paymentInstrument

Various supported payment instruments.

oneOf

cardObject

card object

Card details to be used for the transaction

cardNumstringrequired

This is the card number used for the request.

Possible values: >= 8 characters and <= 20 characters

Example: 4111111111111111

cardExpiry object

This is the card's expiry date.

monthnumberrequired

This is the card expiry month.

Possible values: <= 12

Example: 12

yearnumberrequired

This is the card expiry year.

Possible values: <= 9999

Example: 2022

cvvstring

This is the 3- or 4-digit security code that appears on the card following the card number.

Possible values: >= 3 characters and <= 4 characters, Value must match regular expression ^([0-9]{3,4})$

holderNamestring

This is the name of the card holder.

Possible values: <= 50 characters

Example: Suresh's card

cardTypestring

This is type of card used for the request.

• AM – American Express

• DI – Discover

• JC – JCB

• MC – Mastercard

• MD – Maestro

• SO – Solo

• VI – Visa

• VD – Visa Debit

• VE – Visa Electron

Possible values: [AM, DI, JC, MC, MD, SO, VI, VD, VE]

lastDigitsstring

These are the last four digits of the card used for the request.

nickNamestring

This is the nickname the merchant has for the card holder.

cardBinstring

These are the first 6 digits of the card Bank Identification Number (BIN), for example: the first 6 digits of the card number.

Possible values: <= 6 characters

Example: 411111

rapidTransferObject

rapidTransfer object

oneOf

bacsObject

bacs object

Details of the bacs account to be used for the transaction.

nickNamestring

This is an alias for this bank account.

Possible values: <= 50 characters

Example: Sally's Barclays Account

accountHolderNamestringrequired

This is the name of the customer or company that owns the bank account.

Possible values: <= 18 characters

Example: XYZ Company

accountNumberstringrequired

This is the bank account number.

Possible values: <= 8 characters

Example: 98877219

sortCodestringrequired

This is the 6-digit sort code that identifies the financial institution and branch of the customer’s bank.

Possible values: <= 6 characters

Example: 321654

mandate objectrequired

Contains customer bank's mandate details

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

lastDigitsstring

These are the last two digits of the account number.

Possible values: <= 2 characters

Example: 11

mandates object[]

Array [

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

]

sepaObject

sepa object

These are the details of the sepa account used for the transaction.

nickNamestring

This is an alias for this bank account.

Possible values: <= 50 characters

Example: Sally's Barclays Account

accountHolderNamestringrequired

This is the name of the customer or company that owns the bank account.

Possible values: <= 32 characters

Example: XYZ Company

bicstring

This is the Bank Identifier Code for the consumer's bank account.

Possible values: >= 8 characters and <= 11 characters

Example: ABNANL2APIP

ibanstringrequired

This is the International Bank Account Number for the costumer's bank account.

Possible values: >= 8 characters and <= 34 characters

Example: DE89370400440532013000

mandate objectrequired

Contains customer bank's mandate details

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

lastDigitsstring

These are the last two digits of the iban.

Possible values: <= 2 characters

Example: 11

mandates object[]

Array [

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

]

fasterPaymentsObject

fasterPayments object

UK bank account details

accountHolderNamestringrequired

This is the name of the customer or company that owns the bank account.

Possible values: <= 140 characters

sortCodestringrequired

This is the sort code of the Bank.

Possible values: <= 6 characters

accountNumberstringrequired

This is the costumer's bank account number.

Possible values: >= 8 characters and <= 10 characters

lastDigitsstring

Last 2 digits of the bank account number.

Possible values: <= 2 characters

achObject

ach object

Details of the ach account to be used for the transaction.

accountHolderNamestringrequired

This is the name of the customer or company.

Possible values: <= 22 characters

Example: XYZ Company

payMethodstring

This is the payment type. Possible values are:

• WEB - Website originated debit (Personal bank accounts only).

• TEL - elephone-Initiated Entry (Personal bank accounts only).

• PPD - Personal account debit (Personal bank accounts only).

• CCD - Business account debit (Business bank accounts only).

Possible values: [WEB, TEL, PPD, CCD]

accountTypestring

This is the bank account type.

Possible values: [SAVINGS, CHECKING, LOAN]

accountNumberstringrequired

This is the bank account number.

Possible values: >= 4 characters and <= 17 characters

Example: 988772192

routingNumberstringrequired

For USD accounts, this is the 9-digit routing number of the bank.

Possible values: >= 9 characters and <= 9 characters

Example: 211589828

lastDigitsstring

This is returned in response. It contains only last 2 digits of bank account.

Possible values: >= 2 characters and <= 2 characters

Example: 92

bacsObject

bacs object

Details of the bacs account to be used for the transaction.

nickNamestring

This is an alias for this bank account.

Possible values: <= 50 characters

Example: Sally's Barclays Account

accountHolderNamestringrequired

This is the name of the customer or company that owns the bank account.

Possible values: <= 18 characters

Example: XYZ Company

accountNumberstringrequired

This is the bank account number.

Possible values: <= 8 characters

Example: 98877219

sortCodestringrequired

This is the 6-digit sort code that identifies the financial institution and branch of the customer’s bank.

Possible values: <= 6 characters

Example: 321654

mandate objectrequired

Contains customer bank's mandate details

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

lastDigitsstring

These are the last two digits of the account number.

Possible values: <= 2 characters

Example: 11

mandates object[]

Array [

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

]

sepaObject

sepa object

These are the details of the sepa account used for the transaction.

nickNamestring

This is an alias for this bank account.

Possible values: <= 50 characters

Example: Sally's Barclays Account

accountHolderNamestringrequired

This is the name of the customer or company that owns the bank account.

Possible values: <= 32 characters

Example: XYZ Company

bicstring

This is the Bank Identifier Code for the consumer's bank account.

Possible values: >= 8 characters and <= 11 characters

Example: ABNANL2APIP

ibanstringrequired

This is the International Bank Account Number for the costumer's bank account.

Possible values: >= 8 characters and <= 34 characters

Example: DE89370400440532013000

mandate objectrequired

Contains customer bank's mandate details

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

lastDigitsstring

These are the last two digits of the iban.

Possible values: <= 2 characters

Example: 11

mandates object[]

Array [

idstring

This is the id of the mandate that got created.

Example: abcdc28d-486e-4b0a-bbf9-314033863542

referencestringrequired

This is the identifier of the mandate in the banking system.

Example: ABCDEF0796

statusstring

This is the status of the mandate request response.

Possible values: [PENDING, ACTIVE, CANCELLED, INACTIVE]

statusReasonstring

This is the status reason of the mandate request response.

Possible values: [MERCHANT_CANCELLED, BANK_CANCELLED, DECLINED, REJECTED, DISPUTED, UNAUTHORIZED, TRANSFERRED]

Example: MERCHANT_CANCELLED

]

paymentInstrument

{
  "card": {
    "cardNum": "4111111111111111",
    "cardExpiry": {
      "month": 12,
      "year": 2022
    },
    "cvv": "string",
    "holderName": "Suresh's card",
    "cardType": "AM",
    "lastDigits": "string",
    "nickName": "string",
    "cardBin": "411111"
  }
}