The stripe payment object

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

A stripe payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/stripe_payments endpoint.

Fields

Field	Type	Description
type	string	stripe_payments
id	string	The stripe payment unique identifier
links.self	string	The stripe payment endpoint URL
attributes.stripe_id	string	The Stripe payment intent ID. Required to identify a payment session on stripe.
attributes.client_secret	string	The Stripe payment intent client secret. Required to create a charge through Stripe.js.
attributes.charge_id	string	The Stripe charge ID. Identifies money movement upon the payment intent confirmation.
attributes.publishable_key	string	The Stripe publishable API key.
attributes.options	object	Stripe payment options: 'customer', 'payment_method', 'return_url', etc. Check Stripe payment intent API for more details.
attributes.payment_method	object	Stripe 'payment_method', set by webhook.
attributes.mismatched_amounts	boolean	Indicates if the order current amount differs form the one of the created payment intent.
attributes.return_url	string	The URL to return to when a redirect payment is completed.
attributes.receipt_email	string	The email address to send the receipt to.
attributes._update	boolean	Send this attribute if you want to update the created payment intent with fresh order data.
attributes._refresh	boolean	Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.
attributes.payment_instrument	object	Information about the payment instrument used in the transaction.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	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.
relationships.order	object	The order associated to the Stripe payment, that is set as its payment source.
relationships.payment_gateway	object	The associated payment gateway, inherited by the order payment_method.
relationships.versions	array	The associated changes.
meta.mode	string	The resource environment (can be one of test or live)