v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Customer

Get a single setup payment method request by ID

Retrieves the details of a specific setup payment method request. Use this endpoint to poll the current status of a setup request after it has been created. The status transitions from pending → requires_3ds (if 3DS is needed) → completed or failed. When status is completed, the paymentMethodId field contains the ID of the newly saved payment method.

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

Path parameters

customerEmailstring required

Example:customer@example.com

Email address of the customer

setupRequestIdstring required

Example:setup_pm_req_abc123

Unique identifier of the setup payment method request (e.g. setup_pm_req_abc123)

Response

Setup payment method request details.

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"
}