Money out statuses

Payout transaction statuses

Payout statuses, also known as money out transaction statuses, appear in PartnerHub and PayHub, and the API, and describe where a payout transaction is in its lifecycle.

Status	Key	Description	Events
Authorized	11	A payout is authorized. These are queued payouts, and nothing happens with them until they’re captured.	Authorized
Captured	1	A payout is captured and is now part of the batch for payout.	Captured
Cancelled	0	An authorized payout has been cancelled. A captured payout can be cancelled before batch close at 5 PM ET.	Cancelled
Processing	2	A payout is being processed.	Waiting funds, Funded, Pending (payment type is pending), Generating check
Processed	3	A payment method is defined for the vendor, and the payout has been sent to the recipient.	Open (vCard issued, ACH sent, check generated but not yet cashed), Processed (Payment Type is no longer pending), Reissued, Returned, Errored
Paid	5	A payout has been paid and the recipient has redeemed the funds.	Paid (check cleared, vCard used, ACH settled)

If you are working with money out endpoints involve payouts in the API, the Key is returned as Status, and the most recent event is returned as PaymentStatus. For example, a response body that includes payout data looks like this:

1 {
2   ...
3 			"PaypointDbaname": "Ocean Community",
4       "PaypointLegalname": "Ocean Community",
5       "Status": 2,
6       "LastUpdated": "2023-04-18T18:29:17",
7       "TotalAmount": 75,
8       "NetAmount": 75,
9       "FeeAmount": 0,
10       "Source": null,
11       "ParentOrgName": "Centavo Inc. ",
12       "BatchNumber": null,
13       "PaymentStatus": "Awaiting Funds",
14  ...
15 }

The Status is 2, which means the payment is processing, and the current event is “Awaiting Funds”, which is reflected in PaymentStatus.

Batch statuses

These statuses appear in PartnerHub and PayHub, and the API, and describe a money out batch’s status.

Status	Key	Description	Events
Open	0	The batch is open and hasn’t started processing yet.	None
Closed	1	The batch is closed and sent to be processed. Captured payouts can’t be cancelled at this point.	Approved Payment Group, Waiting Funds
Funded	2	Money has been received from the funding entity (typically the paypoint).	Funded
Processed	3	All payout requests in the batch have a payment type defined for the vendor, and the payments have been sent.	Payment Group Processed
Paid	4	All payout transactions in the batch have been marked as Paid.	Paid
Cancelled	-1	The batch has been cancelled.	Cancelled

If you are working with money out endpoints in the API, the Key is returned as BatchStatus. For example, a response body that includes batch data looks like this:

Example batch response

1 // Example truncated to show the most relevant fields
2 {
3 "Records": [
4     {
5       "IdBatch": 100,
6       "BatchDate": "2023-05-05T00:00:00",
7       "BatchNumber": "187-20230505-EXAMPLEBATCH",
8       "BatchStatus": 1,
9       "BatchStatusText": "Waiting Funds",
10  ...
11     }
12   ]
13 }

The value of BatchStatus indicates the status. In the example, the BatchStatus is 1, which means it’s closed. The BatchStatusText returns the most recent event for that status.

Bill statuses

These statuses appear in PartnerHub and PayHub, and the API, and describe where a bill is in its lifecycle.

Status	Key	Description	Events
Active	1	The bill has been added for a vendor. It can be sent for approval or sent to payment. Only bills with an Active or Approved status can be sent for payment.	None
Sent to Approval	2	The bill has been sent to approval for payout.	None
Partially Approved	5	The bill has been partially approved for payout.	None
Rejected	11	The bill has been rejected and won’t be paid.	BillDisApproved
Approved	20	The bill has been approved for payout.	BillApproved
In Transit	50	The payout for the bill is in transit.	BillProcessing
Paid	100	The bill has been paid.	BillPaid
Cancelled	-99	The bill has been cancelled. This is usually to correct the payment type.	BillCanceled

If you are working with money out endpoints in the API, the Key is returned as Status. For example, a response body that includes bill data will look like this:

1 // Example truncated to show the most relevant fields
2 {
3   "isSuccess": true,
4   "responseText": "Success",
5   "responseCode": 1,
6   "responseData": {
7     "IdBill": 364,
8     "BillNumber": "bill444",
9 ...
10     "Status": 2,
11 ...
12  }
13 }

The value of Status indicates the status. In the example, the Status is 2, which means the bill has been sent to approval.