API reference

Payments & Billing

Configure payment gateways and modes, store gateway credentials, initiate online payments, and reconcile against billing transactions and balance. Payment-provider partners integrate gateway configuration and reconciliation here. Order-level payments are covered under Orders.

Base URLhttps://zopping.com

Payment gateways

The gateway providers available to a retailer (e.g. Razorpay, PayU) and the payment modes each supports. requiredConfigs lists the credential fields a provider needs.

Fields

Field	Type	Description
`id`	stringread-only
`providerName`	stringrequired	Gateway vendor.
`status`	string
`requiredConfigs`	object[]	Credential fields the provider needs.
`paymentModes`	object[]	Supported modes + per-mode `rate`.

GET/api/account-service/payment-gateway

List payment gateways

Parameters

Parameter	Type	Description
`organizationId`required	string· query

Response

{
  "paymentgateway": [
    {
      "id": "pg_1",
      "providerName": "Razorpay",
      "status": "ENABLED",
      "paymentModes": [
        {
          "paymentMode": "UPI",
          "rate": "0.00"
        }
      ]
    }
  ],
  "count": 1
}

Payment modes

The individual methods (UPI, CARD, NETBANKING, WALLET, COD) with their display config and commission rate.

GET/api/account-service/payment-mode

List payment modes

Parameters

Parameter	Type	Description
`organizationId`required	string· query

Gateway credentials

Store the access/secret keys for a gateway, at organization or store level (isStoreLevel). These secrets are write-only from your side.

Fields

Field	Type	Description
`organizationId`	stringrequired
`accessKey`	string	Gateway public key.
`secretKey`	stringrequired	Gateway private key.
`storeId`	integer	Set for store-level credentials.
`isStoreLevel`	boolean

POST/api/account-service/online-payment

Store gateway credentials

Request body

{
  "organizationId": "<org-id>",
  "accessKey": "rzp_live_xxx",
  "secretKey": "••••••",
  "isStoreLevel": false
}

GET/api/account-service/online-payment

List credentials

Parameters

Parameter	Type	Description
`organizationId`required	string· query

PUT/api/account-service/online-payment

Update credentials

Online payments

Initiate an online payment and track it to completion. The create response returns a redirectUrl + transactionHmac to hand off to the gateway; poll the list/get endpoints for final status.

Fields

Field	Type	Description
`id`	integerread-only
`amount`	numberrequired
`referenceNumber`	stringread-only	Unique payment reference.
`status`	enum	`PENDING` · `COMPLETED` · `FAILED`.
`gatewayTransactionId`	stringread-only	For reconciliation.

POST/api/billing-service/online-payment

Initiate an online payment

Request body

{
  "organizationId": "<org-id>",
  "amount": 1500.5,
  "service": "WHATSAPP",
  "duration": "2026-06"
}

Response

{
  "transactionAmount": "1500.50",
  "redirectUrl": "https://pay.gateway/...",
  "transactionId": 90871,
  "transactionHmac": "…",
  "currency": "INR"
}

GET/api/billing-service/online-payment

List online payments

Parameters

Parameter	Type	Description
`organizationId`required	string· query
`referenceNumber`	string· query
`status`	enum· query

GET/api/billing-service/online-payment/{id}

Get a payment

Parameters

Parameter	Type	Description
`id`required	integer· path
`organizationId`required	string· query

Transactions

The billing ledger. Filter by type (CREDIT/DEBIT), status, date range and service. Use gatewayTransactionId to reconcile against your records.

Fields

Field	Type	Description
`id`	integerread-only
`amount`	stringread-only
`currency`	stringread-only
`type`	enum	`CREDIT` or `DEBIT`.
`status`	enum	`COMPLETED` · `PENDING` · `FAILED`.
`gatewayTransactionId`	stringread-only
`verificationStatus`	enum

GET/api/billing-service/transaction

List transactions

Parameters

Parameter	Type	Description
`organizationId`required	string· query
`page`	integer· query
`perPage`	integer· query	Default 20, max 100.
`type`	enum· query	CREDIT / DEBIT.
`status`	enum· query
`startDate`	string· query	yyyy-MM-dd HH:mm:ss.
`endDate`	string· query

GET/api/billing-service/transaction/{id}

Get a transaction

Parameters

Parameter	Type	Description
`id`required	integer· path
`organizationId`required	string· query

Balance

The current ledger balance for the organization.

GET/api/billing-service/balance

Get balance

Parameters

Parameter	Type	Description
`organizationId`required	string· query

Response

{
  "organizationId": "<org-id>",
  "balance": 12450.75
}