v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Payment Setups

Get a payment setup

Returns a single PaymentSetup by id for the merchant.

get/payment-setups/{paymentSetupId}

Path parameters

paymentSetupIdstring required

Response

idstring required

PaymentSetup id

statusstring required

Setup status: pending | requires_3ds | completed | failed | cancelled

currency'EUR' | 'GBP' | 'USD' required
subscriptionIdstring nullable

Subscription this setup is tied to (trial / waitlist)

errorCodestring
errorMessagestring
createdAtstring date-time required
updatedAtstring date-time required
completedAtstring date-time nullable
tokenIntentIdstring nullable
threeDsSessionIdstring nullable
customerIdstring required

Example response

{
  "id": "setup_pm_req_abc123",
  "status": "completed",
  "currency": "EUR",
  "subscriptionId": "sub_1234567890abcdef",
  "customerId": "cust_abc123"
}