Skip to main content
GET
Retrieve a card-on-file enrollment status

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Path Parameters

id
string
required

Id of the enrollment payment returned by POST /subscription-intents.

Response

paymentId
string
required

Id of the underlying enrollment payment, as returned by POST /subscription-intents.

status
enum<string>
required

"pending" while the enrollment link has been issued but nothing came back yet, "action_required" once the payer has been redirected to the card issuer's page, "successful" once the subscription has actually been recorded, and "failed" when the enrollment was refused or could not be recorded. A payer who never completes the page stays "action_required" — it is never reported as "failed".

Available options:
successful,
failed,
pending,
action_required
createdAt
string<date-time>
required

When the enrollment link was issued.

updatedAt
string<date-time>
required

When the enrollment last changed state.

failureCause
object

Present when status is "failed". Same shape and same codes as a regular payment's failureCause.

subscriptionId
number

Present once status is "successful": the subscription id to use with /subscriptions endpoints (charge, cancel, suspend, transactions).