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

    Integration Types

    We offer a variety of integration methods to cater to diverse development and customization needs. Each integration method comes with its own distinct characteristics, allowing you to choose the one that best aligns with your goals and specific requirements. Here are the three types of integration available:
    1.
    Basic Integration: The fastest and easiest way to integrate our solution.
    2.
    Intermediary Integration: This integration is more advanced than the previous one and gives you more control over the payment type selection page.
    3.
    Hardcoded Integration: The most advanced integration that gives you full control over the payment process.
    📌
    If you want to use our paywall page but need customization for your brand, please contact us.

    Basic Integration#

    This method provides a straightforward approach where we provide a ready-to-use web page that seamlessly integrates the payment flow into your application or platform. While it's easier to implement, it offers less customization flexibility compared to other methods.

    Flow#

    1.
    Send a request to our POST checkout_create endpoint.
    2.
    Get the returned checkout_url.
    3.
    Redirect the user to our checkout page.
    4.
    The user will choose the payment type and fill in the payer informations (if applicable) to confirm the transaction.
    5.
    If everything goes well, a PENDING payin will be created and the user will be redirected to the invoice page. Otherwise, the user will see the validation errors and must correct them to proceed.
    6.
    After making the payment and confirming it, the user will be redirected to return_url (if applicable).

    Flowchart diagram#

    Intermediary Integration#

    With this method you will be responsible for the payment type selection process and will only use the payer identification form page (if applicable) provided by us to integrate the payment process. While it requires a little more work to set up, it provides a higher level of customization to meet your specific design and user experience needs.

    Flow#

    1.
    Send a request to our GET payment_type endpoint with the desired filters.
    2.
    Show the list of payment types on your checkout page.
    3.
    Send a request to POST checkout_form to generate the form URL.
    4.
    Redirect the user to our payer identification form page.
    5.
    The user will fill in the payer informations (if applicable) to confirm the transaction.
    6.
    If everything goes well, a PENDING payin will be created and the user will be redirected to the invoice page. Otherwise, the user will see the validation errors and must correct them to proceed.
    7.
    After making the payment and confirming it, the user will be redirected to return_url (if applicable).

    Flowchart diagram#

    Hardcoded Integration#

    This is the most advanced and customizable method where you integrate directly with our API and have full control over the design and functionality of the payment pages in your application.

    Flow#

    1.
    Send a request to our GET payment_type endpoint with the desired filters.
    2.
    Show the list of payment types on your checkout page.
    3.
    Request all payer information according to the payment type mandatory fields.
    4.
    Send a POST payin_create with all necessary information to request a payin.
    5.
    If everything goes well, a PENDING payin will be created and you will receive the transaction_id to follow your payin.
    6.
    A notification will be sent to the callback_url with each status update. Wait until it is CONFIRMED.
    7.
    Optionally, you can check the current status via the endpoint GET payin_check, but we strongly recommend and encourage using the callback.
    ❗
    Some providers require you to go through their checkout page, so you must redirect the user to the internal_url, which is within the checkout_info object of the response
    Modified at 2024-02-23 13:39:18
    Previous
    Introduction
    Next
    API Standards
    Built with