Ask for a request the bank sent to be cancelled (camt.055)

POST/payment-requests/{id}/cancel

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

operatorstringRequired

reasonstringOptional

reason_codestringRequired

Returns

200 OK

The Payment Request object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/payment-requests/{id}/cancel' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "operator": "string",
    "reason_code": "string"
  }'

Response200

{
  "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "amount": 10000,
  "cancellation_reason_code": "string",
  "cancellation_status": "string",
  "counterparty": {
    "account_number": "string",
    "account_type": "string",
    "name": "string",
    "routing_number": "string"
  },
  "created_at": "2026-09-17T14:30:00Z",
  "direction": "string",
  "document_number": "string",
  "expires_at": "2026-09-17T14:30:00Z",
  "id": "string",
  "msg_id": "string",
  "payment_id": "lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "rail": "string",
  "reason": "string",
  "reason_code": "string",
  "remittance": "string",
  "requested_execution_date": "2026-09-17",
  "status": "string",
  "uetr": "string",
  "updated_at": "2026-09-17T14:30:00Z"
}