moneyOut

Get details for a processed payout transaction

Returns details for a processed money out transaction.

get/MoneyOut/details/{transId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/MoneyOut/details/{transId}
  • Auth: HTTP bearer

Path parameters

transIdstring required

ReferenceId for the transaction (PaymentId).

Response

Success

CheckNumberstring

Paper check number related to payout transaction.

Commentsstring

Any comment or description.

CreatedDatestring date-time

Timestamp of when record was created, in UTC.

CreatedAtstring date-time

Timestamp of when record was created, in UTC.

FeeAmountnumber double

Service fee or sub-charge applied.

Gatewaystring

The payment gateway used to process the transaction.

IdOutinteger

Identifier of payout transaction.

LastUpdatedstring date-time

Timestamp of when record was last updated, in UTC.

NetAmountnumber double

Net amount.

ParentOrgNamestring

The name of the parent organization.

ParentOrgIdinteger

The ID of the org's parent organization.

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

Business legal name.

Sourcestring

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 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)
StatusTextstring

Text description of the payout transaction status.

TotalAmountnumber double

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

externalPaypointIDstring

A custom identifier for the paypoint, if applicable.

EntryNamestring

The entity's entrypoint identifier. Learn more.

BatchIdnumber double

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

HasVcardTransactionsboolean

When true, indicates that the paypoint has vCard transactions.

IsSameDayACHboolean

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

ScheduleIdinteger

ID of the recurring payment schedule associated with the transaction.

SettlementStatusstring

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

SettlementStatusNamestring nullable

Name of the settlement status.

RiskFlaggedboolean

Indicates if the transaction was flagged for risk.

RiskFlaggedOnstring date-time

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.

EntityIdstring

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.

Changes

No recorded changes to this operation across all 1 revision of this API.