APIPay Out endpointsPayouts

Get payout details

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 or null
Events associated to this transaction.
CheckDataobject or null
Object referencing to paper check image.
CheckNumberstring or null
Paper check number related to payout transaction.
Commentsstring or null<=250 characters
Any comment or description for payout transaction.
CreatedDatedatetime or null
Timestamp when the payment was created, in UTC.
CreatedAtdatetime or null
Timestamp of when record was created, in UTC.
Eventslist of objects or null
Events associated to this transaction.
FeeAmountdouble or null

Service fee or sub-charge applied.

Gatewaystring or null
Gateway used to process the transaction.
IdOutlong or null
Identifier of payout transaction.
LastUpdateddatetime or null
Timestamp when payment record was updated, in UTC.
NetAmountdouble or null
Net amount.
ParentOrgNamestring or null
The name of the parent organization.
ParentOrgIdlong or null
The ID of the org's parent organization.
PaymentDataobject or null
PaymentGroupstring or null
Unique identifier for group or batch containing the transaction.
PaymentIdstring or null
The unique transaction ID. This value is a string representation of a long integer.
PaymentMethodstring or null
Method of payment applied to the transaction.
PaymentStatusstring or null
Status of payout transaction.
PaypointDbanamestring or null
The alternate or common name that this business is doing business under usually referred to as a DBA name.
PaypointLegalnamestring or null
Paypoint legal name.
Sourcestring or null<=100 characters
Custom identifier to indicate the transaction or request source.
Statusinteger or null
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. | 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 | | **Canceled** | 0 | An authorized payout has been canceled. A captured payout can be canceled 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 | | **OnHold** | 4 | A payout has been placed on hold and requires review before proceeding. | OnHold | | **Paid** | 5 | A payout has been paid and the recipient has redeemed the funds. | Paid (check cleared, vCard used, ACH settled) |
StatusTextstring or null
Status of payout transaction.
TotalAmountdouble or null

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

Vendorobject or null
Vendor related to the payout transaction.
externalPaypointIDstring or null

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 or null

The entity’s entrypoint identifier. Learn more

BatchIdstring or null

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

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

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

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

Errors