Sign in
Payees

Create a payee account

put/api/v2/payees/{payeeUid}/account

Path parameters

payeeUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Unique identifier of the payee

Request body

descriptionstring required

Account description

defaultAccountboolean required

Is this the default account for the owning payee

countryCodestring required

The country code for the account (ISO 3166-1 alpha-2)

accountIdentifierstring required

The account identifier

bankIdentifierstring required

The bank identifier

bankIdentifierType'SORT_CODE' | 'SWIFT' | 'IBAN' | 'ABA' | 'ABA_WIRE' | 'ABA_ACH' | 'BSB' required

The bank identifier type

secondaryIdentifierstring

Secondary reference data (SRD), if applicable

Example request

{
  "description": "Bob's business account",
  "defaultAccount": true,
  "countryCode": "GB",
  "accountIdentifier": "12345678",
  "bankIdentifier": "123456",
  "bankIdentifierType": "SORT_CODE"
}

Response

Successful operation

payeeAccountUidstring

The newly created payee unique identifier, only present on successful payee account creation

successboolean

True if the method completed successfully

Example response

{
  "payeeAccountUid": "66776677-6677-6677-6677-667766776677",
  "success": true,
  "errors": [
    {
      "message": "Something about the error"
    }
  ]
}