Skip to main content
PATCH
/
one-time-payment
/
{id}
/
cancel
Cancel a one-time payment
curl --request PATCH \
  --url https://demo.api.harmony.compago.com/api/one-time-payment/{id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "status": "CANCELLED",
  "description": "<string>",
  "amount": 123,
  "currency": "<string>",
  "externalId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

The unique identifier of the one-time payment to cancel

Response

Payment successfully cancelled

The cancelled one-time payment object

​
id
string<uuid>
required
Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

​
status
enum<string>
required
Available options:
CANCELLED
​
description
string
​
amount
number<decimal>
​
currency
string
​
externalId
string
​
expiresAt
string<date-time>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>