Skip to main content

Cancel Settlement

PUT 
/v1/settlements/:settlementId

Click on Send API Request after entering the required data, to see how to cancel a Settlement. You must include the status parameter set to CANCELLED.

Note: You can cancel a Settlement only if the payment type is CARD and the status is PENDING.

Request​

Path Parameters

    settlementId stringrequired

    This is the ID returned in the response of the Process Payment request.

Header Parameters

    Content-Type string

    Possible values: [application/json]

    Simulator string

    Possible values: [EXTERNAL, INTERNAL]

    Default value: EXTERNAL

Body

    status string

    Possible values: [CANCELLED]

    This is the status of the cancel request.

Responses​

OK

Response Headers

  • Content-Type

    string

Schema

    id string

    This is the ID returned in the response. This ID can be used for future associated requests, for example, to look up the Payment.

    txnTime date-time

    This is the date and time the transaction was processed.

    status string

    Possible values: [CANCELLED]

    This is the status of the cancel request.

Loading...