# PIX {#pm_pix} An article about the payment method which allows to process payments in Brazilian reals and US dollars by using bank accounts in Brazil and supports purchases and payouts. **Parent topic:**[Bank payments](en_pm_bankpayments.md) ## Overview {#en_pm_pix_overview} An article about the payment method which allows to process payments in Brazilian reals and US dollars by using bank accounts in Brazil and supports purchases and payouts. ### Introduction {#section_owc_rzc_cvb .section} PIX is a payment method which allows process payments in Brazilian reals and US dollars by using bank accounts in Brazil. This method supports purchases and payouts. 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 {#section_tbf_2zk_ggb .section} |Payment method type|bank payments| |Payment instrument|bank accounts| |Countries and regions|[BR](references/en/countries/BR.md)| |Payment currencies|[BRL](references/en/currencies/BRL.md)| |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 {#section_tsp_gzk_ggb .section} 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. ![](images/pm/eng_pix_functional.svg) ### Operations support {#section_rnx_4cl_ggb .section} 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 operations. | |Amounts, [BRL](references/en/currencies/BRL.md) ¹| |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 {#section_fgt_sdl_ggb .section} 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. General scenarios of processing purchases can be presented as follows. ![](images/mglwallet/pm/en_pix_interfaces_pp.svg "Purchase by using Payment Page") ![](images/pm/en_pix_interfaces_gate.svg "Purchase by using Gate") ![](images/pm/eng_pix_interfaces_gate_payout.svg "Payout by using Gate") Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features \(such as payment links\) are used, scenarios for performing operations also correspond to the specifics of those features. ## Purchases by using Payment Page {#en_pm_pix_pp_purchase} ### General information {#section_gtg_vxk_m2b .section} To process a purchase through Payment Pageby 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. ![](images/mglwallet/pm/en_pix_uml_pp.svg) 1. A customer initiates a purchase in the 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 and request parameters. 6. Payment Page is displayed to the customer. 7. The customer selects the PIX method. 8. The payment platform receives the request for processing the payment by using the PIX method. 9. The payment platform processes the request and sends it to the PIX service. 10. The request is processed on the PIX service side. 11. The data for redirecting the customer to the PIX service is sent from the PIX service to the payment platform. 12. The data for redirecting the customer is sent from the payment platform to Payment Page. 13. The customer is redirected to the PIX service. 14. The customer completes all required payment steps. 15. The purchase is processed in the PIX service. 16. The result information is displayed to the customer in the PIX service. 17. The customer is redirected to Payment Page. 18. The PIX service sends a notification about the result to the payment platform. 19. The payment platform sends the payment result callback to the web service. 20. The payment platform sends the result information to Payment Page. 21. 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](en_pp_interaction_organisation.md). ### Request format {#section_p5j_fgl_ggb .section} 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. 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 \(can be omitted if the `customer_phone` parameter is specified\) - `customer_phone` —customer phone number \(can be omitted if the `customer_email` parameter is specified\) - `identify_doc_number`—CPF \(Cadastro de Pessoas Físicas, taxpayer identification number assigned to an individual; 11 digits\) or CNPJ \(Cadastro Nacional da Pessoa Jurídica, taxpayer identification number assigned to a legal entity; 14 digits\) 3. If you need to have payment form displayed with the PIX method selected, set the `force_payment_method` parameter to `pix`. 4. Additionally, any other parameters available for working with Payment Page can be used. See [Payment Page API specification](en_PP_Parameters.md) for information on all available parameters. 5. After all target parameters are specified, create a signature \([details](en_platform_signature.md)\). 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. ``` {#codeblock_ayl_fcb_v3c .language-json} { "project_id": 120, "payment_id": "580", "payment_amount": 10000, "payment_currency": "BRL", "customer_id": "customer1", "customer_first_name": "John", "customer_last_name": "Doe", "customer_email": "johnson@example.com, "identify_doc_number": "12345678901", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" } ``` ``` {#codeblock_ewy_vdx_xgc .language-json} { "project_id": 120, "payment_id": "580", "payment_amount": 10000, "payment_currency": "BRL", "customer_id": "customer1", "customer_first_name": "John", "customer_last_name": "Doe", "customer_email": "johnson@example.com, "identify_doc_number": "12345678901", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" } ``` ### Callback format {#section_dpx_2hl_ggb .section} The PIX method uses the standard format for callbacks to deliver purchase results. For more information, see [Handling callbacks](en_platform_callbacks.md). The following is the example of a callback with an information about successful `100.00 BRL` purchase in the `312` project. ```language-json { "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. ```language-json { "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 {#section_xpz_thl_ggb .section} The following articles can be useful when implementing purchases via Payment Page: - [Interaction concepts](en_pp_interaction_organisation.md)—how to organise interaction with the payment platform by using Payment Page - [Signature generation and verification](en_platform_signature.md)—about the procedure of creating and verifying signatures in requests and callbacks. - [Payment processing](en_platform_payment_model.md)—about the types, processing models, and possible statuses of supported payments and operations. - [One-time one-step purchase](en_platform_sms_model.md)—about processing of one-time one-step purchases by using Payment Page. - [Handling operation processing information](en_platform_payment_info_codes.md)—about error and response codes that are used in the payment platform to record information about performing of operations. ## Purchases by using Gate {#en_pm_pix_gate_purchase} ### General information {#section_lsx_3jl_ggb .section} 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 redirect the customer to the PIX service. 3. Receive the final callback from the payment platform. The full sequence and special aspects of purchase processing are provided below. ![](images/pm/en_pix_uml_gate.svg) 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](en_gate_interaction_organisation.md)\). 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 PIX service side. 8. The PIX service sends the redirection data to the payment platform. 9. The payment platform sends the callback with the redirection data to the web service. 10. The customer is redirected to the PIX service. 11. The customer completes all required payment steps on the PIX service side. 12. The purchase is processed in the PIX service. 13. The result is displayed to the customer. 14. The customer is redirected to the web service. 15. The PIX service sends the payment result notification to the payment platform. 16. The payment platform sends the payment result callback to the web service. 17. 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](en_gate_interaction_organisation.md). ### Request format {#section_osx_3jl_ggb .section} 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](https://api-developers.ecommpay.com/api-specification/pix/post-v2-payment-pix-sale) endpoint. 2. Each request must include the following objects and parameters: - Object `general`—general purchase information: - `project_id`—project identifierobtained from Ecommpay during integration - `payment_id`—payment identifierunique within the project - `signature`—request signaturecreated after all required parameters are specified \(details—in the [Signature generation and verification](en_platform_signature.md)\) - Object `payment`—payment information: - `amount`—payment amount in the smallest currency unit - `currency`—payment currency codein the ISO-4217 alpha-3 format - Object `customer`—customer information: - `ip_address`—IP addressrelevant for the initiated payment - `first_name`—customer first name - `last_name`—customer last name - `email`—customer email \(can be omitted if the `phone` parameter is specified\) - `phone`—customer phone number \(can be omitted if the `email` parameter is specified\) - `id`—customer identifierunique within the project - `identify`—information about the document which establishes identity: - `doc_number`—CPF \(Cadastro de Pessoas Físicas, taxpayer identification number assigned to an individual; 11 digits\) or CNPJ \(Cadastro Nacional da Pessoa Jurídica, taxpayer identification number assigned to a legal entity; 14 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. ```language-json { "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@example.com", "identify": { "doc_number": "12345678901" } } } ``` ``` {#codeblock_cgb_3yw_v3c .language-json} { "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@example.com", "identify": { "doc_number": "12345678901" } } } ``` ### Formats of intermediate callbacks for customer redirection {#section_nxg_hmn_zgb .section} Each payment made with the PIX method requires redirection of customers from the merchant's web service to the PIX service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the `redirect_data` object. The format of such callbacks is standard \([details](en_platform_callbacks.md)\), and the following objects and parameters are included in the `redirect_data` object: - `body`—object with data to be sent in the request body - `method`—parameter specifying the HTTP method for sending the request \(`GET` or `POST`\) - `url`—parameter containing a link for redirection ``` {#codeblock_czz_fdb_1fc .language-json} "redirect_data": { "body": {}, "method": "GET", "url": "https://www.example.com/pay" } ``` ### Callback format {#section_wsx_3jl_ggb .section} The PIX method uses the standard format for callbacks to deliver purchase results. For more information, see [Handling callbacks](en_platform_callbacks.md). The following is the example of a callback with an information about successful `100.00 BRL` purchase in the `312` project. ```language-json { "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. ```language-json { "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 {#section_xsx_3jl_ggb .section} The following articles can be useful when implementing purchases via Gate: - [Interaction concepts](en_gate_interaction_organisation.md)—how to organise interaction with the payment platform by using Gate - [Signature generation and verification](en_platform_signature.md)—about the procedure of creating and verifying signatures in requests and callbacks. - [Payment processing](en_platform_payment_model.md)—about the types, processing models, and possible statuses of supported payments and operations. - [One-time one-step purchase](en_platform_sms_model.md)—about processing of one-time one-step purchases by using Gate. - [Handling operation processing information](en_platform_payment_info_codes.md)—about error and response codes that are used in the payment platform to record information about performing of operations. ## Payouts by using Gate {#en_pm_pix_gate_payout} ### General information {#section_lsx_3jl_ggb .section} To process a payout through Gateby 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. ![](images/pm/eng_pix_uml_gate_payout.svg) 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. The 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](en_gate_interaction_organisation.md). 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](en_gate_interaction_organisation.md). ### Request format {#section_osx_3jl_ggb .section} 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](https://api-developers.ecommpay.com/api-specification/pix/post-v2-payment-pix-payout) endpoint. 2. Each request must include the following objects and parameters: - Object `general`—general payout information: - `project_id`—project identifierobtained from Ecommpay during integration - `payment_id`—payment identifierunique within the project - `signature`—request signaturecreated after all required parameters are specified \(details—in the [Signature generation and verification](en_platform_signature.md)\) - Object `payment`—payment information: - `amount`—payout amount in the smallest currency unit - `currency`—payout currency codein the ISO-4217 alpha-3 format - Object `customer`—customer information: - `ip_address`—IP addressrelevant for the initiated payout - `first_name`—first name - `last_name`—last name - `email`—customer email \(can be omitted if the `phone` parameter is specified\) - `phone`—customer phone number \(can be omitted if the `email` parameter is specified\) - `country`—customer country code in ISO 3166-1 alpha-2 format - `day_of_birth`—date of birth in the format DD-MM-YYYY - `id`—customer identifierunique within the project - `identify`—information about the document which establishes identity: - `doc_number`—CPF \(Cadastro de Pessoas Físicas, taxpayer identification number assigned to an individual; 11 digits\) or CNPJ \(Cadastro Nacional da Pessoa Jurídica, taxpayer identification number assigned to a legal entity; 14 digits\) - Object `account`—customer account information: - `number`—customer account number 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. ``` {#codeblock_bgq_jqz_djc .language-json} { "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", "country": "BR", "email": "example@xmpl.com", "day_of_birth": "22-11-2000", "id": "customer_123", "identify": { "doc_number": "12345678901" } }, "account": { "number": "S0Pkonh1Lr2E" } } ``` ### Callback format {#section_wsx_3jl_ggb .section} The PIX method uses the standard format for callbacks to deliver payout results. For more information, see [Handling callbacks](en_platform_callbacks.md). The following is the example of a callback with an information about successful `100.00 BRL` payout in the `312` project. ```language-json { "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. ```language-json { "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 {#section_xsx_3jl_ggb .section} The following articles can be useful when implementing payouts via Gate: - [Interaction concepts](en_gate_interaction_organisation.md)—how to organise interaction with the payment platform by using Gate - [Signature generation and verification](en_platform_signature.md)—about the procedure of creating and verifying signatures in requests and callbacks. - [Payment processing](en_platform_payment_model.md)—about the types, processing models, and possible statuses of supported payments and operations. - [Payouts](en_Gate_payout.md)—about processing of payouts by using Gate. - [Handling operation processing information](en_platform_payment_info_codes.md)—about error and response codes that are used in the payment platform to record information about performing of operations. ## Payouts by using Dashboard {#en_pm_dash_payout} When working with Dashboard, you can process *single* and *mass* payoutsby 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](en_dbl_payments.md) section.The payout parameters must comply with the [requirements](pm_pix.md) \(you do not have to generate a signature because it is specified by Dashboard\). More information about processing payouts by using Dashboard is presented in a [separate section](en_dbl_payments.md). ## Analysis of payments results {#en_pm_pix_dash_analysis} 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](en_dbl_api_protocol.md)\). If you have any questions, refer to the documentation \([Dashboard](en_dbl_about.md) and [Using Data API](en_dbl_api_protocol.md)\) and Ecommpay technical support.