Post https://app.moneygraph.ai/api/v1/customer/recipient/create/{customer}
Authorization* string
Pass your {api_key} as a bearer token in the request header to authorize this call
customer* string
Customer ID. The ID or MCP Key of the onboarded customer.
international_remittance_id* uuid
ID of Recipient Country, learn more about getting international_remittance_id from https://app.moneygraph.ai/docs/reference/currencies.
first_name* string
Recipient First Name
middle_name string
Recipient Middle Name
last_name* string
Recipient Last Name
email* string
Recipient Email address
phone* string
Recipient Phone number
phone_iso2* string
Recipient Phone number iso2
delivery_method* string
Recipient Payout Method, must be between, bank, mobile_money, cash_pickup
agent_id uuid
Recipient Cash Pickup Agent, required if delivery_method is cash_pickup. Learn more about getting agent_id from https://app.moneygraph.ai/docs/reference/agents.
mobile_id uuid
Recipient Mobile Money Company, required if delivery_method is mobile_money. Learn more about getting agent_id from https://app.moneygraph.ai/docs/reference/networks.
crypto_id uuid
Recipient Crypto Currency Network, required if delivery_method is crypto. Learn more about getting crypto_id from https://app.moneygraph.ai/docs/reference/crypto.
mobile_money_number string
Recipient Mobile Money Phone Number, required if delivery_method is mobile_money.
crypto_address string
Recipient Crypto Address, required if delivery_method is crypto.
entity_type* string
Sender Entity Type, either personal or business, this is required if delivery_method is bank
routing_type string
Can be ACH_CODE, SWIFT, IFSC, SORT_CODE, BANK_CODE, BRANCH_CODE, BSB_CODE, LOCATION_ID, TRANSIT_NUMBER, This is always validated against recipient country, required if delivery_method is bank. Verify if routing_type is correct via https://app.moneygraph.ai/docs/reference/banks.
routing_code uuid
Bank routing code, required if delivery_method is bank. Verify if routing_code is correct via https://app.moneygraph.ai/docs/reference/banks.
acct_type_id uuid
Recipient Account Type, required if delivery_method is bank. Learn more about getting acct_type_id from https://app.moneygraph.ai/docs/reference/currencies under international remittance object.
acct_no string
Recipient Bank Account Number, required if delivery_method is bank.
acct_name string
Recipient Bank Account Name, required if delivery_method is bank.
state* string
Recipient State iso2
city* string
Recipient City
address* string
Recipient Address
postal_code* string
Recipient Postal/Zip Code
{
"message": "Recipient Added",
"status": "success",
"data": {
"id": "8d7a7950-d6d5-401d-a8a6-2d0c52dd12bc",
"first_name": "John",
"middle_name": "Son",
"last_name": "Derrick",
"email": "[email protected]",
"phone": "+2349012345678",
"from_currency": "USD",
"to_currency": "USD",
"currency_id": "d374d1fa-6a88-47b7-a5cc-94acb76610fc",
"transfer_purpose": "Education",
"delivery_method": "bank",
"image": null,
"country": "US",
"state": "DE",
"city": "City",
"address": "Address",
"postal_code": "90000",
"bank": {
"bank_name": "Bank of America",
"account_number": "12413523562366",
"account_name": "John Derick",
"account_type": "Checkings",
"routing_type": "SWIFT",
"routing_code": "ZEIBNGLA"
}
}
}