Payabli moneyOut API
The moneyOut API from Payabli — 12 operation(s) for moneyout.
Payabli moneyOut API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 13 operations across 12 paths, and defines 155 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
13 operations
12 paths
155 schemas
1 DELETE5 GET1 PATCH5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payabli moneyOut API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the header as requestToken (APIKeyAuth).
BearerAuth— OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).APIKeyAuth— Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).
Paths & Operations 13
Across 12 paths, the API surfaces 13 operations — 1 DELETE, 5 GET, 1 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
moneyOut 13
POST
/MoneyOut/authorize
Authorize a payout
GET
/MoneyOut/capture/{referenceId}
Capture an authorized payout transaction
POST
/MoneyOut/captureAll
Capture a list of authorized payout transactions
DELETE
/MoneyOut/cancel/{referenceId}
Cancel a payout transaction
GET
/MoneyOut/cancel/{referenceId}
Cancel a payout transaction
POST
/MoneyOut/cancelAll
Cancel list of payout transactions
GET
/MoneyOut/details/{transId}
Get details for a processed payout transaction
GET
/MoneyOut/checkimage/{assetName}
Get check image
PATCH
/MoneyOut/status/{transId}/{checkPaymentStatus}
Update check payment status
POST
/MoneyOut/reissue
Reissue a payout transaction
GET
/MoneyOut/vcard/{cardToken}
Get a virtual card
PUT
/MoneyOutCard/vcard/{cardToken}/renew
Renew a virtual card
POST
/vcard/send-card-link
Send virtual card link
Schemas 155
The contract defines 155 schemas that model the data the API accepts and returns. The most detailed are VendorQueryRecord (53 properties), VCardGetResponseAssociatedVendor (44 properties), BillDetailResponse (41 properties), RequestOutAuthorizeVendorData (32 properties). Each schema is shown below with its type and property counts.
RiskReason
string
Reason for risk flagging.
IsSameDayACH
boolean
When true, this is a same-day ACH transaction.
ContactsField
array
List of contacts.
AccountId
string
Custom identifier for payment connector.
SettlementStatusPayout
string
The settlement status of the payout transaction. See [Payout Transaction Statuses](/guides/pay-out-status-referencepayout-transaction-statuses) for a full refe…
Maskedaccount
string
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
BankName
string
Name of bank for account.
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
CvvResponseText
string
Text code describing the result for CVV validation (applies only for card transactions).
RiskFlaggedOn
string
Timestamp when the transaction was flagged for risk.
Email
string
Email address.
Accountexp
string
Expiration date of card used in transaction.
MethodReferenceId
string
The stored method's identifier (sometimes referred to as 'token') in Payabli. When null, the method wasn't created, or doesn't exist, depending on the operatio…
CityNullable
string
The city.
RequestOutAuthorizeVendorData
object
Object containing vendor data.
32 properties
RemitEmail
string
Remittance email address. Used for sending virtual cards and other information about payouts.
EntityIdString
string
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.
RoomIdNotInUse
integer
Field not in use on this endpoint. It always returns 0.
PayeeName
string
Alternative name used to receive paper check.
RequestOutAuthorizePaymentDetails
object
Object containing payment details.
5 properties
AllowedCheckPaymentStatus
string
The new status to apply to a check payment transaction. - 0: Cancelled/Voided — Cancels the check transaction. - 5: Paid — Marks the check transaction as paid.
Entrypointfield
string
The entrypoint identifier.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
BillDetailsResponse
object
Response object for bill details. Contains basic information about a bill.
8 properties
2 required
IdempotencyKey
string
Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. Th…
VCardGetResponseAssociatedVendorSummary
object
Summary of vendor's billing and transaction status.
16 properties
Vendorid
integer
Payabli identifier for vendor record.
RiskStatus
string
Current risk status of the transaction.
SendVCardLinkRequest
object
1 property
1 required
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
AchSecCode
string
Standard Entry Class (SEC) code is a three letter code that describes how an ACH payment was authorized. Supported values are: - PPD (Prearranged Payment and D…
RenewVCardResponseData
object
9 properties
9 required
CreatedAt
string
Timestamp of when record was created, in UTC.
BinData
object
Object containing information related to the card. This object is null unless the payment method is card. If the payment method is Apple Pay, the binData will…
11 properties
Holdername
string
The cardholder name.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
VendorPhone
string
Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.
AchHolderType
string
The bank's accountholder type: personal or business.
RequestOutAuthorizeVendorBillingData
object
Object containing vendor's bank information. This object is deprecated for this endpoint. Use the paymentMethod object in payout authorize requests instead.
5 properties
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
Remitcountry
string
Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.
FeeAmount
number
Service fee or sub-charge applied.
PayabliApiResponse00Responsedatanonobject
object
6 properties
1 required
AuthorizePayoutBody
object
12 properties
5 required
EnrollmentStatus
string
Enrollment status of vendor in payables program.
InternalReferenceId
integer
An internal reference ID.
PayabliApiResponse0000
object
The response for canceling a single payout transaction.
5 properties
1 required
VendorName2
string
Secondary name for vendor. If provided, allowed characters are the same as the name1 field.
PaymentIdString
string
The unique transaction ID. This value is a string representation of a long integer.
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
Comments
string
Any comment or description.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
OperationResult
object
2 properties
1 required
ScheduleId
integer
ID of the recurring payment schedule associated with the transaction.
Vendorstatus
integer
Vendor's status. Allowed values: - 0 Inactive - 1 Active - -99 Deleted
BankAccountHolderType
string
Describes whether the bank is a personal or business account.
VendorPaymentMethod
object
Payment method object to use for the payout. - { method: "managed" } - Managed payment method - { method: "vcard" } - Virtual card payment method - { method: "…
2 properties
1 required
LocationCode
string
A location code used to identify the vendor's location.
AdditionalDataString
string
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: json { "additionalData"…
RoutingAccount
string
Routing number of bank account.
RiskActionCode
integer
Numeric code representing the risk action.
CaptureAllOutResponse
object
5 properties
1 required
VendorEin
string
EIN/Tax ID for vendor. Must be nine digits formatted as XX-XXXXXXX (for example, 12-3456789).
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Ein
string
Business EIN or tax ID. This value is masked in API responses.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
BillingDataResponse
object
14 properties
13 required
VendorQueryRecord
object
53 properties
VendorNumber
string
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
ReissuePayoutBody
object
Request body for reissuing a payout transaction.
1 property
1 required
Remitzip
string
Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits o…
Signaturedata
string
CaptureAllOutResponseResponseDataItem
object
5 properties
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
CancelPayoutResponseData
object
Response data for canceling a single payout transaction. Mirrors the general response data, with VendorId added alongside CustomerId.
9 properties
BankAccountHolderName
string
The accountholder's name.
Vendoridtrans
integer
Payabli-generated unique ID of the vendor on the payout. Returns the same value as the response's customerId/CustomerId field, or 0 when no vendor is associate…
StoredMethodUsageType
string
Strongly recommended. The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to u…
ContactsResponse
object
4 properties
SplitFundingContent
object
4 properties
AdditionalDataMap
object
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](…
Resulttext
string
Text describing the result. If ResultCode = 1, will return Approved or a general success message. If ResultCode = 2 or 3, will contain the cause of the error o…
BillId
integer
The bill's ID in Payabli. This value is automatically generated by Payabli when the bill is created.
AuthCapturePayoutResponseData
object
9 properties
9 required
AdditionalData
object
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](…
Remitaddress2
string
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
Storedmethodid
string
Payabli identifier of a tokenized payment method. If this field is used in a request, the method field is overridden and the payment is made using the payment…
Accounttype
string
Bank account type or card brand.
BillDetailResponse
object
41 properties
AccountingField
string
Optional custom field.
FileContentFtype
string
The MIME type of the file (if content is provided).
Entry
string
The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overviewentrypoint-vs-entry).
Mcc
string
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcccodes.csv) lists MCC codes.
Responsedatanonobject
The response data.
OrgParentId
integer
The ID of the org's parent organization.
QueryPaymentData
object
14 properties
VendorPaymentMethodString
string
The vendor's preferred payment method. Can be one of: - managed — Managed payment method - vcard — Virtual card payment method - check — Check payment method -…
LastModified
string
Timestamp of when record was last updated, in UTC.
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
AuthorizePaymentMethod
object
Payment method object for vendor payouts. - { method: "managed" } - Managed payment method - { method: "vcard" } - Virtual card payment method - { method: "che…
10 properties
1 required
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
VCardGetResponse
object
27 properties
ResultCode
integer
Result code for the operation. Value 1 indicates a successful operation, values 2 and 3 indicate errors. A value of 10 indicates that an operation has been ini…
Remitcity
string
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
NetAmountstring
string
Net amount owed in bill. Required when adding a bill.
Remitaddress1
string
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
HasVcardTransactions
boolean
When true, indicates that the paypoint has vCard transactions.
Subscriptionid
integer
Payabli identifier of the subscription associated with the transaction.
RequestOutAuthorizeInvoiceData
object
13 properties
Gatewayfield
string
The payment gateway used to process the transaction.
VCardGetResponseContact
object
Contact information structure.
4 properties
Referenceidtrans
string
The transaction identifier in Payabli.
LotNumber
string
Lot number associated with the bill.
Attachments
array
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Accountzip
string
ZIP code for card used in transaction.
Contacts
object
5 properties
Terms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30.
OrgParentName
string
The name of the parent organization.
SettlementStatusName
stringnull
Name of the settlement status.
Netamountnullable
number
Net amount.
VendorName1
string
Primary name for vendor. Required for new vendor.
VCardGetResponseAssociatedVendor
object
Information about the associated vendor.
44 properties
StateNullable
string
The state or province.
PaymentCategories
object
4 properties
2 required
AddressNullable
string
The address.
SplitFunding
array
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
Remitstate
string
Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian…
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
QueryTransactionEventsEventData
Any data associated to the event received from processor. Contents vary by event type.
VendorSummary
object
16 properties
Source
string
Custom identifier to indicate the transaction or request source.
Zip
string
ZIP code for address.
RenewVCardResponse
object
3 properties
3 required
OrderId
string
Custom identifier for the transaction.
RiskAction
string
Action taken due to risk assessment.
ReissuePayoutResponseData
object
3 properties
2 required
TypeAccount
string
Type of bank account: Checking or Savings.
AvsResponseText
string
Text code describing the result for address validation (applies only for card transactions).
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
VendorCheckNumber
string
A check number between 1 and 500,000,000. This value must be passed as a string. This value can be used for fraud prevention with the positive pay service. Whe…
Orderdescription
string
Text description of the transaction.
RiskFlagged
boolean
Indicates if the transaction was flagged for risk.
PaymentDetail
object
Details about the payment.
8 properties
1 required
QueryTransactionEvents
object
3 properties
AuthCapturePayoutResponse
object
6 properties
6 required
VCardGetResponseAssociatedVendorBillingData
object
Billing data for the vendor.
14 properties
AccountNumber
string
Account number for bank account. This value is returned masked in responses.
ReissuePayoutResponse
object
4 properties
4 required
Legalname
string
Business legal name.
Authcode
string
Authorization code for the transaction.
ReissuePaymentMethod
object
Payment method for reissuing a payout transaction. The reissue endpoint uses the payment method details directly. It doesn't fall back to the vendor's managed…
6 properties
1 required
AutoCapture
boolean
When true, Payabli captures the transaction asynchronously after a successful authorization. The authorization request returns once the transaction is authoriz…
AddressAddtlNullable
string
Additional line for the address.
RenewVCardRequest
object
1 property
1 required
Discount
number
Discount applied to the invoice.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Payabli 12
Other APIs Payabli publishes across the network.
Payabli Bill API
Payabli Boarding API
Payabli chargeBacks API
Payabli checkCapture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli ghostCard API
Payabli hostedPaymentPages API
Payabli Import API
Payabli Invoice API
Where this information came from
This is an independent, third-party profile of Payabli moneyOut API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.