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

]

rapidTransferObject

{
  "rapidTransfer": {
    "bacs": {
      "nickName": "Sally's Barclays Account",
      "accountHolderName": "XYZ Company",
      "accountNumber": "98877219",
      "sortCode": "321654",
      "mandate": {
        "id": "abcdc28d-486e-4b0a-bbf9-314033863542",
        "reference": "ABCDEF0796",
        "status": "PENDING",
        "statusReason": "MERCHANT_CANCELLED"
      },
      "lastDigits": "11"
    },
    "mandates": [
      {
        "id": "abcdc28d-486e-4b0a-bbf9-314033863542",
        "reference": "ABCDEF0796",
        "status": "PENDING",
        "statusReason": "MERCHANT_CANCELLED"
      }
    ]
  }
}