Partial update beneficiary

patch

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

Endpoint for partially updating an existing beneficiary.

Path Params

string

required

Body Params

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

OUR - Ours
BEN - Beneficiary
SHA - Shared

Full information for ChargeTypeEnum

Allowed:

contacts

array of strings

The contacts associated with the beneficiary. Can be multiple.

contacts

country

string

enum

SA - Kingdom of Saudi Arabia
AE - United Arab Emirates
QA - Qatar
BH - Bahrain
KW - Kuwait
OM - Oman
EG - Egypt
US - United States of America
AF - Afghanistan
AX - Åland Islands
...

Full information for CountryEnum

currency

string

enum

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
...

Full information for CurrencyEnum

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

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json