Create Account

Create a new account.

Account status and lifecycle

The status field reflects where the account is in its lifecycle. Possible values are:

  • PROVISIONING: the account is being set up and is not yet operational.
  • ACTIVE: the account is operational.
  • SUSPENDED: operations are temporarily disabled (e.g. compliance, fraud, legal hold or review).
  • CLOSED: terminal state — the account has been closed.
  • REJECTED: terminal state — onboarding was deliberately denied (KYC/KYB/compliance).

Depending on the rail, a new account may be returned as ACTIVE right away, or start in PROVISIONING and move to ACTIVE once setup finishes. The status in this endpoint's response is the account's initial state.

Every time the status changes afterwards, a webhook is sent as an HTTP POST to the status_callback_url provided in the request body. The body of that webhook is the account object, using the same schema as the Get Account Details response. No webhook is sent for the initial state, nor when an update leaves the status unchanged.

Testing in sandbox

Account creation is currently synchronous: the account's status is returned directly in this endpoint's response. In the sandbox, create the account with label set to SIMULATE_STATUS_<STATUS> (e.g. SIMULATE_STATUS_SUSPENDED) to have it created directly in that status, or to SIMULATE_PROVISIONING_FLOW to simulate the PROVISIONINGACTIVE transition and its webhook.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Currency of the account

string
enum
required

Country of the account

string
required
length ≤ 100

Label of the account

products
array of objects
required

List of products associated with the account. Requires the product to be already enabled for the company. Valid values: PAYOUTS, PAYINS, INTERNAL_TRANSFER

Products*
Allowed:
string

URL for movement notifications (will follow the same schema as the Get Movement endpoint)

string

Callback URL for account-level events (e.g. account status changes). The notification is sent as a POST request whose body is the account object, using the same schema as the Get Account endpoint.

string
length ≤ 128

A unique key that ensures a request is processed only once. If the same key is sent with multiple requests, the server returns the original response instead of performing the action again.

string

UUID of the account owner, previously created via the Create Account Owner endpoint

Headers
integer

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json