StatusLog In
API Reference and Guides

Sections

Theme switcher

/recipients/{recipientId}/payment-addresses

Header Parameters

idempotencystring
Max length
36
Pattern
^[a-zA-Z 0-9-_+=/]*$
Authorizationstring

Path Parameters

recipientIdstring Required
Min length
38
Max length
100
Pattern
[a-zA-Z]{1,63}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Body Parameters

payoutTypestring Required

Type of payout to be made. Please ensure you cross reference which routing details you are supplying with the payment type to avoid any payment failures.

Enum values:
swiftlocal
routingCodestring Required

Routing code of the recipients bank, usually a local clearing code (ie BSB) or a Swift code.

accountReferencestring Required

Specific account number for the recipients bank address. Usually an local account number or an IBAN.

accountNamestring

Name of the account holder, only required if this differs to the Recipient Name.

externalReferencestring

An optional value that can be passed in to later reference a related resource in the partner system.

currencystring Required

Currency of the recipients account.

Min length
3
Max length
3
clientAddressNamestring

Client reference name for the payment address.

bankCodestring

Bank Code of the recipients bank, only required for certain countries where both routing code and bank code are required.

bankCountrystring Required

Where the recipients bank address is located.

Min length
2
Max length
2
branchCodestring

Branch Code of the recipients bank, only required for certain countries where both routing code and branch codes are required.

accountTypestring

The type of account provided in accountReference. Only required for certain countries.

Enum values:
checkingcaccsavingsothothernronrinreresidentsvgs
intermediarystring

BIC code of bank acting as intermediary for the receiving bank.

Nullable:
True

Response

201
Object
Successful response.

Response Attributes

itemobject

Show child attributes

400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

Response Attributes

messagestring
errorsarray Required

Show child attributes

409
Object
Conflict

Response Attributes

messagestring
errorsarray Required

Show child attributes

500
Object
Unknown Error

Response Attributes

messagestring
errorsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?