Get payout details

GET

/MoneyOut/details/:transId

GET

/api/MoneyOut/details/:transId

$ curl https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324 \
>      -H "requestToken: <apiKey>"

1 {
2   "Bills": [
3     {
4       "invoiceNumber": "INV-2345",
5       "netAmount": "8800.00"
6     }
7   ],
8   "CheckData": null,
9   "CheckNumber": null,
10   "Comments": "testing",
11   "CreatedDate": "2022-07-01T15:00:01Z",
12   "CreatedAt": null,
13   "Events": [
14     {
15       "EventTime": "2023-04-24T09:17:49Z",
16       "TransEvent": "Authorized"
17     }
18   ],
19   "FeeAmount": 0,
20   "Gateway": "TSYS",
21   "IdOut": 350,
22   "LastUpdated": "2023-04-23T17:00:00Z",
23   "NetAmount": 8800,
24   "ParentOrgName": "PropertyManager Pro",
25   "ParentOrgId": null,
26   "PaymentData": {
27     "AccountType": "",
28     "binData": {
29       "binMatchedLength": "6",
30       "binCardBrand": "Visa",
31       "binCardType": "Credit",
32       "binCardCategory": "PLATINUM",
33       "binCardIssuer": "Bank of Example",
34       "binCardIssuerCountry": "United States",
35       "binCardIssuerCountryCodeA2": "US",
36       "binCardIssuerCountryNumber": "840",
37       "binCardIsRegulated": "false",
38       "binCardUseCategory": "Consumer",
39       "binCardIssuerCountryCodeA3": "USA"
40     },
41     "HolderName": "",
42     "Initiator": "payor",
43     "MaskedAccount": "",
44     "Sequence": "subsequent",
45     "SignatureData": "SignatureData",
46     "StoredMethodUsageType": "subscription"
47   },
48   "PaymentGroup": "2345667-ddd-fff",
49   "PaymentId": "12345678910",
50   "PaymentMethod": "managed",
51   "PaymentStatus": "Authorized",
52   "PaypointDbaname": "Sunshine Gutters",
53   "PaypointLegalname": "Sunshine Services, LLC",
54   "Source": "api",
55   "Status": 11,
56   "StatusText": "Captured",
57   "TotalAmount": 8800,
58   "Vendor": {
59     "additionalData": null,
60     "Address1": "123 Ocean Drive",
61     "Address2": "Suite 400",
62     "BillingData": {
63       "id": 123456,
64       "nickname": "Main Checking Account",
65       "bankName": "Example Bank",
66       "routingAccount": "123456789",
67       "accountNumber": "9876543210",
68       "typeAccount": "Checking",
69       "bankAccountHolderName": "John Doe",
70       "bankAccountHolderType": "Business",
71       "bankAccountFunction": 2,
72       "verified": true,
73       "status": 1,
74       "services": [],
75       "default": true,
76       "accountId": "bank-account-001"
77     },
78     "City": "Bristol",
79     "Contacts": [
80       {
81         "ContactEmail": "eric@martinezcoatings.com",
82         "ContactName": "Eric Martinez",
83         "ContactPhone": "5555555555",
84         "ContactTitle": "Owner"
85       }
86     ],
87     "Country": "US",
88     "CreatedDate": "2022-07-01T15:00:01Z",
89     "customerVendorAccount": "123-456",
90     "customField1": "",
91     "customField2": "",
92     "EIN": "123456789",
93     "Email": "example@email.com",
94     "EnrollmentStatus": null,
95     "externalPaypointID": "Paypoint-100",
96     "InternalReferenceId": 1000000,
97     "LastUpdated": "2022-07-01T15:00:01Z",
98     "LocationCode": "LOC123",
99     "Mcc": "7777",
100     "Name1": "Herman's Coatings",
101     "Name2": "Herman's Coating Supply Company, LLC",
102     "ParentOrgName": "PropertyManager Pro",
103     "ParentOrgId": 1000,
104     "payeeName1": "payeeName1",
105     "payeeName2": "payeeName2",
106     "PaymentMethod": null,
107     "PaypointDbaname": "Sunshine Gutters",
108     "PaypointEntryname": "d193cf9a46",
109     "PaypointLegalname": "Sunshine Services, LLC",
110     "Phone": "2125551234",
111     "remitAddress1": "123 Walnut Street",
112     "remitAddress2": "Suite 900",
113     "remitCity": "Miami",
114     "remitCountry": "US",
115     "RemitEmail": null,
116     "remitState": "FL",
117     "remitZip": "31113",
118     "State": "GA",
119     "StoredMethods": [],
120     "Summary": {
121       "ActiveBills": 2,
122       "PendingBills": 4,
123       "InTransitBills": 3,
124       "PaidBills": 18,
125       "OverdueBills": 1,
126       "ApprovedBills": 5,
127       "DisapprovedBills": 1,
128       "TotalBills": 34,
129       "ActiveBillsAmount": 1250.75,
130       "PendingBillsAmount": 2890.5,
131       "InTransitBillsAmount": 1675.25,
132       "PaidBillsAmount": 15420.8,
133       "OverdueBillsAmount": 425,
134       "ApprovedBillsAmount": 3240.9,
135       "DisapprovedBillsAmount": 180,
136       "TotalBillsAmount": 25083.2
137     },
138     "VendorId": 456,
139     "VendorNumber": "VEN-123",
140     "VendorStatus": 1,
141     "Zip": "31113",
142     "PaymentPortalUrl": "https://greenfield-landscaping.com/pay",
143     "CardAccepted": "yes",
144     "AchAccepted": "unable to determine",
145     "EnrichmentStatus": "fully_enriched",
146     "EnrichedBy": "web_search",
147     "EnrichedAt": "2026-03-05T14:22:10Z",
148     "EnrichmentId": "enrich-3890-a1b2c3d4"
149   },
150   "externalPaypointID": null,
151   "EntryName": null,
152   "BatchId": null,
153   "HasVcardTransactions": false,
154   "IsSameDayACH": false,
155   "ScheduleId": null,
156   "SettlementStatus": null,
157   "RiskFlagged": false,
158   "RiskFlaggedOn": null,
159   "RiskStatus": null,
160   "RiskReason": null,
161   "RiskAction": null,
162   "RiskActionCode": null
163 }

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

Bills associated with 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.

CreatedAtdatetime

Timestamp of when record was created, in UTC.

Eventslist of objects

Events associated to this transaction.

FeeAmountdouble

Service fee or sub-charge applied.

Gatewaystring

The payment 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.

ParentOrgIdlong

The ID of the org's parent organization.

PaymentDataobject

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

Paypoint legal name.

Sourcestring<=100 characters

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

Text description of the payout transaction status.

TotalAmountdouble

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

Vendorobject

Vendor related to the payout transaction.

externalPaypointIDstring

A custom identifier for the paypoint, if applicable.

EntryNamestring

The entity’s entrypoint identifier. Learn more.

BatchIddouble

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.

ScheduleIdlong

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

Name of the settlement status.

RiskFlaggedboolean

Indicates if the transaction was flagged for risk.

RiskFlaggedOndatetime

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.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error