Overview of the transfer object.

Shown below is a sample transfer object.

  "id": "tr_i0o9DqJB49JSVno2KD58JmUro",
  "object": "transfer",
  "type": "funding",
  "amount": 1,
  "debit_account_id": "ca_jIUfa7NiowG8QoZ8b45vhbRece",
  "beneficiary_id": "sab_fC4xAhFMWOMwCWSBTpXNXU1l3",
  "payment_id": "tx_HTxTuyMivai11FNGMNc07GMYP",
  "status": "success",
  "bank_reference_number": "STCB220221051342",
  "currency_code": "inr",
  "message": "SUCCESS",
  "payment_mode": "ift",
  "payment_remark": "first funding",
  "paid_to": "21317695883",
  "beneficiary_name": "Anil Reddy",
  "beneficiary_ifsc": "STCB0000065",
  "otp_attempts": 0,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  "merchant_reference_id": "12345678901",
  "transacted_at": 1667899370,
  "is_sandbox": true,
  "created_at": 1667899370

The table below lists the various parameters in the transfer object.

idstringUnique identifier of the transaction in the ZWITCH database.

Example: tr_9pBz9aE32SS82gTTOLb2qH6Wq
objectstringAPI object that is returned.

Possible value: transfer
typestringThe type of transfer you want to make.

Possible value: funding
amountfloatFunding amount.

This will be the same as the amount in the first funding UPI collect request.

Example: 369.71

Supported characters:
  • 0-9
  • .
debit_account_idstringUnique identifier of your current receivable account.

Example: ca_jIUfa7NiowG8QoZ8b45vhbRece

Contact our Integrations Team if you have not received details of your receivable account.
beneficiary_idstringUnique identifier of the beneficiary created for first funding.

This beneficiary is automatically created and cannot be used anywhere else.

Example: sab_fC4xAhFMWOMwCWSBTpXNXU1l3
payment_idstringUnique identifier of the first funding UPI collect request.

Example: tx_HTxTuyMivai11FNGMNc07GMYP

Learn more about first funding UPI collect.
statusstringThe status of the funding transfer.

Possible values:
  • success: The API call was successful. Money has been debited from your current account receivable and credited to the account you want to fund.
  • failed: The API call was successful, but the transfer could not be processed. Refer to the message parameter to know why the transfer failed.
bank_reference_numberstringUnique reference number for the transfer sent by the bank.

Example: STCB220221051342
currency_codestring3-character ISO currency code.

Possible value: inr

Supported characters:
  • a-z
messagestringMessage explaining the status.

Few possible values:
  • success: The API call was successful. Money has been debited from your current account receivable and credited to the account you want to fund.
payment_modestringThe mode used to complete the transfer.

Possible values: ift
payment_remarkstringA remark for the transfer. This is shown in the bank statement.

  • Only alphabets, numbers, and spaces are allowed.
  • Minimum: 1 character.
  • Maximum: 40 characters.
Example: Zwitch for the win.
beneficiary_namestringBeneficiary's name.

Example: Anil Reddy
beneficiary_ifscstringBeneficiary bank IFSC.

Example: HDFC0000123
otp_attemptsintegerAlways 0 for first funding transfers.
merchant_reference_idstringUnique identifier entered when creating the transfer.

  • Only alphabets and numbers are allowed.
  • Minimum: 7 characters.
  • Maximum: 40 characters.
Example: 1409614085
metadataobjectObject of key-value pair that can be used to store additional information about the entity.
  • Each pair cannot exceed 256 characters.
  • Maximum 5 key-value pairs.
Example: "key_1": "Zwitch to the moon.”
transacted_atintegerUnix timestamp when the transfer request was successfully processed.

Example: 1640179951
created_atintegerUnix timestamp when the create transfer request was received by ZWITCH.

Example: 1640179951
is_sandboxbooleanThe mode in which the API was triggered.

Possible values:
  • true: API was triggered in sandbox mode
  • false: API was triggered in live mode