ShopeePay

Integration Steps

Overview of integration process with ShopeePay.

1. Payment

Payment process using ShopeePay doesn't require account binding. After customer creates an order and chooses ShopeePay as payment method on merchant's platform, merchant will hit this payment API to get redirect URLs to ShopeePay's platform for customer to complete the payment.

API Endpoint

Environment

Endpoint

HTTP Method

POST

API Sandbox

https://api-sandbox.doku.com

API Production

https://api.doku.com

Path

.../direct-debit/core/v1/debit/payment-host-to-host

Sample of Request Header, Request Body and Response Body

Notes:

Parameter with (*) is mandatory

Paramater without (*) is optional/conditional

Payment

POSThttps://{api-domain}/direct-debit/core/v1/debit/payment-host-to-host

Header parameters

Body

partnerReferenceNo*string

invoice number from partner | max: 64 | Mandatory

Example: "INV-0001"

validUptostring

Expired time payment url | format: 2024-07-10T11:57:58+07:00

Example: "2024-07-10T11:57:58+07:00"

pointOfInitiationstring

Point of initiation from partner | value: app/pc/mweb | max: 20

Example: "app"

urlParam*object

amount*AmountObject (object)

additionalInfoobject

Response

Successful

Body

responseCode*string

Response Code with format HTTP status code + service code + case code. service code and status code refer to: https://developers.doku.com/getting-started-with-doku-api/response-code/http-status-and-case-code#id-3.-e-wallet . | Mandatory | min length: 1 | max length: 7.

Example: "2000500"

responseMessage*string

Response Message

Example: "Successful"

webRedirectUrl*string

Redirect URL to Merchant's page/platform for customer to input OTP/PIN

Example: "https://app-uat.doku.com/link/283702597342040"

partnerReferenceNostring

Invoice Number from Partner

Example: "INV-0001"

Request

const response = await fetch('https://{api-domain}/direct-debit/core/v1/debit/payment-host-to-host', {
    method: 'POST',
    headers: {
      "X-TIMESTAMP": "2020-12-21T07:56:11.000Z",
      "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5",
      "X-PARTNER-ID": "821508239190",
      "X-EXTERNAL-ID": "418075533589",
      "X-DEVICE-ID": "95221",
      "Authorization": "95221",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "partnerReferenceNo": "INV-0001",
      "amount": {
        "value": "10000.00",
        "currency": "IDR"
      },
      "urlParam": {
        "url": "www.merchant.co.id",
        "type": "PAY_RETURN",
        "isDeepLink": "Y/N"
      }
    }),
});
const data = await response.json();

Response

{
  "responseCode": "2000500",
  "responseMessage": "Successful",
  "webRedirectUrl": "https://app-uat.doku.com/link/283702597342040",
  "partnerReferenceNo": "INV-0001"
}

2. Payment Notification

After payment is completed, DOKU will send HTTP Notification to merchant's defined Notification URL. Learn how to handle the notification from DOKU.

3. Additional Feature

Online Refund

This endpoint is used to create refund request for previous successful payment. Merchant can request a transaction refund to DOKU.

API Endpoint

Environment

Endpoint

HTTP Method

POST

API Sandbox

https://api-sandbox.doku.com

API Production

https://api.doku.com

Path

.../direct-debit/core/v1/debit/refund

Sample of Request Header, Request Body and Response Body

Notes:

Parameter with (*) is mandatory

Paramater without (*) is optional/conditional

Refund

POSThttps://{api-domain}/direct-debit/core/v1/debit/refund

Header parameters

Body

additionalInfo*object

originalPartnerReferenceNo*string

Partner Reference No from Purchase Transaction | max: 64 | Mandatory

Example: "INV-0001"

originalExternalIdstring

External ID from Purchase Transaction | max: 64 |

Example: "REQ-0001"

refundAmountAmountObject (object)

reasonstring

Reason for Refund | max: 255

Example: "Request by Customer"

partnerRefundNo*string

Partner Refund No from Partner | max: 64 | Mandatory

Example: "INV-REF-0001"

Response

Successful

Body

responseCode*string

Example: "2000700"

responseMessage*string

Response message

Example: "Successful"

refundAmount*AmountObject (object)

refundTime*string

format: yyyy-MM-dd'T'HH:mm:ssXXX

Example: "2024-01-01T09:09:00.123"

Request

const response = await fetch('https://{api-domain}/direct-debit/core/v1/debit/refund', {
    method: 'POST',
    headers: {
      "X-TIMESTAMP": "2020-12-21T07:56:11.000Z",
      "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5",
      "X-PARTNER-ID": "821508239190",
      "X-EXTERNAL-ID": "418075533589",
      "X-DEVICE-ID": "95221",
      "Authorization": "95221",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "originalPartnerReferenceNo": "INV-0001",
      "partnerRefundNo": "INV-REF-0001",
      "additionalInfo": {
        "channel": "EMONEY_SHOPEE_PAY_SNAP"
      }
    }),
});
const data = await response.json();

Response

{
  "responseCode": "2000700",
  "responseMessage": "Successful",
  "refundAmount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "refundTime": "2024-01-01T09:09:00.123"
}

PreviousOVO NextDirect Debit

Last updated 5 months ago

const response = await fetch('https://{api-domain}/direct-debit/core/v1/debit/payment-host-to-host', { method: 'POST', headers: { "X-TIMESTAMP": "2020-12-21T07:56:11.000Z", "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5", "X-PARTNER-ID": "821508239190", "X-EXTERNAL-ID": "418075533589", "X-DEVICE-ID": "95221", "Authorization": "95221", "Content-Type": "application/json" }, body: JSON.stringify({ "partnerReferenceNo": "INV-0001", "amount": { "value": "10000.00", "currency": "IDR" }, "urlParam": { "url": "www.merchant.co.id", "type": "PAY_RETURN", "isDeepLink": "Y/N" } }), }); const data = await response.json();