Settlements Status By Payment ID API

The following endpoint retrieves the settlement status based on Payment ID for a particular merchant


Query parameters

Following are the parameters to be sent in the request body:

Fieldis required?Description
payment_idmandatorystring Unique identifier of the payment ID


curl --location --request GET '' \
--header 'Authorization: <SECRET KEY>'

Response Code : 200

Here is an example of success response

  "data": {
    "settlement_id": "set_WDizQUoyWy8680",
    "payment_id": "pay_O7laHvW2BI5527",
    "payment_reference": "",
    "order_id": "ord_KlQRqodMqq0540",
    "order_reference": "order_ref_001",
    "status": "settled",
    "currency": "IDR",
    "settlement_amount": "19635.00",
    "total_settlement_fee": "365.00",
    "payment_discount": "",
    "settled_at": "2021-05-17T08:32:00.628182Z",
    "group": "A",
    "payment_amount": "20000.00",
    "payment_date": "2021-05-17T08:26:43.990125Z",
    "transaction_amount": "20000.00",
    "payment_channel": "ewallet_details",
    "payment_subchannel": "SHOPEEPAY"

Error Response Code : 401

Here is an example error response for unauthorized access

    "error": "invalid Authorization header in request",
    "error_code": "DPAY_UNAUTHORIZED_ACCESS"

Error Response Code : 404

Here is an example error response for resource not found

    "error": "settlement does not exists"
    "error_code": "DPAY_SETTLEMENT_NOT_FOUND"