Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB
Payment Instrument Registration

Register with an open banking account

Create an account with an open banking provider

post/payment-instrument-registrations

Request body

typestring required

Discriminator field. Please see the discriminator mapping for the RegistrationRequest schema.

Example request

{
  "type": "trustly",
  "customer": {
    "customerId": "def456",
    "firstName": "John",
    "lastName": "Smith",
    "country": "GB",
    "postcode": "EH12 5JB",
    "town": "Edinburgh",
    "addressLine1": "Stanhope House",
    "addressLine2": "Address Line 2",
    "phoneNumber": "+44 123 1110000",
    "dateOfBirth": "2000-01-01",
    "documentId": "ABC-123456",
    "email": "a.b@example.com"
  },
  "bank": {
    "bankNumber": "6112",
    "clearingHouse": "SWEDEN",
    "accountNumber": "123123"
  }
}

Response

Successfully registered an account at an Open Banking provider

codestring required

Response Code signifying the outcome of the request.

messagestring required

A description of the outcome of the request.

idstring required

The ID of this request. If you can include these when querying the outcome of individual requests, we can track down the root cause faster.

paymentInstrumentRegistrationIdstring required

The ID of the registration record.

typestring required

Discriminator field. Please see the discriminator mapping for the RegistrationResponse schema.

accountIdstring required

The returned account ID from the trustly registration request

clearingHousestring required

The clearing house of the end-user's bank account. Typically the name of a country in uppercase letters.

bankstring required

The name of the bank which is tied to the account

descriptorstring required

A descriptor for this account that is safe to show to the end user.

Example response

{
  "code": "1000",
  "id": "a7f45953-1e8b-4f33-87b0-3293f4f6972f",
  "paymentInstrumentRegistrationId": "9450a0b0-c62a-457f-9eb0-39c36d883557",
  "type": "trustly",
  "clearingHouse": "SWEDEN"
}