Pago Fácil

Last updated: April 29, 2022

Start accepting payment using Pago Fácil, a favorite payment method in Argentina.

Information

If you want to use a gateway model for accepting Pago Fácil payments, you will need to arrange an agreement with our provider, dLocal, and create merchant details (specifically, x_login and x_trans_key) and a secret key with them. Share these details with our Customer Support team and we'll get you up and running. If you have already been onboarded for one of our other dLocal payment methods, you can use the same credentials.

Model	Collecting
Payment flow	Cash
Payment method type	Voucher
One-step payment
Authorization
Capture
Refund
Partial refund
Chargeback
Recurring payment

Pago Fácil can be used by either redirecting the customer to a statically hosted ticket (redirect integration method) or by rendering the complete ticket within your own checkout flow (direct integration method).

Payments follow a two-step process:

You can find the full list, as well as complete request and response examples, in our API reference.

post

https://api.checkout.com/payments


1{
2  "source": {
3    "type": "pagofacil",
4    "integration_type": "redirect",
5    "country": "AR",
6    "payer": {
7      "name": "Bruce Wayne",
8      "email": "[email protected]"
9    },
10    "description": "simulate Pago Fácil Demo Payment"
11  },
12  "amount": 100,
13  "currency": "ARS"
14}


1{
2  "source": {
3    "type": "pagofacil",
4    "integration_type": "direct",
5    "country": "AR",
6    "payer": {
7      "name": "Bruce Wayne",
8      "email": "[email protected]"
9    },
10    "description": "simulate Pago Fácil Demo Payment"
11  },
12  "amount": 100,
13  "currency": "ARS"
14}

Whether you used the direct or redirect integration_type, you should get a 202 response with the status field set to Pending. This means your request has been accepted.


1{
2  "id": "pay_edov5e5m4zreda7hs4mnzgusze",
3  "status": "Pending",
4  "customer": {
5    "id": "cus_gghyd2m6wkgebnxvkndfwxeaji"
6  },
7  "_links": {
8    "self": {
9      "href": "https://api.sandbox.checkout.com/payments/pay_edov5e5m4zreda7hs4mnzgusze"
10    },
11    "redirect": {
12      "href": "https://sandbox.dlocal.com/collect/pay/pay/M-b91e48a5-92e2-4726-8847-055f0ed793f1?xtid=CATH-ST-1587999296-88241435"
13    },
14    "simulator:payment-succeed": {
15      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_edov5e5m4zreda7hs4mnzgusze/succeed"
16    },
17    "simulator:payment-expire": {
18      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_edov5e5m4zreda7hs4mnzgusze/expire"
19    }
20  }
21}


1{
2  "id": "pay_mnayvzqceh7e3oriqgtiuwdfpa",
3  "status": "Pending",
4  "customer": {
5    "id": "cus_r3t4ok4e64uerf67kv5wly3lfa"
6  },
7  "_links": {
8    "self": {
9      "href": "https://api.sandbox.checkout.com/payments/pay_mnayvzqceh7e3oriqgtiuwdfpa"
10    },
11    "simulator:payment-succeed": {
12      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_mnayvzqceh7e3oriqgtiuwdfpa/succeed"
13    },
14    "simulator:payment-expire": {
15      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_mnayvzqceh7e3oriqgtiuwdfpa/expire"
16    }
17  }
18}

To capture and complete the payment, you need to provide the customer with a Pago Fácil ticket by following one of two flows:

If you used the redirect method, redirect the customer.
If you used the direct method, render the ticket.

Information

When using the redirect integration method, make sure your customer is aware that they will be redirected to the ticket page when they select your Pay now button, and that they should print or save the ticket.

Using the redirection URL returned in the response above via _links.redirect, redirect your customer to the static, hosted Pago Fácil ticket page. Once redirected, your customer should save or print the ticket.

A button on the page will allow them to return to your shop:

If the ticket is still valid, they will be redirected to your success URL.
If the ticket has expired, they will be redirected to your failure URL.

Note

Your payment confirmation page should make it clear to the customer that their purchase has not yet been completed. Explain that it has been reserved and is pending payment before the order can be completed and the goods/services can be delivered.

Redirect your customer to your payment confirmation page, where you should summarize their order and render the Pago Fácil ticket so they can complete the payment.

Note

To get the components necessary to render the ticket, use the 'get payment details' endpoint below. This will return a ticket object which contains the components to display the ticket.

Information

Tips for displaying the ticket:

Separate the ticket number into two groups of four digits (for example: 1234 - 1234). It makes it easier for customers to dictate it to cashiers.
Include the currency and amount on the ticket.
Make sure the expiry date is clear and visible, and use the dd/mm/yyyy format.
Make it clear to the customer that their payment will be credited immediately.
Include payment instructions to help customers unfamiliar with the payment process.
A store locator is a helpful feature. Just link it to google.com/maps/search/pagofacil/.
Include a save button so customers can easily save the ticket on their phone.
Include a print button for customers who want to print their ticket.
As a fallback, the ticket object should also contain the URL to the static, hosted Pago Fácil ticket.

Here's an example:

Using the following endpoint, pass the payment id (for example, pay_hcklpcd45ymepcr7thciirbdaa) from the payment response to get details about the payment.

Use the details below to set up your request.

You can find the full list, as well as complete request and response examples, in our API reference.

get

https://api.checkout.com/payments/{payment_id}

The response will differ depending on which integration_type (redirect or direct) you used in the initial payment request.


1{
2  "id": "pay_edov5e5m4zreda7hs4mnzgusze",
3  "requested_on": "2020-04-27T14:54:56Z",
4  "source": {
5    "type": "pagofacil",
6    "dlocal_order_id": "9aa40b2e9f834a84ab4147d8f7b3f305",
7    "dlocal_payment_id": "D-30150-9b3ce372-6b57-4141-ba39-86b8e8aa6de6",
8    "integration_type": "redirect",
9    "description": "simulate Pago Fácil Demo Payment"
10  },
11  "amount": 100,
12  "currency": "ARS",
13  "payment_type": "Regular",
14  "status": "Pending",
15  "risk": {
16    "flagged": false
17  },
18  "customer": {
19    "id": "cus_gghyd2m6wkgebnxvkndfwxeaji"
20  },
21  "_links": {
22    "redirect": {
23      "href": "https://sandbox.dlocal.com/collect/pay/pay/M-b91e48a5-92e2-4726-8847-055f0ed793f1?xtid=CATH-ST-1587999296-88241435"
24    },
25    "simulator:payment-succeed": {
26      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_edov5e5m4zreda7hs4mnzgusze/succeed"
27    },
28    "simulator:payment-expire": {
29      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_edov5e5m4zreda7hs4mnzgusze/expire"
30    },
31    "self": {
32      "href": "https://api.sandbox.checkout.com/payments/pay_edov5e5m4zreda7hs4mnzgusze"
33    }
34  }
35}


1{
2  "id": "pay_mnayvzqceh7e3oriqgtiuwdfpa",
3  "requested_on": "2020-04-27T14:57:08Z",
4  "source": {
5    "type": "pagofacil",
6    "dlocal_order_id": "dbbc7c685345466cbbc240c885292c12",
7    "dlocal_payment_id": "D-30150-2879065b-f8b2-4faa-a4af-aa0945473cff",
8    "integration_type": "direct",
9    "description": "simulate Pago Fácil Demo Payment",
10    "ticket": {
11      "type": "custom",
12      "number": "792945",
13      "barcode": "214100000100201240000000079294500000000036",
14      "id": "214100000100201240000000079294500000000036",
15      "expiration_date": "2020-05-04T02:59:00Z",
16      "provider_name": "pagofacil",
17      "provider_logo_url": "https://pay.dlocal.com/views/2.0/images/payments/PF.png",
18      "ticket_url": "https://sandbox.dlocal.com/gmf/payments/M-c9d35d6a-2922-4fdf-a4be-721b19e1b732"
19    }
20  },
21  "amount": 100,
22  "currency": "ARS",
23  "payment_type": "Regular",
24  "status": "Pending",
25  "risk": {
26    "flagged": false
27  },
28  "customer": {
29    "id": "cus_r3t4ok4e64uerf67kv5wly3lfa"
30  },
31  "_links": {
32    "simulator:payment-succeed": {
33      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_mnayvzqceh7e3oriqgtiuwdfpa/succeed"
34    },
35    "simulator:payment-expire": {
36      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/pagofacil/payments/pay_mnayvzqceh7e3oriqgtiuwdfpa/expire"
37    },
38    "self": {
39      "href": "https://api.sandbox.checkout.com/payments/pay_mnayvzqceh7e3oriqgtiuwdfpa"
40    }
41  }
42}

You can refund a Pago Fácil payment using our refund API. Partial and multiple – as well as full – refunds are allowed.

The customer will get an email (the email address is taken from the source.payer.email property in the initial payment request) from dLocal asking for their banking details. Once the customer has provided their details, dLocal will transfer the money to the customer's bank account.

The payment status will update to refunded and you will receive a payment_refunded (or payment_refund_declined, if unsuccessful) webhook notification.

A refund processing fee may apply.

There is no chargeback mechanism for Pago Fácil.

Webhooks	Description
`payment_pending`	Sent when a payment request is successfully initiated.
`payment_capture_pending`	Sent when the acquirer is in the process of accepting the payment.
`payment_captured`	Sent when the customer has completed the payment with the ticket.
`payment_expired`	Sent when the ticket has expired.
`payment_declined`	Sent when there was a failure in creating the payment.
`payment_refund_pending`	Sent when a refund is successfully initiated.
`payment_refunded`	Sent when a refund is successfully processed.
`payment_refund_declined`	Sent when a refund is declined.

Information

Learn more about webhooks and how to subscribe to them.

Information

To start testing, you'll need to:

create a test account, and
contact your Account Manager or Integrations engineer to activate Pago Fácil payments in the sandbox environment.

In your sandbox environment, you can test payment capture and expiration, as well as refund success and failure.

In order to test these actions, pass the string "simulate" as part of the source.description field in the initial payment request.

When you do, you will receive additional hypermedia links in the _links object in the payment response and in the 'get payment details' response.

Use the URLs contained in the simulator:payment-succeed, simulator:payment-expire, simulator:refund-succeed and simulator:refund-fail hypermedia objects to simulate the respective action/state change on the test payment.

Note

You can only test the direct payment flow in sandbox.

Pago Fácil

Information

Overview

Step 1: Request payment

Endpoints

Request examples

Response examples

Step 2: Redirect the customer or render the ticket

Redirect the customer

Information

Note

Render the ticket

Note

Information

Get details about a payment

Endpoints

Response examples

Refunds and chargebacks

Refund a payment

Chargebacks

Webhooks

Information

Testing

Information

Note