The satispay payment object
A comprehensive list of the satispay payment resource's attributes and relationships
A satispay payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the
/api/satispay_payments
endpoint.Field | Type | Description |
---|---|---|
type | string | satispay_payments |
id | string | The satispay payment unique identifier |
links.self | string | The satispay payment endpoint URL |
attributes.payment_id | string | The payment unique identifier. |
attributes.flow | string | The Satispay payment flow, inspect gateway API details for more information. |
attributes.status | string | The Satispay payment status. |
attributes.redirect_url | string | The url to redirect the customer after the payment flow is completed. |
attributes.payment_url | string | Redirect url to the payment page. |
attributes.intent_amount_cents | integer | The amount of the associated payment intent, in cents. |
attributes.intent_amount_float | float | The amount of the associated payment intent, float. |
attributes.formatted_intent_amount | string | The amount of the associated payment intent, formatted. |
attributes.payment_response | object | The Satispay payment response, used to fetch internal data. |
attributes._refresh | boolean | Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic. |
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 Satispay 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 ) |
Last modified 29d ago