API Doc

# Finish Notify

# Specification

  • The following table is a specification of this API:
Name Description
API Name finishNotify
Function This API is used to notify payment status and information from PayCools to merchant’s platform
Service Code 52
Method POST
URL /v2.1/qr/qr-mpm-notify
Accept application/json
Content Type application/json
Related Service
Expected Timeout 8 second

# 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 a header of request parameter:
No Name Type Length Required Condition Remarks
1 Content-Type String Variable, 127 max Mandatory - Content type, value always application/json
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 - For verify the signature, please refer to: Digital Signature Validation

# Body

  • The following table is a body of request parameter:
No Name Type Length Required Condition Remarks
1 originalReferenceNo String Variable, 64 max Optional - Transaction identifier on PayCools system
2 originalPartnerReferenceNo String Variable, 64 max Optional - Transaction identifier on partner system
3 aggregateCodAmount MONEY Variable Conditional Y:= Successfully processed Aggregate Cod Amount
4 aggregateCodFeeAmount MONEY Variable Conditional Y:= Successfully processed Aggregate Cod Fee Amount
5 aggregateFrtAmount MONEY Variable Conditional Y:= Successfully processed Aggregate Freight Amount
6 aggregateFrtFeeAmount MONEY Variable Conditional Y:= Successfully processed Aggregate Freight Fee Amount
7 totalAggregateAmount MONEY Variable Conditional Y:= Successfully processed Total Aggregate Amount
8 totalAggregateFeeAmount MONEY Variable Conditional Y:= Successfully processed Total Aggregate Fee Amount
9 latestTransactionStatus String Fixed, 2 max Conditional Y:= Transaction exists Transaction status code
Successfully = 00
10 additionalInfo NotifyAdditionalInfo Variable Mandatory - Additional information

# REQUEST SAMPLE

POST /v2.0/qr/qr-mpm-notify HTTP/1.1
X-Timestamp: 2023-04-11T21:14:56+07:00
X-Signature: Dupbr1ILxsfBrXFmeDdIjwCmgv6AF+JQeIpD1Gq8HDjow7avCXdZAPOEbxVe7/x0atxy86aUfC11zXA1gvXXwxrTXFr6V0x8GZCyTndqnDyRlBeEZLL3BLmDRkrSsomd/mv1eG/th4TQndSPrBBfbN3bj0yIB99y2BnU5fBy7B0ZhYiQVs3uREspIsBB99F/4Zv8GbPWvik2usdOUo0gfPAQoZ3MJAcBQ/0vMRT5KdLm903C2HNyl1Cpb6OFRgaU2LAWybEQIC2QJ9mFb08NPR0PEu75WpVHNrFYn8gfiI8nRso0vBJhtMZrRINDQf9scV53cFdjpWobQHvnFDHCqQ==
Content-Type: application/json

{
    "additionalInfo": {
        "channelCode": "QRIS_DYNAMIC_QR",
        "createTime": "2023-10-08T17:34:55+07:00",
        "eventName": "qrcode.payment.success",
        "returnTime": "2023-10-08T18:58:39+07:00",
    },
    "aggregateCodAmount": {
        "value": "30000.00",
        "currency": "IDR"
    },
    "aggregateCodFeeAmount": {
        "value": "2000.00",
        "currency": "IDR"
    },
    "aggregateFrtAmount": {
        "value": "30000.00",
        "currency": "IDR"
    },
    "aggregateFrtFeeAmount": {
        "value": "2000.00",
        "currency": "IDR"
    },
    "totalAggregateAmount": {
        "value": "60000.00",
        "currency": "IDR"
    },
    "totalAggregateFeeAmount": {
        "value": "4000.00",
        "currency": "IDR"
    }
    "latestTransactionStatus": "00",
    "originalPartnerReferenceNo": "test402787228481568",
    "originalReferenceNo": "C1711314284761452544"
}

# 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:

# Header

  • The following table is a header of response parameter:
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)

# 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

Content-Type: application/json
X-TIMESTAMP: 2023-04-11T21:10:11+07:00
{
    "responseCode": "2005200",
    "responseMessage": "Successful",
}

# Response Code and Message

  • The following table is the list response code and message of Balance Inquiry API:
No Response Code Response Message Remarks Partner Action Related Service
1 2005200 Successful Success to be processed Successful QRIS MPM (Acquirer) - SNAP
2 5005201 Internal Server Error Unknown internal server failure, please retry the process again Mark Finish Notify process as Pending. Retry periodically within 7 days QRIS MPM (Acquirer) - SNAP

← Data Model - MPM Payment →