Sign in

v1

latestOpenAPI 3.0.02026-07-145016.7 KB
Recipients

Create Recipient

Allows a user to create recipient.<br><br>

post/accounts/recipients

Headers

Content-Typestring
Authorizationstring

Request body

recipient_type'individual' | 'business' required

The type of the recipient.

emailstring

Recipient's email.

business_namestring

Name of the recipient when recipient_type is business.

first_namestring

First name of the recipient when recipient_type is individual.

last_namestring

Last name of the recipient when recipient_type is individual.

relationship'business_associate_partner' | 'customer' | 'employee' | 'branch_representative_office' | 'subsidiary_company' | 'holding_company' | 'supplier' | 'creditor' | 'debtor' | 'franchisee_franchisor' | 'others' required

Recipient's relationship

reasonstring required

Reason for the payouts issued to this recipient.

eid_numberstring

Recipient's Emirates ID number.

recipient_metaobject

Example request

{
  "recipient_type": "individual",
  "first_name": "first name",
  "last_name": "last name",
  "relationship": "others",
  "reason": "reason",
  "bank": {
    "iban": "AE080200000123223333121",
    "country": "AE"
  }
}

Response

Successful response

identifierstring
recipient_typestring
namestring
relationshipstring
emailstring
eid_numberstring
reasonstring
created_atstring
recipient_metaobject

Example response

{
  "identifier": "REP-081BCADE9A",
  "email": null,
  "eid_number": null,
  "recipient_type": "individual",
  "relationship": "others",
  "recipient_meta": null,
  "name": "Test User",
  "created_at": "04/12/2025",
  "bank": {
    "name": null,
    "address": null,
    "country": "AE",
    "iban": "AE080200000123223333121",
    "account_number": null,
    "bic_code": null
  },
  "address": {
    "address_line1": null,
    "address_line2": null,
    "city": null,
    "state": null,
    "province": null,
    "zip": null,
    "country": null
  }
}