Create a subscription intent
Creates a subscription intent in the live or test mode of the API key used. The response includes the widget_token used to open the widget so the payer can authorize the subscription.
v1 · Base URL https://api.fintoc.com/v1Authorizations
Body
Information shown to the payer in the widget.
Email address of the payer. Fintoc sends the subscription receipt to this address when the subscription intent succeeds.
"payer@example.com"
Identifier the payer's bank uses to display the subscription on the bank's portal. Up to 15 characters, uppercase letters and numbers only, and not already in use by another subscription intent that has not failed. When omitted, reference_id is null on the subscription intent and defaults to the account holder's ID on the resulting Subscription.
"ABC12345"
Response
The created subscription intent. widget_token is only returned in this response.
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"