API docs by Redocly

Syntropi Banking API (1.1.0)

Download OpenAPI specification:

Syntropi Support: support@syntropi.co.uk URL: https://syntropi.co.uk/support License: Proprietary

API for accessing bank information across multiple providers.

This API allows you to retrieve comprehensive bank information including:

  • Basic bank details (name, country, logo, payment methods)
  • Feature support across all providers (account access, balance, transactions, payments)
  • Provider-specific support details and capabilities
  • Recommended provider based on feature completeness

Filter banks by country, payment method, provider, and search terms.

Banks

Operations related to bank information and synchronization

List all banks

Returns a list of banks with optional filtering by country, provider, payment method, and search term. Results are paginated.

Authorizations:
ApiKeyAuth
query Parameters
country
string
Example: country=GB

Filter by ISO 3166-1 alpha-2 country code

provider
string
Example: provider=token

Filter by banking provider

paymentMethod
string
Example: paymentMethod=sepa

Filter by supported payment method

search
string
Example: search=national

Search term to filter bank names

page
integer >= 1
Default: 1

Page number for pagination

limit
integer [ 1 .. 500 ]
Default: 100

Number of results per page

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get supported banking providers

Returns a list of all supported banking providers

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get bank details

Returns detailed information about a specific bank

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Bank ID

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Sync banks from providers

Admin-only endpoint to synchronize bank information from providers. Optional query parameter to specify which provider to sync.

Authorizations:
ApiKeyAuth
query Parameters
provider
string
Example: provider=token

Specific provider to sync (omit to sync all)

Responses

Response Schema: application/json
success
boolean
message
string
object

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Bank synchronization completed",
  • "data": {
    }
}

Payments

Operations for initiating and managing Single Immediate Payments

List payments

Returns a list of payments for the authenticated client. Results are paginated and can be filtered by status and provider.

Authorizations:
ApiKeyAuth
query Parameters
status
string (PaymentStatus)
Enum: "PENDING" "AUTHORIZING" "AUTHORIZED" "SUBMITTED" "ACCEPTED" "COMPLETED" "FAILED" "CANCELLED" "EXPIRED"
Example: status=PENDING

Filter by payment status

provider
string
Example: provider=token

Filter by payment provider

limit
integer [ 1 .. 100 ]
Default: 20

Number of results per page (max 100)

offset
integer >= 0
Default: 0

Number of results to skip

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Create a new payment

Initiates a new Single Immediate Payment using the specified provider. Supports different flow types for various integration approaches.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (AccountDetails)
required
object (AccountDetails)
required
object (Amount)
object (PaymentReference)
flowType
string (PaymentFlowType)
Enum: "API_ONLY" "HOSTED_PAGES" "EMBEDDED_HOSTED_PAGES"

The integration flow type for the payment:

  • API_ONLY: Full API integration where TPP handles all UI
  • HOSTED_PAGES: Token.io hosted pages handle bank selection and authentication
  • EMBEDDED_HOSTED_PAGES: Token.io hosted pages for authentication only (bankId required)
redirectUrl
string <uri>

URL to redirect to after payment completion

provider
required
string

Payment provider to use

bankId
string

Bank identifier (required for EMBEDDED_HOSTED_PAGES flow)

Responses

Response Schema: application/json
success
boolean
object

Request samples

Content type
application/json
{
  • "toAccount": {
    },
  • "amount": {
    },
  • "reference": {
    },
  • "flowType": "API_ONLY",
  • "provider": "token"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List supported payment providers

Returns a list of payment providers supported by the API

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get payment details

Returns details of a specific payment

Authorizations:
ApiKeyAuth
path Parameters
paymentId
required
string
Example: pay_1234567890abcdef

Unique payment identifier

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Cancel a payment

Cancels a payment if it is in a cancellable state. Payments can only be cancelled before they are completed or failed.

Authorizations:
ApiKeyAuth
path Parameters
paymentId
required
string
Example: pay_1234567890abcdef

Unique payment identifier

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Sync payment status

Synchronizes the payment status with the provider. This will update the payment status to reflect the latest state from the banking provider.

Authorizations:
ApiKeyAuth
path Parameters
paymentId
required
string
Example: pay_1234567890abcdef

Unique payment identifier

Responses

Response Schema: application/json
success
boolean
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}