Deposit
After the successful validation, TCash then sends another request with the same information from the validation API call:
- UUID, string - Unique transaction ID
- account_id, string - User’s account identifier, as provided by the user or the vendor's system.
- amount, integer - The amount to deposit, in Euro cents (for 15€, the amount is 1500)
- money_transfer_code - an identifier of the money transfer to be used when discussing the deposit with the user or between our teams. alphanumerical in form XXX-XXX
- money_transfer_type_id - an integer representing the money transfer type. 1 is a TCash voucher. 2 is a direct deposit.
- details - a nested object containing the details of the location where the deposit was made, or the voucher was purchased
- venue_id - the id of the venue where the transaction was made
- venue_name - the name of the venue where the transaction was made, usually not user-friendly, used for internal identification purposes
- venue_city - the city where the transaction was made
- venue_municipality - the municipality where the transaction was made
- venue_address - the address of the venue where the transaction was made
This diagram shows the sequence of events:
The purpose of this two-step procedure
Example of the API call to make the deposit:
POST {{vendor-api-url}}/deposit
Headers: {
"secret": "S6WvLB298m1#"
}
Body: {
"uuid": "27ac82f0-6c3b-4bc3-81e9-e16daac90e6f",
"account_id": "123",
"amount": 1500,
"money_transfer_code": "4Q9-HUN",
"money_transfer_type_id": 1,
"details": {
"venue_id": "765",
"venue_name": "MyVenue123",
"venue_city": "CityName",
"venue_municipality": "85000",
"venue_address": "Example address 123/12"
}
}
- UUID is unique for the transaction. The same UUID is sent both for the validation call as well as the deposit call.
- If the validation passes, the deposit API call may be repeated until the external system returns a successful response. (HTTP 2xx). This ensures that the deposit will be made even in the case of a temporary system failure.