Deposit

Create a deposit request using the _id value you received from the Available Banks service.

The deposit model

Name
hash
Type
string
Description
Signature generated by us for callback verification.
Name
transactionId
Type
string
Description
The unique ID assigned to the transaction.
Name
bankId
Type
string
Description
ID of the relevant bank.
Name
bank
Type
string
Description
Name of the relevant bank.
Name
amount
Type
number
Description
The amount value you sent when creating the deposit request.
Name
type
Type
string
Description
Transaction type ( deposit ).
Name
bankAccountName
Type
string
Description
The bank account name where the deposit was made.
Name
bankAccountIban
Type
string
Description
The bank account number (IBAN) where the deposit was made.
Name
status
Type
string
Description
Transaction status ( pending ).
Name
name
Type
string
Description
The name value you sent when creating the deposit request.
Name
userName
Type
string
Description
The userName value you sent when creating the deposit request.
Name
userId
Type
string
Description
The userId value you sent when creating the deposit request.
Name
processId
Type
string
Description
The processId value you sent when creating the deposit request.
Name
convertedName
Type
string
Description
A slugified version of the name value you sent when creating the deposit request.
Name
url
Type
string
Description
The page link where the user can view the payment details.
Name
alreadyPending
Type
boolean
Description
Optional. If true, a new deposit was not created and the existing pending deposit was returned instead.

POST/transactions/deposit

Create a deposit

This endpoint allows you to create a new deposit request.

Required attributes

Name
bankId
Type
string
Description
The _id value you received from the Available Banks service.
Name
processId
Type
string
Description
A unique identifier you assign for each transaction.
Name
amount
Type
number
Description
Deposit amount.
Name
userId
Type
string
Description
Your user's ID in your system.
Name
userName
Type
string
Description
Your user's username.
Name
name
Type
string
Description
Your user's full name.

Request

POST

/transactions/deposit

curl --location --request POST 'https://<service-name>.api.paypa.app/transactions/deposit' \
--header 'appKey={appKey}' \
--header 'sign:{signature}' \
--data-urlencode 'bankId=5fb103ee40c69600183ec990' \
--data-urlencode 'amount=100' \
--data-urlencode 'userId=123456789' \
--data-urlencode 'name=Test User' \
--data-urlencode 'userName=testUserName' \
--data-urlencode 'processId=1122334455'

Response

{
    "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",
        "url": "https://odeme.paypa.app/transaction/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFuc2FjdGlvbklkIjoiNjU2N2ZkNDk1NjgyZjcxZjk2MDc4YWVkIiwic2VydmljZSI6IjQiLCJzZXJ2aWNlVHlwZSI6ImNwYXBhcmEiLCJzZXJ2aWNlTmFtZSI6ImpveSIsIm1lcmNoYW50SWQiOiI2NGVmOTU3MmNkNDdjY2JlODFlNzcxYTkiLCJ0aGVtZSI6InN5c3RlbSIsImlhdCI6MTcwMTMxMjY2NiwiZXhwIjoxNzAxMzM0MjY2LCJzdWIiOiJwYXltZW50IiwianRpIjoiIn0.sNvjhZ0g1OPwU-vfxo9C5EI62bRxFtJxAwW79EemDos",
        "hash": "ENWnqnoIYk5OG2yKtYQnXqByrSB9X65ehS6oKVU/d0E="
      },
    "status": 200,
    "responseTime": "30ms",
    "app_version": "paypa-v0.0.1"
}