Payment Statuses
Every payment has a status. You get it in the creation response and can read it at any time with Get Payment Details or List Payments.
Deliver only on Completed
Completed is the only status that means the money was collected. Pending and Processing aren't paid yet, and Authorized only reserves the funds.
At a glance
| Status | What it means | Final? | GPO | By reference |
|---|---|---|---|---|
Pending | Created, waiting for the customer or the provider. | No | ✓ | ✓ |
Processing | The provider is confirming the payment. | No | ✓ | — |
Authorized | Funds reserved, not collected yet. | No | Authorize Funds | — |
Completed | The money was collected. | Only a refund can change it | ✓ | ✓ |
Failed | Declined, rejected, or couldn't be created. | Yes | ✓ | ✓ |
Cancelled | Refused by the customer, cancelled, or expired. | Yes | ✓ | ✓ |
PartiallyRefunded | Part of the payment was refunded. | No | ✓ | — |
Refunded | The full amount was refunded. | Yes | ✓ | — |
GPO
Webframe
| Status | When |
|---|---|
Pending | The customer has the payment page (paymentUrl) and hasn't paid yet. |
Processing | The provider is confirming the payment. |
Completed | The customer paid. |
Cancelled | The customer refused the payment, or it was cancelled at the provider. |
Failed | The payment was rejected, failed, or the payment page expired. |
One-Time Purchase
A Payment Request the customer approves on their phone, in Multicaixa Express.
| Status | When |
|---|---|
Completed | The customer approved the request. |
Cancelled | The customer refused the request, or it expired before they approved it. |
Failed | The bank or the provider declined it, or it failed. |
Pending, Processing | The result isn't confirmed yet. Check the status again later. |
The creation response usually already has the final result. One-Time Purchase in the API Reference
Authorize Funds
| Status | When |
|---|---|
Authorized | The funds are reserved. Capture them, or cancel the authorization. |
Cancelled | You cancelled the authorization with Cancel Authorization, the customer refused it, or it expired. |
Failed | The bank or the provider declined it, or it failed. |
Capturing doesn't change the authorization: it stays Authorized. Authorize Funds in the API Reference
Capture Funds
A capture is a new payment, with its own internalId, linked to the authorization.
| Status | When |
|---|---|
Processing | The capture was sent to the provider. |
Completed | The reserved funds were collected. |
Failed | The capture didn't go through. |
Capture Funds in the API Reference
QR Code
| Status | When |
|---|---|
Pending | The QR Code was created and the customer hasn't paid yet. |
Completed | The customer scanned the code and paid. |
Refunds
When a refund of a completed GPO payment completes, the payment becomes PartiallyRefunded or, once the full amount is returned, Refunded. Each refund also has its own status, which you can see with List Refunds:
| Refund status | When |
|---|---|
Pending, Processing | The refund was requested and is being processed. |
Completed | The money was returned to the customer. |
Failed | The refund didn't go through. The payment keeps its previous status. |
Payment by Reference
Payments by reference never become Authorized or Processing, and they aren't refunded automatically. To return money to a customer, contact IZI Pay support.
Dynamic Reference
| Status | When |
|---|---|
Pending | The reference was issued and the customer hasn't paid yet. |
Completed | The customer paid. |
Cancelled | The reference was cancelled, or it expired before the customer paid. |
Failed | The reference couldn't be created. Read errorCode and errorMessage. |
Dynamic Reference in the API Reference
Charging Reference
A charging reference can be paid many times. Each payment is a separate record that becomes Completed when the customer pays. Find them with List Payments. The reference stays Active until it's cancelled or expires.
Charging Reference in the API Reference
Reference statuses
The reference itself has a referenceStatus, separate from the payment's status. Read it with Get Payment Reference Status.
| Reference status | When |
|---|---|
Active | The reference can be paid. |
Paid | A dynamic reference was paid. Its payment is Completed. |
Cancelled | The reference was cancelled with Cancel Payment Reference and can no longer be paid. |
Expired | The expiry date passed before the customer paid. Its payment is reported as Cancelled. |
A customer's bank can reject an attempt to pay a reference without changing its status. If attempt tracking is enabled for your account, you can see those attempts with List Payment Reference Attempts.
How a status can change
These rules apply to every payment. A payment never goes back: a Failed or Cancelled payment can't become Completed. To try again, create a new payment with a new idempotency key.
| From | Can become |
|---|---|
Pending | Processing, Authorized, Completed, Failed, Cancelled |
Processing | Authorized, Completed, Failed, Cancelled |
Authorized | Completed, Failed, Cancelled |
Completed | PartiallyRefunded, Refunded |
PartiallyRefunded | Refunded |
Failed, Cancelled, Refunded | Nothing. These are final. |