OPopenpayd

Create Account

Create an account for an individual or corporate.

post/accounts

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/accounts
  • Auth
    API key in header Authorization

Headers

idempotency-keystring

Optional header for retrying requests without accidentally creating the same transaction twice.

Request body

currencystring required

Three-letter ISO 4217 currency code indicating the currency in which the account will be opened. This determines the denomination of all transactions on the account. e.g. EUR

friendlyNamestring

A user-friendly label to help you identify this account within your environment or dashboard. This field is for display purposes only and does not affect the legal or operational status of the account. e.g. Billing Account

accountIdstring

Only applicable to Multi Currency accounts. The unique identifier of an existing account to which this new account should be linked. When provided, the new account will be created with the same IBAN as the referenced account, but denominated in the new currency.

ibanCountrystring

Required when opening a EUR account on the UK platform; must be set to MT. For FR-prefixed IBANs, please refer to the Allowed Countries for FR IBAN Accounts page.

endToEndReferencestring

A unique reference used to track or reconcile the account creation request across systems. This can be useful for correlating API calls, internal workflows, or audit trails.

Response

201

idstring
createdOnstring
statusstring
friendlyNamestring
masterboolean
primaryboolean
accountHolderIdstring
transactionCategorystring
accountHolderTypeunknown
mobileNumberunknown
supportMccyboolean
internalAccountIdstring

Example response

{
  "id": "dEVreXhHWGppSzJyNmlRRTRhY2hvUT09",
  "createdOn": "2023-09-12T09:46:19.124Z",
  "status": "PENDING",
  "actualBalance": {
    "currency": "EUR"
  },
  "availableBalance": {
    "currency": "EUR"
  },
  "friendlyName": "EUR Account",
  "accountHolderId": "ed7b1909-0091-4e39-aa1f-673059a431c4",
  "transactionCategory": "OTHER",
  "internalAccountId": "EUR05321124868470"
}

Changes

No recorded changes to this operation across all 1 revision of this API.