Vendor Pay States
Page Overview
This page documents the states associated with Vendor Pay payments.
Note that the webhooks identified below are not the full list – only the ones associated with the states are outlined here. The full list of available webhooks is in Event Reference.
Payment Request States
The corresponding transaction status is displayed where available. Where the transaction has not yet been created, the transaction state is shown as n/a.
| State | isEndState | Description | Webhook | Corresponding Transaction state |
|---|---|---|---|---|
| Created | The Payment Request was structurally correct and recorded | n/a | ||
| Invalid | X | The Payment Request was structurally accurate but contained invalid entries | n/a | |
| Initiated | The Payment Request passed validation and was accepted | PaymentRequestInitiated | n/a | |
| Pending | The Payment Request has all information required to begin processing | n/a | ||
| Processing | The Payment Request is processing and attempting to create a transaction | See Processing States | Pending, Grouping, Payment, Queued, Risk, CancellationReq | |
| Succeeded | X (most) | The Payment Request created a transaction, processed and paid out; end state unless returned | PaymentRequestSucceeded | Succeeded |
| Returned | X | Paid out transaction returned to Vitesse | PaymentRequestTransactionReturned | Returned |
| Failed | X | The Payment Request could not be processed | PaymentRequestFailed | Failed, No TX, Invalid |
| Cancelled | X | The Payment Request was cancelled before entering Processing | PaymentRequestCancelled | Cancelled |
A payment request can be cancelled only if it is in one of the following states: Initiated, Input Needed, Pending. After a Payment Request has generated a Transaction, only the Transaction can be cancelled.
Processing States
| Processing State | isEndState | Description | Webhook | Corresponding PR State | Corresponding Transaction Status |
|---|---|---|---|---|---|
| Pending | Awaiting processing to commence (scheduled for specific date/time) | Processing | n/a | ||
| In Process | Processing of the PR has commenced | Processing | n/a | ||
| Aborted | Processing stopped without a Transaction being created | Pending | n/a | ||
| Transaction Created | PR successfully created a Transaction | PaymentRequestTransactionCreated | Processing, Succeeded, Returned, Failed | Pending, PendingGrouping, PendingPayment, Queued, Risk, CancellationRequested |
Updated 24 days ago