Void a payment - Hellgate Cloud Platform

POST

payments

{payment_id}

void

Void a payment

curl --request POST \
  --url https://commerce1.on-hellgate.dev/payments/{payment_id}/void \
  --header 'X-API-Key: <api-key>'

{
  "classifier": "<string>",
  "code": 123,
  "message": "<string>"
}

X-API-Key

string

header

required

X-Account-ID

string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

X-Idempotency-Key

string

Idempotency key

payment_id

string

required

Payment ID

No content

⌘I

Void a payment

curl --request POST \
  --url https://commerce1.on-hellgate.dev/payments/{payment_id}/void \
  --header 'X-API-Key: <api-key>'

{
  "classifier": "<string>",
  "code": 123,
  "message": "<string>"
}