API referencePay Out endpointsPayouts

Get payout details

Returns details for a processed money out transaction.

Path parameters

transIdstringRequired

ReferenceId for the transaction (PaymentId).

Headers

requestTokenstringRequired

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.
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.
PaymentDataobject or null
PaymentGroupstring or null
Unique identifier for group or batch containing the transaction.
PaymentIdstring or null
Unique transaction ID.
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.
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.

Errors