Sign in

v1

latestOpenAPI 3.1.02026-07-226250251.5 KB
Beneficiaries

Create Beneficiary V3

Create a new beneficiary for payments and transfers. Supports bank accounts, e-wallets, and external crypto wallets as destination types.

post/v3/beneficiaries

Request body

OR
OR

Example request

{
  "customer_id": "6fa1ccd4-ffbd-4b20-a113-ccc286b35443",
  "country": "BGD",
  "currency": "BDT",
  "counter_party": "FIRST_PARTY",
  "account_holder": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+8801912244626"
  },
  "account_holder_address": {
    "street_line_1": "42 Wallaby Way",
    "city": "Dhaka",
    "state": "BD-13",
    "postcode": "1212",
    "country": "BGD"
  },
  "receiver_meta_data": {
    "nationality": "AUS",
    "transaction_purpose_id": 1,
    "occupation_id": 5,
    "occupation_remarks": "Software Engineer",
    "relationship": "FAMILY_MEMBER",
    "relationship_remarks": "Family & Friends",
    "govt_id_number": "JG1121316A",
    "govt_id_issue_date": "2024-12-30",
    "govt_id_expire_date": "2027-12-30"
  },
  "developer_fee": {
    "fixed": 0.02,
    "percentage": 0.01
  },
  "bank_account": {
    "bank_name": "Commonwealth Bank of Australia",
    "number": "1234572211",
    "scheme": "LOCAL",
    "type": "SAVINGS"
  },
  "bank_address": {
    "street_line_1": "Ground Floor Tower 1, 201 Sussex Street",
    "city": "Dhaka",
    "state": "BD-13",
    "postcode": "1212",
    "country": "BGD"
  },
  "bank_routing": [
    {
      "scheme": "SWIFT"
    }
  ],
  "deposit_instruction": {
    "currency": "USDC",
    "rail": "POLYGON"
  },
  "refund_instruction": {
    "wallet_address": "0x1b577931C1cC2765024bFbafad97bCe14FF2e87F",
    "currency": "USDC",
    "rail": "POLYGON"
  },
  "settlement_config": {
    "auto_settlement": true
  }
}

Response

Beneficiary created successfully

Example response

{
  "data": {
    "beneficiary_id": "0254b433-e47d-412e-844b-b735c4bbba74"
  }
}