Create Withdraw
Create a withdraw request using the _id value you received from the Available Banks service.
Request
Key | Type | Description |
---|---|---|
bankId | string | The _id value you receive from the Available Banks service |
amount | decimal | Withdraw amount |
userId | string | Your user's ID in your system |
name | string | Your user's username |
userName | string | Your user's first and last name |
processId | string | An ID value that will be unique to you for each transaction |
accountName | string | Account name to send money to |
iban | string | Account number to send money to |
POST - /api/transactions/withdraw
curl -X POST "http://your-api-endpoint/api/transactions/withdraw" \
-H "Content-Type: application/json" \
-H "ApiKey: your_api_key" \
-d '{
"bankId": "5fe0f093bb4f0b001b5ea63d",
"amount": 100,
"userId": "123456789",
"name": "John Doe",
"userName": "johndoe",
"processId": "601e7af1-dd69-4fb6-9251-4874a86bf711",
"iban": "TR280006276256222621885935",
"accountName": "John Doe",
}'
Response
Key | Type | Description |
---|---|---|
transactionId | string | The unique ID number we give you when creating a transaction |
bankId | string | Relevant bank id value |
amount | decimal | The amount value you sent when creating the withdraw transaction |
userId | string | The userId value you sent when creating the withdraw transaction |
name | string | The name value you sent when creating the withdraw transaction |
userName | string | The userName value you sent when creating the withdraw transaction |
processId | string | The processId value you sent when creating the withdraw transaction |
type | string | Transaction type ( withdrawal ) |
convertedName- | string | A 'slugified' version of the name value you sent when creating the deposit transaction |
bank | string | Name of the relevant bank |
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 ( pending ) |
hash | string | Signature created by us for callback verification |
{
"data": {
"transactionId": "613a0dbd63f54d00182f6414",
"bankId": "5fe25f6e3e73770018d47b15",
"amount": 100,
"userId": "123456789",
"name": "Test User",
"userName": "testUserName",
"processId": "1122334455",
"type": "deposit",
"convertedName": "testuser",
"status": "pending",
"bank": "Fake Bank",
"bankAccountName": "Fake Bank Account Name",
"bankAccountIban": "TR280006276256222621885935",
"hash": "ENWnqnoIYk5OG2yKtYQnXqByrSB9X65ehS6oKVU/d0E="
},
"status": 200,
"errorMessage": null
}