Skip to navigation
APIPay Out endpointsPayouts

Get payout details

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

transIdstringRequired

ReferenceId for the transaction (PaymentId).

Response

Success
Billslist of objectsOptional
Bills associated with this transaction.
CheckDataobjectOptional
Object referencing to paper check image.
CheckNumberstringOptional
Paper check number related to payout transaction.
CommentsstringOptional<=250 characters
Any comment or description for payout transaction.
CreatedDatedatetimeOptional
Timestamp when the payment was created, in UTC.
CreatedAtdatetimeOptional
Timestamp of when record was created, in UTC.
Eventslist of objectsOptional
Events associated to this transaction.
FeeAmountdoubleOptional

Service fee or sub-charge applied.

GatewaystringOptional
The payment gateway used to process the transaction.
IdOutlongOptional
Identifier of payout transaction.
LastUpdateddatetimeOptional
Timestamp when payment record was updated, in UTC.
NetAmountdoubleOptional
Net amount.
ParentOrgNamestringOptional
The name of the parent organization.
ParentOrgIdlongOptional
The ID of the org's parent organization.
PaymentDataobjectOptional
PaymentGroupstringOptional
Unique identifier for group or batch containing the transaction.
PaymentIdstringOptional
The unique transaction ID. This value is a string representation of a long integer.
PaymentMethodstringOptional
Method of payment applied to the transaction.
PaymentStatusstringOptional
Status of payout transaction.
PaypointDbanamestringOptional
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
PaypointLegalnamestringOptional
Paypoint legal name.
SourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.
StatusintegerOptional

Internal status of transaction. Payout statuses, also known as money out transaction statuses, appear in the Payabli Portal 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)
StatusTextstringOptional
Text description of the payout transaction status.
TotalAmountdoubleOptional

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

VendorobjectOptional
Vendor related to the payout transaction.
externalPaypointIDstringOptional
A custom identifier for the paypoint, if applicable.
EntryNamestringOptional

The entity’s entrypoint identifier. Learn more.

BatchIddoubleOptional

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

HasVcardTransactionsbooleanOptional

When true, indicates that the paypoint has vCard transactions.

SettlementStatusstringOptional

The settlement status of the payout transaction. See Payout Transaction Statuses for a full reference.

SettlementStatusNamestring or nullOptional
Name of the settlement status.
RiskFlaggedbooleanOptional
Indicates if the transaction was flagged for risk.
RiskFlaggedOndatetimeOptional
Timestamp when the transaction was flagged for risk.
RiskStatusstringOptional
Current risk status of the transaction.
RiskReasonstringOptional
Reason for risk flagging.
RiskActionstringOptional
Action taken due to risk assessment.
RiskActionCodeintegerOptional
Numeric code representing the risk action.
EntityIdstringOptional
The entity's ID in Payabli. If the entity is a paypoint, this is the paypoint ID. If the entity is an organization, this is the organization ID.
IsSameDayACHbooleanOptionalBeta

When true, this is a same-day ACH transaction.

ScheduleIdlongOptionalBeta
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