Cancellation API

The Cancellation API allows you to cancel a transaction previously generated by theAuthorization API.

With the DELETE method of the orchestrator, transactions can be cancelled or terminated according to their current state.

Transactions with status REGISTRADO or PENDIENTE, will be updated to status CANCELADO.
Transactions with status AUTORIZADO, will be updated to status EXTORNADO.

REQUEST

Path

Method: DELETE

URL: {{base}}/charges/{{merchant_code}}/{{merchant_operation_number}}

Field	Description	Accepted Value	Type
`merchant_code`	Merchant ID	Alfanumeric	`String`
`merchant_operation_number`	Merchant operation number	Alfanumeric	`String`

Headers

For all payment methods, the following parameters will be sent in the request header:

Field	Description	Accepted Value	Type
`Authorization`	Identification token for API usage previously created in Oauth API	Alfanumeric	`String`

RESPONSE

Field	Description	Accepted Value	Type	Madatory
`success`	Indicates whether the process was successful	Alfanumeric: true false	`String`	YES
`merchant_code`	Merchant ID	Alfanumeric	`String`	YES
`merchant_operation_number`	Order number of the operation that was cancelled or extended	Numeric greater than or equal to 6 digits	`String`	YES
`meta`	Object containing metadata of the executed flow		`Object`	YES
`meta.status`	Object containing the result of the executed flow		`Object`	YES
`meta.status.code`	Code representing the result of the executed flow	Numeric	`String`	YES
`meta.status.message_ilgn`	Object that contains the message resulting from the flow.		`Object`	YES
`meta.status.message_ilgn.[].locale`	Language-level locale for the message of the executed stream	Alfanumeric	`String`	YES
`meta.status.message_ilgn.[].value`	Message resulting from the executed flow	Alfanumeric	`String`	YES

Example

JSON

{
    "success": true,
    "merchant_code":"b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "merchant_operation_number":"",
    "meta": {
        "status": {
            "code": "00",
            "message_ilgn": [
                {
                    "locale": "es_PE",
                    "value": "Se proceso correctamente"
                }
            ]
        }
    }
}