Konbini via dLocal

Accept Konbini payments from customers in Japan with dLocal as the payment service provider (PSP). The customer selects Konbini, gets a payment code on a dLocal page and pays at a convenience store.

Supported workflows

Workflow	Supported
Payrails SDK	✔
Payrails API	✔
Delayed / Manual Capture	✖
Instant Capture	✔
Cancel / Void	✖
Refund / Reverse	✔
Save Instruments	✖
Merchant Initiated Transaction (MIT)	✖

Before you begin

Complete these steps before you send your first Konbini payment through dLocal:

Set up a dLocal integration in your workspace. Follow the dLocal integration setup guide if you don’t have one yet.
Ask dLocal to enable Konbini on your dLocal account.
In the Payrails Portal, go to Settings → Integrations, open your dLocal integration, select Konbini under Payment methods, and save.
Add Konbini as a payment option in your workflow.

Request fields for dLocal

Send these fields in the authorize request, in addition to the standard authorize fields. Required fields must be present for the payment to succeed. Payrails sends Optional fields to the PSP when you include them.

Field	Status	Description
`amount.currency`	Required	Must be `JPY`. Payrails rejects other currencies.
`meta.customer.country`	Required	The customer’s country object. Payrails sends `JP` to dLocal for every Konbini payment, whatever `country.code` you send.
`meta.customer.name`	Required	Sent to dLocal as the payer name, together with `meta.customer.lastName`.
`meta.customer.email`	Required	Sent to dLocal as the payer email.
`meta.customer.lastName`	Optional	Added to the payer name.
`meta.customer.phone`	Optional	Sent to dLocal as the payer phone number.
`meta.customer.identityCardNumber`	Optional	Sent to dLocal as the payer document.
`meta.order.billingAddress`	Optional	Sent to dLocal as the payer address. `meta.order.deliveryAddress` takes priority when both are present.
`meta.order.description`	Optional	Sent to dLocal as the payment description.
`meta.clientContext.ipAddress`	Optional	Sent to dLocal as the payer IP address.

Authorize a Konbini payment

Call authorize a payment with konbini as the paymentMethodCode. The response includes the redirect to the dLocal payment code page.

Authorize request

{
  "amount": {
    "value": "2000",
    "currency": "JPY"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "konbini",
      "amount": {
        "value": "2000",
        "currency": "JPY"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Yuki",
      "lastName": "Tanaka",
      "email": "yuki.tanaka@example.com",
      "country": {
        "code": "JP"
      }
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

The customer pays later at a convenience store. Confirm the result through webhook notifications or the execution status before you ship the order.

How dLocal handles Konbini

dLocal returns a redirect URL to its hosted page with the payment code and store instructions. The payment stays pending until the customer pays, and Payrails completes it from the dLocal notification.
Payrails captures Konbini payments through dLocal when they’re paid, so a successful payment is final. To return funds, refund the payment.
Each Konbini payment is a new customer-initiated payment.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for dLocal

Authorize a Konbini payment

How dLocal handles Konbini

​Supported workflows

​Before you begin

​Request fields for dLocal

​Authorize a Konbini payment

​How dLocal handles Konbini

Supported workflows

Before you begin

Request fields for dLocal

Authorize a Konbini payment

How dLocal handles Konbini