Partial update beneficiary

patch

https://api.wafeq.com/v1/beneficiaries/{id}/

Endpoint for partially updating an existing beneficiary.

Path Params

string

required

Body Params

A bank account of a beneficiary that payments can be sent to.

address

string

The full address of the beneficiary.

bank_name

string

length ≤ 200

The name of the bank where the beneficiary account is held.

charge_type

string

enum

The charge type of the account, indicating how fees are handled.

View the enum reference

Allowed:

contacts

array of strings

The contacts associated with the beneficiary. Can be multiple.

contacts

country

string

enum

ISO 3166 two-letter country code of the beneficiary bank account.

View the enum reference

currency

string

enum

The currency of the beneficiary bank account. Must be a valid currency code.

View the enum reference

iban

string

length ≤ 34

The International Bank Account Number (IBAN) of the beneficiary account.

name

string

The name of the beneficiary. Must contain only Latin letters (A-Z), digits (0-9), and spaces.

swift

string

length ≤ 11

The SWIFT code (BIC) of the beneficiary bank.

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response