Sign in

v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

Create Payout Destination

post/payout-destination

Request body

account_idstring required

This represents the id of the account you are making a payout from

source_type'bank_account' | 'wallet_account' required
labelstring required
type'internal' | 'wire' | 'nip' | 'stablecoin' | 'mobile_money' required

Select the wire option for payouts to USD bank accounts, the NIP option for payouts to NGN bank accounts, internal for payouts to Graph wallet accounts, and stablecoin for payouts to an on-chain wallet address.

wire_type'ach' | 'fedwire' | 'swift'

Required for USD payouts via wire.

destination_account_idstring

This applies for making internal transfers to an account created on Graph

destination_type'bank_account' | 'wallet_account' | 'address' | 'mobile_money'
account_type'personal' | 'business'

Beneficiary's account type

bank_codestring

Beneficiary bank code. ONLY required for NGN payouts

account_numberstring

Beneficiary's account number required for all payouts to a bank account.

routing_numberstring

Routing Number is required for domestic USD payouts (to US based banks) while SWIFT code is required for USD payouts to non-US based banks.

beneficiary_namestring

Required for USD payouts

bank_namestring

Beneficiary bank information required for USD payout (both domestic and international).

address_codestring

This should be the wallet address you are paying out to

address_network'ERC20' | 'TRC20' | 'POL'
currency'USDC' | 'USDT'
operator_codestring

Required for mobile money payouts e.g "airtel-gh"

country_codestring
phone_numberstring

Response

201

OR
OR
OR

Example response

{
  "data": {
    "id": "a608dece7c2511edb3220242ac110002",
    "account_id": "8a6f70b87c1411edb3220242ac110002",
    "destination_account_id": "837edb267c1311edb3220242ac110002",
    "label": "Master Destination",
    "type": "internal",
    "beneficiary_name": "ONYENDOCHUKWU NDU",
    "account_number": "9992740188488868",
    "account_type": "personal_checking",
    "routing_number": "084106768",
    "routing_type": "aba",
    "bank_name": "Evolve Bank and Trust",
    "bank_address": {
      "city": "Memphis",
      "country": "US",
      "line1": "6070 Poplar Ave",
      "line2": "Suite 200",
      "postal_code": "38119",
      "state": "TN"
    },
    "created_at": "2022-12-15T03:07:45Z",
    "updated_at": "2022-12-15T03:07:45Z"
  },
  "message": "Payout destination already exists on this organisation",
  "status": "success"
}