POS Balance Enquiry

curl --request POST \
  --url https://api.staging.paycodefintech.net/terminals/balance-enquiry \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "terminal_id": "<string>",
  "network_token": "<string>",
  "card": {
    "pan": "<string>",
    "expiry_date": "<string>",
    "sequence_number": "<string>",
    "entry_mode": "<string>",
    "track1": "<string>",
    "track2": "<string>"
  },
  "merchant": {
    "id": "<string>",
    "category_code": "<string>",
    "name_and_location": "<string>"
  },
  "acquirer": {
    "id": "<string>",
    "country": "<string>"
  },
  "poi": {
    "id": "<string>",
    "terminal_type": "<string>"
  },
  "cardholder": {
    "authentication": {
      "protected_pin_data": "<string>",
      "new_pin_data": "<string>"
    }
  },
  "transaction_amounts": {
    "currency": "<string>",
    "total_amount": "<string>",
    "exchange_rate": "<string>",
    "cardholder_billing_amount": "<string>",
    "cardholder_billing_currency": "<string>"
  },
  "transaction_id": {
    "reference": "<string>",
    "sys_trace_audit_number": "<string>",
    "transmission_date_time": "2023-11-07T05:31:56Z"
  },
  "emv_data": {},
  "initiating_party": {
    "terminal_id": "<string>",
    "additional_info": "<string>"
  }
}
'

{
  "transaction_id": "<string>",
  "is_successful": true,
  "currency": "<string>",
  "message": "<string>",
  "available_balance": "<string>",
  "additional_amounts": [
    "<unknown>"
  ],
  "timestamp": "2023-11-07T05:31:56Z",
  "response_code": "<string>",
  "raw_response": "<string>"
}

POST

terminals

balance-enquiry

POS Balance Enquiry

curl --request POST \
  --url https://api.staging.paycodefintech.net/terminals/balance-enquiry \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "terminal_id": "<string>",
  "network_token": "<string>",
  "card": {
    "pan": "<string>",
    "expiry_date": "<string>",
    "sequence_number": "<string>",
    "entry_mode": "<string>",
    "track1": "<string>",
    "track2": "<string>"
  },
  "merchant": {
    "id": "<string>",
    "category_code": "<string>",
    "name_and_location": "<string>"
  },
  "acquirer": {
    "id": "<string>",
    "country": "<string>"
  },
  "poi": {
    "id": "<string>",
    "terminal_type": "<string>"
  },
  "cardholder": {
    "authentication": {
      "protected_pin_data": "<string>",
      "new_pin_data": "<string>"
    }
  },
  "transaction_amounts": {
    "currency": "<string>",
    "total_amount": "<string>",
    "exchange_rate": "<string>",
    "cardholder_billing_amount": "<string>",
    "cardholder_billing_currency": "<string>"
  },
  "transaction_id": {
    "reference": "<string>",
    "sys_trace_audit_number": "<string>",
    "transmission_date_time": "2023-11-07T05:31:56Z"
  },
  "emv_data": {},
  "initiating_party": {
    "terminal_id": "<string>",
    "additional_info": "<string>"
  }
}
'

{
  "transaction_id": "<string>",
  "is_successful": true,
  "currency": "<string>",
  "message": "<string>",
  "available_balance": "<string>",
  "additional_amounts": [
    "<unknown>"
  ],
  "timestamp": "2023-11-07T05:31:56Z",
  "response_code": "<string>",
  "raw_response": "<string>"
}

Authorizations

api-key

string

header

required

Use the API key created under your merchant account from the Paycode dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Body

application/json

Request payload for POS balance enquiry

terminal_id

string

required

Terminal ID (required)

network_token

string

required

network-token

card

object

required

Card Information for POS transactions

Show child attributes

card.pan

string | null

Primary Account Number (PAN) - either PAN or Track2 must be provided

card.expiry_date

string | null

Card expiry date (YYMM format)

card.sequence_number

string | null

Card sequence number

card.entry_mode

string | null

Entry mode (e.g., "CHIP", "SWIPE", "CONTACTLESS")

card.track1

string | null

Track 1 data if available

card.track2

string | null

Track 2 data if available - either PAN or Track2 must be provided

merchant

object

required

Merchant Information for POS transactions

Show child attributes

merchant.id

string

required

Merchant ID (required)

merchant.category_code

string | null

Merchant Category Code (MCC)

merchant.name_and_location

string | null

Merchant name and location

acquirer

object

required

Acquirer Information for POS transactions

Show child attributes

acquirer.id

string

required

Acquirer ID (required)

acquirer.country

string | null

Acquirer country code

poi

object

required

Point of Interaction (Terminal) Information

Show child attributes

poi.id

string

required

Terminal ID (required)

poi.terminal_type

string | null

Terminal type

cardholder

object

required

Cardholder Information

Show child attributes

cardholder.authentication

object

Cardholder Authentication Data

Show child attributes

cardholder.authentication.protected_pin_data

string | null

Protected PIN data

cardholder.authentication.new_pin_data

string | null

New PIN data if applicable

transaction_amounts

object

required

Transaction Amounts Information

Show child attributes

transaction_amounts.currency

string

required

Currency code (required)

transaction_amounts.total_amount

string | null

Transaction amount (for balance enquiry, this might be 0)

transaction_amounts.exchange_rate

string | null

Exchange rate

transaction_amounts.cardholder_billing_amount

string | null

Cardholder billing amount

transaction_amounts.cardholder_billing_currency

string | null

Cardholder billing currency

transaction_id

object

required

Transaction Identification

Show child attributes

transaction_id.reference

string

required

Unique transaction reference (required)

transaction_id.sys_trace_audit_number

string | null

System trace audit number (STAN)

transaction_id.transmission_date_time

string<date-time> | null

Transmission date and time

emv_data

object

EMV data if available

Show child attributes

emv_data.{key}

string

initiating_party

object

Initiating Party Information

Show child attributes

initiating_party.terminal_id

string | null

Terminal identification

initiating_party.additional_info

string | null

Additional party information

Response

Balance enquiry successful

Response payload for POS balance enquiry

transaction_id

string

required

Transaction ID

is_successful

boolean

required

Status of the enquiry

currency

string

required

Currency code

message

string

required

Response message

available_balance

string | null

Available balance (in smallest currency unit, e.g., cents)

additional_amounts

any[] | null

Additional amounts (e.g., ledger balance, hold amount)

timestamp

string<date-time> | null

Response timestamp

response_code

string | null

Response code from the payment system

raw_response

string | null

Raw response from the payment system if available

File Import

⌘I

Organization

Merchant

Merchant API Key

Terminal

POS

POS Balance Enquiry

Authorizations

Body

Response