Get List of Settled Transactions for Paypoint

GET

Query

settlements

{entry}

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

entry

string

required

The paypoint's entrypoint identifier. Learn more

Query Parameters

parameters

object

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:

settlementDate (gt, ge, lt, le, eq, ne)
depositDate (gt, ge, lt, le, eq, ne)
transId (ne, eq, ct, nct)
gatewayTransId (ne, eq, ct, nct)
method (in, nin, eq, ne)
settledAmount (gt, ge, lt, le, eq, ne)
operation (in, nin, eq, ne)
source (in, nin, eq, ne)
batchNumber (ct, nct, eq, ne)
payaccountLastfour (nct, ct)
payaccountType (ne, eq, in, nin)
customerFirstname (ct, nct, eq, ne)
customerLastname (ct, nct, eq, ne)
customerName (ct, nct)
customerId (eq, ne)
customerNumber (ct, nct, eq, ne)
customerCompanyname (ct, nct, eq, ne)
customerAddress (ct, nct, eq, ne)
customerCity (ct, nct, eq, ne)
customerZip (ct, nct, eq, ne)
customerState (ct, nct, eq, ne)
customerCountry (ct, nct, eq, ne)
customerPhone (ct, nct, eq, ne)
customerEmail (ct, nct, eq, ne)
customerShippingAddress (ct, nct, eq, ne)
customerShippingCity (ct, nct, eq, ne)
customerShippingZip (ct, nct, eq, ne)
customerShippingState (ct, nct, eq, ne)
customerShippingCountry (ct, nct, eq, ne)
orgId (eq) mandatory when entry=org
isHold (eq, ne)
paypointId (ne, eq)
paypointLegal (ne, eq, ct, nct)
paypointDba (ne, eq, ct, nct)
orgName (ne, eq, ct, nct)
batchId (ct, nct, eq, neq)
additional-xxx (ne, eq, ct, nct) where xxx is the additional field name

List of comparison accepted:

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

Example: settledAmount(gt)=20 return all records with settledAmount greater than 20.00

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

Describes the response for settlement queries.

Records

object[] | null

Records.BatchAmount

number | null

The batch amount.

Records.BatchNumber

string | null

The batch number.

Records.Category

string

A field used internally by Payabli to categorize the transaction details. Values are:

auth: Any payment
refund: ACH return or Refund
adj: Adjustments
cb: Chargeback
split: Split amount

Records.CreatedAt

string

Timestamp of when record was created, in UTC.

Records.Customer

object

Records.Customer.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.Customer.BillingAddress1

string | null

Customer's billing address.

Records.Customer.BillingAddress2

string | null

Additional line for Customer's billing address.

Records.Customer.BillingCity

string | null

Customer's billing city.

Records.Customer.BillingCountry

string | null

Customer's billing country.

Records.Customer.BillingEmail

string | null

Customer's email address.

Records.Customer.BillingPhone

string | null

Customer's phone number.

Records.Customer.BillingState

string | null

Customer's billing state. Must be 2-letter state code for address in US.

Records.Customer.BillingZip

string | null

Customer's billing ZIP code.

Records.Customer.CompanyName

string | null

Customer's company name.

Records.Customer.CreatedAt

string

Timestamp of when record was created, in UTC.

Records.Customer.customerId

integer | null

The Payabli-generated unique ID for the customer.

Records.Customer.CustomerId

integer | null

The Payabli-generated unique ID for the customer.

Records.Customer.CustomerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

Records.Customer.customerStatus

integer | null

Customer Status. Possible values:

-99 Deleted
0 Inactive
1 Active
85 Locked (typically due to multiple failed login attempts)

Records.Customer.FirstName

string | null

Customer/Payor first name.

Records.Customer.Identifiers

any[] | null

Array of field names to be used as identifiers.

Records.Customer.LastName

string | null

Customer/Payor last name.

Records.Customer.ShippingAddress1

string | null

The shipping address.

Maximum length: 250

Records.Customer.ShippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Records.Customer.ShippingCity

string | null

Shipping city.

Maximum length: 250

Records.Customer.ShippingCountry

string | null

Shipping address country.

Records.Customer.ShippingState

string | null

Shipping state or province.

Records.Customer.ShippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Records.DepositDate

string | null

The date the funds were deposited.

Records.ExpectedDepositDate

string

The date the funds are expected to be deposited.

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

string | null

Internal identifier used for processing.

Records.Id

integer

Records.invoiceData

object

Records.invoiceData.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.invoiceData.attachments

object | null

Array of fileContent objects with attached documents. Max upload size is 30 MB.

Records.invoiceData.company

string | null

Company name of the recipient of the invoice.

Records.invoiceData.discount

number | null

Discount applied to the invoice.

Records.invoiceData.dutyAmount

number | null

Duty amount.

Records.invoiceData.firstName

string | null

First name of the recipient of the invoice.

Records.invoiceData.freightAmount

number | null

Freight/shipping amount.

Records.invoiceData.frequency

enum<string> | null

Frequency of scheduled invoice.

Available options:

one-time,

weekly,

every2weeks,

every6months,

monthly,

every3months,

annually

Records.invoiceData.invoiceAmount

number | null

Invoice total amount.

Records.invoiceData.invoiceDate

string | null

Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Records.invoiceData.invoiceDueDate

string | null

Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Records.invoiceData.invoiceEndDate

string | null

Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Records.invoiceData.invoiceNumber

string | null

Invoice number. Identifies the invoice under a paypoint.

Maximum length: 250

Records.invoiceData.invoiceStatus

enum<integer> | null

Status for invoice.

The accepted status values are:

0 draft
1 active
2 partially paid
4 paid/complete
99 cancelled

Available options:

0,

1,

2,

4,

99

Records.invoiceData.invoiceType

integer | null

Type of invoice. Only 0 for one-time invoices is currently supported.

Records.invoiceData.items

object[] | null

Array of line items included in the invoice.

Records.invoiceData.lastName

string | null

Last name of the recipient of the invoice.

Records.invoiceData.notes

string | null

Notes included in the invoice.

Records.invoiceData.paymentTerms

enum<string> | null

Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.

Available options:

PIA,

CIA,

UR,

NET10,

NET20,

NET30,

NET45,

NET60,

NET90,

EOM,

MFI,

5MFI,

10MFI,

15MFI,

20MFI,

2/10NET30,

UF,

10UF,

20UF,

25UF,

50UF

Records.invoiceData.purchaseOrder

string | null

Purchase order number.

Records.invoiceData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

Records.invoiceData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Records.invoiceData.shippingCity

string | null

Shipping city.

Maximum length: 250

Records.invoiceData.shippingCountry

string | null

Shipping address country.

Records.invoiceData.shippingEmail

string | null

Shipping recipient's contact email address.

Records.invoiceData.shippingFromZip

string | null

Sender shipping ZIP code.

Records.invoiceData.shippingPhone

string | null

Recipient phone number.

Records.invoiceData.shippingState

string | null

Shipping state or province.

Records.invoiceData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Records.invoiceData.summaryCommodityCode

string | null

Commodity code.

Records.invoiceData.tax

number | null

Tax rate in percent applied to the invoice.

Records.invoiceData.termsConditions

string | null

Custom terms and conditions included in the invoice.

Records.isHold

integer

Describes whether the transaction is being held or not.

1 - Transaction is held

0 - Transaction is not being held

Records.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.Method

string

The payment method.

Records.NetAmount

number | null

Net amount paid.

Records.Operation

string | null

The operation performed.

Records.OrderId

string | null

Custom identifier for the transaction.

Maximum length: 250

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.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 be related to the DPAN (device primary account number), not the card connected to Apple Pay.

Records.PaymentData.HolderName

string | null

Account holder name for the method.

Records.PaymentData.Initiator

string | null

default:

merchant

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 transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

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

string | null

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.

Records.PaymentData.SignatureData

string | null

Records.PaymentData.StoredId

string | null

Identifier of stored payment method used in transaction.

Records.PaymentData.StoredMethodUsageType

string | null

default:

unscheduled

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.

Records.PaymentTransId

string | null

The transaction ID for the payment.

Records.PaymentTransStatus

integer

Status of transaction. See the docs for a full reference.

Records.PaypointDbaname

string | null

Paypoint DBA name.

Records.PaypointEntryname

string | null

Paypoint entryname.

Records.PaypointLegalname

string | null

Paypoint legal name.

Records.ResponseData

object

The transaction's response data.

Records.ScheduleReference

integer

Reference to the subscription originating the transaction.

Records.SettledAmount

number

The transaction amount.

Records.SettlementDate

string

Records.Source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Records.Status

integer

Settlement status for transaction. See the docs for a full reference.

Records.TransactionEvents

object[] | null

Events associated with this transaction.

Records.TransactionTime

string

Timestamp when transaction was submitted, in UTC.

Records.TransMethod

string | null

Payment method used: card or ach.

Records.Type

string

The transaction type: credit or debit.

Summary

object | null

Was this page helpful?

List Subscriptions for Org List Settled Transactions for Org

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Get List of Settled Transactions for Paypoint

Authorizations

Path Parameters

Query Parameters

Response