Transaction States and Events
Transaction States
This is where the funds are debited from the payor.
State | Description | Event |
---|---|---|
CAPTURE_PENDING | The transaction has been started. | TransactionStarted |
CAPTURE_ACH_PENDING | The capture (debit) ACH from the payor has been picked up by the bank and we are waiting for the funds to be deposited into the GrailPay FBO account. | TransactionCaptureStarted |
CAPTURE_ACH_FAILED | The capture (debit) ACH from the payor has failed. Due to the nature of ACH this may happen AFTER the payout has been completed. | TransactionFailed |
CANCELED | The transaction was canceled upon request. | TransactionCanceled |
CHARGEBACK | A chargeback was initiated by the payor. | |
CLAWBACK | The payout was clawed back from the payee because an NSF occurred after payout. | ClawbackComplete |
INPAYOUT | The transaction has been included in either a direct or batch payout. | PayoutComplete |
Sub-Operations
A successful transaction will only involve the capture and payout operations. Other sub-operations come into play based on different situations that can arise during or after the transaction has completed.
Payout States
This is where the funds are credited to the payee.
State | Description | Event |
---|---|---|
PAYOUT_PENDING_ACH | The payout credit to the payee has been started. | |
PAYOUT_ACH_PENDING | The payout ACH has been picked up by the bank and we are waiting for confirmation that the money has been sent. | |
PAYOUT_COMPLETE | We received confirmation that the money was sent to the payee and the payout ACH has been marked as completed. | PayoutCompleted |
PAYOUT_ACH_FAILED | The payout ACH to the payee was unsuccessful. | PayoutFailed |
ReversePayout States
In the rare event that a payout fails, this is where the funds are credited back to the payor.
State | Description | Event |
---|---|---|
REVERSE_PAYOUT_PENDING | The credit to the payer from the GrailPay FBO account has been started. | ReversePayoutStarted |
REVERSE_PAYOUT_ACH_PENDING | The ACH credit has been picked up by the bank and GrailPay is waiting for confirmation that the money has been sent. | |
REVERSE_PAYOUT_ACH_COMPLETE | We received confirmation that the money was sent to the payor and reverse payout ACH has been completed. | ReversePayoutCompleted |
REVERSE_PAYOUT_ACH_FAILED | The reverse payout ACH failed. | ReversePayoutFailed |
Clawback
During an ACH transaction it is sometimes possible for the bank to reverse a debit from the payor after it has already cleared and been sent to the payee. In this instance, a clawback is performed to take the funds back from the payee.
State | Description | Event |
---|---|---|
CLAWBACK_ACH_PENDING | The ACH debit from the payee has been processed by the ban and we are waiting for confirmation that the funds to be deposited into the GrailPay FBO account. | ClawbackStarted |
CLAWBACK_ACH_COMPLETE | The money cleared the GrailPay FBO account and the clawback has been completed. | ClawbackCompleted |
CLAWBACK_ACH_FAILED | The clawback ACH from the payee was unsuccessful. | ClawbackFailed |
Refund
After a transaction has been completed, a request can be made on behalf of the payee to return the money to the payer using the Refund a Transaction API.
State | Description | Event |
---|---|---|
REFUND_PENDING | The refund from the payee to the payer has been requested. | RefundPending |
REFUND_CAPTURE_ACH_PENDING | The ACH debit from the payee to the GrailPay FBO account has been picked up by the bank and GrailPay is waiting for confirmation that the money has been sent. | RefundCaptureStarted |
REFUND_ACH_PENDING | The ACH credit from the GrailPay FBO account to the payer has been initiated. | RefundCaptureCompleted |
REFUND_COMPLETE | The refund process has been completed. | RefundPayoutCompleted |
REFUND_FAILED | The refund capture process failed. | RefundFailed |
Updated 14 days ago