Transaction History
Specification
The Following tabel is spesification for this API :
API Name | Transaction History |
---|---|
Function | This API is used to query user’s Paydia Bisnis transaction history list |
Service Code | 12 |
Method | POST |
URL | /snap/v1.0/transaction-history-list |
Accept | application/json |
Content Type | application/json |
Related Service | Transaction History |
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 | Authorization | String | Variable | Conditional | If the signature option is asymmetric approach | Contains B2B Bearer JWT Token, you've got it from Access Token B2B |
3 | 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) |
4 | X-SIGNATURE | String | Variable | Mandatory | - | Signature will be generated automatically with symmetricSignature or asymmetricSignature method |
5 | X-PARTNER-ID | String | Variable, 36 max | Mandatory | - | ID for partner was generated by Paydia. Unique ID for a partner |
6 | 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 |
7 | CHANNEL-ID | String | Variable, 5 max | Mandatory | - | Device identification on which the API services is currently being accessed by the end user (customer) |
Body
The following table is a body of request parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | partnerReferenceNo | String | Variable, 64 max | Optional | - | Unique transaction identifier on partner system which assigned to each transaction |
2 | fromDateTime | String | Fixed, 25 max | Optional | - | Starting time range, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time). Default: NOW - 3 months (DESC ordering) |
3 | toDateTime | String | Fixed, 25 max | Optional | - | Ending time range, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time). Default: NOW |
Request Sample
The following script is a request sample of this API:
POST /snap/v1.0/transaction-history-list
X-TIMESTAMP: 2024-08-05T13:54:29+07:00
X-PARTNER-ID: 4abbcb6ce30229994c76169006e0dc9c
X-SIGNATURE: ZQO/ikxUNt17uO1wQXDawYjNAYO0A4jPWAHM+g7n1obGrbnDK5RhD+RIiAR72xt3WrFPjwpmivrMiIXIi0Tffw==
X-EXTERNAL-ID: 1722840873
CHANNEL-ID: 902
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjI4MzEyODcsImV4cCI6MTcyMjkxNzY4NywiZGF0YSI6eyJlbnYiOiJwcm9kdWN0aW9uIn19.wFndHWrtUMYIdbTqOtXN1EQR1y2HgafWvu-wti8IIgk
{
"partnerReferenceNo": "1722840869",
"fromDateTime": "2024-07-01T00:00:00+07:00",
"toDateTime": "2024-08-05T23:59:59+07:00"
}
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 |
3 | referenceNo | String | Variable, 64 max | Mandatory | - | Transaction identifier on Paydia |
4 | partnerReferenceNo | String | Variable, 64 max | Mandatory | - | Unique transaction identifier on partner system which assigned to each transaction |
5 | detailData | Array of JSON Object | Variable | Conditional | Y:= Data found | Contains detail data of history transaction |
6 | additionalInfo | JSON Object | Variable | Mandatory | - | Additional information |
7 | additionalInfo.paginator | JSON Object | Variable | Mandatory | - | URL to be able to receive payment notifications after payment is made by the customer |
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2001200",
"responseMessage": "Request has been processed successfully",
"partnerReferenceNo": "1722840869",
"referenceNo": "9XYkH4i1xDVgGH3j",
"detailData": [
{
"dateTime": "2024-07-09T19:26:46+07:00",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"remark": "",
"status": "SUCCESS",
"type": "SEND_MONEY",
"additionalInfo": {
"referenceNo": "f398a683-1d2f-42e0-ba77-861e4734f406",
"partnerReferenceNo": "ce56195d-e91b-4bdb-8cf7-a48b627d84cc",
"transferAmount": {
"value": "10000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "2500.00",
"currency": "IDR"
},
"bankCode": "014"
}
},
{
"dateTime": "2024-07-15T13:33:53+07:00",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"remark": "",
"status": "FAILED",
"type": "SEND_MONEY",
"additionalInfo": {
"referenceNo": "2a3ff3bb-6059-4edf-91a4-ec98f83598dd",
"partnerReferenceNo": "42e65aa8-5412-4d26-8dcf-fd23b777606b",
"transferAmount": {
"value": "10000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "2500.00",
"currency": "IDR"
},
"bankCode": "014"
}
}
],
"additionalInfo": {
"paginator": {
"pageNum": 1,
"pageSize": 10,
"totalPage": 2,
"totalCount": 20
}
}
}
Response Code and Message
The following table is the list response code and message of Transaction History API:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2001200 | Successful | Success to be processed |
2 | 4001201 | Invalid Field Format | Invalid format for certain field |
3 | 4001202 | Invalid Mandatory Field | Missing or invalid format on mandatory field |
4 | 4011200 | Unauthorized. [reason] | General unauthorized error |
5 | 4011201 | Invalid Token (B2B) | Invalid or Expired Access Token |
6 | 4091200 | Conflict | Cannot use same X-EXTERNAL-ID in same day |
7 | 4091201 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
8 | 5001202 | Backend system failure | 500 internal server error |