Open Banking - Third-Party Providers API (TPP)

Tribe Payments Open Banking Third-Party Providers (TPP) API (v2) - the TPP-facing side of Tribe's Open Banking product for initiating account-to-account payments (PIS) and retrieving account information (AIS) from connected banks, authenticated with a bearer token plus X-Client-ID, with a Payment Webhooks interface. Harvested verbatim from the Tribe developer portal.

Documentation Provider Profile APIs.io OpenAPI GitHub

Open Banking - Third-Party Providers API (TPP) is one of 15 APIs that Tribe Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments, Open Banking, Account-to-Account, Payment Initiation, and United Kingdom. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 18 operations across 18 paths, organized into 7 resource areas, and defines 36 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against a single base URL, %tpp_api_url%/tpp/v2.

18 operations 18 paths 36 schemas 13 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2.0.0

Server

%tpp_api_url%/tpp/v2

Authentication

HTTP Bearer, API Key

Resource Areas

Authentication & Security 2

Open Banking - Third-Party Providers API (TPP) declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (tokenAuth). An API key is passed in the header as X-Client-ID (clientId). By default, every request must be authenticated.

Paths & Operations 18

Across 18 paths, the API surfaces 18 operations — 13 GET, 5 POST. They span 7 resource areas: Account, Payment, Bulk payments, General, Funds confirmation, Direct payments, Direct payments without Bank. Each is listed below with its method, path, parameters, and response codes.

Account 4

Endpoints for confirming funds in the account.

GET

/accounts

Returns a list of accounts.

5 params → 200400401403405406429500

GET

/accounts/{accountId}

Returns details of a single account.

6 params → 200400401403404405406429

GET

/accounts/{accountId}/balances

Returns a list of account balances.

6 params → 200400401403404405406429

GET

/accounts/{accountId}/transactions

Returns a list of account transactions.

11 params → 200400401403404405406429

Payment 3

Endpoints for executing payments.

POST

/payments

Initiate a single new payment.

7 params body → 201400401403405406415429

GET

/payments/{paymentId}

Retrieve content of an initiated payment.

6 params → 200400401403404405406429

GET

/payments/{paymentId}/status

Retrieve current status of an initiated payment.

6 params → 200400401403404405406429

Bulk payments 3

Endpoints for executing bulk payments.

POST

/bulk-payments

Initiate a bulk payment.

7 params body → 201400401403405406415429

GET

/bulk-payments/{paymentId}

Retrieve content of an initiated bulk payment.

6 params → 200400401403404405406429

GET

/bulk-payments/{paymentId}/status

Retrieve current status of an initiated bulk payment.

6 params → 200400401403404405406429

General 1

Endpoints for interacting with the general data.

GET

/banks

Returns a list of banks.

8 params → 200400401403405406500

Funds confirmation 1

Endpoints for confirming funds in the account.

POST

/funds-confirmations

Used by the CBPII to confirm whether the amount of funds is available in the account.

5 params body → 200400401403405406415429

Direct payments 3

Some supported ASPSPs provide a more direct approach to some actions. Instead of retrieving prior user consent, actions can be executed directly, followed by an SCA confirmation i…

POST

/direct/payments/{bankIdentifier}

Initiate a single new payment.

7 params body → 201400401403405406415429

GET

/direct/payments/{bankIdentifier}/{paymentId}

Retrieve content of an initiated payment.

7 params → 200400401403404405406429

GET

/direct/payments/{bankIdentifier}/{paymentId}/status

Retrieve current status of an initiated payment.

7 params → 200400401403404405406429

Direct payments without Bank 3

Endpoints for executing direct payments (without acquiring previous consent).

POST

/direct/payments

Initiate a single new payment, with PSU selecting ASPSP during SCA.

7 params body → 201400401403405406415429

GET

/direct/payments/{paymentId}

Retrieve content of an initiated payment.

6 params → 200400401403404405406429

GET

/direct/payments/{paymentId}/status

Retrieve current status of an initiated payment.

6 params → 200400401403404405406429

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are SinglePayment (10 properties), AccountTransaction (10 properties), Account (8 properties), Bank (6 properties). Each schema is shown below with its type and property counts.

Account

object

8 properties 2 required

AccountResponse

object

1 property 1 required

AccountListResponse

object

1 property 1 required

AccountBalance

object

The object with the balance amount and currency.

2 properties 2 required

AccountBalanceList

object

1 property 1 required

AccountTransaction

object

10 properties 1 required

AccountTransactionList

object

The object containing a list of booked and pending transactions.

2 properties

AccountTransactionsResponse

object

The response object containing a list of transactions.

2 properties

RemittanceInformationStructured

object

The reference as contained in the structured remittance reference structure.

2 properties 1 required

StructuredAmount

object

An amount with a currency.

2 properties 2 required

AccountReference

object

The identifier of the addressed account.

4 properties

BankReference

object

The information about the payment receiver's institution. Mandatory to use with the [SWIFT](appendix--enum--payment-schemes) payment scheme.

3 properties

EmptyAdditionalErrors

array

UnauthorizedError

object

The unauthorized error object example.

5 properties 3 required

ForbiddenError

object

The forbidden error object example.

5 properties 3 required

NotFoundError

object

Not found.

5 properties 3 required

AccessExceededError

object

The forbidden error object example.

5 properties 3 required

InternalServerError

object

The forbidden error object example.

5 properties 3 required

NotAllowedError

object

A forbidden HTTP method.

5 properties 3 required

NotAcceptableError

object

An unsupported Accept header.

5 properties 3 required

UnsupportedMediaTypeError

object

An unsupported Content-Type header.

5 properties 3 required

AdditionalError

object

The error object providing additional error information.

3 properties 1 required

Error

object

The generic error object example.

5 properties 3 required

FundsConfirmationRequest

object

Contains a reference of the account that is being queried and a queried amount.

2 properties 2 required

FundsConfirmationResponse

object

Contains an answer if amount of funds is available or not.

1 property 1 required

Bank

object

6 properties 2 required

NextLinks

object

Links pointing to other pages.

1 property

PaymentLinks

object

Contains redirect information for a payment confirmation.

1 property

NextLink

object

The link pointing to the following page.

1 property

ScaRedirect

object

The link to which to redirect the PSU browser for a SCA confirmation of the payment.

1 property

TransactionStatus

object

Contains status of the payment.

1 property

CreditorAddress

object

An address of the account holder.

5 properties 1 required

SinglePayment

object

A JSON structure initiating a single payment.

10 properties 3 required

BulkSinglePayment

object

A JSON structure of a single payment inside a bulk payment.

6 properties 3 required

BulkPayment

object

A JSON structure initiating a bulk payment.

4 properties 1 required

PaymentResponse

object

A JSON body.

3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Tribe Payments publishes across the network.

Payment Gateway - Credit Card API

AE Profile APIs.io

Payment Gateway - Hosted Payments API (HPP)

AE Profile APIs.io

Payment Gateway - Credit Card Token API

AE Profile APIs.io

Payment Gateway - Reports API

AE Profile APIs.io

Point of Sale - Device Directory API

AE Profile APIs.io

Risk Monitor - Client API

AE Profile APIs.io

Open Banking - Bank API

AE Profile APIs.io

Issuer Processor - Program Manager API (PM API)

AE Profile APIs.io

Issuer Processor - Transaction Authorization Interface (TAI API)

AE Profile APIs.io

Acquiring Processor - Acquirer API (ACAPI)

AE Profile APIs.io

Acquiring Processor - Merchant API (MAPI)

AE Profile APIs.io

Acquiring Processor - Terminal API (TAPI)

AE Profile APIs.io

#Payments#Open Banking#Account-to-Account#Payment Initiation#United Kingdom

← Back to O APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Open Banking - Third-Party Providers API (TPP)

Metadata

Authentication & Security 2

Paths & Operations 18

Schemas 36

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Open Banking - Third-Party Providers API (TPP)

Metadata

Authentication & Security 2

Paths & Operations 18

Schemas 36

Specification

Source

More from Tribe Payments 12

API Details

Provider

Explore more