---
title: "Register with an open banking account"
method: POST
path: "/payment-instrument-registrations"
tags: ["Payment Instrument Registration"]
---

# Register with an open banking account

`POST /payment-instrument-registrations`

## Request

- Base URL: `https://sandbox.comcarde.com/v1`
- URL: `https://sandbox.comcarde.com/v1/payment-instrument-registrations`
- Auth: HTTP bearer

Create an account with an open banking provider

## Request body

- RegistrationRequest
  - `type` string, required: Discriminator field. Please see the discriminator mapping for the RegistrationRequest schema.
  - `customer` TrustlyRegistrationCustomerDetails, required: The details of the customer who this account is being created for
    - `customerId` string, required: Customer's customer ID.
    - `firstName` string, required: Customer's first name.
    - `lastName` string, required: Customer's last name.
    - `country` string: ISO 3166 Alpha-2 Country code
    - `postcode` string: The post code of the customer's home address.
    - `town` string: The town of the customer's home address.
    - `addressLine1` string: The first line of the customer's home address.
    - `addressLine2` string: The second line of the customer's home address.
    - `phoneNumber` string: Customer's telephone number. Please use only numbers, spaces and an optional leading +.
    - `dateOfBirth` string, date: Customer's date of birth. ISO Format (YYYY-MM-DD)
    - `documentId` string: Customer's social security number / personal number / birth number / etc. Used by some countries (currently only Sweden) to perform additional verification when logging into a bank account.
    - `email` string, email: Customer's email.
  - `bank` TrustlyRegistrationBankDetails, required: The details of the bank account being registered.
    - `bankNumber` string: The bank number identifying the customer's bank.
    - `clearingHouse` string, required: The clearing house of the end-user's bank account. Typically the name of a country in uppercase letters.
    - `accountNumber` string, required: The account number identifying the customer's account in the bank.

## Response `200`

Successfully registered an account at an Open Banking provider

- RegistrationResponse
  - `code` string, required: [Response Code](https://docs.br-dge.io/docs/response-codes) signifying the outcome of the request.
  - `message` string, required: A description of the outcome of the request.
  - `id` string, 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.
  - `paymentInstrumentRegistrationId` string, required: The ID of the registration record.
  - `type` string, required: Discriminator field. Please see the discriminator mapping for the RegistrationResponse schema.
  - `accountId` string, required: The returned account ID from the trustly registration request
  - `clearingHouse` string, required: The clearing house of the end-user's bank account. Typically the name of a country in uppercase letters.
  - `bank` string, required: The name of the bank which is tied to the account
  - `descriptor` string, required: A descriptor for this account that is safe to show to the end user.

## Other responses

- `400`: Payment instrument registration request failed
- `500`: An internal server error occurred upstream while processing the request. If you have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at <https://comcarde.atlassian.net/servicedesk/customer/portals> with the `id` from the response so we track down the individual requests on our end.

---

[API](https://skmtc.dev/br-dge/apis/br-dge-payment-instrument-rest-api.md) - [All operations](https://skmtc.dev/br-dge/apis/br-dge-payment-instrument-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/br-dge/apis/br-dge-payment-instrument-rest-api/revisions/700277cae488?raw)