Payox

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 created by us for callback verification

  • Name
    transactionId
    Type
    string
    Description

    The unique ID number we give you when creating a transaction

  • Name
    bankId
    Type
    string
    Description

    Relevant bank id value

  • Name
    bank
    Type
    string
    Description

    Name of the relevant bank

  • Name
    amount
    Type
    number
    Description

    The amount value you sent when creating the deposit transaction

  • Name
    type
    Type
    string
    Description

    Transaction type ( deposit )

  • Name
    bankAccountName
    Type
    string
    Description

    Bank account name where the deposit was made

  • Name
    bankAccountIban
    Type
    string
    Description

    Bank account number 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 transaction

  • Name
    userName
    Type
    string
    Description

    The userName value you sent when creating the deposit transaction

  • Name
    userId
    Type
    string
    Description

    The userId value you sent when creating the deposit transaction

  • Name
    processId
    Type
    string
    Description

    The processId value you sent when creating the deposit transaction

  • Name
    convertedName
    Type
    string
    Description

    A 'slugified' version of the name value you sent when creating the deposit transaction

  • Name
    url
    Type
    string
    Description

    Page link where you can see payment information

  • Name
    alreadyPending
    Type
    boolean
    Description

    It is an optional parameter. If the value is 'true', no new deposit has been created and the previous pending deposit information has been returned.

POST/v1/transactions/deposit

Create a deposit

This endpoint allows you to request a new deposit

Required attributes

  • Name
    bankId
    Type
    string
    Description

    The _id value you receive from the Available Banks service

  • Name
    processId
    Type
    string
    Description

    An ID value that will be unique to you 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 first and last name

Request

POST
/v1/transactions/deposit
    curl --location --request POST 'https://<service-name>.api.payox.co/v1/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://payment.payox.co/transaction/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFuc2FjdGlvbklkIjoiNjU2N2ZkNDk1NjgyZjcxZjk2MDc4YWVkIiwic2VydmljZSI6IjQiLCJzZXJ2aWNlVHlwZSI6ImNwYXBhcmEiLCJzZXJ2aWNlTmFtZSI6ImpveSIsIm1lcmNoYW50SWQiOiI2NGVmOTU3MmNkNDdjY2JlODFlNzcxYTkiLCJ0aGVtZSI6InN5c3RlbSIsImlhdCI6MTcwMTMxMjY2NiwiZXhwIjoxNzAxMzM0MjY2LCJzdWIiOiJwYXltZW50IiwianRpIjoiIn0.sNvjhZ0g1OPwU-vfxo9C5EI62bRxFtJxAwW79EemDos",
          "hash": "ENWnqnoIYk5OG2yKtYQnXqByrSB9X65ehS6oKVU/d0E="
        },
      "status": 200,
      "responseTime": "30ms",
      "app_version": "payox-v1.7.3"
  }

Was this page helpful?