Card

POST api/Card/SaveMobile

This operation tokenizes all the required information for Apple Pay payment. Once the information is tokenized, you no longer have to provide us any sensitive information to make payments to this card. To initiate transactions with a token simply provide the token that is returned in the SaveMobile results in the ProcessOne RESTful API. Note: the first payment must be made with the token within 30 minutes of the SaveMobile request.

SaveMobileCardRequest

NameDescriptionTypeAdditional information
MobilePaymentToken

Payment data object provided by Apple API.

string

Required

HolderAddress

Optional: Cardholder address

string

None.

HolderZip

Optional: Cardholder zip code

string

None.

HolderName

Optional: Cardholder name

string

None.

CallbackId

A callback id associated to save mobile transaction

string

None.

DisplayName

Optional: Display Name value for card, usually containing last 4 numbers. Acquired from Apple Pay PKPaymentToken object

string

None.

ClientReferenceData

ClientReferenceData

ClientReferenceData

None.

PortalOneSessionKey

Session key

string

Required

ClientReferenceData

NameDescriptionTypeAdditional information
ClientReferenceData1

Used to pass a reference number such as Policy, Quote, or Claim Number. The value will be searchable in the transaction search report.

string

None.

ClientReferenceData2

Used to pass and External TransactionId value. The value will be searchable in the transaction search report.

string

None.

ClientReferenceData3

Used to pass location data such as the office the transaction originated. The value will be searchable in the transaction search report.

string

None.

ClientReferenceData4

Used to pass additional information with the transaction. The value will be displayed in the transaction details.

string

None.

ClientReferenceData5

Used to pass additional reference source account data such as an account number for a multi-policy account. The value will be searchable in the transaction search report.

string

None.

Request Formats

 
{
  "MobilePaymentToken": "PaymentData property of PKPaymentToken",
  "HolderAddress": "620 Coolidge Drive Suite 200 Folsom, CA 95630",
  "HolderZip": "95630",
  "HolderName": "Janet Smith",
  "CallbackId": "5816211d-c635-4489-b0d7-c94539ee73fa",
  "DisplayName": "MasterCard 1471",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "PortalOneSessionKey": "d209ab43-7feb-4cfc-8bb0-4e762dafaba2"
}
<SaveMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>d209ab43-7feb-4cfc-8bb0-4e762dafaba2</PortalOneSessionKey>
  <CallbackId>5816211d-c635-4489-b0d7-c94539ee73fa</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <DisplayName>MasterCard 1471</DisplayName>
  <HolderAddress>620 Coolidge Drive Suite 200 Folsom, CA 95630</HolderAddress>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <MobilePaymentToken>PaymentData property of PKPaymentToken</MobilePaymentToken>
</SaveMobileCardRequest>

Response Information

SaveMobileCardResponse

NameDescriptionTypeAdditional information
TransactionId

ProcessOne transaction ID

string

None.

Token

ProcessOne Token

string

None.

TokenCreationTime

Time of token creation

date

None.

TimeZone

Time zone of TokenCreationTime

string

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "TransactionId": "123",
  "Token": "bd762aff-38c5-400a-9771-aa10bb8b9573",
  "TokenCreationTime": "2019-01-19T21:30:25.9350073-08:00",
  "TimeZone": "PDT",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveMobileCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>bd762aff-38c5-400a-9771-aa10bb8b9573</Token>
  <TokenCreationTime>2019-01-19T21:30:25.9350073-08:00</TokenCreationTime>
  <TransactionId>123</TransactionId>
</SaveMobileCardResponse>

POST api/Card/ChargeMobile

This operation allows making a payment using the Apple Pay as a provider, which initiates a transfer of money from a particular customer account to the merchant account. You have to provide a valid payment token in your request.

ChargeMobileCardRequest

NameDescriptionTypeAdditional information
MobilePaymentToken

Payment data object provided by Apple API.

string

Required

HolderAddress

Optional: Cardholder address

string

None.

HolderZip

Optional: Cardholder zip code

string

None.

HolderName

Optional: Cardholder name

string

None.

CallbackId

A callback id associated to charge mobile transaction

string

None.

DisplayName

Optional: Display Name value for card, usually containing last 4 numbers

string

None.

Amount

Charge amount

decimal number

None.

ChargeFee

Should we charge with fee (default - true)

boolean

None.

ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string

None.

AccountGroupCode

Account group code

string

None.

ClientReferenceData

ClientReferenceData

ClientReferenceData

None.

PortalOneSessionKey

Session key

string

Required

Request Formats

 
{
  "MobilePaymentToken": "PaymentData property of PKPaymentToken",
  "HolderAddress": "620 Coolidge Drive Suite 200 Folsom, CA 95630",
  "HolderZip": "95630",
  "HolderName": "Janet Smith",
  "CallbackId": "c3204674-f5b6-49bf-8540-1289cd4ca2b3",
  "DisplayName": "MasterCard 1471",
  "Amount": 312.0,
  "ChargeFee": true,
  "ConvenienceFeeType": "Extra",
  "AccountGroupCode": "Default",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "PortalOneSessionKey": "606727cf-62ea-4b85-b09b-e609e5e949d4"
}
<ChargeMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>606727cf-62ea-4b85-b09b-e609e5e949d4</PortalOneSessionKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>312</Amount>
  <CallbackId>c3204674-f5b6-49bf-8540-1289cd4ca2b3</CallbackId>
  <ChargeFee>true</ChargeFee>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <ConvenienceFeeType>Extra</ConvenienceFeeType>
  <DisplayName>MasterCard 1471</DisplayName>
  <HolderAddress>620 Coolidge Drive Suite 200 Folsom, CA 95630</HolderAddress>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <MobilePaymentToken>PaymentData property of PKPaymentToken</MobilePaymentToken>
</ChargeMobileCardRequest>

Response Information

ChargeMobileCardResponse

NameDescriptionTypeAdditional information
TransactionId

Transaction ID

string

None.

TransactionDate

Transaction date and time

date

None.

TimeZone

Transaction time zone

string

None.

AuthorizationCode

A gateway Authorization Code

string

None.

BatchNumber

Number of the batch

integer

None.

HolderName

Card Holder Name

string

None.

HolderZip

Card Holder Zip code

string

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "TransactionId": "123",
  "TransactionDate": "2019-01-19T21:30:26.1693885-08:00",
  "TimeZone": "PDT",
  "AuthorizationCode": "AUX225",
  "BatchNumber": 10,
  "HolderName": "Janet Smith",
  "HolderZip": "95630",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ChargeMobileCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <AuthorizationCode>AUX225</AuthorizationCode>
  <BatchNumber>10</BatchNumber>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2019-01-19T21:30:26.1693885-08:00</TransactionDate>
  <TransactionId>123</TransactionId>
</ChargeMobileCardResponse>

Session

GET api/Session/Create?PortalOneAuthenticationKey={PortalOneAuthenticationKey}

This operation is used to initiate the API session, and creates the PortalOneSessionKey. Once the PortalOneSessionKey is created, you can use it to access other PortalOne API operations.

URI Parameters

NameDescriptionTypeAdditional information
PortalOneAuthenticationKey

Authentication key

string

None.

None.

Response Information

CreateSessionResponse

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "PortalOneSessionKey": "0d269492-647e-468c-ba7b-46c042d52df2",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CreateSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <PortalOneSessionKey>0d269492-647e-468c-ba7b-46c042d52df2</PortalOneSessionKey>
</CreateSessionResponse>