2d API - v1.17.0

Intergiro Direct 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	Valid JWT token
`refresh_token`	string	true	Refresh 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

`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	Valid JWT token
`refresh_token`	string	true	Refresh 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

TRANSACTION¶

Transactions

`GET /transactions` - List transactions¶

Request parameters

Name	Type	Location	Required	Description
`limit`	integer	Query	false	A limit on the number of objects to be returned. Default 10. Can be 1 to 100
`sort_by`	string	Query	false	Sort by. Possible values: `created_at`, `updated_at`
`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`	date-time-iso8601	Query	false	Get transactions from date
`created_to`	date-time-iso8601	Query	false	Get transactions before date
`account_ids`	[string]	Query	false	Filter by account ids
`statuses`	[string]	Query	false	Filter by statuses. Possible values: `pending`, `completed`, `rejected`, `refunded`, `pending_approval`
`correlation_ids`	[string]	Query	false	Filter by correlation ids

Response body

200OK

Transactions list

Name	Type	Required	Description
`data`	array	true	Transactions
`data.id`	string	true	Transaction id
`data.type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`, `fee`
`data.amount`	integer	true	Transaction amount
`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
`data.payment_currency`	string	true	Transaction payment currency
`data.status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`, `pending_approval`
`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	Counterparty 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.counterparty`	object	false	Counterparty
`data.counterparty.name`	string	true	Counterparty name
`data.counterparty.account_id`	string	true	Associated account id
`data.counterparty.account_details`	object	true	Counterparty account details
`data.counterparty.account_details.number`	string	true	Counterparty account number
`data.counterparty.account_details.bank_code`	string	true	Counterparty account bank code
`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.bulk_payment_id`	string	false	Bulk payment id
`data.correlation_id`	string	false	Bulk payment correlation id
`data.created_at`	date-time-iso8601	true	Creation date time
`data.updated_at`	date-time-iso8601	true	Modified 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

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 by ID¶

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
`type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`, `fee`
`amount`	integer	true	Transaction amount
`currency`	string	true	Transaction currency
`exchange_rate`	union	true	Transaction exchange rate. Possible values: `decimal`, `null`
`payment_amount`	integer	true	Transaction payment amount
`payment_currency`	string	true	Transaction payment currency
`status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`, `pending_approval`
`account_id`	string	true	Associated account id
`reference`	string	true	Payment details
`merchant`	object	false	Merchant details
`merchant.name`	string	true	Counterparty name
`merchant.location`	string	true	Location
`merchant.country_code`	string	true	Country code (ISO 3166-1 alpha-2)
`merchant.category`	string	true	Merchant category
`counterparty`	object	false	Counterparty
`counterparty.name`	string	true	Counterparty name
`counterparty.account_id`	string	true	Associated account id
`counterparty.account_details`	object	true	Counterparty account details
`counterparty.account_details.number`	string	true	Counterparty account number
`counterparty.account_details.bank_code`	string	true	Counterparty account bank code
`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
`bulk_payment_id`	string	false	Bulk payment id
`correlation_id`	string	false	Bulk payment correlation id
`created_at`	date-time-iso8601	true	Creation date time
`updated_at`	date-time-iso8601	true	Modified date time

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

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

BULK_PAYMENT¶

Bulk payments

`POST /bulk_payments` - Send bulk payment¶

Request body

Send bulk payment payload data

Name	Type	Required	Description
`account_id`	string	true	Account ID
`items`	union	true	Send bulk payment items request data. Possible values: Counterparty bulk payment item, Beneficiary id bulk payment item

Counterparty bulk payment item

Send bulk payment item request data

Name	Type	Required	Description
`items.counterparty`	object	true	Counterparty data
`items.counterparty.name`	string	true	Counterparty name
`items.counterparty.account`	union	true	Counterparty account. Possible values: Sepa account
`items.amount`	integer	true	Transfer amount
`items.reference`	string	true	Payment reference
`items.correlation_id`	uuid	false	Correlation ID (UUID)

Sepa account

SEPA account data

Name	Type	Required	Description
`items.counterparty.account.account_iban`	string	true	Beneficiary account IBAN
`items.counterparty.account.account_bic`	string	true	Beneficiary account BIC

Beneficiary id bulk payment item

Beneficiary ID bulk payment item

Name	Type	Required	Description
`items.beneficiary_id`	string	true	Beneficiary ID
`items.amount`	integer	true	Transfer amount
`items.reference`	string	true	Payment reference
`items.correlation_id`	uuid	false	Correlation ID (UUID)

Response body

200OK

Payments created

Name	Type	Required	Description
`id`	string	true	Bulk payment ID
`account_id`	string	true	Bulk payment account ID
`totals_by_currency`	map[bulk_payment_currency_total]	true	Calculated amount totals by currency. Note: only EUR is supported

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

ACCOUNT¶

Accounts

`GET /accounts` - List accounts¶

Response body

200OK

List of bank accounts

Name	Type	Required	Description
`data`	array	true	Bank accounts
`data.id`	string	true	Account ID
`data.name`	string	true	Account name
`data.currency`	string	true	Account currency
`data.balance`	double	true	Account balance
`has_more`	boolean	true	A flag that shows whether there are more items to return

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 /accounts/:id` - Get account by ID¶

Request parameters

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

Response body

200OK

Bank account

Name	Type	Required	Description
`id`	string	true	Account ID
`name`	string	true	Account name
`currency`	string	true	Account currency
`balance`	double	true	Account balance

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

`GET /accounts/:id/bank_details` - Get bank account details¶

Request parameters

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

Response body

200OK

Bank account details

Name	Type	Required	Description
`payment_rail`	string	true	Account payment rail. Possible values: `sepa`, `swift`, `uk_local`
`details`	union	true	Account number and bank code. Possible values: 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.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 iban

Account details in IBAN format

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

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

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

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`	string	Path	true	Webhook ID

Response body

200OK

Webhook is deleted

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

Webhook not found

EVENT¶

Events

`GET /events` - Returns all events¶

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. Default DESC. 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

Response body

200OK

Events list

Name	Type	Required	Description
`data`	array	true	Events
`data.id`	uuid	true	ID
`data.name`	string	true	Name. Possible values: `TransactionCreated`, `TransactionStatusChanged`
`data.payload`	union	true	Payload. Possible values: Transaction event 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

Transaction event payload

Transaction event payload. Applicable for: TransactionCreated, TransactionStatusChanged events

Name	Type	Required	Description
`data.payload.transaction_id`	string	true	Transaction ID
`data.payload.status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`, `pending_approval`
`data.payload.type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`, `fee`
`data.payload.amount`	integer	true	Transaction amount
`data.payload.currency`	string	true	Transaction currency

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`	uuid	true	ID
`name`	string	true	Name. Possible values: `TransactionCreated`, `TransactionStatusChanged`
`payload`	union	true	Payload. Possible values: Transaction event payload
`created_at`	date-time-iso8601	true	Creation date time

Transaction event payload

Transaction event payload. Applicable for: TransactionCreated, TransactionStatusChanged events

Name	Type	Required	Description
`payload.transaction_id`	string	true	Transaction ID
`payload.status`	string	true	Transaction status. Possible values: `pending`, `completed`, `rejected`, `refunded`, `pending_approval`
`payload.type`	string	true	Transaction type. Possible values: `bank-transfer`, `card-payment`, `fee`
`payload.amount`	integer	true	Transaction amount
`payload.currency`	string	true	Transaction currency

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

BENEFICIARY¶

Beneficiaries

`GET /beneficiaries` - List beneficiaries¶

Request parameters

Name	Type	Location	Required	Description
`trusted`	boolean	Query	false	Filter by trusted status
`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. Default DESC. 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

Response body

200OK

List of beneficiaries

Name	Type	Required	Description
`data`	array	true	Beneficiaries
`data.id`	string	true	Beneficiary ID
`data.name`	string	true	Beneficiary name
`data.trusted`	boolean	true	Trusted status
`data.account`	union	true	Beneficiary account. Possible values: Beneficiary account iban
`has_more`	boolean	true	A flag that shows whether there are more items to return

Beneficiary account iban

Beneficiary account

Name	Type	Required	Description
`data.account.currency`	string	true	Currency
`data.account.payment_rail`	string	true	Payment rail
`data.account.account_iban`	string	true	Account IBAN
`data.account.account_bic`	string	true	Account BIC

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 /beneficiaries/:id` - Get beneficiary by ID¶

Request parameters

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

Response body

200OK

Beneficiary

Name	Type	Required	Description
`id`	string	true	Beneficiary ID
`name`	string	true	Beneficiary name
`trusted`	boolean	true	Trusted status
`account`	union	true	Beneficiary account. Possible values: Beneficiary account iban

Beneficiary account iban

Beneficiary account

Name	Type	Required	Description
`account.currency`	string	true	Currency
`account.payment_rail`	string	true	Payment rail
`account.account_iban`	string	true	Account IBAN
`account.account_bic`	string	true	Account BIC

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

2d API - v1.17.0

Intergiro Direct 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

TRANSACTION¶

GET /transactions - List transactions¶

Request parameters

Response body

GET /transactions/:id - Get transaction by ID¶

Request parameters

Response body

BULK_PAYMENT¶

POST /bulk_payments - Send bulk payment¶

Request body

Counterparty bulk payment item

Sepa account

Beneficiary id bulk payment item

Response body

ACCOUNT¶

GET /accounts - List accounts¶

Response body

GET /accounts/:id - Get account by ID¶

Request parameters

Response body

GET /accounts/:id/bank_details - Get bank account details¶

Request parameters

Response body

Account details iban

WEBHOOK¶

GET /webhooks - Returns all Webhooks¶

Response body

POST /webhooks - Create new webhook¶

Request body

Response body

DELETE /webhooks/:id - Delete a webhook¶

Request parameters

Response body

EVENT¶

GET /events - Returns all events¶

Request parameters

Response body

Transaction event payload

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

Request parameters

Response body

Transaction event payload

BENEFICIARY¶

GET /beneficiaries - List beneficiaries¶

Request parameters

Response body

Beneficiary account iban

GET /beneficiaries/:id - Get beneficiary by ID¶

Request parameters

Response body

Beneficiary account iban

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

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

`GET /transactions` - List transactions¶

`GET /transactions/:id` - Get transaction by ID¶

`POST /bulk_payments` - Send bulk payment¶

`GET /accounts` - List accounts¶

`GET /accounts/:id` - Get account by ID¶

`GET /accounts/:id/bank_details` - Get bank account details¶

`GET /webhooks` - Returns all Webhooks¶

`POST /webhooks` - Create new webhook¶

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

`GET /events` - Returns all events¶

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

`GET /beneficiaries` - List beneficiaries¶

`GET /beneficiaries/:id` - Get beneficiary by ID¶