GEgetpliant
Beneficiaries

Create Beneficiary Payment Detail

Changed on

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.

post/beneficiaries/{beneficiaryId}/payment-details

Request

Path parameters

beneficiaryIdstring uuid required

The unique identifier of the beneficiary.

Request body

bankCountrystring required

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

bankAccountCurrencystring required

The currency of the bank account in ISO 4217 format. For EUR, SEK, DKK, AED, CZK, HUF, NOK, PLN, RON accounts, accountDetail must include iban and bic. For GBP and USD accounts, see accountDetail: local account details for GB and US banks, otherwise iban and bic.

bankAccountType'LOCAL' | 'INTERNATIONAL' nullable

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.

Response

Ok

idstring uuid

The unique identifier of the beneficiary payment detail.

bankCountrystring

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

bankAccountCurrencystring

The currency of the bank account in ISO 4217 format. For EUR, SEK, DKK, AED, CZK, HUF, NOK, PLN, RON accounts, accountDetail must include iban and bic. For GBP and USD accounts, see accountDetail: local account details for GB and US banks, otherwise iban and bic.

bankAccountType'LOCAL' | 'INTERNATIONAL' nullable

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.
accountDetailAccountDetail (unresolved $ref)

Changes