Payment Statuses
Reference of all payment status codes returned by the Pinch API.
Here are the status codes for a payment when calling endpoints that return payment objects.
Endpoints include:
- Create or Update Payment
- Create Realtime Payment
- Get Payment
- List Payments - Scheduled
- List Payments - Processed
- List Payments for Payer
- Check Payment Nonce
Payment Statuses
| Status | Description |
|---|---|
| scheduled | Payment has been scheduled for a future date and is not yet being processed |
| processing | Payment is currently being processed (for direct debit payments via bank account, the payment may remain in this status for 1–3 business days while awaiting bank results) |
| dishonoured | Payment was unsuccessful |
| settled | Payment has been settled to the Merchant |
| cancelled | Payment has been cancelled |
| approved | Payment has been successful (but not yet settled to Merchant) |
| cleared-settlements-disabled | Payment has been successful and settlement was attempted but merchant has settlements disabled (Most likely because they have not completed compliance checks) |
| cleared-pending-dispute | Payment is in a disputed state |
| returned-without-settlement | Payment has been successful then refunded before it was settled to the merchant |
| pending-action | Status used for asynchronous payment types |
Updated 1 day ago
What’s Next
Did this page help you?