IBAN Guide

1. Create an IBAN Account

Endpoint:

If successful, it retrieves the request identifier, status, and the identifier of the invoice to be paid.

Body Parameters:

Name	Type	Required	Description
`currency`	`string`	✅	Currency of the IBAN account — only EUR is available.

Response Example:

   {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "invoiceId": "string",
    "status": "INIT"
  }

2. Retrieve User's IBAN Info

Endpoint:

GET v1/bank-accountsv1/bank-accounts

Retrieves the status of an IBAN issuance request. Upon successful issuance, the response includes the generated IBAN and linked bank account details.

Response Example:

{
        "id": "00a386f2-6ca3-4e00-ba0a-4feef6af4c5d",
        "type": "SEPA",
        "bankName": "SETTLEGO SOLUTIONS LTD",
        "bankAddress": "THE BOWER BUILDING 207 - 211 OLD STREET SHOREDITCH, LONDON",
        "swiftBic": "SEOUGB21",
        "accountNumber": "GB30SEOU19870010355854",
        "accountHolderName": "John Mock-Doe",
        "accountHolderAddress": "ES, 12345, Test city, Test Address 1",
        "currency": "EUR",
        "status": "ACTIVE",
        "accountId": "e6542559-a837-4da0-8204-8183b317f250",
        "invoiceId": null,
        "memo": null,
        "balance": 8.98000000000000000000
    }

Request Statuses

Status	Description
`INIT`	Request is been completed but not yet paid.
`PENDING`	Request pending review.
`SUPPORT`	The IBAN opening was denied due to an unexpected error.
`ACTIVE`	IBAN is opened, successfully paid.
`CANCELLED`	The user has cancelled the IBAN issuance request.
`CLOSED`	The IBAN account is closed.

The IBAN issuance request can be cancelled via POST v1/bank-accounts/{bankAccountId}/cancel endpoint while the status of the request is one of: INIT, SUPPORT, INVOICE_FAILED.

3. Initialize Payment

Endpoint:

POST /invoice/payment

Initializes the payment for the subscription.

Body Parameters:

Name	Type	Required	Description
`invoiceId`	`string`	✅	the invoice ID.
`type`	`string`	✅	Payment provider type (only `PLATFORM` one is available).
`accountId`	`string`	✅	Identifies the `CHECKING` type of account in the wallet service. All accounts can be retrieved using List all accounts endpoint.
`currency`	`string`	✅	Currency used for the payment.
`anyCurrency`	`boolean`	✅	Flag indicating whether multiple currencies are supported.

Response Example:

{
  "accountId" : "59341629-5f86-47a5-a867-1c4225f119b0",
  "id" : "8caf4504-d6b0-461b-9b67-53dacee85156",
  "invoiceId" : "a90f36dd-57af-4f5e-a2f5-086631f9edac",
  "status" : "INIT",
  "type" : "PLATFORM",
  "amount" : 15,
  "description" : "Invoice payment",
  "last_modified_date" : "2025-04-07T21:32:11.716207540Z",
  "created_date" : "2025-04-07T21:32:11.716207540Z"
}

4. Confirm Invoice Payment

Endpoint:

POST payment/pay

Confirms payment of the invoice.

Body Parameters:

Name	Type	Required	Description
`invoiceId`	`string`	✅	the invoice ID.
`type`	`string`	✅	Payment provider type (only `PLATFORM` one is available).
`paymentId`	`string`	✅	Unique identifier for the payment from Step 4.
`accountId`	`string`	✅	Identifies the `CHECKING` type of account in the wallet service. All accounts can be retrieved using List all accounts endpoint.
`currency`	`string`	✅	Currency used for the payment.
`anyCurrency`	`boolean`	✅	Flag indicating whether multiple currencies are supported.

Response Example:

{
  "accountId" : "59341629-5f86-47a5-a867-1c4225f119b0",
  "id" : "8caf4504-d6b0-461b-9b67-53dacee85156",
  "invoiceId" : "a90f36dd-57af-4f5e-a2f5-086631f9edac",
  "status" : "PROCESSING",
  "type" : "PLATFORM",
  "amount" : 15,
  "description" : "Invoice payment",
  "last_modified_date" : "2025-04-07T21:32:14.700515749Z",
  "created_date" : "2025-04-07T21:32:11.716208Z"
}

Once you pay the invoice, you will need to use OAuth2.0 and Retrieve User Information endpoints — in order to refresh your token and update the userScopes and scope parameters.