Skip to main content

Transaction History

Specification

The Following tabel is spesification for this API :

API NameTransaction History
FunctionThis API is used to query user’s Paydia Bisnis transaction history list
Service Code12
MethodPOST
URL/snap/v1.0/transaction-history-list
Acceptapplication/json
Content Typeapplication/json
Related ServiceTransaction 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:

The following table is Header of Request Parameters :

NoNameTypeLengthRequiredConditionRemarks
1Content-TypeStringVariable, 127 maxMandatory-Content type, value always application/json
2AuthorizationStringVariableConditionalIf the signature option is asymmetric approachContains B2B Bearer JWT Token, you've got it from Access Token B2B
3X-TIMESTAMPStringFixed, 25 maxMandatory-Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
4X-SIGNATUREStringVariableMandatory-Signature will be generated automatically with symmetricSignature or asymmetricSignature method
5X-PARTNER-IDStringVariable, 36 maxMandatory-ID for partner was generated by Paydia. Unique ID for a partner
6X-EXTERNAL-IDStringVariable, 36 maxMandatory-Unique messaging reference ID generated by merchant. Numeric String. Reference number that should be unique in the same day
7CHANNEL-IDStringVariable, 5 maxMandatory-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:

NoNameTypeLengthRequiredConditionRemarks
1partnerReferenceNoStringVariable, 64 maxOptional-Unique transaction identifier on partner system which assigned to each transaction
2fromDateTimeStringFixed, 25 maxOptional-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)
3toDateTimeStringFixed, 25 maxOptional-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:

NoNameTypeLengthRequiredConditionRemarks
1responseCodeStringFixed, 7 maxMandatory-Refer to response code list
2responseMessageStringVariable, 150 maxMandatory-Refer to response code list
3referenceNoStringVariable, 64 maxMandatory-Transaction identifier on Paydia
4partnerReferenceNoStringVariable, 64 maxMandatory-Unique transaction identifier on partner system which assigned to each transaction
5detailDataArray of JSON ObjectVariableConditionalY:= Data foundContains detail data of history transaction
6additionalInfoJSON ObjectVariableMandatory-Additional information
7additionalInfo.paginatorJSON ObjectVariableMandatory-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:

NoResponse CodeResponse MessageRemarks
12001200SuccessfulSuccess to be processed
24001201Invalid Field FormatInvalid format for certain field
34001202Invalid Mandatory FieldMissing or invalid format on mandatory field
44011200Unauthorized. [reason]General unauthorized error
54011201Invalid Token (B2B)Invalid or Expired Access Token
64091200ConflictCannot use same X-EXTERNAL-ID in same day
74091201Duplicate partnerReferenceNoDuplicate partnerReferenceNo
85001202Backend system failure500 internal server error