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

payment_type

GET
https://api.cfxpay.io/{{param_environment}}/{{param_company}}/gateway/payment_type
Last modified:2024-02-21 19:47:59
This endpoint is used to return the list of payment type.
The payment_type_id returned will be used in the other endpoints to identify the payment.

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 *****************
Query Params
category
string 
optional
Category list
Example:
CASH,ONLINE
country
string 
optional
Country list
Example:
BR
currency_symbol
string 
optional
Currency list
Example:
BRL
enabled
string 
optional
Enabled list
Example:
YES
kind
string 
optional
Kind/Provider list
Example:
PROVIDER_01,PROVIDER_02
operation
string 
optional
Operation list
Example:
DEPOSIT
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/payment_type?category=CASH,ONLINE&country=BR&currency_symbol=BRL&enabled=YES&kind=PROVIDER_01,PROVIDER_02&operation=DEPOSIT' \
--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_payment_type
array [object {10}] 
optional
id
string 
required
description
string 
required
operation
string 
required
kind
string 
required
category
string 
required
picture_path
string 
optional
country
string 
required
currency_symbol
string 
required
mandatory
string 
required
enabled
string 
required
Examples
{
    "server": "01",
    "code": 0,
    "message": "Success",
    "identifier": "1707911679521882123",
    "type": "LOG_INFO",
    "caller": "_gateway_payment_type",
    "caller_id": "1707911679503330200",
    "translation_message": "Sucesso",
    "gateway_payment_type": [
        {
            "id": "735771c189f240e726ce28522bbe5ae9",
            "description": "BOLETO RAPIDO",
            "operation": "DEPOSIT",
            "kind": "PROVIDER_01",
            "category": "BOLETO",
            "picture_path": "https://firebasestorage.googleapis.com/v0/b/blusoftech-storage/o/public%2Fshared%2Fpayment_type%2F97d707bb-bf75-4136-b502-c5ed2ae82569.jpeg?alt=media&token=d180b04c-1cdb-46f5-864b-2729af4233af",
            "country": "BR",
            "currency_symbol": "BRL",
            "mandatory": "first_name;last_name;personal_id;email;phone;ip",
            "enabled": "YES"
        },
        {
            "id": "a88eb69672cc1f8483d481a56259dcaa",
            "description": "PIX",
            "operation": "DEPOSIT",
            "kind": "PROVIDER_01",
            "category": "PIX",
            "picture_path": "https://firebasestorage.googleapis.com/v0/b/blusoftech-storage/o/public%2Fshared%2Fpayment_type%2F4819e438-3a72-4d27-9b2a-4ea5c9670fbc.png?alt=media&token=1388de61-962b-4fd1-aa9d-eb93c383166e",
            "country": "BR",
            "currency_symbol": "BRL",
            "mandatory": "first_name;last_name;personal_id;email;ip",
            "enabled": "YES"
        }
    ]
}
🟠400Wrong Params
Modified at 2024-02-21 19:47:59
Previous
balance_merchant
Next
payin_create
Built with