Skip to main content
GET
Get a subscription intent
v1 · Base URL https://api.fintoc.com/v1

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

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.

id
string
required

Unique identifier of the subscription intent.

Example:

"si_mceqLoFwfBVHi3q4"

object
any
required

Type of the object. Always subscription_intent.

business_profile
null | object
required

Information shown to the payer in the widget. null when not provided on creation.

created_at
string<date-time>
required

ISO 8601 timestamp, in UTC, of when the subscription intent was created.

Example:

"2023-03-08T15:24:11Z"

customer_email
string | null
required

Email address of the payer. Fintoc sends the subscription receipt to this address when the subscription intent succeeds.

Example:

"payer@example.com"

mode
enum<string>
required

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

Available options:
test,
live
Example:

"live"

public_error
enum<string> | null
required

Error code describing why the subscription intent did not succeed. null unless status is failed or rejected.

Available options:
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
Example:

"login_invalid_credentials"

reference_id
string | null
required

Identifier the payer's bank uses to display the subscription on the bank's portal. null when not provided on creation.

Example:

"ABC12345"

status
enum<string>
required

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).

Available options:
created,
in_progress,
succeeded,
failed,
rejected
Example:

"succeeded"

subscription
null | object
required

Subscription created when the subscription intent succeeds. null in every other status.

widget_token
string | null
required

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.

Example:

"si_mceqLoFwfBVHi3q4_sec_a8Mw9bnHzgVRCMTSDgrJpvkN"