Get a subscription intent
Retrieves a subscription intent by its id. Only subscription intents matching the live or test mode of the API key are visible. widget_token is always null outside creation.
v1 · Base URL https://api.fintoc.com/v1Authorizations
Path Parameters
The id of the subscription intent to retrieve.
Response
The subscription intent. widget_token is always null outside creation.
Represents the flow a payer goes through to authorize a subscription at their bank. A successful subscription intent produces a Subscription.
Unique identifier of the subscription intent.
"si_mceqLoFwfBVHi3q4"
Type of the object. Always subscription_intent.
Information shown to the payer in the widget. null when not provided on creation.
ISO 8601 timestamp, in UTC, of when the subscription intent was created.
"2023-03-08T15:24:11Z"
Email address of the payer. Fintoc sends the subscription receipt to this address when the subscription intent succeeds.
"payer@example.com"
Mode of the object. live objects use real institution data, test objects use fake data for integration testing.
test, live "live"
Error code describing why the subscription intent did not succeed. null unless status is failed or rejected.
null, login_invalid_credentials, login_credentials_locked, authorization_timeout, mfa_authorization_timeout, mfa_unavailable, bank_connection_error, bank_not_available, password_change_required, request_timeout, subscription_intent_expired, account_type_not_permitted, internal_error, user_left "login_invalid_credentials"
Identifier the payer's bank uses to display the subscription on the bank's portal. null when not provided on creation.
"ABC12345"
Status of the subscription intent. One of created (waiting for the payer to start the authorization), in_progress (the payer is authorizing the subscription at their bank), succeeded (the payer authorized the subscription), failed (the authorization failed or expired), or rejected (the payer's bank rejected the subscription).
created, in_progress, succeeded, failed, rejected "succeeded"
Subscription created when the subscription intent succeeds. null in every other status.
Token used to open the widget so the payer can authorize the subscription. Only returned when the subscription intent is created; null in every other response.
"si_mceqLoFwfBVHi3q4_sec_a8Mw9bnHzgVRCMTSDgrJpvkN"