Create Payment

POST /payments

Description

Create a new payment record.

Authentication

Bearer Token

Request

Headers

Header	Value	Required
Authorization	Bearer {{token}}	Yes
Content-Type	application/json	Yes

Request Body

{
  "paymentMethodLabel": "CASH",
  "transactionNetAmount": 17.2500,
  "transactionCharge": 0,
  "transactionGatewayCharge": 0,
  "transactionMerchantCommission": 0.43125,
  "transactionTax": 0,
  "transactionTotalAmount": 17.2500,
  "reference": "SINV-00003",
  "postingDate": "2026-04-09",
  "transactionCurrency": "USD",
  "partyType": "CUSTOMER",
  "partyIdString": "95dcdd26-9915-4631-b418-c738172d2140",
  "paymentType": "RECEIVE",
  "companyIdString": "7990aa7d-fcff-4c15-86a8-337ea1b0e3c3",
  "isGlOnly": false
}

Field	Type	Required	Description
paymentMethodLabel	string	Yes	Payment method (e.g., CASH, ECOCASH)
transactionNetAmount	number	Yes	Net transaction amount
transactionCharge	number	Yes	Transaction charge
transactionGatewayCharge	number	Yes	Gateway processing charge
transactionMerchantCommission	number	Yes	Merchant commission
transactionTax	number	Yes	Tax amount
transactionTotalAmount	number	Yes	Total transaction amount
reference	string	Yes	Payment reference
postingDate	string (date)	Yes	Posting date
transactionCurrency	string	Yes	Currency code
partyType	string	Yes	Party type (e.g., CUSTOMER, SUPPLIER)
partyIdString	string (UUID)	Yes	Party ID
paymentType	string	Yes	Payment type (e.g., RECEIVE, PAY)
companyIdString	string (UUID)	Yes	Company ID
isGlOnly	boolean	Yes	Whether this is a GL-only entry