Skip to main content
Create a bank account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.

Required string length: 1 - 257
Pattern: ^(?:([\x21\x23-\x5B\x5D-\x7E]{1,255})|"([\x21\x23-\x5B\x5D-\x7E]{1,255})")$

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
currency
string
required
Pattern: ^[A-Z]{3}$
country
string
required

Must be a country Quidkey activates for domestic payments.

Pattern: ^[A-Z]{2}$
account_holder_name
string
required
Minimum string length: 1
iban
string

Write-only. An IBAN that can't address the account's country is refused. Which identifiers a country needs is listed in the reference.

Minimum string length: 1
account_number
string

Write-only.

Minimum string length: 1
bban
string

Write-only.

Minimum string length: 1
plusgiro_number
string

Write-only.

Minimum string length: 1
bic
string
Minimum string length: 1
sort_code
string
Minimum string length: 1
routing_number
string
Minimum string length: 1
bsb
string
Minimum string length: 1
payment_schemes
object[]

Read-only after create. Left out, the country's schemes are attached and active, except an additional payment method such as multibanco, which an account only has by naming it. What a country offers is on the country's payment_schemes.

Required array length: 1 - 10 elements

The person authorises Quidkey and its processors to debit this account for amounts due to Quidkey. agreements must hold the current bank_debit_authorization version and nothing else. Optional. Send it to record the person's acceptance with the create, or accept later through agreement_acceptance.

Response

The bank_account, in the full view.

result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required