H Honor
EN
DiDi finanzas

Documentation

Provides integration guides, API documentation, testing instructions and other information needed throughout the integration process

2. BNPL Integration Overview

1. Document Overview

Purpose

This document describes the content related to all system integration between DiDi BNPL and partners, including but not limited to:
1. Relevant APIs.
2. Environment parameters.

Audience

The audience of this document is the partners of DiDi BNPL (hereinafter referred to as "partner"), including PSPs, e-commerce platforms, or payment partners.

Scope

This document applies to all partners that cooperate with DiDi BNPL, except for partners integrated in a special way.

Support

If you have any questions about the content of this document, or encounter technical issues during integration, please contact your DiDi BNPL contact person in time, or reach out by email: didipaylaternotice@didiglobal.com

2. Open API Message List Overview

No Open API List Direction API Description M/O/C
1 Token API Partner -> DiDi This API is for the partner to get the ACCESS-TOKEN.
This ACCESS-TOKEN will be inserted into the API header as the Authorization field.
Mandatory
2 Prescreen Partner -> DiDi The partner can use this API to check if the user can use the DiDi Paga Después payment method.
If the result = SUCCESS is returned, it means that the DiDi Paga Después payment method can be used for this user.

This is for users to pre-check whether they have permission to use DiDi BNPL.
Optional(strong suggestion)
3 Create Payment Order Partner -> DiDi This API is the main API to create the Order.
When the user selects the DiDi Paga Después payment method on your checkout page, your system should trigger the Create Payment Order API.
Mandatory
4 Cancel Order Partner -> DiDi This is the API for cancelling the order. Only the PENDING status orders can be canceled. Optional
5 Payment Order Information Query Partner -> DiDi This is the API for the partner to query the payment order information, especially the order status.

P.S. Sometimes, the payment order information query API might return an error due to some unpredictable reasons. The partner should not regard the error of the query API as the payment order result. The partner should use the specific result returned in the query API as the payment order result.

Although DiDi will send the Webhook to the partner, the Query API is mandatory. This is a bottom-of-the-pack strategy for the partner to get the order status in case the Webhook is delivered unsuccessfully.
Mandatory
6 Payment Status Webhook DiDi -> Partner The DiDi system will inform the partner of the payment status by sending the webhook.
The four payment statuses below will be sent to the integrating party:
• Order was successfully paid: PAYMENT.ORDER.PAID
• Order cancelled: PAYMENT.ORDER.CANCELED
• Order was declined: PAYMENT.ORDER.DENIED
• Order was expired: PAYMENT.ORDER.EXPIRED
Mandatory
7 Refund Simulation Partner -> DiDi Before the partner sends the refund request, the partner can use this API to simulate the refund to check the relevant fees. Optional
8 Refund Partner -> DiDi This API is for the partner to refund the transaction. It can be used in either customer-initiated or system-initiated scenarios. Mandatory
9 Refund Information Query Partner -> DiDi This is the API for the partner to query the refund information, especially the refund status.

P.S. Sometimes, the refund information query API might return an error due to some unpredictable reasons. The partner should not regard the error of the query API as the Refund result. The partner should use the specific result returned in the query API as the Refund result.

Although DiDi will send the Webhook to the partner, the Query API is mandatory. This is a bottom-of-the-pack strategy for the partner to get the Refund status in case the Webhook is delivered unsuccessfully.
Mandatory
10 Refund Status Webhook DiDi -> Partner The DiDi system will inform the partner of the Refund status by sending the webhook.
The two refund statuses below will be sent to the partner:
• Refund was successful: REFUND.ORDER.SUCCESS
• Refund is failed: REFUND.ORDER.FAILED
Mandatory

3. DiDi BNPL Environment Information

DiDi BNPL Sandbox environment domain: https://paylater-sandbox.didiglobal.com
DiDi BNPL Production environment domain: https://loan-paylater.didifinance.com

Copied successfully