Whitelist IBAN

Endpoint : POST https://api.zamp.finance/api/client/:clientid/customer/:customerid/whitelist/iban

Request

The request body captures the necessary details of a bank account. Use this API for whitelisting an IBAN for seamless fiat payins. Ensure that before any Fiat deposits the IBAN is whitelisted because only first party payins are allowed.

Fields Description

Key	Type	Description	Required
account_holder_name	string	The name of the account holder.	Yes
IBAN	string	The International Bank Account Number.	Yes
bank_name	string	The name of the bank.	No
bank_address	Address	The address of the bank.	No
currency	string	The currency of the bank account (e.g., AED).	No
banking_routing_code_type	string	The Routing code type of bank account (WIRE, SWIFT, LOCAL)	No
banking_routing_code_value	string	The Routing code value	No
account_ownership_document	string	The document proving ownership of the account in base64 encoding.	Yes

Address

Key	Type	Description	Required
address1	string	The primary address line.	No
city	string	The city of the address.	No
country	string	The country of the address.	No
state	string	The state of the address.	No
zip_code	string	The ZIP code of the address.	No

Example JSON Request

{
  "account_holder_name": "test",
  "IBAN": "37681",
  "bank_name": "test",
  "bank_address": {
      "address1": "test",
      "city": "test",
      "country": "US",
      "state": "Ohio",
      "zip_code": "43057"
    },
  "currency": "AED",
  "account_ownership_document": "base64 of the document",
  "banking_routing_code_value":"",
  "banking_routing_code_type":""
}

Response

Key	Type	Description	Required
id	string	The ID of the whitelisted deposit account resource.	Yes
beneficiary_id	string	When whitelisting an IBAN, a corresponding beneficiary ID is automatically created. This ensures that merchants can seamlessly initiate payouts to the same IBAN without the need to recreate the beneficiary, streamlining the process and improving efficiency.	Yes
status	string	The status of the whitelisted deposit account resource.	Yes

JSON Response

{
  "id": "merchant_uNR5Kc6a2zTdfqbLsDwxUZ_06_15", // The ID of the whitelisted deposit account resource.
  "beneficiary_id": "merchant_beR5Kb6atrTdfqbytDwxnc_06_15",
  "status": "whitelisted resource status"
}