Account

Get account information

GET https://api.vendex.app/api/account/info/

To get account information.

Headers

Name	Type	Description
Api-Client-Token	string	Client token obtained from client authentication method.
Api-User-Token	string	User token obtained from user login method.

200

{
    "account_number": "1234567812345678", // Send as string since big integer does not support for statically-typed programming languages.
    "account_balance": "201.00",
    "transaction_limit": "2000.00",
    "currency_code": "USD"
}

Get transaction record

GET https://api.vendex.app/api/account/statement/?records=20

To get transaction record for current user.

Query Parameters

Name	Type	Description
records	integer	This parameter can be use to filter transaction details. Default response will return last 10 records of transaction.
days	integer	This parameter can be use to filter transaction records by certain days.

Headers

Name	Type	Description
Api-Client-Token	string	Client token obtained from client authentication method.
Api-User-Token	string	User token obtained from user login method.

200

[
    {
        "created": "2020-01-10T09:30:40.375141Z", // Timezone aware datetime object in UCT
        "debit": "100.00", // Type float (amount/price) will be rounded to 2 decimal place and formated to type string for stable precision
        "credit": "0.00",
        "account_balance": "1100.00",
        "currency_code": "USD",
        "description": "Nuvapay account top up",
        "profile_image_url": "https://nxpay-uploaded-media.s3.ap-south-1.amazonaws.com/upload/9c900a41-9027-4218-9737-f91db6cf4f53.png"
    },
    {
        "created": "2020-01-12T09:30:40.375141Z",
        "debit": "0.00",
        "credit": "50.00",
        "account_balance": "1050.00",
        "currency_code": "USD",
        "description": "Payment Pizza hut - Airport, Vegas."
        "profile_image_url": "https://nxpay-uploaded-media.s3.ap-south-1.amazonaws.com/upload/9c900a41-9027-4218-9737-f91db6cf5789.png"
    }
]

Add money

POST https://api.vendex.app/api/account/add_money/

To add money to user account. This API is called upon approval from payment gateway. Gateway reference is provided as a security measure and also use for validation.

Headers

Name	Type	Description
Api-Client-Token	string	Client token obtained from client authentication method.
Api-User-Token	string	User token obtained from user login.
Content-Type	string	Content-type need to be set as application/json

200

{
    "status": "success",
    "detail": "Amount successfully top up to account"
}

Example of POST data (JSON)

{
    "amount": 100.00,
    "currency_code": "USD",
    "gateway_ref": "mpmfcvec", // Payment gateway transaction id. This transaction id is used for varification.
    "transaction_signature": "9ef4e5f81dacd2b844c28a7e674cd13961e821c9b559a08b926c736fc5aaffa2" // Transaction signature obtained from get transaction signature method.
}