PIX

Overview

Introduction

PIX is a payment method which allows to process bank transfer payments in Brazil by using QR codes. This method supports purchases and payouts.

PIX is a payment method which allows to process bank transfer payments in Brazil by using QR codes.

This article provides information about working with the PIX method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type bank payments
Payment instrument bank accounts
Countries and regions BR
Payment currencies BRL
Currency conversion on ecommpay side
One-time purchases +
Credential-on-file purchases
Full refunds
Partial refunds
Payouts +
Chargebacks
Notes
Obtaining access to the payment method and access fee refer to your ecommpay key account manager

Interaction diagram

Payment processing by using the PIX method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the PIX service.



Operations support

Various platform interfaces can be used to process payments and perform operations using the PIX method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), payouts—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable to all operationsapplicable.

  Amounts, BRL ¹
minimum maximum
Purchases 50,000.00
Payouts
Note:
  1. Depending on the PIX service, the total value of purchases and payouts made by and to the customer per month, can be limited. Refer to ecommpay technical support in case of such problems.

Processing scenarios

To perform a purchase by using the PIX method, you need to redirect customer to the PIX service, while to initiate a payout, you need to notify the customer via the web service.

Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the PIX method, the merchant web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Payment Page: step-by-step description

  1. A customer initiates a purchase in the merchant's web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project settings and parameters specified in the request.
  6. Payment Page is displayed to the customer.
  7. The customer selects the PIX method.
  8. The request for processing the payment by using the PIX method is received by the payment platform.
  9. The payment platform processes the request and sends it to the PIX service.
  10. The request is processed on the side of the PIX service.
  11. The data for displaying the payment instructions to the customer is sent from the PIX service to the payment platform.
  12. The data for displaying the payment instructions is sent from the payment platform to Payment Page.
  13. The payment instructions are displayed to the customer.
  14. The customer completes all required payment steps.
  15. The purchase is processed on the side of the PIX service.
  16. The PIX service sends a notification about the result to the payment platform.
  17. The payment platform sends the payment result callback to the web service.
  18. The payment platform sends the result information to Payment Page.
  19. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the PIX method via Payment Page is presented further in this section. General information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the PIX method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. Additionally, it is recommended to specify the following parameters:
    • customer_first_name—first name of the customer
    • customer_last_name—last name of the customer
    • customer_email—customer email address
    • identify_doc_number—number of the CPF (Brazilian tax identification number of customer), must contain 11 digits
    If any of these parameters are missing, the payment form may display input fields for entering the missing values (details are available in Submission of additional payment information).
  4. If you need to have payment form displayed with the PIX method selected, set the force_payment_method parameter to pix.
  5. Additionally, any other parameters available for working with Payment Page can be used. See Parameters for opening payment form for information on all available parameters.Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, create a signature (details).

Thus, a correct request for opening the payment form using the PIX method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "BRL",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Johnson",
   "customer_email": "johnson@example.com",
   "identify_doc_number": "12345678901",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The PIX method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100,00 BRL purchase in the 239 project.

Figure: Example of data in a purchase callback

{
        "project_id": 312,
        "payment": {
            "id": "9582",
            "type": "purchase",
            "status": "success",
            "date": "2021-11-03T08:11:24+0000",
            "method": "pix",
            "sum": {
                "amount": 10000,
                "currency": "BRL"
            },
            "description": ""
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 140,
            "type": "sale",
            "status": "success",
            "date": "2021-11-03T08:11:24+0000",
            "created_date": "2021-11-03T08:10:13+0000",
            "request_id": "008d93f549b505e10ff1",
            "sum_initial": {
                "amount": 10000,
                "currency": "BRL"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "BRL"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 12552,
                "payment_id": "1635927056181",
                "auth_code": ""
            }
        },
        "signature": "Fq1XOK0JUSmtkVuVkogZ8lJS6GHWWHi4s3pZQqWBZkoVmZQ=="
    }

The following is the example of a callback with information about a declined purchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 312,
        "payment": {
            "id": "9583",
            "type": "purchase",
            "status": "decline",
            "date": "2021-11-03T08:16:19+0000",
            "method": "pix",
            "sum": {
                "amount": 10000,
                "currency": "BRL"
            },
            "description": ""
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 141,
            "type": "sale",
            "status": "decline",
            "date": "2021-11-03T08:16:19+0000",
            "created_date": "2021-11-03T08:15:43+0000",
            "request_id": "310df107ff9138b5e7c6ff8ff7585a025d",
            "sum_initial": {
                "amount": 10000,
                "currency": "BRL"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "BRL"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 12345,
                "payment_id": "123456789",
                "auth_code": ""
            }
        },
        "signature": "euhyvIW9SLnjnRLPYmoPsH1yJVs+d1PzPyvPfX0ip3jqA=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the PIX method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and display the payment instructions to the customer.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Gate: step-by-step description

  1. A customer initiates a purchase by using the PIX method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the PIX service.
  7. The request is processed on the side of the PIX service.
  8. The data for displaying the payment instructions to the customer is sent from the PIX service to the payment platform.
  9. The data for displaying the payment instructions is sent from the payment platform to the web service.
  10. The payment instructions are displayed to the customer.
  11. The customer completes all required payment steps.
  12. The purchase is processed on the side of the PIX service.
  13. The PIX service sends the payment result notification to the payment platform.
  14. The payment platform sends the payment result callback to the web service.
  15. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the PIX method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the PIX method:

  1. To initiate each purchase, send a POST request to the /v2/payment/pix/sale endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature created after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • ip_address—IP address relevant for the initiated payment
      • first_name—first name
      • last_name—last name
      • email—email
      • id—customer identifier unique within the project
      • identify—information about the document which establishes identity:
        • doc_number—number of the CPF (Brazilian tax identification number of customer), must contain 11 digits
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the PIX method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information as well as signature.

{
    "general": {
        "project_id": 312,
        "payment_id": "9582",
        "signature": "3zjYFq8JuRey87Q4OyuWF6x4Um+K4SAyamNnFVg=="
    },
    "payment": {
        "amount": 10000,
        "currency": "BRL"
    }
    "customer": {
        "ip_address": "192.0.2.0",
        "id": "customer1",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@xmpl.com",
        "identify": {
            "doc_number": "12345678901"
        }
    }
}

Formats of intermediate callbacks for displaying payment instructions

Each payment made with the PIX method requires displaying payment instructions to customers. To display payment instructions it is necessary to receive an intermediate callback from the payment platform and use the information included in the display_data array. The format of such callbacks is standard (details), and the following objects and parameters are included in the display_data array:

  • type—type of data (the value is always qr_data)
  • title—the name of the transferred data that needs to be displayed to the customer (the value is always QR Code)
  • data—a string based on which a QR code should be generated on the web service side (according to ISO/IEC 18004:2015)

Figure: display_data example

"display_data": [
    {
        "type": "qr_data",
        "title": "QR code",
        "data": "00020101com.br359a71a-0cad-4cb2-a937-a3fa5319a5252070503***63042BBF"
    }
]

Callback format

The PIX method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100,00 BRL purchase in the 312 project.

Figure: Example of data in a purchase callback

{
        "project_id": 312,
        "payment": {
            "id": "9582",
            "type": "purchase",
            "status": "success",
            "date": "2021-11-03T08:11:24+0000",
            "method": "pix",
            "sum": {
                "amount": 10000,
                "currency": "BRL"
            },
            "description": ""
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 140,
            "type": "sale",
            "status": "success",
            "date": "2021-11-03T08:11:24+0000",
            "created_date": "2021-11-03T08:10:13+0000",
            "request_id": "008d93f549b505e10ff1",
            "sum_initial": {
                "amount": 10000,
                "currency": "BRL"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "BRL"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 12552,
                "payment_id": "1635927056181",
                "auth_code": ""
            }
        },
        "signature": "Fq1XOK0JUSmtkVuVkogZ8lJS6GHWWHi4s3pZQqWBZkoVmZQ=="
    }

The following is the example of a callback with information about a declined purchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 312,
        "payment": {
            "id": "9583",
            "type": "purchase",
            "status": "decline",
            "date": "2021-11-03T08:16:19+0000",
            "method": "pix",
            "sum": {
                "amount": 10000,
                "currency": "BRL"
            },
            "description": ""
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 141,
            "type": "sale",
            "status": "decline",
            "date": "2021-11-03T08:16:19+0000",
            "created_date": "2021-11-03T08:15:43+0000",
            "request_id": "310df107ff9138b5e7c6ff8ff7585a025dd8e-00000001",
            "sum_initial": {
                "amount": 10000,
                "currency": "BRL"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "BRL"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 12345,
                "payment_id": "123456789",
                "auth_code": ""
            }
        },
        "signature": "euhyvIW9SLnjnRLPYmoPsH1yJVs+d1PzPyvPfX0ip3jqA=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Payouts by using Gate

General information

To process a payout through Gate by using the PIX method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.



Figure: Payout by using Gate: Step-by-step description

  1. A customer orders a payout through the PIX system.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ecommpay URL.
  3. Gate redirects the request to the ecommpay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the PIX service.
  7. The payout is processed on the PIX side.
  8. PIX sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the PIX method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the PIX method:

  1. To initiate each payout send a POST request to the /v2/payment/pix/payout endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature created after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • ip_address—IP address relevant for the initiated payout
      • first_name—first name
      • last_name—last name
      • email—email
      • day_of_birth—date of birth in the format DD-MM-YYYY
      • account_idpixkey identifier which customer registers to use PIX; PIX key can be one of different identifiers: CPF or email
      • id—customer identifier unique within the project
      • identify—information about the document which establishes identity:
        • doc_number—number of the CPF (Brazilian tax identification number of customer), must contain 11 digits
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the PIX method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as signature.

Figure: Example of a payout request

{
    "general": {
        "project_id": 312,
        "payment_id": "f8827",
        "signature": "3zjYFq8JuRey87Q4OyuWs1KaaWIHaNUPcN4sF6x4Um+K4SAyamNnFVg=="
    },
    "payment": {
        "amount": 10000,
        "currency": "BRL"
    }
    "customer": {
        "ip_address": "127.0.0.1",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@xmpl.com",
        "day_of_birth": "22-11-2000",
        "account_id": "email@example.com",
        "id": "customer_123",
        "identify": {
            "doc_number": "12345678901"
        }
    }
}

Callback format

The PIX method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100,00 BRL payout in the 312 project.

Figure: Example of data in a payout callback

{
        "project_id": 312,
        "payment": {
            "id": "306081845",
            "type": "payout",
            "status": "success",
            "date": "2021-11-03T08:19:26+0000",
            "method": "pix",
            "sum": {
                "amount": 10000,
                "currency": "BRL"
            },
            "description": ""
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 142,
            "type": "payout",
            "status": "success",
            "date": "2021-11-03T08:19:26+0000",
            "created_date": "2021-11-03T08:18:46+0000",
            "request_id": "efe84ccebf77b57dd76f43970",
            "sum_initial": {
                "amount": 10000,
                "currency": "BRL"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "BRL"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 12345,
                "payment_id": "12345678909",
                "auth_code": ""
            }
        },
        "signature": "lW9TpyiTQBMVa5dRBGC4geg5wneA=="
    }

The following is the example of a callback with information about a declined payout.

Figure: Example of data in a declined payout callback

{
        "project_id": 312,
        "payment": {
            "id": "306082355",
            "type": "payout",
            "status": "decline",
            "date": "2021-11-03T08:24:33+0000",
            "method": "pix",
            "sum": {
                "amount": 10000,
                "currency": "BRL"
            },
            "description": ""
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 143,
            "type": "payout",
            "status": "decline",
            "date": "2021-11-03T08:24:33+0000",
            "created_date": "2021-11-03T08:23:56+0000",
            "request_id": "a767d408f85ee594048bbe",
            "sum_initial": {
                "amount": 10000,
                "currency": "BRL"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "BRL"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 12345,
                "payment_id": "12345678909877",
                "auth_code": ""
            }
        },
        "signature": "J55CcQzHzjl2hvtoPvwfdKHLfUCmX52swTo/0ZljkMsxw=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

Payout by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the PIX method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.
  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to create a signature because it is specified by Dashboard).

More information Information about processing payouts by using Dashboard is presented in a separate section.

Analysis of payments results

To analyse information about payments made with the PIX method as well as other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL by using the Data API interface (details).

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.