Create a settlement account
Adds one of the merchant’s own bank accounts to receive funds. It is APPROVED automatically only when Equals has given the merchant the top-up permission or the account is an Equals account; otherwise it is PENDING until Equals approves or rejects it. It becomes the default if the merchant has no other. Full bank details are never returned. Returns 400 if bankId is not a listed bank.
Authorizations
Query Parameters
The ID of the account to work with.
"F50091"
Body
Body
The merchant's name for the account. Letters, digits, spaces and & only.
1 - 18^[a-zA-Z0-9\s&]+$"Main account"
ISO-4217 code of a currency Roqqett can take payments in: GBP over Faster Payments, EUR over SEPA Instant.
GBP, EUR "GBP"
SORT_CODE for a GBP account, IBAN for a EUR account.
- Option 1
- Option 2
The bank that holds the account, which refunds are paid from. Can be set later.
1 - 50"1ffe704d39629a929c8e293880fb449a"
Response
Created
The ID of a settlement account: one of the merchant's own bank accounts that SHOPPING checkouts pay into.
36"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64"
The merchant's name for the account. null when none was stored.
1 - 18"Main account"
ISO-4217 code of a currency Roqqett can take payments in: GBP over Faster Payments, EUR over SEPA Instant.
GBP, EUR "GBP"
- Option 1
- Option 2
The bank that holds the account, which refunds are paid from. null until set; refunds from this account fail until it is.
1 - 50"1ffe704d39629a929c8e293880fb449a"
Name of the bank that holds the account.
140"Example Bank"
Only an APPROVED account can receive funds or be set on a checkout. A new account is APPROVED automatically only when Equals has given the merchant the top-up permission (canCreateTopUpCheckouts) or the account is an Equals account; otherwise it stays PENDING until Equals approves or rejects it. Merchants cannot set it.
PENDING, APPROVED, REJECTED "APPROVED"
Whether SHOPPING checkouts with no settlement account of their own pay into this one. The merchant's first account becomes the default.
Checkouts that pay into this account. An account cannot be deleted while any do.
The ID of a checkout: the configured payment page a checkout session is taken on.
36The open banking connection that lets Roqqett read this account's transactions for reconciliation.
The date the Resource was initially created. ISO 8601 format without milliseconds.
The date the Resource was last modified. ISO 8601 format without milliseconds.