Create Beneficiary Payment Detail

post

https://partner-api.getpliant.com/api/beneficiaries/{beneficiaryId}/payment-details

Create a new payment detail for a beneficiary.

Payment details contain the banking information required to process transfers to the beneficiary. You can create multiple payment details for different currencies or banking methods.

Path Params

beneficiaryId

uuid

required

The unique identifier of the beneficiary.

Body Params

bankCountry

string

required

The country where the bank is located in ISO 3166-1 alpha-2 format (e.g., DE for Germany, US for United States).

bankAccountCurrency

string

required

The currency of the bank account in ISO 4217 format, for example EUR for Euro or USD for US Dollar.

bankAccountType

string | null

enum

The type of bank account. The type can only be set when it makes sense in the bankCountry - currently only in GB. It will be ignored for other countries.

It can be one of the following values:

LOCAL: A local bank account within the same country.
INTERNATIONAL: An international bank account for cross-border transfers.

Allowed:

accountDetail

object

required

The account details. Which properties are set depends on the bankCountry and bankType.

Currently in GB:

LOCAL → accountNumber & sortCode
INTERNATIONAL → iban & bic

Everywhere else → iban & bic. In the future other rules may apply.

Responses

Language

Credentials

Bearer

JWT

URL

Response

Choose an example:

application/json

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

404Not Found. The requested resource could not be found.

409Conflict. The request could not be completed due to a conflict with the current state of the resource. You may retry the call.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.