payout_check - CFX Pay

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 *****************

Path Params

transaction_id

string

required

The following ids are accepted:
transaction_id (ID generated by the payout_create)
tracking_id (A tracking ID send by the customer in the payout_create)
api_transaction_id (ID generated by the provider)

Example:

55616f79-0bdd-42f2-8943-168ae7659001

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

curl --location -g --request GET 'https://api.cfxpay.io/{{param_environment}}/{{param_company}}/gateway/payout_check/55616f79-0bdd-42f2-8943-168ae7659001' \
--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

array [object {20}]

optional

transaction_id

string

required

merchant_id

string

required

tracking_id

string

required

api_transaction_id

string

required

payment_type_id

string

required

callback_url

string

required

country

string

required

source

string

required

origin

string

required

status

string

required

currency_symbol

string

required

amount

string

required

amount_fee

string

optional

amount_final

string

required

exchange_symbol

string

optional

exchange_rate

string

optional

exchange_amount

string

optional

exchange_amount_fee

string

optional

exchange_amount_final

string

optional

customer

object (Customer Payout)

optional

Example

{
  "server": "01",
  "code": 0,
  "message": "Success",
  "identifier": "1709226159023785910",
  "type": "LOG_INFO",
  "caller": "_gateway_payout_check",
  "caller_id": "1709226158846936719",
  "translation_message": "Sucesso",
  "gateway": [
    {
      "transaction_id": "1709225790684624139",
      "merchant_id": "cfxpaygateway_merchant",
      "tracking_id": "55616f79-0bdd-42f2-8943-168ae7659001",
      "api_transaction_id": "6622708",
      "payment_type_id": "da29df38dd248d066b7656473a6da4f8",
      "callback_url": "https://api.cfxpay.io/webhook_test",
      "country": "BR",
      "source": "WITHDRAW",
      "origin": "PROVIDER_01",
      "status": "WAITING",
      "currency_symbol": "USD",
      "amount": "10.00",
      "amount_fee": "0.00",
      "amount_final": "10.00",
      "customer": {
        "first_name": "Satoshi",
        "last_name": "Nakamoto",
        "document_type": "1",
        "document_number": "28276469686",
        "email": "dev@cfxpay.io",
        "country": "BR",
        "account_agency_number": "-",
        "account_number": "-",
        "account_type_code": "-",
        "account_pix_key": "28276469687",
        "account_bank_code": "-"
      }
    }
  ]
}

🟠400Record Not Found

🟠400Wrong Params