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 objectsOptional

Events associated to 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.

Eventslist of objectsOptional

Events associated to this transaction.

FeeAmountdoubleOptional

Service fee or sub-charge applied.

GatewaystringOptional

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.

PaymentDataobjectOptional
PaymentGroupstringOptional

Unique identifier for group or batch containing the transaction.

PaymentIdstringOptional

Unique transaction ID.

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.

StatusTextstringOptional

Status of payout transaction.

TotalAmountdoubleOptional

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

VendorobjectOptional

Vendor related to the payout transaction.

Errors