Method deposit-to-card
URL: POST - /partner/transfer/deposit-to-card
The method allows you to top up the client's bank card from the partner's deposit with cash and receive the result of executing the request in JSON format.
The partner's deposit must have enough funds to top up the client's bank card before executing the request.
Header parameters
| Parameter | Type | Description |
|---|---|---|
| client-id * | authorization | Unique Partner ID |
| client-secret * | authorization | Unique authentication key for VIA API |
Request parameters
| Parameter | Type | Description |
|---|---|---|
| externalId * | string | Unique Partner Request ID |
| amount * | integer | Transfer amount in cents (1/100 part of the base currency unit) |
| sender * | object | Sender's Data Object |
| sender.firstName * | string | Sender's first name |
| sender.lastName * | string | Sender's last name |
| sender.middleName * | string | Sender's middle name |
| receiverPan * | string | Client's bank card number for replenishment |
| currency * | string | Currency: «UZS» - Uzbek sum |
| note * | string | Notes, remarks, etc. |
Request sample
curl POST '/partner/transfer/deposit-to-card' \
--header 'client-id: system' \
--header 'client-secret: system123' \
--data '{
"externalId": "string",
"amount": 1000,
"sender": {
"firstName": "John",
"lastName": "Doe",
"middleName": "Smith"
},
"receiverPan": "8600490100715135",
"currency": "UZS",
"note": "P2P for card"
}'
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | object | Response data object |
| transactionId | object | Transaction ID |
| note | string | Notes, remarks, etc. |
| externalId | string | Unique Partner Request ID |
| processPayerTransactionId | string | Sender's processing system transaction identifier |
| processReceiverTransactionId | string | Receiver's processing system transaction ID |
| merchantId | string | VIA Merchant ID |
| status | string | Transaction status: «SUCCESS» - Successful «ERROR» - Error «REJECT» - Refused «PENDING» - Pending «NEW» - New «DRAFT» - Draft |
| amount | integer | Transfer amount in cents (1/100 part of the base currency unit) |
| fee | integer | Commission amount in cents (1/100 part of the base currency unit) |
| feePercent | long | Commission amount as a percentage |
| currency | string | Currency: «UZS» - Uzbek sum |
| errorCode | string | Error code |
| errorMessage | string | Description of the error |
| refundedAmount | integer | Refund amount in cents (1/100 part of the base currency unit) |
| modifiedAt | integer | Transaction update date and time in Unix Timestamp format |
| createdAt | integer | Date and time the transaction was created in Unix Timestamp format |
| payedAt | integer | Payment date and time in Unix Timestamp format |
| process | string | Processing type «UZCARD» «HUMO» |
| epos | object | EPOS system data object |
| epos.merchantId | string | Merchant ID |
| epos.terminalId | string | Terminal ID |
Example response if successful
{
"data": {
"transactionId": "trx_2TEt8TonK6VhrewD78Wv0QXuZEQ",
"note": «sample request»,
"externalId": "trx_2TEt8TonK6VhrewD78Wv0QXuZEQ",
"processPayerTransactionId": "bw_2TEt8UFOloG4VZevOGT4OQThhuF",
"processReceiverTransactionId": "trx_2isdflkUHuh98237KJhw87",
"merchantId": "terrx_2TEt8TonK6VhrewD78Wv0QXu",
"status": "SUCCESS",
"amount": 100000,
"fee": 0,
"feePercent": 0,
"currency": "UZS",
"errorCode": "",
"errorMessage": "",
"refundedAmount": 0,
"modifiedAt": 0,
"createdAt": 0,
"payedAt": 0,
"process": "UZCARD",
"epos": {
"merchantId": "trx_2TEt8TonK6VhrewD78Wv0QXuZEQ",
"terminalId": "trx_2TEt8TonK6VhrewD78Wv0QXuZEQ"
}
}
}
Example response in case of error
{
"status": {
"code": "1234",
"message": "Error while executing the request"
},
"error": {
"path": "URL Path",
"message": {
"uz": "Error message in Uzbek",
"ru": "Error message in Russian",
"en": "Error message in English"
}
}
}