Validation

When validating the deposit TCash sends these parameters:

• UUID, string - Unique transaction ID
• account_id, string - User’s account identifier
• amount, integer - The amount to deposit, in cents (for 250 EUR, this amount is 25000)
• 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

The call is authorized by sending the header secret: <your-api-key>.

danger

Unless you request us to change the defaults, we do not use the "Bearer" prefix, we do not use the Authorization header. The header format is: secret: <your-api-key>

The external system needs to return a response with the status 2xx (valid) or 4xx (invalid), informing if the deposit is valid. In case of an invalid deposit, the system needs to return an explanation for the problem or an error code (account not found, user banned, amount not allowed, etc.) Any other response code will be considered as an error and the deposit will be rejected.

tip

Field names can be changed on request. Additional body or header fields can be added, such as API keys, tokens or similar parameters

Example of the API call to validate the deposit.

POST {{vendor-api-url}}/deposit-validation
Headers: {
"secret": "S6WvLB298m1#"
}
Body: {
"uuid": "27ac82f0-6c3b-4bc3-81e9-e16daac90e6f",
"account_id": "123",
"amount": 25000,
"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"
  }
}