Payabli moneyIn API
The moneyIn API from Payabli — 19 operation(s) for moneyin.
Payabli moneyIn API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include moneyIn. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 19 operations across 19 paths, and defines 202 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.
19 operations
19 paths
202 schemas
7 GET12 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payabli moneyIn 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 19
Across 19 paths, the API surfaces 19 operations — 7 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.
moneyIn 19
POST
/v2/MoneyIn/getpaid
Make a transaction (v2)
POST
/v2/MoneyIn/authorize
Authorize card transaction (v2)
POST
/v2/MoneyIn/capture/{transId}
Capture an authorized transaction (v2)
POST
/v2/MoneyIn/void/{transId}
Void a transaction (v2)
POST
/v2/MoneyIn/refund/{transId}
Refund a settled transaction (v2)
POST
/v2/MoneyIn/refund/{transId}/{amount}
Partially refund a settled transaction (v2)
POST
/MoneyIn/getpaid
Make a transaction
POST
/MoneyIn/authorize
Authorize card transaction
POST
/MoneyIn/capture/{transId}
Capture Auth
GET
/MoneyIn/capture/{transId}/{amount}
Capture an authorized transaction
GET
/MoneyIn/void/{transId}
Void a transaction
GET
/MoneyIn/refund/{transId}/{amount}
Refund a settled transaction
POST
/MoneyIn/refund/{transId}
Refund a settled transaction with split instructions
GET
/MoneyIn/reverse/{transId}/{amount}
Reverse a transaction
GET
/MoneyIn/sendreceipt/{transId}
Send receipt for transaction
GET
/MoneyIn/details/{transId}
Get details for a processed transaction
POST
/MoneyIn/makecredit
Make an ACH credit transaction
GET
/MoneyIn/reverseCredit/{transId}
Reverse an ACH credit transaction
POST
/MoneyIn/validate
Validate card
Schemas 202
The contract defines 202 schemas that model the data the API accepts and returns. The most detailed are V2TransactionDetails (51 properties), TransactionDetailRecord (51 properties), TransactionQueryRecordsCustomer (40 properties), BillData (32 properties). Each schema is shown below with its type and property counts.
IpAddress
string
The IP address associated with the transaction.
RiskReason
string
Reason for risk flagging.
ValidateResponse
object
Response for card validation endpoint
3 properties
3 required
PayabliApiResponse0
object
General response for certain moneyIn and moneyOut endpoints.
4 properties
1 required
VoidResponse
object
Response for MoneyIn/void endpoint
6 properties
5 required
AccountId
string
Custom identifier for payment connector.
Shippingaddress
string
The shipping address.
PaymentDetailCredit
object
The PaymentDetail object for microdeposit (MakeCredit) transactions.
3 properties
1 required
AvsResponse
string
Text code describing the result for address validation (applies only for card transactions).
FreightAmount
number
Freight/shipping amount.
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).
PayMethodBodyAllFields
object
Model for the PaymentMethod object, includes all method types.
16 properties
3 required
TransactionDetailPaymentData
object
Payment method and transaction details
13 properties
13 required
AuthResponse
object
Response for MoneyIn/authorize.
4 properties
3 required
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
CvvResponseText
string
Text code describing the result for CVV validation (applies only for card transactions).
BillDataPaymentTerms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30. Mirrors the values in [Terms](schema-terms).
RiskFlaggedOn
string
Timestamp when the transaction was flagged for risk.
TransactionDetailPaymentDetails
object
Detailed breakdown of payment amounts and identifiers
14 properties
14 required
CapturePaymentDetails
object
2 properties
1 required
Email
string
Email address.
V2BadRequestErrorDetail
object
Individual field error detail for bad request responses.
2 properties
2 required
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…
Accountexp
string
Expiration date of card used in transaction.
BillingStateNullable
string
Billing state. Must be a 2-letter state code for addresses in the US.
RetrievalId
integer
Identifier of retrieval request.
V2DeclinedTransactionResponseWrapper
object
Response wrapper for declined v2 Money In transaction endpoints (HTTP 402). Returned when a transaction is declined by the card network or issuer. All decline…
6 properties
6 required
ResponseDataRefunds
object
9 properties
8 required
V2TransactionDetails
object
Complete transaction details returned by v2 Money In endpoints. This matches the structure of the transaction details previously returned by the v1 details end…
51 properties
47 required
SplitCount
integer
Number of split funding instructions associated with the transaction. Returns 0 when the transaction has no splits.
CvvResponse
string
Text code describing the result for CVV validation (applies only for card transactions).
ResultCodeText
string
Description of the result code. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
BillingCountryNullable
string
Billing address country.
Cardzip
string
ZIP or postal code for the billing address of cardholder. We strongly recommend that you include this field when using card as a method.
CustomerStatus
integer
Customer Status. Possible values: - -99 Deleted - 0 Inactive - 1 Active - 85 Locked (typically due to multiple failed login attempts)
PayMethodACH
object
8 properties
4 required
RequestRefund
object
6 properties
TransactionDetailResponseData
object
Response data from payment processor
16 properties
14 required
RoomIdNotInUse
integer
Field not in use on this endpoint. It always returns 0.
SummaryCommodityCode
string
Commodity code.
ItemUnitofMeasure
string
Unit of measurement. Max length of 100 characters.
TransactionDetailEvent
object
Event associated with transaction processing
3 properties
3 required
ExpectedProcessingDateTime
string
The expected time that the refund will be processed.
ReverseResponse
object
6 properties
5 required
TransactionTime
string
Timestamp when transaction was submitted, in UTC.
Entrypointfield
string
The entrypoint identifier.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
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…
ChargebackId
integer
Identifier of chargeback transaction.
DutyAmount
number
Duty amount.
ValidateResponseData
object
Response data for card validation
8 properties
7 required
RiskStatus
string
Current risk status of the transaction.
Tax
number
Tax rate in percent applied to the invoice.
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
V2ResponseReason
string
Human-readable reason corresponding to the response code.
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…
ItemDescription
string
Item or product description. Max length of 250 characters.
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'.
RefundWithInstructionsResponse
object
4 properties
3 required
V2TransactionDetailResponseData
object
Response data from payment processor
16 properties
16 required
AchHolderType
string
The bank's accountholder type: personal or business.
Cardnumber
string
The card number. Required when method is card and a storedMethodId isn't included.
Shippingstate
string
Shipping state or province.
PayMethodStoredMethodMethod
string
Method to use for the transaction. Use card, ach, or wallet depending on what kind of method was tokenized to use a saved payment method for this transaction.
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
QueryTransactionPayorDataCustomer
object
22 properties
RefundDetail
object
Object containing details about the refund, including line items and optional split instructions.
2 properties
FeeAmount
number
Service fee or sub-charge applied.
CustomerId
integer
The Payabli-generated unique ID for the customer.
TransactionDetailRecordMethod
string
Payment method used for the transaction
ExternalProcessorInformation
string
Information from the external processor about the transaction.
BillingCityNullable
string
Billing city.
CustomerNumberNullable
string
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
PayabliApiResponse0ResponseData
object
8 properties
CustomerVaultId
string
BillItem
object
12 properties
BillingAddressAddtlNullable
string
Additional line for the billing address.
ItemProductCode
string
Item or product code. Max length of 250 characters.
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
Achaccounttype
string
Bank account type: Checking or Savings.
TransactionDetailCustomer
object
Customer information associated with the transaction
22 properties
22 required
BillData
object
32 properties
VoidResponseData
object
Response data for void transactions
8 properties
4 required
PaypointId
integer
The paypoint's ID. Note that this is different than the entryname.
RequestPaymentValidate
object
5 properties
2 required
PayMethodCredit
object
8 properties
3 required
CaptureResponseData
object
Response data for capture transactions
8 properties
8 required
PayMethodStoredMethod
object
The required and recommended fields for a payment made with a stored payment method.
4 properties
1 required
TermsConditions
string
Custom terms and conditions included in the invoice.
RiskActionCode
integer
Numeric code representing the risk action.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
BillingAddressNullable
string
Billing address.
Cardexp
string
Card expiration date in format MMYY or MM/YY. Required for card transactions.
BatchNumber
string
A unique identifier for the batch. This is generated by Payabli when the batch is created, and follows this format: paypointId + "" + serviceName + "" + batchD…
Shippingcountry
string
Shipping address country.
SaveIfSuccess
boolean
When true, Payabli saves the payment method if the transaction is successful. The payment method ID is returned in the response as methodReferenceId. Defaults…
V2InternalServerError
object
Internal server error response (HTTP 500) returned when an unexpected error occurs. Follows RFC 7807 Problem Details format.
4 properties
4 required
Device
string
Identifier of registered cloud device used in the transaction.
Responsedata
object
The object containing the response data.
PendingFeeAmount
number
The difference between the configured pass-through fee and the fee amount sent in the request. When transferring funds, Payabli uses this field to deduct the f…
Signaturedata
string
Check
object
2 properties
2 required
ReceiptResponse
object
Response for SendReceipt endpoint.
3 properties
1 required
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
V2TransactionResponseWrapper
object
Standard response wrapper for v2 Money In transaction endpoints. All v2 transaction endpoints return responses in this format with consistent code, reason, exp…
6 properties
6 required
Cardcvv
string
Card Verification Value (CVV) associated with the card number. We strongly recommend that you include this field when using card as a method.
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…
ForceCustomerCreation
boolean
When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false.
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…
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](…
RefundResponse
object
4 properties
3 required
PayMethodCloud
object
3 properties
1 required
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.
GetPaidResponseData
object
Response data for GetPaid transactions
9 properties
7 required
Methodall
string
Method to use for the transaction.
SettlementStatus
integer
Settlement status for transaction. See [the docs](/developers/references/money-in-statusespayment-funding-status) for a full reference.
Shippingcity
string
Shipping city.
EmvAuthResponseData
string
EMV authorization response data, applicable for card transactions.
FileContentFtype
string
The MIME type of the file (if content is provided).
PayabliAPIResponseGetPaid
object
General response for GetPaid endpoint supporting multiple payment methods
4 properties
3 required
Cash
object
1 property
1 required
TransRequestBody
object
12 properties
2 required
RefundV2Request
object
Optional request body for the v2 refund endpoints. Provide split instructions to refund a split-funded transaction. Omit the body for a standard refund. Fields…
6 properties
Frequency
string
Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (s…
TransactionDetailInvoiceData
object
Invoice information if transaction is associated with an invoice
32 properties
32 required
QueryPaymentData
object
14 properties
PaymentMethod
Information about the payment method for the transaction.
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
Shippingaddressadditional
string
Additional line for shipping address.
ShippingFromZip
string
Sender shipping ZIP code.
Invoicestatus
integer
Invoice status code.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
AchHolder
string
Bank account holder. This field is required when method is ach or check.
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…
V2ResponseCode
string
Payabli's unified response code. Starts with A (Approved) or D (Declined) followed by a four-digit code that provides specific details about the transaction re…
QueryCFeeTransaction
object
8 properties
TransactionQueryRecordsCustomer
object
40 properties
2 required
Customeridtrans
integer
Payabli-generated unique ID of customer owner of transaction. Returns 0 if the transaction wasn't assigned to an existing customer or no customer was created.
Subscriptionid
integer
Payabli identifier of the subscription associated with the transaction.
Achaccount
string
Bank account number.
ItemCommodityCode
string
Item or product commodity code. Max length of 250 characters.
SplitFundingRefundContent
object
4 properties
Referenceidtrans
string
The transaction identifier in Payabli.
RefundId
integer
Identifier of refund transaction linked to this payment.
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
ItemProductName
string
Item or product name. Max length of 250 characters.
Attachments
array
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Cardholder
string
Cardholder name.
Accountzip
string
ZIP code for card used in transaction.
V2ResponseExplanation
string
Detailed description of the response code.
PayorDataRequest
object
Customer information. May be required, depending on the paypoint's settings. Required for subscriptions.
21 properties
TransStatus
integer
Status of transaction. See [the docs](/developers/references/money-in-statusesmoney-in-transaction-status) for a full reference.
OrgParentName
string
The name of the parent organization.
Netamountnullable
number
Net amount.
EntrypageId
integer
If applicable, the internal reference ID to the payment page associated with the transaction.
BillingZip
string
Billing address ZIP code.
Achrouting
string
ABA/routing number of Bank account.
ResultCodev2
string
Unified result code for the transaction. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
PaymentCategories
object
4 properties
2 required
PayabliApiResponse
object
3 properties
1 required
AuthResponseResponseData
object
8 properties
7 required
Shippingzip
string
Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: 37615-1234 or 3…
SplitFunding
array
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
PayorId
integer
Unique ID for the customer linked to the transaction. This is the same value as the customerId used when creating or referencing a customer.
Operation
string
The transaction's operation.
RequestPaymentValidatePaymentMethod
object
Object describing payment method to use for validation.
5 properties
5 required
RequestPaymentValidatePaymentMethodMethod
string
The card validation method.
V2BadRequestError
object
Bad request error response (HTTP 400) returned when request validation fails. Follows RFC 7807 Problem Details format with additional Payabli-specific fields.
8 properties
8 required
CaptureResponse
object
Response for MoneyIn/capture endpoint
6 properties
6 required
PhoneNumber
string
Phone number.
QueryTransactionEventsEventData
Any data associated to the event received from processor. Contents vary by event type.
InvoiceAmount
number
The invoice amount.
TransactionDetailRecord
object
Complete transaction details including payment information, customer data, and processing metadata. This is returned when includeDetails=true.
51 properties
47 required
Source
string
Custom identifier to indicate the transaction or request source.
RequestCreditPaymentMethod
object
Object describing the ACH payment method to use for transaction.
6 properties
1 required
CaptureRequest
object
1 property
1 required
InvoiceType
integer
Invoice type. Value 0 is for single/one-time invoices, 1 for scheduled invoices.
OrderId
string
Custom identifier for the transaction.
V2ResponseAction
string
Recommended resolution approach or next steps based on the response.
RiskAction
string
Action taken due to risk assessment.
RequestCredit
object
9 properties
3 required
QueryResponseData
object
The transaction's response data.
15 properties
AvsResponseText
string
Text code describing the result for address validation (applies only for card transactions).
AchValidation
boolean
When true, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
Orderdescription
string
Text description of the transaction.
RiskFlagged
boolean
Indicates if the transaction was flagged for risk.
PurchaseOrder
string
Purchase order number.
PaymentDetail
object
Details about the payment.
8 properties
1 required
QueryTransactionEvents
object
3 properties
Identifierfields
array
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Authcode
string
Authorization code for the transaction.
ReturnedId
integer
Identifier of return/chargeback transaction linked to this payment.
Legalname
string
Business legal name.
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
#moneyIn
Where this information came from
This is an independent, third-party profile of Payabli moneyIn 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.