Skip to main content
POST
banking.connection.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your identifier for the person; when supplied it must match the consent owner.

Required string length: 1 - 256
returnUrl
string
required

Page to return to. Accepts a public HTTPS URL, or http on localhost for a local install.

country
string
required

Two-letter bank country code.

Pattern: ^[A-Z]{2}$
scopes
enum<string>[]

Bank data sections to authorize.

Required array length: 1 - 7 elements

Requested bank data section.

Available options:
accounts,
balances,
transactions,
owners,
payment-risk,
fraud-screening,
credit-report

Optional acknowledgement of the requested consent.

institutionRef
string

The ref returned by banking.institutions.search.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

connectUrl
string
required

Short-lived connection link on our host; never the bank or provider address.

Pattern: ^https?:\/\/[^/?#\s]+\/connect\/link\/[A-Za-z0-9_-]+$
expiresAt
string<date-time>
required

When the link expires.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
ref
string

Reference to what this call created. Pass it as ref to banking.connection.status or finance.consent.get.