CFX Pay
  1. Hardcode integration
CFX Pay
  • Introduction
  • Integration Types
  • API Standards
  • Status Flow
  • Lists
  • SPEI Mexico
  • PIX Brazil
  • Basic Integration
    • checkout_create
      POST
  • Intermediary Integration
    • checkout_form
      POST
  • Hardcode integration
    • balance_merchant
      GET
    • payment_type
      GET
    • payin_create
      POST
    • payin_check
      GET
    • payout_create
      POST
    • payout_check
      GET
  • Notification
    • How it works
  1. Hardcode integration

balance_merchant

GET
https://api.cfxpay.io/{{param_environment}}/{{param_company}}/gateway/balance_merchant
Last modified:2024-09-07 16:36:27
Use this call to retrieves the balance at any time.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Header Params
Language
string 
required
Language list
Example:
PORTUGUESE_BR

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.cfxpay.io/{{param_environment}}/{{param_company}}/gateway/balance_merchant' \
--header 'Language: PORTUGUESE_BR' \
--header 'Authorization: Basic Og=='

Responses

🟢200Success
application/json
Body
server
string 
required
code
integer 
required
message
string 
required
identifier
string 
required
type
string 
required
caller
string 
required
caller_id
string 
required
translation_message
string 
required
gateway_balance_merchant
array [object {3}] 
required
currency_id
string 
required
currency_symbol
string 
required
balance
string 
required
Example
{
    "server": "01",
    "code": 0,
    "message": "Success",
    "identifier": "1725673034124830498",
    "type": "LOG_INFO",
    "caller": "_gateway_balance_merchant",
    "caller_id": "1725673034063190694",
    "translation_message": "Sucesso",
    "gateway_balance_merchant": [
        {
            "currency_id": "1695752750776630352",
            "currency_symbol": "PEN",
            "balance": "0"
        },
        {
            "currency_id": "1695752763379723496",
            "currency_symbol": "MXN",
            "balance": "1802.838162"
        },
        {
            "currency_id": "1695752773775786537",
            "currency_symbol": "GTQ",
            "balance": "0"
        },
        {
            "currency_id": "1695752782066768381",
            "currency_symbol": "CRC",
            "balance": "0"
        },
        {
            "currency_id": "1695752790258347347",
            "currency_symbol": "COP",
            "balance": "0"
        },
        {
            "currency_id": "1695752797514052739",
            "currency_symbol": "CLP",
            "balance": "0"
        },
        {
            "currency_id": "1695752804543655136",
            "currency_symbol": "BRL",
            "balance": "0.8"
        },
        {
            "currency_id": "1695752811897670191",
            "currency_symbol": "ARS",
            "balance": "0"
        },
        {
            "currency_id": "1695752818276764074",
            "currency_symbol": "USD",
            "balance": "16.138979510793"
        }
    ]
}
Modified at 2024-09-07 16:36:27
Previous
checkout_form
Next
payment_type
Built with