HTTP Notification Sample for SNAP

HTTP Notification sample for SNAP Payment Methods

After setting up your Notification URL, we will send the notification for certain events such as when the Virtual Account has been paid by your customers, etc.

Once the customers finish the payment, DOKU will send the notification to your defined Notification URL.

Virtual Account

Here is the sample notification that DOKU will send to merchant's server. For Virtual Account SNAP has same sample notification.

The list of Virtual Account SNAP, you can find here.

Payment Notification

POSThttps://{merchant-domain}/v1/transfer-va/payment

Header parameters

Body

Payment Notification SNAP request

partnerServiceId*string

similar to company code/BIN,8 digit left padding space. | min length: 1 | max length: 8

Example: " 77777"

customerNo*string

Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo. | min length: 1 | max length: 20

Example: "0000000000001"

virtualAccountNo*string

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo. | min length: 1 | max length: 28

Example: " 777770000000000001"

virtualAccountName*string

Customer Name | min length: 1 | max length: 255

Example: "Toru Yamashita"

trxId*string

Transaction ID in Partner system. | min length: 1 | max length: 64

Example: "23219829713"

paymentRequestIdstring

Unique identifier generated by PJP. If Payment comes from the Inquiry process, this value must be the same with inquiryRequestId. | min length: 1 | max length: 30

Example: "12839218738127830"

paidAmountTotalAmountRef (object)

virtualAccountEmailstring

Customer Email | min length: 1 | max length: 255

Example: "toru@oor.com"

virtualAccountPhonestring

Customer Phone, Format: 62xxxxxxxxx xxxx | min length: 9 | max length: 30

Example: "081293912081"

Response

item created

Body

responseCode*string

Response Code with format HTTP status code + service code + case code. | min length: 1 | max length: 7

Example: "2002500"

responseMessage*string

Response Description. | min length: 1 | max length: 150

Example: "Success"

virtualAccountData*object

Request

Response

Direct Debit

Here is the sample notification that DOKU will send to merchant's server. For Direct Debit SNAP has same sample notification.

The list of Direct Debit SNAP, you can find here.

Notify endpoint

POSThttps://{api-domain}/v1.0/debit/notify

Header parameters

Body

originalPartnerReferenceNo*string

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

Example: "INVALLO201223002"

originalReferenceNo*string

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

Example: "2023122000000002e21131"

originalExternalId*string

Original External ID from payment process | min length: 1 | max length: 64

Example: "660156703"

latestTransactionStatus*string

latest transaction status of transaction | format: 00 (Success) / 03 (Pending) / 04 (Refunded) / 05 (Canceled) / 06 (Failed)

Example: "00"

transactionStatusDesc*string

description of transaction status

Example: "Success"

amount*object

additionalInfo*object

Response

Success

Body

responseCode*string

Example: "2005600"

approvalCode*string

Example: "201039000200"

responseMessage*string

Example: "Request has been processed successfully"

Request

const response = await fetch('https://{api-domain}/v1.0/debit/notify', {
    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-customer": "Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a",
      "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": "INVALLO201223002",
      "originalReferenceNo": "2023122000000002e21131",
      "originalExternalId": "660156703",
      "latestTransactionStatus": "00",
      "transactionStatusDesc": "Success",
      "amount": {},
      "additionalInfo": {}
    }),
});
const data = await response.json();

Response

{
  "responseCode": "2005600",
  "approvalCode": "201039000200",
  "responseMessage": "Request has been processed successfully"
}

E-wallet

The notification format for SNAP e-wallet transactions exhibits minor differences from those of other e-wallets. For further details please refer to sample notification below.

Notify endpoint

POSThttps://{api-domain}/v1.0/debit/notify

Header parameters

Body

originalPartnerReferenceNo*string

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

Example: "INVALLO201223002"

originalReferenceNo*string

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

Example: "2023122000000002e92112131"

originalExternalId*string

Original External ID from payment process | min length: 1 | max length: 64

Example: "660156703"

latestTransactionStatus*string

latest transaction status of transaction | format: 00 (Success) / 03 (Pending) / 04 (Refunded) / 05 (Canceled) / 06 (Failed)

Example: "00"

transactionStatusDesc*string

description of transaction status

Example: "Success"

amount*object

additionalInfo*object

Response

Success

Body

responseCode*string

Example: "2005600"

approvalCode*string

Example: "201039000200"

responseMessage*string

Example: "Request has been processed successfully"

Request

Response

PreviousSetup Notification URL NextHTTP Notification Sample - Non SNAP

Last updated 8 months ago

const response = await fetch('https://{api-domain}/v1.0/debit/notify', { 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-customer": "Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a", "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": "INVALLO201223002", "originalReferenceNo": "2023122000000002e21131", "originalExternalId": "660156703", "latestTransactionStatus": "00", "transactionStatusDesc": "Success", "amount": {}, "additionalInfo": {} }), }); const data = await response.json();