Integr>te™ API - v3.94.0

Intergiro Indirect API

Headers¶

Name	Type	Required	Description
`Content-Type`	http_content_type_json	true	`application/json` HTTP content type

SESSION¶

Authentication

`POST /auth/login` - Login using API key¶

Request body

API key login form

Name	Type	Required	Description
`api_key`	string	true	API key

Response body

200OK

Successful login

Name	Type	Required	Description
`access_token`	string	true	The access token
`refresh_token`	string	true	The refresh token to use for consequent session renewals

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`POST /auth/refresh` - Exchange refresh token for a new access token¶

Request body

Refresh access token form

Name	Type	Required	Description
`refresh_token`	string	true	Refresh token

Response body

200OK

Successful login

Name	Type	Required	Description
`access_token`	string	true	The access token
`refresh_token`	string	true	The refresh token to use for consequent session renewals

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

INDIVIDUAL¶

Individual user management

`POST /individuals` - Create an Individual user¶

Request body

Individual user creation form

Name	Type	Required	Description
`first_name`	string[0...40]	true	First name
`last_name`	string[0...40]	true	Last name
`date_of_birth`	date-iso8601	true	Date of birth (ISO 8601 'YYYY-MM-DD')
`phone_number`	string	true	Phone number
`email`	email	true	Email address. Max length - 254 chars
`address`	object	false	Address info
`address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`address.street1`	string[0...64]	true	Street line 1
`address.street2`	string[0...64]	false	Street line 2
`address.city`	string[0...64]	true	City
`address.region`	string[0...32]	false	Region
`address.postal_code`	string[0...10]	true	Postal code

Response body

200OK

Individual user details

Name	Type	Required	Description
`id`	string	true	Individual ID
`first_name`	string	true	First name
`last_name`	string	true	Last name
`date_of_birth`	date-iso8601	true	Date of birth (ISO 8601 'YYYY-MM-DD')
`phone_number`	string	true	Phone number
`email`	email	true	Email address
`status`	string	true	Status. Possible values: `pending_activation`, `onboarding_requested`, `onboarding_data_provided`, `activated`, `blocked`
`address`	object	false	Address info
`address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`address.street1`	string	true	Street line 1
`address.street2`	string	false	Street line 2
`address.city`	string	true	City
`address.region`	string	false	Region
`address.postal_code`	string	true	Postal code

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`GET /individuals` - Returns all Individuals accessible in the request scope¶

Request parameters

Name	Type	Location	Required	Description
`limit`	integer[1...100]	Query	false	A limit on the number of objects to be returned. Default: `10`
`sort_type`	string	Query	false	Sort type. Possible values: `ASC`, `DESC`. Default: `DESC`
`starting_after`	uuid	Query	false	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_before`	uuid	Query	false	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

200OK

Individuals list

Name	Type	Required	Description
`data`	array	true	Individual users
`data.id`	string	true	Individual ID
`data.first_name`	string	true	First name
`data.last_name`	string	true	Last name
`data.email`	email	true	Email address
`data.phone_number`	string	true	Phone number
`data.status`	string	true	Status. Possible values: `pending_activation`, `onboarding_requested`, `onboarding_data_provided`, `activated`, `blocked`
`has_more`	boolean	true	A flag that shows whether there are more items to return

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`GET /individuals/:id` - Returns Individual details by ID¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Individual ID

Response body

200OK

Individual details

Name	Type	Required	Description
`id`	string	true	Individual ID
`first_name`	string	true	First name
`last_name`	string	true	Last name
`date_of_birth`	date-iso8601	true	Date of birth (ISO 8601 'YYYY-MM-DD')
`phone_number`	string	true	Phone number
`email`	email	true	Email address
`status`	string	true	Status. Possible values: `pending_activation`, `onboarding_requested`, `onboarding_data_provided`, `activated`, `blocked`
`address`	object	false	Address info
`address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`address.street1`	string	true	Street line 1
`address.street2`	string	false	Street line 2
`address.city`	string	true	City
`address.region`	string	false	Region
`address.postal_code`	string	true	Postal code

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Individual not found

`POST /individuals/:id/onboard` - Start Individual onboarding process¶

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

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Individual ID

Request body

Individual user start onboarding flow form

Name	Type	Required	Description
`return_url`	string[0...255]	false	The URL to redirect customer back to after they finish onboarding

Response body

200OK

Onboarding link and expiration time

Name	Type	Required	Description
`redirect_url`	string	true	The URL you must use to redirect the customer to in order to proceed with onboarding
`expires_at`	string	true	URL expiration time

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Individual not found

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`PATCH /individuals/:id` - Update Individual data¶SCAUpdating data requires explicit consent for Activated individual.

Updating data requires explicit consent for Activated individual.

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Individual ID

Request body

Individual update form

Name	Type	Required	Description
`update`	union	true	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

Name	Type	Required	Description
`update.type`	string	true	Type of update. Possible values: `email`
`update.email`	string	true	New individual email. Max length - 254 chars

Individual update form phone number

Individual update form for phone number

Name	Type	Required	Description
`update.type`	string	true	Type of update. Possible values: `phone_number`
`update.phone_number`	string	true	New individual phone number

Response body

200OK

Individual user details

Name	Type	Required	Description
`id`	string	true	Individual ID
`first_name`	string	true	First name
`last_name`	string	true	Last name
`date_of_birth`	date-iso8601	true	Date of birth (ISO 8601 'YYYY-MM-DD')
`phone_number`	string	true	Phone number
`email`	email	true	Email address
`status`	string	true	Status. Possible values: `pending_activation`, `onboarding_requested`, `onboarding_data_provided`, `activated`, `blocked`
`address`	object	false	Address info
`address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`address.street1`	string	true	Street line 1
`address.street2`	string	false	Street line 2
`address.city`	string	true	City
`address.region`	string	false	Region
`address.postal_code`	string	true	Postal code

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Individual not found

412Consent required

Individual update requires explicit consent

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

CONSENT¶

Consents

`GET /consents/:id` - Get a single Individual's consent by id¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Consent ID

Response body

200OK

List of approvals

Name	Type	Required	Description
`id`	string	true	Consent ID
`individual_id`	string	true	Individual ID
`status`	string	true	Consent status. Possible values: `pending`, `requested`, `approved`, `rejected`, `abandoned`
`expires_at`	union	true	Deprecated. The Consent expiration time field has been deprecated, and while it is still included in the response, it has a fixed and singular value `expires_at: null`
`scope`	[string]	true	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`, `charge_payment_method`, `update_individual_phone_number`, `update_individual_email`, `apple_pay_tokenize`, `apple_pay_wallet_extension_tokenize`, `google_pay_tokenize`, `authenticate_card_operation`, `identity_verification`, `proof_of_address_verification`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Event not found

`GET /consents` - Get list of Individual's consents¶

Request parameters

Name	Type	Location	Required	Description
`limit`	integer[1...100]	Query	false	A limit on the number of objects to be returned. Default: `10`
`sort_type`	string	Query	false	Sort type. Possible values: `ASC`, `DESC`. Default: `DESC`
`starting_after`	uuid	Query	false	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_before`	uuid	Query	false	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_id`	uuid	Query	false	Individual ID
`statuses`	[string]	Query	false	Filter by consent status(es). Possible values: `pending`, `requested`, `approved`, `rejected`, `abandoned`

Response body

200OK

List of approvals

Name	Type	Required	Description
`data`	array	true	Consent details
`data.id`	string	true	Consent ID
`data.individual_id`	string	true	Individual ID
`data.status`	string	true	Consent status. Possible values: `pending`, `requested`, `approved`, `rejected`, `abandoned`
`data.expires_at`	union	true	Deprecated. The Consent expiration time field has been deprecated, and while it is still included in the response, it has a fixed and singular value `expires_at: null`
`data.scope`	[string]	true	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`, `charge_payment_method`, `update_individual_phone_number`, `update_individual_email`, `apple_pay_tokenize`, `apple_pay_wallet_extension_tokenize`, `google_pay_tokenize`, `authenticate_card_operation`, `identity_verification`, `proof_of_address_verification`
`has_more`	boolean	true	A flag that shows whether there are more items to return

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

`POST /consents` - Request consent for specified scope¶

Request body

Request consent params

Name	Type	Required	Description
`individual_id`	uuid	true	Individual ID
`scope`	[string]	true	Scope for requested consent. Possible values: `view_balance`, `view_payment_history`
`return_url`	string[0...255]	false	URL for redirect after consent is completed

Response body

200OK

Requested consent method

Name	Type	Required	Description
`method`	object	true	Instructions on how to proceed with consent request
`method.redirect_url`	string	true	Consent URL. `language` optional query parameter can be added to the URL and will define the language of the flow The query parameter value should be of ISO 639-1 language code and be enabled for your account on Intergiro side.
`method.expires_at`	string	true	Consent URL expiration time
`method.token`	string	false	Ephemeral token

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /consents/:id` - Request consent by id¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Consent ID

Request body

Request consent params

Name	Type	Required	Description
`return_url`	string[0...255]	false	URL for redirect after consent is completed

Response body

200OK

Requested consent method

Name	Type	Required	Description
`method`	object	true	Instructions on how to proceed with consent request
`method.redirect_url`	string	true	Consent URL. `language` optional query parameter can be added to the URL and will define the language of the flow The query parameter value should be of ISO 639-1 language code and be enabled for your account on Intergiro side.
`method.expires_at`	string	true	Consent URL expiration time
`method.token`	string	false	Ephemeral token

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

EVENT¶

Events

`GET /events` - Returns all Events¶

Request parameters

Name	Type	Location	Required	Description
`names`	[string]	Query	false	Filter by event name(s). Possible values: `AuthorizationCompleted`, `AuthorizationDeclined`, `IndividualOnboardingDataProvided`, `IndividualActivated`, `IndividualBlocked`, `TransactionCreated`, `TransactionStatusChanged`, `IndividualEmailChanged`, `IndividualPhoneNumberChanged`, `IndividualNameChanged`, `IndividualDateOfBirthChanged`, `IndividualAddressChanged`, `CardStatusChanged`, `CardIssued`, `PendingActionCreated`, `PendingActionCompleted`, `TransactionConsentRejected`, `TokenizedCardNotUsedApplePay`
`limit`	integer[1...100]	Query	false	A limit on the number of objects to be returned. Default: `10`
`sort_type`	string	Query	false	Sort type. Possible values: `ASC`, `DESC`. Default: `DESC`
`starting_after`	uuid	Query	false	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_before`	uuid	Query	false	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

200OK

Events list

Name	Type	Required	Description
`data`	array	true	Events
`data.id`	string	true	Event ID
`data.name`	string	true	Name. Possible values: `AuthorizationCompleted`, `AuthorizationDeclined`, `IndividualOnboardingDataProvided`, `IndividualActivated`, `IndividualBlocked`, `TransactionCreated`, `TransactionStatusChanged`, `IndividualEmailChanged`, `IndividualPhoneNumberChanged`, `IndividualNameChanged`, `IndividualDateOfBirthChanged`, `IndividualAddressChanged`, `CardStatusChanged`, `CardIssued`, `PendingActionCreated`, `PendingActionCompleted`, `TransactionConsentRejected`, `TokenizedCardNotUsedApplePay`
`data.payload`	union	true	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, Card issued payload, Pending action event payload, Transaction consent rejected event payload, Tokenized card not used apple pay payload
`data.created_at`	date-time-iso8601	true	Creation date time
`has_more`	boolean	true	A flag that shows whether there are more items to return

Authorization completed event payload

Transaction authorization completed event payload

Name	Type	Required	Description
`data.payload.authorization_id`	string	true	Authorization ID
`data.payload.transaction_id`	string	true	Successful transaction ID created within authorization process
`data.payload.individual_id`	string	true	Individual ID

Authorization failed event payload

Transaction authorization failed event payload

Name	Type	Required	Description
`data.payload.authorization_id`	string	true	Authorization ID
`data.payload.transaction_id`	string	true	Failed transaction ID created within authorization process
`data.payload.individual_id`	string	true	Individual ID

Individual status updated event payload

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

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID

Transaction event payload

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

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.transaction_id`	string	true	Transaction ID
`data.payload.request_id`	union	false	Request ID
`data.payload.status`	string	true	Status
`data.payload.amount`	integer	true	Amount in minor currency units
`data.payload.currency`	string	true	Currency
`data.payload.account_id`	string	true	Account ID
`data.payload.counterparty_account_id`	string	true	Counterparty account ID
`data.payload.type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`, `fee`
`data.payload.subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`data.payload.merchant`	object	false	Merchant details
`data.payload.merchant.category`	string	true	Merchant category
`data.payload.merchant.category_code`	string	true	Merchant category code

Individual email updated event payload

Individual updated event payload. Applicable for: IndividualEmailChanged events

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.email`	string	true	Individual email

Individual phone number updated event payload

Individual updated event payload. Applicable for: IndividualPhoneNumberChanged events

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.phone_number`	string	true	Individual phone number

Individual name updated event payload

Individual updated event payload. Applicable for: IndividualNameChanged events

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.first_name`	string	false	Individual first name
`data.payload.last_name`	string	false	Individual last name

Individual date of birth updated event payload

Individual updated event payload. Applicable for: IndividualDateOfBirthChanged events

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.date_of_birth`	string	true	Individual date of birth

Individual address updated event payload

Individual updated event payload. Applicable for: IndividualAddressChanged events

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.city`	union	false	Individual city
`data.payload.country_code`	union	false	Individual country code
`data.payload.postal_code`	union	false	Individual postal code
`data.payload.region`	union	false	Individual region
`data.payload.street1`	union	false	Individual street1
`data.payload.street2`	union	false	Individual street2

Card status changed payload

Card status changed event payload. Applicable for: CardStatusChanged events

Name	Type	Required	Description
`data.payload.card_id`	string	true	Card ID
`data.payload.status`	string	true	Updated card status. Possible values: `active`, `not_activated`, `frozen`, `blocked`, `closed`, `stolen`, `lost`, `fraud`, `expired`, `security_block`

Card issued payload

Card issued event payload. Applicable for: CardIssued events

Name	Type	Required	Description
`data.payload.card_id`	string	true	Card ID

Pending action event payload

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.pending_action_id`	string	true	Pending action ID
`data.payload.type`	string	true	Type of pending action. Possible values: `AuthenticateCardOperation`, `IdentityVerification`, `ProofOfAddressVerification`

Transaction consent rejected event payload

Transaction consent rejected event payload. Applicable for: TransactionConsentRejected events

Name	Type	Required	Description
`data.payload.consent_id`	string	true	Consent ID
`data.payload.individual_id`	string	true	Individual ID
`data.payload.request_id`	string	true	Request ID
`data.payload.amount`	integer	true	Amount in minor currency units
`data.payload.currency`	string	true	Currency
`data.payload.account_id`	string	true	Account ID

Tokenized card not used apple pay payload

Apple Pay Tokenized card not used payload. Applicable for: TokenizedCardNotUsedApplePay events

Name	Type	Required	Description
`data.payload.individual_id`	string	true	Individual ID
`data.payload.card_id`	string	true	Card ID
`data.payload.period_of_days`	number	true	Period of days. Possible values: `7`, `14`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`GET /events/:id` - Returns Event details by ID¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Event ID

Response body

200OK

Event details

Name	Type	Required	Description
`id`	string	true	Event ID
`name`	string	true	Name. Possible values: `AuthorizationCompleted`, `AuthorizationDeclined`, `IndividualOnboardingDataProvided`, `IndividualActivated`, `IndividualBlocked`, `TransactionCreated`, `TransactionStatusChanged`, `IndividualEmailChanged`, `IndividualPhoneNumberChanged`, `IndividualNameChanged`, `IndividualDateOfBirthChanged`, `IndividualAddressChanged`, `CardStatusChanged`, `CardIssued`, `PendingActionCreated`, `PendingActionCompleted`, `TransactionConsentRejected`, `TokenizedCardNotUsedApplePay`
`payload`	union	true	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, Card issued payload, Pending action event payload, Transaction consent rejected event payload, Tokenized card not used apple pay payload
`created_at`	date-time-iso8601	true	Creation date time

Authorization completed event payload

Transaction authorization completed event payload

Name	Type	Required	Description
`payload.authorization_id`	string	true	Authorization ID
`payload.transaction_id`	string	true	Successful transaction ID created within authorization process
`payload.individual_id`	string	true	Individual ID

Authorization failed event payload

Transaction authorization failed event payload

Name	Type	Required	Description
`payload.authorization_id`	string	true	Authorization ID
`payload.transaction_id`	string	true	Failed transaction ID created within authorization process
`payload.individual_id`	string	true	Individual ID

Individual status updated event payload

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

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID

Transaction event payload

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

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.transaction_id`	string	true	Transaction ID
`payload.request_id`	union	false	Request ID
`payload.status`	string	true	Status
`payload.amount`	integer	true	Amount in minor currency units
`payload.currency`	string	true	Currency
`payload.account_id`	string	true	Account ID
`payload.counterparty_account_id`	string	true	Counterparty account ID
`payload.type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`, `fee`
`payload.subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`payload.merchant`	object	false	Merchant details
`payload.merchant.category`	string	true	Merchant category
`payload.merchant.category_code`	string	true	Merchant category code

Individual email updated event payload

Individual updated event payload. Applicable for: IndividualEmailChanged events

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.email`	string	true	Individual email

Individual phone number updated event payload

Individual updated event payload. Applicable for: IndividualPhoneNumberChanged events

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.phone_number`	string	true	Individual phone number

Individual name updated event payload

Individual updated event payload. Applicable for: IndividualNameChanged events

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.first_name`	string	false	Individual first name
`payload.last_name`	string	false	Individual last name

Individual date of birth updated event payload

Individual updated event payload. Applicable for: IndividualDateOfBirthChanged events

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.date_of_birth`	string	true	Individual date of birth

Individual address updated event payload

Individual updated event payload. Applicable for: IndividualAddressChanged events

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.city`	union	false	Individual city
`payload.country_code`	union	false	Individual country code
`payload.postal_code`	union	false	Individual postal code
`payload.region`	union	false	Individual region
`payload.street1`	union	false	Individual street1
`payload.street2`	union	false	Individual street2

Card status changed payload

Card status changed event payload. Applicable for: CardStatusChanged events

Name	Type	Required	Description
`payload.card_id`	string	true	Card ID
`payload.status`	string	true	Updated card status. Possible values: `active`, `not_activated`, `frozen`, `blocked`, `closed`, `stolen`, `lost`, `fraud`, `expired`, `security_block`

Card issued payload

Card issued event payload. Applicable for: CardIssued events

Name	Type	Required	Description
`payload.card_id`	string	true	Card ID

Pending action event payload

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.pending_action_id`	string	true	Pending action ID
`payload.type`	string	true	Type of pending action. Possible values: `AuthenticateCardOperation`, `IdentityVerification`, `ProofOfAddressVerification`

Transaction consent rejected event payload

Transaction consent rejected event payload. Applicable for: TransactionConsentRejected events

Name	Type	Required	Description
`payload.consent_id`	string	true	Consent ID
`payload.individual_id`	string	true	Individual ID
`payload.request_id`	string	true	Request ID
`payload.amount`	integer	true	Amount in minor currency units
`payload.currency`	string	true	Currency
`payload.account_id`	string	true	Account ID

Tokenized card not used apple pay payload

Apple Pay Tokenized card not used payload. Applicable for: TokenizedCardNotUsedApplePay events

Name	Type	Required	Description
`payload.individual_id`	string	true	Individual ID
`payload.card_id`	string	true	Card ID
`payload.period_of_days`	number	true	Period of days. Possible values: `7`, `14`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Event not found

WEBHOOK¶

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

`GET /webhooks` - Returns all Webhooks¶

Response body

200OK

Webhooks list

Name	Type	Required	Description
`id`	string	true	Webhook ID
`url`	string	true	Webhook URL
`created_at`	date-time-iso8601	true	Creation timestamp

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`POST /webhooks` - Create new webhook¶

Request body

Create webhook

Name	Type	Required	Description
`url`	string[0...255]	true	Webhook URL. Must have HTTPS protocol and hostname for host part

Response body

200OK

Webhook details

Name	Type	Required	Description
`id`	string	true	Webhook ID
`url`	string	true	Webhook URL
`created_at`	date-time-iso8601	true	Creation timestamp

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`DELETE /webhooks/:id` - Delete a webhook¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Webhook ID

Response body

200OK

Webhook is deleted

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Webhook not found

ACCOUNT¶

Payment accounts

`GET /accounts/:id` - Returns payment account by ID¶SCAAccessing the balance of one or more designated payment accounts for the first time requires Strong Customer Authentication

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

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Payment account ID

Response body

200OK

Payment account

Name	Type	Required	Description
`id`	string	true	Account ID
`name`	string	true	Account name
`currency`	string	true	Account currency
`balance`	integer	true	Account balance in minor currency units
`created_at`	date-time-iso8601	true	Creation date time
`type`	string	true	Account type. Possible values: `current`, `prefunded`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Payment account not found

412Consent required

Individual needs to confirm consent before access to data

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`GET /accounts` - Returns list of payment accounts¶SCAAccessing the balance of one or more designated payment accounts for the first time requires Strong Customer Authentication

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

Request parameters

Name	Type	Location	Required	Description
`individual_id`	uuid	Query	true	Valid Individual ID. Filter accounts owned by the provided Individual

Response body

200OK

List of payment accounts

Name	Type	Required	Description
`data`	array	true	Payment accounts
`data.id`	string	true	Account ID
`data.name`	string	true	Account name
`data.currency`	string	true	Account currency
`data.balance`	integer	true	Account balance in minor currency units
`data.created_at`	date-time-iso8601	true	Creation date time
`data.type`	string	true	Account type. Possible values: `current`, `prefunded`
`has_more`	boolean	true	A flag that shows whether there are more items to return

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

412Consent required

Individual needs to confirm consent before access to data

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`GET /accounts/:id/bank_details` - Returns payment account details by ID¶

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Payment account ID

Response body

200OK

Payment account details

Name	Type	Required	Description
`payment_rail`	string	true	Payment rail. Possible values: `uk_local`, `sepa`, `swift`
`details`	union	true	Account number and bank code. Possible values: Account details uk local, Account details iban
`beneficiary`	string	true	Beneficiary name
`beneficiary_address`	object	true	Beneficiary address
`beneficiary_address.street1`	string	true	Line 1 of the beneficiary’s address
`beneficiary_address.street2`	string	false	Line 2 of the beneficiary’s address
`beneficiary_address.city`	string	true	City
`beneficiary_address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`beneficiary_address.post_code`	string	true	Postal code

Account details uk local

UK local account details

Name	Type	Required	Description
`details.account_no`	string	true	UK account number
`details.sort_code`	string	true	UK bank sort code

Account details iban

Account details in IBAN format

Name	Type	Required	Description
`details.iban`	string	true	IBAN
`details.bic`	string	true	BIC

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Payment account not found

`POST /accounts` - Create payment account for individual¶

Request body

Payment account for individual creation form

Name	Type	Required	Description
`individual_id`	uuid	true	Individual ID
`type`	string	false	Account type. Possible values: `current`, `prefunded`

Response body

200OK

Payment account

Name	Type	Required	Description
`id`	string	true	Account ID
`name`	string	true	Account name
`currency`	string	true	Account currency
`balance`	integer	true	Account balance in minor currency units
`created_at`	date-time-iso8601	true	Creation date time
`type`	string	true	Account type. Possible values: `current`, `prefunded`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

CARD¶

Cards

`POST /cards` - Order card ¶

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

Name	Type	Required	Description
`individual_id`	uuid	true	Associated individual user id
`account_id`	string	true	Associated card account id
`design_id`	string[10]	false	Card design id
`display_name`	string	false	Card display name. Max length - 50 chars
`exp_month`	string	true	Card expiry month
`exp_year`	string	true	Card expiry year
`type`	string	true	Card type. Possible values: `virtual`, `physical`
`delivery_address`	object	false	Where to deliver the card
`delivery_address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`delivery_address.street1`	string	true	Street line 1. Max length - 253 chars combined with street2 field
`delivery_address.street2`	string	false	Street line 2. Max length - 253 chars combined with street1 field
`delivery_address.city`	string	true	City. Max length - 40 chars
`delivery_address.region`	string	false	Region. Max length - 32 chars
`delivery_address.postal_code`	string	true	Postal code. Max length - 10 chars

Response body

200OK

New card

Name	Type	Required	Description
`id`	string	true	Card id
`design_id`	string	true	Card design id
`display_name`	union	true	Card display name
`type`	string	true	Card type. Possible values: `virtual`, `physical`
`brand`	string	true	Card brand. Possible values: `visa`
`region`	string	true	Card region. Possible values: `europe`
`exp_month`	string	true	Card expiry month
`exp_year`	string	true	Card expiry year
`last4`	string	true	Card last four digits
`currency`	string	true	Card main currency
`account_id`	string	true	Associated payment account id
`individual_id`	string	true	Associated individual user id
`status`	string	true	Card status. Possible values: `active`, `not_activated`, `frozen`, `blocked`, `closed`, `stolen`, `lost`, `fraud`, `expired`, `security_block`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`GET /cards` - List of cards¶

Request parameters

Name	Type	Location	Required	Description
`individual_id`	uuid	Query	false	Individual id. Use it for filter by individual id
`limit`	integer[1...100]	Query	false	A limit on the number of objects to be returned. Default: `10`
`sort_type`	string	Query	false	Sort type. Possible values: `ASC`, `DESC`. Default: `DESC`
`account_id`	string	Query	false	Payment account id. Use it for filter by account id
`starting_after`	uuid	Query	false	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_before`	uuid	Query	false	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

200OK

List of cards

Name	Type	Required	Description
`data`	array	true	List of cards
`data.id`	string	true	Card id
`data.design_id`	string	true	Card design id
`data.display_name`	union	true	Card display name
`data.type`	string	true	Card type. Possible values: `virtual`, `physical`
`data.brand`	string	true	Card brand. Possible values: `visa`
`data.region`	string	true	Card region. Possible values: `europe`
`data.exp_month`	string	true	Card expiry month
`data.exp_year`	string	true	Card expiry year
`data.last4`	string	true	Card last four digits
`data.currency`	string	true	Card main currency
`data.account_id`	string	true	Associated payment account id
`data.individual_id`	string	true	Associated individual user id
`data.status`	string	true	Card status. Possible values: `active`, `not_activated`, `frozen`, `blocked`, `closed`, `stolen`, `lost`, `fraud`, `expired`, `security_block`
`has_more`	boolean	true	A flag that shows whether there are more items to return

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`GET /cards/:id` - View card¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Card id

Response body

200OK

Card details

Name	Type	Required	Description
`id`	string	true	Card id
`design_id`	string	true	Card design id
`display_name`	union	true	Card display name
`type`	string	true	Card type. Possible values: `virtual`, `physical`
`brand`	string	true	Card brand. Possible values: `visa`
`region`	string	true	Card region. Possible values: `europe`
`exp_month`	string	true	Card expiry month
`exp_year`	string	true	Card expiry year
`last4`	string	true	Card last four digits
`currency`	string	true	Card main currency
`account_id`	string	true	Associated payment account id
`individual_id`	string	true	Associated individual user id
`status`	string	true	Card status. Possible values: `active`, `not_activated`, `frozen`, `blocked`, `closed`, `stolen`, `lost`, `fraud`, `expired`, `security_block`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Card not found

`GET /cards/:id/credentials` - View card credentials¶SCAAccessing card credentials requires explicit consent

Accessing card credentials requires explicit consent

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Card id

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Card not found

412Consent required

Individual needs to confirm consent before access to data

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

`POST /cards/:id/activate` - Activate card¶SCAActivating the card requires explicit consent

Activating the card requires explicit consent

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Card id

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Card not found

412Consent required

Individual needs to confirm consent before activating the card

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`PUT /cards/:id/pin` - Reset card PIN¶SCACard PIN reset requires explicit consent

Card PIN reset requires explicit consent

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Card id

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Card not found

412Consent required

Card PIN reset requires explicit consent

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`PATCH /cards/:id` - Update card¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Card id

Request body

Card update form

Name	Type	Required	Description
`status`	string	false	Card status. Possible values: `frozen`, `blocked`, `stolen`, `lost`, `fraud`, `not_activated`, `security_block`
`account_id`	string	false	Associated payment account id

Response body

200OK

Update card

Name	Type	Required	Description
`id`	string	true	Card id
`design_id`	string	true	Card design id
`display_name`	union	true	Card display name
`type`	string	true	Card type. Possible values: `virtual`, `physical`
`brand`	string	true	Card brand. Possible values: `visa`
`region`	string	true	Card region. Possible values: `europe`
`exp_month`	string	true	Card expiry month
`exp_year`	string	true	Card expiry year
`last4`	string	true	Card last four digits
`currency`	string	true	Card main currency
`account_id`	string	true	Associated payment account id
`individual_id`	string	true	Associated individual user id
`status`	string	true	Card status. Possible values: `active`, `not_activated`, `frozen`, `blocked`, `closed`, `stolen`, `lost`, `fraud`, `expired`, `security_block`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Card not found

`POST /cards/:id/apple_pay/tokenize` - Apple Pay tokenization¶SCATokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

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

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Card id

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Card not found

412Consent required

Individual needs to confirm consent before tokenizing the card

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /cards/apple_pay/wallet_extension_tokenize` - Apple Pay Wallet extension tokenization¶SCATokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

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

Request body

Apple Pay Wallet extension tokenization

Name	Type	Required	Description
`individual_id`	uuid	true	Individual ID

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Individual not found

412Consent required

Individual needs to confirm consent before tokenizing the card

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /cards/:id/google_pay/tokenize` - Google Pay tokenization (in closed beta)¶SCATokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

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

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Card id

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Card not found

412Consent required

Individual needs to confirm consent before tokenizing the card

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

INDIVIDUAL_PAYMENT_METHOD¶

Individual payment methods

Request parameters

Name	Type	Location	Required	Description
`individual_id`	uuid	Query	true	Valid Individual ID. Filter payment methods belonging to specific Individual

`GET /individuals/:individual_id/payment_methods` - List payment methods¶

Response body

200OK

Array of Payment method objects

Name	Type	Required	Description
`data`	array	true	List of payment methods
`data.id`	uuid	true	Payment method ID
`data.type`	string	true	Payment method type. Possible values: `card`
`data.details`	union	true	Payment method details. Possible values: Payment method details card
`data.created_at`	date-time-iso8601	true	Creation date time
`has_more`	boolean	true	A flag that shows whether there are more items to return

Payment method details card

Card payment method details

Name	Type	Required	Description
`data.details.brand`	string	true	Card brand. Possible values: `visa`, `mastercard`
`data.details.exp_month`	string	true	Card expiry month
`data.details.exp_year`	string	true	Card expiry year
`data.details.last4`	string	true	Card last four digits

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`POST /individuals/:individual_id/payment_methods` - Add new payment method¶

Request body

New payment method request body

Name	Type	Required	Description
`charge`	object	false	Charge details
`charge.amount`	integer	true	Amount to charge in minor currency units
`charge.currency`	string	false	Charge currency. Possible values: `EUR`. Default: `EUR`
`charge.account_id`	string	true	Individual destination account ID
`type`	string	false	Type of payment method to add. Possible values: `card`. Default: `card`

Response body

200OK

Array of Payment method objects

Name	Type	Required	Description
`id`	uuid	true	Payment method ID
`type`	string	true	Payment method type. Possible values: `card`
`details`	union	true	Payment method details. Possible values: Payment method details card
`created_at`	date-time-iso8601	true	Creation date time

Payment method details card

Card payment method details

Name	Type	Required	Description
`details.brand`	string	true	Card brand. Possible values: `visa`, `mastercard`
`details.exp_month`	string	true	Card expiry month
`details.exp_year`	string	true	Card expiry year
`details.last4`	string	true	Card last four digits

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Individual or account not found

412Verification required

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

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /individuals/:individual_id/payment_methods/:id/charge` - Charge payment method¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Payment method ID

Request body

Charge payment method request body

Name	Type	Required	Description
`amount`	integer	true	Amount to charge in minor currency units
`currency`	string	false	Charge currency. Possible values: `EUR`. Default: `EUR`
`account_id`	string	true	Individual destination account ID

Response body

200OK

Transaction details

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

412Verification required

CVC verification is required

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`DELETE /individuals/:individual_id/payment_methods/:id` - Delete payment method¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Payment method ID

Response body

200OK

Success

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Not found

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

TRANSACTION¶

Transactions

`GET /transactions` - List transactions¶SCAAccessing payment history requires explicit consent

Accessing payment history requires explicit consent

Request parameters

Name	Type	Location	Required	Description
`limit`	integer[1...100]	Query	false	A limit on the number of objects to be returned. Default: `10`
`sort_type`	string	Query	false	Sort type. Possible values: `ASC`, `DESC`
`starting_after`	string	Query	false	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_before`	string	Query	false	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_from`	string	Query	false	Get transactions from date. Accepts date or date-time
`created_to`	string	Query	false	Get transactions before date. Accepts date or date-time
`account_id`	string	Query	false	Filter transactions by account id
`card_id`	uuid	Query	false	Filter transactions by card id
`individual_id`	uuid	Query	false	Valid Individual ID. Filter accounts owned by the provided Individual

Response body

200OK

Transactions list

Name	Type	Required	Description
`data`	array	true	Transactions
`data.id`	string	true	Transaction id
`data.request_id`	string	false	Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error
`data.type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`
`data.subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`data.amount`	integer	true	Transaction amount in minor currency units
`data.currency`	string	true	Transaction currency
`data.exchange_rate`	union	true	Transaction exchange rate. Possible values: `decimal`, `null`
`data.payment_amount`	integer	true	Transaction payment amount in minor currency units
`data.payment_currency`	string	true	Transaction payment currency
`data.status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`
`data.account_id`	string	true	Associated account id
`data.reference`	string	true	Payment details
`data.merchant`	object	false	Merchant details
`data.merchant.name`	string	true	Merchant name
`data.merchant.location`	string	true	Location
`data.merchant.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`data.merchant.category`	string	true	Merchant category
`data.merchant.category_code`	string	true	Merchant category code
`data.counterparty`	object	false	Counterparty
`data.counterparty.name`	string	true	Counterparty name
`data.counterparty.account_id`	string	true	Associated account id
`data.counterparty.account_details`	union	true	Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details
`data.card`	object	false	Card details
`data.card.card_number`	string	true	Card number
`data.card.first_name`	string	true	Cardholder first name
`data.card.last_name`	string	true	Cardholder last name
`data.card_id`	string	false	Card id
`data.created_at`	date-time-iso8601	true	Creation date time
`has_more`	boolean	true	A flag that shows whether there are more items to return

Sepa transaction account details

SEPA account details

Name	Type	Required	Description
`data.counterparty.account_details.type`	string	true	SEPA account type. Possible values: `sepa`
`data.counterparty.account_details.iban`	string	true	IBAN

Uk local transaction account details

UK local account details

Name	Type	Required	Description
`data.counterparty.account_details.type`	string	true	UK local account type. Possible values: `uk-local`
`data.counterparty.account_details.number`	string	true	UK local account number

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

412Consent required

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)

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`GET /transactions/:id` - Get transaction details by ID¶SCAAccessing payment history requires explicit consent

Accessing payment history requires explicit consent

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Transaction ID

Response body

200OK

Transaction details

Name	Type	Required	Description
`id`	string	true	Transaction id
`request_id`	string	false	Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error
`type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`
`subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`amount`	integer	true	Transaction amount in minor currency units
`currency`	string	true	Transaction currency
`exchange_rate`	union	true	Transaction exchange rate. Possible values: `decimal`, `null`
`payment_amount`	integer	true	Transaction payment amount in minor currency units
`payment_currency`	string	true	Transaction payment currency
`status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`
`account_id`	string	true	Associated account id
`reference`	string	true	Payment details
`merchant`	object	false	Merchant details
`merchant.name`	string	true	Merchant name
`merchant.location`	string	true	Location
`merchant.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`merchant.category`	string	true	Merchant category
`merchant.category_code`	string	true	Merchant category code
`counterparty`	object	false	Counterparty
`counterparty.name`	string	true	Counterparty name
`counterparty.account_id`	string	true	Associated account id
`counterparty.account_details`	union	true	Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details
`card`	object	false	Card details
`card.card_number`	string	true	Card number
`card.first_name`	string	true	Cardholder first name
`card.last_name`	string	true	Cardholder last name
`card_id`	string	false	Card id
`created_at`	date-time-iso8601	true	Creation date time

Sepa transaction account details

SEPA account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	SEPA account type. Possible values: `sepa`
`counterparty.account_details.iban`	string	true	IBAN

Uk local transaction account details

UK local account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	UK local account type. Possible values: `uk-local`
`counterparty.account_details.number`	string	true	UK local account number

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Transaction not found

412Consent required

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)

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /transactions/move` - Transfer money between own accounts¶

Request body

Make transfer request

Name	Type	Required	Description
`request_id`	string	true	Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error
`source_account_id`	string	true	Source account id
`target_account_id`	string	true	Target account id
`amount`	integer	true	Transfer amount in minor currency units
`reference`	string	true	Payment details. Max length - 140 chars. Letters, numbers, empty spaces, and following symbols: `?:()/.,+-` are allowed

Response body

200OK

Transaction info

Name	Type	Required	Description
`id`	string	true	Transaction id
`request_id`	string	false	Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error
`type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`
`subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`amount`	integer	true	Transaction amount in minor currency units
`currency`	string	true	Transaction currency
`exchange_rate`	union	true	Transaction exchange rate. Possible values: `decimal`, `null`
`payment_amount`	integer	true	Transaction payment amount in minor currency units
`payment_currency`	string	true	Transaction payment currency
`status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`
`account_id`	string	true	Associated account id
`reference`	string	true	Payment details
`merchant`	object	false	Merchant details
`merchant.name`	string	true	Merchant name
`merchant.location`	string	true	Location
`merchant.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`merchant.category`	string	true	Merchant category
`merchant.category_code`	string	true	Merchant category code
`counterparty`	object	false	Counterparty
`counterparty.name`	string	true	Counterparty name
`counterparty.account_id`	string	true	Associated account id
`counterparty.account_details`	union	true	Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details
`card`	object	false	Card details
`card.card_number`	string	true	Card number
`card.first_name`	string	true	Cardholder first name
`card.last_name`	string	true	Cardholder last name
`card_id`	string	false	Card id
`created_at`	date-time-iso8601	true	Creation date time

Sepa transaction account details

SEPA account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	SEPA account type. Possible values: `sepa`
`counterparty.account_details.iban`	string	true	IBAN

Uk local transaction account details

UK local account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	UK local account type. Possible values: `uk-local`
`counterparty.account_details.number`	string	true	UK local account number

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`POST /transactions/pay` - Send money to external beneficiaries¶SCAMaking online payments requires Strong Customer Authentication

Making online payments requires Strong Customer Authentication

Request body

Sepa payment request

Name	Type	Required	Description
`request_id`	string	true	Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error
`account_id`	string	true	Source account id
`counterparty`	union	true	Counterparty details. Possible values: Sepa payment request counterparty with account id, Sepa payment request counterparty with account details
`amount`	integer	true	Transfer amount in minor currency units
`reference`	string	true	Payment details. Max length - 140 chars. Letters, numbers, empty spaces, and following symbols: `?:()/.,+-` are allowed

Sepa payment request counterparty with account id

Counterparty details

Name	Type	Required	Description
`counterparty.name`	string	true	Name of the receiving counterparty. Max length - 70 chars. Letters, numbers, empty spaces, and following symbols: `?:()/.,+-` are allowed
`counterparty.account_id`	string	true	Receiving counterparty's account id

Sepa payment request counterparty with account details

Counterparty details

Name	Type	Required	Description
`counterparty.name`	string	true	Name of the receiving counterparty. Max length - 70 chars. Letters, numbers, empty spaces, and following symbols: `?:()/.,+-` are allowed
`counterparty.account`	object	true	Receiving counterparty's account details
`counterparty.account.iban`	string	true	IBAN
`counterparty.account.bic`	string	true	BIC

Response body

200OK

Transaction

Name	Type	Required	Description
`id`	string	true	Transaction id
`request_id`	string	false	Provide the unique ID, which is used to handle duplicate transfer requests in case of a lost connection or client error
`type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`
`subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`amount`	integer	true	Transaction amount in minor currency units
`currency`	string	true	Transaction currency
`exchange_rate`	union	true	Transaction exchange rate. Possible values: `decimal`, `null`
`payment_amount`	integer	true	Transaction payment amount in minor currency units
`payment_currency`	string	true	Transaction payment currency
`status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`
`account_id`	string	true	Associated account id
`reference`	string	true	Payment details
`merchant`	object	false	Merchant details
`merchant.name`	string	true	Merchant name
`merchant.location`	string	true	Location
`merchant.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`merchant.category`	string	true	Merchant category
`merchant.category_code`	string	true	Merchant category code
`counterparty`	object	false	Counterparty
`counterparty.name`	string	true	Counterparty name
`counterparty.account_id`	string	true	Associated account id
`counterparty.account_details`	union	true	Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details
`card`	object	false	Card details
`card.card_number`	string	true	Card number
`card.first_name`	string	true	Cardholder first name
`card.last_name`	string	true	Cardholder last name
`card_id`	string	false	Card id
`created_at`	date-time-iso8601	true	Creation date time

Sepa transaction account details

SEPA account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	SEPA account type. Possible values: `sepa`
`counterparty.account_details.iban`	string	true	IBAN

Uk local transaction account details

UK local account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	UK local account type. Possible values: `uk-local`
`counterparty.account_details.number`	string	true	UK local account number

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Sender or Receiver account not found

412Consent required

Individual needs to confirm consent before access to data

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

GUEST¶

Anonymous guest users

`GET /guests` - List guests¶

Response body

200OK

List of guests

Name	Type	Required	Description
`data`	array	true	List of guests
`data.id`	uuid	true	Guest UUID
`data.reference_id`	string	true	External reference ID
`data.name`	string	false	First and last name
`data.email`	string	false	Email address
`data.phone_number`	string	false	Phone number
`data.address`	object	false	Address
`data.address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`data.address.street1`	string	true	Street line 1
`data.address.street2`	string	false	Street line 2
`data.address.city`	string	true	City
`data.address.region`	string	false	Region
`data.address.postal_code`	string	true	Postal code
`data.created_at`	date-time-iso8601	true	Creation date time
`has_more`	boolean	true	A flag that shows whether there are more items to return

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`POST /guests` - Create new guest¶

Request body

New guest creation form

Name	Type	Required	Description
`reference_id`	string	true	External reference ID. Must be unique across all guest users
`name`	string[0...100]	false	First and last name
`email`	string[0...254]	false	Email address
`phone_number`	string	false	Phone number
`address`	object	false	Address
`address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`address.street1`	string[0...64]	true	Street line 1
`address.street2`	string[0...64]	false	Street line 2
`address.city`	string[0...64]	true	City
`address.region`	string[0...32]	false	Region
`address.postal_code`	string[0...10]	true	Postal code

Response body

200OK

New guest

Name	Type	Required	Description
`id`	uuid	true	Guest UUID
`reference_id`	string	true	External reference ID
`name`	string	false	First and last name
`email`	string	false	Email address
`phone_number`	string	false	Phone number
`address`	object	false	Address
`address.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`address.street1`	string	true	Street line 1
`address.street2`	string	false	Street line 2
`address.city`	string	true	City
`address.region`	string	false	Region
`address.postal_code`	string	true	Postal code
`created_at`	date-time-iso8601	true	Creation date time

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

GUEST_PAYMENT_METHOD¶

Guest payment methods

Request parameters

Name	Type	Location	Required	Description
`guest_id`	uuid	Path	true	Guest ID

`GET /guests/:guest_id/payment_methods` - List payment methods¶

Response body

200OK

Array of Payment method objects

Name	Type	Required	Description
`data`	array	true	List of payment methods
`data.id`	uuid	true	Payment method ID
`data.type`	string	true	Payment method type. Possible values: `card`
`data.details`	union	true	Payment method details. Possible values: Payment method details card
`data.created_at`	date-time-iso8601	true	Creation date time
`has_more`	boolean	true	A flag that shows whether there are more items to return

Payment method details card

Card payment method details

Name	Type	Required	Description
`data.details.brand`	string	true	Card brand. Possible values: `visa`, `mastercard`
`data.details.exp_month`	string	true	Card expiry month
`data.details.exp_year`	string	true	Card expiry year
`data.details.last4`	string	true	Card last four digits

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`POST /guests/:guest_id/payment_methods` - Add new payment method¶

Request body

New payment method request body

Name	Type	Required	Description
`charge`	object	false	Charge details
`charge.amount`	integer	true	Amount to charge in minor currency units
`charge.currency`	string	false	Charge currency. Possible values: `EUR`. Default: `EUR`
`charge.account_id`	string	true	Individual destination account ID
`type`	string	false	Type of payment method to add. Possible values: `card`. Default: `card`

Response body

200OK

Array of Payment method objects

Name	Type	Required	Description
`id`	uuid	true	Payment method ID
`type`	string	true	Payment method type. Possible values: `card`
`details`	union	true	Payment method details. Possible values: Payment method details card
`created_at`	date-time-iso8601	true	Creation date time

Payment method details card

Card payment method details

Name	Type	Required	Description
`details.brand`	string	true	Card brand. Possible values: `visa`, `mastercard`
`details.exp_month`	string	true	Card expiry month
`details.exp_year`	string	true	Card expiry year
`details.last4`	string	true	Card last four digits

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Individual or account not found

412Verification required

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

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /guests/:guest_id/payment_methods/:id/charge` - Charge payment method¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Payment method ID

Request body

Charge payment method request body

Name	Type	Required	Description
`amount`	integer	true	Amount to charge in minor currency units
`currency`	string	false	Charge currency. Possible values: `EUR`. Default: `EUR`
`account_id`	string	true	Individual destination account ID

Response body

200OK

Transaction details

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

412Verification required

CVC verification is required

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`DELETE /guests/:guest_id/payment_methods/:id` - Delete payment method¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Payment method ID

Response body

200OK

Success

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Not found

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

SIMULATION¶

Simulation endpoints can ONLY be used in testing environments

`POST /simulations/card_payment` - Simulate card payment¶

Request body

Card payment form

Name	Type	Required	Description
`card_id`	uuid	true	Card id
`amount`	integer[100...1000000]	true	Payment amount in minor currency units
`currency`	string	true	Payment currency

Response body

200OK

Card payment simulation result

Name	Type	Required	Description
`successful`	boolean	true	Is payment successful
`code`	string	true	Processing result code. Possible values: `00`, `61`, `05`, `94`, `51`, `13`, `57`, `65`, `84`
`code_description`	string	true	Processing result code description

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

`POST /simulations/three_ds_authentication` - Simulate 3DS authentication¶

Request body

Card transaction data

Name	Type	Required	Description
`card_id`	uuid	true	Card id
`type`	string	true	Transaction type. Possible values: `PAYMENT`, `NON_PAYMENT`
`amount`	integer	false	Payment amount in minor currency units
`currency`	string	false	Payment currency. Possible values: `EUR`, `BGN`, `HRK`, `CZK`, `DKK`, `HUF`, `PLN`, `RON`, `SEK`, `NOK`, `ISK`, `CHF`, `USD`

Response body

200OK

Success

Name	Type	Required	Description
`authentication_id`	string	true	3DS authentication id
`status`	string	true	Status. Possible values: `INITIATED`, `SUCCESS`, `FAILED`, `CANCELLED`, `EXPIRED`
`expires_at`	date-time-iso8601	true	Expiration date time
`created_at`	date-time-iso8601	true	Creation date time

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /simulations/bank_transfer/:id/accepted` - Simulate transaction status transition (`pending` -> `pending (authorized)`)¶

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Transaction ID

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Transaction not found

`POST /simulations/bank_transfer/:id/settled` - Simulate transaction status transition (`pending (authorized)` -> `completed`)¶

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Transaction ID

Response body

200OK

Empty

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Transaction not found

`POST /simulations/onboarding/kyc` - Simulate onboarding KYC data providing¶

Request body

Name	Type	Required	Description
`individual_id`	uuid	true	Individual id

Response body

200OK

Simulation result. Individual passcode for simulation is mocked: 111111

Name	Type	Required	Description
`individual_id`	string	true	Individual id

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /simulations/onboarding/status` - Simulate KYC status changed¶

Request body

Name	Type	Required	Description
`individual_id`	uuid	true	Individual id
`status`	string	true	Status. Possible values: `activated`, `blocked`

Response body

200OK

Simulation result

Name	Type	Required	Description
`individual_id`	string	true	Individual id
`status`	string	true	Status. Possible values: `activated`, `blocked`

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`POST /simulations/individuals/:id/identity_verification` - Simulate identity verification¶

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Individual ID

Response body

200OK

Success

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Individual not found

`POST /simulations/individuals/:id/proof_of_address_verification` - Simulate proof of address verification¶

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Individual ID

Response body

200OK

Success

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Individual not found

`POST /simulations/cards/:id/apple_pay/tokenized_card_not_used` - Simulate TokenizedCardNotUsedApplePay event¶

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Card ID

Request body

Simulate form

Name	Type	Required	Description
`period_of_days`	number	true	Period of days. Possible values: `7`, `14`

Response body

200OK

Success

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Card not found

FEE¶

Fees

`POST /fees` - Create fee¶

Request body

Fee creation data

Name	Type	Required	Description
`account_id`	string	true	Account id
`amount`	integer	true	Fee amount in minor currency units
`description`	string	true	Text note. Max length - 140 chars. Letters, numbers, empty spaces, and following symbols: `?:()/.,+-` are allowed

Response body

200OK

Data of newly created fee

Name	Type	Required	Description
`id`	string	true	Fee id
`amount`	integer	true	Charge amount in minor currency units
`currency`	string	true	Charge currency
`status`	string	true	Status. Possible values: `pending`, `failed`, `refunded`, `completed`
`account_id`	string	true	Associated account id
`description`	string	true	Text note
`type`	string	true	Transaction type. Possible values: `fee`
`subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`created_at`	date-time-iso8601	true	Creation timestamp

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

`GET /fees` - List fees¶SCAAccessing fee history requires explicit consent

Accessing fee history requires explicit consent

Request parameters

Name	Type	Location	Required	Description
`limit`	integer[1...100]	Query	false	A limit on the number of objects to be returned. Default: `10`
`sort_type`	string	Query	false	Sort type. Possible values: `ASC`, `DESC`. Default: `DESC`
`starting_after`	string	Query	false	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_before`	string	Query	false	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_from`	string	Query	false	Get transactions from date. Accepts date or date-time
`created_to`	string	Query	false	Get transactions before date. Accepts date or date-time
`individual_id`	uuid	Query	false	It can be used to filter fees by specific individual
`account_id`	string	Query	false	It can be used to filter fees by specific source account

Response body

200OK

List of fees

Name	Type	Required	Description
`data`	array	true	List of fees
`data.id`	string	true	Fee id
`data.amount`	integer	true	Charge amount in minor currency units
`data.currency`	string	true	Charge currency
`data.status`	string	true	Status. Possible values: `pending`, `failed`, `refunded`, `completed`
`data.account_id`	string	true	Associated account id
`data.description`	string	true	Text note
`data.type`	string	true	Transaction type. Possible values: `fee`
`data.subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`data.created_at`	date-time-iso8601	true	Creation timestamp
`has_more`	boolean	true	A flag that shows whether there are more items to return

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

412Consent required

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)

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

`GET /fees/:id` - Get fee¶SCAAccessing fee history requires explicit consent

Accessing fee history requires explicit consent

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Fee id

Response body

200OK

Fee

Name	Type	Required	Description
`id`	string	true	Fee id
`amount`	integer	true	Charge amount in minor currency units
`currency`	string	true	Charge currency
`status`	string	true	Status. Possible values: `pending`, `failed`, `refunded`, `completed`
`account_id`	string	true	Associated account id
`description`	string	true	Text note
`type`	string	true	Transaction type. Possible values: `fee`
`subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`created_at`	date-time-iso8601	true	Creation timestamp

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Fee not found

412Consent required

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)

Name	Type	Required	Description
`consent`	object	true	Consent details
`consent.id`	string	true	Consent ID
`consent.status`	string	true	Consent status. Possible values: `pending`

CUSTOMER_SUPPORT¶

Endpoints for Customer support purposes

`GET /audit/transactions/:id` - Get limited transaction data without SCA¶

Request parameters

Name	Type	Location	Required	Description
`id`	string	Path	true	Transaction id

Response body

200OK

Limited transaction data

Name	Type	Required	Description
`id`	string	true	Transaction id
`type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`, `fee`
`subtype`	string	false	Transaction subtype. Possible values: `sepa`, `movement`, `internal`, `account-funding`, `account-funding-reservation`, `account-funding-guest`, `fee`, `visa-spending`, `visa-refund`, `visa-oct`, `visa-chargeback`, `visa-atm-withdrawal`
`card_id`	string	false	Card ID
`amount`	integer	true	Transaction amount in minor currency units
`currency`	string	true	Transaction currency
`exchange_rate`	union	true	Transaction exchange rate. Possible values: `decimal`, `null`
`payment_amount`	integer	true	Transaction payment amount in minor currency units
`payment_currency`	string	true	Transaction payment currency
`status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`, `failed`
`account_id`	string	true	Associated account id
`reference`	string	true	Payment details
`counterparty`	object	false	Counterparty
`counterparty.name`	string	true	Counterparty name
`counterparty.account_id`	string	true	Associated account id
`counterparty.account_details`	union	true	Associated account details. Possible values: Sepa transaction account details, Uk local transaction account details
`merchant`	object	false	Merchant details
`merchant.name`	string	true	Merchant name
`merchant.location`	string	true	Location
`merchant.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`merchant.category`	string	true	Merchant category
`merchant.category_code`	string	true	Merchant category code
`created_at`	date-time-iso8601	true	Creation date time

Sepa transaction account details

SEPA account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	SEPA account type. Possible values: `sepa`
`counterparty.account_details.iban`	string	true	IBAN

Uk local transaction account details

UK local account details

Name	Type	Required	Description
`counterparty.account_details.type`	string	true	UK local account type. Possible values: `uk-local`
`counterparty.account_details.number`	string	true	UK local account number

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Transaction not found

PENDING_ACTION¶

Pending actions

`GET /pending_actions` - Get list of pending actions¶

Request parameters

Name	Type	Location	Required	Description
`individual_id`	uuid	Query	false	Filter pending actions by individual ID
`event_id`	uuid	Query	false	Filter pending actions by an associated event ID
`completed`	boolean	Query	false	Filter pending actions on whether they have been completed or not
`limit`	integer[1...100]	Query	false	A limit on the number of objects to be returned. Default: `10`
`sort_type`	string	Query	false	Sort type. Possible values: `ASC`, `DESC`. Default: `DESC`
`starting_after`	uuid	Query	false	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_before`	uuid	Query	false	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

200OK

List of pending actions

Name	Type	Required	Description
`data`	array	true	Array of pending actions
`data.id`	string	true	Pending action ID
`data.type`	string	true	Type of pending action. Possible values: `AuthenticateCardOperation`, `IdentityVerification`, `ProofOfAddressVerification`
`data.description`	string	true	Description of pending action
`data.payload`	object	true	Pending action payload
`data.payload.individual_id`	string	true	Individual ID
`data.payload.consent_id`	string	true	Consent ID
`data.expires_at`	date-time-iso8601	true	Expiration date time
`data.created_at`	date-time-iso8601	true	Creation date time
`has_more`	boolean	true	A flag that shows whether there are more items to return

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Pending actions not found

422Unprocessable Entity

Business error

Name	Type	Required	Description
`error`	object	true	Error
`error.code`	string	false	Error code
`error.field`	string	false	Error field
`error.message`	string	false	Description

`GET /pending_actions/:id` - Get pending action¶

Request parameters

Name	Type	Location	Required	Description
`id`	uuid	Path	true	Pending action ID

Response body

200OK

Pending action details

Name	Type	Required	Description
`id`	string	true	Pending action ID
`type`	string	true	Type of pending action. Possible values: `AuthenticateCardOperation`, `IdentityVerification`, `ProofOfAddressVerification`
`description`	string	true	Description of pending action
`payload`	object	true	Pending action payload
`payload.individual_id`	string	true	Individual ID
`payload.consent_id`	string	true	Consent ID
`expires_at`	date-time-iso8601	true	Expiration date time
`created_at`	date-time-iso8601	true	Creation date time

400Bad Request

Validation error

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Name	Type	Required	Description
`errors`	array	true	Errors
`errors.code`	string	false	Error code
`errors.field`	string	false	Error field
`errors.message`	string	false	Description

404Not Found

Pending action not found

Integr>te™ API - v3.94.0

Intergiro Indirect API

Headers¶

SESSION¶

POST /auth/login - Login using API key¶

Request body

Response body

POST /auth/refresh - Exchange refresh token for a new access token¶

Request body

Response body

INDIVIDUAL¶

POST /individuals - Create an Individual user¶

Request body

Response body

GET /individuals - Returns all Individuals accessible in the request scope¶

Request parameters

Response body

GET /individuals/:id - Returns Individual details by ID¶

Request parameters

Response body

POST /individuals/:id/onboard - Start Individual onboarding process¶

Request parameters

Request body

Response body

PATCH /individuals/:id - Update Individual data¶SCAUpdating data requires explicit consent for Activated individual.

Request parameters

Request body

Individual update form email

Individual update form phone number

Response body

CONSENT¶

GET /consents/:id - Get a single Individual's consent by id¶

Request parameters

Response body

GET /consents - Get list of Individual's consents¶

Request parameters

Response body

POST /consents - Request consent for specified scope¶

Request body

Response body

POST /consents/:id - Request consent by id¶

Request parameters

Request body

Response body

EVENT¶

GET /events - Returns all Events¶

Request parameters

Response body

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

Card issued payload

Pending action event payload

Transaction consent rejected event payload

Tokenized card not used apple pay payload

GET /events/:id - Returns Event details by ID¶

Request parameters

Response body

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

Card issued payload

Pending action event payload

Transaction consent rejected event payload

Tokenized card not used apple pay payload

WEBHOOK¶

`POST /auth/login` - Login using API key¶

`POST /auth/refresh` - Exchange refresh token for a new access token¶

`POST /individuals` - Create an Individual user¶

`GET /individuals` - Returns all Individuals accessible in the request scope¶

`GET /individuals/:id` - Returns Individual details by ID¶

`POST /individuals/:id/onboard` - Start Individual onboarding process¶

`PATCH /individuals/:id` - Update Individual data¶SCAUpdating data requires explicit consent for Activated individual.

`GET /consents/:id` - Get a single Individual's consent by id¶

`GET /consents` - Get list of Individual's consents¶

`POST /consents` - Request consent for specified scope¶

`POST /consents/:id` - Request consent by id¶

`GET /events` - Returns all Events¶

`GET /events/:id` - Returns Event details by ID¶

`GET /webhooks` - Returns all Webhooks¶

`POST /webhooks` - Create new webhook¶

`DELETE /webhooks/:id` - Delete a webhook¶

`GET /accounts/:id` - Returns payment account by ID¶SCAAccessing the balance of one or more designated payment accounts for the first time requires Strong Customer Authentication

`GET /accounts` - Returns list of payment accounts¶SCAAccessing the balance of one or more designated payment accounts for the first time requires Strong Customer Authentication

`GET /accounts/:id/bank_details` - Returns payment account details by ID¶

`POST /accounts` - Create payment account for individual¶

`POST /cards` - Order card ¶

`GET /cards` - List of cards¶

`GET /cards/:id` - View card¶

`GET /cards/:id/credentials` - View card credentials¶SCAAccessing card credentials requires explicit consent

`POST /cards/:id/activate` - Activate card¶SCAActivating the card requires explicit consent

`PUT /cards/:id/pin` - Reset card PIN¶SCACard PIN reset requires explicit consent

`PATCH /cards/:id` - Update card¶

`POST /cards/:id/apple_pay/tokenize` - Apple Pay tokenization¶SCATokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

`POST /cards/apple_pay/wallet_extension_tokenize` - Apple Pay Wallet extension tokenization¶SCATokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

`POST /cards/:id/google_pay/tokenize` - Google Pay tokenization (in closed beta)¶SCATokenizing the card requires explicit consent. Consent must be granted through the mobile SDK.

`GET /individuals/:individual_id/payment_methods` - List payment methods¶

`POST /individuals/:individual_id/payment_methods` - Add new payment method¶

`POST /individuals/:individual_id/payment_methods/:id/charge` - Charge payment method¶

`DELETE /individuals/:individual_id/payment_methods/:id` - Delete payment method¶