Status Codes
This page provides a reference for the various transaction types & payment statuses the ZenPay API. For the full API specification including request/response schemas, see the API Reference.
Transaction Types
Each transaction processed through ZenPay is assigned a type that identifies how it was initiated and its purpose.
| Code | Label | Description |
|---|---|---|
| 1 | Charge | Any payment initiated by or on behalf of a customer |
| 2 | InvoicePayment | Merchant paying their ZenPay platform bill |
| 3 | Refund | Funds returned to the customer for a previous transaction |
| 4 | Chargeback | Customer-initiated dispute and refund through their issuing bank |
| 5 | Recall | ZenPay-initiated reversal of a charge back to the customer |
| 6 | FixedTermSettlement | Funds collected from a recurring installment plan |
| 7 | SponsorInvoicePayment | Merchant paying for additional customer rewards points (B2B only) |
| 8 | MerchantSettlementAdjustmentPayment | Manual adjustment by ZenPay Finance when a settlement date is corrected |
| 9 | Preauthorisation | A hold placed on the payer's card reserving funds for a set number of days |
| 10 | Credit | A standalone refund not tied to a specific prior transaction |
Transaction types appear in API responses, webhook payloads, and reporting endpoints. Use the transactionTypes query parameter on GET /v2/payments to filter by one or more types.
FixedTermSettlement (6) is a TravelPay product that we no longer offer. If your integration filters on this type, plan to remove it.
SponsorInvoicePayment (7) is being phased out and will be removed in a future release. If your integration filters on this type, plan to remove it.
Payment Status
The current processing state of a transaction. Returned in API responses, webhooks, and callbacks. Callback and Webhook use an enum code for the paymentStatus/PaymentStatus parameter and paymentStatusDisplay/PaymentStatusDisplay for the display string . The API uses paymentStatus for the display string.
| Code | Webhook/Callback Display | API paymentStatus Label | Description |
|---|---|---|---|
| -1 | Pending Approval | ApprovalPending | A payment with user only permissions in merchant portal is made and is pending admin approval |
| 0 | Pending | Pending | Payment is queued and waiting to be processed |
| 1 | Error | Error | An error occurred during processing — the error reason will be included in the response payload |
| 2 | Submitted | Submitted | Batch payment has been submitted but not yet processed |
| 3 | Successful | Succesful | Payment has been processed successfully |
| 3 | Successful(Recalled) | Successful(Recalled) | Payment was successful but funds have been recalled from the merchant |
| 3 | Successful(Refunded) | Successful(Refunded) | Payment was successful but refunded to the customer before settlement |
| 3 | Successful (Refunded) (Recalled) | Successful (Refunded) (Recalled) | Payment was successful, funds recalled from merchant and refunded to customer |
| 4 | Failed | Failed | Payment has failed — a failure reason will be included in the response payload |
| 5 | Cancelled | Cancelled | A pending payment that has been cancelled by ZenPay |
| 6 | Suppressed | Suppressed | Payment processing has been paused, typically while a fraud investigation is underway |
| 7 | InProgress | InProgress | Payment is currently being processed |
| 8 | Received Externally | ProcessedExternal | Used when external payments from sources like PayID are received |
| 9 | Rejected | Rejected | Portal payment made with user only permissions is rejected by admin |
| 10 | Pending 3DS check | PendingPendingThreeDS | Payment is pending 3DS verification from the customer |
- Refunded — Funds are returned to the customer before settlement to the merchant
- Recalled — Funds are pulled back from the merchant after settlement has occurred
These can occur together when a settled payment needs to be both recalled from the merchant and refunded to the customer.