Get List of MoneyOut Transactions for Organization

GET

Query

payouts

org

{orgId}

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:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

should become:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

orgId

integer

required

The numeric identifier for organization, assigned by Payabli.

Query Parameters

parameters

object

Collection of field names, conditions, and values used to filter the query.

List of field names accepted:

status (in, nin, eq, ne)
transactionDate (gt, ge, lt, le, eq, ne)
billNumber (ct, nct)
vendorNumber (ct, nct, eq, ne)
vendorName (ct, nct, eq, ne)
paymentMethod (ct, nct, eq, ne, in, nin)
paymentId (ct, nct, eq, ne)
batchNumber (ct, nct, eq, ne)
totalAmount (gt, ge, lt, le, eq, ne)
paypointLegal (ne, eq, ct, nct)
paypointDba (ne, eq, ct, nct)
accountId (ne, eq, ct, nct)
orgName (ne, eq, ct, nct)
externalPaypointID (ct, nct, eq, ne)
paypointId (eq, ne)
vendorId (eq, ne)
vendorEIN (ct, nct, eq, ne)
vendorPhone (ct, nct, eq, ne)
vendorEmail (ct, nct, eq, ne)
vendorAddress (ct, nct, eq, ne)
vendorCity (ct, nct, eq, ne)
vendorState (ct, nct, eq, ne)
vendorCountry (ct, nct, eq, ne)
vendorZip (ct, nct, eq, ne)
vendorMCC (ct, nct, eq, ne)
vendorLocationCode (ct, nct, eq, ne)
vendorCustomField1 (ct, nct, eq, ne)
vendorCustomField2 (ct, nct, eq, ne)
comments (ct, nct)
payaccountCurrency (ne, eq, in, nin)
remitAddress (ct, nct)
source (ct, nct, eq, ne)
updatedOn (gt, ge, lt, le, eq, ne)
feeAmount (gt, ge, lt, le, eq, ne)
lotNumber (ct, nct)
customerVendorAccount (ct, nct, eq, ne)
batchId (eq, ne)

List of comparison accepted - enclosed between parentheses:

eq or empty => equal
gt => greater than
ge => greater or equal
lt => less than
le => less or equal
ne => not equal
ct => contains
nct => not contains
in => inside array separated by "|"
nin => not inside array separated by "|"

List of parameters accepted:

limitRecord : max number of records for query (default="20", "0" or negative value for all)
fromRecord : initial record in query
sortBy : indicate field name and direction to sort the results

Example: netAmount(gt)=20 returns all records with netAmount greater than 20.00

Example: sortBy=desc(netamount) returns all records sorted by netAmount descending

limitRecord

integer

default:

Max number of records to return for the query. Use 0 or negative value to return all records.

fromRecord

integer

The number of records to skip before starting to collect the result set.

sortBy

string

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.

Response

200 - application/json

Records

object[]

Records.BatchNumber

string | null

The batch number.

Records.Bills

object[] | null

Events associated with this transaction.

Records.Bills.AccountingField1

string | null

Optional custom field.

Records.Bills.AccountingField2

string | null

Optional custom field.

Records.Bills.AdditionalData

string | null

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

Records.Bills.attachments

object[] | null

Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly-accessible link. For full details on using this field with a payout authorization, see the documentation.

Records.Bills.billId

integer | null

Bill ID in Payabli.

Records.Bills.comments

string | null

Any comments about bill. For managed payouts, this field has a limit of 100 characters.

Maximum length: 250

Records.Bills.dueDate

string | null

Bill due date in format YYYY-MM-DD or MM/DD/YYYY.

Records.Bills.invoiceDate

string | null

Bill date in format YYYY-MM-DD or MM/DD/YYYY.

Records.Bills.invoiceNumber

string | null

Custom number identifying the bill. Must be unique in paypoint. Required for new bill and when billId is not provided.

Maximum length: 250

Records.Bills.netAmount

string | null

Net Amount owed in bill. Required when adding a bill.

Records.Bills.Terms

string | null

Description of payment terms.

Records.CardToken

string | null

Records.CheckData

object | null

Object referencing paper check image.

Records.CheckNumber

string | null

Paper check number related to payout transaction.

Records.Comments

string | null

Any comment or description for payout transaction.

Maximum length: 250

Records.CreatedAt

string

Timestamp when the payment was created, in UTC.

Records.EntryName

string | null

The entrypoint identifier.

Maximum length: 50

Records.Events

object[] | null

Events associated with this transaction.

Records.externalPaypointID

string | null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.

Records.FeeAmount

number

Service fee or sub-charge applied.

Records.Gateway

string | null

Gateway used to process the transaction.

Records.IdOut

integer

Identifier of payout transaction.

Records.LastUpdated

string | null

Timestamp when payment record was updated.

Records.NetAmount

number | null

Net amount paid.

Records.ParentOrgName

string | null

The name of the parent organization.

Records.PaymentData

object

Records.PaymentData.AccountExp

string | null

Expiration date of card used in transaction.

Records.PaymentData.accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

Records.PaymentData.AccountType

string | null

Bank account type or card brand.

Records.PaymentData.AccountZip

string | null

ZIP code for card used in transaction.

Records.PaymentData.bankAccount

string | null

Records.PaymentData.cloudSignatureData

string | null

Records.PaymentData.cloudSignatureFormat

string | null

Records.PaymentData.HolderName

string | null

Card or bank account holder name.

Records.PaymentData.MaskedAccount

string | null

Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).

Records.PaymentData.orderDescription

string | null

Text description of the transaction.

Maximum length: 250

Records.PaymentData.paymentDetails

object

Details about the payment.

Records.PaymentData.paymentDetails.totalAmount

number

required

Total amount to be charged. If a service fee is sent, then this amount should include the service fee."

Records.PaymentData.paymentDetails.categories

object[] | null

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.

Records.PaymentData.paymentDetails.checkImage

object | null

Object containing image of paper check.

Records.PaymentData.paymentDetails.checkNumber

string | null

A check number to be used in the ach transaction. Required for payment method = 'check'.

Records.PaymentData.paymentDetails.currency

string | null

Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.

Records.PaymentData.paymentDetails.serviceFee

number | null

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.

Records.PaymentData.paymentDetails.splitFunding

object[] | null

Split funding instructions for the transaction. See Split a Transaction for more.

Records.PaymentData.payorData

string | null

Records.PaymentData.StoredId

string | null

Identifier of stored payment method used in transaction.

Records.PaymentId

string | null

Unique transaction ID.

Records.PaymentMethod

string | null

The payment method for the transaction.

Records.PaymentStatus

string | null

Status of payout transaction. See Payout Transaction Statuses for a full reference.

Records.PaypointDbaname

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Records.PaypointLegalname

string | null

Paypoint legal name.

Records.Source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Records.Status

integer

Internal status of transaction.

Records.TotalAmount

number

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

Records.Vendor

object

Vendor related to the payout transaction.

Records.Vendor.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. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Records.Vendor.address1

string | null

Vendor's address.

Records.Vendor.address2

string | null

Additional line for vendor's address.

Records.Vendor.billingData

object

Records.Vendor.city

string | null

Vendor's city.

Records.Vendor.contacts

object[] | null

List of contacts.

Records.Vendor.country

string | null

Vendor's country.

Records.Vendor.createdDate

string

Timestamp of when record was created, in UTC.

Records.Vendor.customerVendorAccount

string | null

Account number of paypoint in the vendor system.

Records.Vendor.ein

string | null

Business EIN or tax ID.

Records.Vendor.email

string | null

Vendor's email address.

Records.Vendor.enrollmentStatus

string | null

Enrollment status of vendor in payables program.

Records.Vendor.externalPaypointId

string | null

Records.Vendor.internalReferenceId

integer | null

Internal identifier for global vendor account.

Records.Vendor.lastUpdated

string | null

Timestamp of when record was last updated, in UTC.

Records.Vendor.locationCode

string | null

Additional location code used to identify the vendor.

Records.Vendor.mcc

string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

Records.Vendor.name1

string | null

Primary name for vendor.

Records.Vendor.name2

string | null

Secondary name for vendor.

Records.Vendor.parentOrgName

string | null

The name of the parent organization.

Records.Vendor.payeeName1

string | null

Alternative name used to receive paper check.

Records.Vendor.payeeName2

string | null

Alternative name used to receive paper check.

Records.Vendor.paymentMethod

object

Object containing details about the payment method to use for the payout.

Records.Vendor.paypointDbaname

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Records.Vendor.paypointEntryname

string | null

The entrypoint identifier.

Maximum length: 50

Records.Vendor.paypointLegalname

string | null

Business legal name.

Records.Vendor.phone

string | null

Vendor's phone number.

Records.Vendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Records.Vendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Records.Vendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Records.Vendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Records.Vendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

Records.Vendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Records.Vendor.state

string | null

Vendor's state.

Records.Vendor.summary

object

Records.Vendor.vendorId

integer | null

Payabli identifier for vendor record.

Records.Vendor.vendorNumber

string | null

Custom number identifying the vendor. Must be unique in paypoint.

Records.Vendor.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Records.Vendor.zip

string | null

Vendor's zip code.

Summary

object

Was this page helpful?

List MoneyOut Transactions for Paypoint List Items for Paypoint

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Get List of MoneyOut Transactions for Organization

Authorizations

Path Parameters

Query Parameters

Response