Cancel an existing payment request

Developing

Cloud Mock

https://mock.apidog.com/m1/828215-0-default

DELETE

/payments/{payment_id}

OperationId:cancel_payment_request_by_id

This will attempt to cancel a previously requested payment. The operation will fail if the payment is already in the process of being deducted by the payroll.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://{domain}.auth.{region}.amazoncognito.com

Scopes:

payments:write-Create and cancel payment requests.

Path Params

Query Params

Responses

🟢200Success

application/json

Body

🟠409Conflict

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://mock.apidog.com/m1/828215-0-default/payments/ce8c38b9-8fc0-4c34-a0a0-1ec929271b58?allow_partial_collection=' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "detail": "PartiallyCancelled",
    "payment_record": {
        "id": "fcc86f74-0110-466c-9d8b-1fb6c8acd206",
        "mandate_id": "f36d6a27-de00-41ce-ad89-7d835f2d441a",
        "due_date": "2026-05-04",
        "requested_amount": 4136,
        "currency": "GBP",
        "status": "Cancelled",
        "actual_amount": 46819,
        "metadata": null,
        "expected_payments": [
            {
                "expected_pay_date": "2027-03-02",
                "amount": 4136,
                "supply_method": "Payroll",
                "status": "Cancelled"
            }
        ]
    }
}

Instruct a new payment request

Get a Payment