Users

User states

The following table lists the states 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, see these articles:

What Is user verification?
How does user verification work with Assembly?

Items

Item states

The following table lists the states 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 that they are wiring the funds in, they are on their way.

payment_pending

22150

Direct debit payment has been triggered, awaiting for these funds to clear.

payment_held

22175

Payment has been held as automatic triggers have been alerted. This will go through a manual review to move on to payment_deposited, or fraud_hold.

payment_authorized

22180

A credit card payment has been authorized for capture.

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/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, Only after the card transaction settles (this could vary between 1-2 business days based on your settings) the funds will be applied to the seller/payee’s wallet account. Refer to Cards payin workflow.

cancelled

22575

The Item is cancelled and can no longer be accessed.

refunded

22600

The funds have been refunded to the funding source of the buyer.

refund_pending

22610

A refund action is initiated, but prior action is needed before the refund is applied (for example, the platform is waiting on a bank deposit or a batch processing).

refund_flagged

22650

The funds will be refunded to the funding source of the buyer, after manual review to approve the refund.

off_platform_refunded

22670

The funds have been refunded to the buyer through a means outside of the platform.

partial_completed

22700

Partial release of funds have been requested by the seller in the transaction.

partial_paid

22800

Partial release of funds have occurred in the transaction.

off_platform_chargedback

22680

The funds have been charged back by the buyer’s issuing bank through a means outside of the platform.

Item refund states

The following table lists the states 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 the funds are direct-debited, these 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. This could be due to an expired card or insufficient funds.

success

22690

The refund has been successfully completed.

Refund state matrix

The following table provides shows both the item state and refund_state which an item undergoes during a refund process.

Full refund for a completed item

Item State

Refund State

Description

refund_pending

pending_return

The refund is awaiting the direct debit from the seller’s bank account. Once the funds are direct-debited, these 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. This could be due to an expired card or insufficient funds.

refunded

success

The refund has been successfully completed.

Partial refund for a completed item

Item State

Refund State

Description

refund_pending

pending_return

The refund is awaiting the direct debit from the seller’s bank account. Once the funds are direct-debited, these 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. This could be due to an expired card or insufficient funds.

success

The refund has been successfully completed.

Full refund for a non-completed item

Item State

Refund State

Description

refund_pending

pending_return

The refund is awaiting the direct debit from the seller’s bank account. Once the funds are direct-debited, these 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

payment_deposited payment_held
partial_paid
partial_completed
work_completed

failed

The refund attempt has failed due to an invalid funding source. This could be due to an expired card or insufficient funds.

refunded

success

The refund has been successfully completed.

Partial refund for a non-completed item

Item State

Refund State

Description

refund_pending

pending_return

The refund is awaiting the direct debit from the seller’s bank account. Once the funds are direct-debited, these 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.

payment_deposited payment_held
partial_paid
partial_completed
work_completed

failed

The refund attempt has failed due to an invalid funding source. This could be due to an expired card or insufficient funds.

success

The refund has been successfully completed.

Batches

Batch transaction states

Status

Code

Description

successful

12000

The Batch Transaction has been processed successful, this means 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 to be reviewed by our Payments Team before it is tagged successful.

pending

12100

The Batch Transaction is in a pending state. This refers to the early stages where the transaction has started and is followed by being batched

bpay_pending

12110

The Batch Transaction for this bpay payin has been received from our bank as a notification however the bpay payin is pending until the funds have been settled into Assembly's account

batched

12200

The Batch Transaction has been created and is being processed by the batch process. This process runs 4 times a day.

invalid_account_details

12360

The Batch Transaction has failed due to incorrect bank account details.

failed_direct_debit

12370

The Batch Transaction has been dishonoured due to insufficient funds or other restrictions. Please refer user to contact their financial institution.

bank_processing

12700

The Batch Transaction has been imported to the bank and is being processed.

errored

12900

The Batch Transaction contained an error and will no longer be processed.

Batch transaction matrix

Both item states and batch transactions statuses show where the item is in a payment workflow. Together, these two fields can tell you the flow of funds after an item has been paid for.

For direct debit payments (pay-ins)

Item State

Batch Transaction Status

Description

payment_pending

pending

The direct debit payment has been triggered, but the payment hasn’t yet been included in a batch for processing.

batched

The payment has been included in a transaction batch, which is waiting to be processed.

bank_processing

The payment, along with other payments in the same batch, is already being processed by the bank.

payment_deposited

successful

The payment was successfully processed by the bank and the funds are now in the Assembly escrow vault.

pending

invalid_account_details

The payment wasn’t successful due to incorrect bank account details.

failed_direct_debit

The payment wasn’t honoured due to insufficient funds or other restrictions.

For direct credit payments (pay-outs)

Item State

Batch Transaction Status

Description

completed

pending

The direct credit payment has been triggered, but the payment hasn’t yet been included in a batch for processing.

batched

The payment has been included in a transaction batch, which is waiting to be processed.

bank_processing

The payment, along with other payments in the same batch, is already being processed by the bank.

successful

The payment was successfully processed by the bank and the funds have now been credited to the seller’s bank account.

pending

invalid_account_details

The payment wasn’t successful due to incorrect bank details.

Disbursements

Disbursement State

NPP Payout State

Description

pending

null / failed

Direct credit payment has been triggered, but the payment hasn’t yet been included in a batch for processing.

bank_processing

trying

Real time payout processing.

successful

null / failed

Payout was successfully processed by direct credit batch.

successful

Payout was 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.

Virtual Account Statuses

Below table lists the different statuses a virtual account can transition into.

Virtual Account Status

Description

pending_activation

In asynchronous processing flow, this is the initial state in which a virtual account is created. This indicates it is not ready yet for pay-in reconciliations.

active

Active state indicates the virtual account is ready for pay-in reconciliations.

activation_failed

If the activation fails due to some errors, the virtual account moves from pending_activation to activation_failed status and hence cannot be used for pay-in reconciliations.


Did this page help you?