Transactional Account Endpoint

This endpoint allows you to check your balance between your proprietary and transactional accounts, and also move balance freely from one to another.

To get a brief summary of the flow of this endpoint, you can check it here

Before utilizing any of our APIs, you should contact your responsible account manager, with your company's name and CNPJ so we can make the necessary configurations for you to proceed.

Move balance between accounts

POST https://api-stg.onekeypayments.com/v1/wallet/transaction Allows you to move a specific amount between your proprietary accounts, and transactional account

Headers You can check how the headers and signature are calculated here.

Name	Type	Description
Content-Type	string	application/json
X-Date	string	ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login	string	Merchant X-Login API Key
Authorization	string	Authorization control hash
X-Idempotency-Key	string	Unique idempotency key

Example Request:

{
  "source": "PROPRIETARY",
  "destination": "TRANSACTIONAL",
  "currency": "BRL",
  "amount": 100.00
}

Example response:

{
  "currency": "BRL",
  "proprietaryBalance": 100.00,
  "transactionalBalance": 100.00
}

In this example, we've moved 100.1 BRL from our OWNER account to our TRANSACTIONAL account.

Get Balance

GET https://api-stg.onekeypayments.com/v1/wallet/balance Allows you to check your total balance between accounts. Example of successful response:

{
    "balances": [
        {
            "amount": 200.00,
            "currency": "BRL",
            "type": "PROPRIETARY"
        },
        {
            "amount": 222.00,
            "currency": "BRL",
            "type": "TRANSACTIONAL"
        }
    ]
}