Create Deposit

Create a deposit 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	Deposit 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

POST - /api/transactions/deposit

curl -X POST "http://your-api-endpoint/api/transactions/deposit" \
     -H "Content-Type: application/json" \
     -H "ApiKey: your_api_key" \
     -d '{
            "bankId": "5fe0f093bb4f0b001b5ea63d",
            "amount": 100,
            "userId": "601e7af1-dd69-4fb6-9251-4874a86bf711",
            "name": "John Doe",
            "userName": "johndoe",
            "processId": "34887bf0-dfc5-4d4c-bf38-e6f3ecea4404"
         }'

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 deposit transaction
userId	string	The userId value you sent when creating the deposit transaction
name	string	The name value you sent when creating the deposit transaction
userName	string	The userName value you sent when creating the deposit transaction
processId	string	The processId value you sent when creating the deposit transaction
type	string	Transaction type ( deposit )
convertedName	string	A 'slugified' version of the name value you sent when creating the deposit transaction
status	string	Transaction status ( pending )
bank	string	Name of the relevant bank
bankAccountName	string	Bank account name where the deposit was made
bankAccountIban	string	Bank account number where the deposit was made
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
}