Integr>te™ API - v3.34.0

Intergiro Indirect API

Headers

NameTypeRequiredDescription
Content-Typehttp_content_type_jsontrue

application/json HTTP content type

Authentication

Request body

API key login form

NameTypeRequiredDescription
api_keystringtrue

API key

Response body

Successful login

NameTypeRequiredDescription
access_tokenstringtrue

The access token

refresh_tokenstringtrue

The refresh token to use for consequent session renewals

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request body

Refresh access token form

NameTypeRequiredDescription
refresh_tokenstringtrue

Refresh token

Response body

Successful login

NameTypeRequiredDescription
access_tokenstringtrue

The access token

refresh_tokenstringtrue

The refresh token to use for consequent session renewals

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual user management

Request body

Individual user creation form

NameTypeRequiredDescription
first_namestringtrue

First name

last_namestringtrue

Last name

date_of_birthdate-iso8601true

Date of birth (ISO 8601 'YYYY-MM-DD')

phone_numberstringtrue

Phone number

emailemailtrue

Email address

addressobjectfalse

Address info

address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

address.street1stringtrue

Street line 1

address.street2stringfalse

Street line 2

address.citystringtrue

City

address.regionstringfalse

Region

address.postal_codestringtrue

Postal code

Response body

Individual user details

NameTypeRequiredDescription
idstringtrue

Individual ID

first_namestringtrue

First name

last_namestringtrue

Last name

date_of_birthdate-iso8601true

Date of birth (ISO 8601 'YYYY-MM-DD')

phone_numberstringtrue

Phone number

emailemailtrue

Email address

statusstringtrue

Status. Possible values: pending_activation, onboarding_requested, onboarding_data_provided, activated, blocked

addressobjectfalse

Address info

address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

address.street1stringtrue

Street line 1

address.street2stringfalse

Street line 2

address.citystringtrue

City

address.regionstringfalse

Region

address.postal_codestringtrue

Postal code

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
limitintegerQueryfalse

A limit on the number of objects to be returned. Default 10. Can be 1 to 100.

sort_typestringQueryfalse

Sort type. Default DESC.. Possible values: ASC, DESC

starting_afterstringQueryfalse

Pagination cursor. starting_after is the ID of the object to begin your list with and would return objects in the order they were created after this object. For example, if you grab list of objects, ending with obj you can include starting_after=obj.id in your call to fetch next page of the list.

ending_beforestringQueryfalse

Pagination cursor. ending_before is an object ID you’d specify to return objects created before this object. For example, if you grab list of objects, starting with obj you can include ending_before=obj.id in your call to fetch previous page of the list.

Response body

Individuals list

NameTypeRequiredDescription
dataarraytrue

Individual users

data.idstringtrue

Individual ID

data.first_namestringtrue

First name

data.last_namestringtrue

Last name

data.emailemailtrue

Email address

data.phone_numberstringtrue

Phone number

data.statusstringtrue

Status. Possible values: pending_activation, onboarding_requested, onboarding_data_provided, activated, blocked

has_morebooleantrue

A flag that shows whether there are more items to return

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Individual ID

Response body

Individual details

NameTypeRequiredDescription
idstringtrue

Individual ID

first_namestringtrue

First name

last_namestringtrue

Last name

date_of_birthdate-iso8601true

Date of birth (ISO 8601 'YYYY-MM-DD')

phone_numberstringtrue

Phone number

emailemailtrue

Email address

statusstringtrue

Status. Possible values: pending_activation, onboarding_requested, onboarding_data_provided, activated, blocked

addressobjectfalse

Address info

address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

address.street1stringtrue

Street line 1

address.street2stringfalse

Street line 2

address.citystringtrue

City

address.regionstringfalse

Region

address.postal_codestringtrue

Postal code

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual not found

Initiates individual onboarding.

Consider using SFSafariViewController on iOS and Chrome Custom Tabs on Android in-app or standalone browser experience to take advantage of a more streamlined process using native Biometry support on mobile.

Once initiated, wait for IndividualOnboardingDataProvided webhook event as soon as the user successfully completes the form. That will mean the ball is on Intergiro side as we'll be receiving the data for approval.

There may be cases when the user drops off without completing the form or doing something similar. For this reason it is recommended that you periodically poll individuals who have stuck in onboarding_requested status for too long, by calling POST /individual/:id/onboard once again to send the user to the onboarding form

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Individual ID

Request body

Individual user start onboarding flow form

NameTypeRequiredDescription
return_urlstringfalse

The URL to redirect customer back to after they finish onboarding

Response body

Onboarding link and expiration time

NameTypeRequiredDescription
redirect_urlstringtrue

The URL you must use to redirect the customer to in order to proceed with onboarding

expires_atstringtrue

URL expiration time

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual not found

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Onboarding & KYC

Request body

KYC questionnaire form

NameTypeRequiredDescription
individual_idstringtrue

Corresponding Individual ID

purpose_of_accountstringtrue

Purpose of applying for bank account. Possible values: Salary / Temporary income, Sending money to family / friends, Trading / Investments / Dividend, General Spending

anticipated_monthly_volumestringtrue

Anticipated monthly transfer volume. Possible values: EUR 0 - 2,500, EUR 2,501 - 5,000, EUR 5,001 - 10,000, more than EUR 10,000

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Not found

Request body

KYC ID verification form

NameTypeRequiredDescription
individual_idstringtrue

Individual ID associated with the document

reportuniontrue

ID verification report. Possible values: Kyc id verification report swedish bank id

Kyc id verification report swedish bank id

Swedish BankID verification report

NameTypeRequiredDescription
report.providerstringtrue

ID verification provider. Possible values: se_bank_id

report.signaturestringtrue

Full BankID signature payload

report.deviceobjecttrue

BankID device info

report.device.ip_addressstringtrue

Valid IP address. Example "46.216.153.150"

report.userobjecttrue

BankID user info

report.user.given_namestringtrue

First name

report.user.personal_numberstringtrue

Swedish personal number as 12-digits long numeric string. Example "197906083089"

report.user.namestringtrue

Full name

report.user.surnamestringtrue

Last name

report.ocsp_responsestringtrue

Full BankID OCSP response

report.certobjecttrue

BankID certificate information

report.cert.not_beforestringtrue

Valid unix timestamp in milliseconds as string. Example "1614553200000"

report.cert.not_afterstringtrue

Valid unix timestamp in milliseconds as string. Example "1614553200000"

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Not found

Request headers

NameTypeRequiredDescription
Content-Typehttp_content_type_form_datatrue

multipart/form-data HTTP content type

Request body

Upload KYC document form

NameTypeRequiredDescription
individual_idstringtrue

Individual ID associated with the document

typestringtrue

KYC document type. Possible values: passport, id, utility_bill, bank_statement, council_tax

filestringtrue

File binary contents

sidestringfalse

The side of the document scanned if applicable. Possible values: front, back

issuing_countrystringfalse

Issuing country if applicable

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Request headers

NameTypeRequiredDescription
Content-Typestringtrue

multipart/form-data HTTP content type

Request body

Upload KYC live photo

NameTypeRequiredDescription
individual_idstringtrue

Individual ID on the photo

challengeuniontrue

Challenges captured on a photo. Possible values: Kyc live photo challenge selfie

filestringtrue

Photo binary contents

Kyc live photo challenge selfie

KYC live photo challenge type via a selfie

NameTypeRequiredDescription
challenge.typestringtrue

Selfie. Possible values: selfie

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Request headers

NameTypeRequiredDescription
Content-Typestringtrue

multipart/form-data HTTP content type

Request body

Upload KYC live video

NameTypeRequiredDescription
individual_idstringtrue

Individual ID on the video

challengeuniontrue

Challenges captured on a video. Possible values: Kyc live video challenge movement, Kyc live video challenge recite

filestringtrue

Video binary contents

Kyc live video challenge movement

KYC live video challenge type via movement

NameTypeRequiredDescription
challenge.typestringtrue

Movement. Possible values: movement

challenge.querystringtrue

Movement task. Possible values: turn_right

Kyc live video challenge recite

KYC live video challenge type via reciting

NameTypeRequiredDescription
challenge.typestringtrue

Recite. Possible values: recite

challenge.query[integer]true

Sequence of numbers as array. Example [1, 2, 3]

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Explicit confirmation or approval

Request parameters

NameTypeLocationRequiredDescription
limitintegerQueryfalse

A limit on the number of objects to be returned. Default 10. Can be 1 to 100.

sort_typestringQueryfalse

Sort type. Default DESC. Possible values: ASC, DESC

starting_afterstringQueryfalse

Pagination cursor. starting_after is the ID of the object to begin your list with and would return objects in the order they were created after this object. For example, if you grab list of objects, ending with obj you can include starting_after=obj.id in your call to fetch next page of the list.

ending_beforestringQueryfalse

Pagination cursor. ending_before is an object ID you’d specify to return objects created before this object. For example, if you grab list of objects, starting with obj you can include ending_before=obj.id in your call to fetch previous page of the list.

individual_idstringQueryfalse

Individual ID

Response body

List of approvals

NameTypeRequiredDescription
dataarraytrue

Consent details

data.idstringtrue

Consent ID

data.individual_idstringtrue

Individual ID

data.statusstringtrue

Consent status

data.expires_atuniontrue

Consent expiration time. Possible values: date-time-iso8601, null. If expires_at: null - consent will not expire.. Possible values:

data.scopestringtrue

List of consent scope. Possible values: view_balance, view_payment_history, confirm_transaction, view_card_credentials, activate_card, reset_card_pin, initialize_payment_method

has_morebooleantrue

A flag that shows whether there are more items to return

Unauthorized

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Consent ID

Request body

Request consent params

NameTypeRequiredDescription
return_urlstringfalse

URL for redirect after consent is completed. Max length - 255 chars

Response body

Requested consent method

NameTypeRequiredDescription
methodobjecttrue

Instructions on how to proceed with consent request

method.redirect_urlstringtrue

Consent URL

method.expires_atstringtrue

Consent URL expiration time

method.tokenstringfalse

Ephemeral token

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Events

Request parameters

NameTypeLocationRequiredDescription
limitintegerQueryfalse

A limit on the number of objects to be returned. Default 10. Can be 1 to 100.

sort_typestringQueryfalse

Sort type. Default DESC.. Possible values: ASC, DESC

starting_afterstringQueryfalse

Pagination cursor. starting_after is the ID of the object to begin your list with and would return objects in the order they were created after this object. For example, if you grab list of objects, ending with obj you can include starting_after=obj.id in your call to fetch next page of the list.

ending_beforestringQueryfalse

Pagination cursor. ending_before is an object ID you’d specify to return objects created before this object. For example, if you grab list of objects, starting with obj you can include ending_before=obj.id in your call to fetch previous page of the list.

Response body

Events list

NameTypeRequiredDescription
dataarraytrue

Events

data.idstringtrue

Event ID

data.namestringtrue

Name. Possible values: AuthorizationCompleted, AuthorizationDeclined, IndividualOnboardingDataProvided, IndividualActivated, IndividualBlocked, TransactionCreated, TransactionStatusChanged

data.payloaduniontrue

Payload. Possible values: Authorization completed event payload, Authorization failed event payload, Individual status updated event payload, Transaction event payload

data.created_atdate-time-iso8601true

Creation date time

has_morebooleantrue

A flag that shows whether there are more items to return

Authorization completed event payload

Transaction authorization completed event payload

NameTypeRequiredDescription
data.payload.authorization_idstringtrue

Authorization ID

data.payload.transaction_idstringtrue

Successful transaction ID created within authorization process

Authorization failed event payload

Transaction authorization failed event payload

NameTypeRequiredDescription
data.payload.authorization_idstringtrue

Authorization ID

data.payload.transaction_idstringtrue

Failed transaction ID created within authorization process

Individual status updated event payload

Individual status updated event payload. Applicable for: IndividualActivated, IndividualBlocked, IndividualOnboardingDataProvided events

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

Transaction event payload

Individual transaction event payload. Applicable for: TransactionCreated, TransactionStatusChanged events

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

data.payload.transaction_idstringtrue

Transaction ID

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Event ID

Response body

Event details

NameTypeRequiredDescription
idstringtrue

Event ID

namestringtrue

Name. Possible values: AuthorizationCompleted, AuthorizationDeclined, IndividualOnboardingDataProvided, IndividualActivated, IndividualBlocked, TransactionCreated, TransactionStatusChanged

payloaduniontrue

Payload. Possible values: Authorization completed event payload, Authorization failed event payload, Individual status updated event payload, Transaction event payload

created_atdate-time-iso8601true

Creation date time

Authorization completed event payload

Transaction authorization completed event payload

NameTypeRequiredDescription
payload.authorization_idstringtrue

Authorization ID

payload.transaction_idstringtrue

Successful transaction ID created within authorization process

Authorization failed event payload

Transaction authorization failed event payload

NameTypeRequiredDescription
payload.authorization_idstringtrue

Authorization ID

payload.transaction_idstringtrue

Failed transaction ID created within authorization process

Individual status updated event payload

Individual status updated event payload. Applicable for: IndividualActivated, IndividualBlocked, IndividualOnboardingDataProvided events

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

Transaction event payload

Individual transaction event payload. Applicable for: TransactionCreated, TransactionStatusChanged events

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

payload.transaction_idstringtrue

Transaction ID

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Event not found

Webhook payload contains data about related event. You can use ID from the payload to fetch full data of corresponding event.

Response body

Webhooks list

NameTypeRequiredDescription
idstringtrue

Webhook ID

urlstringtrue

Webhook URL

created_atdate-time-iso8601true

Creation timestamp

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request body

Create webhook

NameTypeRequiredDescription
urlstringtrue

Webhook URL. Must have HTTPS protocol and hostname for host part.

Response body

Webhook details

NameTypeRequiredDescription
idstringtrue

Webhook ID

urlstringtrue

Webhook URL

created_atdate-time-iso8601true

Creation timestamp

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Webhook ID

Response body

Webhook is deleted

Unauthorized

Forbidden

Webhook not found

Bank accounts

Accessing the balance of one or more designated payment accounts for the first time requires Strong Customer Authentication

Request parameters

NameTypeLocationRequiredDescription
request_idstringQueryfalse

Filter transactions by request ID

limitintegerQueryfalse

A limit on the number of objects to be returned. Default 10. Can be 1 to 100.

sort_typestringQueryfalse

Sort type. Possible values: ASC, DESC

starting_afterstringQueryfalse

Pagination cursor. starting_after is the ID of the object to begin your list with and would return objects in the order they were created after this object. For example, if you grab list of objects, ending with obj you can include starting_after=obj.id in your call to fetch next page of the list.

ending_beforestringQueryfalse

Pagination cursor. ending_before is an object ID you’d specify to return objects created before this object. For example, if you grab list of objects, starting with obj you can include ending_before=obj.id in your call to fetch previous page of the list.

created_fromstringQueryfalse

Get transactions from date

created_tostringQueryfalse

Get transactions before date

account_idstringQueryfalse

Filter transactions by account id

card_idstringQueryfalse

Filter transactions by card id

individual_idstringQueryfalse

Valid Individual ID. Filter accounts owned by the provided Individual

idstringPathtrue

Bank account ID

Response body

Bank account

NameTypeRequiredDescription
idstringtrue

Account ID

namestringtrue

Account name

currencystringtrue

Account currency

balanceintegertrue

Account balance

created_atdate-time-iso8601true

Creation date time

typestringtrue

Account type. Possible values: current, prefunded

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Bank account not found

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Accessing the balance of one or more designated payment accounts for the first time requires Strong Customer Authentication

Request parameters

NameTypeLocationRequiredDescription
individual_idstringQuerytrue

Valid Individual ID. Filter accounts owned by the provided Individual

Response body

List of bank accounts

NameTypeRequiredDescription
dataarraytrue

Bank accounts

data.idstringtrue

Account ID

data.namestringtrue

Account name

data.currencystringtrue

Account currency

data.balanceintegertrue

Account balance

data.created_atdate-time-iso8601true

Creation date time

data.typestringtrue

Account type. Possible values: current, prefunded

has_morebooleantrue

A flag that shows whether there are more items to return

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Bank account ID

Response body

Bank account details

NameTypeRequiredDescription
payment_railstringtrue

Payment rail. Possible values: uk_local, sepa, swift

detailsuniontrue

Account number and bank code. Possible values: Account details uk local, Account details iban

beneficiarystringtrue

Beneficiary name

beneficiary_addressobjecttrue

Beneficiary address

beneficiary_address.street1stringtrue

Line 1 of the beneficiary’s address

beneficiary_address.street2stringfalse

Line 2 of the beneficiary’s address

beneficiary_address.citystringtrue

City

beneficiary_address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

beneficiary_address.post_codestringtrue

Postal code

Account details uk local

UK local account details

NameTypeRequiredDescription
details.account_nostringtrue

UK account number

details.sort_codestringtrue

UK bank sort code

Account details iban

Account details in IBAN format

NameTypeRequiredDescription
details.ibanstringtrue

IBAN

details.bicstringtrue

BIC

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Bank account not found

Request body

Bank account for individual creation form

NameTypeRequiredDescription
individual_idstringtrue

Individual ID

typestringfalse

Account type. Possible values: current, prefunded

Response body

Bank account

NameTypeRequiredDescription
idstringtrue

Account ID

namestringtrue

Account name

currencystringtrue

Account currency

balanceintegertrue

Account balance

created_atdate-time-iso8601true

Creation date time

typestringtrue

Account type. Possible values: current, prefunded

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Cards

Note

  • The minimum card validity period is the current date plus one month.

  • The maximum card validity period is the current date plus three years.

Request body

Card issue form

NameTypeRequiredDescription
individual_idstringtrue

Associated individual user id

account_idstringtrue

Associated card account id

display_namestringfalse

Card display name

exp_monthstringtrue

Card expiry month

exp_yearstringtrue

Card expiry year

typestringtrue

Card type. Possible values: virtual, physical

delivery_addressobjectfalse

Where to deliver the card

delivery_address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

delivery_address.street1stringtrue

Street line 1

delivery_address.street2stringfalse

Street line 2

delivery_address.citystringtrue

City

delivery_address.regionstringfalse

Region

delivery_address.postal_codestringtrue

Postal code

Response body

New card

NameTypeRequiredDescription
idstringtrue

Card id

display_nameuniontrue

Card display name. Possible values:

typestringtrue

Card type. Possible values: virtual, physical

brandstringtrue

Card brand. Possible values: visa

regionstringtrue

Card region. Possible values: europe

exp_monthstringtrue

Card expiry month

exp_yearstringtrue

Card expiry year

last4stringtrue

Card last four digits

currencystringtrue

Card main currency

account_idstringtrue

Associated bank account id

individual_idstringtrue

Associated individual user id

statusstringtrue

Card status. Possible values: active, not_activated, frozen, blocked, closed, stolen, lost, fraud, expired, security_block

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
individual_iduuidQueryfalse

Individual id. Use it for filter by individual id

limitintegerQueryfalse

A limit on the number of objects to be returned. Default 10. Can be 1 to 100.

sort_typestringQueryfalse

Sort type. Default DESC.. Possible values: ASC, DESC

starting_afterstringQueryfalse

Pagination cursor. starting_after is the ID of the object to begin your list with and would return objects in the order they were created after this object. For example, if you grab list of objects, ending with obj you can include starting_after=obj.id in your call to fetch next page of the list.

ending_beforestringQueryfalse

Pagination cursor. ending_before is an object ID you’d specify to return objects created before this object. For example, if you grab list of objects, starting with obj you can include ending_before=obj.id in your call to fetch previous page of the list.

Response body

List of cards

NameTypeRequiredDescription
dataarraytrue

List of cards

data.idstringtrue

Card id

data.display_nameuniontrue

Card display name. Possible values:

data.typestringtrue

Card type. Possible values: virtual, physical

data.brandstringtrue

Card brand. Possible values: visa

data.regionstringtrue

Card region. Possible values: europe

data.exp_monthstringtrue

Card expiry month

data.exp_yearstringtrue

Card expiry year

data.last4stringtrue

Card last four digits

data.currencystringtrue

Card main currency

data.account_idstringtrue

Associated bank account id

data.individual_idstringtrue

Associated individual user id

data.statusstringtrue

Card status. Possible values: active, not_activated, frozen, blocked, closed, stolen, lost, fraud, expired, security_block

has_morebooleantrue

A flag that shows whether there are more items to return

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Card id

Response body

Card details

NameTypeRequiredDescription
idstringtrue

Card id

display_nameuniontrue

Card display name. Possible values:

typestringtrue

Card type. Possible values: virtual, physical

brandstringtrue

Card brand. Possible values: visa

regionstringtrue

Card region. Possible values: europe

exp_monthstringtrue

Card expiry month

exp_yearstringtrue

Card expiry year

last4stringtrue

Card last four digits

currencystringtrue

Card main currency

account_idstringtrue

Associated bank account id

individual_idstringtrue

Associated individual user id

statusstringtrue

Card status. Possible values: active, not_activated, frozen, blocked, closed, stolen, lost, fraud, expired, security_block

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Card not found

Accessing card credentials requires explicit consent

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Card id

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Card not found

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Activating the card requires explicit consent

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Card id

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Card not found

Individual needs to confirm consent before activating the card

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Card PIN reset requires explicit consent

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Card id

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Card not found

Card PIN reset requires explicit consent

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Card id

Request body

Card update form

NameTypeRequiredDescription
statusstringfalse

Card status. Possible values: active, frozen, blocked, stolen, lost, fraud, not_activated

account_idstringfalse

Associated bank account id

Response body

Update virtual card

NameTypeRequiredDescription
idstringtrue

Card id

display_nameuniontrue

Card display name. Possible values:

typestringtrue

Card type. Possible values: virtual, physical

brandstringtrue

Card brand. Possible values: visa

regionstringtrue

Card region. Possible values: europe

exp_monthstringtrue

Card expiry month

exp_yearstringtrue

Card expiry year

last4stringtrue

Card last four digits

currencystringtrue

Card main currency

account_idstringtrue

Associated bank account id

individual_idstringtrue

Associated individual user id

statusstringtrue

Card status. Possible values: active, not_activated, frozen, blocked, closed, stolen, lost, fraud, expired, security_block

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Card not found

Individual payment methods

Response body

Array of Payment method objects

NameTypeRequiredDescription
dataarraytrue

List of payment methods

data.iduuidtrue

Payment method ID

data.typestringtrue

Payment method type. Possible values: card

data.detailsuniontrue

Payment method details. Possible values: Payment method details card

data.created_atdate-time-iso8601true

Creation date time

has_morebooleantrue

A flag that shows whether there are more items to return

Payment method details card

Card payment method details

NameTypeRequiredDescription
data.details.brandstringtrue

Card brand. Possible values: visa, mastercard

data.details.exp_monthstringtrue

Card expiry month

data.details.exp_yearstringtrue

Card expiry year

data.details.last4stringtrue

Card last four digits

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request body

New payment method request body

NameTypeRequiredDescription
chargeobjectfalse

Charge details

charge.amountintegertrue

Amount to charge

charge.currencystringfalse

Charge currency

charge.account_idstringtrue

Individual destination account ID

typestringfalse

Type of payment method to add. Defaults to card. Possible values: card

Response body

Array of Payment method objects

NameTypeRequiredDescription
iduuidtrue

Payment method ID

typestringtrue

Payment method type. Possible values: card

detailsuniontrue

Payment method details. Possible values: Payment method details card

created_atdate-time-iso8601true

Creation date time

Payment method details card

Card payment method details

NameTypeRequiredDescription
details.brandstringtrue

Card brand. Possible values: visa, mastercard

details.exp_monthstringtrue

Card expiry month

details.exp_yearstringtrue

Card expiry year

details.last4stringtrue

Card last four digits

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual or account not found

CVC must be verified. 3D Secure 2 authentication might be needed for a successful payment as well

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

Request body

Charge payment method request body

NameTypeRequiredDescription
amountintegertrue

Amount to charge

currencystringfalse

Charge currency

account_idstringtrue

Individual destination account ID

Response body

Transaction details

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

CVC verification is required

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

Request body

Schedule payment method request body

NameTypeRequiredDescription
chargeobjecttrue

Charge details

charge.amountintegertrue

Amount to charge

charge.currencystringfalse

Charge currency

charge.account_idstringtrue

Individual destination account ID

scheduleuniontrue

Recurring payment schedule settings. Possible values: Payment method schedule

Payment method schedule

Payment method schedule settings

NameTypeRequiredDescription
schedule.frequencystringtrue

Frequency of the payment. Possible values: daily, weekly, monthly, quarterly, yearly

schedule.divisorintegerfalse

How often to apply the payment

schedule.offsetintegerfalse

Specifying offset inside the frequency

Response body

OK

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

CVC verification is required

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

Response body

Array of Subscription objects

NameTypeRequiredDescription
dataarraytrue

Array of subscriptions

data.idstringtrue

Subscription ID

data.currencystringtrue

Subscription currency

data.amountintegertrue

Subscription amount in minor currency units

data.scheduleuniontrue

Recurring payment schedule. Possible values: Payment method schedule

data.startdate-iso8601false

Subscription start date

data.duedate-iso8601false

Subscription due date

has_morebooleantrue

A flag that shows whether there are more items to return

Payment method schedule

Payment method schedule settings

NameTypeRequiredDescription
data.schedule.frequencystringtrue

Frequency of the payment. Possible values: daily, weekly, monthly, quarterly, yearly

data.schedule.divisorintegerfalse

How often to apply the payment

data.schedule.offsetintegerfalse

Specifying offset inside the frequency

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

subscription_idstringPathtrue

Subscription ID

Response body

OK

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Not found

Transactions

Accessing payment history requires explicit consent every 90 days

Request parameters

NameTypeLocationRequiredDescription
limitintegerQueryfalse

A limit on the number of objects to be returned. Default 10. Can be 1 to 100.

sort_typestringQueryfalse

Sort type. Possible values: ASC, DESC

starting_afterstringQueryfalse

Pagination cursor. starting_after is the ID of the object to begin your list with and would return objects in the order they were created after this object. For example, if you grab list of objects, ending with obj you can include starting_after=obj.id in your call to fetch next page of the list.

ending_beforestringQueryfalse

Pagination cursor. ending_before is an object ID you’d specify to return objects created before this object. For example, if you grab list of objects, starting with obj you can include ending_before=obj.id in your call to fetch previous page of the list.

created_fromstringQueryfalse

Get transactions from date

created_tostringQueryfalse

Get transactions before date

account_idstringQueryfalse

Filter transactions by account id

card_idstringQueryfalse

Filter transactions by card id

individual_idstringQueryfalse

Valid Individual ID. Filter accounts owned by the provided Individual

Response body

Transactions list

NameTypeRequiredDescription
dataarraytrue

Transactions

data.idstringtrue

Transaction id

data.request_idstringfalse

Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error

data.typestringtrue

Transaction type. Possible values: bank-transfer, card-payment

data.amountintegertrue

Transaction amount

data.currencystringtrue

Transaction currency

data.statusstringtrue

Transaction status. Possible values: pending, completed, rejected, refunded

data.account_idstringtrue

Associated account id

data.referencestringtrue

Payment details

data.merchantobjectfalse

Merchant details

data.merchant.namestringtrue

Counterparty name

data.merchant.locationstringtrue

Location

data.merchant.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

data.merchant.categorystringtrue

Merchant category

data.counterpartyobjectfalse

Counterparty

data.counterparty.namestringtrue

Counterparty name

data.counterparty.account_idstringtrue

Associated account id

data.counterparty.account_detailsuniontrue

Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details

data.cardobjectfalse

Card details

data.card.card_numberstringtrue

Card number

data.card.first_namestringtrue

Cardholder first name

data.card.last_namestringtrue

Cardholder last name

data.card_idstringfalse

Card id

data.created_atdate-time-iso8601true

Creation date time

has_morebooleantrue

A flag that shows whether there are more items to return

Sepa transaction account details

SEPA account details

NameTypeRequiredDescription
data.counterparty.account_details.typestringtrue

SEPA account type. Possible values: sepa

data.counterparty.account_details.ibanstringtrue

IBAN

Uk local transaction account details

UK local account details

NameTypeRequiredDescription
data.counterparty.account_details.typestringtrue

UK local account type. Possible values: uk-local

data.counterparty.account_details.numberstringtrue

UK local account number

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Accessing payment history requires explicit consent every 90 days

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Transaction ID

Response body

Transaction details

NameTypeRequiredDescription
idstringtrue

Transaction id

request_idstringfalse

Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error

typestringtrue

Transaction type. Possible values: bank-transfer, card-payment

amountintegertrue

Transaction amount

currencystringtrue

Transaction currency

statusstringtrue

Transaction status. Possible values: pending, completed, rejected, refunded

account_idstringtrue

Associated account id

referencestringtrue

Payment details

merchantobjectfalse

Merchant details

merchant.namestringtrue

Counterparty name

merchant.locationstringtrue

Location

merchant.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

merchant.categorystringtrue

Merchant category

counterpartyobjectfalse

Counterparty

counterparty.namestringtrue

Counterparty name

counterparty.account_idstringtrue

Associated account id

counterparty.account_detailsuniontrue

Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details

cardobjectfalse

Card details

card.card_numberstringtrue

Card number

card.first_namestringtrue

Cardholder first name

card.last_namestringtrue

Cardholder last name

card_idstringfalse

Card id

created_atdate-time-iso8601true

Creation date time

Sepa transaction account details

SEPA account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

SEPA account type. Possible values: sepa

counterparty.account_details.ibanstringtrue

IBAN

Uk local transaction account details

UK local account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

UK local account type. Possible values: uk-local

counterparty.account_details.numberstringtrue

UK local account number

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Transaction not found

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request body

Make transfer request

NameTypeRequiredDescription
request_idstringtrue

Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error

source_account_idstringtrue

Source account id

target_account_idstringtrue

Target account id

amountintegertrue

Transfer amount

referencestringtrue

Payment details

Response body

Transaction info

NameTypeRequiredDescription
idstringtrue

Transaction id

request_idstringfalse

Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error

typestringtrue

Transaction type. Possible values: bank-transfer, card-payment

amountintegertrue

Transaction amount

currencystringtrue

Transaction currency

statusstringtrue

Transaction status. Possible values: pending, completed, rejected, refunded

account_idstringtrue

Associated account id

referencestringtrue

Payment details

merchantobjectfalse

Merchant details

merchant.namestringtrue

Counterparty name

merchant.locationstringtrue

Location

merchant.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

merchant.categorystringtrue

Merchant category

counterpartyobjectfalse

Counterparty

counterparty.namestringtrue

Counterparty name

counterparty.account_idstringtrue

Associated account id

counterparty.account_detailsuniontrue

Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details

cardobjectfalse

Card details

card.card_numberstringtrue

Card number

card.first_namestringtrue

Cardholder first name

card.last_namestringtrue

Cardholder last name

card_idstringfalse

Card id

created_atdate-time-iso8601true

Creation date time

Sepa transaction account details

SEPA account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

SEPA account type. Possible values: sepa

counterparty.account_details.ibanstringtrue

IBAN

Uk local transaction account details

UK local account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

UK local account type. Possible values: uk-local

counterparty.account_details.numberstringtrue

UK local account number

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Making online payments requires Strong Customer Authentication

Request body

Sepa payment request

NameTypeRequiredDescription
request_idstringtrue

Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error

account_idstringtrue

Source account id

counterpartyuniontrue

Counterparty details. Possible values: Sepa payment request counterparty with account id, Sepa payment request counterparty with account details

amountintegertrue

Transfer amount

referencestringtrue

Payment details

Sepa payment request counterparty with account id

Counterparty details

NameTypeRequiredDescription
counterparty.namestringtrue

Name of the receiving counterparty

counterparty.account_idstringtrue

Receiving counterparty's account id

Sepa payment request counterparty with account details

Counterparty details

NameTypeRequiredDescription
counterparty.namestringtrue

Name of the receiving counterparty

counterparty.accountobjecttrue

Receiving counterparty's account details

counterparty.account.ibanstringtrue

IBAN

counterparty.account.bicstringtrue

BIC

Response body

Transaction

NameTypeRequiredDescription
idstringtrue

Transaction id

request_idstringfalse

Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error

typestringtrue

Transaction type. Possible values: bank-transfer, card-payment

amountintegertrue

Transaction amount

currencystringtrue

Transaction currency

statusstringtrue

Transaction status. Possible values: pending, completed, rejected, refunded

account_idstringtrue

Associated account id

referencestringtrue

Payment details

merchantobjectfalse

Merchant details

merchant.namestringtrue

Counterparty name

merchant.locationstringtrue

Location

merchant.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

merchant.categorystringtrue

Merchant category

counterpartyobjectfalse

Counterparty

counterparty.namestringtrue

Counterparty name

counterparty.account_idstringtrue

Associated account id

counterparty.account_detailsuniontrue

Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details

cardobjectfalse

Card details

card.card_numberstringtrue

Card number

card.first_namestringtrue

Cardholder first name

card.last_namestringtrue

Cardholder last name

card_idstringfalse

Card id

created_atdate-time-iso8601true

Creation date time

Sepa transaction account details

SEPA account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

SEPA account type. Possible values: sepa

counterparty.account_details.ibanstringtrue

IBAN

Uk local transaction account details

UK local account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

UK local account type. Possible values: uk-local

counterparty.account_details.numberstringtrue

UK local account number

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Anonymous guest users

Response body

List of guests

NameTypeRequiredDescription
dataarraytrue

List of guests

data.iduuidtrue

Guest UUID

data.reference_idstringfalse

External reference ID

data.namestringfalse

First and last name

data.emailstringfalse

Email address

data.phone_numberstringfalse

Phone number

data.addressobjectfalse

Address

data.address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

data.address.street1stringtrue

Street line 1

data.address.street2stringfalse

Street line 2

data.address.citystringtrue

City

data.address.regionstringfalse

Region

data.address.postal_codestringtrue

Postal code

data.created_atdate-time-iso8601true

Creation date time

has_morebooleantrue

A flag that shows whether there are more items to return

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request body

New guest creation form

NameTypeRequiredDescription
reference_idstringfalse

External reference ID. Must be unique across all guest users

namestringfalse

First and last name

emailstringfalse

Email address

phone_numberstringfalse

Phone number

addressobjectfalse

Address

address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

address.street1stringtrue

Street line 1

address.street2stringfalse

Street line 2

address.citystringtrue

City

address.regionstringfalse

Region

address.postal_codestringtrue

Postal code

Response body

New guest

NameTypeRequiredDescription
iduuidtrue

Guest UUID

reference_idstringfalse

External reference ID

namestringfalse

First and last name

emailstringfalse

Email address

phone_numberstringfalse

Phone number

addressobjectfalse

Address

address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

address.street1stringtrue

Street line 1

address.street2stringfalse

Street line 2

address.citystringtrue

City

address.regionstringfalse

Region

address.postal_codestringtrue

Postal code

created_atdate-time-iso8601true

Creation date time

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Guest payment methods

Response body

Array of Payment method objects

NameTypeRequiredDescription
dataarraytrue

List of payment methods

data.iduuidtrue

Payment method ID

data.typestringtrue

Payment method type. Possible values: card

data.detailsuniontrue

Payment method details. Possible values: Payment method details card

data.created_atdate-time-iso8601true

Creation date time

has_morebooleantrue

A flag that shows whether there are more items to return

Payment method details card

Card payment method details

NameTypeRequiredDescription
data.details.brandstringtrue

Card brand. Possible values: visa, mastercard

data.details.exp_monthstringtrue

Card expiry month

data.details.exp_yearstringtrue

Card expiry year

data.details.last4stringtrue

Card last four digits

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request body

New payment method request body

NameTypeRequiredDescription
chargeobjectfalse

Charge details

charge.amountintegertrue

Amount to charge

charge.currencystringfalse

Charge currency

charge.account_idstringtrue

Individual destination account ID

typestringfalse

Type of payment method to add. Defaults to card. Possible values: card

Response body

Array of Payment method objects

NameTypeRequiredDescription
iduuidtrue

Payment method ID

typestringtrue

Payment method type. Possible values: card

detailsuniontrue

Payment method details. Possible values: Payment method details card

created_atdate-time-iso8601true

Creation date time

Payment method details card

Card payment method details

NameTypeRequiredDescription
details.brandstringtrue

Card brand. Possible values: visa, mastercard

details.exp_monthstringtrue

Card expiry month

details.exp_yearstringtrue

Card expiry year

details.last4stringtrue

Card last four digits

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual or account not found

CVC must be verified. 3D Secure 2 authentication might be needed for a successful payment as well

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

Request body

Charge payment method request body

NameTypeRequiredDescription
amountintegertrue

Amount to charge

currencystringfalse

Charge currency

account_idstringtrue

Individual destination account ID

Response body

Transaction details

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

CVC verification is required

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

Request body

Schedule payment method request body

NameTypeRequiredDescription
chargeobjecttrue

Charge details

charge.amountintegertrue

Amount to charge

charge.currencystringfalse

Charge currency

charge.account_idstringtrue

Individual destination account ID

scheduleuniontrue

Recurring payment schedule settings. Possible values: Payment method schedule

Payment method schedule

Payment method schedule settings

NameTypeRequiredDescription
schedule.frequencystringtrue

Frequency of the payment. Possible values: daily, weekly, monthly, quarterly, yearly

schedule.divisorintegerfalse

How often to apply the payment

schedule.offsetintegerfalse

Specifying offset inside the frequency

Response body

OK

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

CVC verification is required

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

Response body

Array of Subscription objects

NameTypeRequiredDescription
dataarraytrue

Array of subscriptions

data.idstringtrue

Subscription ID

data.currencystringtrue

Subscription currency

data.amountintegertrue

Subscription amount in minor currency units

data.scheduleuniontrue

Recurring payment schedule. Possible values: Payment method schedule

data.startdate-iso8601false

Subscription start date

data.duedate-iso8601false

Subscription due date

has_morebooleantrue

A flag that shows whether there are more items to return

Payment method schedule

Payment method schedule settings

NameTypeRequiredDescription
data.schedule.frequencystringtrue

Frequency of the payment. Possible values: daily, weekly, monthly, quarterly, yearly

data.schedule.divisorintegerfalse

How often to apply the payment

data.schedule.offsetintegerfalse

Specifying offset inside the frequency

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
iduuidPathtrue

Payment method ID

subscription_idstringPathtrue

Subscription ID

Response body

OK

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Not found

Simulation endpoints

Request body

Card payment form

NameTypeRequiredDescription
card_idstringtrue

Card id

amountintegertrue

Payment amount

currencystringtrue

Payment currency

Response body

Card payment simulation result

NameTypeRequiredDescription
successfulbooleantrue

Is payment successful

codestringtrue

Processing result code. Possible values: 61, 05, 94, 51, 13, 57, 65, 84

code_descriptionstringtrue

Processing result code description

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Transaction ID

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Transaction not found

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Transaction ID

Response body

Empty

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Transaction not found

Request body

NameTypeRequiredDescription
individual_idstringtrue

Individual id

Response body

Simulation result. Individual passcode for simulation is mocked: 111111

NameTypeRequiredDescription
individual_idstringtrue

Individual id

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request body

NameTypeRequiredDescription
individual_idstringtrue

Individual id

statusstringtrue

Status. Possible values: activated, blocked

Response body

Simulation result

NameTypeRequiredDescription
individual_idstringtrue

Individual id

statusstringtrue

Status. Possible values: activated, blocked

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Fees

Request body

Fee creation data

NameTypeRequiredDescription
account_idstringtrue

Account id

amountintegertrue

Fee amount

descriptionstringtrue

Text note

Response body

Data of newly created fee

NameTypeRequiredDescription
idstringtrue

Fee id

amountintegertrue

Charge amount

currencystringtrue

Charge currency

statusstringtrue

Status. Possible values: pending, failed, refunded, completed

account_idstringtrue

Associated account id

descriptionstringtrue

Text note

created_atdate-time-iso8601true

Creation timestamp

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Accessing fee history requires explicit consent every 90 days

Request parameters

NameTypeLocationRequiredDescription
limitintegerQueryfalse

A limit on the number of objects to be returned. Default 10. Can be 1 to 100.

sort_typestringQueryfalse

Sort type. Default DESC. Possible values: ASC, DESC

starting_afterstringQueryfalse

Pagination cursor. starting_after is the ID of the object to begin your list with and would return objects in the order they were created after this object. For example, if you grab list of objects, ending with obj you can include starting_after=obj.id in your call to fetch next page of the list.

ending_beforestringQueryfalse

Pagination cursor. ending_before is an object ID you’d specify to return objects created before this object. For example, if you grab list of objects, starting with obj you can include ending_before=obj.id in your call to fetch previous page of the list.

individual_idstringQueryfalse

It can be used to filter fees by specific individual.

account_idstringQueryfalse

It can be used to filter fees by specific source account.

Response body

List of fees

NameTypeRequiredDescription
dataarraytrue

List of fees

data.idstringtrue

Fee id

data.amountintegertrue

Charge amount

data.currencystringtrue

Charge currency

data.statusstringtrue

Status. Possible values: pending, failed, refunded, completed

data.account_idstringtrue

Associated account id

data.descriptionstringtrue

Text note

data.created_atdate-time-iso8601true

Creation timestamp

has_morebooleantrue

A flag that shows whether there are more items to return

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Accessing fee history requires explicit consent every 90 days

Request parameters

NameTypeLocationRequiredDescription
idstringPathfalse

Fee id.

Response body

Fee

NameTypeRequiredDescription
idstringtrue

Fee id

amountintegertrue

Charge amount

currencystringtrue

Charge currency

statusstringtrue

Status. Possible values: pending, failed, refunded, completed

account_idstringtrue

Associated account id

descriptionstringtrue

Text note

created_atdate-time-iso8601true

Creation timestamp

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Fee not found

Individual needs to confirm consent before access to data

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

Consent status. Possible values: pending, requested, failed, completed

Endpoints for auditing purposes

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Transaction id.

Response body

Limited transaction data

NameTypeRequiredDescription
idstringtrue

Transaction id

typestringtrue

Transaction type. Possible values: bank-transfer, card-payment, fee

amountintegertrue

Transaction amount

currencystringtrue

Transaction currency

statusstringtrue

Transaction status. Possible values: pending, completed, rejected, refunded, failed

account_idstringtrue

Associated account id

referencestringtrue

Payment details

counterpartyobjectfalse

Counterparty

counterparty.namestringtrue

Counterparty name

counterparty.account_idstringtrue

Associated account id

counterparty.account_detailsuniontrue

Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details

created_atdate-time-iso8601true

Creation date time

Sepa transaction account details

SEPA account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

SEPA account type. Possible values: sepa

counterparty.account_details.ibanstringtrue

IBAN

Uk local transaction account details

UK local account details

NameTypeRequiredDescription
counterparty.account_details.typestringtrue

UK local account type. Possible values: uk-local

counterparty.account_details.numberstringtrue

UK local account number

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Transaction not found