Accounts

What is an account in Paynetics?

Accounts are entities created against a merchant or user with the respective program. They can have one or multiple balances depending on your program.

Paynetics Account Core Functionalities

Accounts at Paynetics can perform a large number of operations.

IBAN - Accounts can have one or multiple IBANs depending on the program.

Supported currencies: EUR, BGN, GBP (Account number + Sort Code)

Virtual Accounts - Virtual accounts are linked to one main account and do not hold a balance. Instead, they are using the primary (main) account balance.

Card - A single card can be issued to an account. Cards can be plastic and/or virtual.

Money transfers - Account holders can send and receive money internally to/from another Paynetics account or externally to/from any IBAN.

Spend money by card - Cards can be used to pay in any physical location, online or withdraw money from ATMs.

Load - There are multiple ways accounts can be loaded:

via wire transfer from an external bank by IBAN
via external bank card
via internal bank transfer (P2P)

Type of accounts

There are several types of accounts that can be created:

Glossary

merchant - all legal entity clients of Paynetics
user - all natural parsons clients of Paynetics
balance - a record of available funds that is always linked with an IBAN or balance token.

How to Create an Account?

Accounts are created via an API request. Each request should include the program and the merchant/user associated with it.

For cases where IBAN/Account Number creation is allowed by the program, but should be omitted for a specific account, a property in the API request can be used to skip that step.

For cases where a virtual account must be created, please include the primary (main) account identifier in the API request. It is mandatory that the primary (main) account is opened to the same merchant/user as in the request.

If the request is successful, the API response will return an account identifier and an array of balances with identifiers to each one. It is recommended these identifiers are stored by external parties for later usage.

Endpoint

POST /v2/accounts

Operation

account_create

Request Structure

program string (0,any)

merchant string (0,any)

user string (0,any)

main string (0,any)

skip_iban_generation boolean

alias string (0,any)

Request

Response Structure

code integer (0,any)

Response

There are 3 statuses that an account can have:

There are two different APIs for account status change. One is for changing between active/inactive status and a separate one is used for account termination since it is an irreversible process.

Active

By default, accounts are created in active status. This means that the account can be loaded using an external bank card, wire transfer, or internal transfer. Wire/internal transfers can also be initiated by the account owner.

Active accounts can have plastic and/or virtual cards that can be used to spend available funds.

Inactive

Inactive status restricts the account holder to spend or receive any funds. Cards cannot be issued. This status is reversible to active. If any cards are issued to the account, they are frozen as well as any Apple/Google tokens

Closed

Closed have same properties as inactive but it also destroys all cards issued, remove all apple/google tokens. Account closure is an irreversible operation.

{ PUT }

Endpoint

PUT /v2/accounts/{account}/status

Operation

account_status

Parameters

[ account ]

Token from account creation

Request Structure

status string (0,any)

Available Options: active , blocked

Request

Response Structure

code integer (0,any)

Response

{ DELETE }

Endpoint

DELETE /v2/accounts/{account}

Operation

account_terminate

Parameters

[ account ]

Token from account creation

Response Structure

code integer (0,any)

Response

Account List

Account list/details can be extracted using API.

List API is used to extract basic information for all accounts associated with an instance. There are several filters that can be used to refine your query.

Endpoint

GET /v2/accounts/{page}/{limit}

Operation

accounts_list

Parameters

[ page ]

Starting from page 1

[ limit ]

Maximum per page 10

Filters

merchant - (Token of merchant)

user - (Token of user)

program - (Code of program)

Response Structure

code integer (0,any)

Response

Account details

Details API is used to return full information for the account and associated balances.

Endpoint

GET /v2/accounts/{account}

Operation

account_details

Parameters

[ account ]

Token from account creation

Response Structure

code integer (0,any)

Response