Create Recipient

Authorization* string

Pass your {api_key} as a bearer token in the request header to authorize this call

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, crypto

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

account_id uuid

Onboarded Customer ID, if this is provided, recipient will be registered under this customer and not your main account. This means your merchant account will be de debited to process remittance for the recipient but will not be registered as the sender