Retrieve balances | Citi Docs Demo

curl -G https://{{baseurl}}/merchant/v1/walletBalances \
     -H "Country-Code: US" \
     -H "Authorization: Bearer <token>" \
     -d currency=USD \
     -d limit=5379 \
     -d merchant_id=1132547457567 \
     -d page_no=1017 \
     -d sort_by=string \
     -d sort_type=ASC \
     -d wallet_id=1132547457567

{
  "balance_information": [
    {
      "wallet_id": "string",
      "merchant_id": "string",
      "account_ref": "22SDKJ29DJW32EDJ3EJ2E3JIU8SDDS2",
      "account_number": "TR123456789012345678901234",
      "currency_code": "TRY",
      "account_name": "CITIBANK NA",
      "account_type": "2-Saving",
      "branch_code": "234",
      "legal_entity": "ASIA 4.6",
      "branch_name": "Central Branch",
      "balance_details": {
        "opening_available_balance": "10.01",
        "closing_available_balance": "10.01",
        "current_available_balance": "10.01",
        "opening_ledger_balance": "10.01",
        "closing_ledger_balance": "10.01",
        "total_credit_amount": "10.01",
        "total_debit_amount": "10.01",
        "net_amount": "10.01",
        "statement_date": "2024-04-22T00:00:00.000+00:00",
        "bank": "CITIBANK",
        "closing_available_balance_eqv_ccy": "10.01",
        "closing_ledger_balance_eqv_ccy": "10.01",
        "country": "Finland",
        "eod_date": "2024-04-22T00:00:00.000+00:00",
        "fx_rate": "4.1",
        "legal_entity": "Jacky Smith",
        "opening_available_balance_eqv_ccy": "10.01",
        "opening_ledger_balance_eqv_ccy": "10.01",
        "effective_rate": "4.1",
        "intraday_available_balance": "10.01",
        "intraday_ledger_balance": "10.01",
        "intraday_available_balance_eqv_ccy": "10.01",
        "intraday_ledger_balance_eqv_ccy": "10.01",
        "intraday_last_update_date_time": "2024-04-22T00:00:00.000+00:00",
        "customer_legal_name": "Jacky Smith",
        "iban_account_number": "FI21 1234 5698 7654 3210",
        "country_code": "CN",
        "region_name": "ASIA",
        "last_entry_date": "2024-04-22T00:00:00.000+00:00",
        "bank_rte_id": "042000013",
        "customer_name": "Jacky Smith",
        "customer_number": "1111111111111",
        "overdraft_details": {
          "overdraft_amount": "13.21"
        }
      }
    },
    {
      "wallet_id": "string",
      "merchant_id": "string",
      "account_ref": "22SDKJ29DJW32EDJ3EJ2E3JIU8SDDS2",
      "account_number": "TR123456789012345678901234",
      "currency_code": "TRY",
      "account_name": "CITIBANK NA",
      "account_type": "2-Saving",
      "branch_code": "234",
      "legal_entity": "ASIA 4.6",
      "branch_name": "Central Branch",
      "balance_details": {
        "opening_available_balance": "10.01",
        "closing_available_balance": "10.01",
        "current_available_balance": "10.01",
        "opening_ledger_balance": "10.01",
        "closing_ledger_balance": "10.01",
        "total_credit_amount": "10.01",
        "total_debit_amount": "10.01",
        "net_amount": "10.01",
        "statement_date": "2024-04-22T00:00:00.000+00:00",
        "bank": "CITIBANK",
        "closing_available_balance_eqv_ccy": "10.01",
        "closing_ledger_balance_eqv_ccy": "10.01",
        "country": "Finland",
        "eod_date": "2024-04-22T00:00:00.000+00:00",
        "fx_rate": "4.1",
        "legal_entity": "Jacky Smith",
        "opening_available_balance_eqv_ccy": "10.01",
        "opening_ledger_balance_eqv_ccy": "10.01",
        "effective_rate": "4.1",
        "intraday_available_balance": "10.01",
        "intraday_ledger_balance": "10.01",
        "intraday_available_balance_eqv_ccy": "10.01",
        "intraday_ledger_balance_eqv_ccy": "10.01",
        "intraday_last_update_date_time": "2024-04-22T00:00:00.000+00:00",
        "customer_legal_name": "Jacky Smith",
        "iban_account_number": "FI21 1234 5698 7654 3210",
        "country_code": "CN",
        "region_name": "ASIA",
        "last_entry_date": "2024-04-22T00:00:00.000+00:00",
        "bank_rte_id": "042000013",
        "customer_name": "Jacky Smith",
        "customer_number": "1111111111111",
        "overdraft_details": {
          "overdraft_amount": "13.21"
        }
      }
    }
  ]
}

It retrieve balances.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

merchant_idintegerOptional

Unique reference by citi for merchant.

wallet_idintegerOptional

Virtual account

currencystringOptional

Unique end-to-end transaction reference, should adhere to the pattern: ^[a-f0-9]8-[a-f0-9]4-4[a-f0-9]3-[89ab][a-f0-9]3-[a-f0-9]12$.

limitintegerOptional

The number of records to display per page.

page_nointegerOptional

You can input a page number and receive the data specific to a requested page. Page number is determined based on pagination metadata received in the response header of the initial request.

sort_bystringOptional

This parameter contains one or more sort criteria.

sort_typestringOptional

Sorting direction
- DESC - Descending order sorting
- ASC - Ascending order sorting

Response headers

apim_guidstringOptional

pagination-metadatastringOptional

Response

Success response for the delete file upload request

balance_informationlist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response headers

Response

Errors