SupportAPI referenceClassic API docs
Guides
Start typing to search…

Rapipago

Start accepting payments using Rapipago, a favorite payment method in Argentina.

📘

If you want to use a gateway model for accepting Rapipago 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.

Process a Rapipago payment

Rapipago payments follow a two-step process:

  1. Request payment
  2. Redirect the customer

Step 1: Request payment

The request

Use the details below to set up your request.

Endpoints

Live

POSThttps://api.checkout.com/payments

Sandbox

POSThttps://api.sandbox.checkout.com/payments

Header parameters

Header

Value

Authorization Required

secret key

Use the valid secret key of your Checkout.com account. You can find this in the Hub.

Content-Type\ Required

application/json

Body parameters

📘

The table below describes the minimum recommended fields. You can find the full list, as well as complete request and response examples, in our API reference.

Field name

Description

source Object Required

Details about the payment source.

source.type\ string\ Required

The type of payment source. Set this to rapipago.

source.integration_type\ string\ Required

The type of integration. Set this to redirect. This will return a redirect URL. Redirect the customer to this URL to proceed with the payment.

source.country\ string\ Required

The two-letter code (ISO 3166) of the customer's country. Should be AR.

source.payer\ Object\ Required

Details about the customer.

source.payer.name\ string\ Required

The full name of the customer.

source.payer.email\ string\ Required

The email address of the customer.

source.payer.document\ string\ Required

The customer's ID number or tax identification number. Either the Documento Nacional de Identidad (DNI) or Clave Única de Identificación Tributaria (CUIT).

source.description\ string\ optional

A description of the payment.

amount\ String\ required

The payment amount.

currency\ String\ Required

The three-letter currency code (ISO 4217). Set this to ARS.

Request example

{
  "source": {
    "type": "rapipago",
    "integration_type": "redirect",
    "country": "AR",
    "payer": {
      "name": "Bruce Wayne",
      "email": "[email protected]",
      "document": "27332162"
    },
    "description": "simulate Rapipago Demo Payment"
  },
  "amount": 100,
  "currency": "ARS"
}

The response

You should get a 202 response with the status field set to Pending. This means your request has been accepted.

Response example

{
  "id": "pay_274nqq3v2vqura6oirwlupvpuu",
  "status": "Pending",
  "customer": {
    "id": "cus_2l5rigg64jqu5d76rmsa4jbuu4"
  },
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_274nqq3v2vqura6oirwlupvpuu"
    },
    "redirect": {
      "href": "https://sandbox.dlocal.com/collect/pay/pay/M-edadd4c6-18d4-4e59-873d-84c361a2d98c?xtid=CATH-ST-1588001175-803994443"
    },
    "simulator:payment-succeed": {
      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/rapipago/payments/pay_274nqq3v2vqura6oirwlupvpuu/succeed"
    },
    "simulator:payment-expire": {
      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/rapipago/payments/pay_274nqq3v2vqura6oirwlupvpuu/expire"
    }
  }
}

Step 2: Redirect the customer

To capture and complete the payment, you need to provide the customer with the Rapipago ticket.

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

📘

Make sure your customer is aware that they will be redirected to the ticket page when they click your "Pay now" button, and that they should print or save the ticket.

A button on the ticket page will allow your customer 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.

🚧

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.

Get payment details

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

The request

Use the details below to set up your request.

Endpoint live

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

Endpoint sandbox

GEThttps://api.sandbox.checkout.com/payments/{payment_id}

Header and path parameters

Header

Value

Authorization Required

secret key

Use the valid secret key of your Checkout.com account. You can find this in the Hub.

Content-Type\ Required

application/json

Path

Value

payment_id Required

The payment ID found in the response of the initial payment.

The response

Response examples

{
  "id": "pay_274nqq3v2vqura6oirwlupvpuu",
  "requested_on": "2020-04-27T15:26:15Z",
  "source": {
    "type": "rapipago",
    "dlocal_order_id": "da95e7f4d26e4a14987b49a6a4710a13",
    "dlocal_payment_id": "D-30150-cbbdc947-5291-4fe9-a114-5c17b3829f9b",
    "integration_type": "redirect",
    "description": "simulate Rapipago Demo Payment"
  },
  "amount": 100,
  "currency": "ARS",
  "payment_type": "Regular",
  "status": "Pending",
  "risk": {
    "flagged": false
  },
  "customer": {
    "id": "cus_2l5rigg64jqu5d76rmsa4jbuu4"
  },
  "_links": {
    "redirect": {
      "href": "https://sandbox.dlocal.com/collect/pay/pay/M-edadd4c6-18d4-4e59-873d-84c361a2d98c?xtid=CATH-ST-1588001175-803994443"
    },
    "simulator:payment-succeed": {
      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/rapipago/payments/pay_274nqq3v2vqura6oirwlupvpuu/succeed"
    },
    "simulator:payment-expire": {
      "href": "http://sb-gateway-internal.cko.lon/dlocal-internal/rapipago/payments/pay_274nqq3v2vqura6oirwlupvpuu/expire"
    },
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_274nqq3v2vqura6oirwlupvpuu"
    }
  }
}
{
  "id": "pay_274nqq3v2vqura6oirwlupvpuu",
  "requested_on": "2020-04-27T15:26:15Z",
  "source": {
    "type": "rapipago",
    "dlocal_order_id": "da95e7f4d26e4a14987b49a6a4710a13",
    "dlocal_payment_id": "D-30150-cbbdc947-5291-4fe9-a114-5c17b3829f9b",
    "integration_type": "redirect",
    "description": "simulate Rapipago Demo Payment"
  },
  "amount": 100,
  "currency": "ARS",
  "payment_type": "Regular",
  "status": "Captured",
  "approved": true,
  "risk": {
    "flagged": false
  },
  "customer": {
    "id": "cus_2l5rigg64jqu5d76rmsa4jbuu4"
  },
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_274nqq3v2vqura6oirwlupvpuu"
    },
    "actions": {
      "href": "https://api.sandbox.checkout.com/payments/pay_274nqq3v2vqura6oirwlupvpuu/actions"
    },
    "refund": {
      "href": "https://api.sandbox.checkout.com/payments/pay_274nqq3v2vqura6oirwlupvpuu/refunds"
    }
  }
}

Refunds and chargebacks

Refund a payment

You can refund a Rapipago 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.

Chargebacks

There is no chargeback mechanism for Rapipago.

Webhooks

Webhook

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.

📘

Learn more about webhooks and how to subscribe to them.

Testing

📘

To start testing, you'll need to:

  • create a test account, and
  • contact your customer success manager or integrations engineer to activate Rapipago 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.

Can we help?

Thanks for using Checkout.com. If you need any help or support, then message our support team at [email protected].

Updated 5 months ago