A comprehensive list of the external payment resource's attributes and relationships
An external payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/external_payments endpoint.
Last updated
| Field | Type | Description |
|---|---|---|
type
string
external_payments
id
string
The external payment unique identifier
links.self
string
The external payment endpoint URL
attributes.payment_source_token
string
The payment source token, as generated by the external gateway SDK. Credit Card numbers are rejected.
attributes.options
object
External payment options.
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 external payment.
relationships.payment_gateway
object
The associated payment gateway, inherited by the order payment_method.
relationships.wallet
object
The payment source token stored into customer's wallet.
relationships.versions
array
The associated changes.
meta.mode
string
The resource environment (can be one of test or live)
