Create Fiat Beneficiary

For each reciever, you need to create a beneficiary on the platform. We will return a beneficiaryId, which can be used to make transfers.

We will run an AML and Sanctions check on them once added into the platform.

Endpoint : POST https://api.zamplabs.com/api/v1/transfer/fiat/beneficiary

This API will create Fiat beneficiary

Request Body For USD Beneficiary

Key	Value	Description	Optional
beneficiary_first_name	String	First Name of the beneficiary in String format (beneficiary_account_type is Individual)	N
beneficiary_last_name	String	Last Name of the beneficiary in String format (beneficiary_account_type is Individual)	N
beneficiary_name	String	Last Name of the beneficiary in String format (beneficiary_account_type is Corporate)	N
beneficiary_email	String	Email of the beneficiary in String format	Y
beneficiary_account_type	Individual or Corporate	Type of the beneficiary	N
destination_currency	String	Destination currency of the beneficiary in String format (USD,USDC)	N
transfer_type	String	SWIFT,ACH,LOCAL	N
destination_country	String	ISO 3166 standard currency Code. (US)	N
beneficiary_country_code	ISO 3166 standard currency Code. (US)	Country which the beneficiary resides in	Y
routing_code_type_1	ACH CODE or SWIFT	Routing code depending on the transfer type	N
routing_code_value_1	String	Routing value depending on the transfer type (ACH CODE/SWIFT)	N
routing_code_type_2	String	Routing code depending on the transfer type	Y
routing_code_value_2	String	Routing value depending on the transfer type	Y
beneficiary_state	String	State which the beneficiary resides in	N
beneficiary_address	String	Address line of the beneficiary	N
beneficiary_city	String	City which the beneficiary resides in	N
beneficiary_postcode	String	Post code of the address which the beneficiary resides in	N
beneficiary_account_number	AlphaNumeric	beneficiary account number to which payout needs to be made	N
beneficiary_contact_country_code	Numeric	beneficiary contact country code	Y
beneficiary_contact_number	Numeric	beneficiary contact number	Y
beneficiary_alias	String	beneficiary nick name	Y
beneficiary_bank_name	AlphaNumeric	beneficiary bank name	Y
beneficiary_bank_address	String	beneficiary bank address (required if routing_code_type_1 is SWIFT)	Y
beneficiary_bank_city	String	beneficiary bank city (required if routing_code_type_1 is SWIFT )	Y
beneficiary_bank_postcode	String	beneficiary bank postcode (required if routing_code_type_1 is SWIFT)	Y
beneficiary_bank_state	String	beneficiary bank state (required if routing_code_type_1 is SWIFT )	Y
beneficiary_bank_country_code	String	beneficiary bank country code (required if routing_code_type_1 is SWIFT)	Y

Request JSON Representation of USD Beneficiary

{
    "beneficiary_name": "VARNI TECH",
    "beneficiary_account_type": "Corporate",
    "beneficiary_address": "651 N Broad St Suite 201",
    "beneficiary_city": "Middletown",
    "beneficiary_country_code": "US",
    "beneficiary_email": "",
    "beneficiary_postcode": "43058",
    "beneficiary_state": "ohio",
    "beneficiary_contact_country_code": "",
    "beneficiary_contact_number": "",
    "destination_currency": "USD",
    "destination_country": "US",
    "beneficiary_account_number": "8508697976",
    "beneficiary_alias": "YUN HI",
    "beneficiary_bank_name": "Bank of New York Mellon ",
    "transfer_type": "SWIFT",
    "routing_code_type_1": "SWIFT",
    "routing_code_value_1": "IRVTUS3N",
    "routing_code_type_2": "",
    "routing_code_value_2": "",
    "beneficiary_bank_address": "225 Liberty Street,",
    "beneficiary_bank_city": "New York",
    "beneficiary_bank_postcode": "10286",
    "beneficiary_bank_state": "New York",
    "beneficiary_bank_country_code": "US"

}

Request Body For INR Beneficiary

Key	Value	Description	Optional
beneficiary_first_name	String	First Name of the beneficiary in String format (beneficiary_account_type is Individual)	N
beneficiary_last_name	String	Last Name of the beneficiary in String format (beneficiary_account_type is Individual)	N
beneficiary_name	String	Name of the beneficiary in String format (beneficiary_account_type is Corporate)	N
beneficiary_account_type	Individual or Corporate	Type of the beneficiary	N
destination_currency	String	Destination currency of the beneficiary in String format (INR)	N
transfer_type	String	LOCAL	N
destination_country	String	ISO 3166 standard currency Code. (US)	N
beneficiary_country_code	ISO 3166 standard currency Code. (US)	Country which the beneficiary resides in	N
routing_code_type_1	String	Routing code depending on the transfer type	N
routing_code_value_1	String	Routing value depending on the transfer type (IMPS)	N
beneficiary_state	String	State which the beneficiary resides in	N
beneficiary_address	String	Address line of the beneficiary	N
beneficiary_city	String	City which the beneficiary resides in	N
beneficiary_postcode	String	Post code of the address which the beneficiary resides in	N
beneficiary_account_number	AlphaNumeric	beneficiary account number to which payout needs to be made	N
beneficiary_contact_country_code	Numeric	beneficiary contact country code	N
beneficiary_contact_number	Numeric	beneficiary contact number	N
beneficiary_alias	String	beneficiary nick name	N
beneficiary_bank_name	AlphaNumeric	beneficiary bank name	N
beneficiary_bank_address	String	beneficiary bank address	N
beneficiary_bank_city	String	beneficiary bank city	N
beneficiary_bank_postcode	String	beneficiary bank postcode	N
beneficiary_bank_state	String	beneficiary bank state	N
beneficiary_bank_country_code	String	beneficiary bank country code	N
currency_type	String	Fiat	N
beneficiary_bank_account_type	String	Business Checking, Business Savings, Personal Checking, Personal Savings	N

Request JSON Representation of INR Beneficiary

{
  "beneficiary_first_name": "VARNI",
  "beneficiary_last_name": "TECH",
  "beneficiary_email": "[email protected]",
  "beneficiary_account_type": "Individual",
  "counter_party_alias": "test",
  "beneficiary_relationship": "CUSTOMER",
  "destination_currency": "INR",
  "transfer_type": "LOCAL",
  "destination_country": "IN",
  "beneficiary_country_code": "IN",
  "routing_code_type_1": "IFSC",
  "routing_code_value_1": "ICIC0006614",
  "beneficiary_state": "Delhi",
  "beneficiary_address": "test",
  "beneficiary_city": "test",
  "beneficiary_postcode": "test",
  "beneficiary_account_number": "8391890218901",
  "beneficiary_contact_country_code": "+91"
  "beneficiary_contact_number": "9837182191",
  "beneficiary_alias": "test INR bene",
  "beneficiary_bank_name": "ICICIC",
  "beneficiary_bank_address": "test",
  "beneficiary_bank_city": "test",
  "beneficiary_bank_postcode": "test",
  "beneficiary_bank_state": "Delhi",
  "currency_type": "Fiat",
  "beneficiary_bank_country_code": "IN",
  "beneficiary_bank_account_type": "Business Savings",

}

Response Body

Key	Value	Description
beneficiary_id	merchant_jXHm4aJH4vUmgcT6bmYGwD_11_30	This is the UUID with which merchant can uniquely identify a beneficiary on Zamp systems

Response JSON Representation

{
    "data": {
        "beneficiary_id": "merchant_jXHm4aJH4vUmgcT6bmYGwD_11_30"
    }
}

Error Codes

HTTP Code	Error Response	Description
404	{"code":"RECORD_NOT_FOUND","message":"Unable to find the record requested."}	Failed to find the configuration required to add the Beneficiary for the Merchant. Please contact the Zamp team if this happens
403	{"code":"BENEFICIARY_CREATION_NOT_ALLOWED","message":"Beneficiary creation not allowed"}	The Merchant is not allowed to create a beneficiary.