Skip to main content
GET
Get payment by ID

Authorizations

x-api-key
string
header
required

API key for service-to-service or merchant authentication.

Headers

x-correlation-id
string<uuid>

Unique identifier for request tracing. Generated by the client or server if not provided.

Example:

"550e8400-e29b-41d4-a716-446655440000"

x-business-account-id
string<uuid>

The business account to act on, for platform use cases. When sent, that account is the merchant for the request: resources are created under it, reads and 404 checks are scoped to it, and per-merchant uniqueness (such as merchant_reference_id) applies within it. The API key's own account is recorded as the account acting on its behalf. Omit it to act on the API key's own account.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

payment_id
string<uuid>
required

Unique identifier of the payment

Example:

"9822ffb8-26de-423b-ad15-0d129cf1b4ac"

Query Parameters

include
enum<string>[]

Comma-separated list of related resources to include

Available options:
instrument,
operations

Response

Payment details.

payment
object
required
next_action
object

Next action for the client (present only when action is required)

Available action links (HATEOAS)