Transaction model

This is the full transaction entity. The endpoints you integrate against return smaller views of it:

Initiate Transaction returns only referenceNumber, redirectUrl and pollUrl.
Make Payment, Check Payment Status and the result callback return the transaction result — the subset listed on the result callback page. It has no redirectUrl, redirectRequired, settlementMode, liquidationStatus or paymentMethodDetails.

Use the table below to understand a field’s meaning; use the pages above for what each call actually gives you.

{
  "amountDetails": {
    "amount": 0,
    "currencyCode": "string",
    "customerPayableAmount": 0,
    "defaultCurrencyAmount": 0,
    "defaultCurrencyCode": "string",
    "formattedMerchantAmount": "string",
    "merchantAmount": 0,
    "totalTransactionAmount": 0,
    "transactionServiceFee": 0
  },
  "applicationCode": "string",
  "applicationName": "string",
  "chargeType": "NO_CHARGE",
  "customer": {
    "contactNumbers": ["string"],
    "email": "string",
    "name": "string"
  },
  "customerAmountPaid": {
    "amountPaid": 0,
    "currencyCode": "string"
  },
  "dateOfTransaction": "string",
  "id": 0,
  "internalReference": "string",
  "liquidationStatus": "COMPLETED",
  "liquidationTransactionReference": "string",
  "merchantReference": "string",
  "paymentMetadata": {},
  "paymentMethodDetails": {
    "paymentMethodCode": "string",
    "paymentMethodId": 0,
    "paymentMethodMessage": "string",
    "paymentMethodName": "string",
    "paymentMethodReference": "string",
    "paymentMethodStatus": "string"
  },
  "pollUrl": "string",
  "reasonForPayment": "string",
  "redirectRequired": true,
  "redirectUrl": "string",
  "referenceNumber": "string",
  "resultUrl": "string",
  "returnUrl": "string",
  "settlementMode": "DIRECTLY_SETTLED",
  "transactionStatus": "AUTHORIZATION_FAILED",
  "transactionType": "BASIC"
}

Field	Type	Description
`amountDetails`	object	Currency, amount charged to the customer, and fees for the transaction
`applicationCode`	string	The unique code assigned to your application on creation
`applicationName`	string	Your application’s name
`chargeType`	string	`NO_CHARGE`, `SHARED_TRANSACTIONAL_CHARGE`, `TRANSACTIONAL_CHARGE_FOR_CUSTOMER`, or `TRANSACTIONAL_CHARGE_FOR_MERCHANT`
`customer`	object	The customer’s details
`customerAmountPaid`	object	The amount actually paid by the customer
`dateOfTransaction`	string	Date and time the transaction was initiated
`internalReference`	string	Pesepay’s internal transaction reference
`liquidationStatus`	string	`COMPLETED`, `DUE_FOR_LIQUIDATION`, `IN_PROGRESS`, `NO_LIQUIDATION_REQUIRED`, `PENDING`, or `WAITING_FOR_DETERMINATION`
`liquidationTransactionReference`	string	The liquidation transaction reference
`merchantReference`	string	Your own reference for the transaction
`paymentMetadata`	object	Additional payment information
`paymentMethodDetails`	object	Details of the payment method used
`pollUrl`	string	URL to poll for a change in transaction status
`reasonForPayment`	string	The subject of the transaction
`redirectRequired`	boolean	Whether the payment method requires a redirect
`redirectUrl`	string	The redirect URL, when applicable
`referenceNumber`	string	The transaction’s reference number — your primary tracking key
`resultUrl`	string	The URL Pesepay posts the transaction result to
`returnUrl`	string	The URL the customer is returned to after processing
`settlementMode`	string	How the transaction settles
`transactionStatus`	string	See Transaction Statuses
`transactionType`	string	`BASIC` or `INVOICE`