Direct Debit Payment Notify

Specification

The Following tabel is spesification for this API :

API Name	Direct Debit Payment Notify
Function	This API is used to notify payment status and information from Paydia to merchant’s platform
Service Code	56
Method	POST
URL	/snap/v1.0/debit/notify
Accept	application/json
Content Type	application/json
Related Service	Direct Debit

Request

The following part will be describe about parameter of request in this API:

Request Parameter

The following table is a list of request parameter in this API:

Header

The following table is Header of Request Parameters :

No	Name	Type	Length	Required	Condition	Remarks
1	Content-Type	String	Variable, 127 max	Mandatory	-	Content type, value always application/json
2	X-TIMESTAMP	String	Fixed, 25 max	Mandatory	-	Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
3	X-PARTNER-ID	String	Variable, 36 max	Mandatory	-	ID for partner was generated by Paydia. Unique ID for a partner
4	X-EXTERNAL-ID	String	Variable, 36 max	Mandatory	-	Unique messaging reference ID generated by merchant. Numeric String. Reference number that should be unique in the same day
5	CHANNEL-ID	String	Variable, 5 max	Mandatory	-	Device identification on which the API services is currently being accessed by the end user (customer)
6	X-SIGNATURE	String	Variable	Mandatory	-	Signature need to be validate with Asymmetric Signature method

Body

The following table is a body of request parameter:

No	Name	Type	Length	Required	Condition	Remarks
1	originalPartnerReferenceNo	String	Variable, 64 max	Mandatory	-	Original transaction identifier on partner system
2	originalReferenceNo	String	Variable, 64 max	Mandatory	-	Original transaction identifier on Paydia system. Must be filled upon successful transaction
3	originalExternalId	String	Variable, 36 max	Mandatory	-	Original external ID on header message
4	merchantId	String	Variable, 64 max	Mandatory	-	Merchant identifier that is unique per each merchant
5	latestTransactionStatus	String	Fixed, 2 max	Mandatory	-	Category code for the status of the transaction. The values include: 00 - Success, the order has been paid 05 - Cancelled, the order has been closed because it is expired
6	transactionStatusDesc	String	Variable, 50 max	Mandatory	-	Description status transaction
7	createdTime	String	Fixed, 25 max	Mandatory	-	Transaction created time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
8	finishedTime	String	Fixed, 25 max	Mandatory	-	Transaction created time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
9	additionalInfo	JSON Object	Variable	Optional	-	Additional Information

Request Sample

The following script is a request sample of this API:

POST /v1.0/debit/notify
X-TIMESTAMP: 2024-08-05T11:43:41+07:00
X-PARTNER-ID: 4abbcb6ce30229994c76169006e0dc9c
X-SIGNATURE: X7chUwIGOnH2LTtIpynWsBGkbSyJ4JiLqEbmRl4Mu6I87Gh8jZ212Qehq6Xq8HtN/S8EfAatFtcoR/7qoWUF3ntogz8Pz7GpjRYxE+UoOjAtabxU0dlu/9+RzfPwAl07Cj8bwjUg/2A8O0uKaBf/QTdq9cV3rvdxWhwx5Hh0HVkZZc+5wNvT2yMuPXa0/SsmtjnkXM668YlOqOSI6JRwaTrzBSiJyX0Sg6A+/XbD70QBTJB2XYcx3ji0qamlCdgGxsT2Sa4+oA7ugYn1qh4SP10kfWnFVNXocYfLqY6MyFjB+1VwfgILvi9tNCsws7P4QQZeYBxcGDBMKxZTUVEwzQ==
X-EXTERNAL-ID: 1722833021
Content-Type: application/json

{
    "originalPartnerReferenceNo": "390a3ca2-75b4-4c14-9e81-6fc2c5f5e3ef",
    "originalReferenceNo": "202408IJqTAqDXOa",
    "originalExternalId": "1722832971",
    "merchantId": "240327001000000",
    "latestTransactionStatus": "00",
    "transactionStatusDesc": "Success",
    "createdTime": "2024-08-05T11:42:51+07:00",
    "finishedTime": "2024-08-05T11:43:41+07:00",
    "additionalInfo": {
        "trxId": "240805000002"
    }
}

Response

The following part will be describe about parameter of response in this API:

Response Parameter

The following table is a list of response parameter in this API:

Body

The following table is a body of response parameter:

No	Name	Type	Length	Required	Condition	Remarks
1	responseCode	String	Fixed, 7 max	Mandatory	-	Refer to response code list
2	responseMessage	String	Variable, 150 max	Mandatory	-	Refer to response code list

Response Sample

The following script is a response sample of this API:

{
  "responseCode": "2005600",
  "responseMessage": "Successful"
}

Response Code and Message

No	Response Code	Response Message	Remarks
1	2005600	Successful	Success to be processed
2	5005602	Backend system failure	500 internal server error