2d API - v1.9.1

Intergiro Direct API

Headers

NameTypeRequiredDescription
Content-Typehttp_content_type_jsontrue

application/json HTTP content type

Authentication

Request body

API key login form

NameTypeRequiredDescription
api_keystringtrue

API key

Response body

Successful login

NameTypeRequiredDescription
access_tokenstringtrue

Valid JWT token

refresh_tokenstringtrue

Refresh token

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request body

Refresh access token form

NameTypeRequiredDescription
refresh_tokenstringtrue

Refresh token

Response body

Successful login

NameTypeRequiredDescription
access_tokenstringtrue

Valid JWT token

refresh_tokenstringtrue

Refresh token

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Transactions

Request parameters

NameTypeLocationRequiredDescription
limitintegerQueryfalse

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

sort_typestringQueryfalse

Sort type. Possible values: ASC, DESC

starting_afterstringQueryfalse

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

ending_beforestringQueryfalse

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

created_fromdate-time-iso8601Queryfalse

Get transactions from date

created_todate-time-iso8601Queryfalse

Get transactions before date

account_ids[string]Queryfalse

Filter by account ids

statusesstringQueryfalse

Filter by statuses. Possible values: pending, completed, rejected, refunded, pending_approval

Response body

Transactions list

NameTypeRequiredDescription
dataarraytrue

Transactions

data.idstringtrue

Transaction id

data.typestringtrue

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

data.amountintegertrue

Transaction amount

data.currencystringtrue

Transaction currency

data.exchange_rateuniontrue

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

data.payment_amountintegertrue

Transaction payment amount

data.payment_currencystringtrue

Transaction payment currency

data.statusstringtrue

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

data.account_idstringtrue

Associated account id

data.referencestringtrue

Payment details

data.merchantobjectfalse

Merchant details

data.merchant.namestringtrue

Counterparty name

data.merchant.locationstringtrue

Location

data.merchant.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

data.merchant.categorystringtrue

Merchant category

data.counterpartyobjectfalse

Counterparty

data.counterparty.namestringtrue

Counterparty name

data.counterparty.account_idstringtrue

Associated account id

data.counterparty.account_detailsobjecttrue

Counterparty account details

data.counterparty.account_details.numberstringtrue

Counterparty account number

data.counterparty.account_details.bank_codestringtrue

Counterparty account bank code

data.cardobjectfalse

Card details

data.card.card_numberstringtrue

Card number

data.card.first_namestringtrue

Cardholder first name

data.card.last_namestringtrue

Cardholder last name

data.card_idstringfalse

Card id

data.created_atdate-time-iso8601true

Creation date time

has_morebooleantrue

A flag that shows whether there are more items to return

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Transaction ID

Response body

Transaction details

NameTypeRequiredDescription
idstringtrue

Transaction id

typestringtrue

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

amountintegertrue

Transaction amount

currencystringtrue

Transaction currency

exchange_rateuniontrue

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

payment_amountintegertrue

Transaction payment amount

payment_currencystringtrue

Transaction payment currency

statusstringtrue

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

account_idstringtrue

Associated account id

referencestringtrue

Payment details

merchantobjectfalse

Merchant details

merchant.namestringtrue

Counterparty name

merchant.locationstringtrue

Location

merchant.country_codestringtrue

Country code (ISO 3166-1 alpha-2)

merchant.categorystringtrue

Merchant category

counterpartyobjectfalse

Counterparty

counterparty.namestringtrue

Counterparty name

counterparty.account_idstringtrue

Associated account id

counterparty.account_detailsobjecttrue

Counterparty account details

counterparty.account_details.numberstringtrue

Counterparty account number

counterparty.account_details.bank_codestringtrue

Counterparty account bank code

cardobjectfalse

Card details

card.card_numberstringtrue

Card number

card.first_namestringtrue

Cardholder first name

card.last_namestringtrue

Cardholder last name

card_idstringfalse

Card id

created_atdate-time-iso8601true

Creation date time

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Transaction not found

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Bulk payments

Request body

Send bulk payment payload data

NameTypeRequiredDescription
account_idstringtrue

Account ID

itemsarraytrue

Send bulk payment items request data

items.counterpartyobjecttrue

Counterparty data

items.counterparty.namestringtrue

Counterparty name

items.counterparty.accountuniontrue

Counterparty account. Possible values: Sepa account

items.amountintegertrue

Transfer amount

items.referencestringtrue

Payment reference

Sepa account

SEPA account data

NameTypeRequiredDescription
items.counterparty.account.account_ibanstringtrue

Beneficiary account IBAN

items.counterparty.account.account_bicstringtrue

Beneficiary account BIC

Response body

Payments created

NameTypeRequiredDescription
idstringtrue

Bulk payment ID

account_idstringtrue

Bulk payment account ID

totals_by_currencymap[bulk_payment_currency_total]true

Calculated amount totals by currency. Note: only EUR is supported

Validation error

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Business error

NameTypeRequiredDescription
errorobjecttrue

Error

error.codestringfalse

Error code

error.fieldstringfalse

Error field

error.messagestringfalse

Description

Accounts

Response body

List of bank accounts

NameTypeRequiredDescription
dataarraytrue

Bank accounts

data.idstringtrue

Account ID

data.namestringtrue

Account name

data.currencystringtrue

Account currency

data.balancedoubletrue

Account balance

has_morebooleantrue

A flag that shows whether there are more items to return

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Request parameters

NameTypeLocationRequiredDescription
idstringPathtrue

Account ID

Response body

Bank account

NameTypeRequiredDescription
idstringtrue

Account ID

namestringtrue

Account name

currencystringtrue

Account currency

balancedoubletrue

Account balance

Unauthorized

Forbidden

NameTypeRequiredDescription
errorsarraytrue

Errors

errors.codestringfalse

Error code

errors.fieldstringfalse

Error field

errors.messagestringfalse

Description

Not found