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.
Parameter | Type | Description |
---|---|---|
id | string | Unique identifier of the transaction in the ZWITCH database. Example: tr_9pBz9aE32SS82gTTOLb2qH6Wq |
object | string | API object that is returned. Possible value: transfer |
type | string | The type of transfer you want to make. Possible value: funding |
amount | float | Funding amount. This will be the same as the amount in the first funding UPI collect request. Example: 369.71 Supported characters:
|
debit_account_id | string | Unique identifier of your current receivable account. Example: ca_jIUfa7NiowG8QoZ8b45vhbRece Contact our Integrations Team if you have not received details of your receivable account. |
beneficiary_id | string | Unique identifier of the beneficiary created for first funding. This beneficiary is automatically created and cannot be used anywhere else. Example: sab_fC4xAhFMWOMwCWSBTpXNXU1l3 |
payment_id | string | Unique identifier of the first funding UPI collect request. Example: tx_HTxTuyMivai11FNGMNc07GMYP Learn more about first funding UPI collect. |
status | string | The status of the funding transfer. Possible values:
|
bank_reference_number | string | Unique reference number for the transfer sent by the bank. Example: STCB220221051342 |
currency_code | string | 3-character ISO currency code. Possible value: inr Supported characters:
|
message | string | Message explaining the status. Few possible values:
|
payment_mode | string | The mode used to complete the transfer. Possible values: ift |
payment_remark | string | A remark for the transfer. This is shown in the bank statement.
Zwitch for the win. |
beneficiary_name | string | Beneficiary's name. Example: Anil Reddy |
beneficiary_ifsc | string | Beneficiary bank IFSC. Example: HDFC0000123 |
otp_attempts | integer | Always 0 for first funding transfers. |
merchant_reference_id | string | Unique identifier entered when creating the transfer.
1409614085 |
metadata | object | Object of key-value pair that can be used to store additional information about the entity.
"key_1": "Zwitch to the moon.” |
transacted_at | integer | Unix timestamp when the transfer request was successfully processed. Example: 1640179951 |
created_at | integer | Unix timestamp when the create transfer request was received by ZWITCH. Example: 1640179951 |
is_sandbox | boolean | The mode in which the API was triggered. Possible values:
|