CFX Pay
    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

    PIX Brazil

    PIX Brazil#

    If you are just integrating PIX Brazil, there are some useful things you should know that can make your integration process easier.
    All Integration Types, API Standards and Status Flow are valid for this payment type;
    You should use only:
    KIND/PROVIDER: PROVIDER_03
    CURRENCY: BRL
    COUNTRY: BR
    CATEGORY: PIX
    For Payout Create, the customer mandatory fields are:
    document number: The document number of the beneficiary:
    CPF
    CNPJ
    account_pix_key: The PIX key of the benefiary:
    Email
    CPF or CNPJ
    Aleatory Key
    Phone Number

    Examples#

    Balance Merchant
    Payin Create request body:
    {
        "payment_type_id": "df38eb861b1b8090dbaceea49eb577ac",
        "amount": "150.00",
        "description": "Payin PIX",
        "tracking_id": "9da1dced-cb45-5301-9e34-ee96ca1b3579",
        "callback_url": "https://api.cfxpay.io/webhook_test"
    }
    Payout Create request body:
    {
        "payment_type_id": "a4c71909b0ffb4a30d1d30e6fb534d23",
        "amount": "100.00",
        "description": "Payout PIX",
        "tracking_id": "75616f79-0bdd-42f2-8943-168ae7659001",
        "callback_url": "https://api.cfxpay.io/webhook_test",
        "customer": {
    	"document_number": "18276469681",
    	"account_pix_key": "18276469681"
        }
    }
    Modified at 2024-09-11 13:35:20
    Previous
    SPEI Mexico
    Next
    checkout_create
    Built with