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
Events associated to 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.
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.
PaymentDataobject
PaymentGroupstring
Unique identifier for group or batch containing the transaction.
PaymentIdstring
Unique transaction ID.
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.
StatusTextstring
Status of payout transaction.
TotalAmountdouble

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

Vendorobject
Vendor related to the payout transaction.

Errors

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