paymentInstrument

Various supported payment instruments.

oneOf

card

object

Card details to be used for the transaction

cardNum stringrequired

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

This is the card number used for the request.

cardExpiry

object

This is the card's expiry date.

month numberrequired

Possible values: <= 12

This is the card expiry month.

year numberrequired

Possible values: <= 9999

This is the card expiry year.

cvv string

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

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

holderName string

Possible values: <= 50 characters

This is the name of the card holder.

cardType string

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

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

lastDigits string

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

nickName string

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

cardBin string

Possible values: <= 6 characters

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

rapidTransfer

object

oneOf

bacsObject
sepaObject

bacs

object

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

nickName string

Possible values: <= 50 characters

This is an alias for this bank account.

accountHolderName stringrequired

Possible values: <= 18 characters

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

accountNumber stringrequired

Possible values: <= 8 characters

This is the bank account number.

sortCode stringrequired

Possible values: <= 6 characters

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

mandate

object

required

Contains customer bank's mandate details

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

lastDigits string

Possible values: <= 2 characters

These are the last two digits of the account number.

mandates

object[]

Array [

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

]

sepa

object

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

nickName string

Possible values: <= 50 characters

This is an alias for this bank account.

accountHolderName stringrequired

Possible values: <= 32 characters

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

bic string

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

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

iban stringrequired

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

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

mandate

object

required

Contains customer bank's mandate details

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

lastDigits string

Possible values: <= 2 characters

These are the last two digits of the iban.

mandates

object[]

Array [

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

]

fasterPayments

object

UK bank account details

accountHolderName stringrequired

Possible values: <= 140 characters

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

sortCode stringrequired

Possible values: <= 6 characters

This is the sort code of the Bank.

accountNumber stringrequired

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

This is the costumer's bank account number.

lastDigits string

Possible values: <= 2 characters

Last 2 digits of the bank account number.

ach

object

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

accountHolderName stringrequired

Possible values: <= 22 characters

This is the name of the customer or company.

payMethod string

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

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).

accountType string

Possible values: [SAVINGS, CHECKING, LOAN]

This is the bank account type.

accountNumber stringrequired

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

This is the bank account number.

routingNumber stringrequired

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

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

lastDigits string

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

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

bacs

object

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

nickName string

Possible values: <= 50 characters

This is an alias for this bank account.

accountHolderName stringrequired

Possible values: <= 18 characters

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

accountNumber stringrequired

Possible values: <= 8 characters

This is the bank account number.

sortCode stringrequired

Possible values: <= 6 characters

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

mandate

object

required

Contains customer bank's mandate details

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

lastDigits string

Possible values: <= 2 characters

These are the last two digits of the account number.

mandates

object[]

Array [

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

]

sepa

object

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

nickName string

Possible values: <= 50 characters

This is an alias for this bank account.

accountHolderName stringrequired

Possible values: <= 32 characters

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

bic string

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

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

iban stringrequired

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

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

mandate

object

required

Contains customer bank's mandate details

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

lastDigits string

Possible values: <= 2 characters

These are the last two digits of the iban.

mandates

object[]

Array [

id string

This is the id of the mandate that got created.

reference stringrequired

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

status string

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

This is the status of the mandate request response.

statusReason string

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

This is the status reason of the mandate request response.

]