Cancel Authorization

Cancel Authorization

PATCH https://api.stage.localpayment.com/api/payin/capture/:externalId/status

Cancel a credit card authorization

Path Parameters

Name	Type	Description
externalId*	string	Mandatory. The ID which was given while creating the authorization. Each ID must b unique and meaningful to you and your system.

Headers

Name	Type	Description
Authorization*	string	Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

200: OK Authorization was cancelled

{
    "externalId": "1648840917",
    "internalId": "39eb0371-3f21-488f-a779-913799e51406",
    "status": {
        "code": "905",
        "description": "CANCELLED",
        "detail": "The authorization was cancelled"
    }
}

400: Bad Request Error. An authorization can only be cancelled once

{
    "status": {
        "code": "400",
        "description": "ERROR",
        "detail": "Invalid operation"
    }
}

400: Bad Request Error: The externail ID could be incorrect

{
    "status": {
        "code": "404",
        "description": "ERROR",
        "detail": "Payin not found"
    }
}

Examples: Cancel Authorization

cURL: Example Request

curl --location --request PATCH 'https://api.stage.localpayment.com/api/payin/capture/1648848122/status/' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ4ODQ4NDE3LCJqdGkiOiJlOGVmZjIzMzlkOTI0MTNmOTFkNzlhM2UxZjMzNzQwMyIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.Pe9WjZYlHUZEzh-LQjT5PBKv6N9gXhpsKHHJtnZS_no' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "CANCELLED"
}'

JSON Example Request

{
    "status": "CANCELLED"
}

Example Response

{
    "externalId": "1648848122",
    "internalId": "1bb34022-5f3b-423e-a67c-5df58ff3d1e3",
    "status": {
        "code": "905",
        "description": "CANCELLED",
        "detail": "The authorization was cancelled"
    }
}