rapidTransferObject

rapidTransfer

object

oneOf

bacsObject

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.

]

sepaObject

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.

]