Documentation

Creates a new merchant payment account.

post
https://api-sandbox.nofrixion.com/api/v1/accounts

Authorization: End user or Merchant token is required.

User permissions required: CanCreateAccounts

Body Params

The details of the payment account to create.

uuid

The ID of the merchant the payment account is being created for.

string
enum

Currency for the account, only EUR, GBP, USD and in sandbox BTC are supported.

string | null

The name for the account. This name is descriptive only, and will not be used when sending payments, but it should still be set to something that identifies the purpose of the funds. For example "EUR Payment" would be suitable to for an account used for general purpose business payments.

uuid

For internal use only. Leave empty unless requested otherwise.

string | null
enum

If specified the account type will be set to the specified value disregarding the merchant default account type.

Allowed:
uuid | null

For EUR accounts this can be set to the ID of another account that will act as the backing physical account. The new account will then act as a Virtual account, able to receive funds but the transactions will be recorded against the backing physical account.

boolean

Optional property to indicate whether the account is a trust account. The account name is displayed on the statement for trust accounts instead of the merchant name.

roleIDs
array of uuids | null

Optional list of role IDs that will get access to the payment account when created. Creator user's roles will always be able to access the account. If not specified, the account will be accessible by all the merchant's roles. If specified as an empty list, the account will only be accessible by the creator user.

roleIDs
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

201

The payment account was successfully created and is ready to use.

202

The payment account was created but the is not yet ready to use.

Updated 9 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
Updated 9 months ago