v1

latestOpenAPI 3.0.02026-07-145016.7 KB
Recipients

Fetch Recipient

Allows a user to fetch recipient details.<br><br>

get/accounts/recipients/{recipientIdentifier}

Path parameters

recipientIdentifierstring required

Recipient Identifier

Headers

Content-Typestring
Authorizationstring

Response

Successful response

identifierstring
recipient_typestring
namestring
relationshipstring
emailstring
eid_numberstring
reasonstring
created_atstring
recipient_metaobject

Example response

{
  "identifier": "REP-D8B07FB8C7",
  "name": "first name last name",
  "recipient_type": "individual",
  "relationship": "others",
  "reason": "reason",
  "email": null,
  "eid_number": null,
  "address": null,
  "bank": {
    "iban": "AE080200000123223333121",
    "country": "AE",
    "name": null,
    "account_number": null,
    "address": null,
    "city": null,
    "bic_code": null
  },
  "created_at": "19/02/2024",
  "recipient_meta": {}
}