Callbacks

After creating Deposit & Withdraw, we POST status updates in JSON format to an endpoint where you send us status updates. You can get information about the parameters sent below.

We may send you more than one callback for a transaction. For example, when a deposit is successful, a callback is sent to you regarding the "successful" status. However, in case of a systematic error, this transaction may turn into unsuccessful and a callback will be sent to you again. To avoid this anomaly, please process each callback we send only once.

Deposit Callback Payload

Key	Type	Description
hash	string	Signature created by us for callback verification
transactionId	string	The unique ID number we give you when creating a transaction
bankId	string	Relevant bank id value
bank	string	Name of the relevant bank
amount	decimal	Last amount. (the amount you will consider)
type	string	Transaction type ( deposit )
bankAccountName	string	Bank account name where the deposit was made
bankAccountIban	string	Bank account number where the deposit was made
status	string	Transaction status ( successful or unsuccessful )
statusReason	string	Reason for failure if status field is unsuccessful
name	string	The name value you sent when creating the deposit transaction
userName	string	The userName value you sent when creating the deposit transaction
userId	string	The userId value you sent when creating the deposit transaction
processId	string	The processId value you sent when creating the deposit transaction
convertedName	string	A 'slugified' version of the name value you sent when creating the deposit transaction

POST to your-callback-url

{
    "hash": "zzunnCrv6Sb38TU/dPYIl+9TKd8gT6iqrcxv+V32AFs=",
    "transactionId": "6575078b9e6bb1554a50b7b1",
    "bankId": "507f1f77bcf86cd799439011",
    "amount": 500,
    "userId": "987654",
    "name": "Test User",
    "userName": "testUserName",
    "processId": "123456789",
    "type": "deposit",
    "convertedName": "testuser",
    "bank": "Fake Bank",
    "bankAccountName": "Fake Bank Account Name",
    "bankAccountIban": "TR280006276256222621885935",
    "status": "successful",
    "statusReason": null
}

Withdraw Callback Payload

Key	Type	Description
hash	string	Signature created by us for callback verification
transactionId	string	The unique ID number we give you when creating a transaction
bankId	string	Relevant bank id value
bank	string	Name of the relevant bank
amount	decimal	Last amount. (the amount you will consider)
type	string	Transaction type ( withdraw )
accountName	string	The accountName value you sent when creating the withdraw transaction
iban	string	The iban value you sent when creating the withdraw transaction
status	string	Transaction status ( successful or unsuccessful )
statusReason	string	Reason for failure if status field is unsuccessful
name	string	The name value you sent when creating the withdraw transaction
userName	string	The userName value you sent when creating the withdraw transaction
userId	string	The userId value you sent when creating the withdraw transaction
processId	string	The processId value you sent when creating the withdraw transaction
convertedName	string	A 'slugified' version of the name value you sent when creating the deposit transaction

POST to your-callback-url

{
    "hash": "zzunnCrv6Sb38TU/dPYIl+9TKd8gT6iqrcxv+V32AFs=",
    "transactionId": "6575078b9e6bb1554a50b7b1",
    "bankId": "507f1f77bcf86cd799439011",
    "amount": 500,
    "userId": "987654",
    "name": "Test User",
    "userName": "testUserName",
    "processId": "123456789",
    "type": "withdraw",
    "convertedName": "testuser",
    "bank": "Fake Bank",
    "accountName": "Test User",
    "iban": "TR280006276256222621885935",
    "status": "successful",
    "statusReason": null
}