Documentation

Transaction States and Events

Transaction States

This is where the funds are debited from the payor.

StateDescriptionEvent
CAPTURE_PENDINGThe transaction has been started.TransactionStarted
CAPTURE_ACH_PENDINGThe 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_FAILEDThe capture (debit) ACH from the payor has failed. Due to the nature of ACH this may happen AFTER the payout has been completed.TransactionFailed
CANCELEDThe transaction was canceled upon request.TransactionCanceled
CHARGEBACKA chargeback was initiated by the payor.
CLAWBACKThe payout was clawed back from the payee because an NSF occurred after payout.ClawbackComplete
INPAYOUTThe 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.

StateDescriptionEvent
PAYOUT_PENDING_ACHThe payout credit to the payee has been started.
PAYOUT_ACH_PENDINGThe payout ACH has been picked up by the bank and we are waiting for confirmation that the money has been sent.
PAYOUT_COMPLETEWe received confirmation that the money was sent to the payee and the payout ACH has been marked as completed.PayoutCompleted
PAYOUT_ACH_FAILEDThe 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.

StateDescriptionEvent
REVERSE_PAYOUT_PENDINGThe credit to the payer from the GrailPay FBO account has been started.ReversePayoutStarted
REVERSE_PAYOUT_ACH_PENDINGThe ACH credit has been picked up by the bank and GrailPay is waiting for confirmation that the money has been sent.
REVERSE_PAYOUT_ACH_COMPLETEWe received confirmation that the money was sent to the payor and reverse payout ACH has been completed.ReversePayoutCompleted
REVERSE_PAYOUT_ACH_FAILEDThe 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.

StateDescriptionEvent
CLAWBACK_ACH_PENDINGThe 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_COMPLETEThe money cleared the GrailPay FBO account and the clawback has been completed.ClawbackCompleted
CLAWBACK_ACH_FAILEDThe 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.


StateDescriptionEvent
REFUND_PENDINGThe refund from the payee to the payer has been requested.RefundPending
REFUND_CAPTURE_ACH_PENDINGThe 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_PENDINGThe ACH credit from the GrailPay FBO account to the payer has been initiated.RefundCaptureCompleted
REFUND_COMPLETEThe refund process has been completed.RefundPayoutCompleted
REFUND_FAILEDThe refund capture process failed.RefundFailed