Create AccountSubmit FeedbackAI Assist (BETA)

Transaction History Detail API

This API is used to get merchant's transaction history detail

Path/{version}/transaction-history-detail
HTTP MethodPOST
Versionv1.0
SNAP Service Code13

Request Header

Field NameField TypeMandatoryField Description
Content-typeStringMMedia type of the resource, i.e. application/json
X-TIMESTAMPStringMClient’s current local time in ISO-8601 format
X-SIGNATUREStringMUnique identifier for partner
AuthorizationStringMRepresents access_token of a request; string starts with keyword “Bearer ” followed by access_token. Can get this token from Access Token B2B response
X-PARTNER-IDStringMUnique identifier for partner
X-EXTERNAL-IDStringMAlphanumeric string. Preferably UUID. Reference number that should be unique in the same day or 1 day idempotency key
CHANNEL-IDStringMDevice identification on which the API services are currently being accessed by the end user. Given by BI
Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:34:40+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
CHANNEL-ID: 95221

Request Body

Field NameField TypeMandatoryField Description
originalPartnerReferenceNoString(64)MTransaction identifier on service consumer system
additionalInfoObjectMAdditional information
additionalInfo.referenceNoString(64)MTransaction identifier on service provider system
{
  "originalPartnerReferenceNo": "2020102900000000000001",
  "additionalInfo": {
    "referenceNo": "2020102977770000000009"
  }
}

Response Header

Field NameField TypeMandatoryField Description
Content-typeStringMMedia type of the resource, i.e. application/json
X-TIMESTAMPStringMClient’s current local time in ISO-8601 format
Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:34:40+07:00

Response Body

Field NameField TypeMandatoryField Description
responseCodeString(7)MResponse code (HTTP status code + service code + case code)
responseMessageString(150)MResponse description
referenceNoString(64)MTransaction identifier on service provider system
partnerReferenceNoString(64)MTransaction identifier on service consumer system
dateTimeString(25)MTransaction created time in ISO-8601 format
amountObjectMAmount information
amount.valueString(16,2)MNet amount of the transaction
amount.currencyString(3)MCurrency
remarkString(256)OTransaction remark
statusString(32)MTransaction status (BI-SNAP)
typeString(32)MTransaction type (BI-SNAP)
additionalInfoObjectOAdditional information
additionalInfo.statusString(32)MTransaction status (Midtrans)
additionalInfo.typeString(32)MTransaction type (Midtrans)
additionalInfo.updatedTimeString(25)MTransaction updated time in ISO-8601 format
additionalInfo.channelString(100)MTransaction channel
additionalInfo.customerEmailString(100)OCustomer email
additionalInfo.accountNoString(32)OAccount number
additionalInfo.paymentObjectOPayment related information
payment.expiryTimeString(25)MPayment expiry time in ISO-8601 format
payment.sourceString(20)MPayment source
payment.cardNumberStringOCredit card number
payment.cardTypeStringOCredit card type
payment.cardChannelResponseCodeStringOCredit card response code
payment.
cardChannelResponseMessage		StringOCredit card response message
payment.issuingBrandStringOCredit card issuing brand
payment.issuingBankStringOCredit card issuing bank
payment.issuingCountryCodeStringOCredit card issuing country code
payment.issuingCountryNameStringOCredit card issuing country name
payment.acquiringBankStringOCredit card acquiring bank
payment.retrievalReferenceNumberStringOCredit card retrieval reference number
payment.fdsRecommendationStringOCredit card FDS recommendation
payment.creditCardSecureStringOCredit card secure
payment.bankMidStringOCredit card bank mid
payment.bankResponseCodeStringOCredit card bank response code
payment.isOneClickbooleanOCredit card is one click
payment.isTwoClickbooleanOCredit card is two click
payment.installmentTermStringOCredit card installment term
payment.installmentTypeStringOCredit card installment type
payment.redeemedPointsAmountStringOCredit card redeemed points amount
payment.redeemedPointsQuantityStringOCredit card redeemed points quantity
payment.networkTransactionIdStringOCredit card network transaction id
payment.storeStringOConvenient store name, i.e: indomaret, alfamart
payment.paymentCodeStringOConvenient store payment code
payment.trackingRefStringOConvenient store tracking reference (only for Indomaret)
payment.agentTransactionIdStringOConvenient store agent transaction id (only for Alfarmart)
payment.virtualAccountNumberStringOVirtual account number
payment.bcaVaChannelStringOVirtual account channel (only for BCA)
payment.bniVaTypeStringOVirtual account type, e.g: open_payment, fixed_payment (only for BNI)
payment.bniLeftAmountStringOVirtual account left amount (only for BNI)
payment.qrisOnUsbooleanOQRIS is on us
payment.qrisReferenceNumberStringOQRIS reference number
payment.qrisIssuerStringOQRIS issuer
payment.qrisIssuerTransactionIdStringOQRIS issuer transaction id
payment.qrisAcquirerStringOQRIS acquirer
payment.qrisAcquirerTransactionIdStringOQRIS acquirer transaction id
payment.gopaySourceStringOGoPay source
payment.gopayPaymentOptionStringOGoPay payment options
payment.merchantCrossReferenceIdStringOGoPay unique ID per merchant as an identifier in tokenization activation
payment.mandiriBillKeyStringOMandiri Bill key
payment.mandiriBillChannelIdStringOMandiri Bill channel id
payment.mandiriBillInfosArray of StringOMandiri Bill informations
payment.mandiriBillPaidBillsStringOMandiri Bill paid bills
payment.mandiriBillPaymentAmountStringOMandiri Bill payment amount
payment.akulakuOrderIdStringOAkulaku order id
payment.akulakuPeriodsStringOAkulaku periods
payment.
akulakuMonthlyInstallmentPayment		StringOAkulaku monthly installment payment
payment.kredivoTransactionIdStringOKredivo transaction id
payment.kredivoInstallmentTermStringOKredivo installment term
payment.shopeepayTransactionIdStringOShopeePay transaction id
payment.uobEzpayTransactionTimeStringOUOB EZ Pay transaction time
payment.uobEzpayNotificationIdStringOUOB EZ Pay notification id
payment.uobEzpayBankReferenceStringOUOB EZ Pay bank reference
payment.
cimbClicksReferenceNumber		StringOCIMB Clicks reference number
payment.cimbClicksAuthCodeStringOCIMB Clicks auth code
payment.
bcaKlikpayTransactionNumber		StringOBCA KlikPay transaction number
payment.bcaKlikpayTypeStringOBCA KlikPay type
payment.
bcaKlikbcaTransactionNumber		StringOKlikBCA transaction number
payment.bcaKlikbcaUserIdStringOKlikBCA user id
payment.
briEpayPaymentReferenceNumber		StringOe-Pay BRI payment reference number
payment.
briEpayBillReferenceNumber		StringOe-Pay BRI bill reference number
payment.briEpayUserFullNameStringOe-Pay BRI user full name
payment.mandiriEcashIdStringOMandiri e-Cash id
payment.mandiriEcashTraceNumberStringOMandiri e-Cash trace number
payment.mandiriEcashPhoneNumberStringOMandiri e-Cash phone number
payment.mandiriEcashDescriptionStringOMandiri e-Cash description
payment.
danamonOnline
PaymentReferenceNumber		StringODanamon Online payment reference number
payment.
danamonOnlineBillReferenceNumber		StringODanamon Online bill reference number
payment.linkajaResultCodeStringOLinkAja result code
payment.linkajaReferenceIdStringOLinkAja reference id
payment.linkajaReceiptNumberStringOLinkAja receipt number
payment.
linkajaOriginatorConversationId		StringOLinkAja originator conversation id
payment.linkajaConversationIdStringOLinkAja conversation id
payment.dbsPaylahMessageIdStringOLinkAja message id
payment.dbsPaylahReferenceIdStringODBS Paylah! reference id
payment.paypalTransactionIdStringOPayPal transaction id
payment.refundsArray of ObjectORefunds information
refunds.idStringORefund id
refunds.amount.valueStringORefund amount of the transaction
refunds.amount.currencyStringORefund currency
refunds.reasonStringORefund reason
refunds.createdTimeString(25)ORefund created time in in ISO-8601 format
refunds.bankConfirmedTimeString(25)ORefund bank confirmed time in in ISO-8601 format
refunds.cancelledTimeString(25)ORefund cancelled time in in ISO-8601 format
payment.customerObjectOCustomer information
customer.firstNameStringOCustomer first name
customer.lastNameStringOCustomer last name
customer.emailStringOCustomer email
customer.phoneStringOCustomer phone
payment.shippingAddressStringOShipping address information
shippingAddress.firstNameStringOShipping first name
shippingAddress.lastNameStringOShipping last name
shippingAddress.phoneStringOShipping phone
shippingAddress.postalCodeStringOShipping postalCode
shippingAddress.countryCodeStringOShipping postal code
shippingAddress.cityStringOShipping city
shippingAddress.addressStringOShipping address
payment.itemsArray of ObjectOItems information
items.idStringOItem identifier on service provider system
items.partnerIdStringOItem identifier on service consumer system
items.nameStringOItem name
items.quantityStringOItem quantity
items.price.valueStringOItem price
payment.promoObjectOPromo information
promo.idStringOPromo identifier
promo.codeStringOPromo code
promo.nameStringOPromo name
promo.sponsorStringOPromo sponsor
promo.originalAmount.valueStringOPromo original amount
promo.discountAmount.valueStringOPromo discountAmount
promo.userIpStringOUser IP address when using the promo
additionalInfo.withdrawalObjectOWithdrawal related information
withdrawal.bankNameStringOWithdrawal bank name
withdrawal.bankCodeStringOWithdrawal bank code
withdrawal.accountNoStringOWithdrawal account number
withdrawal.accountNameStringOWithdrawal account name
withdrawal.requestedTimeStringOWithdrawal requested time in ISO-8601 format
withdrawal.successTimeStringOWithdrawal success time in ISO-8601 format
withdrawal.failedTimeStringOWithdrawal failed time in ISO-8601 format
withdrawal.cancelledTimeStringOWithdrawal cancelled time in ISO-8601 format
additionalInfo.disbursementObjectODisbursement related information
disbursement.sourceBankCodeStringODisbursement source bank code
disbursement.sourceAccountNoStringODisbursement source account number
disbursement.beneficiaryEmailStringODisbursement beneficiary email
disbursement.beneficiaryNameStringODisbursement beneficiary name
disbursement.beneficiaryBankCodeStringODisbursement beneficiary bank code
disbursement.beneficiaryBankNameStringODisbursement beneficiary bank name
disbursement.beneficiaryAccountNoStringODisbursement beneficiary account number
disbursement.creatorEmailStringODisbursement creator email
disbursement.creatorNameStringODisbursement creator name
disbursement.approverEmailStringODisbursement approver email
disbursement.approverNameStringODisbursement approver name
disbursement.requestedTimeString(25)ODisbursement requested time in ISO-8601 format
disbursement.approvedTimeString(25)ODisbursement approved time in ISO-8601 format
disbursement.rejectedTimeString(25)ODisbursement rejected time in ISO-8601 format
disbursement.processedTimeString(25)ODisbursement processed time in ISO-8601 format
disbursement.completedTimeString(25)ODisbursement completed time in ISO-8601 format
disbursement.failedTimeString(25)ODisbursement failed time in ISO-8601 format
disbursement.failureMessageStringODisbursement failure message
disbursement.failureCodeStringODisbursement failure code
{
  "responseCode": "2001300",
  "responseMessage": "Success",
  "referenceNo": "2020102977770000000009",
  "partnerReferenceNo": "2020102900000000000001",
  "dateTime": "2019-07-03T12:08:56+07:00",
  "amount": {
    "value": "12345678.00",
    "currency": "IDR"
  },
  "remark": "Payment to Warung Ikan Bakar",
  "status": "SUCCESS",
  "type": "PAYMENT",
  "additionalInfo": {
    "status": "SETTLEMENT",
    "type": "PAYMENT",
    "updatedTime": "2019-07-03T12:08:56+07:00",
    "channel": "qris",
    "customerEmail": "[email protected]",
    "accountNo": "123456",
    "payment": {
      "expiryTime": "2019-07-03T12:08:56+07:00",
      "source": "SNAP",
      "providerReferenceId": "A120240108151754NxoeRNYP4YID",
      "approvalCode": "100127",
      
      // Credit Card
      "cardNumber": "4556 5579 **** 6624",
      "cardType": "credit",
      "cardChannel": "mti",
      "cardChannelResponseCode": "00",
      "cardChannelResponseMessage": "Approved",
      "issuingBrand": "VISA",
      "issuingBank": "bca",
      "issuingCountryCode": "US",
      "issuingCountryName": "UNITEDSTATES",
      "acquiringBank": "mandiri",
      "retrievalReferenceNumber": "736620222955",
      "fdsRecommendation": "accept",
      "creditCardSecure": true,
      "bankMid": "1100889977",
      "bankResponseCode": "00",
      "isOneClick": false,
      "isTwoClick": false,
      "installmentTerm": "",
      "installmentType": "",
      "redeemedPointsAmount": {
        "value": "5000.00",
        "currency": "IDR"
      },
      "redeemedPointsQuantity": "10",
      "networkTransactionId": "606345944234331",
      
      // Convenient Store
      "store": "indomaret",
      "paymentCode": "901083200026",
      "trackingRef": "82851212597196801", // indomaret
      "agentTransactionId": "cZkpKVCOibLOeEp", // alfamart
      
      // Bank Transfer / Virtual Account
      "virtualAccountNumber": "96883778474",
      "bcaVaChannel": "Internet Banking",
      "bniVaType": "open_payment",
      "bniLeftAmount": {
        "value": "-3.00",
        "currency": "IDR"
      },
        
      // QRIS
      "qrisOnUs": false,
      "qrisReferenceNumber": "A120240108151754NxoeRNYP4YID",
      "qrisIssuer": "gopay",
      "qrisIssuerTransactionId": "A120240108151754NxoeRNYP4YID",
      "qrisAcquirer": "gopay",
      "qrisAcquirerTransactionId": "A120240108151754NxoeRNYP4YID",
        
      // GoPay
      "gopaySource": "gopay_online",
      "gopayPaymentOption": "GOPAY_WALLET",
      "merchantCrossReferenceId": "760fbd7c-6720-4bb6-88f9-2a75ad8c1173",
      
      // Mandiri Bill
      "mandiriBillKey": "213916480962",
      "mandiriBillInfos": ["rizvi gopay"],
      "mandiriBillChannelId": "1234",
      "mandiriBillPaidBills": "01",
      "mandiriBillPaymentAmount": {
        "value": "10000.00",
        "currency": "IDR"
      },
      
      // Akulaku
      "akulakuOrderId": "A120240223061624q0ouIEgan1ID-1",
      "akulakuPeriods": "",
      "akulakuMonthlyInstallmentPayment": "5000",
      
      // Kredivo
      "kredivoTransactionId": "12a1c87c-74c9-4819-aa37-4f74acff9c07",
      "kredivoInstallmentTerm": "30_days",
      
      // ShopeePay
      "shopeepayTransactionId": "960774027066627564",
      
      // UOB EZ Pay
      "uobEzpayTransactionTime": "2019-07-03T12:08:56+07:00",
      "uobEzpayNotificationId": "asdfgh",
      "uobEzpayBankReference": "zxcvbn",
     
      // CIMB Clicks
      "cimbClicksReferenceNumber": "000000000000071969",
      "cimbClicksAuthCode": "1708428664718",
     
      // BCA KlikPay
      "bcaKlikpayTransactionNumber": "1693622",
      "bcaKlikpayType": "1",
      
      // KlikBCA
      "bcaKlikbcaTransactionNumber": "12078115af80447e97",
      "bcaKlikbcaUserId": "testuser01",
      
      // e-Pay BRI
      "briEpayPaymentReferenceNumber": "1696937935399",
      "briEpayBillReferenceNumber": "294634661",
      "briEpayUserFullName": "Midtrans",
      
      // Mandiri e-Cash
      "mandiriEcashId": "cf7989fe-1873-4ecd-a933-3c833a8b9f8b",
      "mandiriEcashTraceNumber": "xyzxyz",
      "mandiriEcashPhoneNumber": "0987654321",
      "mandiriEcashDescription": "Transaction Description",
      
      // Danamon Online
      "danamonOnlinePaymentReferenceNumber": "i1ji2X9Rzc19GR",
      "danamonOnlineBillReferenceNumber": "166526",
      
      // LinkAja
      "linkajaResultCode": "0",
      "linkajaReceiptNumber": "D5AF930801",
      "linkajaReferenceId": "test-order-1706005255",
      "linkajaOriginatorConversationId": "6310bd69-ddea-4550-a746-a6afce00a7ef",
      "linkajaConversationId": "01HMTXCNTGZNPHRZ6X4804VFAY",
      
      // DBS PayLah!
      "dbsPaylahReferenceId": "17086717018447aab035",
      "dbsPaylahMessageId": "a4-9c7c-05a98c507aab",
        
      // PayPal
      "paypalTransactionId": "qee0evgt",
      
      "refunds": [
        {
          "id": "12345",
          "amount": {
            "value": "5000.00",
            "currency": "IDR"
          },
          "reason": "need to refund",
          "createdTime": "2019-07-03T12:08:56+07:00",
          "bankConfirmedTime": "2019-07-03T12:08:56+07:00",
          "cancelledTime": "2019-07-03T12:08:56+07:00"
        }
      ],
      "customer": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "phone": "+62812131415"
      },
      "shippingAddress": {
        "firstName": "John",
        "lastName": "Doe",
        "phone": "+62812131415",
        "postalCode": "123456",
        "countryCode": "21",
        "city": "Jakarta",
        "address": "Pasaraya Blok M"
      },
      "items": [
        {
          "id": "2a17f5a2-4150-31db-9880-b10dd503c93d",
          "partnerId": "item001",
          "name": "Test item",
          "quantity": "1",
          "price": {
            "value": "10000.00",
            "currency": "IDR"
          }
        }
      ],
      "promo": {
        "id": "promo1",
        "code": "TESTPROMO",
        "name": "Promo buy 1 get 2",
        "sponsor": "Midtrans",
        "originalAmount": {
          "value": "25000.00",
          "currency": "IDR"
        },
        "discountAmount": {
          "value": "5000.00",
          "currency": "IDR"
        },
        "userIp": "10.128.20.227"
      }
    },
    "withdrawal": {
      "bankName": "PT. BANK MANDIRI (PERSERO) TBK.",
      "bankCode": "mandiri",
      "accountNo": "1111222233333",
      "accountName": "Mandiri Simulator A",
      "requestedTime": "2019-07-03T12:08:56+07:00",
      "successTime": "2019-07-03T12:08:56+07:00",
      "failedTime": "2019-07-03T12:08:56+07:00",
      "cancelledTime": "2019-07-03T12:08:56+07:00"
    },
    "disbursement": {
      "sourceBankCode": "bca",
      "sourceAccountNo": "4433221100",
      "beneficiaryEmail": "[email protected]",
      "beneficiaryName": "BCA Simulator A",
      "beneficiaryBankCode": "bca",
      "beneficiaryBankName": "PT. BANK CENTRAL ASIA TBK.",
      "beneficiaryAccountNo": "0011223344",
      "creatorEmail": "[email protected]",
      "creatorName": "MLA creator",
      "approverEmail": "[email protected]",
      "approverName": "MLA approver",
      "requestedTime": "2019-07-03T12:08:56+07:00",
      "approvedTime": "2019-07-03T12:08:56+07:00",
      "rejectedTime": "2019-07-03T12:08:56+07:00",
      "processedTime": "2019-07-03T12:08:56+07:00",
      "completedTime": "2019-07-03T12:08:56+07:00",
      "failedTime": "2019-07-03T12:08:56+07:00",
      "failureMessage": "invalid destination account number",
      "failureCode": "002"
    }
  }
}

{
  "responseCode": "4011200", 
  "responseMessage": "Unauthorized. Client"
}

List of Response Codes

Response CodeHTTP StatusDescription
2001300200Successful
4001301400Invalid field format {........}
4001302400Missing mandatory field {........}
4011300401Unauthorized signature
4011301401Access token invalid
4041301404Transaction not found
4031318403Inactive account
4091300409Cannot use same X-EXTERNAL-ID in same day
5001301500Unknown internal server failure, please retry the process again