LogoLogo
  • OKP APIs
  • Getting Started with OKP
  • API Documentation
    • Deposits API
      • Technical and Security Aspects
        • Calculating the Signature
      • Endpoints
        • Deposit Creation Endpoint
          • Notifications
        • Transactional Account Endpoint
          • Understanding the Solution
        • PCI Deposit Creation Endpoint
        • Deposit Status Endpoint
        • Payment Methods Endpoint
        • Currency Exchange Endpoint
        • Crypto Exchange Endpoint
        • Country States Codes Endpoint
        • Refund Creation Endpoint
          • Notifications
        • Refund Status Endpoint
      • Payment Methods
        • 🌎America
          • 🇧🇷Brazil
            • PIX Biometric
      • API Codes
    • Cashouts API
      • Technical and Security Aspects
        • Calculating the Payload-Signature
      • Endpoints
        • Cashout Creation Endpoint
          • Notifications
        • Cashout Status Endpoint
        • Cashout Update Status Endpoint
        • Cashout Cancellation Endpoint
        • Cashout Bank Codes
      • Countries Validations
        • American Countries
          • 🇧🇷Brazil
      • API Codes
    • Subscriptions API
      • Technical and Security Aspects
        • Calculating the Signature
      • Subscription Creation Endpoints
        • OneShot Subscription Creation
        • PCI Subscription Creation Endpoint
        • Notifications
      • Subscription Cancellation Endpoint
      • Subscription Status Endpoint
    • Quickpay
      • Endpoints
        • Deposit creation endpoint
          • Notifications
        • Deposit status endpoint
    • Bank Account Validation
      • Technical and Security Aspects
        • Calculating the Signature
      • Endpoints
        • Bank Account Validation Endpoint
          • Pix Key Validation and Details Endpoint
      • API Codes
    • KYC API
      • Technical and Security Aspects
        • Calculating the Signature
      • KYC Endpoint
      • API Codes
  • Deposits Tools
    • Cards SDK
      • With User Interface
        • 🚀Color Customization
      • Without User Interface
    • Java SDK
    • PHP SDK
  • Knowledge Base
    • Deposits with Cards SDK
      • With User Interface
      • Without User Interface
    • Countries Specifications
  • PLUGINS
    • WooCommerce
      • Installation
      • Configuration
  • Status Page
Powered by GitBook
On this page
  • Move balance between accounts
  • Get Balance
  1. API Documentation
  2. Deposits API
  3. Endpoints

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.

PreviousNotificationsNextUnderstanding the Solution

Last updated 5 months ago

To get a brief summary of the flow of this endpoint,

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

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",
  "proprietary_balance": 100.00,
  "transactional_balance": 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"
        }
    ]
}
you can check it here
headers and signature are calculated here.