API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- GETList Transactions for Paypoint
- GETList Transactions for Org
- GETList Batches for Paypoint
- GETList Batches for Org
- GETList Batch Details for Paypoint
- GETList Batch Details for Org
- GETList MoneyOut Batches for Paypoint
- GETList MoneyOut Batches for Org
- GETList Subscriptions for Paypoint
- GETList Subscriptions for Org
- GETList Settled Transactions for Paypoint
- GETList Settled Transactions for Org
- GETGet Transfer Details
- GETList Transfers for Paypoint
- GETList Chargebacks for Paypoint
- GETList Chargebacks for Org
- GETList Customers for Paypoint
- GETList Customers for Org
- GETList Users for Paypoint
- GETList Users for Org
- GETList Suborganizations
- GETList Paypoints for Org
- GETList Notifications for Paypoint
- GETList Notifications for Org
- GETList Reports for Paypoint
- GETList Reports for Org
- GETList Vendors for Paypoint
- GETList Vendors for Org
- GETList vCards for Paypoint
- GETList vCards for Org
- GETList MoneyOut Transactions for Paypoint
- GETList MoneyOut Transactions for Org
- GETList Items for Paypoint
- GETList Invoices for Paypoint
- GETList Invoices for Org
- GETList Bills for Paypoint
- GETList Bills for Org
- GET
- Statistic
- Export
- Import
Object Models
- Object Model References
Get Details for Transfer
Get transaction details for a single transfer for an entrypoint.
You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters.
Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters= and run the request in a different client.
For example:
should become:
—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Query Parameters
Max number of records to return for the query. Use 0 or negative value to return all records.
The number of records to skip before starting to collect the result set.
The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.
Collection of field names, conditions, and values used to filter the query. See Filters and Conditions Reference for more information.
List of field names accepted:
- grossAmount (gt, ge, lt, le, eq, ne)
- chargeBackAmount (gt, ge, lt, le, eq, ne)
- returnedAmount (gt, ge, lt, le, eq, ne)
- billingFeeAmount (gt, ge, lt, le, eq, ne)
- thirdPartyPaidAmount (gt, ge, lt, le, eq, ne)
- netFundedAmount (gt, ge, lt, le, eq, ne)
- adjustmentAmount (gt, ge, lt, le, eq, ne)
- splitFundingAmount (gt, ge, lt, le, eq, ne)
- operation (in, nin, eq, ne)
- transactionId (eq, ne, in, nin)
- category (eq, ne, ct, nct)
- type (eq, ne, in, nin)
- method (eq, ne, in, nin)
Response
Amount of corrections applied to Billing & Fees charges.
Batch amount.
Batch number.
Amount of charges and fees applied for services and transactions.
Details about billing and fees items.
Base amount for billing calculation.
Calculated billing amount for the billable event.
Category group of the billable event.
Description of the billable event.
Amount charged for the billable event.
Percentage of net amount to be billed.
Frequency of the billable event.
Service group descriptor of the billable event.
A field used internally by Payabli to categorize the transaction details. Values are:
auth: Any paymentrefund: ACH return or Refundadj: Adjustmentscb: Chargebacksplit: Split amount
Service Fee or sub-charge transaction associated to the main transaction.
Timestamp when transaction was submitted, in UTC.
Amount of chargebacks to be deducted from batch.
Connector used for transaction.
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:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Customer's billing address.
Additional line for Customer's billing address.
Customer's billing city.
Customer's billing country.
Customer's email address.
Customer's phone number.
Customer's billing state. Must be 2-letter state code for address in US.
Customer's billing ZIP code.
Customer's company name.
Timestamp of when record was created, in UTC.
The Payabli-generated unique ID for the customer.
The Payabli-generated unique ID for the customer.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Customer/Payor first name.
Array of field names to be used as identifiers.
Customer/Payor last name.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping state or province.
Shipping ZIP code.
50Identifier of registered cloud device used in the transaction.
If applicable, the internal reference ID to the payment page capturing the payment.
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
Service fee or sub-charge applied.
Internal identifier used for processing.
Gross batch is the total amount of the payments grouped in the batch. This amount includes service fees.
Amount being held for fraud or risk concerns.
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:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Company name of the recipient of the invoice.
Discount applied to the invoice.
Duty amount.
First name of the recipient of the invoice.
Freight/shipping amount.
Frequency of scheduled invoice.
one-time, weekly, every2weeks, every6months, monthly, every3months, annually Invoice total amount.
Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice number. Identifies the invoice under a paypoint.
250Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0, 1, 2, 4, 99 Type of invoice. Only 0 for one-time invoices is currently supported.
Array of line items included in the invoice.
Item or product price per unit.
Item or product name. Max length of 250 characters.
250Quantity of item or product.
Array of tags classifying item or product.
Item or product commodity code. Max length of 250 characters.
250Item or product description. Max length of 250 characters.
250Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both.
0, 1, 2 Item or product code. Max length of 250 characters.
250Tax amount applied to item or product.
Tax rate applied to item or product.
Total amount in item or product.
Unit of measurement. Max length of 100 characters.
100Last name of the recipient of the invoice.
Notes included in the invoice.
Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.
PIA, CIA, UR, NET10, NET20, NET30, NET45, NET60, NET90, EOM, MFI, 5MFI, 10MFI, 15MFI, 20MFI, 2/10NET30, UF, 10UF, 20UF, 25UF, 50UF Purchase order number.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping recipient's contact email address.
Sender shipping ZIP code.
Recipient phone number.
Shipping state or province.
Shipping ZIP code.
50Commodity code.
Tax rate in percent applied to the invoice.
Custom terms and conditions included in the invoice.
The payment method.
Payment method used: card, ach, or wallet.
Net amount paid.
Net transfer amount.
The transaction's operation.
Custom identifier for the transaction.
250ID of immediate parent organization.
The name of the parent organization.
Expiration date of card used in transaction.
Custom identifier for payment connector.
250Bank account type or card brand.
ZIP code for card used in transaction.
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 be related to the DPAN (device primary account number), not the card connected to Apple Pay.
The card brand. For example, Visa, MasterCard, American Express, Discover.
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID.
The name of the financial institution that issued the card.
The issuing financial institution's country name.
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
The type of card: Credit or Debit.
The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
Account holder name for the method.
Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant.
Available values:
payor: For cardholder-initiated transactionsmerchant: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Text description of the transaction.
250Details about the payment.
Total amount to be charged. If a service fee is sent, then this amount should include the service fee."
Array of payment categories/line items describing the amount to be paid Note: These categories are for information only and are not validated against the total amount provided.
Price/cost per unit of item or category.
Name of item or category.
Description of item or category
Quatity of item or category
Object containing image of paper check.
A check number to be used in the ach transaction. Required for payment method = 'check'.
Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.
Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.
Split funding instructions for the transaction. See Split a Transaction for more.
The accountId for the account the split should be sent to.
Amount from the transaction to sent to this recipient.
A description for the split.
The entrypoint the split should be sent to.
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.
Available values:
first: The first use of the payment method. This is almost always a cardholder-initiated transaction.subsequent: For merchant-initiated transactions after the first use of the payment method.
See Understanding CIT and MIT Indicators for more information.
Identifier of stored payment method used in transaction.
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 unscheduled.
Available values:
unscheduled: This type is used for transactions that are one-time or otherwise not pre-scheduled.subscription: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.recurring: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.
See Understanding CIT and MIT Indicators for more information.
Unique Transaction ID.
Unique ID for customer linked to the transaction.
Paypoint's DBA name.
Paypoint's entryname.
50The ID of the paypoint the transfer belongs to.
InternalId for paypoint.
Paypoint's legal name.
The difference between the configured pass-through fee and the fee amount sent in the request. When transfering funds, Payabli uses this field to deduct the fee difference and transfer the correct amount to the merchant.
When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See Fee Configuration to learn more about pass-through fee settings.
Amount of refunds to be deducted from batch.
Identifier of refund transaction linked to this payment.
Amount of previously held funds that have been released after a risk review.
The transaction's response data.
Authorization code.
Text code describing the result for address validation (applies only for card transactions).
Text code describing the result for address validation (applies only for card transactions).
Text code describing the result for CVV validation (applies only for card transactions).
Text code describing the result for CVV validation (applies only for card transactions).
EMV authorization response data, applicable for card transactions.
Custom identifier for the transaction.
250Response text for operation: 'Success' or 'Declined'.
Internal result code processing the transaction. Value 1 indicates successful operation, values 2 and 3 indicate errors.
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 decline.
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 decline.
The transaction identifier in Payabli.
Type of transaction or operation.
Amount of ACH returns to be deducted from batch.
Identifier of return/chargeback transaction linked to this payment.
Reference to the subscription that originated the transaction.
Settlement status for transaction. See the docs for a full reference.
Custom identifier to indicate the transaction or request source.
100Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
The accountId for the account the split should be sent to.
Amount from the transaction to sent to this recipient.
A description for the split.
The entrypoint the split should be sent to.
Amount of payments captured in the batch cycle that are deposited separately. For example, checks or cash payments recorded in the batch but not deposited via Payabli, or card brands making a direct transfer in certain situations.
Transaction total amount (including service fee or sub-charge)
Events associated with this transaction.
Any data associated to the event received from processor. Contents vary by event type.
Date and time of event.
Event descriptor. See TransEvent Reference for more details.
The transaction ID.
Transaction date and time, in UTC.
Not currently in use.
The transfer detail ID.
The transfer ID.
The transaction type: credit or debit.
ACH returns deducted from the batch.
Corrections applied to Billing & Fees charges.
Charges applied for transactions and services.
Chargebacks deducted from batch.
The gross batch amount before deductions.
Funds being held for fraud or risk concerns.
Auxiliary validation used internally by payment pages and components.
Number of records per page.
Refunds deducted from batch.
Previously held funds that have been released after a risk review.
Service fees are any pass-through fees charged to the customer at the time of payment. These are not transferred to the merchant when the batch is transferred and funded.
Payments captured in the batch cycle that are deposited separately. For example, checks or cash payments recorded in the batch but not deposited via Payabli, or card brands making a direct transfer in certain situations.
The total sum of the transfers in the response.
The total sum of the transfers in the response.
The gross batch amount minus service fees.
Number of pages in the response.
Number of records in the response.
The transfer amount is the net batch amount plus or minus any returns, refunds, billing and fees items, chargebacks, adjustments, and third party payments. This is the amount from the batch that is transferred to the merchant bank account.
Was this page helpful?