Skip to main content
POST
Cancel a payment

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id
string

Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Idempotency-Key
string

Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012.

Path Parameters

id
string<uuid>
required

Payment identifier (UUID).

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
reason
string
required

Response

Bad Request

code
string

Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN).

Example:

"ERR-0001"

detail
string

A human-readable explanation specific to this occurrence of the problem.

Example:

"Property foo is required but is missing."

errors
object[] | null

Optional list of individual error details

instance
string<uri>

A URI reference that identifies the specific occurrence of the problem.

Example:

"https://example.com/error-log/abc123"

status
integer<int64>

HTTP status code

Example:

400

title
string

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

Example:

"Bad Request"

type
string<uri>
default:about:blank

A URI reference to human-readable documentation for the error.

Example:

"https://example.com/errors/example"

upstream
object

RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.