Get payment profile session
Retrieve details of a specific payment profile session by its identifier.
Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Path Parameters
The unique identifier of the payment profile session to retrieve.
Response
Payment profile session retrieved successfully
A payment profile session that wraps the process of setting up and saving a payment method for future use.
The unique identifier for this payment profile session.
"69321a62-f1fe-461f-8761-a19ae6587bb2"
The unique identifier of the order this payment profile session is associated with.
"44567801-a504-4f09-8089-31ea78bc239b"
Payment service provider that processes the transaction.
STRIPE, BILLOGRAM "STRIPE"
Current status of a payment profile session lifecycle.
PENDING, REQUIRES_ACTION, COMPLETED, FAILED, CANCELED "PENDING"
The hosted page to redirect the customer to in order to save their payment method.
"https://payments.example.com/setup/69321a62-f1fe-461f-8761-a19ae6587bb2"
Custom key-value pairs for additional payment profile session information.
{
"source": "mobile_app",
"campaign": "summer_2024"
}When this payment profile session was created.
"2024-09-29T10:00:00Z"
When this payment profile session was last updated.
"2024-09-29T10:30:00Z"