Cdn

GET api/Cdn/{portalName}/{relativeJsPath}

This operation generates a js-script using a template downloaded from a portal.

URI Parameters

NameDescriptionTypeAdditional information
portalName

Portal name

string

Required

relativeJsPath

Relative path to js-script template in the portal

string

Required

None.

Response Information

HttpResponseMessage

NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

Version

NameDescriptionTypeAdditional information
Major

integer

None.

Minor

integer

None.

Build

integer

None.

Revision

integer

None.

MajorRevision

integer

None.

MinorRevision

integer

None.

HttpContent

NameDescriptionTypeAdditional information
Headers

Collection of Object

None.

HttpContentHeaders

None.

HttpStatusCode

Possible enumeration values:

NameValueDescription
Continue

100

SwitchingProtocols

101

OK

200

Created

201

Accepted

202

NonAuthoritativeInformation

203

NoContent

204

ResetContent

205

PartialContent

206

MultipleChoices

300

Ambiguous

300

MovedPermanently

301

Moved

301

Found

302

Redirect

302

SeeOther

303

RedirectMethod

303

NotModified

304

UseProxy

305

Unused

306

TemporaryRedirect

307

RedirectKeepVerb

307

BadRequest

400

Unauthorized

401

PaymentRequired

402

Forbidden

403

NotFound

404

MethodNotAllowed

405

NotAcceptable

406

ProxyAuthenticationRequired

407

RequestTimeout

408

Conflict

409

Gone

410

LengthRequired

411

PreconditionFailed

412

RequestEntityTooLarge

413

RequestUriTooLong

414

UnsupportedMediaType

415

RequestedRangeNotSatisfiable

416

ExpectationFailed

417

UpgradeRequired

426

InternalServerError

500

NotImplemented

501

BadGateway

502

ServiceUnavailable

503

GatewayTimeout

504

HttpVersionNotSupported

505

HttpResponseHeaders

None.

HttpRequestMessage

NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

Method

HttpMethod

None.

RequestUri

URI

None.

Headers

Collection of Object

None.

Properties

Dictionary of string and Object

None.

HttpMethod

NameDescriptionTypeAdditional information
Method

string

None.

HttpRequestHeaders

None.

IDictionaryOfStringAndObject

Dictionary of string [key] and Object [value]

Object

None.

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

None.

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

None.

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": "28a4206a-492d-4470-8d67-12a5f48ea125",
  "DisplayName": "MasterCard 1471",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "PortalOneSessionKey": "76ad115e-c358-4325-8536-5ca09ac38f2b"
}
<SaveMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>76ad115e-c358-4325-8536-5ca09ac38f2b</PortalOneSessionKey>
  <CallbackId>28a4206a-492d-4470-8d67-12a5f48ea125</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": "140080c3-5a8c-4eea-bf4e-e3af5ddc3085",
  "TokenCreationTime": "2019-09-19T08:24:40.9586305-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>140080c3-5a8c-4eea-bf4e-e3af5ddc3085</Token>
  <TokenCreationTime>2019-09-19T08:24:40.9586305-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

None.

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.

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.

Amount

Charge amount

decimal number

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

Properties

Custom payment properties

Dictionary of PaymentPropertyName and string

None.

AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean

None.

PortalOneSessionKey

Session key

string

None.

IDictionaryOfPaymentPropertyNameAndString

Dictionary of PaymentPropertyName [key] and string [value]

PaymentPropertyName

Possible enumeration values:

NameValueDescription
CustomerName

1

Customer Name (Policy Holder Name)

Request Formats

 
{
  "MobilePaymentToken": "PaymentData property of PKPaymentToken",
  "HolderAddress": "620 Coolidge Drive Suite 200 Folsom, CA 95630",
  "HolderZip": "95630",
  "HolderName": "Janet Smith",
  "CallbackId": "a3517fba-dcf2-44e3-87e9-47d69bcae114",
  "DisplayName": "MasterCard 1471",
  "ChargeFee": true,
  "ConvenienceFeeType": "Extra",
  "AccountGroupCode": "Default",
  "Amount": 312.0,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "Properties": {
    "CustomerName": "John Smith"
  },
  "AcknowledgmentRequired": null,
  "PortalOneSessionKey": "e8be56db-d791-47d7-8c48-9187d88394ae"
}
<ChargeMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>e8be56db-d791-47d7-8c48-9187d88394ae</PortalOneSessionKey>
  <AcknowledgmentRequired i:nil="true" />
  <Amount>312</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfPaymentPropertyNamestringgUnhQyVF>
      <d2p1:Key>CustomerName</d2p1:Key>
      <d2p1:Value>John Smith</d2p1:Value>
    </d2p1:KeyValueOfPaymentPropertyNamestringgUnhQyVF>
  </Properties>
  <AccountGroupCode>Default</AccountGroupCode>
  <CallbackId>a3517fba-dcf2-44e3-87e9-47d69bcae114</CallbackId>
  <ChargeFee>true</ChargeFee>
  <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
AuthorizationCode

A gateway Authorization Code

string

None.

HolderName

Card Holder Name

string

None.

HolderZip

Card Holder Zip code

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.

ReceiptId

Receipt ID

string

None.

AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "AuthorizationCode": "AUX225",
  "HolderName": "Janet Smith",
  "HolderZip": "95630",
  "TransactionId": "123",
  "TransactionDate": "2019-09-19T08:24:41.068007-07:00",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": "bac1e777-8e96-4170-8b2d-5b6b513aa167",
  "AcknowledgmentDelivered": null,
  "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" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ReceiptId>bac1e777-8e96-4170-8b2d-5b6b513aa167</ReceiptId>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2019-09-19T08:24:41.068007-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
  <AuthorizationCode>AUX225</AuthorizationCode>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
</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

None.

CallbackId

A callback id associated to save transaction

string

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

CustomerId

Client facing customer identifier

globally unique identifier

None.

IsDefaultPaymentMethod

Is default payment method flag

boolean

None.

PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string

None.

PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string

None.

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": "de41287a-ad82-4988-99bd-46a33c02d57f",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "bdaeb8c0-c1f5-43b9-9e2b-81237077fba3",
  "IsDefaultPaymentMethod": false,
  "PortalOneSessionKey": "c32dc23a-f9cd-4911-9317-646d52554338",
  "PortalOneAuthenticationKey": null
}
<SaveCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey i:nil="true" />
  <PortalOneSessionKey>c32dc23a-f9cd-4911-9317-646d52554338</PortalOneSessionKey>
  <CallbackId>de41287a-ad82-4988-99bd-46a33c02d57f</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>bdaeb8c0-c1f5-43b9-9e2b-81237077fba3</CustomerId>
  <IsDefaultPaymentMethod>false</IsDefaultPaymentMethod>
  <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>
</SaveCardRequest>

Response Information

SaveCardResponse

NameDescriptionTypeAdditional information
BaseCardType

Base Card type

CreditCardType

None.

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.

PaymentMethodId

Related payment method identifier

integer

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

{
  "BaseCardType": "Visa",
  "Token": "1b132c5e-5a8e-4db5-ab68-05c530bdd637",
  "TokenCreationTime": "2019-09-19T08:24:41.2242563-07:00",
  "TimeZone": "PDT",
  "PaymentMethodId": null,
  "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" />
  <PaymentMethodId i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>1b132c5e-5a8e-4db5-ab68-05c530bdd637</Token>
  <TokenCreationTime>2019-09-19T08:24:41.2242563-07:00</TokenCreationTime>
  <BaseCardType>Visa</BaseCardType>
</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
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.

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.

Amount

Charge amount

decimal number

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

Properties

Custom payment properties

Dictionary of PaymentPropertyName and string

None.

AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "ChargeFee": true,
  "Token": "19c006b7-dc6f-4b35-9e80-de4aa4a20e94",
  "Card": null,
  "IsRecurring": false,
  "AccountGroupCode": "Default",
  "CallbackId": "fafafb0f-66e2-4c49-8603-007f1a3b2a95",
  "Save": false,
  "ConvenienceFeeType": "Extra",
  "Amount": 312.0,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "Properties": {
    "CustomerName": "John Smith"
  },
  "AcknowledgmentRequired": null,
  "PortalOneSessionKey": "7eb9679d-36f8-4d59-bf20-97fd7a2283c6"
}
<ChargeCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>7eb9679d-36f8-4d59-bf20-97fd7a2283c6</PortalOneSessionKey>
  <AcknowledgmentRequired i:nil="true" />
  <Amount>312</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfPaymentPropertyNamestringgUnhQyVF>
      <d2p1:Key>CustomerName</d2p1:Key>
      <d2p1:Value>John Smith</d2p1:Value>
    </d2p1:KeyValueOfPaymentPropertyNamestringgUnhQyVF>
  </Properties>
  <AccountGroupCode>Default</AccountGroupCode>
  <CallbackId>fafafb0f-66e2-4c49-8603-007f1a3b2a95</CallbackId>
  <Card i:nil="true" />
  <ChargeFee>true</ChargeFee>
  <ConvenienceFeeType>Extra</ConvenienceFeeType>
  <IsRecurring>false</IsRecurring>
  <Save>false</Save>
  <Token>19c006b7-dc6f-4b35-9e80-de4aa4a20e94</Token>
</ChargeCardRequest>

Response Information

ChargeCardResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string

None.

AuthorizationCode

A gateway Authorization Code

string

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.

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.

ReceiptId

Receipt ID

string

None.

AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "Token": null,
  "AuthorizationCode": "AUX225",
  "CreditCardType": "Visa",
  "HolderName": "Janet Smith",
  "HolderZip": "95630",
  "BaseCardType": "Visa",
  "TransactionId": "123",
  "TransactionDate": "2019-09-19T08:24:41.349255-07:00",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": "8969a887-895b-43f3-a393-d91d74b7fe49",
  "AcknowledgmentDelivered": null,
  "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" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ReceiptId>8969a887-895b-43f3-a393-d91d74b7fe49</ReceiptId>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2019-09-19T08:24:41.349255-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
  <AuthorizationCode>AUX225</AuthorizationCode>
  <BaseCardType>Visa</BaseCardType>
  <CreditCardType>Visa</CreditCardType>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <Token i:nil="true" />
</ChargeCardResponse>

POST api/Card/GetAcceptedCardTypes

This operation returns available card types.

GetAcceptedCardTypesRequest

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "PortalOneSessionKey": "f5f6247c-7a9c-4d96-aef4-2d2adaf29cc3"
}
<GetAcceptedCardTypesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>f5f6247c-7a9c-4d96-aef4-2d2adaf29cc3</PortalOneSessionKey>
</GetAcceptedCardTypesRequest>

Response Information

GetAcceptedCardTypesResponse

NameDescriptionTypeAdditional information
AcceptedCardTypes

Accepted card types

Collection of String

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

IEnumerableOfString

Response Formats

{
  "AcceptedCardTypes": [
    "Visa",
    "MasterCard",
    "AmericanExpress"
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetAcceptedCardTypesResponse 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" />
  <AcceptedCardTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Visa</d2p1:string>
    <d2p1:string>MasterCard</d2p1:string>
    <d2p1:string>AmericanExpress</d2p1:string>
  </AcceptedCardTypes>
</GetAcceptedCardTypesResponse>

POST api/Card/ValidateBin

This operation returns card information.

ValidateBinRequest

NameDescriptionTypeAdditional information
CardNumber

Card number

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "CardNumber": "4111111111111111",
  "PortalOneSessionKey": "edf74efe-d974-4986-b119-38c3b23f211e"
}
<ValidateBinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>edf74efe-d974-4986-b119-38c3b23f211e</PortalOneSessionKey>
  <CardNumber>4111111111111111</CardNumber>
</ValidateBinRequest>

Response Information

ValidateBinResponse

NameDescriptionTypeAdditional information
CreditCardNetworkType

Credit Card Network type

CreditCardNetworkType

None.

BaseCardType

Credit Card type

CreditCardType

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

CreditCardNetworkType

Possible enumeration values:

NameValueDescription
Unknown

0

Unknown

Hybrid

1

Hybrid

Debit

2

Debit

Credit

3

Credit

Response Formats

{
  "CreditCardNetworkType": "Credit",
  "BaseCardType": "Visa",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ValidateBinResponse 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>
  <CreditCardNetworkType>Credit</CreditCardNetworkType>
</ValidateBinResponse>

POST api/Card/GetConvenienceFee

This operation returns convenience fee.

GetCardConvenienceFeeRequest

NameDescriptionTypeAdditional information
ChargeAmount

Charge amount

decimal number

None.

ConvenienceFeeType

Convenience fee type

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "ChargeAmount": 100.0,
  "ConvenienceFeeType": "PaymentWithFee",
  "PortalOneSessionKey": "a5673066-500f-468b-b364-963b0d1f8e2e"
}
<GetCardConvenienceFeeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>a5673066-500f-468b-b364-963b0d1f8e2e</PortalOneSessionKey>
  <ChargeAmount>100</ChargeAmount>
  <ConvenienceFeeType>PaymentWithFee</ConvenienceFeeType>
</GetCardConvenienceFeeRequest>

Response Information

GetCardConvenienceFeeResponse

NameDescriptionTypeAdditional information
ConvenienceFee

Convenience fee amount

decimal number

None.

CalculationType

Calculation type

string

None.

FlatRate

Flat rate

decimal number

None.

Percent

Percent

decimal number

None.

MinimumAmount

Minimum amount

decimal number

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ConvenienceFee": 5.0,
  "CalculationType": "FlatRate",
  "FlatRate": 5.0,
  "Percent": null,
  "MinimumAmount": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetCardConvenienceFeeResponse 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" />
  <CalculationType>FlatRate</CalculationType>
  <ConvenienceFee>5</ConvenienceFee>
  <FlatRate>5</FlatRate>
  <MinimumAmount i:nil="true" />
  <Percent i:nil="true" />
</GetCardConvenienceFeeResponse>

POST api/Card/Update

This method updates card information.

UpdateCardRequest

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string

None.

ExpirationYear

Card expiration year

integer

None.

ExpirationMonth

Card expiration month

integer

None.

HolderZip

Card holder ZIP

string

None.

HolderAddress

Card holder address

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "Token": "bb46936d-d65a-40d4-aa8f-336248393d68",
  "ExpirationYear": 2021,
  "ExpirationMonth": 1,
  "HolderZip": "12345",
  "HolderAddress": "64, Force Hill Rd, Livingston, NJ",
  "PortalOneSessionKey": "19537d66-362d-4f4a-ac05-75b3aa43ae8d"
}
<UpdateCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>19537d66-362d-4f4a-ac05-75b3aa43ae8d</PortalOneSessionKey>
  <ExpirationMonth>1</ExpirationMonth>
  <ExpirationYear>2021</ExpirationYear>
  <HolderAddress>64, Force Hill Rd, Livingston, NJ</HolderAddress>
  <HolderZip>12345</HolderZip>
  <Token>bb46936d-d65a-40d4-aa8f-336248393d68</Token>
</UpdateCardRequest>

Response Information

UpdateCardResponse

NameDescriptionTypeAdditional information
TimeZone

Time zone

string

None.

UpdateTime

Card update time

date

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "TimeZone": "PST",
  "UpdateTime": "2019-09-19T08:24:41.7420984-07:00",
  "ResponseCode": "Success",
  "ResponseMessage": "Successfully saved"
}
<UpdateCardResponse 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>Successfully saved</ResponseMessage>
  <TimeZone>PST</TimeZone>
  <UpdateTime>2019-09-19T08:24:41.7420984-07:00</UpdateTime>
</UpdateCardResponse>

POST api/Card/AcknowledgePayment

This method allows acknowledge successful payment

AcknowledgePaymentRequest

NameDescriptionTypeAdditional information
TransactionId

Transaction Id

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "TransactionId": "123",
  "PortalOneSessionKey": "91ebc4e2-84c6-45be-89fb-98ec892bd4fc"
}
<AcknowledgePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>91ebc4e2-84c6-45be-89fb-98ec892bd4fc</PortalOneSessionKey>
  <TransactionId>123</TransactionId>
</AcknowledgePaymentRequest>

Response Information

AcknowledgePaymentResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<AcknowledgePaymentResponse 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" />
</AcknowledgePaymentResponse>

PaymentToken

POST api/PaymentToken/GetInfo

This operation provides information about a saved Credit Card or EFT payment method that corresponds to a specific token. A valid token and a valid session key must be provided in order to retrieve information.

GetTokenInfoRequest

NameDescriptionTypeAdditional information
Token

Payment token

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "Token": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<GetTokenInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 2</PortalOneSessionKey>
  <Token>sample string 1</Token>
</GetTokenInfoRequest>

Response Information

GetTokenInfoResponse

NameDescriptionTypeAdditional information
TokenType

Token type

TokenType

None.

Eft

EFT details

TokenEftInfo

None.

CreditCard

Credit card details

TokenCreditCardInfo

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

TokenType

Possible enumeration values:

NameValueDescription
CreditCard

0

Eft

1

TokenEftInfo

NameDescriptionTypeAdditional information
RoutingNumber

The bank routing number. Must only contain numbers.

string

None.

LastFourDigits

Last 4 digits of account number

string

None.

Type

EFT account type - Checking / Savings

EftAccountType

None.

CustomerName

Customer name

string

None.

EftAccountType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Checking

1

Checking

Savings

2

Savings

TokenCreditCardInfo

NameDescriptionTypeAdditional information
LastFourDigits

Last 4 digits of credit card number

string

None.

Type

Credit card type

CreditCardType

None.

ExpirationYear

Year of the expiration of the credit card

integer

None.

ExpirationMonth

Month of the expiration of the credit card

integer

None.

Holder

Card holder

Customer

None.

BaseCardType

Base Credit Card type

CreditCardType

None.

Response Formats

{
  "TokenType": "CreditCard",
  "Eft": {
    "RoutingNumber": "sample string 1",
    "LastFourDigits": "sample string 2",
    "Type": "Undefined",
    "CustomerName": "sample string 3"
  },
  "CreditCard": {
    "LastFourDigits": "sample string 1",
    "Type": "Undefined",
    "ExpirationYear": 1,
    "ExpirationMonth": 1,
    "Holder": {
      "Name": "sample string 1",
      "Zip": "sample string 2",
      "Address": "sample string 3"
    },
    "BaseCardType": "Undefined"
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "sample string 1",
    "ClientReferenceData2": "sample string 2",
    "ClientReferenceData3": "sample string 3",
    "ClientReferenceData4": "sample string 4",
    "ClientReferenceData5": "sample string 5"
  },
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetTokenInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>sample string 1</ClientReferenceData1>
    <ClientReferenceData2>sample string 2</ClientReferenceData2>
    <ClientReferenceData3>sample string 3</ClientReferenceData3>
    <ClientReferenceData4>sample string 4</ClientReferenceData4>
    <ClientReferenceData5>sample string 5</ClientReferenceData5>
  </ClientReferenceData>
  <CreditCard>
    <BaseCardType>Undefined</BaseCardType>
    <ExpirationMonth>1</ExpirationMonth>
    <ExpirationYear>1</ExpirationYear>
    <Holder>
      <Address>sample string 3</Address>
      <Name>sample string 1</Name>
      <Zip>sample string 2</Zip>
    </Holder>
    <LastFourDigits>sample string 1</LastFourDigits>
    <Type>Undefined</Type>
  </CreditCard>
  <Eft>
    <CustomerName>sample string 3</CustomerName>
    <LastFourDigits>sample string 2</LastFourDigits>
    <RoutingNumber>sample string 1</RoutingNumber>
    <Type>Undefined</Type>
  </Eft>
  <TokenType>CreditCard</TokenType>
</GetTokenInfoResponse>

Session

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

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.

CustomerId

Client facing customer identifier

globally unique identifier

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": "ddc9e80a-feff-4cef-a966-7a79ac1bb81b",
  "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>ddc9e80a-feff-4cef-a966-7a79ac1bb81b</PortalOneSessionKey>
</CreateSessionResponse>

POST api/Session/Validate

ValidateSessionRequest

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "PortalOneSessionKey": "sample string 1"
}
<ValidateSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 1</PortalOneSessionKey>
</ValidateSessionRequest>

Response Information

ValidateSessionResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<ValidateSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</ValidateSessionResponse>

Template

POST api/Template/GetImage

This operation returns image data.

GetImageRequest

NameDescriptionTypeAdditional information
ImageId

Image identifier

integer

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "ImageId": 1,
  "PortalOneSessionKey": "00f3bc05-de98-4833-a92b-ccca7d0d2a8c"
}
<GetImageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>00f3bc05-de98-4833-a92b-ccca7d0d2a8c</PortalOneSessionKey>
  <ImageId>1</ImageId>
</GetImageRequest>

Response Information

GetImageResponse

NameDescriptionTypeAdditional information
FileData

Image file data

FileData

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

FileData

NameDescriptionTypeAdditional information
FileDataId

File data identifier

integer

None.

Guid

Unique identifier

globally unique identifier

None.

Created

Date time when file data was created

date

None.

Data

File content

Collection of Byte

None.

Name

File name

string

None.

Byte

Response Formats

{
  "FileData": {
    "FileDataId": 1,
    "Guid": "eb994df3-81e4-46ac-a217-0dc92b501c9e",
    "Created": "2019-09-19T08:24:42.117117-07:00",
    "Data": "x4tyVG5LaUe+O3XhsI1y5A==",
    "Name": "SampleImage"
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetImageResponse 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" />
  <FileData>
    <Created>2019-09-19T08:24:42.117117-07:00</Created>
    <Data>x4tyVG5LaUe+O3XhsI1y5A==</Data>
    <FileDataId>1</FileDataId>
    <Guid>eb994df3-81e4-46ac-a217-0dc92b501c9e</Guid>
    <Name>SampleImage</Name>
  </FileData>
</GetImageResponse>

POST api/Template/GetPortalScreenFlow

This operation returns ScreenFlow for requested operation in portal.

GetScreenFlowRequest

NameDescriptionTypeAdditional information
ScreenFlowName

ScreenFlow identifier

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "ScreenFlowName": "makePayment",
  "PortalOneSessionKey": "9bd0b25e-7a27-42ce-ac27-2d402922f348"
}
<GetScreenFlowRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>9bd0b25e-7a27-42ce-ac27-2d402922f348</PortalOneSessionKey>
  <ScreenFlowName>makePayment</ScreenFlowName>
</GetScreenFlowRequest>

Response Information

GetScreenFlowResponse

NameDescriptionTypeAdditional information
ScreenFlow

ScreenFlow

string

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ScreenFlow": "{ \"componentInjectionToken\": \"PlaceholderStackComponent\", \"data\": { \"componentList\": [ { \"componentInjectionToken\": \"PciBarWidget\", \"data\": { } }, { \"componentInjectionToken\": \"AddPaymentMethodPage\", \"data\": { } }, { \"componentInjectionToken\": \"InlineAlertWidget\", \"data\": { \"componentDefinition\": { \"componentInjectionToken\": \"InlineAlertControl\", \"data\": { } } } } ] } }",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetScreenFlowResponse 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" />
  <ScreenFlow>{ "componentInjectionToken": "PlaceholderStackComponent", "data": { "componentList": [ { "componentInjectionToken": "PciBarWidget", "data": { } }, { "componentInjectionToken": "AddPaymentMethodPage", "data": { } }, { "componentInjectionToken": "InlineAlertWidget", "data": { "componentDefinition": { "componentInjectionToken": "InlineAlertControl", "data": { } } } } ] } }</ScreenFlow>
</GetScreenFlowResponse>

POST api/Template/GetPortalConfiguration

This operation returns configuration for the current portal.

GetPortalConfigurationRequest

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "PortalOneSessionKey": "sample string 1"
}
<GetPortalConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 1</PortalOneSessionKey>
</GetPortalConfigurationRequest>

Response Information

GetPortalConfigurationResponse

NameDescriptionTypeAdditional information
PortalSettings

Portal Settings

PortalSettings

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

PortalSettings

NameDescriptionTypeAdditional information
IsWalletActivated

Indicates that wallet functionality is activated

boolean

None.

MaxPaymentAmount

Maximum allowed payment amount

decimal number

None.

Response Formats

{
  "PortalSettings": {
    "IsWalletActivated": true,
    "MaxPaymentAmount": 1.0
  },
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetPortalConfigurationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
  <PortalSettings>
    <IsWalletActivated>true</IsWalletActivated>
    <MaxPaymentAmount>1</MaxPaymentAmount>
  </PortalSettings>
</GetPortalConfigurationResponse>

GET api/Template/GetPortalStyles?PortalOneSessionKey={PortalOneSessionKey}

This operation returns rendered styles for portal.

URI Parameters

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

None.

None.

Response Information

HttpResponseMessage

NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

Version

NameDescriptionTypeAdditional information
Major

integer

None.

Minor

integer

None.

Build

integer

None.

Revision

integer

None.

MajorRevision

integer

None.

MinorRevision

integer

None.

HttpContent

NameDescriptionTypeAdditional information
Headers

Collection of Object

None.

HttpContentHeaders

None.

HttpStatusCode

Possible enumeration values:

NameValueDescription
Continue

100

SwitchingProtocols

101

OK

200

Created

201

Accepted

202

NonAuthoritativeInformation

203

NoContent

204

ResetContent

205

PartialContent

206

MultipleChoices

300

Ambiguous

300

MovedPermanently

301

Moved

301

Found

302

Redirect

302

SeeOther

303

RedirectMethod

303

NotModified

304

UseProxy

305

Unused

306

TemporaryRedirect

307

RedirectKeepVerb

307

BadRequest

400

Unauthorized

401

PaymentRequired

402

Forbidden

403

NotFound

404

MethodNotAllowed

405

NotAcceptable

406

ProxyAuthenticationRequired

407

RequestTimeout

408

Conflict

409

Gone

410

LengthRequired

411

PreconditionFailed

412

RequestEntityTooLarge

413

RequestUriTooLong

414

UnsupportedMediaType

415

RequestedRangeNotSatisfiable

416

ExpectationFailed

417

UpgradeRequired

426

InternalServerError

500

NotImplemented

501

BadGateway

502

ServiceUnavailable

503

GatewayTimeout

504

HttpVersionNotSupported

505

HttpResponseHeaders

None.

HttpRequestMessage

NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

Method

HttpMethod

None.

RequestUri

URI

None.

Headers

Collection of Object

None.

Properties

Dictionary of string and Object

None.

HttpMethod

NameDescriptionTypeAdditional information
Method

string

None.

HttpRequestHeaders

None.

IDictionaryOfStringAndObject

Dictionary of string [key] and Object [value]

Object

None.

Receipt

GET api/Receipt/DownloadReceipt?ReceiptId={ReceiptId}&ToPreview={ToPreview}&PortalOneSessionKey={PortalOneSessionKey}

This operation returns payment receipt as pdf file.

URI Parameters

NameDescriptionTypeAdditional information
ReceiptId

Payment receipt Id

string

None.

ToPreview

Optional: Indicates that receipt file can be opened in a browser preview

boolean

None.

PortalOneSessionKey

Session key

string

None.

None.

Response Information

None.

POST api/Receipt/Email

This operation generates a payment receipt and sends it

EmailReceiptRequest

NameDescriptionTypeAdditional information
EmailAddress

Email address

string

None.

ReceiptId

Payment receipt Id

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "EmailAddress": "test@oneinc.com",
  "ReceiptId": "37e0f4a4-1996-42ff-8ad8-6b2ba8ebd8cb",
  "PortalOneSessionKey": "b1c63de3-f6fe-4f16-a237-b6857cd42e2e"
}
<EmailReceiptRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>b1c63de3-f6fe-4f16-a237-b6857cd42e2e</PortalOneSessionKey>
  <EmailAddress>test@oneinc.com</EmailAddress>
  <ReceiptId>37e0f4a4-1996-42ff-8ad8-6b2ba8ebd8cb</ReceiptId>
</EmailReceiptRequest>

Response Information

EmailReceiptResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<EmailReceiptResponse 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" />
</EmailReceiptResponse>

Customer

POST api/Customer/CreateAccount

This operation creates a record for a new customer entity, generates and returns an unique identifier for it. The method also creates a record in the Wallet table for the customer.

CreateAccountRequest

NameDescriptionTypeAdditional information
PortalOneAuthenticationKey

Authentication key

string

None.

ExternalCustomerId

An unique identifier of a customer in some external system

string

None.

CustomerName

Customer name

string

None.

Request Formats

 
{
  "PortalOneAuthenticationKey": "ce7a6138-969f-461b-91d0-c4a3f25fa4f5",
  "ExternalCustomerId": "387d086f-acca-4529-8ee4-8cc82a543306",
  "CustomerName": "John Smith"
}
<CreateAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <CustomerName>John Smith</CustomerName>
  <ExternalCustomerId>387d086f-acca-4529-8ee4-8cc82a543306</ExternalCustomerId>
  <PortalOneAuthenticationKey>ce7a6138-969f-461b-91d0-c4a3f25fa4f5</PortalOneAuthenticationKey>
</CreateAccountRequest>

Response Information

CreateAccountResponse

NameDescriptionTypeAdditional information
CustomerId

Generated identifier for a customer

globally unique identifier

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "CustomerId": "23765854-f06f-4409-a37c-82d4f4a67745",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CreateAccountResponse 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" />
  <CustomerId>23765854-f06f-4409-a37c-82d4f4a67745</CustomerId>
</CreateAccountResponse>

POST api/Customer/GetByExternalCustomerId

This operation returns Customer Account by ExternalCustomerId value.

GetByExternalCustomerIdRequest

NameDescriptionTypeAdditional information
PortalOneAuthenticationKey

Authentication key

string

None.

ExternalCustomerId

An unique identifier of a customer in some external system

string

None.

Request Formats

 
{
  "PortalOneAuthenticationKey": "e55863f2-b20f-44eb-bf95-cbed21042fcd",
  "ExternalCustomerId": "2c323717-f7ee-47a9-b53a-37b0bad60082"
}
<GetByExternalCustomerIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ExternalCustomerId>2c323717-f7ee-47a9-b53a-37b0bad60082</ExternalCustomerId>
  <PortalOneAuthenticationKey>e55863f2-b20f-44eb-bf95-cbed21042fcd</PortalOneAuthenticationKey>
</GetByExternalCustomerIdRequest>

Response Information

GetByExternalCustomerIdResponse

NameDescriptionTypeAdditional information
CustomerId

An identifier for a customer generated when the customer was created

globally unique identifier

None.

CustomerName

Customer name

string

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "CustomerId": "6a929196-7e1f-452d-8dda-1bf63407d4e3",
  "CustomerName": "John Smith",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetByExternalCustomerIdResponse 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" />
  <CustomerId>6a929196-7e1f-452d-8dda-1bf63407d4e3</CustomerId>
  <CustomerName>John Smith</CustomerName>
</GetByExternalCustomerIdResponse>

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.

BypassBankAccountValidation

Bypassing bank account validation

boolean

None.

CallbackId

A callback id associated to save transaction

string

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

CustomerId

Client facing customer identifier

globally unique identifier

None.

IsDefaultPaymentMethod

Is default payment method flag

boolean

None.

PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string

None.

PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string

None.

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.

Request Formats

 
{
  "EftDetails": {
    "RoutingNumber": "121042882",
    "AccountNumber": "12345",
    "Type": "Undefined",
    "AccountGroupCode": null,
    "CustomerName": "Janet Smith"
  },
  "BypassBankAccountValidation": false,
  "CallbackId": "aa1b3c2b-d039-4997-8ea6-5291a18d6405",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "329c44fb-9d61-4db0-96c7-7c14d1f20f24",
  "IsDefaultPaymentMethod": false,
  "PortalOneSessionKey": "9c0c6e87-1131-43ee-9222-dd80f2f28c0d",
  "PortalOneAuthenticationKey": null
}
<SaveEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey i:nil="true" />
  <PortalOneSessionKey>9c0c6e87-1131-43ee-9222-dd80f2f28c0d</PortalOneSessionKey>
  <CallbackId>aa1b3c2b-d039-4997-8ea6-5291a18d6405</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>329c44fb-9d61-4db0-96c7-7c14d1f20f24</CustomerId>
  <IsDefaultPaymentMethod>false</IsDefaultPaymentMethod>
  <BypassBankAccountValidation>false</BypassBankAccountValidation>
  <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
BankName

Bank name

string

None.

VerifyBankAccountDescription

Additional response data

string

None.

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.

PaymentMethodId

Related payment method identifier

integer

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "BankName": "WELLS FARGO BANK NA",
  "VerifyBankAccountDescription": null,
  "Token": "66be6c07-d25a-4ee1-b436-5c5295257d71",
  "TokenCreationTime": "2019-09-19T08:24:42.6661755-07:00",
  "TimeZone": "PDT",
  "PaymentMethodId": null,
  "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" />
  <PaymentMethodId i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>66be6c07-d25a-4ee1-b436-5c5295257d71</Token>
  <TokenCreationTime>2019-09-19T08:24:42.6661755-07:00</TokenCreationTime>
  <BankName>WELLS FARGO BANK NA</BankName>
  <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
Token

Saved Eft token

string

None.

EftDetails

Eft details

EftDetails

None.

IsRecurring

Is recurring charge

boolean

None.

CallbackId

Callback ID

string

None.

Amount

Charge amount

decimal number

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

Properties

Custom payment properties

Dictionary of PaymentPropertyName and string

None.

AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "Token": "1178e1d6-8b0e-4d82-b91e-39998da79096",
  "EftDetails": null,
  "IsRecurring": false,
  "CallbackId": "eb7ef2dd-3801-4373-ba9f-ae95098e6566",
  "Amount": 312.0,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "Properties": null,
  "AcknowledgmentRequired": null,
  "PortalOneSessionKey": "248d04c8-67da-49e7-aa20-9d1ae814daeb"
}
<CreditEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>248d04c8-67da-49e7-aa20-9d1ae814daeb</PortalOneSessionKey>
  <AcknowledgmentRequired i:nil="true" />
  <Amount>312</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <CallbackId>eb7ef2dd-3801-4373-ba9f-ae95098e6566</CallbackId>
  <EftDetails i:nil="true" />
  <IsRecurring>false</IsRecurring>
  <Token>1178e1d6-8b0e-4d82-b91e-39998da79096</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.

ReceiptId

Receipt ID

string

None.

AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "BankName": "WELLS FARGO BANK NA",
  "TransactionId": "123",
  "TransactionDate": "2019-09-19T08:24:42.7911933-07:00",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": null,
  "AcknowledgmentDelivered": null,
  "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" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ReceiptId i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2019-09-19T08:24:42.7911933-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
  <BankName>WELLS FARGO BANK NA</BankName>
</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.

Token

Saved Eft token

string

None.

EftDetails

Eft details

EftDetails

None.

IsRecurring

Is recurring charge

boolean

None.

CallbackId

Callback ID

string

None.

Amount

Charge amount

decimal number

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

Properties

Custom payment properties

Dictionary of PaymentPropertyName and string

None.

AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "Save": false,
  "ChargeFee": true,
  "ConvenienceFeeType": "Extra",
  "BypassBankAccountValidation": false,
  "Token": "9628965e-4af7-4b53-879f-875bd7cfcd7a",
  "EftDetails": null,
  "IsRecurring": false,
  "CallbackId": "1d0fe509-af7d-4d83-8c00-8debb29ce65c",
  "Amount": 312.0,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "Properties": {
    "CustomerName": "John Smith"
  },
  "AcknowledgmentRequired": null,
  "PortalOneSessionKey": "a0a2b10d-4c3b-433d-abc7-86c69f212bb7"
}
<DebitEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>a0a2b10d-4c3b-433d-abc7-86c69f212bb7</PortalOneSessionKey>
  <AcknowledgmentRequired i:nil="true" />
  <Amount>312</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfPaymentPropertyNamestringgUnhQyVF>
      <d2p1:Key>CustomerName</d2p1:Key>
      <d2p1:Value>John Smith</d2p1:Value>
    </d2p1:KeyValueOfPaymentPropertyNamestringgUnhQyVF>
  </Properties>
  <CallbackId>1d0fe509-af7d-4d83-8c00-8debb29ce65c</CallbackId>
  <EftDetails i:nil="true" />
  <IsRecurring>false</IsRecurring>
  <Token>9628965e-4af7-4b53-879f-875bd7cfcd7a</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.

ReceiptId

Receipt ID

string

None.

AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean

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-09-19T08:24:42.9318252-07:00",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": "b050725a-6bd1-482c-8d6b-29fc80d1f497",
  "AcknowledgmentDelivered": null,
  "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" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ReceiptId>b050725a-6bd1-482c-8d6b-29fc80d1f497</ReceiptId>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2019-09-19T08:24:42.9318252-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
  <BankName>WELLS FARGO BANK NA</BankName>
  <Token i:nil="true" />
  <VerifyBankAccountDescription i:nil="true" />
</DebitEftResponse>

POST api/Eft/GetConvenienceFee

This operation returns convenience fee.

GetEftConvenienceFeeRequest

NameDescriptionTypeAdditional information
ChargeAmount

Charge amount

decimal number

None.

ConvenienceFeeType

Convenience fee type

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "ChargeAmount": 100.0,
  "ConvenienceFeeType": "PaymentWithFee",
  "PortalOneSessionKey": "d1e82fde-1a9b-4626-b028-b044c71eaee8"
}
<GetEftConvenienceFeeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>d1e82fde-1a9b-4626-b028-b044c71eaee8</PortalOneSessionKey>
  <ChargeAmount>100</ChargeAmount>
  <ConvenienceFeeType>PaymentWithFee</ConvenienceFeeType>
</GetEftConvenienceFeeRequest>

Response Information

GetEftConvenienceFeeResponse

NameDescriptionTypeAdditional information
ConvenienceFee

Convenience fee amount

decimal number

None.

CalculationType

Calculation type

string

None.

FlatRate

Flat rate

decimal number

None.

Percent

Percent

decimal number

None.

MinimumAmount

Minimum amount

decimal number

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ConvenienceFee": 5.0,
  "CalculationType": "FlatRate",
  "FlatRate": 5.0,
  "Percent": null,
  "MinimumAmount": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetEftConvenienceFeeResponse 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" />
  <CalculationType>FlatRate</CalculationType>
  <ConvenienceFee>5</ConvenienceFee>
  <FlatRate>5</FlatRate>
  <MinimumAmount i:nil="true" />
  <Percent i:nil="true" />
</GetEftConvenienceFeeResponse>

POST api/Eft/GetBankData

This operation returns bank data.

GetBankDataRequest

NameDescriptionTypeAdditional information
RoutingNumber

Routing number

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "RoutingNumber": "121042882",
  "PortalOneSessionKey": "84efa2b3-9767-4468-aa00-e0b4db6d900e"
}
<GetBankDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>84efa2b3-9767-4468-aa00-e0b4db6d900e</PortalOneSessionKey>
  <RoutingNumber>121042882</RoutingNumber>
</GetBankDataRequest>

Response Information

GetBankDataResponse

NameDescriptionTypeAdditional information
BankName

Bank name

string

None.

BankAddress

Bank address

string

None.

BankCity

Bank city

string

None.

BankState

Bank state

string

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "BankName": "WELLS FARGO BANK NA",
  "BankAddress": "MAC N9301-041",
  "BankCity": "MINNEAPOLIS",
  "BankState": "MN",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetBankDataResponse 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" />
  <BankAddress>MAC N9301-041</BankAddress>
  <BankCity>MINNEAPOLIS</BankCity>
  <BankName>WELLS FARGO BANK NA</BankName>
  <BankState>MN</BankState>
</GetBankDataResponse>

POST api/Eft/VerifyBankAccount

This operation verify bank account.

VerifyBankAccountRequest

NameDescriptionTypeAdditional information
EftDetails

EFT details

EftDetails

None.

Token

Saved Eft Token

string

None.

ClientReferenceData

Client reference data

ClientReferenceData

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "EftDetails": {
    "RoutingNumber": "122199983",
    "AccountNumber": "92361077941",
    "Type": "Checking",
    "AccountGroupCode": "Default",
    "CustomerName": "John Stevens"
  },
  "Token": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "PortalOneSessionKey": "4d09bb86-ca9a-42ca-a290-51232946ec24"
}
<VerifyBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>4d09bb86-ca9a-42ca-a290-51232946ec24</PortalOneSessionKey>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <EftDetails>
    <AccountGroupCode>Default</AccountGroupCode>
    <AccountNumber>92361077941</AccountNumber>
    <CustomerName>John Stevens</CustomerName>
    <RoutingNumber>122199983</RoutingNumber>
    <Type>Checking</Type>
  </EftDetails>
  <Token i:nil="true" />
</VerifyBankAccountRequest>

Response Information

VerifyBankAccountResponse

NameDescriptionTypeAdditional information
VerifyBankAccountDescription

Operation result description

string

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "VerifyBankAccountDescription": "Bank Account Validation is successful",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<VerifyBankAccountResponse 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" />
  <VerifyBankAccountDescription>Bank Account Validation is successful</VerifyBankAccountDescription>
</VerifyBankAccountResponse>

POST api/Eft/AcknowledgePayment

This method allows acknowledge successful payment

AcknowledgePaymentRequest

NameDescriptionTypeAdditional information
TransactionId

Transaction Id

string

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "TransactionId": "123",
  "PortalOneSessionKey": "3bcc6b7f-816c-4f83-a380-f83e1474bef1"
}
<AcknowledgePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>3bcc6b7f-816c-4f83-a380-f83e1474bef1</PortalOneSessionKey>
  <TransactionId>123</TransactionId>
</AcknowledgePaymentRequest>

Response Information

AcknowledgePaymentResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<AcknowledgePaymentResponse 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" />
</AcknowledgePaymentResponse>

PaymentMethod

POST api/PaymentMethod/Get

This operation returns saved payment method.

GetPaymentMethodRequest

NameDescriptionTypeAdditional information
CustomerId

Client facing customer identifier

globally unique identifier

None.

PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string

None.

PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string

None.

Request Formats

 
{
  "CustomerId": "ddd19004-c5b3-470f-a97f-333dca1fc193",
  "PortalOneSessionKey": "d04a0853-e8d6-4ad8-9b9f-1dc0c8102601",
  "PortalOneAuthenticationKey": null
}
<GetPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey i:nil="true" />
  <PortalOneSessionKey>d04a0853-e8d6-4ad8-9b9f-1dc0c8102601</PortalOneSessionKey>
  <CustomerId>ddd19004-c5b3-470f-a97f-333dca1fc193</CustomerId>
</GetPaymentMethodRequest>

Response Information

GetPaymentMethodResponse

NameDescriptionTypeAdditional information
PaymentMethods

Payment methods

Collection of PaymentMethod

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

IEnumerableOfPaymentMethod

NameDescriptionTypeAdditional information
PaymentMethodId

Payment method identifier

integer

None.

CustomerId

Customer identifier

integer

None.

PolicyHashId

Policy hash identifier

integer

None.

PaymentMethodType

Payment method type

PaymentMethodType

None.

ProcessOneToken

ProcessOne payment token

string

None.

IsDefault

Is default flag

boolean

None.

CardExpirationMonth

Card expiration month

integer

None.

CardExpirationYear

Card expiration year

integer

None.

CustomerName

Customer name

string

None.

DateAdded

Date when payment method was added

date

None.

BillingZipCode

ZIP Code

string

None.

CreditCardType

Card type

CreditCardType

None.

BankAccountType

Bank account type

EftAccountType

None.

LastFour

Last for digits

string

None.

CardHolderAddress

Card holder address

string

None.

BankName

Bank name

string

None.

PaymentMethodType

Possible enumeration values:

NameValueDescription
CreditCard

0

Credit card

Eft

1

Eft

Response Formats

{
  "PaymentMethods": [
    {
      "PaymentMethodId": 1,
      "CustomerId": 1,
      "PolicyHashId": 0,
      "PaymentMethodType": "CreditCard",
      "ProcessOneToken": "19115ff6-f2fd-4846-9155-7db558c169e1",
      "IsDefault": false,
      "CardExpirationMonth": 1,
      "CardExpirationYear": 2021,
      "CustomerName": "Janet Smith",
      "DateAdded": "2019-09-19T08:24:43.384946-07:00",
      "BillingZipCode": "12345",
      "CreditCardType": "Visa",
      "BankAccountType": "Undefined",
      "LastFour": "1111",
      "CardHolderAddress": "64, Force Hill Rd, Livingston, NJ",
      "BankName": null
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetPaymentMethodResponse 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" />
  <PaymentMethods>
    <PaymentMethod>
      <BankAccountType>Undefined</BankAccountType>
      <BankName i:nil="true" />
      <BillingZipCode>12345</BillingZipCode>
      <CardExpirationMonth>1</CardExpirationMonth>
      <CardExpirationYear>2021</CardExpirationYear>
      <CardHolderAddress>64, Force Hill Rd, Livingston, NJ</CardHolderAddress>
      <CreditCardType>Visa</CreditCardType>
      <CustomerId>1</CustomerId>
      <CustomerName>Janet Smith</CustomerName>
      <DateAdded>2019-09-19T08:24:43.384946-07:00</DateAdded>
      <IsDefault>false</IsDefault>
      <LastFour>1111</LastFour>
      <PaymentMethodId>1</PaymentMethodId>
      <PaymentMethodType>CreditCard</PaymentMethodType>
      <PolicyHashId>0</PolicyHashId>
      <ProcessOneToken>19115ff6-f2fd-4846-9155-7db558c169e1</ProcessOneToken>
    </PaymentMethod>
  </PaymentMethods>
</GetPaymentMethodResponse>

POST api/PaymentMethod/GetDefault

This operation returns default payment method.

GetDefaultPaymentMethodRequest

NameDescriptionTypeAdditional information
CustomerId

Client facing customer identifier

globally unique identifier

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "CustomerId": "2fb02c40-4752-4b95-94bb-fe91b5454ab1",
  "PortalOneSessionKey": "1f1b590e-dfdc-49bc-8794-92741f875236"
}
<GetDefaultPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>1f1b590e-dfdc-49bc-8794-92741f875236</PortalOneSessionKey>
  <CustomerId>2fb02c40-4752-4b95-94bb-fe91b5454ab1</CustomerId>
</GetDefaultPaymentMethodRequest>

Response Information

GetDefaultPaymentMethodResponse

NameDescriptionTypeAdditional information
PaymentMethod

Default payment method

PaymentMethod

None.

ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

PaymentMethod

NameDescriptionTypeAdditional information
PaymentMethodId

Payment method identifier

integer

None.

CustomerId

Customer identifier

integer

None.

PolicyHashId

Policy hash identifier

integer

None.

PaymentMethodType

Payment method type

PaymentMethodType

None.

ProcessOneToken

ProcessOne payment token

string

None.

IsDefault

Is default flag

boolean

None.

CardExpirationMonth

Card expiration month

integer

None.

CardExpirationYear

Card expiration year

integer

None.

CustomerName

Customer name

string

None.

DateAdded

Date when payment method was added

date

None.

BillingZipCode

ZIP Code

string

None.

CreditCardType

Card type

CreditCardType

None.

BankAccountType

Bank account type

EftAccountType

None.

LastFour

Last for digits

string

None.

CardHolderAddress

Card holder address

string

None.

BankName

Bank name

string

None.

Response Formats

{
  "PaymentMethod": {
    "PaymentMethodId": 1,
    "CustomerId": 1,
    "PolicyHashId": 0,
    "PaymentMethodType": "CreditCard",
    "ProcessOneToken": "f1c77781-63a6-4a3a-9492-22daf96dcc18",
    "IsDefault": true,
    "CardExpirationMonth": 1,
    "CardExpirationYear": 2021,
    "CustomerName": "Janet Smith",
    "DateAdded": "2019-09-19T08:24:43.5099448-07:00",
    "BillingZipCode": "12345",
    "CreditCardType": "Visa",
    "BankAccountType": "Undefined",
    "LastFour": "1111",
    "CardHolderAddress": "64, Force Hill Rd, Livingston, NJ",
    "BankName": null
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetDefaultPaymentMethodResponse 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" />
  <PaymentMethod>
    <BankAccountType>Undefined</BankAccountType>
    <BankName i:nil="true" />
    <BillingZipCode>12345</BillingZipCode>
    <CardExpirationMonth>1</CardExpirationMonth>
    <CardExpirationYear>2021</CardExpirationYear>
    <CardHolderAddress>64, Force Hill Rd, Livingston, NJ</CardHolderAddress>
    <CreditCardType>Visa</CreditCardType>
    <CustomerId>1</CustomerId>
    <CustomerName>Janet Smith</CustomerName>
    <DateAdded>2019-09-19T08:24:43.5099448-07:00</DateAdded>
    <IsDefault>true</IsDefault>
    <LastFour>1111</LastFour>
    <PaymentMethodId>1</PaymentMethodId>
    <PaymentMethodType>CreditCard</PaymentMethodType>
    <PolicyHashId>0</PolicyHashId>
    <ProcessOneToken>f1c77781-63a6-4a3a-9492-22daf96dcc18</ProcessOneToken>
  </PaymentMethod>
</GetDefaultPaymentMethodResponse>

POST api/PaymentMethod/SetDefault

This operation sets the default payment method.

SetDefaultPaymentMethodRequest

NameDescriptionTypeAdditional information
PaymentMethodId

Payment method identifier

integer

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "PaymentMethodId": 1,
  "PortalOneSessionKey": "cd78897f-ee0a-4166-8192-5c9b00074ad9"
}
<SetDefaultPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>cd78897f-ee0a-4166-8192-5c9b00074ad9</PortalOneSessionKey>
  <PaymentMethodId>1</PaymentMethodId>
</SetDefaultPaymentMethodRequest>

Response Information

SetDefaultPaymentMethodResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SetDefaultPaymentMethodResponse 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" />
</SetDefaultPaymentMethodResponse>

POST api/PaymentMethod/Delete

This operation removes payment method.

DeletePaymentMethodRequest

NameDescriptionTypeAdditional information
PaymentMethodId

Payment method identifier

integer

None.

PortalOneSessionKey

Session key

string

None.

Request Formats

 
{
  "PaymentMethodId": 1,
  "PortalOneSessionKey": "7d90008d-e0ca-434d-9f28-3bc10b664a50"
}
<DeletePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>7d90008d-e0ca-434d-9f28-3bc10b664a50</PortalOneSessionKey>
  <PaymentMethodId>1</PaymentMethodId>
</DeletePaymentMethodRequest>

Response Information

DeletePaymentMethodResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

None.

ResponseMessage

Response message

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<DeletePaymentMethodResponse 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" />
</DeletePaymentMethodResponse>