Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

The payment capture object

A comprehensive list of the payment capture resource's attributes and relationships

A payment capture object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/2026-05/payment_captures endpoint.

Fields

Field
Type
Description

type

string

payment_captures

id

string

The payment capture unique identifier

links.self

string

The payment capture endpoint URL

attributes.status

string

The transaction status. One of 'pending' (default), 'requires_action', 'processing', 'succeeded', 'declined', 'failed', 'canceled', or 'expired'.

attributes.payment_type

string

The payment type inherited by the payment session. One of 'ADYEN', 'BRAINTREE', 'CHECKOUT_COM', 'EXTERNAL', 'GIFT_CARD', 'MANUAL', 'PAYPAL', or 'STRIPE'.

attributes._internal_version

string

Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal_versionable.

attributes.token

string

The token identifying the transaction, returned by the payment session interaction.

attributes.currency_code

string

The international 3-letter currency code as defined by the ISO 4217 standard.

attributes.amount_cents

integer

The payment transacion amount cents collected.

attributes.amount_float

float

The payment transaction amount, float.

attributes.formatted_amount

string

The payment transaction amount, formatted.

attributes.request_data

object

The data of the request sent to the payment gateway.

attributes.response_data

object

The payment gateway response data, specific to this transaction. Cannot be passed by sales channels.

attributes.options

object

Options to use for the transaction, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels.

attributes.requires_action_at

string

Time at which the transaction is marked as requires_action.

attributes.processing_at

string

Time at which the transaction has been processed.

attributes.succeeded_at

string

Time at which the transaction is marked as succeeded.

attributes.declined_at

string

Time at which the transaction is marked as declined.

attributes.failed_at

string

Time at which the transaction is marked as failed.

attributes.canceled_at

string

Time at which the transaction has been cancelled.

attributes.expired_at

string

Time at which the transaction has been expired.

attributes.created_at

string

Time at which the resource was created.

attributes.updated_at

string

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

attributes.refund_balance_cents

integer

The balance to be refunded, in cents.

attributes.refund_balance_float

float

The balance to be refunded, float.

attributes.formatted_refund_balance

string

The balance to be refunded, formatted.

relationships.payment_session

object

The associated payment session.

relationships.order

object

The associated order.

relationships.payment_setting

object

The associated payment setting.

relationships.attachments

array

The associated attachments.

relationships.events

array

The associated events.

relationships.event_stores

array

The associated event stores.

relationships.payment_authorization

object

The associated payment authorization.

relationships.payment_refunds

array

The associated refunds.

Last updated