Get accounts list

Account

Get accounts list

POST

https://agents-api-sit.finci.com:5500/v1/get-accounts

Returns the list of accounts that match the submitted filter criteria.

Headers

X-Auth-Token

string

Required

Partner Token

X-Auth-Signature

string

Required

Signature of the request body

X-Auth-Timestamp

string

Required

Request timestamp (Unix Epoch in UTC).

Request body

person_id

string

Person ID. Must be filled if account owner is a private person

Examples:

10011000000000000001

corporate_id

string

Corporate ID. Must be filled if account owner is a corporate.

Examples:

10011100000000000001

Response

Accounts list

status

string

success

string

error

string

errors

array of string

Error codes list

items

array of object

List of accounts

external_number

string

External Number. Must be unique for every account. Digits only, 6 to 20 characters.

currency_code

string

Defaults: EUR

AED

string

AFN

string

ALL

string

AMD

string

ANG

string

AOA

string

ARS

string

AUD

string

AWG

string

AZN

string

BAM

string

BBD

string

BDT

string

BGN

string

BHD

string

BIF

string

BMD

string

BND

string

BOB

string

BOV

string

BRL

string

BSD

string

BTN

string

BWP

string

BYN

string

BZD

string

CAD

string

CDF

string

CHE

string

CHF

string

CHW

string

CLF

string

CLP

string

CNY

string

COP

string

COU

string

CRC

string

CUC

string

CUP

string

CVE

string

CZK

string

DJF

string

DKK

string

DOP

string

DZD

string

EGP

string

ERN

string

ETB

string

EUR

string

FJD

string

FKP

string

GBP

string

GEL

string

GHS

string

GIP

string

GMD

string

GNF

string

GTQ

string

GYD

string

HKD

string

HNL

string

HRK

string

HTG

string

HUF

string

IDR

string

ILS

string

INR

string

IQD

string

IRR

string

ISK

string

JMD

string

JOD

string

JPY

string

KES

string

KGS

string

KHR

string

KMF

string

KPW

string

KRW

string

KWD

string

KYD

string

KZT

string

LAK

string

LBP

string

LKR

string

LRD

string

LSL

string

LYD

string

MAD

string

MDL

string

MGA

string

MKD

string

MMK

string

MNT

string

MOP

string

MRU

string

MUR

string

MVR

string

MWK

string

MXN

string

MXV

string

MYR

string

MZN

string

NAD

string

NGN

string

NIO

string

NOK

string

NPR

string

NZD

string

OMR

string

PAB

string

PEN

string

PGK

string

PHP

string

PKR

string

PLN

string

PYG

string

QAR

string

RON

string

RSD

string

RUB

string

RWF

string

SAR

string

SBD

string

SCR

string

SDG

string

SEK

string

SGD

string

SHP

string

SLL

string

SOS

string

SRD

string

SSP

string

STN

string

SVC

string

SYP

string

SZL

string

THB

string

TJS

string

TMT

string

TND

string

TOP

string

TRY

string

TTD

string

TWD

string

TZS

string

UAH

string

UGX

string

USD

string

USN

string

UYI

string

UYU

string

UYW

string

UZS

string

VES

string

VND

string

VUV

string

WST

string

XAF

string

XCD

string

XOF

string

XPF

string

YER

string

ZAR

string

ZMW

string

ZWL

string

XBT

string

ETH

string

USC

string

UST

string

balance

number

Balance on account

Required range: 0 <= x <= 9999999999.99

balance_hold

number

Hold balance on account

Required range: 0 <= x <= 9999999999.99

total

integer

Total number of accounts

Example request

curl --request POST \
     --url https://agents-api-sit.finci.com:5500/v1/get-accounts \
     --header 'X-Auth-Signature: string' \
     --header 'X-Auth-Timestamp: string' \
     --header 'X-Auth-Token: string' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "person_id": "10011000000000000001",
  "corporate_id": "10011100000000000001"
}
'

Example response

{
  "status": "success",
  "errors": [
    "string"
  ],
  "items": [
    {
      "external_number": "string",
      "currency_code": "AED",
      "balance": 9999999999.99,
      "balance_hold": 9999999999.99
    }
  ],
  "total": 0
}

Create an account Update account balance

Built with