Create beneficiary

post

https://api.wafeq.com/v1/beneficiaries/

Endpoint for creating a new beneficiary.

Body Params

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

address

string

required

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

required

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

required

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

required

length ≤ 34

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

name

string

required

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

Language

Credentials

Header

Loading…

Response

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

application/json

201