The following table lists the statuses available that a user can assume on your platform.
| Status | Code | Description |
|---|
| pending | 23000 | The user is pending certain information for user verification approval. |
| pending_check | 23100 | The user has complete information received, however is still being reviewed and/or has not received payments yet. |
| approved_kyc_check | 23150 | The user has passed user verification review, but has been flagged for underwriting. |
| approved | 23200 | The user is considered in good standing and can transact normally. |
📘User Verification
To better understand our user verification and underwriting process, take a look at the article,
How does user verification work with Zai?
The following table lists the statuses available that an item can assume on your platform.
| Status | Code | Description |
|---|
| pending | 22000 | Transaction has not started yet; no payment received or requested. |
| payment_required | 22100 | Payment has been requested by the seller to the buyer. |
| wire_pending | 22110 | The buyer has acknowledged they are wiring the funds; they are on their way. |
| payment_pending | 22150 | Direct debit payment has been triggered; awaiting funds to clear. |
| payment_held | 22175 | Payment has been held due to automatic triggers. This will go to a manual review to move on to payment_deposited or fraud_hold. |
| payment_authorized | 22180 | A credit card payment has been authorized for capture. |
| void_pending | 22185 | Void of a previous credit card payment authorization has been triggered; awaiting the authorization to be voided. |
| voided | 22195 | A previous credit card payment authorization has been voided. |
| payment_deposited | 22200 | Payment has been successfully received in our escrow vault. |
| work_completed | 22300 | Seller has requested release; they have delivered the goods or service. |
| problem_flagged | 22400 | A dispute has been raised by either the buyer or seller; transaction is on hold until it is resolved. |
| problem_resolve_requested | 22410 | The other party (who didn’t raise the dispute) has requested that the dispute should be resolved. |
| problem_escalated | 22420 | The dispute has not been resolved and has been escalated. This will go into a process of third-party litigation. |
| completed | 22500 | The item is completed; funds have been released. Note: for card payments, after settlement (typically 1–2 business days) funds are applied. |
| cancelled | 22575 | The item is cancelled and can no longer be accessed. |
| refunded | 22600 | The funds have been refunded to the buyer’s funding source. |
| refund_pending | 22610 | A refund action is initiated, but prior action is needed before the refund is applied (e.g., waiting on a bank deposit or batch processing). |
| refund_flagged | 22650 | The funds will be refunded after manual review to approve the refund. |
| off_platform_refunded | 22670 | The funds have been refunded to the buyer off-platform. |
| partial_completed | 22700 | Partial release of funds has been requested by the seller in the transaction. |
| partial_paid | 22800 | Partial release of funds has occurred in the transaction. |
| off_platform_chargedback | 22680 | The funds have been charged back by the buyer’s issuing bank off-platform. |
The following table lists the statuses that an item can undergo during a refund process. This is displayed, when applicable, under refund_state, in addition to the item state.
| Status | Code | Description |
|---|
| pending | 22600 | A refund has been initiated by the seller. |
| requested | 22620 | A refund has been requested by the buyer. |
| processing | 22622 | The refund has been triggered and is being processed. |
| pending_return | 22630 | The refund is awaiting the direct debit from the seller’s bank account. Once direct-debited, funds will be returned to the item’s funding source. |
| pending_direct_credit | 22640 | The refund is being processed for direct credit to the buyer’s bank account. The item will be marked a success after 2 business days if the funds do not bounce. |
| failed | 22660 | The refund attempt has failed due to an invalid funding source (e.g., expired card or insufficient funds). |
| success | 22690 | The refund has been successfully completed. |
| Item State | Refund State | Description |
|---|
| refund_pending | pending_return | The refund is awaiting the direct debit from the seller’s bank account. Once direct-debited, funds will be returned to the item’s funding source. |
| pending_direct_credit | The refund is being processed for direct credit to the buyer’s bank account. The item will be marked a success after 2 business days if the funds do not bounce. |
| completed | failed | The refund attempt has failed due to an invalid funding source (e.g., expired card or insufficient funds). |
| refunded | success | The refund has been successfully completed. |
| Item State | Refund State | Description |
|---|
| refund_pending | pending_return | The refund is awaiting the direct debit from the seller’s bank account. Once direct-debited, funds will be returned to the item’s funding source. |
| pending_direct_credit | The refund is being processed for direct credit to the buyer’s bank account. The item will be marked a success after 2 business days if the funds do not bounce. |
| completed | failed | The refund attempt has failed due to an invalid funding source (e.g., expired card or insufficient funds). |
| success | The refund has been successfully completed. |
| Item State | Refund State | Description |
|---|
| refund_pending | pending_return | The refund is awaiting the direct debit from the seller’s bank account. Once direct-debited, funds will be returned to the item’s funding source. |
| (same as above) | pending_direct_credit | The refund is being processed for direct credit to the buyer’s bank account. The item will be marked a success after 2 business days if the funds do not bounce. |
| payment_deposited, payment_held, partial_paid, partial_completed, work_completed | failed | The refund attempt has failed due to an invalid funding source (e.g., expired card or insufficient funds). |
| refunded | success | The refund has been successfully completed. |
| Item State | Refund State | Description |
|---|
| refund_pending | pending_return | The refund is awaiting the direct debit from the seller’s bank account. Once direct-debited, funds will be returned to the item’s funding source. |
| (same as above) | pending_direct_credit | The refund is being processed for direct credit to the buyer’s bank account. The item will be marked a success after 2 business days if the funds do not bounce. |
| payment_deposited, payment_held, partial_paid, partial_completed, work_completed | failed | The refund attempt has failed due to an invalid funding source (e.g., expired card or insufficient funds). |
| (not applicable) | success | The refund has been successfully completed. |
| Status | Code | Description |
|---|
| successful | 12000 | The batch transaction has been processed successfully (a direct debit has been received or a disbursement has been sent). |
| pending_successful | 12010 | The batch transaction has not bounced after 2 business days but needs review by our Payments Team before being tagged successful. |
| pending | 12100 | The batch transaction is pending (early stages before batching). |
| bpay_pending (Australia) | 12110 | The bank has notified us of a BPAY pay-in; it is pending until the funds settle into Zai’s account. |
| batched | 12200 | The batch transaction has been created and is being processed by the batch process (runs 4 times a day). |
| invalid_account_details | 12360 | Failed due to incorrect bank account details. |
| failed_direct_debit (Australia) | 12370 | Dishonoured due to insufficient funds or other restrictions. Please refer user to contact their financial institution. |
| bank_processing | 12700 | Imported to the bank and being processed. |
| errored | 12900 | The batch transaction contained an error and will no longer be processed. |
| Item State | Batch Transaction Status | Description |
|---|
| payment_pending | pending | Direct debit payment triggered, not yet included in a batch for processing. |
| batched | Payment included in a transaction batch and waiting to be processed. |
| bank_processing | Payment in the batch is being processed by the bank. |
| completed | successful | Payment successfully processed by the bank. |
| pending | invalid_account_details | Payment unsuccessful due to incorrect bank account details. |
| failed_direct_debit | Payment not honoured due to insufficient funds or other restrictions. |
| Item State | Batch Transaction Status | Description |
|---|
| completed | pending | Direct credit payment triggered, not yet included in a batch for processing. |
| batched | Payment included in a transaction batch and waiting to be processed. |
| bank_processing | Payment in the batch is being processed by the bank. |
| successful | Payment successfully processed by the bank; funds credited to the seller’s bank account. |
| pending | invalid_account_details | Payment unsuccessful due to incorrect bank details. |
| Disbursement State | NPP Payout State | Description |
|---|
| pending | null / failed | Direct credit payment triggered, not yet included in a batch for processing. |
| bank_processing | trying | Real-time payout processing. |
| successful | null / failed | Payout successfully processed by direct credit batch. |
| (same as above) | successful | Payout successfully processed in real time. |
| invalid_account_details | failed | Invalid bank account details provided. Funds remain in digital wallet. |
| cancelled | failed | Real-time payout failed. Funds returned to digital wallet. |
The below table lists the different statuses a virtual account can transition into.
| Virtual Account Status | Description |
|---|
| pending_activation | Initial state while virtual account creation is processed; not yet ready for pay-in reconciliations. |
| active | Virtual account is ready for pay-in reconciliations. |
| activation_failed | Activation failed; the account cannot be used for pay-in reconciliations. |
| PayID Status | Description |
|---|
| pending_activation | Initial status while PayID registration is processed; not yet activated and cannot be used for pay-in reconciliations. |
| active | PayID is active and associated with a virtual account; can be used for pay-in reconciliations. |
| activation_failed | PayID activation failed; cannot be used for pay-in reconciliations. Try registering the PayID again. |
| PayTo Agreement Status | Description |
|---|
| pending_validation | Initial status while the agreement validation request is accepted and queued for processing. |
| validated | Agreement has been successfully validated and can be created soon. |
| validation_failed | Validation failed. The failure reason will be provided in WAPI notification and is available via the GET Agreement API. |
| pending_creation | Initial status for creation; the creation request has been accepted and will be processed soon. |
| created | Agreement has been created with NPPA and is pending payer approval; it cannot be used for payment initiations yet. |
| active | For AUPM, the payer has approved; for MCGR, the agreement has been migrated successfully. Payments can now be initiated per agreement terms. |
| creation_failed | Agreement creation failed with NPPA. The failure reason will be provided in WAPI notification and is available via the GET Agreement API. |
| suspended | Agreement paused temporarily (by payer or initiator). Payments cannot be initiated while suspended. |
| cancelled | Agreement cancelled and no longer available for payment initiations. Cancelled is final and cannot be changed. Typical reasons include payer no longer needs the goods/services, initiator no longer provides services, agreement reached end date, or agreement cancelled after last payment initiation completion. |
| Payment Initiation Request Status | Description |
|---|
| pending_payment_initiation | Initial status while the request is accepted and queued for processing. |
| payment_initiated | Payment has been requested from the payer’s bank. |
| payment_initiation_completed | The payer’s bank has cleared and settled a push payment toward Zai; funds should soon be reconciled to the user’s digital wallet in Zai. |
| payment_initiation_rejected | The payment initiation request has been rejected. The failure reason will be provided in WAPI notification and is available via the GET Payment Initiation Request API. |