Create Refund

Request a refund of your payment session

Method and URL

POST [BASE_URL]/v1/refunds

Request

Request Body

{
    "clientReferenceId": "1755665477",
    "paymentSessionId": "44a14481-fa75-49a5-b17f-d03d8c5d52a6",
    "isFullAmount": false,
    "amount": { // required if `isFullAmount` = false
        "value": "10000",
        "currency": "IDR"
    },
    "reason": "REQUESTED_BY_CUSTOMER",
    "description": "Customer didn't receive the Product",
    "method": "AUTO",
    "transferDestination": { // required if `method` = TRANSFER_ONLY
        "channelCode": "BCA",
        "channelInformation": {
            "accountNumber": "17677665415",
            "accountName": "Reforza Jordan Geotama"
        },
        "description": "Refund Pivot"
    },
    "metadata": {
        "notes": "Customer called support"
    }
}

Detail Parameter Request

Parameter

Data Type

Character Limit

Requirement

Description

Refund

Object

Refund Object

Response

Response Body

{
    "code": "00",
    "message": "Success",
    "data": {
        "id": "01990e74-5bc9-79a5-a651-400af0ad13ef",
        "clientReferenceId": "1755665477",
        "paymentSessionId": "44a14481-fa75-49a5-b17f-d03d8c5d52a6",
        "chargeId": "110eb890-d238-4212-aedc-533a8c77a53e",
        "capturedAmount": {
            "currency": "IDR",
            "value": "10000.00"
        },
        "isFullAmount": true,
        "amount": {
            "currency": "IDR",
            "value": "10000.00"
        },
        "status": "PENDING",
        "reason": "REQUESTED_BY_CUSTOMER",
        "description": "Customer didn't receive the Product",
        "method": "AUTO",
        "transferDestination": {
            "channelCode": "BCA",
            "channelInformation": {
                "accountNumber": "17677665415",
                "accountName": "Reforza Jordan Geotama"
            },
            "description": "Refund Pivot"
        },
        "metadata": {
            "notes": "Customer called support"
        },
        "createdAt": "2025-09-03T07:22:10.761667115Z",
        "updatedAt": "2025-09-03T07:22:10.761667203Z"
    }
}

Detail Parameter Response