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": "b3b733db-7005-49b2-82ed-53cc1acb3702",
  "DisplayName": "MasterCard 1471",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "PortalOneSessionKey": "f625b8ea-7e93-420d-a6a4-28a10eb7ca80"
}
<SaveMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>f625b8ea-7e93-420d-a6a4-28a10eb7ca80</PortalOneSessionKey>
  <CallbackId>b3b733db-7005-49b2-82ed-53cc1acb3702</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": "43bd9a81-c970-4ca2-b706-42dc5a5abed7",
  "TokenCreationTime": "2019-05-26T19:06:33.974794-07: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>43bd9a81-c970-4ca2-b706-42dc5a5abed7</Token>
  <TokenCreationTime>2019-05-26T19:06:33.974794-07: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": "db4ed8ef-3132-45d7-9f15-785d8ee89689",
  "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": "1b4c5596-578c-41f1-863f-57bb65b29d80"
}
<ChargeMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>1b4c5596-578c-41f1-863f-57bb65b29d80</PortalOneSessionKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>312</Amount>
  <CallbackId>db4ed8ef-3132-45d7-9f15-785d8ee89689</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-05-26T19:06:34.2091674-07: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-05-26T19:06:34.2091674-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
</ChargeMobileCardResponse>

POST api/Card/Save

This operation tokenizes all the required information about a credit card payment method. Once the card information is tokenized, you no longer have to provide us any sensitive credit card information. To initiate transactions with a tokenized card simply provide the token that is returned by our API.

SaveCardRequest

NameDescriptionTypeAdditional information
Card

Card information

CardDetails

Required

CallbackId

A callback id associated to save card transaction

string

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

PortalOneSessionKey

Session key

string

Required

CardDetails

NameDescriptionTypeAdditional information
ExpirationYear

Card expiration year

integer

None.

ExpirationMonth

Card expiration month

integer

None.

Holder

Card holder details

Customer

None.

Number

Card number

string

None.

ValidationValue

Card validation value

string

None.

Customer

NameDescriptionTypeAdditional information
Name

Name

string

None.

Zip

Zip code

string

None.

Address

Address

string

None.

Request Formats

 
{
  "Card": {
    "ExpirationYear": 2021,
    "ExpirationMonth": 1,
    "Holder": {
      "Name": "Janet Smith",
      "Zip": "95630",
      "Address": "620 Coolidge Drive Suite 200 Folsom, CA 95630"
    },
    "Number": "4111111111111111",
    "ValidationValue": "123"
  },
  "CallbackId": "dd5bc06e-ed33-4c6f-9037-cda9e62fb499",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "PortalOneSessionKey": "4c1bdf43-c25c-47d6-acd4-85db1e3afc8b"
}
<SaveCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>4c1bdf43-c25c-47d6-acd4-85db1e3afc8b</PortalOneSessionKey>
  <CallbackId>dd5bc06e-ed33-4c6f-9037-cda9e62fb499</CallbackId>
  <Card>
    <ExpirationMonth>1</ExpirationMonth>
    <ExpirationYear>2021</ExpirationYear>
    <Holder>
      <Address>620 Coolidge Drive Suite 200 Folsom, CA 95630</Address>
      <Name>Janet Smith</Name>
      <Zip>95630</Zip>
    </Holder>
    <Number>4111111111111111</Number>
    <ValidationValue>123</ValidationValue>
  </Card>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
</SaveCardRequest>

Response Information

SaveCardResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string

None.

TokenCreationTime

Token creation date and time in merchant time zone

date

None.

TimeZone

Short time zone name with daylight saving time suffix

string

None.

BaseCardType

Base Card type

CreditCardType

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

CreditCardType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Visa

1

Visa

MasterCard

2

MasterCard

AmericanExpress

3

AmericanExpress

Discover

4

Discover

PinlessDebitGeneric

5

PinlessDebitGeneric

Star

6

Star

Nyce

7

Nyce

Pulse

8

Pulse

Other

99

Other

Response Formats

{
  "Token": "e08bffda-707b-47ff-8ffd-496d4b8c1170",
  "TokenCreationTime": "2019-05-26T19:06:34.3810439-07:00",
  "TimeZone": "PDT",
  "BaseCardType": 1,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveCardResponse 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" />
  <BaseCardType>Visa</BaseCardType>
  <TimeZone>PDT</TimeZone>
  <Token>e08bffda-707b-47ff-8ffd-496d4b8c1170</Token>
  <TokenCreationTime>2019-05-26T19:06:34.3810439-07:00</TokenCreationTime>
</SaveCardResponse>

POST api/Card/Charge

This operation allows making a payment with a given credit card, which initiates a transfer of money from a particular customer account to the merchant account. You either have to provide a valid token or include credit card information in your request.

ChargeCardRequest

NameDescriptionTypeAdditional information
Amount

Charge amount

decimal number

None.

ChargeFee

Should we charge with fee (default - true)

boolean

None.

Token

Saved Card token

string

None.

Card

Either Card or token parameter is required. If both are sent, token will be used

CardDetails

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

IsRecurring

Is recurring charge

boolean

None.

AccountGroupCode

Account group code

string

None.

CallbackId

A callback id associated to charge card transaction

string

None.

Save

Enables to save and tokenize credit card information

boolean

None.

ConvenienceFeeType

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

string

None.

PortalOneSessionKey

Session key

string

Required

Request Formats

 
{
  "Amount": 312.0,
  "ChargeFee": true,
  "Token": "bc410f6c-9892-4db3-86a6-ce89afb90cb7",
  "Card": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "IsRecurring": false,
  "AccountGroupCode": "Default",
  "CallbackId": "eccf8eaa-9342-4593-8549-4b654c76d8e4",
  "Save": false,
  "ConvenienceFeeType": "Extra",
  "PortalOneSessionKey": "15f660c7-cb7e-43f1-b737-e9f4c17ab6a7"
}
<ChargeCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>15f660c7-cb7e-43f1-b737-e9f4c17ab6a7</PortalOneSessionKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>312</Amount>
  <CallbackId>eccf8eaa-9342-4593-8549-4b654c76d8e4</CallbackId>
  <Card i:nil="true" />
  <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>
  <IsRecurring>false</IsRecurring>
  <Save>false</Save>
  <Token>bc410f6c-9892-4db3-86a6-ce89afb90cb7</Token>
</ChargeCardRequest>

Response Information

ChargeCardResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string

None.

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.

CreditCardType

Credit Card type

CreditCardType

None.

HolderName

Card Holder Name

string

None.

HolderZip

Card Holder Zip code

string

None.

BaseCardType

Base Credit Card type

CreditCardType

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "Token": null,
  "TransactionId": "123",
  "TransactionDate": "2019-05-26T19:06:34.537333-07:00",
  "TimeZone": "PDT",
  "AuthorizationCode": "AUX225",
  "BatchNumber": 10,
  "CreditCardType": 1,
  "HolderName": "Janet Smith",
  "HolderZip": "95630",
  "BaseCardType": 1,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ChargeCardResponse 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>
  <BaseCardType>Visa</BaseCardType>
  <BatchNumber>10</BatchNumber>
  <CreditCardType>Visa</CreditCardType>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <TimeZone>PDT</TimeZone>
  <Token i:nil="true" />
  <TransactionDate>2019-05-26T19:06:34.537333-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
</ChargeCardResponse>

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": "553ab92b-2f70-4f34-820f-552d6abe5868",
  "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>553ab92b-2f70-4f34-820f-552d6abe5868</PortalOneSessionKey>
</CreateSessionResponse>

Eft

POST api/Eft/Save

This operation tokenizes all the required information about a bank account payment method. Once the bank account information has been tokenized, you no longer have to provide us any sensitive and personal information to debit or credit a bank account, just use the token that is retunred by our API.

SaveEftRequest

NameDescriptionTypeAdditional information
EftDetails

Eft details

EftDetails

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

CallbackId

A callback id associated to save EFT transaction

string

None.

BypassBankAccountValidation

Bypassing bank account validation

boolean

None.

PortalOneSessionKey

Session key

string

Required

EftDetails

NameDescriptionTypeAdditional information
RoutingNumber

The bank routing number. Must only contain numbers.

string

None.

AccountNumber

Account number. Must contain only numbers.

string

None.

Type

EFT account type - Checking / Savings.

EftAccountType

None.

AccountGroupCode

This field is used to route money to different accounts based on a predefined groups.

string

None.

CustomerName

Customer name

string

None.

EftAccountType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Checking

1

Checking

Savings

2

Savings

Request Formats

 
{
  "EftDetails": {
    "RoutingNumber": "121042882",
    "AccountNumber": "12345",
    "Type": 0,
    "AccountGroupCode": null,
    "CustomerName": "Janet Smith"
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CallbackId": "ade014a5-3f96-4ba3-8204-dfc595d1779c",
  "BypassBankAccountValidation": false,
  "PortalOneSessionKey": "fd144a84-9dbb-4c8f-8af3-f502698ccfbc"
}
<SaveEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>fd144a84-9dbb-4c8f-8af3-f502698ccfbc</PortalOneSessionKey>
  <BypassBankAccountValidation>false</BypassBankAccountValidation>
  <CallbackId>ade014a5-3f96-4ba3-8204-dfc595d1779c</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <EftDetails>
    <AccountGroupCode i:nil="true" />
    <AccountNumber>12345</AccountNumber>
    <CustomerName>Janet Smith</CustomerName>
    <RoutingNumber>121042882</RoutingNumber>
    <Type>Undefined</Type>
  </EftDetails>
</SaveEftRequest>

Response Information

SaveEftResponse

NameDescriptionTypeAdditional information
Token

Saved Eft token

string

None.

BankName

Bank name

string

None.

VerifyBankAccountDescription

Additional response data

string

None.

TimeZone

Short time zone name with daylight saving time suffix

string

None.

TokenCreationTime

Token creation date and time in merchant time zone

date

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "Token": "4d810c62-cc4b-464e-85d8-5e2b627c5cb4",
  "BankName": "WELLS FARGO BANK NA",
  "VerifyBankAccountDescription": null,
  "TimeZone": "PDT",
  "TokenCreationTime": "2019-05-26T19:06:34.78729-07:00",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveEftResponse 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" />
  <BankName>WELLS FARGO BANK NA</BankName>
  <TimeZone>PDT</TimeZone>
  <Token>4d810c62-cc4b-464e-85d8-5e2b627c5cb4</Token>
  <TokenCreationTime>2019-05-26T19:06:34.78729-07:00</TokenCreationTime>
  <VerifyBankAccountDescription i:nil="true" />
</SaveEftResponse>

POST api/Eft/Credit

This operation allows to credit a given bank account, which initiates a transfer of money from the merchant to a particular customer bank account. You can either provide a bank account information or use a previously saved token.

CreditEftRequest

NameDescriptionTypeAdditional information
Amount

Amount to charge

decimal number

None.

Token

Saved Eft token

string

None.

EftDetails

Eft details

EftDetails

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

IsRecurring

Is recurring charge

boolean

None.

CallbackId

Callback ID

string

None.

PortalOneSessionKey

Session key

string

Required

Request Formats

 
{
  "Amount": 312.0,
  "Token": "22a7e42e-c227-4936-a0f1-089f81028dcb",
  "EftDetails": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "IsRecurring": false,
  "CallbackId": "b29579f1-c526-4068-82a2-295f250ac6dc",
  "PortalOneSessionKey": "5a8845b2-afcc-482f-ac1b-a7bad4db7d9b"
}
<CreditEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>5a8845b2-afcc-482f-ac1b-a7bad4db7d9b</PortalOneSessionKey>
  <Amount>312</Amount>
  <CallbackId>b29579f1-c526-4068-82a2-295f250ac6dc</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <EftDetails i:nil="true" />
  <IsRecurring>false</IsRecurring>
  <Token>22a7e42e-c227-4936-a0f1-089f81028dcb</Token>
</CreditEftRequest>

Response Information

CreditEftResponse

NameDescriptionTypeAdditional information
BankName

Bank name

string

None.

TransactionId

Transaction ID

string

None.

TransactionDate

Transaction date and time

date

None.

TimeZone

Transaction time zone

string

None.

BatchNumber

Number of the batch

integer

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "BankName": "WELLS FARGO BANK NA",
  "TransactionId": "123",
  "TransactionDate": "2019-05-26T19:06:34.9435404-07:00",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CreditEftResponse 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" />
  <BankName>WELLS FARGO BANK NA</BankName>
  <BatchNumber>10</BatchNumber>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2019-05-26T19:06:34.9435404-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
</CreditEftResponse>

POST api/Eft/Debit

This operation allows debiting a given bank account, which initiates a transfer of money from a particular customer bank account to the merchant. You can either provide a bank account information or use a previously saved token.

DebitEftRequest

NameDescriptionTypeAdditional information
Save

Enables to save and tokenize eft information

boolean

None.

ChargeFee

Should we charge with fee

boolean

None.

ConvenienceFeeType

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

string

None.

BypassBankAccountValidation

Bypassing bank account validation

boolean

None.

Amount

Amount to charge

decimal number

None.

Token

Saved Eft token

string

None.

EftDetails

Eft details

EftDetails

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

IsRecurring

Is recurring charge

boolean

None.

CallbackId

Callback ID

string

None.

PortalOneSessionKey

Session key

string

Required

Request Formats

 
{
  "Save": false,
  "ChargeFee": true,
  "ConvenienceFeeType": "Extra",
  "BypassBankAccountValidation": false,
  "Amount": 312.0,
  "Token": "4aea4477-45fa-4ead-999d-e88b30d34270",
  "EftDetails": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "IsRecurring": false,
  "CallbackId": "caeca2ec-c14a-4539-ac7c-c850897db0d9",
  "PortalOneSessionKey": "c35c896d-3683-456e-9a62-c69bcde00c29"
}
<DebitEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>c35c896d-3683-456e-9a62-c69bcde00c29</PortalOneSessionKey>
  <Amount>312</Amount>
  <CallbackId>caeca2ec-c14a-4539-ac7c-c850897db0d9</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <EftDetails i:nil="true" />
  <IsRecurring>false</IsRecurring>
  <Token>4aea4477-45fa-4ead-999d-e88b30d34270</Token>
  <BypassBankAccountValidation>false</BypassBankAccountValidation>
  <ChargeFee>true</ChargeFee>
  <ConvenienceFeeType>Extra</ConvenienceFeeType>
  <Save>false</Save>
</DebitEftRequest>

Response Information

DebitEftResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string

None.

VerifyBankAccountDescription

Additional response data

string

None.

BankName

Bank name

string

None.

TransactionId

Transaction ID

string

None.

TransactionDate

Transaction date and time

date

None.

TimeZone

Transaction time zone

string

None.

BatchNumber

Number of the batch

integer

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "Token": null,
  "VerifyBankAccountDescription": null,
  "BankName": "WELLS FARGO BANK NA",
  "TransactionId": "123",
  "TransactionDate": "2019-05-26T19:06:35.0997916-07:00",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<DebitEftResponse 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" />
  <BankName>WELLS FARGO BANK NA</BankName>
  <BatchNumber>10</BatchNumber>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2019-05-26T19:06:35.0997916-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
  <Token i:nil="true" />
  <VerifyBankAccountDescription i:nil="true" />
</DebitEftResponse>