Integr>te™ API - v3.62.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_namestring[...40]true

First name

last_namestring[...40]true

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.street1string[...64]true

Street line 1

address.street2string[...64]false

Street line 2

address.citystring[...64]true

City

address.regionstring[...32]false

Region

address.postal_codestring[...10]true

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

Updating data requires explicit consent for Activated individual.

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Individual ID

Request body

Individual update form

NameTypeRequiredDescription
updateuniontrue

Union of possible individual update objects. Possible values: Individual update form email, Individual update form phone number

Individual update form email

Individual update form for email address

NameTypeRequiredDescription
update.typestringtrue

Type of update. Possible values: email

update.emailstringtrue

New individual email

Individual update form phone number

Individual update form for phone number

NameTypeRequiredDescription
update.typestringtrue

Type of update. Possible values: phone_number

update.phone_numberstringtrue

New individual phone number

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

Individual not found

Individual update 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

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 swedish bank id verification report, Kyc norwegian bank id verification report, Kyc finnish bank id verification report

Kyc swedish bank id verification report

Swedish BankID verification report

NameTypeRequiredDescription
report.providerstringtrue

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_numberstring[12]true

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_beforestring[13]true

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

report.cert.not_afterstring[13]true

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

Kyc norwegian bank id verification report

Norwegian BankID verification report

NameTypeRequiredDescription
report.providerstringtrue

Provider. Possible values: no_bank_id

report.pidstringtrue

PID

report.ssnstringfalse

SSN

report.not_afterunionfalse

Not after. Possible values: string, null. Possible values:

report.not_beforeunionfalse

Not before. Possible values: string, null. Possible values:

report.phone_numberunionfalse

Phone number. Possible values: string, null. Possible values:

report.issuer_dnstringfalse

Issuer DN

report.used_mobile_bank_idbooleantrue

Indicates whether user already used mobile bank ID

report.profile_dataobjecttrue

BankID user information

report.profile_data.birthdatedate-time-iso8601true

Birthdate

report.profile_data.family_namestringtrue

Family name

report.profile_data.given_namestringtrue

Given name

report.profile_data.namestringtrue

Name

report.certificate_dataobjecttrue

BankID certificate information

report.certificate_data.certificate_policystringtrue

Policy

report.certificate_data.distinguished_namestringtrue

Distinguished name

report.certificate_data.serial_numberstringtrue

Serial number

report.certificate_data.key_algorithmstringtrue

Key algorithm

report.certificate_data.key_sizestringtrue

Key size

report.certificate_data.cert_qualifiedbooleantrue

Certificate qualified

report.certificate_data.monetary_limit_currencystringtrue

Monetary limit currency

report.certificate_data.monetary_limit_amountstringtrue

Monetary limit amount

report.certificate_data.cert_valid_fromdate-time-iso8601true

Certificate valid from

report.certificate_data.cert_valid_todate-time-iso8601true

Certificate valid to

report.certificate_data.version_numberstringtrue

Version number

report.certificate_data.countryunionfalse

Country. Possible values: string, null. Possible values:

report.certificate_data.certificateunionfalse

Certificate. Possible values: string, null. Possible values:

report.certificate_data.common_nameunionfalse

Common name. Possible values: string, null. Possible values:

Kyc finnish bank id verification report

Finnish BankID verification report

NameTypeRequiredDescription
report.providerstringtrue

Provider. Possible values: fi_bank_id

report.trx_codestringtrue

trx code

report.bankstringtrue

Bank

report.pidstringtrue

PID

report.ssnstringtrue

SSN

report.profile_dataobjecttrue

BankID user information

report.profile_data.birthdatedate-time-iso8601true

Birthdate

report.profile_data.family_namestringtrue

Family name

report.profile_data.given_namestringtrue

Given name

report.profile_data.namestringtrue

Name

report.certificate_dataobjecttrue

BankID certificate information

report.certificate_data.countrystringtrue

Country

report.certificate_data.certificatestringtrue

Certificate

report.certificate_data.certificate_policystringtrue

Certificate policy

report.certificate_data.common_namestringtrue

Common name

report.certificate_data.distinguished_namestringtrue

Distinguished name

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

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, view_old_transactions, confirm_transaction, view_card_credentials, activate_card, reactivate_card, reset_card_pin, initialize_payment_method, update_individual_phone_number, update_individual_email, apple_pay_tokenize, google_pay_tokenize

has_morebooleantrue

A flag that shows whether there are more items to return

Unauthorized

Request body

Request consent params

NameTypeRequiredDescription
individual_idstringtrue

Individual ID

scopestringtrue

Scope for requested consent. Possible values: view_balance, view_payment_history

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

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, IndividualEmailChanged, IndividualPhoneNumberChanged, IndividualNameChanged, IndividualDateOfBirthChanged, IndividualAddressChanged, CardStatusChanged, PendingActionCreated, PendingActionCompleted

data.payloaduniontrue

Payload. Possible values: Authorization completed event payload, Authorization failed event payload, Individual status updated event payload, Transaction event payload, Individual email updated event payload, Individual phone number updated event payload, Individual name updated event payload, Individual date of birth updated event payload, Individual address updated event payload, Card status changed payload, Pending action 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

data.payload.request_idunionfalse

Request ID. Possible values:

data.payload.statusstringtrue

Status

data.payload.amountintegertrue

Amount

data.payload.currencystringtrue

Currency

data.payload.account_idstringtrue

Account ID

data.payload.counterparty_account_idstringtrue

Counterparty account ID

Individual email updated event payload

Individual updated event payload. Applicable for: IndividualEmailChanged events

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

data.payload.emailstringtrue

Individual email

Individual phone number updated event payload

Individual updated event payload. Applicable for: IndividualPhoneNumberChanged events

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

data.payload.phone_numberstringtrue

Individual phone number

Individual name updated event payload

Individual updated event payload. Applicable for: IndividualNameChanged events

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

data.payload.first_namestringfalse

Individual first name

data.payload.last_namestringfalse

Individual last name

Individual date of birth updated event payload

Individual updated event payload. Applicable for: IndividualDateOfBirthChanged events

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

data.payload.date_of_birthstringtrue

Individual date of birth

Individual address updated event payload

Individual updated event payload. Applicable for: IndividualAddressChanged events

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

data.payload.cityunionfalse

Individual city. Possible values:

data.payload.country_codeunionfalse

Individual country code. Possible values:

data.payload.postal_codeunionfalse

Individual postal code. Possible values:

data.payload.regionunionfalse

Individual region. Possible values:

data.payload.street1unionfalse

Individual street1. Possible values:

data.payload.street2unionfalse

Individual street2. Possible values:

Card status changed payload

Card status changed event payload. Applicable for: CardStatusChanged events

NameTypeRequiredDescription
data.payload.card_idstringtrue

Card ID

data.payload.statusstringtrue

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

Pending action event payload

Pending action event payload

NameTypeRequiredDescription
data.payload.individual_idstringtrue

Individual ID

data.payload.pending_action_idstringtrue

Pending action ID

data.payload.typestringtrue

Type of pending action. Possible values: UploadDocument, AuthenticateCardOperation

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, IndividualEmailChanged, IndividualPhoneNumberChanged, IndividualNameChanged, IndividualDateOfBirthChanged, IndividualAddressChanged, CardStatusChanged, PendingActionCreated, PendingActionCompleted

payloaduniontrue

Payload. Possible values: Authorization completed event payload, Authorization failed event payload, Individual status updated event payload, Transaction event payload, Individual email updated event payload, Individual phone number updated event payload, Individual name updated event payload, Individual date of birth updated event payload, Individual address updated event payload, Card status changed payload, Pending action 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

payload.request_idunionfalse

Request ID. Possible values:

payload.statusstringtrue

Status

payload.amountintegertrue

Amount

payload.currencystringtrue

Currency

payload.account_idstringtrue

Account ID

payload.counterparty_account_idstringtrue

Counterparty account ID

Individual email updated event payload

Individual updated event payload. Applicable for: IndividualEmailChanged events

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

payload.emailstringtrue

Individual email

Individual phone number updated event payload

Individual updated event payload. Applicable for: IndividualPhoneNumberChanged events

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

payload.phone_numberstringtrue

Individual phone number

Individual name updated event payload

Individual updated event payload. Applicable for: IndividualNameChanged events

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

payload.first_namestringfalse

Individual first name

payload.last_namestringfalse

Individual last name

Individual date of birth updated event payload

Individual updated event payload. Applicable for: IndividualDateOfBirthChanged events

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

payload.date_of_birthstringtrue

Individual date of birth

Individual address updated event payload

Individual updated event payload. Applicable for: IndividualAddressChanged events

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

payload.cityunionfalse

Individual city. Possible values:

payload.country_codeunionfalse

Individual country code. Possible values:

payload.postal_codeunionfalse

Individual postal code. Possible values:

payload.regionunionfalse

Individual region. Possible values:

payload.street1unionfalse

Individual street1. Possible values:

payload.street2unionfalse

Individual street2. Possible values:

Card status changed payload

Card status changed event payload. Applicable for: CardStatusChanged events

NameTypeRequiredDescription
payload.card_idstringtrue

Card ID

payload.statusstringtrue

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

Pending action event payload

Pending action event payload

NameTypeRequiredDescription
payload.individual_idstringtrue

Individual ID

payload.pending_action_idstringtrue

Pending action ID

payload.typestringtrue

Type of pending action. Possible values: UploadDocument, AuthenticateCardOperation

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
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, security_block

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

Tokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

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 tokenizing 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

Tokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

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 tokenizing 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

Individual payment methods


Request parameters

NameTypeLocationRequiredDescription
individual_idstringQuerytrue

Valid Individual ID. Filter payment methods belonging to specific Individual

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

Response body

Success

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

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Transactions

Accessing payment history requires explicit consent

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

Transaction exchange rate. Possible values: decimal, null. Possible values:

data.payment_amountintegertrue

Transaction payment amount

data.payment_currencystringtrue

Transaction payment 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

Accessing payment history requires:

  • explicit consent every 90 days to view transactions from the past 90 days
  • explicit consent to view transactions older than 90 days (valid for 10 minutes)

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

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

exchange_rateuniontrue

Transaction exchange rate. Possible values: decimal, null. Possible values:

payment_amountintegertrue

Transaction payment amount

payment_currencystringtrue

Transaction payment 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

Accessing payment history requires:

  • explicit consent every 90 days to view transactions from the past 90 days
  • explicit consent to view transactions older than 90 days (valid for 10 minutes)

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

exchange_rateuniontrue

Transaction exchange rate. Possible values: decimal, null. Possible values:

payment_amountintegertrue

Transaction payment amount

payment_currencystringtrue

Transaction payment 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

exchange_rateuniontrue

Transaction exchange rate. Possible values: decimal, null. Possible values:

payment_amountintegertrue

Transaction payment amount

payment_currencystringtrue

Transaction payment 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

Sender or Receiver 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

Anonymous guest users

Response body

List of guests

NameTypeRequiredDescription
dataarraytrue

List of guests

data.iduuidtrue

Guest UUID

data.reference_idstringtrue

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_idstringtrue

External reference ID. Must be unique across all guest users

namestring[...100]false

First and last name

emailstringfalse

Email address

phone_numberstringfalse

Phone number

addressobjectfalse

Address

address.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

address.street1string[...64]true

Street line 1

address.street2string[...64]false

Street line 2

address.citystring[...64]true

City

address.regionstring[...32]false

Region

address.postal_codestring[...10]true

Postal code

Response body

New guest

NameTypeRequiredDescription
iduuidtrue

Guest UUID

reference_idstringtrue

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


Request parameters

NameTypeLocationRequiredDescription
guest_iduuidPathtrue

Guest ID

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

Response body

Success

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

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Simulation endpoints can ONLY be used in testing environments

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: 00, 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

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

Accessing fee history requires:

  • explicit consent every 90 days to view fees from the past 90 days
  • explicit consent to view fees older than 90 days (valid for 10 minutes)

NameTypeRequiredDescription
consentobjecttrue

Consent details

consent.idstringtrue

Consent ID

consent.statusstringtrue

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

Accessing fee history requires explicit consent

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

Accessing fee history requires:

  • explicit consent every 90 days to view fees from the past 90 days
  • explicit consent to view fees older than 90 days (valid for 10 minutes)

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

card_idstringfalse

Card ID

amountintegertrue

Transaction amount

currencystringtrue

Transaction currency

exchange_rateuniontrue

Transaction exchange rate. Possible values: decimal, null. Possible values:

payment_amountintegertrue

Transaction payment amount

payment_currencystringtrue

Transaction payment 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

Pending actions

Request parameters

NameTypeLocationRequiredDescription
individual_iduuidQueryfalse

Filter pending actions by individual ID

event_iduuidQueryfalse

Filter pending actions by an associated event ID

completedbooleanQueryfalse

Filter pending actions on whether they have been completed or not

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 pending actions

NameTypeRequiredDescription
dataarraytrue

Array of pending actions

data.idstringtrue

Pending action ID

data.typestringtrue

Type of pending action. Possible values: UploadDocument, AuthenticateCardOperation

data.descriptionstringtrue

Description of pending action

data.payloadobjecttrue

Pending action payload

data.payload.individual_idstringtrue

Individual ID

data.payload.consent_idstringtrue

Consent ID

data.expires_atdate-time-iso8601true

Expiration date time

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

Pending actions not found

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
idstringPathfalse

Pending action ID

Response body

Pending action details

NameTypeRequiredDescription
idstringtrue

Pending action ID

typestringtrue

Type of pending action. Possible values: UploadDocument, AuthenticateCardOperation

descriptionstringtrue

Description of pending action

payloadobjecttrue

Pending action payload

payload.individual_idstringtrue

Individual ID

payload.consent_idstringtrue

Consent ID

expires_atdate-time-iso8601true

Expiration date time

created_atdate-time-iso8601true

Creation date time

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Pending action not found