A Payment Session object represents the entire process of an Ansa transaction, from the moment checkout begins to completing a payment. This can include the process of the customer adding funds to their balance or completing a payment from their balance.
Payment Session Lifecycle Tip
We recommend maintaining exactly one
PaymentSessionper order or customer session in your system.
Payment Session Attributes
| Field | Type | Description | Example value |
|---|---|---|---|
id | string | Unique identifier for the payment session. | 9f656bb4-7e9e-450f-8cf6-647cf029454d |
clientSecret | string | The client secret of this payment session. The client secret should be used to complete a payment and other sensitive operations from the frontend. It should not be stored, logged, or exposed to anyone except for the customer. You should have TLS enabled on any page that includes the client secret. | ansa_cs_sandbox_+v1234512345 |
customerId | string | The ID of the Customer this payment session belongs to. | |
created | timestamp | The timestamp (in RFC 3339 format) when the payment session and its associated client secret were created. | 2022-12-08T23:47:41.643Z |
validUntil | timestamp | The timestamp (in RFC 3339 format) when the payment session and its associated client secret will expire. This is typically 24 hours after created. | 2022-12-09T23:47:41.643Z |