APIPay Out endpointsPayouts

Get payout details

View as MarkdownOpen in Claude
Returns details for a processed money out transaction.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

transIdstringRequired

ReferenceId for the transaction (PaymentId).

Response

Success
Billslist of objects
Bills associated with this transaction.
CheckDataobject
Object referencing to paper check image.
CheckNumberstring
Paper check number related to payout transaction.
Commentsstring<=250 characters
Any comment or description for payout transaction.
CreatedDatedatetime
Timestamp when the payment was created, in UTC.
CreatedAtdatetime
Timestamp of when record was created, in UTC.
Eventslist of objects
Events associated to this transaction.
FeeAmountdouble

Service fee or sub-charge applied.

Gatewaystring
Gateway used to process the transaction.
IdOutlong
Identifier of payout transaction.
LastUpdateddatetime
Timestamp when payment record was updated, in UTC.
NetAmountdouble
Net amount.
ParentOrgNamestring
The name of the parent organization.
ParentOrgIdlong
The ID of the org's parent organization.
PaymentDataobject
PaymentGroupstring
Unique identifier for group or batch containing the transaction.
PaymentIdstring
The unique transaction ID. This value is a string representation of a long integer.
PaymentMethodstring
Method of payment applied to the transaction.
PaymentStatusstring
Status of payout transaction.
PaypointDbanamestring
The alternate or common name that this business is doing business under usually referred to as a DBA name.
PaypointLegalnamestring
Paypoint legal name.
Sourcestring<=100 characters
Custom identifier to indicate the transaction or request source.
Statusinteger

Internal status of transaction.

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.

StatusKeyDescriptionEvents
Authorized11A payout is authorized. These are queued payouts, and nothing happens with them until they’re captured.Authorized
Captured1A payout is captured and is now part of the batch for payout.Captured
Canceled0An authorized payout has been canceled. A captured payout can be canceled before batch close at 5 PM ET.Cancelled
Processing2A payout is being processed.Waiting funds, Funded, Pending (payment type is pending), Generating check
Processed3A 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
OnHold4A payout has been placed on hold and requires review before proceeding.OnHold
Paid5A payout has been paid and the recipient has redeemed the funds.Paid (check cleared, vCard used, ACH settled)
StatusTextstring
Text description of the payout transaction status.
TotalAmountdouble

Transaction total amount (including service fee or sub-charge).

Vendorobject
Vendor related to the payout transaction.
externalPaypointIDstring

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant’s ID from your own systems.

EntryNamestring

The entity’s entrypoint identifier. Learn more

BatchIdstring

Identifier for the batch in which this transaction was processed. Used to track and reconcile batch-level operations.

HasVcardTransactionsboolean
IsSameDayACHboolean
Indicates if the payout transaction is processed as Same Day ACH. This is only applicable for ACH transactions.
SettlementStatusinteger

Settlement status for transaction. See the docs for a full reference.

RiskFlaggedboolean
Indicates if the transaction was flagged for risk
RiskFlaggedOndatetime
Timestamp when the transaction was flagged for risk
RiskStatusstring
Current risk status of the transaction
RiskReasonstring
Reason for risk flagging
RiskActionstring
Action taken due to risk assessment
RiskActionCodeinteger
Numeric code representing the risk action
ScheduleIdlongBeta
ID of the recurring payment schedule associated with the transaction.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error