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

payin_check

GET
https://api.cfxpay.io/{{param_environment}}/{{param_company}}/gateway/payin_check/{transaction_id}
Last modified:2024-02-21 19:48:27
Check the payin by transaction ID.

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 payin_create)
tracking_id (A tracking ID send by the customer in the payin_create)
api_transaction_id (ID generated by the provider)
Example:
55616f79-0bdd-42f2-8943-165ae7359001
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/payin_check/55616f79-0bdd-42f2-8943-165ae7359001' \
--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 {24}] 
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
return_url
string 
optional
cancel_url
string 
optional
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
checkout_url
string 
required
checkout_info
object (Checkout Info) 
required
customer
object (Customer Payin) 
optional
Example
{
  "server": "01",
  "code": 0,
  "message": "Success",
  "identifier": "1708459481804055808",
  "type": "LOG_INFO",
  "caller": "_gateway_payin_check",
  "caller_id": "1708459480212169629",
  "translation_message": "Sucesso",
  "gateway": [
    {
      "transaction_id": "1708459481626763970",
      "merchant_id": "cfxpaygateway_merchant",
      "tracking_id": "55616f79-0bdd-42f2-8943-185ce7359001",
      "api_transaction_id": "3ad3383d-3cea-49e7-b1a5-d688668b0bcc",
      "payment_type_id": "a88eb69672cc1f8483d481a56259dcaa",
      "callback_url": "https://api.cfxpay.io/webhook_test",
      "return_url": "https://cfxpay.io",
      "cancel_url": "https://cfxpay.io",
      "country": "BR",
      "source": "DEPOSIT",
      "origin": "PROVIDER_01",
      "status": "PENDING",
      "currency_symbol": "BRL",
      "amount": "50.00",
      "amount_fee": "0.00",
      "amount_final": "50.00",
      "exchange_symbol": "USD",
      "exchange_rate": "5.33049040",
      "exchange_amount": "9.38",
      "exchange_amount_fee": "0.00",
      "exchange_amount_final": "9.38",
      "checkout_url": "https://checkout.cfxpay.io/#/invoice/55616f79-0bdd-42f2-8943-185ce7359001",
      "checkout_info": {
        "description": "PIX",
        "type": "QRCODE",
        "code": "00020101021226910014br.gov.bcb.pix2569qrcode.pix.com.br/pixqrcode/v2/d4ace62a7907bd90a3d4ea2aa5c85652046009Sao ***630444F1",
        "amount": "50.00",
        "symbol": "BRL",
        "expire_utc": "1708545881",
        "language_default": "PORTUGUESE_BR",
        "instructions": [
          {
            "language": "ENGLISH",
            "instruction_01": "Open your bank's app",
            "instruction_02": "Select the pay option through PIX",
            "instruction_03": "Select the option QR Code",
            "instruction_04": "Scan the QR code with your phone's camera",
            "instruction_05": "Authorize payment"
          },
          {
            "language": "SPANISH",
            "instruction_01": "Abre la aplicación de tu banco",
            "instruction_02": "Seleccione la opción de pago a través de PIX",
            "instruction_03": "Seleccione la opción Código QR",
            "instruction_04": "Escanea el código QR con la cámara de tu teléfono",
            "instruction_05": "Autorizar pago"
          },
          {
            "language": "PORTUGUESE_BR",
            "instruction_01": "Abra o aplicativo do seu banco",
            "instruction_02": "Selecione a opção de pagamento via PIX",
            "instruction_03": "Selecione a opção Código QR",
            "instruction_04": "Digitalize o código QR com a câmera do seu telefone",
            "instruction_05": "Autorizar pagamento"
          }
        ]
      },
      "customer": {
        "first_name": "Satoshi",
        "last_name": "Nakamoto",
        "document_number": "28276469686",
        "email": "dev@cfxpay.io",
        "country": "BR",
        "city": "Sao Paulo",
        "address": "R. Jose Simoes, 596",
        "zip": "01508001",
        "phone": "5511999999999",
        "device_id": "123123123",
        "ip": "182.147.131.140"
      }
    }
  ]
}
🟠400Record Not Found
🟠400Wrong Params
Modified at 2024-02-21 19:48:27
Previous
payin_create
Next
payout_create
Built with