Debit-Status
- Endpoint:
POST /v1.0/debit/status - Tags: Indonesia SNAP
Parameters
| Field | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
Content-Type | header | string | Yes | Content type, value always application/json | |
X-TIMESTAMP | header | string | Yes | Transaction date time, in format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. | |
X-SIGNATURE | header | string | Yes | Signature need to be generated with symmetricSignature or asymmetricSignature method | |
ORIGIN | header | string | No | Origin domain | |
X-PARTNER-ID | header | string | Yes | Unique identifier for partner was generated by Payermax, or known as clientId | |
X-EXTERNAL-ID | header | string | Yes | Unique messaging reference identifier generated by merchant and should be unique within the same day | |
CHANNEL-ID | header | string | Yes | Device identification on which the API services is currently being accessed by the end user (customer) | |
sign | header | string | Yes | 签名信息请参考技术文档 |
Parameter Examples
Content-Type:"application/json"X-TIMESTAMP:""X-SIGNATURE:""ORIGIN:""X-PARTNER-ID:""X-EXTERNAL-ID:""CHANNEL-ID:""sign:"FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="
Request Body
Content-Type: application/json
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
merchantId | string | Yes | maxLength: 32 | Merchant identifier that is unique per each merchant | |
originalPartnerReferenceNo | string | Yes | maxLength: 64 | Original transaction identifier on partner system | |
serviceCode | string | Yes | maxLength: 2 | Transaction type indicator (service code of the original transaction request) | |
originalReferenceNo | string | No | maxLength: 64 | Original transaction identifier on payermax system | |
originalExternalId | string | No | maxLength: 36 | Original external identifier on header message | |
transactionDate | string | No | maxLength: 25 | Transaction date, in format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. | |
amount | object | No | |||
amount.value | number | Yes | Transaction amount | ||
amount.currency | string | Yes | Transaction currency | ||
externalStoreId | string | No | maxLength: 64 | Store identifier to indicate to which store this payment belongs to | |
additionalInfo | object | Yes | Additional information | ||
additionalInfo.version | string | Yes | maxLength: 8 | API version. Current value: 1.4 | |
additionalInfo.keyVersion | string | Yes | maxLength: 8 | Signature Algorithm Version, Current value: 1 |
Example
json
{
"originalPartnerReferenceNo": "20240305152406779100017",
"merchantId": "P05010114269706",
"originalReferenceNo": "",
"originalExternalId": "",
"serviceCode": "17",
"transactionDate": "2020-12-21T14:56:11+07:00",
"amount": {
"value": "100000.00",
"currency": "IDR"
},
"subMerchantId": "",
"externalStoreId": "",
"additionalInfo": {
"version": "1.4",
"keyVersion": "1"
}
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
responseCode | string | Yes | maxLength: 7 | response code | |
responseMessage | string | Yes | maxLength: 150 | response msg | |
originalPartnerReferenceNo | string | Yes | maxLength: 64 | Original transaction identifier on service consumer system | |
originalReferenceNo | string | Yes | maxLength: 64 | Original transaction identifier on service Payermax system | |
transAmount | object | No | Trans amount | ||
transAmount.value | number | Yes | Trans amount | ||
transAmount.currency | string | Yes | maxLength: 3 | Trans currency | |
latestTransactionStatus | string | Yes | maxLength: 2 | Category code for the status of the transaction. The values include: 00 = Success, the order has been successfully in final state and paid 03 = Pending, the order is in process, not in final state, payment is success 05 = Cancelled, the order has been closed 06 = Failed, the order has been failed | |
paidTime | string | No | maxLength: 25 | Transaction paid time, in format yyyy-MM-dd'T'HH:mm:ss.SSSXXX | |
originalResponseMessage | string | No | maxLength: 256 | Original response message | |
refundHistory | array[object] | No | Refund orders | ||
refundHistory[].refundNo | string | Yes | maxLength: 64 | Refund transaction Identifier on Service Provider System | |
refundHistory[].partnerRefundNo | string | Yes | maxLength: 64 | Refund transaction identifier on service consumer system | |
refundHistory[].refundAmount | object | Yes | Net amount of the refund | ||
refundHistory[].refundAmount.value | number | Yes | Refund amount | ||
refundHistory[].refundAmount.currency | string | Yes | maxLength: 3 | Refund currency | |
refundHistory[].refundStatus | string | Yes | maxLength: 2 | 00 - Success 03 - Pending 06 - Failed | |
refundHistory[].refundDate | string | No | maxLength: 25 | Refund transaction date | |
refundHistory[].reason | string | No | maxLength: 512 | Refund reason |
Response Example
json
{
"transAmount": {
"currency": "IDR",
"value": 100000
},
"originalReferenceNo": "T2024030507930244000069",
"latestTransactionStatus": "05",
"originalResponseMessage": "Payment was not completed on time.",
"originalPartnerReferenceNo": "20240305152406779100017",
"responseMessage": "Success.",
"paidTime": "",
"responseCode": "2005500"
}