v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Customer

List all setup payment method requests for a customer

Returns every setup payment method request created for the given customer, sorted by most recent first. Each item includes the current status (pending, completed, failed, requires_3ds), the currency, timestamps, error details if the request failed, and the resulting paymentMethodId if the setup completed successfully.

get/api/customer/{customerEmail}/payment-methods/setup-requests

Path parameters

customerEmailstring required

Example:customer@example.com

Email address of the customer

Response

List of setup payment method requests for the customer, sorted by most recent first.

idstring required

Unique ID of the setup request.

statusstring required

Current status of the setup request (pending, completed, failed, requires_3ds).

currencystring required

Currency of the setup request (EUR or USD).

createdAtstring date-time required

When the request was created.

updatedAtstring date-time required

When the request was last updated.

completedAtstring date-time nullable required

When the request completed (success or failure), or null.

errorCodestring nullable required

Error code if the request failed, or null.

errorMessagestring nullable required

Error message if the request failed, or null.

paymentMethodIdstring nullable required

ID of the payment method created by this request, or null if not yet completed.

Example response

[
  {
    "id": "setup_pm_req_abc123",
    "status": "completed",
    "currency": "EUR",
    "paymentMethodId": "cpm_xyz789"
  }
]