Skip to main content
POST
Connect

Authorizations

Authorization
string
header
required

Your live or test secret key, prefixed sk-. Send as Authorization: Bearer sk-....

Body

application/json

Getting initial connect with Flick

firstName
string
required
Example:

"user Name"

lastName
string
required
Example:

"user lastName"

email
string
required
Example:

"user email"

phoneNumber
string
required
Example:

"user phoneNumber"

purpose
enum<string>
required
Available options:
statement,
transaction,
balance,
identity
selectedPeriod
string
required

Statement = 1,3,6,9,12 months Transation = 1,3,7,14,30 days. balance/identity =''

Example:

"1, 3, 6, 9 & 12 months / 1, 3, 7, 14, & 30 days"

Response

Successful

status
string
Example:

"200"

message
string
Example:

"successful"

id
string
Example:

"1d48c8f-0d29-4340-a"

url
string
Example:

"https://link.paywithflick.co/pages/cBYpdJ"