ShopeePay

Integration Steps

Here is the overview of how to integrate with ShopeePay :

1. Payment

2. Acknowledge Payment Notification

1. Payment

To do payment using ShopeePay, you will need to hit this API through your backend :

Payment Jump App Merchant Interface

Merchant interface for payment jump App Dana SNAP

POSThttps://virtserver.swaggerhub.com/DOKUTECHNOLOGY/Merchant-Interface/1.0.0/direct-debit/merchant/shopeepay/v1.0/debit/payment-host-to-host

Header parameters

Body

application/json

partnerReferenceNo*string

Partner Reference Number | min length: 1 | max length: 64

Example: "INV_20221221_0002"

amountobject

urlParamarray of object

validUpTostring (date)

Order Valid Up To | format: date

Example: "2022-07-20T07:00:00+07:00"

additionalInfoobject

Response

200400401

Payment successful

Body

application/json

responseCodestring

Example: "20054000"

responseMessagestring

Example: "Successfull"

referenceNostring

Example: "20231011111212800110166670701279462"

partnerReferenceNostring

Example: "INV2023101102"

webRedirectUrlstring

Example: "https://pjsp.com/universal?bizNo=REF9"

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/DOKUTECHNOLOGY/Merchant-Interface/1.0.0/direct-debit/merchant/shopeepay/v1.0/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": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "partnerReferenceNo": "INV_20221221_0002"
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "20054000",
  "responseMessage": "Successfull",
  "referenceNo": "20231011111212800110166670701279462",
  "partnerReferenceNo": "INV2023101102",
  "webRedirectUrl": "https://pjsp.com/universal?bizNo=REF9"
}

2. Acknowledge Payment Notification

After the payment is being made by your customer, DOKU will send HTTP Notification to your defined Notification URL. Learn how to handle the notification from DOKU .

Additional Feature

Online Refund :

Refund Merchant Interface

Merchant interface for Refund Dana SNAP

POSThttps://virtserver.swaggerhub.com/DOKUTECHNOLOGY/Merchant-Interface/1.0.0/direct-debit/merchant/shopeepay/v1.0/debit/refund

Header parameters

Body

application/json

JSON request body for refunding a direct debit payment

originalPartnerReferenceNo*string

Original Partner Reference Number | min length: 1 | max length: 64

Example: "Testing-123"

partnerRefundNo*string

Partner Refund Number | min length: 1 | max length: 64

Example: "20230915123232"

originalExternalId*string

Original External Id | min length: 1 | max length: 36

Example: "20230926103436"

reasonstring

Reason of refund | max length: 256

Example: "Cancel Order"

refundAmountobject

Response

200400401

Refund successful

Body

application/json

responseCodestring

Example: "20058000"

responseMessagestring

Example: "Successful"

refundNostring

Example: "Refund-123123"

partnerRefundNostring

Example: "Refund-test123"

refundAmountobject

refundTimestring

Example: "2022-07-20T07:00:00+07:00"

additionalInfoobject

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/DOKUTECHNOLOGY/Merchant-Interface/1.0.0/direct-debit/merchant/shopeepay/v1.0/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": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "originalPartnerReferenceNo": "Testing-123",
      "partnerRefundNo": "20230915123232",
      "originalExternalId": "20230926103436"
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "20058000",
  "responseMessage": "Successful",
  "refundNo": "Refund-123123",
  "partnerRefundNo": "Refund-test123",
  "refundAmount": {
    "value": "12345678.00",
    "currency": "IDR"
  },
  "refundTime": "2022-07-20T07:00:00+07:00",
  "additionalInfo": {
    "createTime": "2022-07-20T07:00:00+07:00",
    "latestTransactionStatus": "00"
  }
}