openapi: 3.0.1
info:
title: Payabli API
version: ''
description: >-
## Payabli API
The Payabli API is a RESTful API that enables you to build robust payment
solutions on the Payabli platform. Process card and ACH transactions, manage
entities like vendors and customers, handle subscriptions and recurring
billing, tokenize payment methods securely, and send payouts.
The API provides comprehensive endpoints for accepting payments, making
payouts to vendors, and managing merchant operations. Use our sandbox
environment to build and test your integration, then seamlessly move to
production.
The API includes built-in security features like idempotency keys to prevent
duplicate transactions, rate limits for optimal performance, and multiple
authentication token types for different use cases. Available in both
sandbox and production environments with complete support for webhooks,
fraud controls, and real-time transaction processing.
See the [API
overview](https://docs.payabli.com/developers/api-reference/api-overview)
for information on authentication, error handling, idempotency, rate limits,
and more.
See our full collection of [developer
tools](https://docs.payabli.com/developers/developer-guides/tools-overview)
for SDKs, our MCP server, Postman collection information, and example apps
to help you get started quickly.
paths:
/Bill/single/{entry}:
post:
description: Creates a bill in an entrypoint.
operationId: bill_AddBill
tags:
- Bill
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add bill
security: &ref_0
- APIKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillOutData'
/Bill/attachedFileFromBill/{idBill}/{filename}:
delete:
description: Delete a file attached to a bill.
operationId: bill_deleteAttachedFromBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
- name: filename
in: path
description: |-
The filename in Payabli. Filename is `zipName` in response to a
request to `/api/Invoice/{idInvoice}`. Here, the filename is
`0_Bill.pdf`.
```json
"DocumentsRef": {
"zipfile": "inva_269.zip",
"filelist": [
{
"originalName": "Bill.pdf",
"zipName": "0_Bill.pdf",
"descriptor": null
}
]
}
```
required: true
schema:
type: string
- name: returnObject
in: query
description: >-
When `true`, the request returns the file content as a
Base64-encoded string.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete attached file from bill
security: *ref_0
get:
description: >-
Retrieves a file attached to a bill, either as a binary file or as a
Base64-encoded string.
operationId: bill_getAttachedFromBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
- name: filename
in: path
description: >-
The filename in Payabli. Filename is `zipName` in response to a
request to `/api/Invoice/{idInvoice}`. Here, the filename is
`0_Bill.pdf``.
"DocumentsRef": {
"zipfile": "inva_269.zip",
"filelist": [
{
"originalName": "Bill.pdf",
"zipName": "0_Bill.pdf",
"descriptor": null
}
]
}
required: true
schema:
type: string
- name: returnObject
in: query
description: >-
When `true`, the request returns the file content as a
Base64-encoded string.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: >-
A successful response returns a binary file when `returnObject` is
`false`. When `returnObject` is `true`, the response contains the
file content as a Base64-encoded string in an object. Due to
technical limitations, only the object response is documented here.
content:
application/json:
schema:
$ref: '#/components/schemas/FileContent'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get attached file from bill
security: *ref_0
/Bill/{idBill}:
delete:
description: Deletes a bill by ID.
operationId: bill_DeleteBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete bill
security: *ref_0
put:
description: Updates a bill by ID.
operationId: bill_EditBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EditBillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update bill
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillOutData'
get:
description: Retrieves a bill by ID from an entrypoint.
operationId: bill_GetBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetBillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get bill
security: *ref_0
/Query/bills/{entry}:
get:
description: >-
Retrieve a list of bills for an entrypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: bill_ListBills
tags:
- Bill
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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 isn't 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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `frequency` (`in`, `nin`, `ne`, `eq`)
- `method` (`in`, `nin`, `eq`, `ne`)
- `event` (`in`, `nin`, `eq`, `ne`)
- `target` (`ct`, `nct`, `eq`, `ne`)
- `status` (`eq`, `ne`)
- `approvalUserId` (`eq`, `ne`)
- `parentOrgId` (`ne`, `eq`, `nin`, `in`)
- `approvalUserEmail` (`eq`, `ne`)
- `scheduleId` (`ne`, `eq`)
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
- `nin` => not inside array
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: `totalAmount(gt)=20` returns all records with a
`totalAmount` that's greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BillQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of bills for entrypoint
security: *ref_0
/Query/bills/org/{orgId}:
get:
description: >-
Retrieve a list of bills for an organization. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: bill_ListBillsOrg
tags:
- Bill
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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 isn't 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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `frequency` (in, nin, ne, eq)
- `method` (in, nin, eq, ne)
- `event` (in, nin, eq, ne)
- `target` (ct, nct, eq, ne)
- `status` (eq, ne)
- `parentOrgId` (ne, eq, nin, in)
- `approvalUserId` (eq, ne)
- `approvalUserEmail` (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
- nin => not inside array
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: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BillQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of bills for organization
security: *ref_0
/Bill/approval/{idBill}:
put:
description: Modify the list of users the bill is sent to for approval.
operationId: bill_ModifyApprovalBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyApprovalBillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Change bill approvers
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: string
post:
description: Send a bill to a user or list of users to approve.
operationId: bill_SendToApprovalBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
- name: autocreateUser
in: query
description: >-
Automatically create the target user for approval if they don't
exist.
required: false
schema:
type: boolean
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Send a bill to approval
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: string
/Bill/approval/{idBill}/{approved}:
get:
description: Approve or disapprove a bill by ID.
operationId: bill_SetApprovedBill
tags:
- Bill
parameters:
- name: idBill
in: path
description: >-
Payabli ID for the bill. Get this ID by querying `/api/Query/bills/`
for the entrypoint or the organization.
required: true
schema:
type: integer
- name: approved
in: path
description: >-
String representing the approved status. Accepted values: 'true' or
'false'.
required: true
schema:
type: string
- name: email
in: query
description: Email or username of user modifying approval status.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SetApprovedBillResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Approve or disapprove a bill
security: *ref_0
/Boarding/app:
post:
description: >-
Creates a boarding application in an organization. This endpoint
requires an application API token.
operationId: boarding_AddApplication
tags:
- Boarding
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Create boarding application
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddApplicationRequest'
/Boarding/app/{appId}:
delete:
description: Deletes a boarding application by ID.
operationId: boarding_DeleteApplication
tags:
- Boarding
parameters:
- name: appId
in: path
description: 'Boarding application ID. '
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete boarding application
security: *ref_0
put:
description: >-
Updates a boarding application by ID. This endpoint requires an
application API token.
operationId: boarding_UpdateApplication
tags:
- Boarding
parameters:
- name: appId
in: path
description: 'Boarding application ID. '
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update boarding application
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationData'
/Boarding/read/{appId}:
get:
description: 'Retrieves the details for a boarding application by ID. '
operationId: boarding_GetApplication
tags:
- Boarding
parameters:
- name: appId
in: path
description: Boarding application ID.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDetailsRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get boarding application by ID
security: *ref_0
/Boarding/read/{xId}:
post:
description: >-
Gets a boarding application by authentication information. This endpoint
requires an `application` API token.
operationId: boarding_GetApplicationByAuth
tags:
- Boarding
parameters:
- name: xId
in: path
description: >-
The application ID in Hex format. Find this at the end of the
boarding link URL returned in a call to
api/Boarding/applink/{appId}/{mail2}. For example in:
`https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E`,
the xId is `17E`.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get boarding application by auth
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
$ref: '#/components/schemas/Email'
nullable: true
description: >-
The email address the applicant used to save the
application.
referenceId:
type: string
nullable: true
description: >-
The referenceId is sent to the applicant via email when they
save the application.
/Boarding/linkbyId/{boardingLinkId}:
get:
description: 'Retrieves details for a boarding link, by ID. '
operationId: boarding_GetByIdLinkApplication
tags:
- Boarding
parameters:
- name: boardingLinkId
in: path
description: >-
The boarding link ID. You can find this at the end of the boarding
link reference name. For example
`https://boarding.payabli.com/boarding/app/myorgaccountname-00091`.
The ID is `91`.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BoardingLinkQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get boarding link by ID
security: *ref_0
/Boarding/linkbyTemplate/{templateId}:
get:
description: >-
Get details for a boarding link using the boarding template ID. This
endpoint requires an application API token.
operationId: boarding_GetByTemplateIdLinkApplication
tags:
- Boarding
parameters:
- name: templateId
in: path
description: >-
The boarding template ID. You can find this at the end of the
boarding template URL in PartnerHub. Example:
`https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`.
Here, the template ID is `80`.
required: true
schema:
type: number
format: double
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BoardingLinkQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get boarding link by template ID
security: *ref_0
/Boarding/applink/{appId}/{mail2}:
put:
description: >-
Retrieves a link and the verification code used to log into an existing
boarding application. You can also use this endpoint to send a link and
referenceId for an existing boarding application to an email address.
The recipient can use the referenceId and email address to access and
edit the application.
operationId: boarding_getExternalApplication
tags:
- Boarding
parameters:
- name: appId
in: path
description: 'Boarding application ID. '
required: true
schema:
type: integer
- name: mail2
in: path
description: >-
Email address used to access the application. If `sendEmail`
parameter is true, a link to the application is sent to this email
address.
required: true
schema:
type: string
- name: sendEmail
in: query
description: >-
If `true`, sends an email that includes the link to the application
to the `mail2` address. Defaults to `false`.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get link or email a link for a boarding application
security: *ref_0
/Boarding/link/{boardingLinkReference}:
get:
description: >-
Retrieves the details for a boarding link, by reference name. This
endpoint requires an application API token.
operationId: boarding_GetLinkApplication
tags:
- Boarding
parameters:
- name: boardingLinkReference
in: path
description: >-
The boarding link reference name. You can find this at the end of
the boarding link URL. For example
`https://boarding.payabli.com/boarding/app/myorgaccountname-00091`
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BoardingLinkQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get boarding Link by reference
security: *ref_0
/Query/boarding/{orgId}:
get:
description: >-
Returns a list of boarding applications for an organization. Use filters
to limit results. Include the `exportFormat` query parameter to return
the results as a file instead of a JSON response.
operationId: boarding_ListApplications
tags:
- Boarding
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `createdAt` (gt, ge, lt, le, eq, ne)
- `startDate` (gt, ge, lt, le, eq, ne)
- `dbaname` (ct, nct)
- `legalname` (ct, nct)
- `ein` (ct, nct)
- `address` (ct, nct)
- `city` (ct, nct)
- `state` (ct, nct)
- `phone` (ct, nct)
- `mcc` (ct, nct)
- `owntype` (ct, nct)
- `ownerName` (ct, nct)
- `contactName` (ct, nct)
- `status` (in, nin, eq,ne)
- `orgParentname` (ct, nct)
- `externalpaypointID` (ct, nct, eq, ne)
- `repCode` (ct, nct, eq, ne)
- `repName` (ct, nct, eq, ne)
- `repOffice` (ct, nct, 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
- nin => not inside array
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBoardingAppsListResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of applications for an organization
security: *ref_0
/Query/boardinglinks/{orgId}:
get:
description: >-
Return a list of boarding links for an organization. Use filters to
limit results.
operationId: boarding_ListBoardingLinks
tags:
- Boarding
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `lastUpdated` (gt, ge, lt, le, eq, ne)
- `templateName` (ct, nct)
- `referenceName` (ct, nct)
- `acceptRegister` (eq, ne)
- `acceptAuth` (eq, ne)
- `templateCode` (ct, nct)
- `templateId` (eq, ne)
- `orgParentname` (ct, nct)
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
- nin => not inside array
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: templateName(ct)=hoa return all records with template title
containing "hoa"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBoardingLinksResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of boarding links for organization
security: *ref_0
/ChargeBacks/response/{Id}:
post:
description: Add a response to a chargeback or ACH return.
operationId: chargeBacks_AddResponse
tags:
- ChargeBacks
parameters:
- name: Id
in: path
description: ID of the chargeback or return record.
required: true
schema:
type: integer
format: int64
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddResponseResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add response to chargeback or return
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
description: Array of attached files to response.
contactEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: Email of response submitter.
contactName:
type: string
nullable: true
description: Name of response submitter
notes:
type: string
nullable: true
description: Response notes
/ChargeBacks/read/{Id}:
get:
description: Retrieves a chargeback record and its details.
operationId: chargeBacks_GetChargeback
tags:
- ChargeBacks
parameters:
- name: Id
in: path
description: >-
ID of the chargeback or return record. This is returned as
`chargebackId` in the
[RecievedChargeback](/developers/developer-guides/webhook-payloads#receivedChargeback)
and
[ReceivedAchReturn](/developers/developer-guides/webhook-payloads#receivedachreturn)
webhook notifications.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ChargebackQueryRecords'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get chargeback or ACH return record
security: *ref_0
/ChargeBacks/getChargebackAttachments/{Id}/{fileName}:
get:
description: Retrieves a chargeback attachment file by its file name.
operationId: chargeBacks_getChargebackAttachment
tags:
- ChargeBacks
parameters:
- name: Id
in: path
description: The ID of chargeback or return record.
required: true
schema:
type: integer
format: int64
- name: fileName
in: path
description: The chargeback attachment's file name.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
text/plain:
schema:
type: string
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get ChargeBack attachment by fileName
security: *ref_0
/CheckCapture/CheckProcessing:
post:
description: >-
Captures a check for Remote Deposit Capture (RDC) using the provided
check images and details. This endpoint handles the OCR extraction of
check data including MICR, routing number, account number, and amount.
See the [RDC guide](/developers/developer-guides/pay-in-rdc) for more
details.
operationId: checkCapture_CheckProcessing
tags:
- CheckCapture
parameters: []
responses:
'200':
description: Success response with check processing results.
content:
application/json:
schema:
$ref: '#/components/schemas/CheckCaptureResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Process Check Capture
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
entryPoint:
$ref: '#/components/schemas/Entry'
frontImage:
type: string
description: >-
Base64-encoded front check image. Must be JPEG or PNG format
and less than 1MB. Image must show the entire check clearly
with no partial, blurry, or illegible portions.
rearImage:
type: string
description: >-
Base64-encoded rear check image. Must be JPEG or PNG format
and less than 1MB. Image must show the entire check clearly
with no partial, blurry, or illegible portions.
checkAmount:
type: integer
description: Check amount in cents (maximum 32-bit integer value).
required:
- entryPoint
- frontImage
- rearImage
- checkAmount
/Cloud/register/{entry}:
post:
description: >-
Register a cloud device to an entrypoint. See [Devices
Quickstart](/developers/developer-guides/devices-quickstart#devices-quickstart)
for a complete guide.
operationId: cloud_addDevice
tags:
- Cloud
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddDeviceResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Register cloud device
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: string
nullable: true
description: >-
Description or name for the device. This can be anything,
but Payabli recommends entering the name of the paypoint, or
some other easy to identify descriptor. If you have several
devices for one paypoint, you can give them descriptions
like "Cashier 1" and "Cashier 2", or "Front Desk" and "Back
Office"
registrationCode:
type: string
nullable: true
description: >-
The device registration code or serial number, depending on
the model.
- Ingenico devices: This is the activation code that's
displayed on the device screen during setup.
- PAX A920 device: This code is the serial number on the
back of the device.
/Cloud/history/{entry}/{deviceId}:
get:
description: 'Retrieve the registration history for a device. '
operationId: cloud_HistoryDevice
tags:
- Cloud
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: deviceId
in: path
description: 'ID of the cloud device. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CloudQueryApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get registration history for device
security: *ref_0
/Cloud/list/{entry}:
get:
description: Get a list of cloud devices registered to an entrypoint.
operationId: cloud_ListDevice
tags:
- Cloud
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: forceRefresh
in: query
description: >-
When `true`, the request retrieves an updated list of devices from
the processor instead of returning a cached list of devices.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CloudQueryApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: List registered devices in cloud
security: *ref_0
/Cloud/register/{entry}/{deviceId}:
delete:
description: Remove a cloud device from an entrypoint.
operationId: cloud_RemoveDevice
tags:
- Cloud
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: deviceId
in: path
description: 'ID of the cloud device. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveDeviceResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Unregister cloud device
security: *ref_0
/Customer/single/{entry}:
post:
description: >-
Creates a customer in an entrypoint. An identifier is required to create
customer records. Change your identifier settings in Settings > Custom
Fields in PartnerHub.
If you don't include an identifier, the record is rejected.
operationId: customer_AddCustomer
tags:
- Customer
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entrypointfield'
- name: forceCustomerCreation
in: query
description: >-
When `true`, the request creates a new customer record, regardless
of whether customer identifiers match an existing customer.
required: false
schema:
type: boolean
nullable: true
- name: replaceExisting
in: query
description: >-
Flag indicating to replace existing customer with a new record.
Possible values: 0 (don't replace), 1 (replace). Default is `0`.
required: false
schema:
type: integer
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseCustomerQuery'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add customer
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerData'
/Customer/{customerId}:
delete:
description: Delete a customer record.
operationId: customer_DeleteCustomer
tags:
- Customer
parameters:
- name: customerId
in: path
description: >-
Payabli-generated customer ID. Maps to "Customer ID" column in
PartnerHub.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete customer record
security: *ref_0
get:
description: Retrieves a customer's record and details.
operationId: customer_GetCustomer
tags:
- Customer
parameters:
- name: customerId
in: path
description: >-
Payabli-generated customer ID. Maps to "Customer ID" column in
PartnerHub.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerQueryRecords'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get customer record.
security: *ref_0
put:
description: Update a customer record. Include only the fields you want to change.
operationId: customer_UpdateCustomer
tags:
- Customer
parameters:
- name: customerId
in: path
description: >-
Payabli-generated customer ID. Maps to "Customer ID" column in
PartnerHub.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update customer record
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerData'
/Customer/link/{customerId}/{transId}:
get:
description: Links a customer to a transaction by ID.
operationId: customer_LinkCustomerTransaction
tags:
- Customer
parameters:
- name: customerId
in: path
description: >-
Payabli-generated customer ID. Maps to "Customer ID" column in
PartnerHub.
required: true
schema:
type: integer
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Link Customer to Transaction
security: *ref_0
/Customer/{customerId}/consent:
post:
description: >-
Sends the consent opt-in email to the customer email address in the
customer record.
operationId: customer_RequestConsent
tags:
- Customer
parameters:
- name: customerId
in: path
description: >-
Payabli-generated customer ID. Maps to "Customer ID" column in
PartnerHub.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Request consent opt-in
security: *ref_0
/Export/boarding/{format}/{orgId}:
get:
description: >-
Export a list of boarding applications for an organization. Use filters
to limit results.
operationId: export_ExportApplications
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `createdAt` (gt, ge, lt, le, eq, ne)
- `startDate` (gt, ge, lt, le, eq, ne)
- `dbaname` (ct, nct)
- `legalname` (ct, nct)
- `ein` (ct, nct)
- `address` (ct, nct)
- `city` (ct, nct)
- `state` (ct, nct)
- `phone` (ct, nct)
- `mcc` (ct, nct)
- `owntype` (ct, nct)
- `ownerName` (ct, nct)
- `contactName` (ct, nct)
- `status` (eq, ne)
- `orgParentname` (ct, nct)
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
- nin => not inside array
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: `dbaname(ct)=hoa` returns all records with a `dbaname`
containing "hoa"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of boarding applications for organization
security: *ref_0
/Export/batchDetails/{format}/{entry}:
get:
description: >-
This endpoint is deprecated. Export batch details for a paypoint. Use
filters to limit results.
operationId: export_ExportBatchDetails
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**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 parameters accepted:
- limitRecord: max number of records for query (default="20", "0" or
negative value for all)
- fromRecord: initial record in query
Example: `amount(gt)=20` return all records with amount greater than
20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export batch details for a paypoint
security: *ref_0
/Export/batchDetails/{format}/org/{orgId}:
get:
description: >-
This endpoint is deprecated. Export batch details for an organization.
Use filters to limit results.
operationId: export_ExportBatchDetailsOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**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 parameters accepted:
- limitRecord: max number of records for query (default="20", "0" or
negative value for all)
- fromRecord: initial record in query
Example: `amount(gt)=20` return all records with amount greater than
20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export batch details for an org
security: *ref_0
/Export/batches/{format}/{entry}:
get:
description: >-
Export a list of batches for an entrypoint. Use filters to limit
results.
operationId: export_ExportBatches
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `connectorName` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `feeBatchAmount` (gt, ge, lt, le, eq, ne)
- `netBatchAmount` (gt, ge, lt, le, eq, ne)
- `releaseAmount` (gt, ge, lt, le, eq, ne)
- `heldAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
- `expectedDepositDate` (gt, ge, lt, le, eq, ne)
- `batchRecords` (gt, ge, lt, le, eq, ne)
- `transferId` (ne, eq)
- `transferDate` (gt, ge, lt, le, eq, ne)
- `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)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
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: `batchAmount(gt)=20` returns all records with a
`batchAmount` greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of batches for entrypoint
security: *ref_0
/Export/batches/{format}/org/{orgId}:
get:
description: >-
Export a list of batches for an organization. Use filters to limit
results.
operationId: export_ExportBatchesOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `connectorName` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `feeBatchAmount` (gt, ge, lt, le, eq, ne)
- `netBatchAmount` (gt, ge, lt, le, eq, ne)
- `releaseAmount` (gt, ge, lt, le, eq, ne)
- `heldAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
- `expectedDepositDate` (gt, ge, lt, le, eq, ne)
- `batchRecords` (gt, ge, lt, le, eq, ne)
- `transferId` (ne, eq)
- `transferDate` (gt, ge, lt, le, eq, ne)
- `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)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
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: `batchAmount(gt)=20` returns all records with a
`batchAmount` greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of batches for organization
security: *ref_0
/Export/batchesOut/{format}/{entry}:
get:
description: >-
Export a list of money out batches for a paypoint. Use filters to limit
results.
operationId: export_ExportBatchesOut
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct, nin, in)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
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: `batchAmount(gt)=20` returns all records with a
`batchAmount` greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of pay out batches for entrypoint
security: *ref_0
/Export/batchesOut/{format}/org/{orgId}:
get:
description: >-
Export a list of money out batches for an organization. Use filters to
limit results.
operationId: export_ExportBatchesOutOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct, nin, in)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
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: `batchAmount(gt)=20` returns all records with a
`batchAmount` greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of pay out batches for organization
security: *ref_0
/Export/bills/{format}/{entry}:
get:
description: Export a list of bills for an entrypoint. Use filters to limit results.
operationId: export_ExportBills
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `status` (in, nin, eq, ne)
- `billNumber` (ct, nct, eq, ne)
- `billDate` (gt, ge, lt, le, eq, ne)
- `billDueDate` (gt, ge, lt, le, eq, ne)
- `vendorNumber` (ct, nct, eq, ne)
- `vendorName` (ct, nct, eq, ne)
- `ein` (ct, nct, eq, ne)
- `paymentMethod` (ct, nct, eq, ne)
- `paymentId` (ct, nct, eq, ne)
- `paymentgroup` (ct, nct, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
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
Example: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of bills for an entrypoint
security: *ref_0
/Export/bills/{format}/org/{orgId}:
get:
description: >-
Export a list of bills for an organization. Use filters to limit
results.
operationId: export_ExportBillsOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `status` (in, nin, eq, ne)
- `billNumber` (ct, nct, eq, ne)
- `billDate` (gt, ge, lt, le, eq, ne)
- `billDueDate` (gt, ge, lt, le, eq, ne)
- `vendorNumber` (ct, nct, eq, ne)
- `vendorName` (ct, nct, eq, ne)
- `ein` (ct, nct, eq, ne)
- `paymentMethod` (ct, nct, eq, ne)
- `paymentId` (ct, nct, eq, ne)
- `paymentgroup` (ct, nct, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
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
Example: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of bills for organization
security: *ref_0
/Export/chargebacks/{format}/{entry}:
get:
description: >-
Export a list of chargebacks and ACH returns for an entrypoint. Use
filters to limit results.
operationId: export_ExportChargebacks
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `chargebackDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `reasonCode` (in, nin, eq, ne)
- `reason` (ct, nct, eq, ne)
- `caseNumber` (ct, nct, eq, ne)
- `status` (in, nin, eq, ne)
- `accountType` (in, nin, 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*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of chargebacks and returned transactions for entrypoint
security: *ref_0
/Export/chargebacks/{format}/org/{orgId}:
get:
description: >-
Export a list of chargebacks and ACH returns for an organization. Use
filters to limit results.
operationId: export_ExportChargebacksOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `chargebackDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `reasonCode` (in, nin, eq, ne)
- `reason` (ct, nct, eq, ne)
- `caseNumber` (ct, nct, eq, ne)
- `status` (in, nin, eq, ne)
- `accountType` (in, nin, 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*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of chargebacks and returned transactions for an organization
security: *ref_0
/Export/customers/{format}/{entry}:
get:
description: >-
Export a list of customers for an entrypoint. Use filters to limit
results.
operationId: export_ExportCustomers
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**List of field names accepted:**
- `createdDate` (gt, ge, lt, le, eq, ne)
- `customernumber` (ne, eq, ct, nct)
- `firstname` (ne, eq, ct, nct)
- `lastname` (ne, eq, ct, nct)
- `name` (ct, nct)
- `address` (ne, eq, ct, nct)
- `city` (ne, eq, ct, nct)
- `country` (ne, eq, ct, nct)
- `zip` (ne, eq, ct, nct)
- `state` (ne, eq, ct, nct)
- `shippingaddress` (ne, eq, ct, nct)
- `shippingcity` (ne, eq, ct, nct)
- `shippingcountry` (ne, eq, ct, nct)
- `shippingzip` (ne, eq, ct, nct)
- `shippingstate` (ne, eq, ct, nct)
- `phone` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `company` (ne, eq, ct, nct)
- `username` (ne, eq, ct, nct)
- `balance` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
- `orgId` (eq) *mandatory when entry=org*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
**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
**Example:**
balance(gt)=20 return all records with balance greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of customers for entrypoint
security: *ref_0
/Export/customers/{format}/org/{orgId}:
get:
description: >-
Exports a list of customers for an organization. Use filters to limit
results.
operationId: export_ExportCustomersOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**List of field names accepted:**
- `createdDate` (gt, ge, lt, le, eq, ne)
- `customernumber` (ne, eq, ct, nct)
- `firstname` (ne, eq, ct, nct)
- `lastname` (ne, eq, ct, nct)
- `name` (ct, nct)
- `address` (ne, eq, ct, nct)
- `city` (ne, eq, ct, nct)
- `country` (ne, eq, ct, nct)
- `zip` (ne, eq, ct, nct)
- `state` (ne, eq, ct, nct)
- `shippingaddress` (ne, eq, ct, nct)
- `shippingcity` (ne, eq, ct, nct)
- `shippingcountry` (ne, eq, ct, nct)
- `shippingzip` (ne, eq, ct, nct)
- `shippingstate` (ne, eq, ct, nct)
- `phone` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `company` (ne, eq, ct, nct)
- `username` (ne, eq, ct, nct)
- `balance` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
- `orgId` (eq) *mandatory when entry=org*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
**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
**Example:**
balance(gt)=20 return all records with balance greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of customers for organization
security: *ref_0
/Export/invoices/{format}/{entry}:
get:
description: Export list of invoices for an entrypoint. Use filters to limit results.
operationId: export_ExportInvoices
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `invoiceDate` (gt, ge, lt, le, eq, ne)
- `dueDate` (gt, ge, lt, le, eq, ne)
- `sentDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin,ne, eq)
- `invoiceType` (eq, ne)
- `payTerms` (in, nin, eq, ne)
- `paypointId` (ne, eq)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paidAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `invoiceNumber` (ct, nct, eq, ne)
- `purchaseOrder` (ct, nct, eq, ne)
- `itemProductCode` (ct, nct)
- `itemDescription` (ct, nct)
- `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)
- `paylinkId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
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
- nin => not inside array
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: `totalAmount(gt)=20` returns all records with `totalAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of invoices for an entrypoint
security: *ref_0
/Export/invoices/{format}/org/{orgId}:
get:
description: >-
Export a list of invoices for an organization. Use filters to limit
results.
operationId: export_ExportInvoicesOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `invoiceDate` (gt, ge, lt, le, eq, ne)
- `dueDate` (gt, ge, lt, le, eq, ne)
- `sentDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin,ne, eq)
- `invoiceType` (eq, ne)
- `payTerms` (in, nin, eq, ne)
- `paypointId` (ne, eq)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paidAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `invoiceNumber` (ct, nct, eq, ne)
- `purchaseOrder` (ct, nct, eq, ne)
- `itemProductCode` (ct, nct)
- `itemDescription` (ct, nct)
- `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)
- `paylinkId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
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
- nin => not inside array
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: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of invoices for an organization
security: *ref_0
/Export/organizations/{format}/org/{orgId}:
get:
description: >-
Export a list of child organizations (suborganizations) for a parent
organization.
operationId: export_ExportOrganizations
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `name` (ct, nct, eq, ne)
- `type` (ne, eq)
- `contactName` (ct, nct, eq, ne)
- `contactTitle` (ct, nct, eq, ne)
- `contactEmail` (ct, nct, eq, ne)
- `contactPhone` (ct, nct, eq, ne)
- `city` (ct, nct, eq, ne)
- `state` (in, nin, eq, ne)
- `address` (ct, nct, eq, ne)
- `country` (ct, nct, eq, ne)
- `zip` (ct, nct, eq, ne)
- `hasBilling` any value greater than zero is taken as TRUE
otherwise is FALSE
- `hasResidual` any value greater than zero is taken as TRUE
otherwise is FALSE
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
- nin => not inside array
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: name(ct)=hoa return all records where name contains "hoa"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of child organization for a parent organization
security: *ref_0
/Export/payouts/{format}/{entry}:
get:
description: >-
Export a list of payouts and their statuses for an entrypoint. Use
filters to limit results.
operationId: export_ExportPayout
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
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)
- `paymentId` (ct, nct, eq, ne)
- `paymentgroup` (ct, nct, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
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
Example: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of payouts for an entrypoint
security: *ref_0
/Export/payouts/{format}/org/{orgId}:
get:
description: >-
Export a list of payouts and their details for an organization. Use
filters to limit results.
operationId: export_ExportPayoutOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
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)
- `paymentId` (ct, nct, eq, ne)
- `paymentgroup` (ct, nct, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
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
Example: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of payouts for organization
security: *ref_0
/Export/paypoints/{format}/{orgId}:
get:
description: >-
Export a list of paypoints in an organization. Use filters to limit
results.
operationId: export_ExportPaypoints
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `createdAt` (gt, ge, lt, le, eq, ne)
- `startDate` (gt, ge, lt, le, eq, ne)
- `dbaname` (ct, nct)
- `legalname` (ct, nct)
- `ein` (ct, nct)
- `address` (ct, nct)
- `city` (ct, nct)
- `state` (ct, nct)
- `phone` (ct, nct)
- `mcc` (ct, nct)
- `owntype` (ct, nct)
- `ownerName` (ct, nct)
- `contactName` (ct, nct)
- `orgParentname` (ct, nct)
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
- nin => not inside array
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: `dbaname(ct)=hoa` returns all records with `dbaname`
containing "hoa"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of paypoints in an organization
security: *ref_0
/Export/settlements/{format}/{entry}:
get:
description: >-
Export a list of settled transactions for an entrypoint. Use filters to
limit results.
operationId: export_ExportSettlements
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `settlementDate` (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*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
Example: `settledAmount(gt)=20` returns all records with a
`settledAmount` greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of settled transactions for entrypoint
security: *ref_0
/Export/settlements/{format}/org/{orgId}:
get:
description: >-
Export a list of settled transactions for an organization. Use filters
to limit results.
operationId: export_ExportSettlementsOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `settlementDate` (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*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
Example: `settledAmount(gt)=20` returns all records with a
`settledAmount` greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of settled transactions for organization
security: *ref_0
/Export/subscriptions/{format}/{entry}:
get:
description: >-
Export a list of subscriptions for an entrypoint. Use filters to limit
results.
operationId: export_ExportSubscriptions
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `startDate` (gt, ge, lt, le, eq, ne)
- `endDate` (gt, ge, lt, le, eq, ne)
- `nextDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin, ne, eq)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `untilcancelled` (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)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
- nin => not inside array
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: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of subscriptions for an entrypoint
security: *ref_0
/Export/subscriptions/{format}/org/{orgId}:
get:
description: >-
Export a list of subscriptions for an organization. Use filters to limit
results.
operationId: export_ExportSubscriptionsOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `startDate` (gt, ge, lt, le, eq, ne)
- `endDate` (gt, ge, lt, le, eq, ne)
- `nextDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin, ne, eq)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `untilcancelled` (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)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
- nin => not inside array
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: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of subscriptions for an organization
security: *ref_0
/Export/transactions/{format}/{entry}:
get:
description: >-
Export a list of transactions for an entrypoint in a file in XLXS or CSV
format. Use filters to limit results. If you don't specify a date range
in the request, the last two months of data are returned.
operationId: export_ExportTransactions
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `transactionDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct)
- `gatewayTransId` (ne, eq, ct, nct)
- `orderId` (ne, eq)
- `idTrans` (ne, eq)
- `orgId` (ne, eq)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `operation` (in, nin, eq, ne)
- `source` (in, nin, eq, ne)
- `status` (in, nin, eq, ne)
- `settlementStatus` (in, nin, eq, ne)
- `batchNumber` (nct, ct)
- `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)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
- nin => not inside array
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: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of transactions for entrypoint
security: *ref_0
/Export/transactions/{format}/org/{orgId}:
get:
description: >-
Export a list of transactions for an org in a file in XLSX or CSV
format. Use filters to limit results. If you don't specify a date range
in the request, the last two months of data are returned.
operationId: export_ExportTransactionsOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `transactionDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct)
- `gatewayTransId` (ne, eq, ct, nct)
- `orderId` (ne, eq)
- `idTrans` (ne, eq)
- `orgId` (ne, eq)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `operation` (in, nin, eq, ne)
- `source` (in, nin, eq, ne)
- `status` (in, nin, eq, ne)
- `settlementStatus` (in, nin, eq, ne)
- `batchNumber` (nct, ct)
- `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)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
- nin => not inside array
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: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of transactions for an org
security: *ref_0
/Export/transferDetails/{format}/{entry}/{transferId}:
get:
description: >-
Export a list of transfer details for an entrypoint. Use filters to
limit results.
operationId: export_ExportTransferDetails
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: transferId
in: path
description: Transfer identifier.
required: true
schema:
type: integer
format: int64
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
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)
- `transactionId` (eq, ne, in, nin)
- `category` (eq, ne, ct, nct)
- `type` (eq, ne, in, nin)
- `method` (eq, ne, in, nin)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of transfer details
security: *ref_0
/Export/transfers/{entry}:
get:
description: Get a list of transfers for an entrypoint. Use filters to limit results.
operationId: export_ExportTransfers
tags:
- Export
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `transferDate` (gt, ge, lt, le, eq, ne)
- `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)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
- `batchNumber` (ne, eq, ct, nct)
- `batchId` (ne, eq, in, nin)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export list of transfers for entrypoint
security: *ref_0
/Export/vendors/{format}/{entry}:
get:
description: >-
Export a list of vendors for an entrypoint. Use filters to limit
results.
operationId: export_ExportVendors
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `method` (in, nin, eq, ne)
- `enrollmentStatus` (in, nin, eq, ne)
- `status` (in, nin, eq, ne)
- `vendorNumber` (ct, nct, eq, ne)
- `name` (ct, nct, eq, ne)
- `ein` (ct, nct, eq, ne)
- `phone` (ct, nct, eq, ne)
- `email` (ct, nct, eq, ne)
- `address` (ct, nct, eq, ne)
- `city` (ct, nct, eq, ne)
- `state` (ct, nct, eq, ne)
- `country` (ct, nct, eq, ne)
- `zip` (ct, nct, eq, ne)
- `mcc` (ct, nct, eq, ne)
- `locationCode` (ct, nct, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export vendors for an entrypoint
security: *ref_0
/Export/vendors/{format}/org/{orgId}:
get:
description: >-
Export a list of vendors for an organization. Use filters to limit
results.
operationId: export_ExportVendorsOrg
tags:
- Export
parameters:
- name: format
in: path
description: 'Format for the export, either XLSX or CSV. '
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: columnsExport
in: query
required: false
schema:
type: string
pattern: >-
^([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*,)*([a-zA-Z_][a-zA-Z0-9_]*:[a-zA-Z_][a-zA-Z0-9_]*)$
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
The number of records to return for the query. The maximum is 30,000
records. When this parameter isn't sent, the API returns up to
25,000 records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `method` (in, nin, eq, ne)
- `enrollmentStatus` (in, nin, eq, ne)
- `status` (in, nin, eq, ne)
- `vendorNumber` (ct, nct, eq, ne)
- `name` (ct, nct, eq, ne)
- `ein` (ct, nct, eq, ne)
- `phone` (ct, nct, eq, ne)
- `email` (ct, nct, eq, ne)
- `address` (ct, nct, eq, ne)
- `city` (ct, nct, eq, ne)
- `state` (ct, nct, eq, ne)
- `country` (ct, nct, eq, ne)
- `zip` (ct, nct, eq, ne)
- `mcc` (ct, nct, eq, ne)
- `locationCode` (ct, nct, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
summary: Export vendors for an organization
security: *ref_0
/MoneyOutCard/GhostCard/{entry}:
post:
description: >-
Creates a ghost card, a multi-use virtual debit card issued to a vendor
for recurring or discretionary spend.
Unlike single-use virtual cards issued as part of a payout transaction,
ghost cards aren't tied to a specific payout. They're issued directly to
a vendor and can be reused up to a configurable number of times within
the card's spending limits.
Only one ghost card can exist per vendor per paypoint. To issue a new
card to the same vendor, cancel the existing card first.
operationId: ghostCard_CreateGhostCard
tags:
- GhostCard
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
responses:
'200':
description: Success response with ghost card details.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGhostCardResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Create ghost card
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
vendorId:
type: integer
format: int64
description: >-
ID of the vendor who receives the card. The vendor must
belong to the paypoint and have an active status.
expenseLimit:
type: number
format: double
description: >-
Spending limit for the card. Must be greater than `0` and
can't exceed the paypoint's configured payout credit limit.
expirationDate:
type: string
nullable: true
description: >-
Requested expiration date for the card. If not provided,
defaults to 30 days from creation.
amount:
type: number
format: double
description: Initial load amount for the card.
maxNumberOfUses:
type: integer
description: >-
Maximum number of times the card can be used. Ignored and
set to `1` when `exactAmount` is `true`.
exactAmount:
type: boolean
description: >-
When `true`, restricts the card to a single use.
`maxNumberOfUses` is automatically set to `1` regardless of
any other value provided.
expenseLimitPeriod:
type: string
description: >-
Time period over which `expenseLimit` applies (for example,
`monthly` or `weekly`).
billingCycle:
type: string
description: Billing cycle identifier.
billingCycleDay:
type: string
description: Day within the billing cycle.
dailyTransactionCount:
type: integer
description: Maximum number of transactions allowed per day.
dailyAmountLimit:
type: number
format: double
description: Maximum total spend allowed per day.
transactionAmountLimit:
type: integer
description: Maximum spend allowed per single transaction.
mcc:
type: string
nullable: true
description: >-
Merchant Category Code to restrict where the card can be
used. Must be a valid MCC if provided.
tcc:
type: string
nullable: true
description: >-
Transaction Category Code to restrict where the card can be
used. Must be a valid TCC if provided.
misc1:
type: string
nullable: true
description: Custom metadata field. Stored on the card record.
misc2:
type: string
nullable: true
description: Custom metadata field. Stored on the card record.
required:
- vendorId
- expenseLimit
- amount
- maxNumberOfUses
- exactAmount
- expenseLimitPeriod
- billingCycle
- billingCycleDay
- dailyTransactionCount
- dailyAmountLimit
- transactionAmountLimit
/MoneyOutCard/card/{entry}:
patch:
description: >-
Updates the status of a virtual card (including ghost cards) under a
paypoint.
operationId: ghostCard_UpdateCard
tags:
- GhostCard
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
responses:
'200':
description: Success response.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update card status
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cardToken:
type: string
description: >-
Token that uniquely identifies the card. This is the
`ReferenceId` returned when the card was created.
status:
$ref: '#/components/schemas/CardStatus'
nullable: true
description: The new status to set on the card.
required:
- cardToken
/Paypoint/load/{entry}/{subdomain}:
get:
description: >-
Loads all of a payment page's details including `pageIdentifier` and
`validationCode`. This endpoint requires an `application` API token.
operationId: hostedPaymentPages_loadPage
tags:
- HostedPaymentPages
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: subdomain
in: path
description: >-
Payment page identifier. The subdomain value is the last part of the
payment page URL. For example,
in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`,
the subdomain is `pay-your-fees-1`.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliPages'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get all payment page details
security: *ref_0
/Paypoint/{entry}:
post:
description: >-
Creates a new payment page for a paypoint.
Note: this operation doesn't create a new paypoint, just a payment page
for an existing paypoint. Paypoints are created by the Payabli team when
a boarding application is approved.
operationId: hostedPaymentPages_newPage
tags:
- HostedPaymentPages
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Create payment page
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliPages'
get:
description: Gets the details for a single paypoint.
operationId: paypoint_getEntryConfig
tags:
- Paypoint
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: entrypages
in: query
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEntryConfigResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get paypoint details
security: *ref_0
/Paypoint/{entry}/{subdomain}:
put:
description: Updates a payment page in a paypoint.
operationId: hostedPaymentPages_savePage
tags:
- HostedPaymentPages
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: subdomain
in: path
description: >-
Payment page identifier. The subdomain value is the last part of the
payment page URL. For example,
in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`,
the subdomain is `pay-your-fees-1`.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update a payment page
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliPages'
get:
description: 'Gets the details for single payment page for a paypoint. '
operationId: paypoint_getPage
tags:
- Paypoint
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: subdomain
in: path
description: >-
Payment page identifier. The subdomain value is the last portion of
the payment page URL. For example,
in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`,
the subdomain is `pay-your-fees-1`.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliPages'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get payment page details
security: *ref_0
delete:
description: Deletes a payment page in a paypoint.
operationId: paypoint_removePage
tags:
- Paypoint
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: subdomain
in: path
description: >-
Payment page identifier. The subdomain value is the last portion of
the payment page URL. For example,
in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`,
the subdomain is `pay-your-fees-1`.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete a payment page
security: *ref_0
/Import/billsForm/{entry}:
post:
description: >-
Import a list of bills from a CSV file. See the [Import
Guide](/developers/developer-guides/bills-add#import-bills) for more
help and an example file.
operationId: import_ImportBills
tags:
- Import
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseImport'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Import list of bills
security: *ref_0
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
/Import/customersForm/{entry}:
post:
description: >-
Import a list of customers from a CSV file. See the [Import
Guide](/developers/developer-guides/entities-customers#import-customers)
for more help and example files.
operationId: import_ImportCustomer
tags:
- Import
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entrypointfield'
- name: replaceExisting
in: query
description: >-
Flag indicating to replace existing customer with a new record.
Possible values: 0 (do not replace), 1 (replace). Default is 0
required: false
schema:
type: integer
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseImport'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Import list of customers
security: *ref_0
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
/Import/vendorsForm/{entry}:
post:
description: >-
Import a list of vendors from a CSV file. See the [Import
Guide](/developers/developer-guides/entities-vendors#import-vendors) for
more help and example files.
operationId: import_ImportVendor
tags:
- Import
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entrypointfield'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseImport'
summary: Import list of vendors
security: *ref_0
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
/Invoice/{entry}:
post:
description: Creates an invoice in an entrypoint.
operationId: invoice_AddInvoice
tags:
- Invoice
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceResponseWithoutData'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add invoice
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceDataRequest'
/Invoice/attachedFileFromInvoice/{idInvoice}/{filename}:
delete:
description: Deletes an invoice that's attached to a file.
operationId: invoice_deleteAttachedFromInvoice
tags:
- Invoice
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
- name: filename
in: path
description: >-
The filename in Payabli. Filename is `zipName` in response to a
request to `/api/Invoice/{idInvoice}`. Here, the filename is
`0_Bill.pdf``.
"DocumentsRef": {
"zipfile": "inva_269.zip",
"filelist": [
{
"originalName": "Bill.pdf",
"zipName": "0_Bill.pdf",
"descriptor": null
}
]
}
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceResponseWithoutData'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete attached file from invoice
security: *ref_0
get:
description: Retrieves a file attached to an invoice.
operationId: invoice_GetAttachedFileFromInvoice
tags:
- Invoice
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
- name: filename
in: path
description: >-
The filename in Payabli. Filename is `zipName` in the response to a
request to `/api/Invoice/{idInvoice}`. Here, the filename is
`0_Bill.pdf``.
```
"DocumentsRef": {
"zipfile": "inva_269.zip",
"filelist": [
{
"originalName": "Bill.pdf",
"zipName": "0_Bill.pdf",
"descriptor": null
}
]
}
```
required: true
schema:
type: string
- name: returnObject
in: query
description: >-
When `true`, the request returns the file content as a
Base64-encoded string.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: >-
A successful response returns a binary file when `returnObject` is
`false`. When `returnObject` is `true`, the response contains the
file content as a Base64-encoded string in an object. Due to
technical limitations, only the object response is documented here.
content:
application/json:
schema:
$ref: '#/components/schemas/FileContent'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get attached file from an invoice
security: *ref_0
/Invoice/{idInvoice}:
delete:
description: Deletes a single invoice from an entrypoint.
operationId: invoice_DeleteInvoice
tags:
- Invoice
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceResponseWithoutData'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete invoice
security: *ref_0
put:
description: Updates details for a single invoice in an entrypoint.
operationId: invoice_EditInvoice
tags:
- Invoice
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
- name: forceCustomerCreation
in: query
description: >-
When `true`, the request creates a new customer record, regardless
of whether customer identifiers match an existing customer.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceResponseWithoutData'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update invoice
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceDataRequest'
get:
description: Retrieves a single invoice by ID.
operationId: invoice_GetInvoice
tags:
- Invoice
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
responses:
'200':
description: Success. Fields marked optional may return `null` if not set.
content:
application/json:
schema:
$ref: '#/components/schemas/GetInvoiceRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get invoice
security: *ref_0
/Invoice/getNumber/{entry}:
get:
description: Retrieves the next available invoice number for a paypoint.
operationId: invoice_GetInvoiceNumber
tags:
- Invoice
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceNumberResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get next InvoiceNumber for entrypoint
security: *ref_0
/Query/invoices/{entry}:
get:
description: >-
Returns a list of invoices for an entrypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: invoice_ListInvoices
tags:
- Invoice
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `invoiceDate` (gt, ge, lt, le, eq, ne)
- `dueDate` (gt, ge, lt, le, eq, ne)
- `sentDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin,ne, eq)
- `invoiceType` (eq, ne)
- `payTerms` (in, nin, eq, ne)
- `paypointId` (ne, eq)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paidAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `invoiceNumber` (ct, nct, eq, ne)
- `purchaseOrder` (ct, nct, eq, ne)
- `itemProductCode` (ct, nct)
- `itemDescription` (ct, nct)
- `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)
- `paylinkId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
- nin => not inside array
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: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success. Fields marked optional may return `null` if not set.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryInvoiceResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of invoices for an entrypoint
security: *ref_0
/Query/invoices/org/{orgId}:
get:
description: >-
Returns a list of invoices for an org. Use filters to limit results.
Include the `exportFormat` query parameter to return the results as a
file instead of a JSON response.
operationId: invoice_ListInvoicesOrg
tags:
- Invoice
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `invoiceDate` (gt, ge, lt, le, eq, ne)
- `dueDate` (gt, ge, lt, le, eq, ne)
- `sentDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin,ne, eq)
- `invoiceType` (eq, ne)
- `payTerms` (in, nin, eq, ne)
- `paypointId` (ne, eq)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `paidAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `invoiceNumber` (ct, nct, eq, ne)
- `purchaseOrder` (ct, nct, eq, ne)
- `itemProductCode` (ct, nct)
- `itemDescription` (ct, nct)
- `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)
- `paylinkId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
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
- nin => not inside array
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: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success. Fields marked optional may return `null` if not set.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryInvoiceResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of invoices for an organization
security: *ref_0
/Invoice/send/{idInvoice}:
get:
description: Sends an invoice from an entrypoint via email.
operationId: invoice_SendInvoice
tags:
- Invoice
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
- name: attachfile
in: query
description: When `true`, attaches a PDF version of invoice to the email.
required: false
schema:
type: boolean
nullable: true
- name: mail2
in: query
description: >-
Email address where the invoice will be sent to. If this parameter
isn't included, Payabli uses the email address on file for the
customer owner of the invoice.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SendInvoiceResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Send invoice via email
security: *ref_0
/Export/invoicePdf/{idInvoice}:
get:
description: Export a single invoice in PDF format.
operationId: invoice_GetInvoicePDF
tags:
- Invoice
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Export Invoice PDF
security: *ref_0
/LineItem/{entry}:
post:
description: >-
Adds products and services to an entrypoint's catalog. These are used as
line items for invoicing and transactions. In the response,
"responseData" displays the item's code.
operationId: lineItem_AddItem
tags:
- LineItem
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: idempotencyKey
in: header
description: >-
A unique ID you can include to prevent duplicating objects or
transactions if a request is sent more than once. This key isn't
generated in Payabli, you must generate it yourself.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse6'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add item to entrypoint catalog
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LineItem'
/LineItem/{lineItemId}:
delete:
description: Deletes an item.
operationId: lineItem_DeleteItem
tags:
- LineItem
parameters:
- name: lineItemId
in: path
description: ID for the line item (also known as a product, service, or item).
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteItemResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete item in entrypoint
security: *ref_0
get:
description: 'Gets an item by ID. '
operationId: lineItem_GetItem
tags:
- LineItem
parameters:
- name: lineItemId
in: path
description: ID for the line item (also known as a product, service, or item).
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LineItemQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get item in entrypoint
security: *ref_0
put:
description: Updates an item.
operationId: lineItem_UpdateItem
tags:
- LineItem
parameters:
- name: lineItemId
in: path
description: ID for the line item (also known as a product, service, or item).
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse6'
summary: Update item in entrypoint
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LineItem'
/Query/lineitems/{entry}:
get:
description: >-
Retrieves a list of line items and their details from an entrypoint.
Line items are also known as items, products, and services. Use filters
to limit results.
operationId: lineItem_ListLineItems
tags:
- LineItem
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `categories` (ct, nct)
- `code` (ne, eq, ct, nct)
- `commodityCode` (ne, eq, ct, nct)
- `createdDate` (gt, ge, lt, le, eq, ne)
- `description` (ne, eq, ct, nct)
- `externalPaypointID` (ct, nct, ne, eq)
- `mode` (eq, ne)
- `name` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `quantity` (gt, ge, lt, le, eq, ne)
- `uom` (ne, eq, ct, nct)
- `updatedDate` (gt, ge, lt, le, eq, ne)
- `value` (gt, ge, lt, le, 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
Example: name(ct)=john return all records with name containing john
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseItems'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of items for entrypoint
security: *ref_0
/MoneyIn/authorize:
post:
description: >-
Authorize a card transaction. This returns an authorization code and
reserves funds for the merchant. Authorized transactions aren't flagged
for settlement until
[captured](/developers/api-reference/moneyin/capture-an-authorized-transaction).
Only card transactions can be authorized. This endpoint can't be used
for ACH transactions.
Consider migrating to the [v2 Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction) to take advantage of unified response codes and improved response consistency.
operationId: moneyIn_Authorize
tags:
- MoneyIn
parameters:
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Authorize card transaction
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransRequestBody'
/MoneyIn/capture/{transId}/{amount}:
get:
description: >-
This endpoint is deprecated and will be sunset on November 24, 2025. Migrate to [POST `/capture/{transId}`](/developers/api-reference/moneyin/capture-an-authorized-transaction)`.
Capture an [authorized
transaction](/developers/api-reference/moneyin/authorize-a-transaction)
to complete the transaction and move funds from the customer to merchant
account.
operationId: moneyIn_Capture
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
- name: amount
in: path
description: >-
Amount to be captured. The amount can't be greater the original
total amount of the transaction. `0` captures the total amount
authorized in the transaction. Partial captures aren't supported.
required: true
schema:
type: number
format: double
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/CaptureResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Capture an authorized transaction
security: *ref_0
/MoneyIn/capture/{transId}:
post:
description: >-
Capture an [authorized
transaction](/developers/api-reference/moneyin/authorize-a-transaction)
to complete the transaction and move funds from the customer to merchant
account.
You can use this endpoint to capture both full and partial amounts of
the original authorized transaction. See [Capture an authorized
transaction](/developers/developer-guides/pay-in-auth-and-capture) for
more information about this endpoint.
Consider migrating to the [v2 Capture
endpoint](/developers/api-reference/moneyinV2/capture-an-authorized-transaction)
to take advantage of unified response codes and improved response
consistency.
operationId: moneyIn_CaptureAuth
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/CaptureResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CaptureRequest'
/MoneyIn/makecredit:
post:
description: >-
Make a temporary microdeposit in a customer account to verify the
customer's ownership and access to the target account. Reverse the
microdeposit with `reverseCredit`. Payabli doesn't automatically make
microdeposits when you add a bank account, you must manually make the
requests.
This feature must be enabled by Payabli on a per-merchant basis. Contact
support for help.
operationId: moneyIn_Credit
tags:
- MoneyIn
parameters:
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: >-
Success. The `referenceId` returned in a successful response is the
`transId` value you need to reverse the microdeposit.
A "Missing Gateway Data" message can indicate that the entrypoint
targeted in the request isn't set up for ACH payments.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse0'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Make an ACH credit transaction
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
customerData:
$ref: '#/components/schemas/PayorDataRequest'
description: Object describing the customer/payor.
entrypoint:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
paymentDetails:
$ref: '#/components/schemas/PaymentDetailCredit'
paymentMethod:
$ref: '#/components/schemas/RequestCreditPaymentMethod'
description: >-
Object describing the ACH payment method to use for
transaction.
source:
$ref: '#/components/schemas/Source'
nullable: true
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
required:
- customerData
- paymentDetails
- paymentMethod
/MoneyIn/details/{transId}:
get:
description: Retrieve a processed transaction's details.
operationId: moneyIn_Details
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionQueryRecordsCustomer'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get details for a processed transaction
security: *ref_0
/MoneyIn/getpaid:
post:
description: >-
Make a single transaction. This method authorizes and captures a payment
in one step.
Consider migrating to the [v2 Make a transaction endpoint](/developers/api-reference/moneyinV2/make-a-transaction) to take advantage of unified response codes and improved response consistency.
operationId: moneyIn_getpaid
tags:
- MoneyIn
parameters:
- name: achValidation
in: query
required: false
schema:
$ref: '#/components/schemas/AchValidation'
nullable: true
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: includeDetails
in: query
description: >-
When `true`, transactionDetails object is returned in the response.
See a full example of the `transactionDetails` object in the
[Transaction integration
guide](/developers/developer-guides/money-in-transaction-add#includedetailstrue-response).
required: false
schema:
type: boolean
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
- name: validationCode
in: header
description: >-
Value obtained from user when an API generated CAPTCHA is used in
payment page
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliAPIResponseGetPaid'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Make a transaction
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransRequestBody'
/MoneyIn/reverse/{transId}/{amount}:
get:
description: >-
A reversal either refunds or voids a transaction independent of the
transaction's settlement status. Send a reversal request for a
transaction, and Payabli automatically determines whether it's a refund
or void. You don't need to know whether the transaction is settled or
not.
operationId: moneyIn_Reverse
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
- name: amount
in: path
description: >-
Amount to reverse from original transaction, minus any service fees
charged on the original transaction.
The amount provided can't be greater than the original total amount
of the transaction, minus service fees. For example, if a
transaction was $90 plus a $10 service fee, you can reverse up to
$90.
An amount equal to zero will refunds the total amount authorized
minus any service fee.
required: true
schema:
type: number
format: double
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ReverseResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Reverse a transaction
security: *ref_0
/MoneyIn/refund/{transId}/{amount}:
get:
description: >-
Refund a transaction that has settled and send money back to the account
holder. If a transaction hasn't been settled, void it instead.
Consider migrating to the [v2 Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) to take advantage of unified response codes and improved response consistency.
operationId: moneyIn_Refund
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
- name: amount
in: path
description: >-
Amount to refund from original transaction, minus any service fees
charged on the original transaction.
The amount provided can't be greater than the original total amount
of the transaction, minus service fees. For example, if a
transaction was \$90 plus a \$10 service fee, you can refund up to
\$90.
An amount equal to zero will refund the total amount authorized
minus any service fee.
required: true
schema:
type: number
format: double
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/RefundResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Refund a settled transaction
security: *ref_0
/MoneyIn/refund/{transId}:
post:
description: Refunds a settled transaction with split instructions.
operationId: moneyIn_RefundWithInstructions
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RefundWithInstructionsResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Refund a settled transaction with split instructions
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: number
format: double
nullable: true
description: >-
Amount to refund from original transaction, minus any
service fees charged on the original transaction.
The amount provided can't be greater than the original total
amount of the transaction, minus service fees. For example,
if a transaction was $90 plus a $10 service fee, you can
refund up to $90.
An amount equal to zero will refund the total amount
authorized minus any service fee.
ipaddress:
$ref: '#/components/schemas/IpAddress'
nullable: true
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
refundDetails:
$ref: '#/components/schemas/RefundDetail'
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
/MoneyIn/reverseCredit/{transId}:
get:
description: >-
Reverse microdeposits that are used to verify customer account ownership
and access. The `transId` value is returned in the success response for
the original credit transaction made with `api/MoneyIn/makecredit`.
operationId: moneyIn_ReverseCredit
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Reverse an ACH credit transaction
security: *ref_0
/MoneyIn/sendreceipt/{transId}:
get:
description: Send a payment receipt for a transaction.
operationId: moneyIn_SendReceipt2Trans
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
- name: email
in: query
description: >-
Email address where the payment receipt should be sent.
If not provided, the email address on file for the user owner of the
transaction is used.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ReceiptResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Send receipt for transaction
security: *ref_0
/MoneyIn/validate:
post:
description: >-
Validates a card number without running a transaction or authorizing a
charge.
operationId: moneyIn_Validate
tags:
- MoneyIn
parameters:
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Validate card
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
entryPoint:
$ref: '#/components/schemas/Entrypointfield'
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
paymentMethod:
$ref: '#/components/schemas/RequestPaymentValidatePaymentMethod'
description: Object describing payment method to use for transaction.
required:
- entryPoint
- paymentMethod
/MoneyIn/void/{transId}:
get:
description: >-
Cancel a transaction that hasn't been settled yet. Voiding non-captured
authorizations prevents future captures. If a transaction has been
settled, refund it instead.
Consider migrating to the [v2 Void endpoint](/developers/api-reference/moneyinV2/void-a-transaction) to take advantage of unified response codes and improved response consistency.
operationId: moneyIn_Void
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/VoidResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Void a transaction
security: *ref_0
/v2/MoneyIn/getpaid:
post:
description: >-
Make a single transaction. This method authorizes and captures a payment
in one step. This is the v2 version of the `api/MoneyIn/getpaid`
endpoint, and returns the unified response format. See [Pay In unified
response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
operationId: moneyIn_getpaidv2
tags:
- MoneyIn
parameters:
- name: achValidation
in: query
required: false
schema:
$ref: '#/components/schemas/AchValidation'
nullable: true
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
- name: validationCode
in: header
description: >-
Value obtained from user when an API generated CAPTCHA is used in
payment page
required: false
schema:
type: string
nullable: true
responses:
'201':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/V2TransactionResponseWrapper'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2BadRequestError'
'401':
description: ''
content:
application/json:
schema: {}
'402':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2InternalServerError'
summary: Make a transaction (v2)
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransRequestBody'
/v2/MoneyIn/authorize:
post:
description: >-
Authorize a card transaction. This returns an authorization code and
reserves funds for the merchant. Authorized transactions aren't flagged
for settlement until captured. This is the v2 version of the
`api/MoneyIn/authorize` endpoint, and returns the unified response
format. See [Pay In unified response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
**Note**: Only card transactions can be authorized. This endpoint can't
be used for ACH transactions.
operationId: moneyIn_authorizev2
tags:
- MoneyIn
parameters:
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'201':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/V2TransactionResponseWrapper'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2BadRequestError'
'401':
description: ''
content:
application/json:
schema: {}
'402':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2InternalServerError'
summary: Authorize card transaction (v2)
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransRequestBody'
/v2/MoneyIn/capture/{transId}:
post:
description: >-
Capture an authorized transaction to complete the transaction and move
funds from the customer to merchant account. This is the v2 version of
the `api/MoneyIn/capture/{transId}` endpoint, and returns the unified
response format. See [Pay In unified response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
operationId: moneyIn_capturev2
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'201':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/V2TransactionResponseWrapper'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2BadRequestError'
'401':
description: ''
content:
application/json:
schema: {}
'402':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2InternalServerError'
summary: Capture an authorized transaction (v2)
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CaptureRequest'
/v2/MoneyIn/refund/{transId}:
post:
description: >-
Give a full refund for a transaction that has settled and send money
back to the account holder. To perform a partial refund, see [Partially
refund a
transaction](developers/api-reference/moneyinV2/partial-refund-a-settled-transaction).
This is the v2 version of the refund endpoint, and returns the unified
response format. See [Pay In unified response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
operationId: moneyIn_refundv2
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'201':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/V2TransactionResponseWrapper'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2BadRequestError'
'401':
description: ''
content:
application/json:
schema: {}
'402':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2InternalServerError'
summary: Refund a settled transaction (v2)
security: *ref_0
/v2/MoneyIn/refund/{transId}/{amount}:
post:
description: >-
Refund a transaction that has settled and send money back to the account
holder. If `amount` is omitted or set to 0, performs a full refund. When
a non-zero `amount` is provided, this endpoint performs a partial
refund.
This is the v2 version of the refund endpoint, and returns the unified
response format. See [Pay In unified response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
operationId: moneyIn_refundv2amount
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
- name: amount
in: path
description: >-
Amount to refund from original transaction, minus any service fees
charged on the original transaction. If omitted or set to 0,
performs a full refund.
required: true
schema:
type: number
format: double
responses:
'201':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/V2TransactionResponseWrapper'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2BadRequestError'
'401':
description: ''
content:
application/json:
schema: {}
'402':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2InternalServerError'
summary: Partially refund a settled transaction (v2)
security: *ref_0
/v2/MoneyIn/void/{transId}:
post:
description: >-
Cancel a transaction that hasn't been settled yet. Voiding non-captured
authorizations prevents future captures. This is the v2 version of the
`api/MoneyIn/void/{transId}` endpoint, and returns the unified response
format. See [Pay In unified response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
operationId: moneyIn_voidv2
tags:
- MoneyIn
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/V2TransactionResponseWrapper'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2BadRequestError'
'401':
description: ''
content:
application/json:
schema: {}
'402':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V2InternalServerError'
summary: Void a transaction (v2)
security: *ref_0
/MoneyOut/authorize:
post:
description: >-
Authorizes transaction for payout. Authorized transactions aren't
flagged for settlement until captured. Use `referenceId` returned in the
response to capture the transaction.
operationId: moneyOut_AuthorizeOut
tags:
- MoneyOut
parameters:
- name: allowDuplicatedBills
in: query
description: >-
When `true`, the authorization bypasses the requirement for unique
bills, identified by vendor invoice number. This allows you to make
more than one payout authorization for a bill, like a split payment.
required: false
schema:
type: boolean
nullable: true
- name: doNotCreateBills
in: query
description: >-
When `true`, Payabli won't automatically create a bill for this
payout transaction.
required: false
schema:
type: boolean
nullable: true
- name: forceVendorCreation
in: query
description: >-
When `true`, the request creates a new vendor record, regardless of
whether the vendor already exists.
required: false
schema:
type: boolean
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthCapturePayoutResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Authorize a payout
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizePayoutBody'
/MoneyOut/cancelAll:
post:
description: Cancels an array of payout transactions.
operationId: moneyOut_CancelAllOut
tags:
- MoneyOut
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CaptureAllOutResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Cancel list of payout transactions
security: *ref_0
requestBody:
description: Array of identifiers of payout transactions to cancel.
required: true
content:
application/json:
schema:
type: array
items:
type: string
/MoneyOut/cancel/{referenceId}:
get:
description: Cancel a payout transaction by ID.
operationId: moneyOut_CancelOutGet
tags:
- MoneyOut
parameters:
- name: referenceId
in: path
description: 'The ID for the payout transaction. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse0000'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Cancel a payout transaction
security: *ref_0
delete:
description: Cancel a payout transaction by ID.
operationId: moneyOut_CancelOutDelete
tags:
- MoneyOut
parameters:
- name: referenceId
in: path
description: 'The ID for the payout transaction. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse0000'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Cancel a payout transaction
security: *ref_0
/MoneyOut/captureAll:
post:
description: >-
Captures an array of authorized payout transactions for settlement. The
maximum number of transactions that can be captured in a single request
is 500.
operationId: moneyOut_CaptureAllOut
tags:
- MoneyOut
parameters:
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CaptureAllOutResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Capture a list of authorized payout transactions
security: *ref_0
requestBody:
description: 'Array of identifiers of payout transactions to capture. '
required: true
content:
application/json:
schema:
type: array
items:
type: string
/MoneyOut/capture/{referenceId}:
get:
description: Captures a single authorized payout transaction by ID.
operationId: moneyOut_CaptureOut
tags:
- MoneyOut
parameters:
- name: referenceId
in: path
description: 'The ID for the payout transaction. '
required: true
schema:
type: string
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthCapturePayoutResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Capture an authorized payout transaction
security: *ref_0
/MoneyOut/details/{transId}:
get:
description: Returns details for a processed money out transaction.
operationId: moneyOut_PayoutDetails
tags:
- MoneyOut
parameters:
- name: transId
in: path
description: ReferenceId for the transaction (PaymentId).
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BillDetailResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get details for a processed payout transaction
security: *ref_0
/MoneyOut/vcard/{cardToken}:
get:
description: Retrieves vCard details for a single card in an entrypoint.
operationId: moneyOut_VCardGet
tags:
- MoneyOut
parameters:
- name: cardToken
in: path
description: ID for a virtual card.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/VCardGetResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get a virtual card
security: *ref_0
/vcard/send-card-link:
post:
description: >-
Sends a virtual card link via email to the vendor associated with the
`transId`.
operationId: moneyOut_SendVCardLink
tags:
- MoneyOut
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OperationResult'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Send virtual card link
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
transId:
type: string
description: >-
The transaction ID of the virtual card payout. The ID is
returned as `ReferenceId` in the response when you authorize
a payout with POST /MoneyOut/authorize.
required:
- transId
/MoneyOut/checkimage/{assetName}:
get:
description: >-
Retrieve the image of a check associated with a processed transaction.
The check image is returned in the response body as a base64-encoded
string.
The check image is only available for payouts that have been processed.
operationId: moneyOut_GetCheckImage
tags:
- MoneyOut
parameters:
- name: assetName
in: path
description: >-
Name of the check asset to retrieve. This is returned as `filename`
in the `CheckData` object
in the response when you make a GET request to
`/MoneyOut/details/{transId}`.
```
"CheckData": {
"ftype": "PDF",
"filename": "check133832686289732320_01JKBNZ5P32JPTZY8XXXX000000.pdf",
"furl": "",
"fContent": ""
}
```
required: true
schema:
type: string
responses:
'200':
description: A base64-encoded string of the check image.
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get check image
security: *ref_0
/MoneyOut/status/{transId}/{checkPaymentStatus}:
patch:
description: >-
Updates the status of a processed check payment transaction. This
endpoint handles the status transition, updates related bills, creates
audit events, and triggers notifications.
The transaction must meet all of the following criteria:
- **Status**: Must be in Processing or Processed status.
- **Payment method**: Must be a check payment method.
### Allowed status values
| Value | Status | Description |
|-------|--------|-------------|
| `0` | Cancelled/Voided | Cancels the check transaction. Reverts
associated bills to their previous state (Approved or Active), creates
"Cancelled" events, and sends a `payout_transaction_voidedcancelled`
notification if the notification is enabled. |
| `5` | Paid | Marks the check transaction as paid. Updates associated
bills to "Paid" status, creates "Paid" events, and sends a
`payout_transaction_paid` notification if the notification is enabled. |
operationId: moneyOut_UpdateCheckPaymentStatus
tags:
- MoneyOut
parameters:
- name: transId
in: path
description: The Payabli transaction ID for the check payment.
required: true
schema:
type: string
- name: checkPaymentStatus
in: path
description: >-
The new status to apply to the check transaction. To mark a check as
`Paid`, send 5. To mark a check as `Cancelled`, send 0.
required: true
schema:
$ref: '#/components/schemas/AllowedCheckPaymentStatus'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update check payment status
security: *ref_0
/MoneyOut/reissue:
post:
description: >-
Reissues a payout transaction with a new payment method. This creates a
new transaction linked to the original and marks the original
transaction as reissued.
The original transaction must be in **Processing** or **Processed**
status. The payment method in the request body is used directly. The
endpoint doesn't fall back to vendor-managed payment methods.
The new transaction goes through the standard authorize-and-capture flow
automatically. Both the original and new transactions are linked through
their event histories for audit purposes.
operationId: moneyOut_ReissueOut
tags:
- MoneyOut
parameters:
- name: transId
in: query
description: The transaction ID of the payout to reissue.
required: true
schema:
type: string
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ReissuePayoutResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaylinks'
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Reissue a payout transaction
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReissuePayoutBody'
/Notification:
post:
description: 'Create a new notification or autogenerated report. '
operationId: notification_AddNotification
tags:
- Notification
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseNotifications'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add notification
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddNotificationRequest'
/Notification/{nId}:
delete:
description: Deletes a single notification or autogenerated report.
operationId: notification_DeleteNotification
tags:
- Notification
parameters:
- name: nId
in: path
description: 'Notification ID. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseNotifications'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete notification
security: *ref_0
get:
description: Retrieves a single notification or autogenerated report's details.
operationId: notification_GetNotification
tags:
- Notification
parameters:
- name: nId
in: path
description: 'Notification ID. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get notification
security: *ref_0
put:
description: 'Update a notification or autogenerated report. '
operationId: notification_UpdateNotification
tags:
- Notification
parameters:
- name: nId
in: path
description: 'Notification ID. '
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseNotifications'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update notification
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNotificationRequest'
/Export/notificationReport/{Id}:
get:
description: Gets a copy of a generated report by ID.
operationId: notification_GetReportFile
tags:
- Notification
parameters:
- name: Id
in: path
description: Report ID
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
summary: Export Generated Report by ID
security: *ref_0
/v2/notificationlogs:
post:
description: >-
Search notification logs with filtering and pagination.
- Start date and end date cannot be more than 30 days apart
- Either `orgId` or `paypointId` must be provided
This endpoint requires the `notifications_create` OR
`notifications_read` permission.
operationId: notificationlogs_searchNotificationLogs
tags:
- Notificationlogs
parameters:
- name: PageSize
in: query
required: false
schema:
$ref: '#/components/schemas/Pagesize'
nullable: true
- name: Page
in: query
description: The page number to retrieve. Defaults to 1 if not provided.
required: false
schema:
type: integer
nullable: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationLog'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLogSearchRequest'
/v2/notificationlogs/{uuid}:
get:
description: >-
Get detailed information for a specific notification log entry.
This endpoint requires the `notifications_create` OR
`notifications_read` permission.
operationId: notificationlogs_getNotificationLog
tags:
- Notificationlogs
parameters:
- name: uuid
in: path
description: The notification log entry.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLogDetail'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
security: *ref_0
/v2/notificationlogs/{uuid}/retry:
get:
description: |-
Retry sending a specific notification.
**Permissions:** notifications_create
operationId: notificationlogs_retryNotificationLog
tags:
- Notificationlogs
parameters:
- name: uuid
in: path
description: Unique id
required: true
schema:
type: string
format: uuid
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLogDetail'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
security: *ref_0
/v2/notificationlogs/retry:
post:
description: >-
Retry sending multiple notifications (maximum 50 IDs).
This is an async process, so use the search endpoint again to check the
notification status.
This endpoint requires the `notifications_create` permission.
operationId: notificationlogs_bulkRetryNotificationLogs
tags:
- Notificationlogs
parameters: []
responses:
'204':
description: ''
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkRetryRequest'
/Import/ocrDocumentForm/{typeResult}:
post:
description: >-
Use this endpoint to upload an image file for OCR processing. The
accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the
desired type of result (either 'bill' or 'invoice') in the path
parameter `typeResult`. The response will contain the OCR processing
results, including extracted data such as bill number, vendor
information, bill items, and more.
operationId: ocr_OcrDocumentForm
tags:
- Ocr
parameters:
- name: typeResult
in: path
required: true
schema:
$ref: '#/components/schemas/typeResult'
responses:
'200':
description: OCR document processing result
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseOCR'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
security: *ref_0
requestBody:
description: >-
The image file to OCR. Accepted formats include PDF, JPG, JPEG, PNG,
GIF.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FileContentImageOnly'
/Import/ocrDocumentJson/{typeResult}:
post:
description: >-
Use this endpoint to submit a Base64-encoded image file for OCR
processing. The accepted file formats include PDF, JPG, JPEG, PNG, and
GIF. Specify the desired type of result (either 'bill' or 'invoice') in
the path parameter `typeResult`. The response will contain the OCR
processing results, including extracted data such as bill number, vendor
information, bill items, and more.
operationId: ocr_OcrDocumentJson
tags:
- Ocr
parameters:
- name: typeResult
in: path
required: true
schema:
$ref: '#/components/schemas/typeResult'
responses:
'200':
description: OCR document processing result
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseOCR'
security: *ref_0
requestBody:
description: Base64-encoded file content for OCR processing
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FileContentImageOnly'
/Organization:
post:
description: >-
Creates an organization under a parent organization. This is also
referred to as a suborganization.
operationId: organization_AddOrganization
tags:
- Organization
parameters:
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success.
content:
application/json:
schema:
$ref: '#/components/schemas/AddOrganizationResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
services:
type: array
items:
$ref: '#/components/schemas/ServiceCost'
nullable: true
billingInfo:
$ref: '#/components/schemas/Instrument'
nullable: true
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
hasBilling:
type: boolean
nullable: true
hasResidual:
type: boolean
nullable: true
orgAddress:
$ref: '#/components/schemas/Orgaddress'
nullable: true
orgCity:
$ref: '#/components/schemas/Orgcity'
nullable: true
orgCountry:
$ref: '#/components/schemas/Orgcountry'
nullable: true
orgEntryName:
$ref: '#/components/schemas/Orgentryname'
nullable: true
orgId:
$ref: '#/components/schemas/Orgidstring'
nullable: true
orgLogo:
$ref: '#/components/schemas/FileContent'
nullable: true
orgName:
$ref: '#/components/schemas/Orgname'
orgParentId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
orgState:
$ref: '#/components/schemas/Orgstate'
nullable: true
orgTimezone:
$ref: '#/components/schemas/Orgtimezone'
nullable: true
orgType:
$ref: '#/components/schemas/Orgtype'
orgWebsite:
$ref: '#/components/schemas/Orgwebsite'
nullable: true
orgZip:
$ref: '#/components/schemas/Orgzip'
nullable: true
replyToEmail:
$ref: '#/components/schemas/ReplyToEmail'
required:
- orgName
- orgType
- replyToEmail
/Organization/{orgId}:
delete:
description: 'Delete an organization by ID. '
operationId: organization_DeleteOrganization
tags:
- Organization
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteOrganizationResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete organization
security: *ref_0
put:
description: Updates an organization's details by ID.
operationId: organization_EditOrganization
tags:
- Organization
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EditOrganizationResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
services:
type: array
items:
$ref: '#/components/schemas/ServiceCost'
nullable: true
billingInfo:
$ref: '#/components/schemas/Instrument'
nullable: true
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
hasBilling:
type: boolean
nullable: true
hasResidual:
type: boolean
nullable: true
orgAddress:
$ref: '#/components/schemas/Orgaddress'
nullable: true
orgCity:
$ref: '#/components/schemas/Orgcity'
nullable: true
orgCountry:
$ref: '#/components/schemas/Orgcountry'
nullable: true
orgEntryName:
$ref: '#/components/schemas/Orgentryname'
nullable: true
orgId:
$ref: '#/components/schemas/Orgidstring'
nullable: true
orgLogo:
$ref: '#/components/schemas/FileContent'
nullable: true
orgName:
$ref: '#/components/schemas/Orgname'
nullable: true
orgParentId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
orgState:
$ref: '#/components/schemas/Orgstate'
nullable: true
orgTimezone:
$ref: '#/components/schemas/Orgtimezone'
nullable: true
orgType:
$ref: '#/components/schemas/Orgtype'
nullable: true
orgWebsite:
$ref: '#/components/schemas/Orgwebsite'
nullable: true
orgZip:
$ref: '#/components/schemas/Orgzip'
nullable: true
replyToEmail:
$ref: '#/components/schemas/ReplyToEmail'
nullable: true
/Organization/basic/{entry}:
get:
description: >-
Gets an organization's basic information by entry name (entrypoint
identifier).
operationId: organization_GetBasicOrganization
tags:
- Organization
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get basic organization details by entry name
security: *ref_0
/Organization/basicById/{orgId}:
get:
description: Gets an organizations basic details by org ID.
operationId: organization_GetBasicOrganizationById
tags:
- Organization
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get basic organization details by ID
security: *ref_0
/Organization/read/{orgId}:
get:
description: 'Retrieves details for an organization by ID. '
operationId: organization_GetOrganization
tags:
- Organization
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get organization
security: *ref_0
/Organization/settings/{orgId}:
get:
description: Retrieves an organization's settings.
operationId: organization_GetSettingsOrganization
tags:
- Organization
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsQueryRecord'
summary: Get organization settings
security: *ref_0
/PaymentLink/{idInvoice}:
post:
description: 'Generates a payment link for an invoice from the invoice ID. '
operationId: paymentLink_AddPayLinkFromInvoice
tags:
- PaymentLink
parameters:
- name: idInvoice
in: path
description: Invoice ID
required: true
schema:
type: integer
- name: amountFixed
in: query
description: >-
Indicates whether customer can modify the payment amount. A value of
`true` means the amount isn't modifiable, a value `false` means the
payor can modify the amount to pay.
required: false
schema:
type: boolean
nullable: true
- name: mail2
in: query
description: >-
List of recipient email addresses. When there is more than one,
separate them by a semicolon (;).
required: false
schema:
type: string
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Generate payment link from Invoice
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentPageRequestBody'
/PaymentLink/bill/{billId}:
post:
description: >-
Generates a payment link for a bill from the bill ID. The vendor
receives a secure page where they can select their preferred payment
method (ACH, virtual card, or check) and complete the payment.
operationId: paymentLink_AddPayLinkFromBill
tags:
- PaymentLink
parameters:
- name: billId
in: path
description: The Payabli ID for the bill.
required: true
schema:
type: integer
- name: amountFixed
in: query
description: >-
Indicates whether customer can modify the payment amount. A value of
`true` means the amount isn't modifiable, a value `false` means the
payor can modify the amount to pay.
required: false
schema:
type: boolean
nullable: true
- name: mail2
in: query
description: >-
List of recipient email addresses. When there is more than one,
separate them by a semicolon (;).
required: false
schema:
type: string
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Generate payment link from Bill
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentPageRequestBodyOut'
/PaymentLink/{payLinkId}:
delete:
description: Deletes a payment link by ID.
operationId: paymentLink_deletePayLinkFromId
tags:
- PaymentLink
parameters:
- name: payLinkId
in: path
description: ID for the payment link.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete payment link
security: *ref_0
/PaymentLink/load/{paylinkId}:
get:
description: Retrieves a payment link by ID.
operationId: paymentLink_getPayLinkFromId
tags:
- PaymentLink
parameters:
- name: paylinkId
in: path
description: ID for payment link
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPayLinkFromIdResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get payment link from ID
security: *ref_0
/PaymentLink/push/{payLinkId}:
post:
description: Send a payment link to the specified email addresses or phone numbers.
operationId: paymentLink_pushPayLinkFromId
tags:
- PaymentLink
parameters:
- name: payLinkId
in: path
description: ID for the payment link.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Send payment link
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PushPayLinkRequest'
/PaymentLink/refresh/{payLinkId}:
get:
description: Refresh a payment link's content after an update.
operationId: paymentLink_refreshPayLinkFromId
tags:
- PaymentLink
parameters:
- name: payLinkId
in: path
description: ID for the payment link.
required: true
schema:
type: string
- name: amountFixed
in: query
description: >-
Indicates whether customer can modify the payment amount. A value of
`true` means the amount isn't modifiable, a value `false` means the
payor can modify the amount to pay.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Refresh payment link content
security: *ref_0
/PaymentLink/send/{payLinkId}:
get:
description: 'Sends a payment link to the specified email addresses. '
operationId: paymentLink_sendPayLinkFromId
tags:
- PaymentLink
parameters:
- name: payLinkId
in: path
description: ID for the payment link.
required: true
schema:
type: string
- name: attachfile
in: query
description: When `true`, attaches a PDF version of invoice to the email.
required: false
schema:
type: boolean
nullable: true
- name: mail2
in: query
description: >-
List of recipient email addresses. When there is more than one,
separate them by a semicolon (;).
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Send payment link email
security: *ref_0
/PaymentLink/update/{payLinkId}:
put:
description: Updates a payment link's details.
operationId: paymentLink_updatePayLinkFromId
tags:
- PaymentLink
parameters:
- name: payLinkId
in: path
description: ID for the payment link.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update payment link
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
contactUs:
$ref: '#/components/schemas/ContactElement'
nullable: true
description: ContactUs section of payment link page
logo:
$ref: '#/components/schemas/Element'
nullable: true
description: Logo section of payment link page
messageBeforePaying:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Message section of payment link page
notes:
$ref: '#/components/schemas/NoteElement'
nullable: true
description: Notes section of payment link page
page:
$ref: '#/components/schemas/PageElement'
nullable: true
description: Page header section of payment link page
paymentButton:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Payment button section of payment link page
paymentMethods:
$ref: '#/components/schemas/MethodElement'
nullable: true
description: Payment methods section of payment link page
review:
$ref: '#/components/schemas/HeaderElement'
nullable: true
description: Review section of payment link page
settings:
$ref: '#/components/schemas/PagelinkSetting'
nullable: true
description: Settings section of payment link page
/PaymentLink/bill/lotNumber/{lotNumber}:
post:
description: >-
Generates a vendor payment link for a specific bill lot number. This
allows you to pay all bills with the same lot number for a vendor with a
single payment link.
operationId: paymentLink_AddPayLinkFromBillLotNumber
tags:
- PaymentLink
parameters:
- name: lotNumber
in: path
description: >-
Lot number of the bills to pay. All bills with this lot number will
be included.
required: true
schema:
type: string
- name: entryPoint
in: query
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: vendorNumber
in: query
description: The vendor number for the vendor being paid with this payment link.
required: true
schema:
type: string
- name: mail2
in: query
description: >-
List of recipient email addresses. When there is more than one,
separate them by a semicolon (;).
required: false
schema:
type: string
nullable: true
- name: amountFixed
in: query
description: >-
Indicates whether customer can modify the payment amount. A value of
`true` means the amount isn't modifiable, a value `false` means the
payor can modify the amount to pay.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
summary: Generate payment link from lot number
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentPageRequestBodyOut'
/PaymentLink/out/{paylinkId}:
patch:
description: >-
Partially updates a Pay Out payment link's content, expiration date,
and/or status. Use this to modify the payment page configuration, extend
or change the expiration, or cancel a link. Updating the expiration date
of an expired link reactivates it to Active status.
operationId: paymentLink_patchOutPaymentLink
tags:
- PaymentLink
parameters:
- name: paylinkId
in: path
description: ID for the payment link.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update Pay Out payment link
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchOutPaymentLinkRequest'
/PaymentLink/updateOut/{paylinkId}:
patch:
description: >-
Updates the payment page content for a Pay Out payment link. Use this to
change the branding, messaging, payment methods offered, or other page
configuration.
operationId: paymentLink_updatePayLinkOutFromId
tags:
- PaymentLink
parameters:
- name: paylinkId
in: path
description: ID for the payment link.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update Pay Out payment link content
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentPageRequestBodyOut'
/PaymentMethodDomain:
post:
description: Add a payment method domain to an organization or paypoint.
operationId: paymentMethodDomain_AddPaymentMethodDomain
tags:
- PaymentMethodDomain
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddPaymentMethodDomainApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add a payment method domain
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
applePay:
$ref: '#/components/schemas/AddPaymentMethodDomainRequestApplePay'
nullable: true
description: Apple Pay configuration information.
googlePay:
$ref: '#/components/schemas/AddPaymentMethodDomainRequestGooglePay'
nullable: true
description: Google Pay configuration information.
domainName:
$ref: '#/components/schemas/DomainName'
nullable: true
entityId:
$ref: '#/components/schemas/EntityId'
nullable: true
entityType:
$ref: '#/components/schemas/EntityType'
nullable: true
/PaymentMethodDomain/{domainId}/cascade:
post:
description: >-
Cascades a payment method domain to all child entities. All paypoints
and suborganization under this parent will inherit this domain and its
settings.
operationId: paymentMethodDomain_CascadePaymentMethodDomain
tags:
- PaymentMethodDomain
parameters:
- name: domainId
in: path
description: The payment method domain's ID in Payabli.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodDomainGeneralResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Cascade a payment method domain to the child entities
security: *ref_0
/PaymentMethodDomain/{domainId}:
delete:
description: >-
Delete a payment method domain. You can't delete an inherited domain,
you must delete a domain at the organization level.
operationId: paymentMethodDomain_DeletePaymentMethodDomain
tags:
- PaymentMethodDomain
parameters:
- name: domainId
in: path
description: The payment method domain's ID in Payabli.
required: true
schema:
type: string
responses:
'200':
description: Success response for a deleted payment method domain.
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePaymentMethodDomainResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete a payment method domain
security: *ref_0
get:
description: Get the details for a payment method domain.
operationId: paymentMethodDomain_GetPaymentMethodDomain
tags:
- PaymentMethodDomain
parameters:
- name: domainId
in: path
description: The payment method domain's ID in Payabli.
required: true
schema:
type: string
responses:
'200':
description: Success response that includes a payment method domain's details.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodDomainApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get payment method domain details
security: *ref_0
patch:
description: Update a payment method domain's configuration values.
operationId: paymentMethodDomain_UpdatePaymentMethodDomain
tags:
- PaymentMethodDomain
parameters:
- name: domainId
in: path
description: The payment method domain's ID in Payabli.
required: true
schema:
type: string
responses:
'200':
description: Success response for configuration update.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodDomainGeneralResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update payment method domain configuration
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
applePay:
$ref: '#/components/schemas/UpdatePaymentMethodDomainRequestWallet'
nullable: true
googlePay:
$ref: '#/components/schemas/UpdatePaymentMethodDomainRequestWallet'
nullable: true
/PaymentMethodDomain/list:
get:
description: >-
Get a list of payment method domains that belong to a PSP, organization,
or paypoint.
operationId: paymentMethodDomain_ListPaymentMethodDomains
tags:
- PaymentMethodDomain
parameters:
- name: entityId
in: query
description: >-
Identifier for the organization or paypoint.
- For organization, provide the organization ID - For paypoint,
provide the paypoint ID
required: false
schema:
type: integer
format: int64
nullable: true
- name: entityType
in: query
description: |-
The type of entity. Valid values:
- organization
- paypoint
- psp
required: false
schema:
type: string
nullable: true
- name: fromRecord
in: query
description: Number of records to skip. Defaults to `0`.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: Max number of records for query response. Defaults to `20`.
required: false
schema:
type: integer
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPaymentMethodDomainsResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: List payment method domains for an entity
security: *ref_0
/PaymentMethodDomain/{domainId}/verify:
post:
description: >-
Verify a new payment method domain. If verification is successful, Apple
Pay is automatically activated for the domain.
operationId: paymentMethodDomain_VerifyPaymentMethodDomain
tags:
- PaymentMethodDomain
parameters:
- name: domainId
in: path
description: The payment method domain's ID in Payabli.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodDomainGeneralResponse'
summary: Verify a payment method domain
security: *ref_0
/PayoutSubscription:
post:
description: >-
Creates a payout subscription to automatically send payouts to a vendor
on a recurring schedule. See [Manage payout
subscriptions](/guides/pay-out-developer-payout-subscriptions-manage)
for a step-by-step guide.
operationId: payoutSubscription_CreatePayoutSubscription
tags:
- PayoutSubscription
parameters:
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddPayoutSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Create payout subscription
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PayoutSubscriptionRequestBody'
/PayoutSubscription/{id}:
get:
description: >-
Retrieves a single payout subscription's details. See [Manage payout
subscriptions](/guides/pay-out-developer-payout-subscriptions-manage)
for more information.
operationId: payoutSubscription_GetPayoutSubscription
tags:
- PayoutSubscription
parameters:
- name: id
in: path
description: The payout subscription ID.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPayoutSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get a payout subscription
security: *ref_0
put:
description: >-
Updates a payout subscription's details. See [Manage payout
subscriptions](/guides/pay-out-developer-payout-subscriptions-manage)
for more information.
operationId: payoutSubscription_UpdatePayoutSubscription
tags:
- PayoutSubscription
parameters:
- name: id
in: path
description: The payout subscription ID.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePayoutSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update a payout subscription
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePayoutSubscriptionBody'
delete:
description: >-
Deletes a payout subscription and prevents future payouts. See [Manage
payout
subscriptions](/guides/pay-out-developer-payout-subscriptions-manage)
for more information.
operationId: payoutSubscription_DeletePayoutSubscription
tags:
- PayoutSubscription
parameters:
- name: id
in: path
description: The payout subscription ID.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePayoutSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete a payout subscription
security: *ref_0
/Paypoint/basic/{entry}:
get:
description: Gets the basic details for a paypoint.
operationId: paypoint_getBasicEntry
tags:
- Paypoint
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetBasicEntryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get basic paypoint details
security: *ref_0
/Paypoint/basicById/{IdPaypoint}:
get:
description: 'Retrieves the basic details for a paypoint by ID. '
operationId: paypoint_getBasicEntryById
tags:
- Paypoint
parameters:
- name: IdPaypoint
in: path
description: >-
Paypoint ID. You can find this value by querying
`/api/Query/paypoints/{orgId}`
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetBasicEntryByIdResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get paypoint details by ID
security: *ref_0
/Paypoint/logo/{entry}:
put:
description: 'Updates a paypoint logo. '
operationId: paypoint_saveLogo
tags:
- Paypoint
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update paypoint logo
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FileContent'
/Paypoint/settings/{entry}:
get:
description: >-
Retrieves an paypoint's basic settings like custom fields, identifiers,
and invoicing settings.
operationId: paypoint_settingsPage
tags:
- Paypoint
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get paypoint settings
security: *ref_0
/Paypoint/migrate:
post:
description: Migrates a paypoint to a new parent organization.
operationId: paypoint_migrate
tags:
- Paypoint
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/MigratePaypointResponse'
summary: Migrate paypoint
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaypointMoveRequest'
/Query/batchDetails/{entry}:
get:
description: >-
Retrieve a list of batches and their details, including settled and
unsettled transactions for a paypoint. Use filters to limit results.
Include the `exportFormat` query parameter to return the results as a
file instead of a JSON response.
operationId: query_ListBatchDetails
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#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` returns all records with a
`settledAmount` greater than 20.00.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBatchesDetailResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: >-
Get a list of settled and unsettled transactions in batches for a
paypoint
security: *ref_0
/Query/batchDetails/org/{orgId}:
get:
description: >-
Retrieve a list of batches and their details, including settled and
unsettled transactions for an organization. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListBatchDetailsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#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` returns all records with a
`settledAmount` greater than 20.00.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseSettlements'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of settled and unsettled transactions in batches for an org
security: *ref_0
/Query/batches/{entry}:
get:
description: >-
Retrieve a list of batches for a paypoint. Use filters to limit results.
Include the `exportFormat` query parameter to return the results as a
file instead of a JSON response.
operationId: query_ListBatches
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `method` (in, nin, eq, ne)
- `connectorName` (ne, eq, ct, nct)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `feeBatchAmount` (gt, ge, lt, le, eq, ne)
- `netBatchAmount` (gt, ge, lt, le, eq, ne)
- `releaseAmount` (gt, ge, lt, le, eq, ne)
- `heldAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
- `expectedDepositDate` (gt, ge, lt, le, eq, ne)
- `depositDate` (gt, ge, lt, le, eq, ne)
- `batchRecords` (gt, ge, lt, le, eq, ne)
- `transferId` (ne, eq)
- `transferDate` (gt, ge, lt, le, eq, ne)
- `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)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
**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: `batchAmount(gt)=20` returns all records with a
`batchAmount` greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBatchesResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of batches for a paypoint
security: *ref_0
/Query/batches/org/{orgId}:
get:
description: >-
Retrieve a list of batches for an org. Use filters to limit results.
Include the `exportFormat` query parameter to return the results as a
file instead of a JSON response.
operationId: query_ListBatchesOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `method` (in, nin, eq, ne)
- `connectorName` (ne, eq, ct, nct)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `feeBatchAmount` (gt, ge, lt, le, eq, ne)
- `netBatchAmount` (gt, ge, lt, le, eq, ne)
- `releaseAmount` (gt, ge, lt, le, eq, ne)
- `heldAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
- `expectedDepositDate` (gt, ge, lt, le, eq, ne)
- `depositDate` (gt, ge, lt, le, eq, ne)
- `batchRecords` (gt, ge, lt, le, eq, ne)
- `transferId` (ne, eq)
- `transferDate` (gt, ge, lt, le, eq, ne)
- `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)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
**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: `batchAmount(gt)=20` returns all records with a
`batchAmount` greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBatchesResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of batches for an organization
security: *ref_0
/Query/batchesOut/{entry}:
get:
description: >-
Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListBatchesOut
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query. See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted**:
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `parentOrgId` (ne, eq, nin, in)
- `status` (in, nin, eq, ne)
- `orgId` (eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBatchesOutResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of MoneyOut batches for a paypoint
security: *ref_0
/Query/batchesOut/org/{orgId}:
get:
description: >-
Retrieve a list of MoneyOut batches for an org. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListBatchesOutOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted**:
- `batchDate` (gt, ge, lt, le, eq, ne)
- `batchNumber` (ne, eq)
- `batchAmount` (gt, ge, lt, le, eq, ne)
- `parentOrgId` (ne, eq, nin, in)
- `status` (in, nin, eq, ne)
- `orgId` (eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `paypointId` (ne, eq)
- `externalPaypointID` (ct, nct, eq, ne)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBatchesOutResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of MoneyOut batches for an org
security: *ref_0
/Query/chargebacks/{entry}:
get:
description: >-
Retrieves a list of chargebacks and returned transactions for a
paypoint. Use filters to limit results. Include the `exportFormat` query
parameter to return the results as a file instead of a JSON response.
operationId: query_ListChargebacks
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**List of field names accepted:**
- `chargebackDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `reasonCode` (in, nin, eq, ne)
- `reason` (ct, nct, eq, ne)
- `replyDate` (gt, ge, lt, le, eq, ne)
- `caseNumber` (ct, nct, eq, ne)
- `status` (in, nin, eq, ne)
- `accountType` (in, nin, 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*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
**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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryChargebacksResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of chargebacks and returned transactions for a paypoint
security: *ref_0
/Query/chargebacks/org/{orgId}:
get:
description: >-
Retrieve a list of chargebacks and returned transactions for an org. Use
filters to limit results. Include the `exportFormat` query parameter to
return the results as a file instead of a JSON response.
operationId: query_ListChargebacksOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**List of field names accepted:**
- `chargebackDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct)
- `method` (in, nin, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `reasonCode` (in, nin, eq, ne)
- `reason` (ct, nct, eq, ne)
- `replyDate` (gt, ge, lt, le, eq, ne)
- `caseNumber` (ct, nct, eq, ne)
- `status` (in, nin, eq, ne)
- `accountType` (in, nin, 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*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
**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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryChargebacksResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of chargebacks and returned transactions for an org
security: *ref_0
/Query/customers/{entry}:
get:
description: >-
Retrieves a list of customers for a paypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListCustomers
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more details.
**List of Accepted Field Names:**
- `createdDate` (gt, ge, lt, le, eq, ne)
- `customernumber` (ne, eq, ct, nct)
- `firstname` (ne, eq, ct, nct)
- `lastname` (ne, eq, ct, nct)
- `name` (ct, nct)
- `address` (ne, eq, ct, nct)
- `city` (ne, eq, ct, nct)
- `country` (ne, eq, ct, nct)
- `zip` (ne, eq, ct, nct)
- `state` (ne, eq, ct, nct)
- `shippingaddress` (ne, eq, ct, nct)
- `shippingcity` (ne, eq, ct, nct)
- `shippingcountry` (ne, eq, ct, nct)
- `shippingzip` (ne, eq, ct, nct)
- `shippingstate` (ne, eq, ct, nct)
- `phone` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `company` (ne, eq, ct, nct)
- `username` (ne, eq, ct, nct)
- `balance` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
- `orgId` (eq) *mandatory when entry=org*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
**List of Accepted Comparisons:**
- `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 "|"
**Accepted Parameters:**
- `limitRecord`: Max number of records for query (default="20", "0"
or negative value for all)
- `fromRecord`: Initial record in query
**Example Usage:**
`balance(gt)=20` will return all records with a balance greater than
20.00.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryCustomerResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of customers for a paypoint
security: *ref_0
/Query/customers/org/{orgId}:
get:
description: >-
Retrieves a list of customers for an org. Use filters to limit results.
Include the `exportFormat` query parameter to return the results as a
file instead of a JSON response.
operationId: query_ListCustomersOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more details.
**List of Accepted Field Names:**
- `createdDate` (gt, ge, lt, le, eq, ne)
- `customernumber` (ne, eq, ct, nct)
- `firstname` (ne, eq, ct, nct)
- `lastname` (ne, eq, ct, nct)
- `name` (ct, nct)
- `address` (ne, eq, ct, nct)
- `city` (ne, eq, ct, nct)
- `country` (ne, eq, ct, nct)
- `zip` (ne, eq, ct, nct)
- `state` (ne, eq, ct, nct)
- `shippingaddress` (ne, eq, ct, nct)
- `shippingcity` (ne, eq, ct, nct)
- `shippingcountry` (ne, eq, ct, nct)
- `shippingzip` (ne, eq, ct, nct)
- `shippingstate` (ne, eq, ct, nct)
- `phone` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `company` (ne, eq, ct, nct)
- `username` (ne, eq, ct, nct)
- `balance` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
- `orgId` (eq) *mandatory when entry=org*
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
**List of Accepted Comparisons:**
- `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 "|"
**Accepted Parameters:**
- `limitRecord`: Max number of records for query (default="20", "0"
or negative value for all)
- `fromRecord`: Initial record in query
**Example Usage:**
`balance(gt)=20` will return all records with a balance greater than
20.00.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryCustomerResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of customers for an org
security: *ref_0
/Query/notificationReports/{entry}:
get:
description: >-
Returns a list of all reports generated in the last 60 days for a single
entrypoint. Use filters to limit results.
operationId: query_ListNotificationReports
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `reportName` (ct, nct, eq, ne)
- `createdAt` (gt, ge, lt, le, 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
- nin => not inside array
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: reportName(ct)=tr return all records containing the string
"tr"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseNotificationReports'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of reports generated in last 60 days for entrypoint
security: *ref_0
/Query/notificationReports/org/{orgId}:
get:
description: >-
Returns a list of all reports generated in the last 60 days for an
organization. Use filters to limit results.
operationId: query_ListNotificationReportsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `reportName` (ct, nct, eq, ne)
- `createdAt` (gt, ge, lt, le, 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
- nin => not inside array
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: reportName(ct)=tr return all records containing the string
"tr"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseNotificationReports'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of reports generated in last 60 days for organization
security: *ref_0
/Query/notifications/{entry}:
get:
description: >-
Returns a list of notifications for an entrypoint. Use filters to limit
results.
operationId: query_ListNotifications
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `frequency` (in, nin,ne, eq)
- `method` (in, nin, eq, ne)
- `event` (in, nin, eq, ne)
- `target` (ct, nct, eq, ne)
- `status` (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
- nin => not inside array
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: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseNotifications'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of notifications for an entrypoint
security: *ref_0
/Query/notifications/org/{orgId}:
get:
description: >-
Return a list of notifications for an organization. Use filters to limit
results.
operationId: query_ListNotificationsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `frequency` (in, nin,ne, eq)
- `method` (in, nin, eq, ne)
- `event` (in, nin, eq, ne)
- `target` (ct, nct, eq, ne)
- `status` (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
- nin => not inside array
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: totalAmount(gt)=20 return all records with totalAmount
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseNotifications'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of notifications for organization
security: *ref_0
/Query/organizations/{orgId}:
get:
description: >-
Retrieves a list of an organization's suborganizations and their full
details such as orgId, users, and settings. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListOrganizations
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
**List of field names accepted:**
- `createdAt` (gt, ge, lt, le, eq, ne)
- `startDate` (gt, ge, lt, le, eq, ne)
- `dbaname` (ct, nct)
- `legalname` (ct, nct)
- `ein` (ct, nct)
- `address` (ct, nct)
- `city` (ct, nct)
- `state` (ct, nct)
- `phone` (ct, nct)
- `mcc` (ct, nct)
- `owntype` (ct, nct)
- `ownerName` (ct, nct)
- `contactName` (ct, nct)
- `orgParentname` (ct, nct)
- `boardingId` (eq, ne)
- `entryName` (ct, nct)
**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
- `nin` => not inside array
**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: `dbaname(ct)=hoa` returns all records with a `dbaname`
containing "hoa"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrganizationsResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of organizations for a parent
security: *ref_0
/Query/payouts/{entry}:
get:
description: >-
Retrieves a list of money out transactions (payouts) for a paypoint. Use
filters to limit results. Include the `exportFormat` query parameter to
return the results as a file instead of a JSON response.
operationId: query_ListPayout
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
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)
- `parentOrgId` (ne, eq, nin, in)
- `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)
- `AchTraceNumber` (eq, ne)
- `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
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 a `netAmount` greater than 20.00
Example: `sortBy=desc(netamount)` returns all records sorted by `netAmount` descending
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryPayoutTransaction'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of money out transactions for paypoint
security: *ref_0
/Query/payouts/org/{orgId}:
get:
description: >-
Retrieves a list of money out transactions (payouts) for an
organization. Use filters to limit results. Include the `exportFormat`
query parameter to return the results as a file instead of a JSON
response.
operationId: query_ListPayoutOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
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)
- `parentOrgId` (ne, eq, nin, in)
- `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)
- `AchTraceNumber` (eq, ne)
- `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
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 a `netAmount` greater than 20.00
Example: `sortBy=desc(netamount)` returns all records sorted by `netAmount` descending
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryPayoutTransaction'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of money out transactions for organization
security: *ref_0
/Query/paypoints/{orgId}:
get:
description: >-
Returns a list of paypoints in an organization. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListPaypoints
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
**List of field names accepted:**
- `createdAt` (gt, ge, lt, le, eq, ne)
- `lastModified` (gt, ge, lt, le, eq, ne)
- `startDate` (gt, ge, lt, le, eq, ne)
- `dbaname` (ct, nct)
- `status` (eq, ne)
- `legalname` (ct, nct)
- `externalPaypointID` (ct, nct)
- `ein` (ct, nct)
- `address` (ct, nct)
- `city` (ct, nct)
- `state` (ct, nct)
- `phone` (ct, nct)
- `mcc` (ct, nct)
- `owntype` (ct, nct)
- `ownerName` (ct, nct)
- `contactName` (ct, nct)
- `paypointId` (eq, ne)
- `orgParentname` (ct, nct, in, nin)
- `boardingId` (eq, ne)
- `entryName` (ct, nct)
- `externalOrgID` (ct, nct)
**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
- `nin` => not inside array
**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: `dbaname(ct)=hoa` returns all records with a `dbaname`
containing "hoa"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryEntrypointResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of paypoints for an organization
security: *ref_0
/Query/settlements/{entry}:
get:
description: >-
Retrieve a list of settled transactions for a paypoint. Use filters to
limit results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListSettlements
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#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` returns all records with a
`settledAmount` greater than 20.00.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseSettlements'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of settled transactions for a paypoint
security: *ref_0
/Query/settlements/org/{orgId}:
get:
description: >-
Retrieve a list of settled transactions for an organization. Include the
`exportFormat` query parameter to return the results as a file instead
of a JSON response.
operationId: query_ListSettlementsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#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` returns all records with a
`settledAmount` greater than 20.00.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseSettlements'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of settled transactions for an org
security: *ref_0
/Query/subscriptions/{entry}:
get:
description: >-
Returns a list of subscriptions for a single paypoint. Use filters to
limit results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListSubscriptions
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `startDate` (gt, ge, lt, le, eq, ne)
- `endDate` (gt, ge, lt, le, eq, ne)
- `nextDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin, ne, eq)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `untilcancelled` (eq, ne)
- `payaccountLastfour` (nct, ct)
- `payaccountType` (ne, eq, in, nin)
- `payaccountCurrency` (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)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `externalPaypointId` (ct, nct, ne, eq)
- `subId` (eq, ne)
- `orderDescription` (ct, nct)
- `cycles` (eq, ne, gt, ge, lt, le)
- `leftcycles` (eq, ne, gt, ge, lt, le)
- `createdAt` (eq, ne, gt, ge, lt, le)
- `updatedOn` (eq, ne, gt, ge, lt, le)
- `invoiceNumber` (ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
**List of comparison operators 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
- `nin` => not inside array
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QuerySubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of subscriptions for a paypoint
security: *ref_0
/Query/subscriptions/org/{orgId}:
get:
description: >-
Returns a list of subscriptions for a single org. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListSubscriptionsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `startDate` (gt, ge, lt, le, eq, ne)
- `endDate` (gt, ge, lt, le, eq, ne)
- `nextDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin, ne, eq)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `untilcancelled` (eq, ne)
- `payaccountLastfour` (nct, ct)
- `payaccountType` (ne, eq, in, nin)
- `payaccountCurrency` (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)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `externalPaypointId` (ct, nct, ne, eq)
- `subId` (eq, ne)
- `orderDescription` (ct, nct)
- `cycles` (eq, ne, gt, ge, lt, le)
- `leftcycles` (eq, ne, gt, ge, lt, le)
- `createdAt` (eq, ne, gt, ge, lt, le)
- `updatedOn` (eq, ne, gt, ge, lt, le)
- `invoiceNumber` (ct, nct)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name
**List of comparison operators 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
- `nin` => not inside array
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QuerySubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of subscriptions for an org
security: *ref_0
/Query/payoutsubscriptions/{entry}:
get:
description: >-
Returns a list of payout subscriptions for a single paypoint. Use
filters to limit results. Include the `exportFormat` query parameter to
return the results as a file instead of a JSON response. See [Manage
payout
subscriptions](/guides/pay-out-developer-payout-subscriptions-manage)
for more information.
operationId: query_ListPayoutSubscriptions
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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/payoutsubscriptions/entry123?parameters=totalAmount(gt)=1000&limitRecord=20
should become:
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?totalAmount(gt)=1000&limitRecord=20
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `startDate` (gt, ge, lt, le, eq, ne)
- `endDate` (gt, ge, lt, le, eq, ne)
- `nextDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin, ne, eq)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `untilcancelled` (eq, ne)
- `payaccountLastfour` (ct, nct)
- `payaccountType` (ne, eq, in, nin)
- `payaccountCurrency` (ne, eq, in, nin)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct, nin, in)
- `parentOrgId` (ne, eq, nin, in)
- `subscriptionId` (eq, ne)
- `orderDescription` (ct, nct)
- `cycles` (eq, ne, gt, ge, lt, le)
- `leftcycles` (eq, ne, gt, ge, lt, le)
- `createdAt` (eq, ne, gt, ge, lt, le)
- `updatedOn` (eq, ne, gt, ge, lt, le)
- `vendorNumber` (ne, eq, ct, nct)
- `name` (ne, eq, ct, nct)
- `phone` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `address` (ne, eq, ct, nct)
- `remitAddress` (ct, nct)
- `city` (ne, eq, ct, nct)
- `state` (ne, eq, ct, nct)
- `country` (ne, eq, ct, nct)
- `zip` (ne, eq, ct, nct)
**List of comparison operators 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
- `nin` => not inside array
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryPayoutSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of payout subscriptions for a paypoint
security: *ref_0
/Query/payoutsubscriptions/org/{orgId}:
get:
description: >-
Returns a list of payout subscriptions for a single org. Use filters to
limit results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response. See [Manage payout
subscriptions](/guides/pay-out-developer-payout-subscriptions-manage)
for more information.
operationId: query_ListPayoutSubscriptionsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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/payoutsubscriptions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
should become:
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?totalAmount(gt)=1000&limitRecord=20
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `startDate` (gt, ge, lt, le, eq, ne)
- `endDate` (gt, ge, lt, le, eq, ne)
- `nextDate` (gt, ge, lt, le, eq, ne)
- `frequency` (in, nin, ne, eq)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `status` (in, nin, eq, ne)
- `untilcancelled` (eq, ne)
- `payaccountLastfour` (ct, nct)
- `payaccountType` (ne, eq, in, nin)
- `payaccountCurrency` (ne, eq, in, nin)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct, nin, in)
- `parentOrgId` (ne, eq, nin, in)
- `subscriptionId` (eq, ne)
- `orderDescription` (ct, nct)
- `cycles` (eq, ne, gt, ge, lt, le)
- `leftcycles` (eq, ne, gt, ge, lt, le)
- `createdAt` (eq, ne, gt, ge, lt, le)
- `updatedOn` (eq, ne, gt, ge, lt, le)
- `vendorNumber` (ne, eq, ct, nct)
- `name` (ne, eq, ct, nct)
- `phone` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `address` (ne, eq, ct, nct)
- `remitAddress` (ct, nct)
- `city` (ne, eq, ct, nct)
- `state` (ne, eq, ct, nct)
- `country` (ne, eq, ct, nct)
- `zip` (ne, eq, ct, nct)
**List of comparison operators 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
- `nin` => not inside array
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryPayoutSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of payout subscriptions for an org
security: *ref_0
/Query/transactions/{entry}:
get:
description: >-
Retrieve a list of transactions for a paypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
By default, this endpoint returns only transactions from the last 60
days. To query transactions outside of this period, include
`transactionDate` filters.
For example, this request parameters filter for transactions between
April 01, 2024 and April 09, 2024.
``` curl -X GET
https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
-H 'requestToken: '
```
operationId: query_ListTransactions
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `transactionDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct, in, nin)
- `gatewayTransId` (ne, eq, ct, nct)
- `orderId` (ne, eq)
- `scheduleId` (ne, eq)
- `returnId` (ne, eq)
- `refundId` (ne, eq)
- `idTrans` (ne, eq)
- `orgId` (ne, eq)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `externalPaypointId` (ct, nct, eq, ne)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `operation` (in, nin, eq, ne)
- `source` (in, nin, eq, ne, ct, nct)
- `status` (in, nin, eq, ne)
- `settlementStatus` (in, nin, eq, ne)
- `batchNumber` (nct, ct)
- `invoiceNumber` (ct, nct)
- `ipAddress` (eq, ne)
- `authCode` (ct, nct)
- `orderDescription` (ct, nct)
- `payaccountLastfour` (nct, ct)
- `payaccountType` (ne, eq, in, nin)
- `payaccountCurrency` (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)
- `deviceId` (ct, nct, in, nin, eq, ne)
- `AchSecCode` ( ct, nct, in, nin, eq, ne)
- `AchHolderType` (ct, nct, in, nin, eq, and ne)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name related to customer data
- 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the
additional field name related to invoice data
**List of comparison operators 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
- `nin` => not inside array
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseTransactions'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of transactions for a paypoint
security: *ref_0
/Query/transactions/org/{orgId}:
get:
description: >-
Retrieve a list of transactions for an organization. Use filters to
limit results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
By default, this endpoint returns only transactions from the last 60
days. To query transactions outside of this period, include
`transactionDate` filters.
For example, this request parameters filter for transactions between
April 01, 2024 and April 09, 2024.
```
curl -X GET
"https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
-H 'requestToken: '
```
operationId: query_ListTransactionsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**List of field names accepted:**
- `transactionDate` (gt, ge, lt, le, eq, ne)
- `transId` (ne, eq, ct, nct, in, nin)
- `gatewayTransId` (ne, eq, ct, nct)
- `orderId` (ne, eq)
- `scheduleId` (ne, eq)
- `returnId` (ne, eq)
- `refundId` (ne, eq)
- `idTrans` (ne, eq)
- `orgId` (ne, eq)
- `paypointId` (ne, eq)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `externalPaypointId` (ct, nct, eq, ne)
- `method` (in, nin, eq, ne)
- `totalAmount` (gt, ge, lt, le, eq, ne)
- `netAmount` (gt, ge, lt, le, eq, ne)
- `feeAmount` (gt, ge, lt, le, eq, ne)
- `operation` (in, nin, eq, ne)
- `source` (in, nin, eq, ne, ct, nct)
- `status` (in, nin, eq, ne)
- `settlementStatus` (in, nin, eq, ne)
- `batchNumber` (nct, ct)
- `invoiceNumber` (ct, nct)
- `authCode` (ct, nct)
- `orderDescription` (ct, nct)
- `payaccountLastfour` (nct, ct)
- `payaccountType` (ne, eq, in, nin)
- `payaccountCurrency` (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)
- `deviceId` (ct, nct, in, nin, eq, ne)
- `AchSecCode` ( ct, nct, in, nin, eq, ne)
- `AchHolderType`` (ct, nct, in, nin, eq, and ne)
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional
field name related to customer data
- 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the
additional field name related to invoice data
**List of comparison operators 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
- `nin` => not inside array
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseTransactions'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of transactions for an organization
security: *ref_0
/Query/transferDetails/{entry}/{transferId}:
get:
description: >-
Retrieve a list of transfer details records for a paypoint. Use filters
to limit results. Include the `exportFormat` query parameter to return
the results as a file instead of a JSON response.
operationId: query_ListTransferDetails
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: transferId
in: path
description: The numeric identifier for the transfer, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
required: false
schema:
$ref: '#/components/schemas/limitRecord'
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter
the query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#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)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryTransferDetailResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get transfer details for a paypoint
security: *ref_0
/Query/transfers/{entry}:
get:
description: >-
Retrieve a list of transfers for a paypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListTransfers
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query. See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**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
List of field names accepted:
- `transferDate` (gt, ge, lt, le, eq, ne)
- `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)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
- `batchNumber` (ne, eq, ct, nct)
- `batchId` (ne, eq, in, nin)
- `transferId` (in, nin, eq, ne)
- `bankAccountNumber` (ct, nct, ne, eq)
- `bankRoutingNumber` (ct, nct, ne, eq)
- `batchCurrency` (in, nin, ne, eq)
- `parentOrgName` (ct, nct, ne, eq)
- `parentOrgId` (ct, nct, ne, eq)
- `externalPaypointID` (ct, nct)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TransferQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of transfers for a paypoint
/Query/transfers/org/{orgId}:
get:
description: >-
Retrieve a list of transfers for an org. Use filters to limit results.
Include the `exportFormat` query parameter to return the results as a
file instead of a JSON response.
operationId: query_ListTransfersOrg
tags:
- Query
parameters:
- name: orgId
in: path
required: true
schema:
$ref: '#/components/schemas/Orgid'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query. See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**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
List of field names accepted:
- `transferDate` (gt, ge, lt, le, eq, ne)
- `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)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
- `batchNumber` (ne, eq, ct, nct)
- `batchId` (ne, eq, in, nin)
- `transferId` (in, nin, eq, ne)
- `bankAccountNumber` (ct, nct, ne, eq)
- `bankRoutingNumber` (ct, nct, ne, eq)
- `batchCurrency` (in, nin, ne, eq)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TransferQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of transfers for an organization
/Query/transfersOut/org/{orgId}:
get:
description: >-
Retrieve a list of outbound transfers for an organization. Use filters
to limit results.
operationId: query_ListTransfersOutOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query. See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**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
List of field names accepted:
- `transferDate` (gt, ge, lt, le, eq, ne)
- `grossAmount` (gt, ge, lt, le, eq, ne)
- `returnedAmount` (gt, ge, lt, le, eq, ne)
- `billingFeeAmount` (gt, ge, lt, le, eq, ne)
- `netFundedAmount` (gt, ge, lt, le, eq, ne)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
- `transferId` (ne, eq, in, nin)
- `paypointLegalName` (ne, eq, ct, nct)
- `paypointDbaName` (ne, eq, ct, nct)
- `batchNumber` (ne, eq, ct, nct)
- `batchId` (ne, eq, in, nin)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TransferOutQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of outbound transfers for an organization
/Query/transfersOut/{entry}:
get:
description: >-
Retrieve a list of outbound transfers for a paypoint. Use filters to
limit results.
operationId: query_ListTransfersOutPaypoint
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query. See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**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
List of field names accepted:
- `transferDate` (gt, ge, lt, le, eq, ne)
- `grossAmount` (gt, ge, lt, le, eq, ne)
- `returnedAmount` (gt, ge, lt, le, eq, ne)
- `billingFeeAmount` (gt, ge, lt, le, eq, ne)
- `netFundedAmount` (gt, ge, lt, le, eq, ne)
- `processor` (ne, eq, ct, nct)
- `transferStatus` (ne, eq, in, nin)
- `transferId` (ne, eq, in, nin)
- `paypointLegalName` (ne, eq, ct, nct)
- `paypointDbaName` (ne, eq, ct, nct)
- `batchNumber` (ne, eq, ct, nct)
- `batchId` (ne, eq, in, nin)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TransferOutQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of outbound transfers for a paypoint
/Query/transferDetailsOut/{entry}/{transferId}:
get:
description: >-
Retrieve details for a specific outbound transfer. Use filters to limit
results.
operationId: query_ListTransferDetailsOut
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: transferId
in: path
description: The numeric identifier for the transfer, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query. See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for more information.
**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
List of field names accepted:
- `grossAmount` (gt, ge, lt, le, eq, ne)
- `returnedAmount` (gt, ge, lt, le, eq, ne)
- `billingFeeAmount` (gt, ge, lt, le, eq, ne)
- `netFundedAmount` (gt, ge, lt, le, eq, ne)
- `adjustmentAmount` (gt, ge, lt, le, eq, ne)
- `transactionId` (eq, ne, in, nin)
- `category` (eq, ne, ct, nct)
- `type` (eq, ne, in, nin)
- `method` (eq, ne, in, nin)
- `walletType` (eq, ne, in, nin)
- `splitFundingAmount` (gt, ge, lt, le, eq, ne)
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TransferOutDetailQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get outbound transfer details
/Query/users/org/{orgId}:
get:
description: Get list of users for an org. Use filters to limit results.
operationId: query_ListUsersOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**List of field names accepted:**
- `createdDate` (gt, ge, lt, le, eq, ne)
- `name` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `status` (in, nin, eq, ne)
- `role.xxx` (ne, eq, ct, nct) where xxx is the role field:
`roleLabel` or `roleValue`
**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
Example: `name(ct)=john` return all records with name containing
'john'.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of users for an org
security: *ref_0
/Query/users/point/{entry}:
get:
description: Get list of users for a paypoint. Use filters to limit results.
operationId: query_ListUsersPaypoint
tags:
- Query
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
**List of field names accepted:**
- `createdDate` (gt, ge, lt, le, eq, ne)
- `name` (ne, eq, ct, nct)
- `email` (ne, eq, ct, nct)
- `status` (in, nin, eq, ne)
- `role.xxx` (ne, eq, ct, nct) where xxx is the role field:
`roleLabel` or `roleValue`
**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
Example: `name(ct)=john` return all records with name containing
'john'
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of users for paypoint
security: *ref_0
/Query/vendors/{entry}:
get:
description: >-
Retrieve a list of vendors for an entrypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListVendors
tags:
- Query
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `method` (in, nin, eq, ne)
- `enrollmentStatus` (in,nin, eq, ne)
- `status` (in, nin, eq, ne)
- `vendorNumber` (ct, nct, eq, ne)
- `name` (ct, nct, eq, ne)
- `ein` (ct, nct, eq, ne)
- `phone` (ct, nct, eq, ne)
- `email` (ct, nct, eq, ne)
- `address` (ct, nct, eq, ne)
- `city` (ct, nct, eq, ne)
- `state` (ct, nct, eq, ne)
- `country` (ct, nct, eq, ne)
- `zip` (ct, nct, eq, ne)
- `mcc` (ct, nct, eq, ne)
- `locationCode` (ct, nct, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `parentOrgId` (ne, eq, nin, in)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseVendors'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of vendors for entrypoint
security: *ref_0
/Query/vendors/org/{orgId}:
get:
description: >-
Retrieve a list of vendors for an organization. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
operationId: query_ListVendorsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `method` (in, nin, eq, ne)
- `enrollmentStatus` (in,nin, eq, ne)
- `status` (in, nin, eq, ne)
- `vendorNumber` (ct, nct, eq, ne)
- `name` (ct, nct, eq, ne)
- `ein` (ct, nct, eq, ne)
- `phone` (ct, nct, eq, ne)
- `email` (ct, nct, eq, ne)
- `address` (ct, nct, eq, ne)
- `city` (ct, nct, eq, ne)
- `state` (ct, nct, eq, ne)
- `country` (ct, nct, eq, ne)
- `zip` (ct, nct, eq, ne)
- `mcc` (ct, nct, eq, ne)
- `locationCode` (ct, nct, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `parentOrgId` (ne, eq, nin, in)
- `orgName` (ne, eq, ct, nct)
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
Example: `netAmount(gt)=20` returns all records with a `netAmount`
greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponseVendors'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of vendors for organization
security: *ref_0
/Query/vcards/{entry}:
get:
description: >-
Retrieve a list of vcards (virtual credit cards) issued for an
entrypoint. Use filters to limit results. Include the `exportFormat`
query parameter to return the results as a file instead of a JSON
response.
operationId: query_ListVcards
tags:
- Query
parameters:
- name: entry
in: path
required: true
schema:
$ref: '#/components/schemas/Entry'
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
List of field names accepted:
- `status` (in, nin, eq, ne)
- `createdAt` (gt, ge, lt, le, eq, ne)
- `cardToken` (ct, nct, eq, ne)
- `lastFour` (ct, nct, eq, ne)
- `expirationDate` (ct, nct, eq, ne)
- `payoutId` (ct, nct, eq, ne, in, nin)
- `vendorId` (ct, nct, eq, ne, in, nin)
- `miscData1` (ct, nct, eq, ne)
- `miscData2` (ct, nct, eq, ne)
- `currentUses` (gt, ge, lt, le, eq, ne)
- `amount` (gt, ge, lt, le, eq, ne)
- `balance` (gt, ge, lt, le, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `externalPaypointId` (ct, nct, eq, ne)
- `paypointId` (in, nin, 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 "|"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/VCardQueryResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get list of virtual cards for entrypoint
security: *ref_0
/Query/vcards/org/{orgId}:
get:
description: >-
Retrieve a list of vcards (virtual credit cards) issued for an
organization. Use filters to limit results. Include the `exportFormat`
query parameter to return the results as a file instead of a JSON
response.
operationId: query_ListVcardsOrg
tags:
- Query
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/ExportFormat'
nullable: true
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
List of field names accepted:
- `status` (in, nin, eq, ne)
- `createdAt` (gt, ge, lt, le, eq, ne)
- `cardToken` (ct, nct, eq, ne)
- `lastFour` (ct, nct, eq, ne)
- `expirationDate` (ct, nct, eq, ne)
- `payoutId` (ct, nct, eq, ne, in, nin)
- `vendorId` (ct, nct, eq, ne, in, nin)
- `miscData1` (ct, nct, eq, ne)
- `miscData2` (ct, nct, eq, ne)
- `currentUses` (gt, ge, lt, le, eq, ne)
- `amount` (gt, ge, lt, le, eq, ne)
- `balance` (gt, ge, lt, le, eq, ne)
- `paypointLegal` (ne, eq, ct, nct)
- `paypointDba` (ne, eq, ct, nct)
- `orgName` (ne, eq, ct, nct)
- `externalPaypointId` (ct, nct, eq, ne)
- `paypointId` (in, nin, 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 "|"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/VCardQueryResponse'
summary: Get list of virtual cards for an organization
security: *ref_0
/Statistic/basic/{mode}/{freq}/{level}/{entryId}:
get:
description: >-
Retrieves the basic statistics for an organization or a paypoint, for a
given time period, grouped by a particular frequency.
operationId: statistic_BasicStats
tags:
- Statistic
parameters:
- name: mode
in: path
description: |-
Mode for the request. Allowed values:
- `custom` - Allows you to set a custom date range
- `ytd` - Year To Date
- `mtd` - Month To Date
- `wtd` - Week To Date
- `today` - All current day
- `m12` - Last 12 months
- `d30` - Last 30 days
- `h24` - Last 24 hours
- `lasty` - Last Year
- `lastm` - Last Month
- `lastw` - Last Week
- `yesterday` - Last Day
required: true
schema:
type: string
- name: freq
in: path
description: |-
Frequency to group series. Allowed values:
- `m` - monthly
- `w` - weekly
- `d` - daily
- `h` - hourly
For example, `w` groups the results by week.
required: true
schema:
type: string
- name: level
in: path
description: |-
The entry level for the request:
- 0 for Organization
- 2 for Paypoint
required: true
schema:
type: integer
- name: entryId
in: path
description: Identifier in Payabli for the entity.
required: true
schema:
type: integer
format: int64
- name: endDate
in: query
description: |-
Used with `custom` mode. The end date for the range.
Valid formats:
- YYYY-mm-dd
- YYYY/mm/dd
- mm-dd-YYYY
- mm/dd/YYYY
required: false
schema:
type: string
nullable: true
- name: parameters
in: query
description: List of parameters.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: startDate
in: query
description: |-
Used with `custom` mode. The start date for the range.
Valid formats:
- YYYY-mm-dd
- YYYY/mm/dd
- mm-dd-YYYY
- mm/dd/YYYY
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StatBasicExtendedQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get Basic statistics for a paypoint or organization
security: *ref_0
/Statistic/customerbasic/{mode}/{freq}/{customerId}:
get:
description: >-
Retrieves the basic statistics for a customer for a specific time
period, grouped by a selected frequency.
operationId: statistic_CustomerBasicStats
tags:
- Statistic
parameters:
- name: mode
in: path
description: |-
Mode for request. Allowed values:
- `ytd` - Year To Date
- `mtd` - Month To Date
- `wtd` - Week To Date
- `today` - All current day
- `m12` - Last 12 months
- `d30` - Last 30 days
- `h24` - Last 24 hours
- `lasty` - Last Year
- `lastm` - Last Month
- `lastw` - Last Week
- `yesterday` - Last Day
required: true
schema:
type: string
- name: freq
in: path
description: |-
Frequency to group series. Allowed values:
- `m` - monthly
- `w` - weekly
- `d` - daily
- `h` - hourly
For example, `w` groups the results by week.
required: true
schema:
type: string
- name: customerId
in: path
description: >-
Payabli-generated customer ID. Maps to "Customer ID" column in
PartnerHub.
required: true
schema:
type: integer
- name: parameters
in: query
description: List of parameters.
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionStatsQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get basic statistics for a customer
security: *ref_0
/Statistic/subscriptions/{interval}/{level}/{entryId}:
get:
description: >-
Retrieves the subscription statistics for a given interval for a
paypoint or organization.
operationId: statistic_SubStats
tags:
- Statistic
parameters:
- name: interval
in: path
description: |-
Interval to get the data. Allowed values:
- `all` - all intervals
- `30` - 1-30 days
- `60` - 31-60 days
- `90` - 61-90 days
- `plus` - +90 days
required: true
schema:
type: string
- name: level
in: path
description: |-
The entry level for the request:
- 0 for Organization
- 2 for Paypoint
required: true
schema:
type: integer
- name: entryId
in: path
description: Identifier in Payabli for the entity.
required: true
schema:
type: integer
format: int64
- name: parameters
in: query
description: List of parameters
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StatBasicQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get subscription statistics for a paypoint or organization
security: *ref_0
/Statistic/vendorbasic/{mode}/{freq}/{idVendor}:
get:
description: >-
Retrieve the basic statistics about a vendor for a given time period,
grouped by frequency.
operationId: statistic_VendorBasicStats
tags:
- Statistic
parameters:
- name: mode
in: path
description: |-
Mode for request. Allowed values:
- `ytd` - Year To Date
- `mtd` - Month To Date
- `wtd` - Week To Date
- `today` - All current day
- `m12` - Last 12 months
- `d30` - Last 30 days
- `h24` - Last 24 hours
- `lasty` - Last Year
- `lastm` - Last Month
- `lastw` - Last Week
- `yesterday` - Last Day
required: true
schema:
type: string
- name: freq
in: path
description: |-
Frequency to group series. Allowed values:
- `m` - monthly
- `w` - weekly
- `d` - daily
- `h` - hourly
For example, `w` groups the results by week.
required: true
schema:
type: string
- name: idVendor
in: path
description: Vendor ID.
required: true
schema:
type: integer
- name: parameters
in: query
description: List of parameters
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StatisticsVendorQueryRecord'
summary: Get basic statistics for a vendor
security: *ref_0
/Subscription/{subId}:
get:
description: Retrieves a single subscription's details.
operationId: subscription_GetSubscription
tags:
- Subscription
parameters:
- name: subId
in: path
description: 'The subscription ID. '
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionQueryRecords'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get a subscription
security: *ref_0
delete:
description: >-
Deletes a subscription, autopay, or recurring payment and prevents
future charges.
operationId: subscription_RemoveSubscription
tags:
- Subscription
parameters:
- name: subId
in: path
description: 'The subscription ID. '
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete a subscription
security: *ref_0
put:
description: Updates a subscription's details.
operationId: subscription_UpdateSubscription
tags:
- Subscription
parameters:
- name: subId
in: path
description: 'The subscription ID. '
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriptionResponse'
summary: Update a subscription
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
paymentDetails:
$ref: '#/components/schemas/PaymentDetail'
nullable: true
description: >-
Object describing details of the payment. To skip the
payment, set the `totalAmount` to 0. Payments will be paused
until the amount is updated to a non-zero value. When
`totalAmount` is set to 0, the `serviceFee` must also be set
to 0.
scheduleDetails:
$ref: '#/components/schemas/ScheduleDetail'
nullable: true
description: Object describing the schedule for subscription
setPause:
$ref: '#/components/schemas/SetPause'
nullable: true
/Subscription/add:
post:
description: >-
Creates a subscription or scheduled payment to run at a specified time
and frequency.
operationId: subscription_NewSubscription
tags:
- Subscription
parameters:
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddSubscriptionResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Create Subscription
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionRequestBody'
/Templates/{templateId}:
delete:
description: 'Deletes a template by ID. '
operationId: templates_DeleteTemplate
tags:
- Templates
parameters:
- name: templateId
in: path
description: >-
The boarding template ID. Can be found at the end of the boarding
template URL in PartnerHub. Example:
`https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`.
Here, the template ID is `80`.
required: true
schema:
type: number
format: double
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseTemplateId'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete boarding template
security: *ref_0
/Templates/getlink/{templateId}/{ignoreEmpty}:
get:
description: Generates a boarding link from a boarding template.
operationId: templates_getlinkTemplate
tags:
- Templates
parameters:
- name: templateId
in: path
description: >-
The boarding template ID. Can be found at the end of the boarding
template URL in PartnerHub. Example:
`https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`.
Here, the template ID is `80`.
required: true
schema:
type: number
format: double
- name: ignoreEmpty
in: path
description: >-
Ignore read-only and empty fields Default is `false`. If
`ignoreEmpty` = `false` and any field is empty, then the request
returns a failure response. If `ignoreEmpty` = `true`, the request
returns the boarding link name regardless of whether fields are
empty.
required: true
schema:
type: boolean
responses:
'200':
description: Success.
content:
application/json:
schema:
$ref: '#/components/schemas/BoardingLinkApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Generate boarding link from template
security: *ref_0
/Templates/get/{templateId}:
get:
description: Retrieves a boarding template's details by ID.
operationId: templates_getTemplate
tags:
- Templates
parameters:
- name: templateId
in: path
description: >-
The boarding template ID. Can be found at the end of the boarding
template URL in PartnerHub. Example:
`https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`.
Here, the template ID is `80`.
required: true
schema:
type: number
format: double
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get boarding template by ID
security: *ref_0
/Query/templates/{orgId}:
get:
description: >-
Retrieves a list of boarding templates for an organization. Use filters
to limit results. You can't make a request that includes filters from
the API console in the documentation. The response won't be filtered.
Instead, copy the request, remove `parameters=` and run the request in a
different client.
operationId: templates_ListTemplates
tags:
- Templates
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
nullable: true
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
nullable: true
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**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
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `createdAt` (gt, ge, lt, le, eq, ne)
- `title` (ct, nct)
- `description` (ct, nct)
- `code` (ct, nct)
- `orgParentname` (ct, nct)
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
- nin => not inside array
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: title(ct)=hoa return all records with title containing
"hoa"
required: false
schema:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
- name: sortBy
in: query
description: >-
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`.
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateQueryResponse'
summary: Get list of boarding templates for organization
security: *ref_0
/TokenStorage/add:
post:
description: >-
Saves a payment method for reuse. This call exchanges sensitive payment
information for a token that can be used to process future transactions.
The `ReferenceId` value in the response is the `storedMethodId` to use
with transactions.
operationId: tokenStorage_AddMethod
tags:
- TokenStorage
parameters:
- name: achValidation
in: query
required: false
schema:
$ref: '#/components/schemas/AchValidation'
nullable: true
- name: createAnonymous
in: query
required: false
schema:
$ref: '#/components/schemas/CreateAnonymous'
nullable: true
- name: forceCustomerCreation
in: query
required: false
schema:
$ref: '#/components/schemas/ForceCustomerCreation'
nullable: true
- name: temporary
in: query
required: false
schema:
$ref: '#/components/schemas/Temporary'
nullable: true
- name: idempotencyKey
in: header
required: false
schema:
$ref: '#/components/schemas/IdempotencyKey'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddMethodResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Save a payment method (tokenize)
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTokenStorage'
/TokenStorage/{methodId}:
get:
description: Retrieves details for a saved payment method.
operationId: tokenStorage_GetMethod
tags:
- TokenStorage
parameters:
- name: methodId
in: path
description: The saved payment method ID.
required: true
schema:
type: string
- name: cardExpirationFormat
in: query
description: >-
Format for card expiration dates in the response.
Accepted values:
- 0: default, no formatting. Expiration dates are returned in the
format they're saved in.
- 1: MMYY
- 2: MM/YY
required: false
schema:
type: integer
nullable: true
- name: includeTemporary
in: query
description: >-
When `true`, the request will include temporary tokens in the search
and return details for a matching temporary token. The default
behavior searches only for permanent tokens.
required: false
schema:
type: boolean
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMethodResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get payment method
security: *ref_0
delete:
description: Deletes a saved payment method.
operationId: tokenStorage_RemoveMethod
tags:
- TokenStorage
parameters:
- name: methodId
in: path
description: The saved payment method ID.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymethodDelete'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Remove a payment method
security: *ref_0
put:
description: Updates a saved payment method.
operationId: tokenStorage_UpdateMethod
tags:
- TokenStorage
parameters:
- name: methodId
in: path
description: The saved payment method ID.
required: true
schema:
type: string
- name: achValidation
in: query
required: false
schema:
$ref: '#/components/schemas/AchValidation'
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponsePaymethodDelete'
summary: Update a payment method
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTokenStorage'
/User:
post:
description: Use this endpoint to add a new user to an organization.
operationId: user_AddUser
tags:
- User
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Add User to an Organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserData'
/User/authrefresh:
post:
description: >-
Use this endpoint to refresh the authentication token for a user within
an organization.
operationId: user_AuthRefreshUser
tags:
- User
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseUserMfa'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Refresh token for User
security: *ref_0
/User/authreset:
post:
description: >-
Use this endpoint to initiate a password reset for a user within an
organization.
operationId: user_AuthResetUser
tags:
- User
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResetUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Reset password for User
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
$ref: '#/components/schemas/Email'
nullable: true
description: The user's email address.
entry:
type: string
nullable: true
description: >-
Identifier for entrypoint originating the request (used by
front-end apps)
entryType:
type: integer
nullable: true
description: >-
Type of entry identifier: 0 - partner, 2 - paypoint. This is
used by front-end apps, required if an Entry is indicated.
/User/auth/{provider}:
post:
description: This endpoint requires an application API token.
operationId: user_AuthUser
tags:
- User
parameters:
- name: provider
in: path
description: >-
Auth provider. This fields is optional and defaults to null for the
built-in provider.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseMfaBasic'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Authenticate User
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
$ref: '#/components/schemas/Email'
nullable: true
entry:
type: string
nullable: true
description: >-
Identifier for entry point originating the request (used by
front-end apps)
entryType:
type: integer
nullable: true
description: >-
Type of entry identifier: 0 - partner, 2 - paypoint. This is
used by front-end apps, required if an Entry is indicated.
psw:
type: string
nullable: true
userId:
type: integer
format: int64
nullable: true
userTokenId:
type: string
nullable: true
/User/authpsw:
put:
description: >-
Use this endpoint to change the password for a user within an
organization.
operationId: user_ChangePswUser
tags:
- User
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ChangePswUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update password for User
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
psw:
type: string
nullable: true
description: New User password
/User/{userId}:
delete:
description: Use this endpoint to delete a specific user within an organization.
operationId: user_DeleteUser
tags:
- User
parameters:
- name: userId
in: path
description: The Payabli-generated `userId` value.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete User in an Organization
security: *ref_0
put:
description: >-
Use this endpoint to modify the details of a specific user within an
organization.
operationId: user_EditUser
tags:
- User
parameters:
- name: userId
in: path
description: User Identifier
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Modify User in an Organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserData'
get:
description: >-
Use this endpoint to retrieve information about a specific user within
an organization.
operationId: user_GetUser
tags:
- User
parameters:
- name: userId
in: path
description: The Payabli-generated `userId` value.
required: true
schema:
type: integer
format: int64
- name: entry
in: query
description: The entrypoint identifier.
required: false
schema:
type: string
nullable: true
- name: level
in: query
description: 'Entry level: 0 - partner, 2 - paypoint'
required: false
schema:
type: integer
nullable: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserQueryRecord'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Get User in an Organization
security: *ref_0
/User/mfa/{userId}:
put:
description: >-
Use this endpoint to enable or disable multi-factor authentication (MFA)
for a user within an organization.
operationId: user_EditMfaUser
tags:
- User
parameters:
- name: userId
in: path
description: User Identifier
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EditMfaUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Enable/ disable MFA for User in an Organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MfaData'
/User/authlogout:
get:
description: Use this endpoint to log a user out from the system.
operationId: user_LogoutUser
tags:
- User
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LogoutUserResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Logout User
security: *ref_0
/User/resendmfa/{usrname}/{Entry}/{EntryType}:
post:
description: >-
Resends the MFA code to the user via the selected MFA mode (email or
SMS).
operationId: user_ResendMFACode
tags:
- User
parameters:
- name: usrname
in: path
description: ' '
required: true
schema:
type: string
- name: Entry
in: path
description: ' '
required: true
schema:
type: string
- name: EntryType
in: path
description: ' '
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseMfaBasic'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Resend MFA code
security: *ref_0
/User/mfa:
post:
description: >-
Use this endpoint to validate the multi-factor authentication (MFA) code
for a user within an organization.
operationId: user_ValidateMfaUser
tags:
- User
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseUserMfa'
summary: Validate MFA for User in an Organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mfaCode:
type: string
nullable: true
mfaValidationCode:
$ref: '#/components/schemas/MfaValidationCode'
nullable: true
/Vendor/single/{entry}:
post:
description: Creates a vendor in an entrypoint.
operationId: vendor_AddVendor
tags:
- Vendor
parameters:
- name: entry
in: path
description: Entrypoint identifier.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseVendors'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Create vendor
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VendorData'
/Vendor/{idVendor}:
delete:
description: 'Delete a vendor. '
operationId: vendor_DeleteVendor
tags:
- Vendor
parameters:
- name: idVendor
in: path
description: Vendor ID.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseVendors'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Delete vendor
security: *ref_0
put:
description: Updates a vendor's information. Send only the fields you need to update.
operationId: vendor_EditVendor
tags:
- Vendor
parameters:
- name: idVendor
in: path
description: Vendor ID.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponseVendors'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Update vendor
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VendorData'
get:
description: Retrieves a vendor's details.
operationId: vendor_GetVendor
tags:
- Vendor
parameters:
- name: idVendor
in: path
description: Vendor ID.
required: true
schema:
type: integer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/VendorQueryRecord'
summary: Get vendor
security: *ref_0
/Wallet/applepay/configure-organization:
post:
description: Configure and activate Apple Pay for a Payabli organization
operationId: wallet_ConfigureApplePayOrganization
tags:
- Wallet
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureApplePayOrganizationApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Configure Apple Pay for an organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cascade:
$ref: '#/components/schemas/Cascade'
nullable: true
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
orgId:
$ref: '#/components/schemas/OrganizationId'
nullable: true
/Wallet/applepay/configure-paypoint:
post:
description: Configure and activate Apple Pay for a Payabli paypoint
operationId: wallet_ConfigureApplePayPaypoint
tags:
- Wallet
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureApplePaypointApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Configure Apple Pay for a paypoint
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
entry:
$ref: '#/components/schemas/Entry'
nullable: true
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
description: When `true`, Apple Pay is enabled.
/Wallet/googlepay/configure-organization:
post:
description: Configure and activate Google Pay for a Payabli organization
operationId: wallet_ConfigureGooglePayOrganization
tags:
- Wallet
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureApplePayOrganizationApiResponse'
'400':
description: ''
content:
application/json:
schema: {}
'401':
description: ''
content:
application/json:
schema: {}
'500':
description: ''
content:
application/json:
schema: {}
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliApiResponse'
summary: Configure Google Pay for an organization
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cascade:
$ref: '#/components/schemas/Cascade'
nullable: true
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
orgId:
$ref: '#/components/schemas/OrganizationId'
nullable: true
/Wallet/googlepay/configure-paypoint:
post:
description: Configure and activate Google Pay for a Payabli paypoint
operationId: wallet_ConfigureGooglePayPaypoint
tags:
- Wallet
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureGooglePaypointApiResponse'
summary: Configure Google Pay for a paypoint
security: *ref_0
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
entry:
$ref: '#/components/schemas/Entry'
nullable: true
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
description: When `true`, Google Pay is enabled.
components:
schemas:
RoomIdNotInUse:
title: RoomIdNotInUse
type: integer
format: int64
description: Field not in use on this endpoint. It always returns `0`.
AchValidation:
title: AchValidation
type: boolean
description: >-
When `true`, enables real-time validation of ACH account and routing
numbers. This is an add-on feature, contact Payabli for more
information.
AcceptOauth:
title: AcceptOauth
type: boolean
AcceptRegister:
title: AcceptRegister
type: boolean
Accountexp:
title: Accountexp
type: string
description: Expiration date of card used in transaction.
AccountId:
title: AccountId
type: string
description: Custom identifier for payment connector.
AccountingField:
title: AccountingField
type: string
description: Optional custom field.
AccountNumber:
title: AccountNumber
type: string
description: >-
Account number for bank account. This value is returned masked in
responses.
Accounttype:
title: Accounttype
type: string
description: Bank account type or card brand.
Accountzip:
title: Accountzip
type: string
description: ZIP code for card used in transaction.
ACH:
title: ACH
type: object
properties:
achAccount:
$ref: '#/components/schemas/Achaccount'
description: Bank account number. This field is **required** when method = `ach`.
achAccountType:
$ref: '#/components/schemas/Achaccounttype'
nullable: true
description: Bank account type. This field is **required** when method = `ach`.
achCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
achHolder:
$ref: '#/components/schemas/AchHolder'
achHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
achRouting:
$ref: '#/components/schemas/Achrouting'
description: >-
ABA/routing number of bank account. This field is **required** when
method is `ach`.
device:
$ref: '#/components/schemas/Device'
nullable: true
method:
type: string
const: ach
required:
- achAccount
- achHolder
- achRouting
- method
AchAbsorbSection:
title: AchAbsorbSection
type: object
properties:
multiTier:
type: boolean
nullable: true
tiers:
type: array
items:
$ref: '#/components/schemas/AchTypesTiers'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
AchAcceptanceElement:
title: AchAcceptanceElement
type: object
properties:
types:
$ref: '#/components/schemas/AchTypes'
nullable: true
posCol:
$ref: '#/components/schemas/PosCol'
nullable: true
posRow:
$ref: '#/components/schemas/PosRow'
nullable: true
readOnly:
$ref: '#/components/schemas/ReadOnly'
nullable: true
value:
$ref: '#/components/schemas/ValueTemplates'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
Achaccount:
title: Achaccount
type: string
description: Bank account number.
Achaccounttype:
title: Achaccounttype
type: string
enum:
- Checking
- Savings
description: 'Bank account type: Checking or Savings.'
AchFeeSection:
title: AchFeeSection
type: object
properties:
advancedSettlementAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
annualAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
chargebackAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
earlyTerminationAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
monthlyAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
quarterlyPCIAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
returnedAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
sameDayAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
sundayOriginationAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
verifyBankAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
verifyFundAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
verifyNegativeAchFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
AchHolder:
title: AchHolder
type: string
description: >-
Bank account holder. This field is **required** when `method` is `ach`
or `check`.
AchHolderType:
title: AchHolderType
type: string
enum:
- personal
- business
description: 'The bank''s accountholder type: personal or business.'
AchLinkTypes:
title: AchLinkTypes
type: object
properties:
ccd:
$ref: '#/components/schemas/LinkData'
nullable: true
ppd:
$ref: '#/components/schemas/LinkData'
nullable: true
web:
$ref: '#/components/schemas/LinkData'
nullable: true
AchPassThroughSection:
title: AchPassThroughSection
type: object
properties:
multiTier:
type: boolean
nullable: true
tiers:
type: array
items:
$ref: '#/components/schemas/AchTypesPass'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
Achrouting:
title: Achrouting
type: string
description: ABA/routing number of Bank account.
AchSecCode:
title: AchSecCode
type: string
description: >-
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 Deposit) - Used for credits or debits where an accountholder authorizes a company to initiate either a single or recurring transaction to their personal bank account. Common examples include direct deposit of payroll, mortgage payments, or utility bills. This is the default value for subscription payments.
- WEB (Internet-Initiated/Mobile Entry) - Used for debit entries when authorization is obtained from an accountholder via the internet or a wireless network. Common examples are online bill payments, ecommerce purchases, and mobile app payments where the consumer enters their banking information online.
- TEL (Telephone-Initiated Entry) - Used for one-time debit entries where authorization is obtained from a consumer via telephone. Common examples are phone-based purchases or bill payments where the consumer provides their banking information over the phone.
- CCD (Corporate Credit or Debit) - Used for fund transfers between business accounts. This code is specifically for business-to-business transactions. Common examples include vendor payments and other business-to-business payments.
- BOC (Back Office Conversion) - Used to convert paper checks received in-person at a point-of-sale or staffed payment location into electronic ACH debits. Required for Remote Deposit Capture (RDC) transactions. Only supports consumer checks; business, government, and mailed checks aren't eligible.
AchSection:
title: AchSection
type: object
properties:
acceptance:
$ref: '#/components/schemas/AchLinkTypes'
nullable: true
fees:
$ref: '#/components/schemas/BasicTable'
nullable: true
price:
$ref: '#/components/schemas/BasicTable'
nullable: true
AchService:
title: AchService
type: object
properties:
achAbsorb:
$ref: '#/components/schemas/AchAbsorbSection'
nullable: true
achAbsorb_highPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
achAbsorb_lowPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
achAcceptance:
$ref: '#/components/schemas/AchAcceptanceElement'
nullable: true
achFees:
$ref: '#/components/schemas/AchFeeSection'
nullable: true
achPass_highPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
achPass_lowPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
achPassThrough:
$ref: '#/components/schemas/AchPassThroughSection'
nullable: true
batchCutoffTime:
$ref: '#/components/schemas/TemplateElement'
nullable: true
description: >-
Controls how to present the `batchCutoffTime` field on the
application. If this field isn't sent, batch cut off time defaults
to 5 ET.
discountFrequency:
$ref: '#/components/schemas/TemplateElement'
nullable: true
fundingRollup:
$ref: '#/components/schemas/TemplateElement'
nullable: true
gateway:
$ref: '#/components/schemas/TemplateElement'
nullable: true
pdfTemplateId:
$ref: '#/components/schemas/TemplateElement'
nullable: true
pricingPlan:
type: integer
format: int64
nullable: true
pricingType:
$ref: '#/components/schemas/TemplateElement'
nullable: true
processor:
$ref: '#/components/schemas/TemplateElement'
nullable: true
provider:
$ref: '#/components/schemas/TemplateElement'
nullable: true
tierName:
$ref: '#/components/schemas/TemplateElement'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
AchSetup:
title: AchSetup
type: object
properties:
acceptCCD:
type: boolean
nullable: true
description: >-
CCD is an ACH SEC Code that can be used in ACH transactions by the
user that indicates the transaction is a Corporate Credit or Debit
Entry. Options are: `true` and `false`
acceptPPD:
type: boolean
nullable: true
description: >-
PPD is an ACH SEC Code that can be used in ACH transactions by the
user that indicates the transaction is a Prearranged Payment and
Deposit.
acceptWeb:
type: boolean
nullable: true
description: >-
Web is an ACH SEC Code that can be used in ACH transactions by the
user that indicates the transaction is a Internet Initiated/Mobile
Entry Options are `true` and `false`.
AchTypes:
title: AchTypes
type: object
properties:
ccd:
$ref: '#/components/schemas/BasicTemplateElement'
nullable: true
ppd:
$ref: '#/components/schemas/BasicTemplateElement'
nullable: true
web:
$ref: '#/components/schemas/BasicTemplateElement'
nullable: true
AchTypesPass:
title: AchTypesPass
type: object
properties:
ccd:
$ref: '#/components/schemas/TierItemPass'
nullable: true
ppd:
$ref: '#/components/schemas/TierItemPass'
nullable: true
web:
$ref: '#/components/schemas/TierItemPass'
nullable: true
AchTypesTiers:
title: AchTypesTiers
type: object
properties:
ccd:
$ref: '#/components/schemas/TierItem'
nullable: true
ppd:
$ref: '#/components/schemas/TierItem'
nullable: true
web:
$ref: '#/components/schemas/TierItem'
nullable: true
AdditionalDataMap:
title: AdditionalDataMap
type: object
additionalProperties:
type: string
description: >-
Custom dictionary of key:value pairs. You can use this field to store
any data related to the object or for your system.
```json
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
```
AdditionalData:
title: AdditionalData
type: object
additionalProperties:
type: object
additionalProperties: true
nullable: true
description: >-
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](/developers/developer-guides/entities-customers),
pass those in this object. Max length for a value is 100 characters.
Example usage:
```json
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
```
AdditionalDataString:
title: AdditionalDataString
type: string
description: >-
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": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
```
AddPaymentMethodDomainApiResponse:
title: AddPaymentMethodDomainApiResponse
type: object
description: Response for the add payment method domain operation.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
responseData:
$ref: '#/components/schemas/PaymentMethodDomainApiResponse'
responseText:
type: string
required:
- isSuccess
- pageidentifier
- responseData
- responseText
AddressAddtlNullable:
title: AddressAddtlNullable
type: string
description: Additional line for the address.
AddressNullable:
title: AddressNullable
type: string
description: The address.
AmountElement:
title: AmountElement
type: object
properties:
categories:
type: array
items:
$ref: '#/components/schemas/PayCategory'
nullable: true
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
order:
$ref: '#/components/schemas/Order'
nullable: true
Annualrevenue:
title: Annualrevenue
type: number
format: double
description: Annual revenue amount.
AppId:
title: AppId
type: integer
description: 'Boarding application ID. '
ApplePayData:
title: ApplePayData
type: object
description: Details about the status of the Apple Pay service.
properties:
data:
$ref: '#/components/schemas/ApplePayStatusData'
nullable: true
description: >-
This object is only returned when the domain verification check
fails. If a domain has failed validation, this object contains
information about the failure.
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
description: When `true`, Apple Pay is enabled.
ApplePayId:
title: ApplePayId
type: string
description: The internal identifier for Apple Pay-related information.
GooglePayData:
title: GooglePayData
type: object
description: Details about the status of the Google Pay service.
properties:
data:
$ref: '#/components/schemas/GooglePayStatusData'
nullable: true
description: >-
This object is only returned when the domain verification check
fails. If a domain has failed validation, this object contains
information about the failure.
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
description: When `true`, Google Pay is enabled.
GooglePayStatusData:
title: GooglePayStatusData
type: object
description: Details about the Google Pay service status.
properties:
errorMessage:
type: string
nullable: true
description: Any error message related to Google Pay's activation status.
metadata:
$ref: '#/components/schemas/GooglePayMetadata'
nullable: true
GooglePayMetadata:
title: GooglePayMetadata
type: object
description: >-
This metadata appears only when the domain verification check fails. It
gives more information about why the check failed.
properties:
statusCode:
type: integer
nullable: true
description: The status code return by the domain verification URL.
redirectUrl:
type: string
nullable: true
description: >-
If the domain verification URL is redirected, this is the URL it's
redirected to. For example, www.partner.com could redirect to
www.partners-new-home-page.com. In this case, you should add
www.partners-new-home-page.com as a domain instead of
www.partner.com.
redirectDomainName:
type: string
nullable: true
description: The domain name if the domain verification URL returns a redirect.
ApplePayMetadata:
title: ApplePayMetadata
type: object
description: >-
This metadata appears only when the domain verification check fails. It
gives more information about why the check failed.
properties:
isFileAvailable:
type: boolean
nullable: true
description: >-
When `true`, indicates whether the domain verification file is
available at the expected path. When `false`, Payabli was unable to
find the file at the expected path. If the file is missing, make
sure it's hosted at the correct path:
`/.well-known/apple-developer-merchantid-domain-association`
isFileContentValid:
type: boolean
nullable: true
description: >-
Indicates whether the domain verification file content is valid. If
the file is invalid, try downloading it and hosting it again.
redirectDomainName:
type: string
nullable: true
description: The domain name if the domain verification URL returns a redirect.
redirectUrl:
type: string
nullable: true
description: >-
If the domain verification URL is redirected, this is the URL it's
redirected to.
For example, www.partner.com could redirect to
www.partners-new-home-page.com. In this case, you should add
www.partners-new-home-page.com as a domain instead of
www.partner.com.
statusCode:
type: integer
nullable: true
description: The status code return by the domain verification URL.
ApplePayOrganizationUpdateData:
title: ApplePayOrganizationUpdateData
type: object
properties:
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
id:
$ref: '#/components/schemas/ApplePayId'
nullable: true
description: Internal ID for the Apple Pay organization update.
jobId:
$ref: '#/components/schemas/JobId'
nullable: true
jobStatus:
$ref: '#/components/schemas/JobStatus'
nullable: true
organizationId:
$ref: '#/components/schemas/OrganizationId'
nullable: true
type:
$ref: '#/components/schemas/ApplePayType'
nullable: true
description: >-
The record type, in this context it will always be
`ApplePayOrganizationUpdate`.
updatedAt:
$ref: '#/components/schemas/LastModified'
nullable: true
updates:
$ref: '#/components/schemas/OrganizationUpdates'
nullable: true
AppleWalletData:
title: AppleWalletData
type: object
description: The wallet data.
properties:
entry:
$ref: '#/components/schemas/Entry'
nullable: true
applePayMerchantId:
type: string
nullable: true
description: The Apple Pay merchant identifier.
domainNames:
type: array
items:
$ref: '#/components/schemas/DomainName'
nullable: true
description: A list of domain names that are enabled for this paypoint.
paypointName:
$ref: '#/components/schemas/PaypointName'
nullable: true
paypointUrl:
type: string
nullable: true
description: The paypoint URL.
markedForDeletionAt:
type: string
format: date-time
nullable: true
description: >-
The date and time a paypoint's Apple Pay registration was scheduled
for deletion. The paypoint will be unregistered from Apple Pay
permanently 30 days from this value.
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
updatedAt:
$ref: '#/components/schemas/LastModified'
nullable: true
id:
$ref: '#/components/schemas/ApplePayId'
nullable: true
description: Internal ID for the Apple Pay paypoint registration update.
type:
$ref: '#/components/schemas/ApplePayType'
nullable: true
description: >-
The record type, in this context it will always be
`ApplePayRegistration`.
GoogleWalletData:
title: GoogleWalletData
type: object
description: The wallet data.
properties:
gatewayMerchantId:
type: string
nullable: true
description: The Google Pay merchant identifier.
gatewayId:
type: string
nullable: true
description: The Google Pay gateway identifier.
ApplePayPaypointRegistrationData:
title: ApplePayPaypointRegistrationData
type: object
properties:
entry:
$ref: '#/components/schemas/Entry'
nullable: true
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
walletType:
type: string
nullable: true
description: The wallet type. In this context it will always be `applePay`.
walletData:
$ref: '#/components/schemas/AppleWalletData'
nullable: true
GooglePayPaypointRegistrationData:
title: GooglePayPaypointRegistrationData
type: object
properties:
entry:
$ref: '#/components/schemas/Entry'
nullable: true
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
walletType:
type: string
nullable: true
description: The wallet type. In this context it will always be `googlePay`.
walletData:
$ref: '#/components/schemas/GoogleWalletData'
nullable: true
ApplePayStatusData:
title: ApplePayStatusData
type: object
description: Details about the Apple Pay service status.
properties:
errorMessage:
type: string
nullable: true
description: Any error message related to Apple Pay's activation status.
metadata:
$ref: '#/components/schemas/ApplePayMetadata'
nullable: true
ApplePayType:
title: ApplePayType
type: string
description: The record type.
ApplicationData:
title: ApplicationData
type: object
properties:
services:
$ref: '#/components/schemas/Services'
nullable: true
annualRevenue:
$ref: '#/components/schemas/Annualrevenue'
nullable: true
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
avgmonthly:
$ref: '#/components/schemas/Avgmonthly'
nullable: true
baddress:
$ref: '#/components/schemas/Baddress1'
nullable: true
baddress1:
$ref: '#/components/schemas/Baddress2'
nullable: true
bankData:
$ref: '#/components/schemas/BankData'
nullable: true
bcity:
$ref: '#/components/schemas/Bcity'
nullable: true
bcountry:
$ref: '#/components/schemas/Bcountry'
nullable: true
binperson:
$ref: '#/components/schemas/Binperson'
nullable: true
binphone:
$ref: '#/components/schemas/Binphone'
nullable: true
binweb:
$ref: '#/components/schemas/Binweb'
nullable: true
bstate:
$ref: '#/components/schemas/Bstate'
nullable: true
bsummary:
$ref: '#/components/schemas/Bsummary'
nullable: true
btype:
$ref: '#/components/schemas/OwnType'
nullable: true
bzip:
$ref: '#/components/schemas/Bzip'
nullable: true
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
dbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
ein:
$ref: '#/components/schemas/Ein'
nullable: true
externalPaypointId:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
faxnumber:
$ref: '#/components/schemas/BoardingBusinessFax'
nullable: true
highticketamt:
$ref: '#/components/schemas/Highticketamt'
nullable: true
legalname:
$ref: '#/components/schemas/Legalname'
nullable: true
license:
$ref: '#/components/schemas/License'
nullable: true
licstate:
$ref: '#/components/schemas/Licensestate'
nullable: true
maddress:
$ref: '#/components/schemas/Maddress'
nullable: true
maddress1:
$ref: '#/components/schemas/Maddress1'
nullable: true
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
mcity:
$ref: '#/components/schemas/Mcity'
nullable: true
mcountry:
$ref: '#/components/schemas/Mcountry'
nullable: true
mstate:
$ref: '#/components/schemas/Mstate'
nullable: true
mzip:
$ref: '#/components/schemas/Mzip'
nullable: true
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
ownership:
$ref: '#/components/schemas/Ownership'
nullable: true
payoutAverageMonthlyVolume:
$ref: '#/components/schemas/PayoutAverageMonthlyVolume'
nullable: true
payoutAverageTicketLimit:
$ref: '#/components/schemas/PayoutAverageTicketLimit'
nullable: true
payoutCreditLimit:
$ref: '#/components/schemas/PayoutCreditLimit'
nullable: true
payoutHighTicketAmount:
$ref: '#/components/schemas/PayoutHighTicketAmount'
nullable: true
phonenumber:
$ref: '#/components/schemas/BoardingBusinessPhone'
nullable: true
recipientEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: >-
Email address for the applicant. This is used to send the applicant
a boarding link.
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
signer:
$ref: '#/components/schemas/SignerDataRequest'
nullable: true
startdate:
$ref: '#/components/schemas/Busstartdate'
nullable: true
taxfillname:
$ref: '#/components/schemas/Taxfillname'
nullable: true
templateId:
$ref: '#/components/schemas/TemplateId'
nullable: true
ticketamt:
$ref: '#/components/schemas/Ticketamt'
nullable: true
website:
$ref: '#/components/schemas/Website'
nullable: true
whenCharged:
$ref: '#/components/schemas/Whencharged'
nullable: true
whenDelivered:
$ref: '#/components/schemas/Whendelivered'
nullable: true
whenProvided:
$ref: '#/components/schemas/Whenprovided'
nullable: true
whenRefunded:
$ref: '#/components/schemas/Whenrefunded'
nullable: true
RepCode:
$ref: '#/components/schemas/RepCode'
nullable: true
RepName:
$ref: '#/components/schemas/RepName'
nullable: true
RepOffice:
$ref: '#/components/schemas/RepOffice'
nullable: true
onCreate:
$ref: '#/components/schemas/OnCreate'
nullable: true
ApplicationDataManaged:
title: ApplicationDataManaged
type: object
properties:
annualRevenue:
$ref: '#/components/schemas/Annualrevenue'
nullable: true
description: Annual revenue amount. We recommend including this value.
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
baddress:
$ref: '#/components/schemas/Baddress1'
nullable: true
baddress1:
$ref: '#/components/schemas/Baddress2'
nullable: true
bankData:
$ref: '#/components/schemas/BankData'
nullable: true
bcity:
$ref: '#/components/schemas/Bcity'
nullable: true
bcountry:
$ref: '#/components/schemas/Bcountry'
nullable: true
boardingLinkId:
type: string
nullable: true
description: >-
Boarding link ID for the application. Either `templateId` or
`boardingLinkId` are required.
bstate:
$ref: '#/components/schemas/Bstate'
nullable: true
bsummary:
$ref: '#/components/schemas/Bsummary'
nullable: true
btype:
$ref: '#/components/schemas/OwnType'
nullable: true
bzip:
$ref: '#/components/schemas/Bzip'
nullable: true
contacts:
type: array
items:
$ref: '#/components/schemas/ApplicationDataManagedContactsItem'
nullable: true
description: List of contacts for the business.
dbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
ein:
$ref: '#/components/schemas/Ein'
nullable: true
faxnumber:
$ref: '#/components/schemas/BoardingBusinessFax'
nullable: true
legalname:
$ref: '#/components/schemas/Legalname'
nullable: true
license:
$ref: '#/components/schemas/License'
nullable: true
licstate:
$ref: '#/components/schemas/Licensestate'
nullable: true
maddress:
$ref: '#/components/schemas/Maddress'
nullable: true
maddress1:
$ref: '#/components/schemas/Maddress1'
nullable: true
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
mcity:
$ref: '#/components/schemas/Mcity'
nullable: true
mcountry:
$ref: '#/components/schemas/Mcountry'
nullable: true
mstate:
$ref: '#/components/schemas/Mstate'
nullable: true
mzip:
$ref: '#/components/schemas/Mzip'
nullable: true
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
ownership:
type: array
items:
$ref: '#/components/schemas/ApplicationDataManagedOwnershipItem'
nullable: true
description: List of Owners with at least a 25% ownership.
phonenumber:
$ref: '#/components/schemas/BoardingBusinessPhone'
nullable: true
recipientEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: >-
Email address for the applicant. This is used to send the applicant
a boarding link.
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
signer:
$ref: '#/components/schemas/SignerDataRequest'
startdate:
$ref: '#/components/schemas/Busstartdate'
nullable: true
taxfillname:
$ref: '#/components/schemas/Taxfillname'
nullable: true
templateId:
$ref: '#/components/schemas/TemplateId'
nullable: true
description: >-
The associated boarding template's ID in Payabli. Either
`templateId` or `boardingLinkId` are required.
website:
$ref: '#/components/schemas/Website'
nullable: true
RepCode:
$ref: '#/components/schemas/RepCode'
nullable: true
RepName:
$ref: '#/components/schemas/RepName'
nullable: true
RepOffice:
$ref: '#/components/schemas/RepOffice'
nullable: true
onCreate:
$ref: '#/components/schemas/OnCreate'
nullable: true
required:
- signer
ApplicationDataManagedContactsItem:
title: ApplicationDataManagedContactsItem
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/Contacts'
ApplicationDataManagedOwnershipItem:
title: ApplicationDataManagedOwnershipItem
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/Owners'
ApplicationDataOdp:
title: ApplicationDataOdp
type: object
properties:
services:
$ref: '#/components/schemas/Services'
nullable: true
annualRevenue:
$ref: '#/components/schemas/Annualrevenue'
nullable: true
description: Annual revenue amount. We recommend including this value.
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
baddress:
$ref: '#/components/schemas/Baddress1'
nullable: true
baddress1:
$ref: '#/components/schemas/Baddress2'
nullable: true
bankData:
$ref: '#/components/schemas/BankData'
nullable: true
bcity:
$ref: '#/components/schemas/Bcity'
nullable: true
bcountry:
$ref: '#/components/schemas/Bcountry'
nullable: true
boardingLinkId:
type: string
nullable: true
description: >-
Boarding link ID for the application. Either `templateId` or
`boardingLinkId` are required.
bstate:
$ref: '#/components/schemas/Bstate'
nullable: true
bsummary:
$ref: '#/components/schemas/Bsummary'
nullable: true
btype:
$ref: '#/components/schemas/OwnType'
nullable: true
bzip:
$ref: '#/components/schemas/Bzip'
nullable: true
contacts:
type: array
items:
$ref: '#/components/schemas/ApplicationDataOdpContactsItem'
nullable: true
description: List of contacts for the business.
dbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
ein:
$ref: '#/components/schemas/Ein'
nullable: true
faxnumber:
$ref: '#/components/schemas/BoardingBusinessFax'
nullable: true
highticketamt:
$ref: '#/components/schemas/Highticketamt'
nullable: true
legalname:
$ref: '#/components/schemas/Legalname'
nullable: true
license:
$ref: '#/components/schemas/License'
nullable: true
licstate:
$ref: '#/components/schemas/Licensestate'
nullable: true
maddress:
$ref: '#/components/schemas/Maddress'
nullable: true
maddress1:
$ref: '#/components/schemas/Maddress1'
nullable: true
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
mcity:
$ref: '#/components/schemas/Mcity'
nullable: true
mcountry:
$ref: '#/components/schemas/Mcountry'
nullable: true
mstate:
$ref: '#/components/schemas/Mstate'
nullable: true
mzip:
$ref: '#/components/schemas/Mzip'
nullable: true
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
ownership:
type: array
items:
$ref: '#/components/schemas/ApplicationDataOdpOwnershipItem'
nullable: true
description: List of Owners with at least a 25% ownership.
payoutAverageMonthlyVolume:
$ref: '#/components/schemas/PayoutAverageMonthlyVolume'
payoutAverageTicketAmount:
$ref: '#/components/schemas/PayoutAverageTicketLimit'
payoutCreditLimit:
$ref: '#/components/schemas/PayoutCreditLimit'
payoutHighTicketAmount:
$ref: '#/components/schemas/PayoutHighTicketAmount'
phonenumber:
$ref: '#/components/schemas/BoardingBusinessPhone'
nullable: true
recipientEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: >-
Email address for the applicant. This is used to send the applicant
a boarding link.
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
signer:
$ref: '#/components/schemas/SignerDataRequest'
startdate:
$ref: '#/components/schemas/Busstartdate'
nullable: true
taxfillname:
$ref: '#/components/schemas/Taxfillname'
nullable: true
templateId:
$ref: '#/components/schemas/TemplateId'
nullable: true
description: >-
The associated boarding template's ID in Payabli. Either
`templateId` or `boardingLinkId` are required.
website:
$ref: '#/components/schemas/Website'
nullable: true
RepCode:
$ref: '#/components/schemas/RepCode'
nullable: true
RepName:
$ref: '#/components/schemas/RepName'
nullable: true
RepOffice:
$ref: '#/components/schemas/RepOffice'
nullable: true
onCreate:
$ref: '#/components/schemas/OnCreate'
nullable: true
required:
- payoutAverageMonthlyVolume
- payoutAverageTicketAmount
- payoutCreditLimit
- payoutHighTicketAmount
- signer
ApplicationDataOdpContactsItem:
title: ApplicationDataOdpContactsItem
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/Contacts'
ApplicationDataOdpOwnershipItem:
title: ApplicationDataOdpOwnershipItem
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/Owners'
ApplicationDataPayIn:
title: ApplicationDataPayIn
type: object
description: Fields for Pay In boarding applications.
properties:
services:
$ref: '#/components/schemas/ApplicationDataPayInServices'
annualRevenue:
$ref: '#/components/schemas/Annualrevenue'
nullable: true
averageBillSize:
$ref: '#/components/schemas/BoardingAverageBillSize'
nullable: true
averageMonthlyBill:
$ref: '#/components/schemas/BoardingAvgMonthlyBill'
nullable: true
avgmonthly:
$ref: '#/components/schemas/Avgmonthly'
nullable: true
baddress:
$ref: '#/components/schemas/Baddress1'
nullable: true
baddress1:
$ref: '#/components/schemas/Baddress2'
nullable: true
bankData:
$ref: '#/components/schemas/BankData'
bcity:
$ref: '#/components/schemas/Bcity'
nullable: true
bcountry:
$ref: '#/components/schemas/Bcountry'
nullable: true
binperson:
$ref: '#/components/schemas/Binperson'
nullable: true
binphone:
$ref: '#/components/schemas/Binphone'
nullable: true
binweb:
$ref: '#/components/schemas/Binweb'
nullable: true
boardingLinkId:
type: string
nullable: true
description: >-
Boarding link ID for the application. Either `templateId` or
`boardingLinkId` are required.
bstate:
$ref: '#/components/schemas/Bstate'
nullable: true
bsummary:
$ref: '#/components/schemas/Bsummary'
nullable: true
btype:
$ref: '#/components/schemas/OwnType'
nullable: true
bzip:
$ref: '#/components/schemas/Bzip'
nullable: true
contacts:
type: array
items:
$ref: '#/components/schemas/ApplicationDataPayInContactsItem'
nullable: true
description: List of contacts for the business.
creditLimit:
type: string
nullable: true
description: >-
The maximum amount of credit that our lending partner has authorized
to your business for Pay In processing. It's the upper boundary on
how much you can spend or owe on a credit account at any given time.
For on-demand payout (Pay Out) credit limits, see
`payoutCreditLimit`.
dbaName:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: >-
The alternate or common name that this business is doing business
under usually referred to as a DBA name. Payabli strongly recommends
including this information.
ein:
$ref: '#/components/schemas/Ein'
nullable: true
externalpaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
faxnumber:
$ref: '#/components/schemas/FaxNumber'
nullable: true
description: The business's fax number.
highticketamt:
$ref: '#/components/schemas/Highticketamt'
nullable: true
legalName:
$ref: '#/components/schemas/Legalname'
nullable: true
license:
$ref: '#/components/schemas/License'
nullable: true
licstate:
$ref: '#/components/schemas/Licensestate'
nullable: true
maddress:
$ref: '#/components/schemas/Maddress'
nullable: true
maddress1:
$ref: '#/components/schemas/Maddress1'
nullable: true
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
mcity:
$ref: '#/components/schemas/Mcity'
nullable: true
mcountry:
$ref: '#/components/schemas/Mcountry'
nullable: true
mstate:
$ref: '#/components/schemas/Mstate'
nullable: true
mzip:
$ref: '#/components/schemas/Mzip'
nullable: true
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
ownership:
type: array
items:
$ref: '#/components/schemas/ApplicationDataPayInOwnershipItem'
nullable: true
description: List of Owners with at least a 25% ownership.
phonenumber:
$ref: '#/components/schemas/PhoneNumber'
description: The business's phone number.
processingRegion:
type: string
description: The business's processing region, either `US` or `CA`.
recipientEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: >-
Email address for the applicant. This is used to send the applicant
a boarding link.
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
signer:
$ref: '#/components/schemas/SignerDataRequest'
startdate:
$ref: '#/components/schemas/Busstartdate'
nullable: true
taxFillName:
$ref: '#/components/schemas/Taxfillname'
nullable: true
templateId:
$ref: '#/components/schemas/TemplateId'
nullable: true
description: >-
The associated boarding template's ID in Payabli. Either
`templateId` or `boardingLinkId` are required.
ticketamt:
$ref: '#/components/schemas/Ticketamt'
nullable: true
website:
$ref: '#/components/schemas/Website'
nullable: true
whenCharged:
$ref: '#/components/schemas/Whencharged'
whenDelivered:
$ref: '#/components/schemas/Whendelivered'
whenProvided:
$ref: '#/components/schemas/Whenprovided'
whenRefunded:
$ref: '#/components/schemas/Whenrefunded'
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
RepCode:
$ref: '#/components/schemas/RepCode'
nullable: true
RepName:
$ref: '#/components/schemas/RepName'
nullable: true
RepOffice:
$ref: '#/components/schemas/RepOffice'
nullable: true
onCreate:
$ref: '#/components/schemas/OnCreate'
nullable: true
required:
- services
- bankData
- phonenumber
- processingRegion
- signer
- whenCharged
- whenDelivered
- whenProvided
- whenRefunded
ApplicationDataPayInContactsItem:
title: ApplicationDataPayInContactsItem
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/Contacts'
ApplicationDataPayInOwnershipItem:
title: ApplicationDataPayInOwnershipItem
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/Owners'
ApplicationDataPayInServices:
title: ApplicationDataPayInServices
type: object
properties:
ach:
$ref: '#/components/schemas/ApplicationDataPayInServicesAch'
card:
$ref: '#/components/schemas/ApplicationDataPayInServicesCard'
odp:
$ref: '#/components/schemas/OdpSetup'
nullable: true
required:
- ach
- card
ApplicationDataPayInServicesAch:
title: ApplicationDataPayInServicesAch
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/AchSetup'
ApplicationDataPayInServicesCard:
title: ApplicationDataPayInServicesCard
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/CardSetup'
ApplicationDetailsRecord:
title: ApplicationDetailsRecord
type: object
properties:
annualRevenue:
$ref: '#/components/schemas/Annualrevenue'
nullable: true
averageMonthlyVolume:
$ref: '#/components/schemas/Avgmonthly'
nullable: true
averageTicketAmount:
$ref: '#/components/schemas/Ticketamt'
nullable: true
bAddress1:
$ref: '#/components/schemas/Baddress1'
nullable: true
bAddress2:
$ref: '#/components/schemas/Baddress2'
nullable: true
bankData:
$ref: '#/components/schemas/BankData'
nullable: true
bCity:
$ref: '#/components/schemas/Bcity'
nullable: true
bCountry:
$ref: '#/components/schemas/Bcountry'
nullable: true
bFax:
$ref: '#/components/schemas/Bphone'
nullable: true
description: The business's fax number.
binPerson:
$ref: '#/components/schemas/Binperson'
nullable: true
binPhone:
$ref: '#/components/schemas/Binphone'
nullable: true
binWeb:
$ref: '#/components/schemas/Binweb'
nullable: true
boardingLinkId:
$ref: '#/components/schemas/BoardingLinkId'
nullable: true
boardingStatus:
$ref: '#/components/schemas/BoardingStatus'
nullable: true
boardingSubStatus:
$ref: '#/components/schemas/BoardingStatus'
nullable: true
bPhone:
$ref: '#/components/schemas/Bphone'
nullable: true
bStartdate:
$ref: '#/components/schemas/Busstartdate'
nullable: true
bState:
$ref: '#/components/schemas/Bstate'
nullable: true
bSummary:
$ref: '#/components/schemas/Bsummary'
nullable: true
builderData:
$ref: '#/components/schemas/BuilderData'
nullable: true
bZip:
$ref: '#/components/schemas/Bzip'
nullable: true
contactData:
$ref: '#/components/schemas/ContactsField'
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
dbaName:
$ref: '#/components/schemas/Dbaname'
nullable: true
documentsRef:
$ref: '#/components/schemas/BoardingApplicationAttachments'
nullable: true
ein:
$ref: '#/components/schemas/Ein'
nullable: true
externalPaypointId:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
generalEvents:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: Events associated with the application.
highTicketAmount:
$ref: '#/components/schemas/Highticketamt'
nullable: true
idApplication:
$ref: '#/components/schemas/AppId'
nullable: true
lastModified:
$ref: '#/components/schemas/LastModified'
nullable: true
legalName:
$ref: '#/components/schemas/Legalname'
nullable: true
license:
$ref: '#/components/schemas/License'
nullable: true
licenseState:
$ref: '#/components/schemas/Licensestate'
nullable: true
logo:
type: string
nullable: true
description: A URL pointing to a logo file.
mAddress1:
$ref: '#/components/schemas/Maddress'
nullable: true
mAddress2:
$ref: '#/components/schemas/Maddress1'
nullable: true
mccid:
type: string
nullable: true
mCity:
$ref: '#/components/schemas/Mstate'
nullable: true
mCountry:
$ref: '#/components/schemas/Mcountry'
nullable: true
messages:
type: array
items:
$ref: '#/components/schemas/ApplicationDetailsRecordMessagesItem'
nullable: true
mState:
$ref: '#/components/schemas/Mstate'
nullable: true
mZip:
$ref: '#/components/schemas/Mzip'
nullable: true
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
orgParentName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ownerData:
$ref: '#/components/schemas/Ownership'
nullable: true
ownType:
$ref: '#/components/schemas/OwnType'
nullable: true
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
salesCode:
$ref: '#/components/schemas/SalesCode'
nullable: true
serviceData:
$ref: '#/components/schemas/Services'
nullable: true
signer:
$ref: '#/components/schemas/SignerData'
nullable: true
taxfillname:
$ref: '#/components/schemas/Taxfillname'
nullable: true
templateId:
$ref: '#/components/schemas/TemplateId'
nullable: true
websiteAddress:
$ref: '#/components/schemas/Website'
nullable: true
whencharged:
$ref: '#/components/schemas/Whencharged'
nullable: true
whendelivered:
$ref: '#/components/schemas/Whendelivered'
nullable: true
whenProvided:
$ref: '#/components/schemas/Whenprovided'
nullable: true
whenrefund:
$ref: '#/components/schemas/Whenrefunded'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
ApplicationDetailsRecordMessagesItem:
title: ApplicationDetailsRecordMessagesItem
type: object
properties:
content:
type: string
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
currentApplicationStatus:
type: integer
nullable: true
currentApplicationSubStatus:
type: integer
nullable: true
id:
type: integer
nullable: true
messageType:
type: integer
nullable: true
originalApplicationStatus:
type: integer
nullable: true
originalApplicationSubStatus:
type: integer
nullable: true
roomId:
type: integer
nullable: true
userId:
type: integer
nullable: true
userName:
type: string
nullable: true
ApplicationQueryRecord:
title: ApplicationQueryRecord
type: object
properties:
annualRevenue:
$ref: '#/components/schemas/Annualrevenue'
nullable: true
averageMonthlyVolume:
$ref: '#/components/schemas/Avgmonthly'
nullable: true
averageTicketAmount:
$ref: '#/components/schemas/Ticketamt'
nullable: true
bAddress1:
$ref: '#/components/schemas/Baddress1'
nullable: true
bAddress2:
$ref: '#/components/schemas/Baddress2'
nullable: true
bankData:
$ref: '#/components/schemas/BankData'
nullable: true
bCity:
$ref: '#/components/schemas/Bcity'
nullable: true
bCountry:
$ref: '#/components/schemas/Bcountry'
nullable: true
bFax:
$ref: '#/components/schemas/Bphone'
nullable: true
description: The business's fax number.
binPerson:
$ref: '#/components/schemas/Binperson'
nullable: true
binPhone:
$ref: '#/components/schemas/Binphone'
nullable: true
binWeb:
$ref: '#/components/schemas/Binweb'
nullable: true
boardingLinkId:
$ref: '#/components/schemas/BoardingLinkId'
nullable: true
boardingStatus:
$ref: '#/components/schemas/BoardingStatus'
nullable: true
boardingSubStatus:
$ref: '#/components/schemas/BoardingStatus'
nullable: true
bPhone:
$ref: '#/components/schemas/Bphone'
nullable: true
bStartdate:
$ref: '#/components/schemas/Busstartdate'
nullable: true
bState:
$ref: '#/components/schemas/Bstate'
nullable: true
bSummary:
$ref: '#/components/schemas/Bsummary'
nullable: true
builderData:
$ref: '#/components/schemas/BuilderData'
nullable: true
bZip:
$ref: '#/components/schemas/Bzip'
nullable: true
contactData:
$ref: '#/components/schemas/ContactsField'
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
dbaName:
$ref: '#/components/schemas/Dbaname'
nullable: true
documentsRef:
$ref: '#/components/schemas/BoardingApplicationAttachments'
nullable: true
ein:
$ref: '#/components/schemas/Ein'
nullable: true
externalPaypointId:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
generalEvents:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: Events associated with the application.
highTicketAmount:
$ref: '#/components/schemas/Highticketamt'
nullable: true
idApplication:
$ref: '#/components/schemas/AppId'
nullable: true
lastModified:
$ref: '#/components/schemas/LastModified'
nullable: true
legalName:
$ref: '#/components/schemas/Legalname'
nullable: true
license:
$ref: '#/components/schemas/License'
nullable: true
licenseState:
$ref: '#/components/schemas/Licensestate'
nullable: true
logo:
$ref: '#/components/schemas/FileContent'
nullable: true
description: Object containing logo file.
mAddress1:
$ref: '#/components/schemas/Maddress'
nullable: true
mAddress2:
$ref: '#/components/schemas/Maddress1'
nullable: true
mccid:
type: string
nullable: true
mCity:
$ref: '#/components/schemas/Mstate'
nullable: true
mCountry:
$ref: '#/components/schemas/Mcountry'
nullable: true
mState:
$ref: '#/components/schemas/Mstate'
nullable: true
mZip:
$ref: '#/components/schemas/Mzip'
nullable: true
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
orgParentName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ownerData:
$ref: '#/components/schemas/Ownership'
nullable: true
ownType:
$ref: '#/components/schemas/OwnType'
nullable: true
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
salesCode:
$ref: '#/components/schemas/SalesCode'
nullable: true
serviceData:
$ref: '#/components/schemas/Services'
nullable: true
signer:
$ref: '#/components/schemas/SignerData'
nullable: true
taxfillname:
$ref: '#/components/schemas/Taxfillname'
nullable: true
templateId:
$ref: '#/components/schemas/TemplateId'
nullable: true
websiteAddress:
$ref: '#/components/schemas/Website'
nullable: true
whencharged:
$ref: '#/components/schemas/Whencharged'
nullable: true
whendelivered:
$ref: '#/components/schemas/Whendelivered'
nullable: true
whenProvided:
$ref: '#/components/schemas/Whenprovided'
nullable: true
whenrefund:
$ref: '#/components/schemas/Whenrefunded'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
RepCode:
$ref: '#/components/schemas/RepCode'
nullable: true
RepName:
$ref: '#/components/schemas/RepName'
nullable: true
RepOffice:
$ref: '#/components/schemas/RepOffice'
nullable: true
ASection:
title: ASection
type: object
properties:
minimumDocuments:
type: integer
nullable: true
multipleContacts:
type: boolean
nullable: true
multipleOwners:
type: boolean
nullable: true
Attachments:
title: Attachments
type: array
items:
$ref: '#/components/schemas/FileContent'
description: >-
Array of `fileContent` objects with attached documents. Max upload size
is 30 MB.
Authcode:
title: Authcode
type: string
description: Authorization code for the transaction.
AutoElement:
title: AutoElement
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
finish:
$ref: '#/components/schemas/Finishtype'
nullable: true
description: Type of end date
frequency:
$ref: '#/components/schemas/FrequencyList'
nullable: true
description: accepted frequencies for autopay
frequencySelected:
type: string
nullable: true
description: Value of pre-selected frequency
header:
type: string
nullable: true
description: Header text for section
order:
$ref: '#/components/schemas/Order'
nullable: true
startDate:
type: string
nullable: true
description: Range of days enabled in calendar. Leave empty to enable all days.
Avgmonthly:
title: Avgmonthly
type: number
format: double
description: >-
Average total amount of transactions in your local currency that are
processed each month.
Avgticketamt:
title: Avgticketamt
type: number
format: double
description: Average ticket amount.
AvsResponseText:
title: AvsResponseText
type: string
description: >-
Text code describing the result for address validation (applies only for
card transactions).
AvsResponse:
title: AvsResponse
type: string
description: >-
Text code describing the result for address validation (applies only for
card transactions).
CvvResponse:
title: CvvResponse
type: string
description: >-
Text code describing the result for CVV validation (applies only for
card transactions).
CvvResponseText:
title: CvvResponseText
type: string
description: >-
Text code describing the result for CVV validation (applies only for
card transactions).
BAddress:
title: BAddress
type: object
properties:
baddress:
$ref: '#/components/schemas/LinkData'
nullable: true
baddress1:
$ref: '#/components/schemas/LinkData'
nullable: true
bcity:
$ref: '#/components/schemas/LinkData'
nullable: true
bcountry:
$ref: '#/components/schemas/LinkData'
nullable: true
bstate:
$ref: '#/components/schemas/LinkData'
nullable: true
bzip:
$ref: '#/components/schemas/LinkData'
nullable: true
maddress:
$ref: '#/components/schemas/LinkData'
nullable: true
maddress1:
$ref: '#/components/schemas/LinkData'
nullable: true
mcity:
$ref: '#/components/schemas/LinkData'
nullable: true
mcountry:
$ref: '#/components/schemas/LinkData'
nullable: true
mstate:
$ref: '#/components/schemas/LinkData'
nullable: true
mzip:
$ref: '#/components/schemas/LinkData'
nullable: true
Baddress1:
title: Baddress1
type: string
description: Business address. This must be a physical address, not a P.O. box.
Baddress2:
title: Baddress2
type: string
description: >-
Business address additional line. If used, this must be the physical
address of the business, not a P.O. box.
Bank:
title: Bank
type: object
description: Object that contains bank account details.
properties:
id:
type: integer
nullable: true
description: The Payabli-assigned internal identifier for the bank account.
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
description: >-
An identifier for the bank account, used to specify which account
handles payments when multiple accounts are configured. If not
provided during creation or update, the system generates one in the
format `acct-{first_digit}xxxxx{last_4_digits}` based on the account
number. The mask always uses five `x` characters regardless of
account number length. For example, account number `123456789`
produces `acct-1xxxxx6789`. If a duplicate exists within the same
service at the paypoint, a numeric suffix is appended, such as
`acct-1xxxxx6789-2`. This value is also used as the identifier for
the bank account's associated payment connector.
nickname:
$ref: '#/components/schemas/BankNickname'
nullable: true
bankName:
$ref: '#/components/schemas/BankName'
nullable: true
routingAccount:
$ref: '#/components/schemas/RoutingAccount'
nullable: true
accountNumber:
$ref: '#/components/schemas/AccountNumber'
nullable: true
typeAccount:
$ref: '#/components/schemas/TypeAccount'
nullable: true
bankAccountHolderName:
$ref: '#/components/schemas/BankAccountHolderName'
nullable: true
bankAccountHolderType:
$ref: '#/components/schemas/BankAccountHolderType'
nullable: true
bankAccountFunction:
$ref: '#/components/schemas/BankAccountFunction'
nullable: true
verified:
type: boolean
nullable: true
description: >-
Bank account verification status. When `true`, the account has been
verified to exist and be in good standing based on vendor checks or
previous processing histories.
status:
type: integer
nullable: true
description: Bank account status
services:
type: array
items:
type: string
nullable: true
description: Array of services associated with this bank account
BankAccountFunction:
title: BankAccountFunction
type: integer
description: >-
Indicates the function of the bank account:
* 0 - Deposits
* 1 - Withdrawals
* 2 - Deposits & Withdrawals
* 3 - Remittances
* 4 - Remittances & Deposits
* 5 - Remittances & Withdrawals
* 6 - Remittances & Withdrawals & Deposits
A paypoint is required to have a single deposit and withdrawal account.
A Paypoint can have as many remittance accounts as needed for pay outs
(remittances).
BankAccountHolderName:
title: BankAccountHolderName
type: string
description: The accountholder's name.
BankAccountHolderType:
title: BankAccountHolderType
type: string
enum:
- Personal
- Business
description: Describes whether the bank is a personal or business account.
BankData:
title: BankData
type: array
items:
$ref: '#/components/schemas/Bank'
description: Information about associated bank accounts.
BankName:
title: BankName
type: string
description: Name of bank for account.
BankNickname:
title: BankNickname
type: string
description: User-defined name for the bank account.
BankSection:
title: BankSection
type: object
description: Details about a bank account.
properties:
visible:
$ref: '#/components/schemas/Visible'
nullable: true
accountNumber:
$ref: '#/components/schemas/TemplateElement'
nullable: true
accountType:
$ref: '#/components/schemas/TemplateElement'
nullable: true
bankName:
$ref: '#/components/schemas/TemplateElement'
nullable: true
routingNumber:
$ref: '#/components/schemas/TemplateElement'
nullable: true
BasicTable:
title: BasicTable
type: object
properties:
body:
type: array
items:
$ref: '#/components/schemas/LinkRow'
nullable: true
header:
$ref: '#/components/schemas/LinkRow'
nullable: true
BasicTemplateElement:
title: BasicTemplateElement
type: object
properties:
readOnly:
$ref: '#/components/schemas/ReadOnly'
nullable: true
required:
$ref: '#/components/schemas/RequiredElement'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
BatchNumber:
title: BatchNumber
type: string
description: >-
A unique identifier for the batch. This is generated by Payabli when the
batch is created, and follows this format:
`paypointId + "_" + serviceName + "_" + batchDate:yyyyMMdd + "_" + Guid.NewGuid()`. Payabli generates the GUID to ensure that the batch number is unique.
For example, in this batch number: `123_card_20251008_3f2504e0-4f89-11d3-9a0c-0305e82c3301`, the paypointID is "123", the service is "card", the batch date is "2025-10-08", and the GUID is "3f2504e0-4f89-11d3-9a0c-0305e82c3301".
BatchSummary:
title: BatchSummary
type: object
properties:
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSize:
type: integer
nullable: true
description: Number of records on each response page.
totalAmount:
type: number
format: double
nullable: true
description: Total amount for the records.
totalNetAmount:
type: number
format: double
nullable: true
description: Total net amount for the records.
totalPages:
type: integer
nullable: true
description: Total number of pages in response.
totalRecords:
type: integer
nullable: true
description: Total number of records in response.
Bcity:
title: Bcity
type: string
description: Business city
Bcountry:
title: Bcountry
type: string
description: >-
Business country in ISO-3166-1 alpha 2 format. See:
https://en.wikipedia.org/wiki/ISO_3166-1 for more information.
BDetails:
title: BDetails
type: object
properties:
btype:
$ref: '#/components/schemas/LinkData'
nullable: true
dbaname:
$ref: '#/components/schemas/LinkData'
nullable: true
ein:
$ref: '#/components/schemas/LinkData'
nullable: true
faxnumber:
$ref: '#/components/schemas/LinkData'
nullable: true
legalname:
$ref: '#/components/schemas/LinkData'
nullable: true
license:
$ref: '#/components/schemas/LinkData'
nullable: true
licstate:
$ref: '#/components/schemas/LinkData'
nullable: true
phonenumber:
$ref: '#/components/schemas/LinkData'
nullable: true
startdate:
$ref: '#/components/schemas/LinkData'
nullable: true
taxfillname:
$ref: '#/components/schemas/LinkData'
nullable: true
website:
$ref: '#/components/schemas/LinkData'
nullable: true
BillData:
title: BillData
type: object
properties:
AdditionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
company:
type: string
nullable: true
description: Company name of the recipient of the invoice.
discount:
$ref: '#/components/schemas/Discount'
nullable: true
dutyAmount:
$ref: '#/components/schemas/DutyAmount'
nullable: true
firstName:
type: string
nullable: true
description: First name of the recipient of the invoice.
freightAmount:
$ref: '#/components/schemas/FreightAmount'
nullable: true
frequency:
$ref: '#/components/schemas/Frequency'
nullable: true
description: Frequency of scheduled invoice.
invoiceAmount:
$ref: '#/components/schemas/InvoiceAmount'
nullable: true
invoiceDate:
type: string
format: date
nullable: true
description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
invoiceDueDate:
type: string
format: date
nullable: true
description: >-
Invoice due date in one of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
invoiceEndDate:
type: string
format: date
nullable: true
description: >-
Indicate the date to finish a scheduled invoice cycle
(`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
nullable: true
description: Invoice number. Identifies the invoice under a paypoint.
invoiceStatus:
$ref: '#/components/schemas/Invoicestatus'
nullable: true
invoiceType:
$ref: '#/components/schemas/InvoiceType'
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/BillItem'
nullable: true
description: Array of line items included in the invoice.
lastName:
type: string
nullable: true
description: Last name of the recipient of the invoice.
notes:
type: string
nullable: true
description: Notes included in the invoice.
paymentTerms:
$ref: '#/components/schemas/BillDataPaymentTerms'
nullable: true
purchaseOrder:
$ref: '#/components/schemas/PurchaseOrder'
nullable: true
shippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
shippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
shippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
shippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
shippingEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: Shipping recipient's contact email address.
shippingFromZip:
$ref: '#/components/schemas/ShippingFromZip'
nullable: true
shippingPhone:
type: string
nullable: true
description: Recipient phone number.
shippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
shippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
summaryCommodityCode:
$ref: '#/components/schemas/SummaryCommodityCode'
nullable: true
tax:
$ref: '#/components/schemas/Tax'
nullable: true
termsConditions:
$ref: '#/components/schemas/TermsConditions'
nullable: true
BillDataPaymentTerms:
title: BillDataPaymentTerms
type: string
enum:
- PIA
- CIA
- UR
- NET10
- NET20
- NET30
- NET45
- NET60
- NET90
- EOM
- MFI
- 5MFI
- 10MFI
- 15MFI
- 20MFI
- 2/10NET30
- UF
- 10UF
- 20UF
- 25UF
- 50UF
description: >-
Payment terms for invoice. If no terms are defined, then response data
for this field defaults to `NET30`.
**Available Values:**
- `PIA`: Payment in advance
- `CIA`: Cash in advance
- `UR`: Upon receipt
- `NET10`: 10 days after invoice date
- `NET20`: 20 days after invoice date
- `NET30`: 30 days after invoice date
- `NET45`: 45 days after invoice date
- `NET60`: 60 days after invoice date
- `NET90`: 90 days after invoice date
- `EOM`: Due end of this month
- `MFI`: 1st of the month following the invoice date
- `5MFI`: 5th of the month following the invoice date
- `10MFI`: 10th of the month following the invoice date
- `15MFI`: 15th of the month following the invoice date
- `20MFI`: 20th of the month following the invoice date
- `2/10NET30`: 2% discount if paid within 10 days, otherwise net 30 days
- `UF`: Until further notice
- `10UF`: 10 days until further notice
- `20UF`: 20 days until further notice
- `25UF`: 25 days until further notice
- `50UF`: 50 days until further notice
BillEvents:
title: BillEvents
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
description: >-
Array of event objects with information related to events associated to
the invoice.
BillingAddressAddtlNullable:
title: BillingAddressAddtlNullable
type: string
description: Additional line for the billing address.
BillingAddressNullable:
title: BillingAddressNullable
type: string
description: Billing address.
BillingCityNullable:
title: BillingCityNullable
type: string
description: Billing city.
BillingCountryNullable:
title: BillingCountryNullable
type: string
description: Billing address country.
BillingData:
title: BillingData
type: object
properties:
accountNumber:
type: string
nullable: true
description: Account number for bank account.
bankAccountFunction:
type: integer
nullable: true
description: >-
Describes whether the bank account is used for deposits or
withdrawals in Payabli:
- `0`: Deposit
- `1`: Withdrawal
- `2`: Deposit and withdrawal
bankAccountHolderName:
$ref: '#/components/schemas/BankAccountHolderName'
nullable: true
bankAccountHolderType:
$ref: '#/components/schemas/BankAccountHolderType'
nullable: true
bankName:
$ref: '#/components/schemas/BankName'
nullable: true
id:
type: integer
nullable: true
description: The bank's ID in Payabli.
routingAccount:
$ref: '#/components/schemas/RoutingAccount'
nullable: true
typeAccount:
$ref: '#/components/schemas/TypeAccount'
nullable: true
BillingDataResponse:
title: BillingDataResponse
type: object
properties:
id:
type: integer
description: The bank's ID in Payabli.
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
description: >-
An identifier for the bank account. If not provided during creation
or update, the system generates one in the format
`acct-{first_digit}xxxxx{last_4_digits}` based on the account
number. If a duplicate exists within the same service at the
paypoint, a numeric suffix is appended, such as `-2`. This value is
also used as the identifier for the bank account's associated
payment connector.
nickname:
type: string
bankName:
$ref: '#/components/schemas/BankName'
routingAccount:
$ref: '#/components/schemas/RoutingAccount'
accountNumber:
$ref: '#/components/schemas/AccountNumber'
typeAccount:
$ref: '#/components/schemas/TypeAccount'
bankAccountHolderName:
$ref: '#/components/schemas/BankAccountHolderName'
bankAccountHolderType:
$ref: '#/components/schemas/BankAccountHolderType'
bankAccountFunction:
type: integer
description: >-
Describes whether the bank account is used for deposits or
withdrawals in Payabli:
- `0`: Deposit
- `1`: Withdrawal
- `2`: Deposit and withdrawal
verified:
type: boolean
status:
type: integer
services:
type: array
items: {}
default:
type: boolean
required:
- id
- nickname
- bankName
- routingAccount
- accountNumber
- typeAccount
- bankAccountHolderName
- bankAccountHolderType
- bankAccountFunction
- verified
- status
- services
- default
BillingFeeDetail:
title: BillingFeeDetail
type: object
properties:
billableEvent:
type: string
nullable: true
service:
type: string
nullable: true
eventId:
type: string
nullable: true
description:
type: string
nullable: true
description: Description of the billing fee
category:
type: string
nullable: true
description: Category of the billing fee
fixPrice:
type: number
format: double
nullable: true
description: Fixed price component of the fee
floatPrice:
type: number
format: double
nullable: true
description: Percentage component of the fee
billableAmount:
type: number
format: double
nullable: true
description: Amount eligible for the fee
billAmount:
type: number
format: double
nullable: true
description: Total fee amount charged
frequency:
type: string
nullable: true
serviceGroup:
type: string
nullable: true
BillingStateNullable:
title: BillingStateNullable
type: string
description: Billing state. Must be 2-letter state code for address in US.
BillingZip:
title: BillingZip
type: string
description: Billing address ZIP code.
BillItem:
title: BillItem
type: object
properties:
itemCategories:
type: array
items:
type: string
nullable: true
nullable: true
description: Array of tags classifying item or product.
itemCommodityCode:
$ref: '#/components/schemas/ItemCommodityCode'
nullable: true
itemCost:
type: number
format: double
description: Item or product price per unit.
itemDescription:
$ref: '#/components/schemas/ItemDescription'
nullable: true
itemMode:
type: integer
nullable: true
description: >-
Internal class of item or product: value '0' is only for invoices ,
'1' for bills and, '2' common for both.
itemProductCode:
$ref: '#/components/schemas/ItemProductCode'
nullable: true
itemProductName:
$ref: '#/components/schemas/ItemProductName'
nullable: true
itemQty:
type: integer
nullable: true
description: Quantity of item or product.
itemTaxAmount:
type: number
format: double
nullable: true
description: Tax amount applied to item or product.
itemTaxRate:
type: number
format: double
nullable: true
description: Tax rate applied to item or product.
itemTotalAmount:
type: number
format: double
nullable: true
description: Total amount in item or product.
itemUnitOfMeasure:
$ref: '#/components/schemas/ItemUnitofMeasure'
nullable: true
required:
- itemCost
Billitems:
title: Billitems
type: array
items:
$ref: '#/components/schemas/BillItem'
description: Array of `LineItems` contained in bill.
BillOptions:
title: BillOptions
type: object
properties:
includePaylink:
type: boolean
nullable: true
description: Flag to indicate if the scheduled invoice includes a payment link.
includePdf:
type: boolean
nullable: true
description: >-
Flag to indicate if the scheduled invoice includes a PDF version of
invoice
BillId:
title: BillId
type: integer
format: int64
description: >-
The bill's ID in Payabli. This value is automatically generated by
Payabli when the bill is created.
BillPayOutDataRequest:
title: BillPayOutDataRequest
type: object
properties:
billId:
type: integer
format: int64
nullable: true
description: Bill ID in Payabli.
comments:
$ref: '#/components/schemas/Comments'
nullable: true
description: >-
Any comments about bill. **For managed payouts, this field has a
limit of 100 characters**.
dueDate:
type: string
format: date
nullable: true
description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
invoiceDate:
type: string
format: date
nullable: true
description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
nullable: true
description: >-
Custom number identifying the bill. Must be unique in paypoint.
**Required** for new bill and when `billId` isn't provided.
netAmount:
$ref: '#/components/schemas/NetAmountstring'
nullable: true
description: Net Amount owed in bill. Required when adding a bill.
discount:
type: string
nullable: true
description: Bill discount amount.
terms:
$ref: '#/components/schemas/Terms'
nullable: true
description: Description of payment terms.
accountingField1:
$ref: '#/components/schemas/AccountingField'
nullable: true
accountingField2:
$ref: '#/components/schemas/AccountingField'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
description: >-
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](/developers/developer-guides/pay-out-manage-payouts).
BillDetailsResponse:
title: BillDetailsResponse
type: object
description: >-
Response object for bill details. Contains basic information about a
bill.
properties:
billId:
$ref: '#/components/schemas/BillId'
nullable: true
lotNumber:
type: string
nullable: true
description: Lot number of the bill.
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
nullable: true
description: Custom number identifying the bill.
netAmount:
$ref: '#/components/schemas/NetAmountstring'
nullable: true
description: Net Amount owed in bill. Required when adding a bill.
discount:
type: string
nullable: true
description: Bill discount amount.
dueDate:
type: string
format: date
nullable: true
description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
invoiceDate:
type: string
format: date
nullable: true
description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
comments:
$ref: '#/components/schemas/Comments'
nullable: true
description: >-
Any comments about bill. **For managed payouts, this field has a
limit of 100 characters**.
required:
- dueDate
- invoiceDate
BillPayOutData:
title: BillPayOutData
type: object
properties:
billId:
type: integer
format: int64
nullable: true
description: Bill ID in Payabli.
comments:
$ref: '#/components/schemas/Comments'
nullable: true
description: >-
Any comments about bill. **For managed payouts, this field has a
limit of 100 characters**.
dueDate:
type: string
format: date
nullable: true
description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
invoiceDate:
type: string
format: date
nullable: true
description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
nullable: true
description: >-
Custom number identifying the bill. Must be unique in paypoint.
**Required** for new bill and when `billId` isn't provided.
netAmount:
$ref: '#/components/schemas/NetAmountstring'
nullable: true
description: Net Amount owed in bill. Required when adding a bill.
discount:
type: string
nullable: true
description: Bill discount amount.
Terms:
$ref: '#/components/schemas/Terms'
nullable: true
description: Description of payment terms.
AccountingField1:
$ref: '#/components/schemas/AccountingField'
nullable: true
AccountingField2:
$ref: '#/components/schemas/AccountingField'
nullable: true
AdditionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
description: >-
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](/developers/developer-guides/pay-out-manage-payouts).
required:
- dueDate
- invoiceDate
BillDetailResponse:
title: BillDetailResponse
type: object
properties:
Bills:
type: array
items:
$ref: '#/components/schemas/BillDetailsResponse'
nullable: true
description: Bills associated with this transaction.
CheckData:
$ref: '#/components/schemas/FileContent'
nullable: true
description: Object referencing to paper check image.
CheckNumber:
type: string
nullable: true
description: Paper check number related to payout transaction.
Comments:
$ref: '#/components/schemas/Comments'
nullable: true
description: Any comment or description for payout transaction.
CreatedDate:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp when the payment was created, in UTC.
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
Events:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
nullable: true
description: Events associated to this transaction.
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
nullable: true
Gateway:
$ref: '#/components/schemas/Gatewayfield'
nullable: true
IdOut:
type: integer
format: int64
nullable: true
description: Identifier of payout transaction.
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: Timestamp when payment record was updated, in UTC.
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ParentOrgId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
PaymentGroup:
type: string
nullable: true
description: Unique identifier for group or batch containing the transaction.
PaymentId:
$ref: '#/components/schemas/PaymentIdString'
nullable: true
PaymentMethod:
type: string
nullable: true
description: Method of payment applied to the transaction.
PaymentStatus:
type: string
nullable: true
description: Status of payout transaction.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: Paypoint legal name.
Source:
$ref: '#/components/schemas/Source'
nullable: true
Status:
type: integer
nullable: true
description: >-
Internal status of transaction.
Payout statuses, also known as money out transaction statuses,
appear in PartnerHub and PayHub, and the API, and describe where a
payout transaction is in its lifecycle.
| Status | Key | Description | Events |
|--------|-----|-------------|---------|
| **Authorized** | 11 | A payout is authorized. These are queued
payouts, and nothing happens with them until they're captured. |
Authorized |
| **Captured** | 1 | A payout is captured and is now part of the
batch for payout. | Captured |
| **Canceled** | 0 | An authorized payout has been canceled. A
captured payout can be canceled before batch close at 5 PM ET. |
Cancelled |
| **Processing** | 2 | A payout is being processed. | Waiting funds,
Funded, Pending (payment type is pending), Generating check |
| **Processed** | 3 | A payment method is defined for the vendor,
and the payout has been sent to the recipient. | Open (vCard issued,
ACH sent, check generated but not yet cashed), Processed (Payment
Type is no longer pending), Reissued, Returned, Errored |
| **OnHold** | 4 | A payout has been placed on hold and requires
review before proceeding. | OnHold |
| **Paid** | 5 | A payout has been paid and the recipient has
redeemed the funds. | Paid (check cleared, vCard used, ACH settled)
|
StatusText:
type: string
nullable: true
description: Text description of the payout transaction status.
TotalAmount:
type: number
format: double
nullable: true
description: Transaction total amount (including service fee or sub-charge).
Vendor:
$ref: '#/components/schemas/VendorQueryRecord'
nullable: true
description: Vendor related to the payout transaction.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
EntryName:
$ref: '#/components/schemas/Entry'
nullable: true
BatchId:
type: string
nullable: true
description: >-
Identifier for the batch in which this transaction was processed.
Used to track and reconcile batch-level operations.
HasVcardTransactions:
$ref: '#/components/schemas/HasVcardTransactions'
nullable: true
IsSameDayACH:
$ref: '#/components/schemas/IsSameDayACH'
nullable: true
ScheduleId:
$ref: '#/components/schemas/ScheduleId'
nullable: true
SettlementStatus:
$ref: '#/components/schemas/SettlementStatus'
nullable: true
RiskFlagged:
$ref: '#/components/schemas/RiskFlagged'
nullable: true
RiskFlaggedOn:
$ref: '#/components/schemas/RiskFlaggedOn'
nullable: true
RiskStatus:
$ref: '#/components/schemas/RiskStatus'
nullable: true
RiskReason:
$ref: '#/components/schemas/RiskReason'
nullable: true
RiskAction:
$ref: '#/components/schemas/RiskAction'
nullable: true
RiskActionCode:
$ref: '#/components/schemas/RiskActionCode'
nullable: true
BillApprovals:
title: BillApprovals
type: array
items:
$ref: '#/components/schemas/BillQueryRecord2BillApprovalsItem'
nullable: true
description: Approvals associated with the bill.
BillQueryResponse:
title: BillQueryResponse
type: object
properties:
Summary:
$ref: '#/components/schemas/BillQueryResponseSummary'
nullable: true
description: Summary statistics for the bill query response.
Records:
type: array
items:
$ref: '#/components/schemas/BillQueryRecord2'
nullable: true
description: Array of bill records returned by the query.
BillQueryResponseSummary:
title: BillQueryResponseSummary
type: object
properties:
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSize:
$ref: '#/components/schemas/Pagesize'
nullable: true
total2approval:
type: integer
nullable: true
totalactive:
type: integer
nullable: true
totalAmount:
type: number
format: double
nullable: true
description: Total amount of bills in response.
totalamount2approval:
type: number
format: double
nullable: true
totalamountactive:
type: number
format: double
nullable: true
totalamountapproved:
type: number
format: double
nullable: true
description: The total amount of approved bills.
totalamountcancel:
type: number
format: double
nullable: true
totalamountdisapproved:
type: number
format: double
nullable: true
description: The total amount of disapproved bills.
totalamountintransit:
type: number
format: double
nullable: true
totalamountoverdue:
type: number
format: double
nullable: true
description: The total amount of bills that are overdue.
totalamountpaid:
type: number
format: double
nullable: true
description: The total amount of paid bills.
totalamountsent2approval:
type: number
format: double
nullable: true
totalapproved:
type: integer
nullable: true
description: The total number of bills that were approved.
totalcancel:
type: integer
nullable: true
totaldisapproved:
type: integer
nullable: true
description: The number of bills that were disapproved.
totalintransit:
type: integer
nullable: true
totaloverdue:
type: integer
nullable: true
description: The number of bills that are overdue.
totalPages:
$ref: '#/components/schemas/Totalpages'
nullable: true
totalpaid:
type: integer
nullable: true
description: The total number of paid bills.
totalRecords:
$ref: '#/components/schemas/Totalrecords'
nullable: true
totalsent2approval:
type: integer
nullable: true
BillQueryRecord2:
title: BillQueryRecord2
type: object
properties:
AccountingField1:
$ref: '#/components/schemas/AccountingField'
nullable: true
AccountingField2:
$ref: '#/components/schemas/AccountingField'
nullable: true
AdditionalData:
type: object
additionalProperties:
type: string
nullable: true
description: Additional data associated with the bill.
BatchNumber:
type: string
nullable: true
description: Batch number associated with the bill.
billApprovals:
type: array
items:
$ref: '#/components/schemas/BillQueryRecord2BillApprovalsItem'
nullable: true
BillDate:
type: string
format: date
nullable: true
description: >-
Bill creation date in one of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
billEvents:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: Events associated with the bill.
BillItems:
type: array
items:
$ref: '#/components/schemas/BillItem'
nullable: true
description: Array of items included in the bill.
BillNumber:
type: string
nullable: true
description: Bill number.
Comments:
type: string
nullable: true
description: Additional comments on the bill.
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp of when bill was created, in UTC.
Discount:
type: number
format: double
nullable: true
description: Discount amount applied to the bill.
DocumentsRef:
type: string
nullable: true
description: Reference to documents associated with the bill.
DueDate:
type: string
format: date
nullable: true
description: >-
Bill due date in one of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
EndDate:
type: string
format: date
nullable: true
description: End date for the bill.
EntityID:
type: string
nullable: true
description: Entity identifier associated with the bill.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
Frequency:
$ref: '#/components/schemas/Frequency'
nullable: true
description: Frequency for scheduled bills. Applied only in `Mode` = 1.
IdBill:
type: integer
format: int64
nullable: true
description: Identifier of the bill.
LastUpdated:
type: string
format: date-time
nullable: true
description: Timestamp of when bill was last updated, in UTC.
LotNumber:
type: string
nullable: true
description: Lot number associated with the bill.
Mode:
type: integer
nullable: true
description: >-
Bill mode: value `0` for single/one-time bills, `1` for scheduled
bills.
NetAmount:
type: number
format: double
nullable: true
description: Net amount of the bill.
ParentOrgId:
type: integer
format: int64
nullable: true
description: Parent organization identifier.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaymentId:
$ref: '#/components/schemas/PaymentIdString'
nullable: true
PaymentMethod:
$ref: '#/components/schemas/BillQueryRecord2PaymentMethod'
nullable: true
description: Preferred payment method used.
paylinkId:
type: string
nullable: true
description: Paylink identifier associated with the bill.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
PaypointEntryname:
type: string
nullable: true
description: Entry name of the paypoint.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint's legal name.
Source:
type: string
nullable: true
description: Source of the bill.
Status:
$ref: '#/components/schemas/Billstatus'
nullable: true
Terms:
$ref: '#/components/schemas/Terms'
nullable: true
description: >-
The payment terms for invoice. If no terms were defined initially,
then response data for this field will default to `N30`.
TotalAmount:
type: number
format: double
nullable: true
description: Total amount of the bill including taxes and fees.
Transaction:
$ref: '#/components/schemas/TransactionOutQueryRecord'
nullable: true
description: MoneyOut transaction associated to the bill.
Vendor:
$ref: '#/components/schemas/VendorOutData'
nullable: true
required:
- AccountingField1
- AccountingField2
- AdditionalData
- BatchNumber
- billApprovals
- BillDate
- billEvents
- BillItems
- BillNumber
- Comments
- CreatedAt
- Discount
- DocumentsRef
- DueDate
- EndDate
- EntityID
- externalPaypointID
- Frequency
- IdBill
- LastUpdated
- LotNumber
- Mode
- NetAmount
- ParentOrgId
- ParentOrgName
- PaymentId
- PaymentMethod
- paylinkId
- PaypointDbaname
- PaypointEntryname
- PaypointLegalname
- Source
- Status
- Terms
- TotalAmount
- Transaction
- Vendor
BillQueryRecord2BillApprovalsItem:
title: BillQueryRecord2BillApprovalsItem
type: object
properties:
approved:
type: integer
nullable: true
description: >-
Indicates whether the bill has been approved. `0` is false, and `1`
is true.
approvedTime:
type: string
format: date-time
nullable: true
description: Timestamp of when the approval was made, in UTC.
comments:
type: string
nullable: true
description: Additional comments on the approval.
email:
$ref: '#/components/schemas/Email'
nullable: true
description: The approving user's email address.
Id:
type: integer
format: int64
nullable: true
description: The approving user's ID.
required:
- approvedTime
BillQueryRecord2PaymentMethod:
title: BillQueryRecord2PaymentMethod
type: string
enum:
- vcard
- ach
- check
- card
- managed
description: Preferred payment method used.
Billstatus:
title: Billstatus
type: integer
description: |-
The bill's status. Values are:
- `-99`: deleted or canceled
- `1`: Active
- `2`: Sent to approval
- `5`: Partially approved
- `11`: Rejected
- `20`: Approved
- `50`: Payment in transit
- `100`: Paid "
BinData:
title: BinData
type: object
description: >-
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.
properties:
binMatchedLength:
type: string
nullable: true
description: |-
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.
binCardBrand:
type: string
nullable: true
description: |-
The card brand. For example, Visa, Mastercard, American Express,
Discover.
binCardType:
type: string
nullable: true
description: 'The type of card: Credit or Debit.'
binCardCategory:
type: string
nullable: true
description: >-
The category of the card, which indicates the card product. For
example: Standard, Gold, Platinum, etc. The binCardCategory for
prepaid cards is marked `PREPAID`.
binCardIssuer:
type: string
nullable: true
description: The name of the financial institution that issued the card.
binCardIssuerCountry:
type: string
nullable: true
description: The issuing financial institution's country name.
binCardIssuerCountryCodeA2:
type: string
nullable: true
description: >-
The issuing financial institution's two-character ISO country code.
See [this resource](https://www.iso.org/obp/ui/#search) for a list
of codes.
binCardIssuerCountryNumber:
type: string
nullable: true
description: >-
The issuing financial institution's ISO standard numeric country
code. See [this resource](https://www.iso.org/obp/ui/#search) for a
list of codes.
binCardIsRegulated:
type: string
nullable: true
description: Indicates whether the card is regulated.
binCardUseCategory:
type: string
nullable: true
description: The use category classification for the card.
binCardIssuerCountryCodeA3:
type: string
nullable: true
description: >-
The issuing financial institution's three-character ISO country
code.
See [this resource](https://www.iso.org/obp/ui/#search) for a list
of
codes.
Binperson:
title: Binperson
type: integer
description: >-
Numeric percent of volume processed in person. To pass validation,
`binperson`, `binweb`, and `binphone` must total 100 together.
Binphone:
title: Binphone
type: integer
description: >-
Numeric percent of volume processed by phone. To pass validation,
`binperson`, `binweb`, and `binphone` must total 100 together.
Binweb:
title: Binweb
type: integer
description: >-
Numeric percent of volume processed on web. To pass validation,
`binperson`, `binweb`, and `binphone` must total 100 together.
Bnk:
title: Bnk
type: object
properties:
accountNumber:
$ref: '#/components/schemas/LinkData'
nullable: true
bankName:
$ref: '#/components/schemas/LinkData'
nullable: true
routingAccount:
$ref: '#/components/schemas/LinkData'
nullable: true
typeAccount:
$ref: '#/components/schemas/LinkData'
nullable: true
BoardingApplicationAttachments:
title: BoardingApplicationAttachments
type: object
properties:
filelist:
type: array
items:
$ref: '#/components/schemas/PairFiles'
nullable: true
description: Array of objects describing files contained in the ZIP file.
zipfile:
type: string
nullable: true
description: Zip file containing attachments.
BoardingAverageBillSize:
title: BoardingAverageBillSize
type: string
description: >-
This is the average amount of each bill you pay through our service. For
example, if your business paid 3 bills for a total of \$1,500 then your
average bill size is \$500.
BoardingAvgMonthlyBill:
title: BoardingAvgMonthlyBill
type: string
description: >-
This is the total number of bills the business pays each month. For
example, if your business pays an electric bill of \$500, a internet
bill of \$150, and various suppliers \$5,000 every month then your
monthly bill volume would be \$5,650.
BoardingBusinessFax:
title: BoardingBusinessFax
type: string
description: The business's fax number.
BoardingBusinessPhone:
title: BoardingBusinessPhone
type: string
description: The business's phone number.
BoardingId:
title: BoardingId
type: integer
format: int64
description: >-
The Payabli-assigned ID of the boarding application linked to this
paypoint.
BoardingLinkApiResponse:
title: BoardingLinkApiResponse
type: object
description: ' '
properties:
responseData:
type: string
nullable: true
description: |-
Reference name for boarding link (if responseText = Success) or
List of empty fields separated by comma (if responseText = Fail)
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
BoardingLinkId:
title: BoardingLinkId
type: integer
description: >-
The boarding link ID. This is found at the end of the boarding link
reference name. For example:
`https://boarding.payabli.com/boarding/app/myorgaccountname-00091`. The
ID is `91`.
BoardingLinkQueryRecord:
title: BoardingLinkQueryRecord
type: object
properties:
acceptOauth:
$ref: '#/components/schemas/AcceptOauth'
nullable: true
acceptRegister:
$ref: '#/components/schemas/AcceptRegister'
nullable: true
builderData:
$ref: '#/components/schemas/BuilderData'
nullable: true
entryAttributes:
$ref: '#/components/schemas/EntryAttributes'
nullable: true
id:
type: integer
format: int64
nullable: true
logo:
$ref: '#/components/schemas/FileContent'
nullable: true
description: Object containing logo file.
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
'pageIdentifier:':
$ref: '#/components/schemas/PageIdentifier'
nullable: true
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
referenceName:
$ref: '#/components/schemas/ReferenceName'
nullable: true
referenceTemplateId:
$ref: '#/components/schemas/ReferenceTemplateId'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
BoardingQueryLinks:
title: BoardingQueryLinks
type: object
properties:
acceptOauth:
$ref: '#/components/schemas/AcceptOauth'
nullable: true
acceptRegister:
$ref: '#/components/schemas/AcceptRegister'
nullable: true
entryAttributes:
$ref: '#/components/schemas/EntryAttributes'
nullable: true
id:
$ref: '#/components/schemas/BoardingLinkId'
nullable: true
lastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
orgParentName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
referenceName:
$ref: '#/components/schemas/ReferenceName'
nullable: true
referenceTemplateId:
$ref: '#/components/schemas/ReferenceTemplateId'
nullable: true
templateCode:
$ref: '#/components/schemas/TemplateCode'
nullable: true
templateName:
$ref: '#/components/schemas/TemplateName'
nullable: true
BoardingStatus:
title: BoardingStatus
type: integer
description: >-
The application's status in the merchant boarding process. See [Boarding
Status Reference](/developers/references/boarding-statuses) for more.
Bphone:
title: Bphone
type: string
description: Business phone number.
BSection:
title: BSection
type: object
properties:
address:
$ref: '#/components/schemas/BAddress'
nullable: true
details:
$ref: '#/components/schemas/BDetails'
nullable: true
Bstate:
title: Bstate
type: string
description: Business state.
Bsummary:
title: Bsummary
type: string
description: A summary of what the business sells in terms of goods or services.
BuilderData:
title: BuilderData
type: object
properties:
services:
$ref: '#/components/schemas/SSection'
nullable: true
attributes:
$ref: '#/components/schemas/ASection'
nullable: true
banking:
$ref: '#/components/schemas/DSection'
nullable: true
business:
$ref: '#/components/schemas/BSection'
nullable: true
owners:
$ref: '#/components/schemas/OSection'
nullable: true
processing:
$ref: '#/components/schemas/PSection'
nullable: true
BusinessSection:
title: BusinessSection
type: object
description: Details about a business.
properties:
baddress:
$ref: '#/components/schemas/TemplateElement'
nullable: true
baddress1:
$ref: '#/components/schemas/TemplateElement'
nullable: true
bcity:
$ref: '#/components/schemas/TemplateElement'
nullable: true
bcountry:
$ref: '#/components/schemas/TemplateElement'
nullable: true
bstate:
$ref: '#/components/schemas/TemplateElement'
nullable: true
btype:
$ref: '#/components/schemas/TemplateElement'
nullable: true
bzip:
$ref: '#/components/schemas/TemplateElement'
nullable: true
dbaname:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ein:
$ref: '#/components/schemas/TemplateElement'
nullable: true
faxnumber:
$ref: '#/components/schemas/TemplateElement'
nullable: true
legalname:
$ref: '#/components/schemas/TemplateElement'
nullable: true
license:
$ref: '#/components/schemas/TemplateElement'
nullable: true
licstate:
$ref: '#/components/schemas/TemplateElement'
nullable: true
maddress:
$ref: '#/components/schemas/TemplateElement'
nullable: true
maddress1:
$ref: '#/components/schemas/TemplateElement'
nullable: true
mcity:
$ref: '#/components/schemas/TemplateElement'
nullable: true
mcountry:
$ref: '#/components/schemas/TemplateElement'
nullable: true
mstate:
$ref: '#/components/schemas/TemplateElement'
nullable: true
mzip:
$ref: '#/components/schemas/TemplateElement'
nullable: true
phonenumber:
$ref: '#/components/schemas/TemplateElement'
nullable: true
startdate:
$ref: '#/components/schemas/TemplateElement'
nullable: true
taxfillname:
$ref: '#/components/schemas/TemplateElement'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
website:
$ref: '#/components/schemas/TemplateElement'
nullable: true
additionalData:
$ref: '#/components/schemas/TemplateAdditionalDataSection'
nullable: true
Busstartdate:
title: Busstartdate
type: string
description: |-
Business start date. Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
ButtonElement:
title: ButtonElement
type: object
properties:
label:
type: string
description: Label for custom payment button
size:
$ref: '#/components/schemas/ButtonElementSize'
nullable: true
description: Specify size of custom payment button
required:
- label
ButtonElementSize:
title: ButtonElementSize
type: string
enum:
- sm
- md
- lg
description: Specify size of custom payment button
Bzip:
title: Bzip
type: string
description: Business ZIP.
CardAcceptanceElement:
title: CardAcceptanceElement
type: object
properties:
types:
$ref: '#/components/schemas/CardTypes'
nullable: true
posCol:
$ref: '#/components/schemas/PosCol'
nullable: true
posRow:
$ref: '#/components/schemas/PosRow'
nullable: true
readOnly:
$ref: '#/components/schemas/ReadOnly'
nullable: true
value:
type: string
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
Cardcvv:
title: Cardcvv
type: string
description: >-
Card Verification Value (CVV) associated with the card number. We
**strongly recommend** that you include this field when using `card` as
a method.
Cardexp:
title: Cardexp
type: string
description: >-
Card expiration date in format MMYY or MM/YY. Required for card
transactions.
CardFeeSection:
title: CardFeeSection
type: object
properties:
achBatchCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
annualCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
avsCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
chargebackCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ddaRejectsCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
earlyTerminationCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
minimumProcessingCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
monthlyPCICardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
montlyPlatformCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
retrievalCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
transactionCardFee:
$ref: '#/components/schemas/TemplateElement'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
CardFlatSection:
title: CardFlatSection
type: object
properties:
tiers:
type: array
items:
$ref: '#/components/schemas/CardType'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
Cardholder:
title: Cardholder
type: string
description: Cardholder name.
CardIcpSection:
title: CardIcpSection
type: object
properties:
tiers:
type: array
items:
$ref: '#/components/schemas/CardType'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
CardLinkTypes:
title: CardLinkTypes
type: object
properties:
amex:
$ref: '#/components/schemas/LinkData'
nullable: true
discover:
$ref: '#/components/schemas/LinkData'
nullable: true
mastercard:
$ref: '#/components/schemas/LinkData'
nullable: true
visa:
$ref: '#/components/schemas/LinkData'
nullable: true
Cardnumber:
title: Cardnumber
type: string
description: >-
The card number. Required when method is `card` and a `storedMethodId`
isn't included.
CardPassThroughSection:
title: CardPassThroughSection
type: object
properties:
multiTier:
type: boolean
nullable: true
tiers:
type: array
items:
$ref: '#/components/schemas/CardTypePass'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
CardSection:
title: CardSection
type: object
properties:
acceptance:
$ref: '#/components/schemas/CardLinkTypes'
nullable: true
fees:
$ref: '#/components/schemas/BasicTable'
nullable: true
price:
$ref: '#/components/schemas/BasicTable'
nullable: true
CardService:
title: CardService
type: object
properties:
batchCutoffTime:
$ref: '#/components/schemas/TemplateElement'
nullable: true
description: >-
Controls how to present the `batchCutoffTime` field on the
application. If this field isn't sent, batch cut off time defaults
to 5 ET.
cardAcceptance:
$ref: '#/components/schemas/CardAcceptanceElement'
nullable: true
cardFees:
$ref: '#/components/schemas/CardFeeSection'
nullable: true
cardFlat:
$ref: '#/components/schemas/CardFlatSection'
nullable: true
cardFlat_amountxAuth:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardFlat_highPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardFlat_lowPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardFlat_percentxAuth:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardICP:
$ref: '#/components/schemas/CardIcpSection'
nullable: true
cardICP_amountxAuth:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardICP_highPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardICP_lowPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardICP_percentxAuth:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardPassThrough:
$ref: '#/components/schemas/CardPassThroughSection'
nullable: true
cardPassThrough_amountRecurring:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardPassThrough_amountxAuth:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardPassThrough_highPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardPassThrough_lowPayRange:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardPassThrough_percentRecurring:
$ref: '#/components/schemas/TemplateElement'
nullable: true
cardPassThrough_percentxAuth:
$ref: '#/components/schemas/TemplateElement'
nullable: true
discountFrequency:
$ref: '#/components/schemas/TemplateElement'
nullable: true
fundingRollup:
$ref: '#/components/schemas/TemplateElement'
nullable: true
gateway:
$ref: '#/components/schemas/TemplateElement'
nullable: true
passThroughCost:
$ref: '#/components/schemas/TemplateElement'
nullable: true
pdfTemplateId:
$ref: '#/components/schemas/TemplateElement'
nullable: true
pricingPlan:
type: integer
format: int64
nullable: true
pricingType:
$ref: '#/components/schemas/TemplateElement'
nullable: true
processor:
$ref: '#/components/schemas/TemplateElement'
nullable: true
provider:
$ref: '#/components/schemas/TemplateElement'
nullable: true
tierName:
$ref: '#/components/schemas/TemplateElement'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
CardSetup:
title: CardSetup
type: object
properties:
acceptAmex:
type: boolean
nullable: true
description: Determines whether American Express is accepted.
acceptDiscover:
type: boolean
nullable: true
description: Determines whether Discover is accepted.
acceptMastercard:
type: boolean
nullable: true
description: Determines whether Mastercard is accepted.
acceptVisa:
type: boolean
nullable: true
description: Determines whether Visa is accepted.
CardType:
title: CardType
type: object
properties:
amex:
$ref: '#/components/schemas/TierItem'
nullable: true
discover:
$ref: '#/components/schemas/TierItem'
nullable: true
masterCard:
$ref: '#/components/schemas/TierItem'
nullable: true
visa:
$ref: '#/components/schemas/TierItem'
nullable: true
CardTypePass:
title: CardTypePass
type: object
properties:
amex:
$ref: '#/components/schemas/TierItemPass'
nullable: true
discover:
$ref: '#/components/schemas/TierItemPass'
nullable: true
masterCard:
$ref: '#/components/schemas/TierItemPass'
nullable: true
visa:
$ref: '#/components/schemas/TierItemPass'
nullable: true
CardTypes:
title: CardTypes
type: object
properties:
amex:
$ref: '#/components/schemas/BasicTemplateElement'
nullable: true
discover:
$ref: '#/components/schemas/BasicTemplateElement'
nullable: true
masterCard:
$ref: '#/components/schemas/BasicTemplateElement'
nullable: true
visa:
$ref: '#/components/schemas/BasicTemplateElement'
nullable: true
Cardzip:
title: Cardzip
type: string
description: >-
ZIP or postal code for the billing address of cardholder. We **strongly
recommend** that you include this field when using `card` as a method.
Cascade:
title: Cascade
type: boolean
description: >-
When `true`, the wallet service configuration cascades to all paypoints
and suborganizations belonging to the parent entity.
CascadeJobDetails:
title: CascadeJobDetails
type: object
description: Details about the cascade process.
properties:
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
jobErrorMessage:
type: string
nullable: true
description: Error message for a failed cascade process.
jobId:
$ref: '#/components/schemas/JobId'
nullable: true
jobStatus:
$ref: '#/components/schemas/JobStatus'
nullable: true
updatedAt:
$ref: '#/components/schemas/LastModified'
nullable: true
Cash:
title: Cash
type: object
properties:
method:
type: string
const: cash
description: >-
Method to use for the transaction. For cash transactions, use
`cash`.
required:
- method
Category:
title: Category
type: string
description: >-
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
ChargebackId:
title: ChargebackId
type: integer
format: int64
description: Identifier of chargeback transaction
Check:
title: Check
type: object
properties:
achHolder:
$ref: '#/components/schemas/AchHolder'
description: The checking accountholder's name.
method:
type: string
const: check
description: >-
Method to use for the transaction. Use `check` for a paper check
transaction. When the method is `check`, then
`paymentDetails.checkNumber` is required.
required:
- achHolder
- method
CityNullable:
title: CityNullable
type: string
description: The city.
CList:
title: CList
type: object
properties:
contactEmail:
$ref: '#/components/schemas/LinkData'
nullable: true
contactName:
$ref: '#/components/schemas/LinkData'
nullable: true
contactPhone:
$ref: '#/components/schemas/LinkData'
nullable: true
contactTitle:
$ref: '#/components/schemas/LinkData'
nullable: true
CloudQueryApiResponse:
title: CloudQueryApiResponse
type: object
description: >-
Object containing details about cloud devices and their registration
history.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseList:
type: array
items:
$ref: '#/components/schemas/PoiDevice'
nullable: true
description: List of devices and history of registration.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
Comments:
title: Comments
type: string
description: Any comment or description.
ConfigureApplePayOrganizationApiResponse:
title: ConfigureApplePayOrganizationApiResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/ApplePayOrganizationUpdateData'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
ConfigureApplePaypointApiResponse:
title: ConfigureApplePaypointApiResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/ApplePayPaypointRegistrationData'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
roomId:
type: integer
format: int64
nullable: true
description: Field not in use on this endpoint
required:
- responseText
ConfigureGooglePaypointApiResponse:
title: ConfigureGooglePaypointApiResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
responseCode:
$ref: '#/components/schemas/Responsecode'
responseData:
$ref: '#/components/schemas/GooglePayPaypointRegistrationData'
responseText:
$ref: '#/components/schemas/ResponseText'
roomId:
type: integer
format: int64
nullable: true
description: Field not in use on this endpoint
required:
- isSuccess
- pageIdentifier
- responseCode
- responseData
- responseText
ContactElement:
title: ContactElement
type: object
properties:
emailLabel:
type: string
nullable: true
description: Custom content for email
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
header:
type: string
nullable: true
description: Header text for section
order:
$ref: '#/components/schemas/Order'
nullable: true
paymentIcons:
type: boolean
nullable: true
description: Flag indicating if icons for accepted card brands will be shown
phoneLabel:
type: string
nullable: true
description: Custom content for phone number
Contacts:
title: Contacts
type: object
properties:
contactEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: Contact email address.
contactName:
type: string
nullable: true
description: Contact name.
contactPhone:
type: string
nullable: true
description: Contact phone number.
contactTitle:
type: string
nullable: true
description: Contact title.
additionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
ContactsResponse:
title: ContactsResponse
type: object
properties:
ContactEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: Contact email address.
ContactName:
type: string
nullable: true
description: Contact name.
ContactPhone:
type: string
nullable: true
description: Contact phone number.
ContactTitle:
type: string
nullable: true
description: Contact title.
ContactsField:
title: ContactsField
type: array
items:
$ref: '#/components/schemas/Contacts'
description: List of contacts.
CountryNullable:
title: CountryNullable
type: string
description: >-
The country in ISO-3166-1 alpha 2 format. See
https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
CreatedAt:
title: CreatedAt
type: string
format: date-time
description: Timestamp of when record was created, in UTC.
CustomerData:
title: CustomerData
type: object
description: Data about a single customer.
properties:
customerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
nullable: true
customerUsername:
type: string
nullable: true
description: Customer username for customer portal
customerPsw:
type: string
nullable: true
description: Customer password for customer portal
customerStatus:
$ref: '#/components/schemas/CustomerStatus'
nullable: true
company:
type: string
nullable: true
description: Company name
firstname:
type: string
nullable: true
description: Customer first name
lastname:
type: string
nullable: true
description: Customer last name
phone:
type: string
nullable: true
description: Customer phone number
email:
$ref: '#/components/schemas/Email'
nullable: true
description: Customer email address.
address:
type: string
nullable: true
description: Customer address
address1:
type: string
nullable: true
description: Additional customer address
city:
type: string
nullable: true
description: Customer city
state:
type: string
nullable: true
description: Customer State
zip:
type: string
nullable: true
description: Customer postal code
country:
type: string
nullable: true
description: >-
Customer country in ISO-3166-1 alpha 2 format. See
https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
shippingAddress:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
shippingAddress1:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
shippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
shippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
shippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
shippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
balance:
type: number
format: double
nullable: true
description: Customer balance.
timeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
additionalFields:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
description: Additional Custom fields in format "key":"value".
identifierFields:
$ref: '#/components/schemas/Identifierfields'
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
CustomerId:
title: CustomerId
type: integer
format: int64
description: The Payabli-generated unique ID for the customer.
Customeridtrans:
title: Customeridtrans
type: integer
format: int64
description: >-
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.
CustomerNumberNullable:
title: CustomerNumberNullable
type: string
description: >-
User-provided unique identifier for the customer. This is typically the
customer ID from your own system.
CustomerQueryRecords:
title: CustomerQueryRecords
type: object
properties:
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
customerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
nullable: true
customerUsername:
type: string
nullable: true
description: Username for customer.
customerStatus:
$ref: '#/components/schemas/CustomerStatus'
nullable: true
Company:
type: string
nullable: true
description: Company name.
Firstname:
type: string
nullable: true
description: Customer first name.
Lastname:
type: string
nullable: true
description: Customer last name.
Phone:
type: string
nullable: true
description: Customer phone number.
Email:
$ref: '#/components/schemas/Email'
nullable: true
description: Customer email address.
Address:
type: string
nullable: true
description: Customer address.
Address1:
type: string
nullable: true
description: Additional line for customer address.
City:
type: string
nullable: true
description: Customer city.
State:
type: string
nullable: true
description: Customer state.
Zip:
type: string
nullable: true
description: Customer postal code.
Country:
type: string
nullable: true
description: Customer country.
ShippingAddress:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
ShippingAddress1:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
ShippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
ShippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
ShippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
ShippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
Balance:
type: number
format: double
nullable: true
description: Customer balance.
TimeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
MFA:
$ref: '#/components/schemas/Mfa'
nullable: true
MFAMode:
$ref: '#/components/schemas/MfaMode'
nullable: true
snProvider:
type: string
nullable: true
description: |-
Social network linked to customer. Possible values:
- `facebook`
- `google`
- `twitter`
- `microsoft`
snIdentifier:
type: string
nullable: true
description: Identifier or token for customer in linked social network.
snData:
type: string
nullable: true
description: >-
Additional data provided by the social network related to the
customer.
LastUpdated:
type: string
format: date-time
nullable: true
description: Date and time of last update.
Created:
type: string
format: date-time
nullable: true
description: Date and time created.
AdditionalFields:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
description: List of additional custom fields in format key:value.
IdentifierFields:
$ref: '#/components/schemas/Identifierfields'
nullable: true
Subscriptions:
type: array
items:
$ref: '#/components/schemas/SubscriptionQueryRecords'
nullable: true
description: List of subscriptions associated to the customer.
StoredMethods:
type: array
items:
$ref: '#/components/schemas/MethodQueryRecords'
nullable: true
description: List of payment methods associated to the customer.
customerSummary:
$ref: '#/components/schemas/CustomerSummaryRecord'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: Paypoint legal name.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: Paypoint DBA name.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ParentOrgId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
customerConsent:
$ref: '#/components/schemas/CustomerQueryRecordsCustomerConsent'
nullable: true
CustomerQueryRecordsCustomerConsent:
title: CustomerQueryRecordsCustomerConsent
type: object
properties:
eCommunication:
$ref: >-
#/components/schemas/CustomerQueryRecordsCustomerConsentECommunication
nullable: true
description: Describes the customer's email communications consent status.
sms:
$ref: '#/components/schemas/CustomerQueryRecordsCustomerConsentSms'
nullable: true
description: Describes the customer's SMS communications consent status.
CustomerQueryRecordsCustomerConsentECommunication:
title: CustomerQueryRecordsCustomerConsentECommunication
type: object
description: Describes the customer's email communications consent status.
properties:
status:
$ref: '#/components/schemas/OptinStatus'
nullable: true
updatedAt:
$ref: '#/components/schemas/LastModified'
nullable: true
CustomerQueryRecordsCustomerConsentSms:
title: CustomerQueryRecordsCustomerConsentSms
type: object
description: Describes the customer's SMS communications consent status.
properties:
status:
$ref: '#/components/schemas/OptinStatus'
nullable: true
updatedAt:
$ref: '#/components/schemas/LastModified'
nullable: true
CustomerStatus:
title: CustomerStatus
type: integer
description: |-
Customer Status.
Possible values:
- `-99` Deleted
- `0` Inactive
- `1` Active
- `85` Locked (typically due to multiple failed login attempts)
CustomerSummaryRecord:
title: CustomerSummaryRecord
type: object
properties:
numberofTransactions:
type: integer
nullable: true
description: Number total of transactions or payments
recentTransactions:
type: array
items:
$ref: '#/components/schemas/TransactionQueryRecords'
nullable: true
description: List of more recent 5 transactions belonging to the customer
totalAmountTransactions:
type: number
format: double
nullable: true
description: Total amount in transactions
totalNetAmountTransactions:
type: number
format: double
nullable: true
description: Total net amount in transactions
CustomerVaultId:
title: CustomerVaultId
type: string
DeviceId:
title: DeviceId
$ref: '#/components/schemas/Device'
description: Identifier of registered cloud device used in the transaction
Dbaname:
title: Dbaname
type: string
description: >-
The alternate or common name that this business is doing business under
usually referred to as a DBA name.
DepositDate:
title: DepositDate
type: string
format: date-time
description: The date the funds were deposited.
Descriptor:
title: Descriptor
type: string
description: >-
When the method is a card, this field displays card brand. When the
method is ACH, this field displays the account type for ACH (checking or
savings).
Device:
title: Device
type: string
description: Identifier of registered cloud device used in the transaction.
Discount:
title: Discount
type: number
format: double
description: Discount applied to the invoice.
DisplayProperty:
title: DisplayProperty
type: object
properties:
display:
type: boolean
nullable: true
description: When `true`, the field is displayed on the receipt.
Fixed:
type: boolean
nullable: true
description: This field is unused.
name:
type: string
nullable: true
description: The field's name.
DocumentSection:
title: DocumentSection
type: object
properties:
visble:
$ref: '#/components/schemas/Visible'
nullable: true
subFooter:
$ref: '#/components/schemas/SubFooter'
nullable: true
subHeader:
$ref: '#/components/schemas/SubHeader'
nullable: true
depositBank:
$ref: '#/components/schemas/BankSection'
nullable: true
minimumDocuments:
type: integer
nullable: true
description: >-
The minimum number of documents the applicant must upload with the
application.
uploadDocuments:
type: boolean
nullable: true
description: >-
When `true`, allows the applicant to upload documents to the
application.
bankData:
$ref: '#/components/schemas/BankSection'
nullable: true
termsAndConditions:
$ref: '#/components/schemas/DocumentSectionTermsAndConditions'
nullable: true
signer:
$ref: '#/components/schemas/SignerSection'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
withdrawalBank:
$ref: '#/components/schemas/BankSection'
nullable: true
DocumentSectionTermsAndConditions:
title: DocumentSectionTermsAndConditions
type: object
properties:
tcLinks:
type: array
items:
$ref: '#/components/schemas/DocumentSectionTermsAndConditionsTcLinksItem'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
DocumentSectionTermsAndConditionsTcLinksItem:
title: DocumentSectionTermsAndConditionsTcLinksItem
type: object
properties:
label:
type: string
nullable: true
value:
type: string
nullable: true
DocumentsRef:
title: DocumentsRef
type: object
properties:
filelist:
type: array
items:
$ref: '#/components/schemas/PairFiles'
nullable: true
description: Array of objects describing files contained in the ZIP file.
zipfile:
type: string
nullable: true
description: Zip file containing attachments.
DomainName:
title: DomainName
type: string
description: >-
The domain. For example: `subdomain.domain.com` or `domain.com`. Must
be public. Can't be `localhost`, hidden by a VPN, or protected by a
password.
DSection:
title: DSection
type: object
properties:
depositAccount:
$ref: '#/components/schemas/Bnk'
nullable: true
withdrawalAccount:
$ref: '#/components/schemas/Bnk'
nullable: true
DutyAmount:
title: DutyAmount
type: number
format: double
description: Duty amount.
Ein:
title: Ein
type: string
description: >-
Business EIN or tax ID. This value is masked in API responses, for
example `XXXX6789`.
Element:
title: Element
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
order:
$ref: '#/components/schemas/Order'
nullable: true
Email:
title: Email
type: string
format: email
pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
description: Email address.
EmvAuthResponseData:
title: EmvAuthResponseData
type: string
description: EMV authorization response data, applicable for card transactions.
Enabled:
title: Enabled
type: boolean
description: Toggles whether the section or element is enabled.
EnrollmentStatus:
title: EnrollmentStatus
type: string
description: Enrollment status of vendor in payables program.
EntityId:
title: EntityId
type: integer
format: int64
description: |-
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.
EntityType:
title: EntityType
type: string
description: |-
The entity type. Available values:
- paypoint
- organization
- psp (payment service provider)
Entry:
title: Entry
type: string
description: >-
The entity's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
EntryAttributes:
title: EntryAttributes
type: string
EntrypageId:
title: EntrypageId
type: integer
format: int64
description: >-
If applicable, the internal reference ID to the payment page capturing
the payment.
Entrypointfield:
title: Entrypointfield
type: string
description: The entrypoint identifier.
ExpectedDepositDate:
title: ExpectedDepositDate
type: string
format: date-time
description: The date the funds are expected to be deposited.
ExpectedProcessingDateTime:
title: ExpectedProcessingDateTime
type: string
format: date-time
description: >-
The expected time that the refund will be processed. This value only
appears when the `resultCode` is `10`, which means that the refund has
been initiated and is queued for processing. See [Enhanced Refund
Flow](/guides/pay-in-enhanced-refund-flow) for more information about
refund processing.
ExternalPaypointId:
title: ExternalPaypointId
type: string
description: >-
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.
ExternalProcessorInformation:
title: ExternalProcessorInformation
type: string
description: >-
Processor information, used for troubleshooting and reporting. This
field contains a value when the API key used to make the request has
management permissions.
ExportFormat:
title: ExportFormat
type: string
enum:
- csv
- xlsx
description: >-
Export format for file downloads. When specified, returns data as a file
instead of JSON.
FaxNumber:
title: FaxNumber
type: string
description: Fax number.
FeeAmount:
title: FeeAmount
type: number
format: double
description: Service fee or sub-charge applied.
File:
title: File
type: object
additionalProperties: true
description: >-
A file containing the response data, in the format specified in the
request.
FileContent:
title: FileContent
type: object
description: Contains details about a file. Max upload size is 30 MB.
properties:
fContent:
type: string
nullable: true
description: >-
Content of file, Base64-encoded. Ignored if furl is specified. Max
upload size is 30 MB.
filename:
type: string
nullable: true
description: The name of the attached file.
ftype:
$ref: '#/components/schemas/FileContentFtype'
nullable: true
description: The MIME type of the file (if content is provided)
furl:
type: string
nullable: true
description: Optional URL provided to show or download the file remotely
FileContentFtype:
title: FileContentFtype
type: string
enum:
- pdf
- doc
- docx
- jpg
- jpeg
- png
- gif
- txt
description: The MIME type of the file (if content is provided)
Finishtype:
title: Finishtype
type: object
properties:
calendar:
type: boolean
nullable: true
description: Flag to enable 'calendar' option
untilCancelled:
type: boolean
nullable: true
description: Flag to enable 'untilCancelled' option
ForceCustomerCreation:
title: ForceCustomerCreation
type: boolean
description: >-
When `true`, the request creates a new customer record, regardless of
whether customer identifiers match an existing customer. Defaults to
`false`.
FreightAmount:
title: FreightAmount
type: number
format: double
description: Freight/shipping amount.
Frequency:
title: Frequency
type: string
enum:
- onetime
- weekly
- every2weeks
- every6months
- monthly
- every3months
- annually
description: Frequency for operation.
FrequencyList:
title: FrequencyList
type: object
properties:
annually:
type: boolean
nullable: true
description: Enable or disable the annual frequency.
every2Weeks:
type: boolean
nullable: true
description: Enable or disable the every-two-weeks frequency.
every3Months:
type: boolean
nullable: true
description: Enable or disable the every-three-months frequency.
every6Months:
type: boolean
nullable: true
description: Enable or disable the every-six-months frequency.
monthly:
type: boolean
nullable: true
description: Enable or disable the monthly frequency.
onetime:
type: boolean
nullable: true
description: Enable or disable the one-time frequency.
weekly:
type: boolean
nullable: true
description: Enable or disable the weekly frequency.
Frequencynotification:
title: Frequencynotification
type: string
enum:
- one-time
- daily
- weekly
- biweekly
- monthly
- quarterly
- semiannually
- annually
- untilcancelled
description: >-
Frequency for notification.
For notifications using the *email* ,*sms*, or *web* `method`, the
allowed values are:
- `untilcancelled`
- `one-time`
For notifications using the *report-email* or *report-web* `method`, the
allowed values are:
- `one-time`
- `daily`
- `weekly`
- `biweekly`
- `monthly`
- `quarterly`
- `semiannually`
- `annually`
Gatewayfield:
title: Gatewayfield
type: string
description: Gateway used to process the transaction.
GeneralEvents:
title: GeneralEvents
type: object
properties:
description:
type: string
nullable: true
description: Event description.
eventTime:
type: string
format: date-time
nullable: true
description: Event timestamp, in UTC.
extraData:
type: object
additionalProperties: true
nullable: true
description: Extra data.
refData:
type: string
nullable: true
description: Reference data.
source:
$ref: '#/components/schemas/Source'
nullable: true
description: The event source.
HasVcardTransactions:
title: HasVcardTransactions
type: boolean
HeaderElement:
title: HeaderElement
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
header:
type: string
nullable: true
description: Header text for section
order:
$ref: '#/components/schemas/Order'
nullable: true
Highticketamt:
title: Highticketamt
type: number
format: double
description: High ticket amount.
Holdername:
title: Holdername
type: string
description: Account holder name for the method.
IdempotencyKey:
title: IdempotencyKey
type: string
description: >-
_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. This key isn't generated in Payabli, you must generate
it yourself. This key persists for 2 minutes. After 2 minutes, you can
reuse the key if needed.
Identifierfields:
title: Identifierfields
type: array
items:
type: string
nullable: true
description: >-
List of fields acting as customer identifiers, to be used instead of
CustomerNumber.
Idpaypoint:
title: Idpaypoint
type: integer
format: int64
description: Paypoint ID.
Initiator:
title: Initiator
type: string
description: >-
**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](/guides/pay-in-transactions-cit-mit-overview) for more information.
Instrument:
title: Instrument
type: object
properties:
achAccount:
$ref: '#/components/schemas/Achaccount'
achRouting:
$ref: '#/components/schemas/Achrouting'
billingAddress:
$ref: '#/components/schemas/BillingAddressNullable'
nullable: true
billingCity:
$ref: '#/components/schemas/BillingCityNullable'
nullable: true
billingCountry:
$ref: '#/components/schemas/BillingCountryNullable'
nullable: true
billingState:
$ref: '#/components/schemas/BillingStateNullable'
nullable: true
billingZip:
$ref: '#/components/schemas/BillingZip'
nullable: true
required:
- achAccount
- achRouting
InternalReferenceId:
title: InternalReferenceId
type: integer
format: int64
description: Internal identifier for global vendor account.
InvoiceAmount:
title: InvoiceAmount
type: number
format: double
description: Invoice total amount.
InvoiceElement:
title: InvoiceElement
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
invoiceLink:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Link to invoice
order:
$ref: '#/components/schemas/Order'
nullable: true
viewInvoiceDetails:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Link to view invoice details
InvoiceNumber:
title: InvoiceNumber
type: string
description: >-
Custom number identifying the bill or invoice. Must be unique in
paypoint.
Invoicestatus:
title: Invoicestatus
type: integer
description: |-
Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
InvoiceType:
title: InvoiceType
type: integer
description: Type of invoice. Only `0` for one-time invoices is currently supported.
IpAddress:
title: IpAddress
type: string
description: >-
*Recommended*. The customer's IP address. This field is used to help
prevent fraudulent transactions, and Payabli strongly recommends
including this data.
IsEnabled:
title: IsEnabled
type: boolean
description: When `true`, the service is enabled.
IsRoot:
title: IsRoot
type: boolean
description: When `true`, indicates that this is the organization's root template.
IsSuccess:
title: IsSuccess
type: boolean
description: >-
Boolean indicating whether the operation was successful. A `true` value
indicates success. A `false` value indicates failure.
ItemCommodityCode:
title: ItemCommodityCode
type: string
description: Item or product commodity code. Max length of 250 characters.
ItemDescription:
title: ItemDescription
type: string
description: Item or product description. Max length of 250 characters.
ItemProductCode:
title: ItemProductCode
type: string
description: Item or product code. Max length of 250 characters.
ItemProductName:
title: ItemProductName
type: string
description: Item or product name. Max length of 250 characters.
ItemUnitofMeasure:
title: ItemUnitofMeasure
type: string
description: Unit of measurement. Max length of 100 characters.
IsSameDayACH:
title: IsSameDayACH
type: boolean
description: |-
Indicates if the payout transaction is processed as Same Day ACH. This
is only applicable for ACH transactions.
JobId:
title: JobId
type: string
description: The cascade process ID.
JobStatus:
title: JobStatus
type: string
description: |-
The cascade process status. Available values:
- `in_progress`
- `completed`
- `failed`
KeyValue:
title: KeyValue
type: object
properties:
key:
type: string
nullable: true
description: Key name.
readOnly:
$ref: '#/components/schemas/ReadOnly'
nullable: true
value:
type: string
nullable: true
description: Key value.
KeyValueDuo:
title: KeyValueDuo
type: object
properties:
key:
type: string
nullable: true
description: Key name.
value:
type: string
nullable: true
description: Key value.
LabelElement:
title: LabelElement
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
label:
type: string
nullable: true
description: Label to display for section or element
order:
$ref: '#/components/schemas/Order'
nullable: true
Language:
title: Language
type: string
description: >-
The user's locale for PartnerHub and PayHub localization. Supported
values:
- `en`
- `es`
LastModified:
title: LastModified
type: string
format: date-time
description: Timestamp of when record was last updated, in UTC.
Legalname:
title: Legalname
type: string
description: Business legal name.
License:
title: License
type: string
description: Business license ID or state ID number.
Licensestate:
title: Licensestate
type: string
description: Business license issuing state or province.
LineItem:
title: LineItem
type: object
properties:
itemCategories:
type: array
items:
type: string
nullable: true
nullable: true
description: Array of tags classifying item or product.
itemCommodityCode:
$ref: '#/components/schemas/ItemCommodityCode'
nullable: true
itemCost:
type: number
format: double
description: Item or product price per unit.
itemDescription:
$ref: '#/components/schemas/ItemDescription'
nullable: true
itemMode:
type: integer
nullable: true
description: >-
Internal class of item or product: value '0' is only for invoices,
'1' for bills, and '2' is common for both.
itemProductCode:
$ref: '#/components/schemas/ItemProductCode'
nullable: true
itemProductName:
$ref: '#/components/schemas/ItemProductName'
nullable: true
itemQty:
type: integer
description: Quantity of item or product.
itemUnitOfMeasure:
$ref: '#/components/schemas/ItemUnitofMeasure'
nullable: true
required:
- itemCost
- itemQty
LineItemQueryRecord:
title: LineItemQueryRecord
type: object
properties:
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp of when line item was created, in UTC.
id:
type: integer
format: int64
nullable: true
description: Identifier of line item.
itemCategories:
type: array
items:
type: string
nullable: true
nullable: true
description: Array of tags classifying item or product.
itemCommodityCode:
$ref: '#/components/schemas/ItemCommodityCode'
nullable: true
itemCost:
type: number
format: double
description: Item or product price per unit.
itemDescription:
$ref: '#/components/schemas/ItemDescription'
nullable: true
itemMode:
type: integer
nullable: true
description: >-
Internal class of item or product: value '0' is only for invoices ,
'1' for bills, and '2' common for both.
itemProductCode:
$ref: '#/components/schemas/ItemProductCode'
nullable: true
itemProductName:
$ref: '#/components/schemas/ItemProductName'
nullable: true
itemQty:
type: integer
description: Quantity of item or product.
itemUnitOfMeasure:
$ref: '#/components/schemas/ItemUnitofMeasure'
nullable: true
lastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: Timestamp of when the line item was updated, in UTC.
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
description: The name of the paypoint's parent organization.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: The paypoint's entryname (entrypoint) value.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint's legal name.
required:
- itemCost
- itemQty
LinkData:
title: LinkData
type: object
properties:
ro:
$ref: '#/components/schemas/ReadOnly'
nullable: true
rq:
$ref: '#/components/schemas/RequiredElement'
nullable: true
validator:
type: string
nullable: true
description: |-
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- email
- routing
value:
$ref: '#/components/schemas/ValueTemplates'
nullable: true
LinkRow:
title: LinkRow
type: object
properties:
columns:
type: array
items:
$ref: '#/components/schemas/LinkData'
nullable: true
LocationCode:
title: LocationCode
type: string
description: A location code used to identify the vendor's location.
Maddress:
title: Maddress
type: string
description: The business's mailing address.
Maddress1:
title: Maddress1
type: string
description: Additional line for the business's mailing address.
Maskedaccount:
title: Maskedaccount
type: string
description: >-
Masked card or bank account used in transaction. In the case of Apple
Pay, this is a masked DPAN (device primary account number).
MaxTicket:
title: MaxTicket
type: number
format: double
description: >-
Maximum ticket amount for transactions within the paypoint. Contact
Payabli support to request a change to this value.
GreaterValueAllowed:
title: GreaterValueAllowed
type: boolean
description: >-
Whether a customer fee greater than the configured service fee is
allowed for this credential.
AbsorbDifference:
title: AbsorbDifference
type: boolean
description: >-
Whether the paypoint absorbs the difference between the configured
service fee and the actual fee charged to the customer.
AllowOverride:
title: AllowOverride
type: boolean
description: >-
Whether the configured service fee can be overridden at the transaction
level.
Mcc:
title: Mcc
type: string
description: >-
Business Merchant Category Code (MCC). [This
resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv)
lists MCC codes.
Mcity:
title: Mcity
type: string
description: The business's mail city.
Mcountry:
title: Mcountry
type: string
description: Business mailing country.
Methodall:
title: Methodall
type: string
enum:
- card
- ach
- cloud
- check
- cash
description: Method to use for the transaction.
MethodElement:
title: MethodElement
type: object
properties:
allMethodsChecked:
type: boolean
nullable: true
description: Flag indicating if all allowed payment methods will be pre-selected.
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
header:
type: string
nullable: true
description: Header text for section
methods:
$ref: '#/components/schemas/MethodsList'
nullable: true
order:
$ref: '#/components/schemas/Order'
nullable: true
settings:
$ref: '#/components/schemas/MethodElementSettings'
nullable: true
description: Settings for wallet payment methods.
MethodElementSettings:
title: MethodElementSettings
type: object
description: Settings for wallet payment methods.
properties:
applePay:
$ref: '#/components/schemas/MethodElementSettingsApplePay'
nullable: true
MethodElementSettingsApplePay:
title: MethodElementSettingsApplePay
type: object
properties:
buttonStyle:
$ref: '#/components/schemas/MethodElementSettingsApplePayButtonStyle'
nullable: true
description: >-
The Apple Pay button style. See [Apple Pay Button
Style](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-style)
for more information.
buttonType:
$ref: '#/components/schemas/MethodElementSettingsApplePayButtonType'
nullable: true
description: >-
The text on Apple Pay button. See [Apple Pay Button
Type](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-type)
for more information.
language:
$ref: '#/components/schemas/MethodElementSettingsApplePayLanguage'
nullable: true
description: >-
The Apple Pay button locale. See [Apple Pay Button
Language](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-language)
for more information.
MethodElementSettingsApplePayButtonStyle:
title: MethodElementSettingsApplePayButtonStyle
type: string
enum:
- black
- white-outline
- white
description: >-
The Apple Pay button style. See [Apple Pay Button
Style](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-style)
for more information.
MethodElementSettingsApplePayButtonType:
title: MethodElementSettingsApplePayButtonType
type: string
enum:
- plain
- buy
- donate
- check-out
- book
- continue
- top-up
- order
- rent
- support
- contribute
- tip
- pay
description: >-
The text on Apple Pay button. See [Apple Pay Button
Type](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-type)
for more information.
MethodElementSettingsApplePayLanguage:
title: MethodElementSettingsApplePayLanguage
type: string
enum:
- en-US
- ar-AB
- ca-ES
- zh-CN
- zh-HK
- zh-TW
- hr-HR
- cs-CZ
- da-DK
- de-DE
- nl-NL
- en-AU
- en-GB
- fi-FI
- fr-CA
- fr-FR
- el-GR
- he-IL
- hi-IN
- hu-HU
- id-ID
- it-IT
- ja-JP
- ko-KR
- ms-MY
- nb-NO
- pl-PL
- pt-BR
- pt-PT
- ro-RO
- ru-RU
- sk-SK
- es-MX
- es-ES
- sv-SE
- th-TH
- tr-TR
- uk-UA
- vi-VN
description: >-
The Apple Pay button locale. See [Apple Pay Button
Language](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-language)
for more information.
Methodnotification:
title: Methodnotification
type: string
enum:
- email
- sms
- web
- report-email
- report-web
description: Method to use to send the notification to the target.
MethodQueryRecords:
title: MethodQueryRecords
type: object
properties:
bin:
type: string
nullable: true
description: The bank identification number (BIN). Null when method is ACH.
binData:
$ref: '#/components/schemas/BinData'
nullable: true
descriptor:
$ref: '#/components/schemas/Descriptor'
nullable: true
expDate:
type: string
nullable: true
description: >-
Expiration date associated to the method (only for card) in format
MMYY.
holderName:
$ref: '#/components/schemas/Holdername'
nullable: true
idPmethod:
type: string
nullable: true
description: Method internal ID
lastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: Date of last update
maskedAccount:
$ref: '#/components/schemas/Maskedaccount'
nullable: true
method:
type: string
nullable: true
description: 'Type of payment vehicle: **ach** or **card**'
MethodReferenceId:
title: MethodReferenceId
type: string
description: >-
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 operation performed.
MethodsList:
title: MethodsList
type: object
properties:
amex:
type: boolean
nullable: true
description: When `true`, American Express is accepted.
applePay:
type: boolean
nullable: true
description: When `true`, Apple Pay is accepted.
googlePay:
type: boolean
nullable: true
description: When `true`, Google Pay is accepted.
discover:
type: boolean
nullable: true
description: When `true`, Discover is accepted.
eCheck:
type: boolean
nullable: true
description: When `true`, ACH is accepted.
mastercard:
type: boolean
nullable: true
description: When `true`, Mastercard is accepted.
visa:
type: boolean
nullable: true
description: When `true`, Visa is accepted.
Mfa:
title: Mfa
type: boolean
description: When `true`, multi-factor authentication (MFA) is enabled.
MfaData:
title: MfaData
type: object
properties:
mfa:
type: boolean
nullable: true
mfaMode:
$ref: '#/components/schemas/MfaMode'
nullable: true
MfaMode:
title: MfaMode
type: integer
MfaValidationCode:
title: MfaValidationCode
type: string
description: >-
The validation code for multi-factor authentication, typically a hash or
similar encrypted format.
MinTicket:
title: MinTicket
type: number
format: double
description: >-
Minimum ticket amount for transactions within the paypoint. Contact
Payabli support to request a change to this value.
Mstate:
title: Mstate
type: string
description: The business's mailing address state.
Mzip:
title: Mzip
type: string
description: Business mailing ZIP.
NameUser:
title: NameUser
type: string
Netamountnullable:
title: Netamountnullable
type: number
format: double
description: Net amount.
NetAmountstring:
title: NetAmountstring
type: string
description: Net Amount owed in bill. Required when adding a bill.
NoteElement:
title: NoteElement
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
header:
type: string
nullable: true
description: Header text for section
order:
$ref: '#/components/schemas/Order'
nullable: true
placeholder:
type: string
nullable: true
description: Placeholder text for input field
value:
type: string
nullable: true
description: Pre-populated value for input field
NotificationContent:
title: NotificationContent
type: object
properties:
eventType:
$ref: '#/components/schemas/NotificationContentEventType'
nullable: true
description: The notification's event name.
fileFormat:
$ref: '#/components/schemas/NotificationContentFileFormat'
nullable: true
description: |-
Indicate the format of report file to be generated by the engine.
Used for `method` = *report-email* and *report-web*.
internalData:
type: array
items:
$ref: '#/components/schemas/KeyValueDuo'
nullable: true
description: >-
Array of pairs key:value to insert in request body to target in
**method** = *web* or *report-web*.
reportName:
$ref: '#/components/schemas/NotificationContentReportName'
nullable: true
description: >-
The kind report to generate. For [automated
reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports)
only.
timeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
transactionId:
type: string
nullable: true
description: >-
Used internally to reference the entity or object generating the
event.
webHeaderParameters:
type: array
items:
$ref: '#/components/schemas/KeyValueDuo'
nullable: true
description: >-
Array of pairs key:value to insert in header of request to target in
**method** = *web* or *report-web*.
NotificationContentEventType:
title: NotificationContentEventType
type: string
enum:
- ApprovedPayment
- AuthorizedPayment
- DeclinedPayment
- OriginatedPayment
- SettledPayment
- SubscriptionCreated
- SubscriptionUpdated
- SubscriptionCanceled
- SubscriptionCompleted
- FundedPayment
- VoidedPayment
- RefundedPayment
- HoldTransaction
- ReleasedTransaction
- HoldBatch
- ReleasedBatch
- TransferDisabledCreditFund
- TransferDisabledDebitFund
- TransferNotAvailableBalance
- TransferReturn
- TransferSuccess
- TransferSuspended
- TransferError
- SendReceipt
- RecoveredTransaction
- CreatedApplication
- ApprovedApplication
- FailedBoardingApplication
- SubmittedApplication
- UnderWritingApplication
- ActivatedMerchant
- ReceivedChargeBack
- ChargebackUpdated
- ReceivedRetrieval
- RetrievalUpdated
- ReceivedAchReturn
- HoldingApplication
- DeclinedApplication
- BoardingApplication
- FraudAlert
- InvoiceSent
- InvoicePaid
- InvoiceCreated
- BillPaid
- BillApproved
- BillDisApproved
- BillCanceled
- BillProcessing
- CardCreated
- CardActivated
- CardDeactivated
- CardExpired
- CardExpiring
- CardLimitUpdated
- BatchClosed
- BatchNotClosed
- PayOutFunded
- PayOutProcessed
- PayOutCanceled
- PayOutPaid
- PayOutReturned
- PayoutSubscriptionCreated
- PayoutSubscriptionUpdated
- PayoutSubscriptionCanceled
- PayoutSubscriptionCompleted
- PayoutSubscriptionReminder
- importFileReceived
- importFileProcessed
- importFileError
- exportFileSent
- exportFileError
- FailedEmailNotification
- FailedWebNotification
- FailedSMSNotification
- UserPasswordExpiring
- UserPasswordExpired
- TransactionNotFound
- SystemAlert
- Report
description: The notification's event name.
NotificationContentFileFormat:
title: NotificationContentFileFormat
type: string
enum:
- json
- csv
- xlsx
description: |-
Indicate the format of report file to be generated by the engine.
Used for `method` = *report-email* and *report-web*.
NotificationContentReportName:
title: NotificationContentReportName
type: string
enum:
- Transaction
- Settlement
- Boarding
- Returned
description: >-
The kind report to generate. For [automated
reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports)
only.
NotificationId:
title: NotificationId
type: integer
format: int64
description: >-
The notification's Payabli identifier. This is the ID used to manage the
notification.
NotificationQueryRecord:
title: NotificationQueryRecord
type: object
properties:
content:
$ref: '#/components/schemas/NotificationContent'
nullable: true
description: Notification content.
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp of when notification was created.
frequency:
$ref: '#/components/schemas/Frequencynotification'
nullable: true
lastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: Timestamp of when notification was last updated.
method:
$ref: '#/components/schemas/Methodnotification'
nullable: true
notificationId:
$ref: '#/components/schemas/NotificationId'
nullable: true
ownerId:
$ref: '#/components/schemas/Ownerid'
nullable: true
ownerName:
type: string
nullable: true
description: Name of entity owner of notification.
ownerType:
$ref: '#/components/schemas/Ownertype'
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
description: Custom descriptor of source of notification.
status:
$ref: '#/components/schemas/Statusnotification'
nullable: true
target:
$ref: '#/components/schemas/Target'
nullable: true
NotificationReportRequest:
title: NotificationReportRequest
type: object
description: >-
Information about the report notification configuration (report-email,
report-web).
properties:
content:
$ref: '#/components/schemas/NotificationReportRequestContent'
frequency:
$ref: '#/components/schemas/NotificationReportRequestFrequency'
method:
$ref: '#/components/schemas/NotificationReportRequestMethod'
description: >-
Automated reporting lets you gather critical reports without
manually filtering and exporting the data. Get automated daily,
weekly, and monthly report for daily sales, ACH returns,
settlements, and more. You can send these reports via email or via
webhook. See [Automated
Reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports)
for more.
ownerId:
$ref: '#/components/schemas/Ownerid'
nullable: true
ownerType:
$ref: '#/components/schemas/Ownertype'
status:
$ref: '#/components/schemas/Statusnotification'
nullable: true
target:
type: string
description: >-
Specify the notification target.
For method=report-email the expected value is a list of email
addresses separated by semicolon.
For method=report-web the expected value is a valid and complete
URL. Webhooks support only standard HTTP ports: 80, 443, 8080, or
4443.
required:
- content
- frequency
- method
- ownerType
- target
NotificationReportRequestContent:
title: NotificationReportRequestContent
type: object
properties:
eventType:
type: string
const: Report
nullable: true
description: The notification's event name.
fileFormat:
$ref: '#/components/schemas/NotificationReportRequestContentFileFormat'
nullable: true
description: Indicate the format of report file to be generated by the engine.
internalData:
type: array
items:
$ref: '#/components/schemas/KeyValueDuo'
nullable: true
description: >-
Array of pairs key:value to insert in request body to target in
**method** = *report-web*.
reportName:
$ref: '#/components/schemas/NotificationReportRequestContentReportName'
nullable: true
description: The kind report to generate.
timeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
transactionId:
type: string
nullable: true
description: >-
Used internally to reference the entity or object generating the
event.
webHeaderParameters:
type: array
items:
$ref: '#/components/schemas/KeyValueDuo'
nullable: true
description: >-
Array of pairs key:value to insert in header of request to target in
**method** = *report-web*.
NotificationReportRequestContentFileFormat:
title: NotificationReportRequestContentFileFormat
type: string
enum:
- json
- csv
- xlsx
description: Indicate the format of report file to be generated by the engine.
NotificationReportRequestContentReportName:
title: NotificationReportRequestContentReportName
type: string
enum:
- Transaction
- Settlement
- Boarding
- Returned
description: The kind report to generate.
NotificationReportRequestFrequency:
title: NotificationReportRequestFrequency
type: string
enum:
- one-time
- daily
- weekly
- biweekly
- monthly
- quarterly
- semiannually
- annually
NotificationReportRequestMethod:
title: NotificationReportRequestMethod
type: string
enum:
- report-email
- report-web
description: >-
Automated reporting lets you gather critical reports without manually
filtering and exporting the data. Get automated daily, weekly, and
monthly report for daily sales, ACH returns, settlements, and more. You
can send these reports via email or via webhook. See [Automated
Reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports)
for more.
NotificationStandardRequest:
title: NotificationStandardRequest
type: object
description: >-
Information about the standard notification configuration (email, sms,
web).
properties:
content:
$ref: '#/components/schemas/NotificationStandardRequestContent'
nullable: true
frequency:
$ref: '#/components/schemas/NotificationStandardRequestFrequency'
method:
$ref: '#/components/schemas/NotificationStandardRequestMethod'
description: >-
Get near-instant notifications via email, SMS, or webhooks for
important events like new payment disputes, merchant activations,
fraud alerts, approved transactions, settlement history, vendor
payouts, and more. Use webhooks with notifications to get real-time
updates and automate operations based on key those key events. See
[Notifications](/developers/developer-guides/notifications-and-webhooks-overview#notifications)
for more.
ownerId:
$ref: '#/components/schemas/Ownerid'
nullable: true
ownerType:
$ref: '#/components/schemas/Ownertype'
status:
$ref: '#/components/schemas/Statusnotification'
nullable: true
target:
type: string
description: >-
Specify the notification target.
- For method=email the expected value is a list of email addresses
separated by semicolon.
- For method=sms the expected value is a list of phone numbers
separated by semicolon.
- For method=web the expected value is a valid and complete URL.
Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.
required:
- frequency
- method
- ownerType
- target
NotificationStandardRequestContent:
title: NotificationStandardRequestContent
type: object
properties:
eventType:
$ref: '#/components/schemas/NotificationStandardRequestContentEventType'
nullable: true
description: The notification's event name.
internalData:
type: array
items:
$ref: '#/components/schemas/KeyValueDuo'
nullable: true
description: >-
Array of pairs key:value to insert in request body to target in
**method** = *web*.
transactionId:
type: string
nullable: true
description: >-
Used internally to reference the entity or object generating the
event.
webHeaderParameters:
type: array
items:
$ref: '#/components/schemas/KeyValueDuo'
nullable: true
description: >-
Array of pairs key:value to insert in header of request to target in
**method** = *web*.
NotificationStandardRequestContentEventType:
title: NotificationStandardRequestContentEventType
type: string
enum:
- payin_transaction_rejected
- payin_transaction_onhold
- payin_transaction_released
- payin_transaction_recovered
- payout_transaction_initiated
- payout_transaction_authorized
- payout_transaction_approvedcaptured
- payout_transaction_declined
- payout_transaction_technicaldecline
- payout_transaction_failed
- payout_transaction_error
- payout_transaction_paid
- payout_transaction_returned
- payout_transaction_rejected
- payout_transaction_voidedcancelled
- payout_transaction_processing
- payout_transaction_processed
- payout_transaction_onhold
- payout_transaction_released
- payout_transaction_recovered
- payin_batch_onhold
- payin_batch_released
- payout_batch_open
- payout_batch_onhold
- payout_batch_released
- payout_batch_processed
- payout_batch_paid
- payout_batch_funded
- payout_batch_closed
- payout_batch_notclosed
- payout_batch_fundpending
- payout_batch_cancelled
- payout_batch_transferred
- payout_batch_resolved
- payout_batch_settlement_pending
- payout_batch_settlement_intransit
- payout_batch_settlement_transferred
- payout_batch_settlement_funded
- payout_batch_settlement_resolved
- payout_batch_settlement_exception
- payout_batch_settlement_achreturn
- payout_batch_settlement_held
- payout_batch_settlement_released
- ApprovedPayment
- AuthorizedPayment
- DeclinedPayment
- OriginatedPayment
- SettledPayment
- SubscriptionCreated
- SubscriptionUpdated
- SubscriptionCanceled
- SubscriptionCompleted
- FundedPayment
- VoidedPayment
- RefundedPayment
- HoldTransaction
- ReleasedTransaction
- HoldBatch
- ReleasedBatch
- TransferAdjusted
- TransferDisabledCreditFund
- TransferDisabledDebitFund
- TransferNotAvailableBalance
- TransferReadyforRetry
- TransferResolved
- TransferReturn
- TransferSuccess
- TransferSuspended
- TransferError
- SendReceipt
- RecoveredTransaction
- CreatedApplication
- ApprovedApplication
- FailedBoardingApplication
- SubmittedApplication
- UnderWritingApplication
- ActivatedMerchant
- ReceivedChargeBack
- ChargebackUpdated
- ReceivedRetrieval
- RetrievalUpdated
- ReceivedAchReturn
- HoldingApplication
- DeclinedApplication
- BoardingApplication
- PaypointMoved
- FraudAlert
- InvoiceSent
- InvoicePaid
- InvoiceCreated
- BillPaid
- BillApproved
- BillDisApproved
- BillCanceled
- BillProcessing
- CardCreated
- CardActivated
- CardDeactivated
- CardExpired
- CardExpiring
- CardLimitUpdated
- BatchClosed
- BatchNotClosed
- PayOutFunded
- PayOutProcessed
- PayOutCanceled
- PayOutPaid
- PayOutReturned
- PayoutSubscriptionCreated
- PayoutSubscriptionUpdated
- PayoutSubscriptionCanceled
- PayoutSubscriptionCompleted
- PayoutSubscriptionReminder
- importFileReceived
- importFileProcessed
- importFileError
- exportFileSent
- exportFileError
- UpdatedMerchant
- Report
- FailedEmailNotification
- FailedWebNotification
- FailedSMSNotification
- UserPasswordExpiring
- UserPasswordExpired
- TransactionNotFound
- SystemAlert
description: The notification's event name.
NotificationStandardRequestFrequency:
title: NotificationStandardRequestFrequency
type: string
enum:
- one-time
- untilcancelled
NotificationStandardRequestMethod:
title: NotificationStandardRequestMethod
type: string
enum:
- email
- sms
- web
description: >-
Get near-instant notifications via email, SMS, or webhooks for important
events like new payment disputes, merchant activations, fraud alerts,
approved transactions, settlement history, vendor payouts, and more. Use
webhooks with notifications to get real-time updates and automate
operations based on key those key events. See
[Notifications](/developers/developer-guides/notifications-and-webhooks-overview#notifications)
for more.
OdpSetup:
title: OdpSetup
type: object
properties:
allowAch:
type: boolean
nullable: true
description: Enables or disables ACH payout functionality
allowChecks:
type: boolean
nullable: true
description: Enables or disables check printing payout functionality
allowVCard:
type: boolean
nullable: true
description: Enables or disables vCard payout functionality
processing_region:
$ref: '#/components/schemas/OdpSetupProcessingRegion'
nullable: true
description: Region where payment processing occurs
processor:
type: string
nullable: true
description: Payment processor identifier
issuerNetworkSettingsId:
type: string
nullable: true
description: Reference ID for the program enabled for ODP issuance
OdpSetupProcessingRegion:
title: OdpSetupProcessingRegion
type: string
enum:
- US
- CA
description: Region where payment processing occurs
OnCreate:
title: OnCreate
type: string
description: >-
Action to take when the application is created. The only currently
supported option is `submitApplication`. Use this when you have
collected eSignature elsewhere or are adding additional locations for an
applicant, or when you want to submit an application via API with one
call without using the hosted boarding UI or embedded boarding
components
OList:
title: OList
type: object
properties:
oaddress:
$ref: '#/components/schemas/LinkData'
nullable: true
ocity:
$ref: '#/components/schemas/LinkData'
nullable: true
ocountry:
$ref: '#/components/schemas/LinkData'
nullable: true
odriverstate:
$ref: '#/components/schemas/LinkData'
nullable: true
ostate:
$ref: '#/components/schemas/LinkData'
nullable: true
ownerdob:
$ref: '#/components/schemas/LinkData'
nullable: true
ownerdriver:
$ref: '#/components/schemas/LinkData'
nullable: true
owneremail:
$ref: '#/components/schemas/LinkData'
nullable: true
ownername:
$ref: '#/components/schemas/LinkData'
nullable: true
ownerpercent:
$ref: '#/components/schemas/LinkData'
nullable: true
ownerphone1:
$ref: '#/components/schemas/LinkData'
nullable: true
ownerphone2:
$ref: '#/components/schemas/LinkData'
nullable: true
ownerssn:
$ref: '#/components/schemas/LinkData'
nullable: true
ownertitle:
$ref: '#/components/schemas/LinkData'
nullable: true
ozip:
$ref: '#/components/schemas/LinkData'
nullable: true
Operation:
title: Operation
type: string
description: The transaction's operation.
OptinStatus:
title: OptinStatus
type: integer
description: |-
Customer's consent status.
Allowed status:
- 0: Customer hasn't opted in to communications
- -1: Customer opt in pending
- 1: Customer has opted in to communications
Order:
title: Order
type: integer
description: Order of element or section in container.
Orderdescription:
title: Orderdescription
type: string
description: Text description of the transaction.
OrderId:
title: OrderId
type: string
description: Custom identifier for the transaction.
Orgaddress:
title: Orgaddress
type: string
description: The organization's address.
OrganizationId:
title: OrganizationId
type: integer
format: int64
description: Organization ID for the target organization.
OrganizationQueryRecord:
title: OrganizationQueryRecord
type: object
properties:
services:
type: array
items:
$ref: '#/components/schemas/OrganizationQueryRecordServicesItem'
nullable: true
billingInfo:
$ref: '#/components/schemas/Instrument'
nullable: true
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
hasBilling:
type: boolean
nullable: true
hasResidual:
type: boolean
nullable: true
idOrg:
$ref: '#/components/schemas/Orgid'
nullable: true
isRoot:
$ref: '#/components/schemas/IsRoot'
nullable: true
orgAddress:
$ref: '#/components/schemas/Orgaddress'
nullable: true
orgCity:
$ref: '#/components/schemas/Orgcity'
nullable: true
orgCountry:
$ref: '#/components/schemas/Orgcountry'
nullable: true
orgEntryName:
$ref: '#/components/schemas/Orgentryname'
nullable: true
orgId:
$ref: '#/components/schemas/Orgidstring'
nullable: true
orgLogo:
$ref: '#/components/schemas/FileContent'
nullable: true
orgName:
$ref: '#/components/schemas/Orgname'
nullable: true
orgParentId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
orgParentName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
orgState:
$ref: '#/components/schemas/Orgstate'
nullable: true
orgTimezone:
$ref: '#/components/schemas/Orgtimezone'
nullable: true
orgType:
$ref: '#/components/schemas/Orgtype'
nullable: true
orgWebsite:
$ref: '#/components/schemas/Orgwebsite'
nullable: true
orgZip:
$ref: '#/components/schemas/Orgzip'
nullable: true
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
replyToEmail:
$ref: '#/components/schemas/ReplyToEmail'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
summary:
$ref: '#/components/schemas/SummaryOrg'
nullable: true
users:
type: array
items:
$ref: '#/components/schemas/UserQueryRecord'
nullable: true
OrganizationQueryRecordServicesItem:
title: OrganizationQueryRecordServicesItem
type: object
properties:
description:
type: string
nullable: true
enabled:
type: boolean
nullable: true
monthlyCost:
type: number
format: double
nullable: true
name:
type: string
nullable: true
reseller:
type: boolean
nullable: true
setupCost:
type: number
format: double
nullable: true
txCost:
type: number
format: double
nullable: true
txPercentCost:
type: number
format: double
nullable: true
OrganizationUpdates:
title: OrganizationUpdates
type: object
properties:
cascade:
$ref: '#/components/schemas/WalletCascade'
nullable: true
isEnabled:
$ref: '#/components/schemas/WalletIsEnabled'
nullable: true
Orgcity:
title: Orgcity
type: string
description: The organization's city.
Orgcountry:
title: Orgcountry
type: string
description: The organization's country.
OrgData:
title: OrgData
type: object
properties:
idOrg:
$ref: '#/components/schemas/Orgid'
nullable: true
orgAddress:
$ref: '#/components/schemas/Orgaddress'
nullable: true
orgLogo:
$ref: '#/components/schemas/FileContent'
nullable: true
orgName:
$ref: '#/components/schemas/Orgname'
nullable: true
orgStatus:
type: integer
nullable: true
description: |-
The paypoint's status.
Active - `1`
Inactive - 0
orgType:
$ref: '#/components/schemas/Orgtype'
nullable: true
Orgentryname:
title: Orgentryname
type: string
description: >-
The entryname for the org, in string format. If you leave this blank,
Payabli uses the DBA name.
Orgid:
title: Orgid
type: integer
format: int64
description: Organization ID. Unique identifier assigned to an org by Payabli.
Orgidstring:
title: Orgidstring
type: string
description: >-
An alternate ID for the organization, in string format. This can be your
internal identifier for an org, and is typically a name, like "My
Suborganization".
Orgname:
title: Orgname
type: string
description: The name of the organization.
OrgParentId:
title: OrgParentId
type: integer
format: int64
description: The ID of the org's parent organization.
OrgParentName:
title: OrgParentName
type: string
description: The name of the parent organization.
OrgScope:
title: OrgScope
type: object
properties:
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
orgType:
$ref: '#/components/schemas/Orgtype'
nullable: true
Orgstate:
title: Orgstate
type: string
description: The organization's state.
Orgtimezone:
title: Orgtimezone
type: integer
description: The org's timezone, in UTC offset. For example, -5 is Eastern time.
Orgtype:
title: Orgtype
type: integer
description: The organization type. Currently, this must be `0`.
Orgwebsite:
title: Orgwebsite
type: string
description: The organization's website.
OrgXScope:
title: OrgXScope
type: object
properties:
orgEntry:
$ref: '#/components/schemas/Orgentryname'
nullable: true
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
orgType:
$ref: '#/components/schemas/Orgtype'
nullable: true
Orgzip:
title: Orgzip
type: string
description: The organization's ZIP code.
OSection:
title: OSection
type: object
properties:
contact_list:
$ref: '#/components/schemas/CList'
nullable: true
own_list:
$ref: '#/components/schemas/OList'
nullable: true
OwnerEntityId:
title: OwnerEntityId
type: integer
format: int64
description: >-
The domain's owning entity's ID in Payabli. This value might be
different than the `entityId`, depending on whether the domain is
cascaded and whether it's inherited.`
OwnerEntityType:
title: OwnerEntityType
type: string
description: |-
The domain's owner's entity type. Available values:
- paypoint
- organization
- psp (payment service provider).
Ownerid:
title: Ownerid
type: integer
description: >-
ID for the paypoint or organization that owns the notification.
If the `ownerType` field is `0`, this field is the same as the `orgId`
for the organization that owns this notification.
If the `ownerType` field is `2`, this field is the same as the
`paypointId` for the paypoint that owns this notification.
Owners:
title: Owners
type: object
properties:
ownername:
type: string
nullable: true
description: >-
Person who is registered as the beneficial owner of the business.
This is a combination of first and last name.
ownertitle:
type: string
nullable: true
description: The job title of the person such as CEO or director.
ownerpercent:
type: integer
nullable: true
description: Percentage of ownership the person holds, in integer format.
ownerssn:
type: string
nullable: true
description: >-
The relevant identifier for the person such as a Social Security
Number.
ownerdob:
type: string
nullable: true
description: Owner's date of birth.
ownerphone1:
type: string
nullable: true
description: Owner phone 1.
ownerphone2:
type: string
nullable: true
description: Owner phone 2.
owneremail:
$ref: '#/components/schemas/Email'
nullable: true
description: Owner email.
ownerdriver:
type: string
nullable: true
description: >-
Owner driver's license ID number. Payabli strongly recommends
including this.
oaddress:
type: string
nullable: true
description: >-
Owner street address. This must be the physical address of the
owner, not a P.O. box.
ocity:
type: string
nullable: true
description: Owner address city.
ocountry:
type: string
nullable: true
description: >-
Owner address country in ISO-3166-1 alpha 2 format. Check out
https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
odriverstate:
type: string
nullable: true
description: >-
Owner driver's license State. Payabli strongly recommends including
this.
ostate:
type: string
nullable: true
description: Owner address state.
ozip:
type: string
nullable: true
description: Owner address ZIP.
additionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
Ownership:
title: Ownership
type: array
items:
$ref: '#/components/schemas/Owners'
description: List of Owners with at least a 25% ownership.
OwnersSection:
title: OwnersSection
type: object
description: Information about a business owner.
properties:
contactEmail:
$ref: '#/components/schemas/TemplateElement'
nullable: true
contactName:
$ref: '#/components/schemas/TemplateElement'
nullable: true
contactPhone:
$ref: '#/components/schemas/TemplateElement'
nullable: true
contactTitle:
$ref: '#/components/schemas/TemplateElement'
nullable: true
multipleContacts:
type: boolean
nullable: true
description: Offer add more contacts
multipleOwners:
type: boolean
nullable: true
description: offer add more owners
oaddress:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ocity:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ocountry:
$ref: '#/components/schemas/TemplateElement'
nullable: true
odriverstate:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ostate:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownerdob:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownerdriver:
$ref: '#/components/schemas/TemplateElement'
nullable: true
owneremail:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownername:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownerpercent:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownerphone1:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownerphone2:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownerssn:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ownertitle:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ozip:
$ref: '#/components/schemas/TemplateElement'
nullable: true
subFooter:
$ref: '#/components/schemas/SubFooter'
nullable: true
subHeader:
$ref: '#/components/schemas/SubHeader'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
additionalData:
$ref: '#/components/schemas/TemplateAdditionalDataSection'
nullable: true
Ownertype:
title: Ownertype
type: integer
description: |-
Entity owner type. Accepted values:
- `0`: Organization/partner
- `2`: Paypoint
OwnType:
title: OwnType
type: string
enum:
- Limited Liability Company
- Non-Profit Org
- Partnership
- Private Corp
- Public Corp
- Tax Exempt
- Government
- Sole Proprietor
description: The business ownership type.
PageContent:
title: PageContent
type: object
properties:
amount:
$ref: '#/components/schemas/AmountElement'
nullable: true
description: Amount section of payment page
autopay:
$ref: '#/components/schemas/AutoElement'
nullable: true
description: Autopay section of payment page
contactUs:
$ref: '#/components/schemas/ContactElement'
nullable: true
description: ContactUs section of payment page
entry:
type: string
nullable: true
description: Identifier of entry point owner of page
invoices:
$ref: '#/components/schemas/InvoiceElement'
nullable: true
description: Invoices section of payment page
logo:
$ref: '#/components/schemas/Element'
nullable: true
description: Logo section of payment page
messageBeforePaying:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Message section of payment page
name:
type: string
nullable: true
description: Descriptor of page
notes:
$ref: '#/components/schemas/NoteElement'
nullable: true
description: Notes section of payment page
page:
$ref: '#/components/schemas/PageElement'
nullable: true
description: Page header section of payment page
paymentButton:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Payment button section of payment page
paymentMethods:
$ref: '#/components/schemas/MethodElement'
nullable: true
description: Payment methods section of payment page
payor:
$ref: '#/components/schemas/PayorElement'
nullable: true
description: Customer/Payor section of payment page
review:
$ref: '#/components/schemas/HeaderElement'
nullable: true
description: Review section of payment page
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
description: Unique identifier assigned to the page.
PageElement:
title: PageElement
type: object
properties:
description:
type: string
nullable: true
description: Page description in header
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
header:
type: string
nullable: true
description: Page header
order:
$ref: '#/components/schemas/Order'
nullable: true
PageIdentifier:
title: PageIdentifier
type: string
description: Auxiliary validation used internally by payment pages and components.
PagelinkSetting:
title: PagelinkSetting
type: object
properties:
color:
type: string
nullable: true
description: 'An HTML color code in format #RRGGBB'
customCssUrl:
type: string
nullable: true
description: Complete URL to a custom CSS file to be loaded with the page
language:
type: string
nullable: true
description: Two-letter code following ISO 639-1
pageLogo:
$ref: '#/components/schemas/FileContent'
nullable: true
description: Object containing logo file to upload/ use in page
redirectAfterApprove:
type: boolean
nullable: true
description: >-
Flag indicating if the capability for redirection in the page will
be activated
redirectAfterApproveUrl:
type: string
nullable: true
description: Complete URL where the page will be redirected after completion
PageSetting:
title: PageSetting
type: object
properties:
color:
type: string
nullable: true
description: 'An HTML color code in format #RRGGBB'
customCssUrl:
type: string
nullable: true
description: Complete URL to a custom CSS file to be loaded with the page
language:
type: string
nullable: true
description: Two-letter code following ISO 639-1
pageLogo:
$ref: '#/components/schemas/FileContent'
nullable: true
description: Object containing logo file to upload/ use in page
paymentButton:
$ref: '#/components/schemas/ButtonElement'
nullable: true
redirectAfterApprove:
type: boolean
nullable: true
description: >-
Flag indicating if the capability for redirection in the page will
be activated
redirectAfterApproveUrl:
type: string
nullable: true
description: Complete URL where the page will be redirected after completion
Pagesize:
title: Pagesize
type: integer
description: Number of records on each response page.
PairFiles:
title: PairFiles
type: object
properties:
originalName:
type: string
nullable: true
description: Original filename
zipName:
type: string
nullable: true
description: >-
Filename assigned to zipped file. This is the name to use for
reference in the API functions to get files in attachments.
descriptor:
type: string
nullable: true
description: Descriptor of the file.
PayabliApiResponse:
title: PayabliApiResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
$ref: '#/components/schemas/Responsedata'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponse0:
title: PayabliApiResponse0
type: object
description: General response for certain `moneyIn` and `moneyOut` endpoints.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseData:
$ref: '#/components/schemas/PayabliApiResponse0ResponseData'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponse00:
title: PayabliApiResponse00
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/Responsedata'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponse0000:
title: PayabliApiResponse0000
type: object
description: The response for canceling a single payout transaction.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/PayabliApiResponse0ResponseData'
nullable: true
required:
- responseText
PayabliApiResponse00Responsedatanonobject:
title: PayabliApiResponse00Responsedatanonobject
type: object
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
type: integer
format: int64
nullable: true
description: >-
Describes the room ID. Only in use on Boarding endpoints, returns
`0` when not applicable.
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
required:
- responseText
PayabliApiResponse0ResponseData:
title: PayabliApiResponse0ResponseData
type: object
properties:
AuthCode:
$ref: '#/components/schemas/Authcode'
nullable: true
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
CustomerId:
$ref: '#/components/schemas/Customeridtrans'
nullable: true
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
ReferenceId:
$ref: '#/components/schemas/Referenceidtrans'
nullable: true
ResultCode:
$ref: '#/components/schemas/ResultCode'
nullable: true
ResultText:
$ref: '#/components/schemas/Resulttext'
nullable: true
PayabliApiResponse6:
title: PayabliApiResponse6
type: object
description: Response schema for line item operations.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
description: >-
If `isSuccess` = true, this contains the line item identifier. If
`isSuccess` = false, this contains the reason of the error.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseCustomerQuery:
title: PayabliApiResponseCustomerQuery
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
$ref: '#/components/schemas/CustomerQueryRecords'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseError400:
title: PayabliApiResponseError400
type: object
properties:
isSuccess:
type: boolean
nullable: true
description: >-
Boolean indicating whether the operation was successful. A `true`
value indicates success. A `false` value indicates failure.
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
type: integer
nullable: true
description: >-
A code that indicates the operation's failure reason. See [API
Response
Codes](https://docs.payabli.com/api-reference/api-responses) for a
full reference.
responseData:
$ref: '#/components/schemas/PayabliApiResponseError400ResponseData'
nullable: true
description: Describes the reason for a failed operation and how to resolve it.
responseText:
type: string
nullable: true
description: 'Response text for operation: ''Success'' or ''Declined''.'
PayabliApiResponseError400ResponseData:
title: PayabliApiResponseError400ResponseData
type: object
description: Describes the reason for a failed operation and how to resolve it.
properties:
explanation:
type: string
nullable: true
description: Describes the reason the operation failed.
todoAction:
type: string
nullable: true
description: Describes how to resolve the error.
PayabliApiResponseGeneric2Part:
title: PayabliApiResponseGeneric2Part
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseImport:
title: PayabliApiResponseImport
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/PayabliApiResponseImportResponseData'
nullable: true
description: The response data containing the result of the import operation.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseImportResponseData:
title: PayabliApiResponseImportResponseData
type: object
description: The response data containing the result of the import operation.
properties:
added:
type: integer
nullable: true
description: The number of records successfully added.
errors:
type: array
items:
type: string
nullable: true
description: List of errors, if any.
rejected:
type: integer
nullable: true
description: The number of records that were rejected.
PayabliApiResponseMfaBasic:
title: PayabliApiResponseMfaBasic
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
mfa:
$ref: '#/components/schemas/Mfa'
nullable: true
mfaMode:
type: string
nullable: true
description: The mode of multi-factor authentication used.
mfaValidationCode:
$ref: '#/components/schemas/MfaValidationCode'
nullable: true
responseData:
type: string
nullable: true
description: Data returned by the response, masked for security.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseNotifications:
title: PayabliApiResponseNotifications
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
description: >-
If `isSuccess` = true, `responseData` contains the notification
identifier.
If `isSuccess` = false, `responseData` contains the reason for the
error.
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/PayabliApiResponseNotificationsResponseData'
nullable: true
description: >-
When the request was successful, this contains the notification ID,
or `nID` used to manage the notification.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseNotificationsResponseData:
title: PayabliApiResponseNotificationsResponseData
oneOf:
- type: integer
- type: string
description: |-
When the request was successful, this contains the notification ID, or
`nID` used to manage the notification.
PayabliApiResponsePaylinks:
title: PayabliApiResponsePaylinks
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
responseData:
$ref: '#/components/schemas/Responsedata'
description: The paylink ID or error details.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- pageIdentifier
- responseCode
- responseData
- responseText
PayabliApiResponsePaymethodDelete:
title: PayabliApiResponsePaymethodDelete
type: object
description: Response body for payment method deletion.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
$ref: '#/components/schemas/PayabliApiResponsePaymethodDeleteResponseData'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponsePaymethodDeleteResponseData:
title: PayabliApiResponsePaymethodDeleteResponseData
type: object
properties:
referenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
description: The method's reference ID.
resultCode:
$ref: '#/components/schemas/ResultCode'
nullable: true
resultText:
$ref: '#/components/schemas/Resulttext'
nullable: true
PayabliApiResponseTemplateId:
title: PayabliApiResponseTemplateId
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
description: When the operation is successful, contains the template's ID.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseUserMfa:
title: PayabliApiResponseUserMfa
type: object
properties:
inactiveTokenTime:
type: integer
nullable: true
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
remaining:
type: integer
nullable: true
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliApiResponseVendors:
title: PayabliApiResponseVendors
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
type: integer
nullable: true
description: >-
If the request was successful, this field contains the identifier
for the vendor.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayabliCredentials:
title: PayabliCredentials
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
description: >-
The identifier for the payment connector, matching the `accountId`
of the linked bank account.
cfeeFix:
type: number
format: double
nullable: true
cfeeFloat:
type: number
format: double
nullable: true
cfeeMax:
type: number
format: double
nullable: true
cfeeMin:
type: number
format: double
nullable: true
maxticket:
type: number
format: double
nullable: true
minticket:
type: number
format: double
nullable: true
mode:
type: integer
nullable: true
description: >-
The payment mode supported by this service. `0` for one-time
payments, `1` for recurring payments, `2` for both.
referenceId:
type: integer
format: int64
nullable: true
service:
type: string
nullable: true
description: >-
The payment service that this credential applies to. A paypoint can
support multiple services, each represented by its own credential
object in the array. Possible values are `card` (credit/debit card),
`ach` (ACH bank transfer), `check` (paper check), `vcard` (virtual
card), `cloud` (card-present), `cash`, `managed` (managed payment
service), and `wallet`.
greaterValueAllowed:
$ref: '#/components/schemas/GreaterValueAllowed'
nullable: true
absorbDifference:
$ref: '#/components/schemas/AbsorbDifference'
nullable: true
allowOverride:
$ref: '#/components/schemas/AllowOverride'
nullable: true
PayabliPages:
title: PayabliPages
type: object
properties:
AdditionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
credentials:
type: array
items:
$ref: '#/components/schemas/PayabliCredentials'
nullable: true
description: Array of credential objects with active services for the page
lastAccess:
type: string
format: date-time
nullable: true
description: Timestamp of last access to page structure
pageContent:
$ref: '#/components/schemas/PageContent'
nullable: true
description: Sections of page
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSettings:
$ref: '#/components/schemas/PageSetting'
nullable: true
description: Settings of page
published:
type: integer
nullable: true
description: >-
Flag indicating if page is active to accept payments. `0` for false,
`1` for true.
receiptContent:
$ref: '#/components/schemas/ReceiptContent'
nullable: true
description: Sections of payment receipt
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
description: Page identifier. Must be unique in platform.
totalAmount:
type: number
format: double
nullable: true
description: Total amount to pay in this page
validationCode:
type: string
nullable: true
description: Base64 encoded image of CAPTCHA associated to this page load
PayCategory:
title: PayCategory
type: object
properties:
description:
type: string
nullable: true
label:
type: string
nullable: true
name:
type: string
nullable: true
optionalPay:
type: boolean
nullable: true
order:
$ref: '#/components/schemas/Order'
nullable: true
quantity:
type: integer
nullable: true
showDescription:
type: boolean
nullable: true
type:
type: string
nullable: true
value:
type: string
nullable: true
PayeeName:
title: PayeeName
type: string
description: Alternative name used to receive paper check.
PaylinkId:
title: PaylinkId
type: string
description: Identifier of payment link associated to the invoice or bill.
PaymentCategories:
title: PaymentCategories
type: object
properties:
amount:
type: number
format: double
description: Price/cost per unit of item or category.
description:
type: string
nullable: true
description: Description of item or category
label:
type: string
description: Name of item or category.
qty:
type: integer
nullable: true
description: Quantity of item or category
required:
- amount
- label
PaymentDetail:
title: PaymentDetail
type: object
description: Details about the payment.
properties:
categories:
type: array
items:
$ref: '#/components/schemas/PaymentCategories'
nullable: true
description: >-
Array of payment categories/line items describing the amount to be
paid.
**Note**: These categories are for information only and aren't
validated against the total amount provided.
checkImage:
type: object
additionalProperties: true
nullable: true
description: Object containing image of paper check.
checkNumber:
type: string
nullable: true
description: >-
A check number to be used in the ach transaction. **Required** for
payment method = 'check'.
currency:
type: string
nullable: true
description: >-
The currency for the transaction, `USD` or `CAD`. If your paypoint
is configured for CAD, you must send the `CAD` value in this field,
otherwise it defaults to USD, which will cause the transaction to
fail.
serviceFee:
type: number
format: double
nullable: true
description: >-
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.
splitFunding:
$ref: '#/components/schemas/SplitFunding'
nullable: true
description: >-
Split funding instructions for the transaction. See [Split a
Transaction](/developers/developer-guides/money-in-split-funding)
for more.
checkUniqueId:
type: string
nullable: true
description: >-
Unique identifier for a processed check image. Required for RDC
(Remote Deposit Capture) transactions where `achCode` is `BOC`. Use
the `id` value from the [check
processing](/developers/api-reference/moneyin/check-capture)
response.
totalAmount:
type: number
format: double
description: >-
Total amount to be charged. If a service fee is sent, then this
amount should include the service fee."
required:
- totalAmount
PaymentDetailCredit:
title: PaymentDetailCredit
type: object
description: 'The PaymentDetail object for microdeposit (MakeCredit) transactions. '
properties:
currency:
type: string
nullable: true
description: >-
Currency code ISO-4217. If not code is provided the currency in the
paypoint setting is taken. Default is **USD**
serviceFee:
type: number
format: double
nullable: true
description: >-
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.
totalAmount:
type: number
format: double
description: >-
Total amount to be charged. If a service fee is provided, then this
amount should include the service fee.
required:
- totalAmount
Paymentid:
title: Paymentid
type: integer
format: int64
description: Unique transaction ID.
PaymentIdString:
title: PaymentIdString
type: string
description: >-
The unique transaction ID. This value is a string representation of a
long integer.
PaymentMethod:
title: PaymentMethod
oneOf:
- $ref: '#/components/schemas/PayMethodCredit'
- $ref: '#/components/schemas/PayMethodACH'
- $ref: '#/components/schemas/PayMethodStoredMethod'
- $ref: '#/components/schemas/PayMethodCloud'
- $ref: '#/components/schemas/Check'
- $ref: '#/components/schemas/Cash'
- $ref: '#/components/schemas/PayMethodBodyAllFields'
description: Information about the payment method for the transaction.
PayMethodBodyAllFields:
title: PayMethodBodyAllFields
type: object
description: 'Model for the PaymentMethod object, includes all method types. '
properties:
achAccount:
$ref: '#/components/schemas/Achaccount'
description: Bank account number. This field is **required** when method = 'ach'.
achAccountType:
$ref: '#/components/schemas/Achaccounttype'
nullable: true
achCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
achHolder:
$ref: '#/components/schemas/AchHolder'
achRouting:
$ref: '#/components/schemas/Achrouting'
description: >-
ABA/routing number of Bank account. This field is **required** when
method = 'ach'.
cardcvv:
$ref: '#/components/schemas/Cardcvv'
nullable: true
cardexp:
$ref: '#/components/schemas/Cardexp'
nullable: true
cardHolder:
$ref: '#/components/schemas/Cardholder'
nullable: true
cardnumber:
$ref: '#/components/schemas/Cardnumber'
nullable: true
cardzip:
$ref: '#/components/schemas/Cardzip'
nullable: true
device:
$ref: '#/components/schemas/Device'
nullable: true
initator:
$ref: '#/components/schemas/Initiator'
nullable: true
method:
$ref: '#/components/schemas/Methodall'
nullable: true
saveIfSuccess:
$ref: '#/components/schemas/SaveIfSuccess'
nullable: true
storedMethodId:
$ref: '#/components/schemas/Storedmethodid'
nullable: true
storedMethodUsageType:
$ref: '#/components/schemas/StoredMethodUsageType'
nullable: true
required:
- achAccount
- achHolder
- achRouting
PayMethodACH:
title: PayMethodACH
type: object
properties:
achAccount:
$ref: '#/components/schemas/Achaccount'
description: Bank account number. This field is **required** when method = 'ach'.
achAccountType:
$ref: '#/components/schemas/Achaccounttype'
nullable: true
description: Bank account type. This field is **required** when method = 'ach'.
achCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
achHolder:
$ref: '#/components/schemas/AchHolder'
achHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
achRouting:
$ref: '#/components/schemas/Achrouting'
description: >-
ABA/routing number of bank account. This field is **required** when
method = 'ach'.
device:
$ref: '#/components/schemas/Device'
nullable: true
method:
type: string
const: ach
required:
- achAccount
- achHolder
- achRouting
- method
PayMethodCredit:
title: PayMethodCredit
type: object
properties:
cardcvv:
$ref: '#/components/schemas/Cardcvv'
nullable: true
cardexp:
$ref: '#/components/schemas/Cardexp'
cardHolder:
$ref: '#/components/schemas/Cardholder'
nullable: true
cardnumber:
$ref: '#/components/schemas/Cardnumber'
cardzip:
$ref: '#/components/schemas/Cardzip'
nullable: true
initiator:
$ref: '#/components/schemas/Initiator'
nullable: true
method:
type: string
const: card
description: >-
Method to use for the transaction. For transactions with a credit or
debit card, or a tokenized card, use `card`.
saveIfSuccess:
$ref: '#/components/schemas/SaveIfSuccess'
nullable: true
required:
- cardexp
- cardnumber
- method
PayMethodCloud:
title: PayMethodCloud
type: object
properties:
device:
$ref: '#/components/schemas/Device'
nullable: true
method:
type: string
const: cloud
description: >-
Method to use for the transaction. For cloud device transactions,
the method is `cloud`.
saveIfSuccess:
$ref: '#/components/schemas/SaveIfSuccess'
nullable: true
required:
- method
PayMethodStoredMethod:
title: PayMethodStoredMethod
type: object
description: >-
The required and recommended fields for a payment made with a stored
payment method.
properties:
initiator:
$ref: '#/components/schemas/Initiator'
nullable: true
method:
$ref: '#/components/schemas/PayMethodStoredMethodMethod'
description: >-
Method to use for the transaction. Use either `card` or `ach`,
depending on what kind of method was tokenized to use a saved
payment method for this transaction.
storedMethodId:
$ref: '#/components/schemas/Storedmethodid'
nullable: true
description: Payabli identifier of a tokenized payment method.
storedMethodUsageType:
$ref: '#/components/schemas/StoredMethodUsageType'
nullable: true
required:
- method
PayMethodStoredMethodMethod:
title: PayMethodStoredMethodMethod
type: string
enum:
- card
- ach
description: >-
Method to use for the transaction. Use either `card` or `ach`, depending
on what kind of method was tokenized to use a saved payment method for
this transaction.
PaymentMethodDomainApiResponse:
title: PaymentMethodDomainApiResponse
type: object
description: Data related to the payment method domain.
properties:
type:
type: string
nullable: true
description: >-
The record type. For payment method domains, this is always
`PaymentMethodDomain`.
applePay:
$ref: '#/components/schemas/ApplePayData'
googlePay:
$ref: '#/components/schemas/GooglePayData'
cascades:
type: array
items:
$ref: '#/components/schemas/CascadeJobDetails'
nullable: true
description: Data about the domain's cascade status.
createdAt:
$ref: '#/components/schemas/CreatedAt'
domainName:
$ref: '#/components/schemas/DomainName'
entityId:
$ref: '#/components/schemas/EntityId'
entityType:
$ref: '#/components/schemas/EntityType'
id:
$ref: '#/components/schemas/PaymentMethodDomainId'
ownerEntityId:
$ref: '#/components/schemas/OwnerEntityId'
ownerEntityType:
$ref: '#/components/schemas/OwnerEntityType'
updatedAt:
$ref: '#/components/schemas/LastModified'
nullable: true
required:
- type
- applePay
- googlePay
- createdAt
- domainName
- entityId
- entityType
- id
- ownerEntityId
- ownerEntityType
PaymentMethodDomainGeneralResponse:
title: PaymentMethodDomainGeneralResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseData:
$ref: '#/components/schemas/PaymentMethodDomainApiResponse'
nullable: true
responseText:
type: string
required:
- responseText
PaymentMethodDomainId:
title: PaymentMethodDomainId
type: string
description: The payment method domain's ID in Payabli.
PayorDataRequest:
title: PayorDataRequest
type: object
description: >-
Customer information. May be required, depending on the paypoint's
settings. Required for subscriptions.
properties:
additionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
billingAddress1:
$ref: '#/components/schemas/BillingAddressNullable'
nullable: true
billingAddress2:
$ref: '#/components/schemas/BillingAddressAddtlNullable'
nullable: true
billingCity:
$ref: '#/components/schemas/BillingCityNullable'
nullable: true
billingCountry:
$ref: '#/components/schemas/BillingCountryNullable'
nullable: true
billingEmail:
$ref: '#/components/schemas/Email'
nullable: true
billingPhone:
$ref: '#/components/schemas/PhoneNumber'
nullable: true
billingState:
$ref: '#/components/schemas/BillingStateNullable'
nullable: true
billingZip:
$ref: '#/components/schemas/BillingZip'
nullable: true
description: >-
Customer's billing 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 "37615".
company:
type: string
nullable: true
description: Customer's company name.
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
customerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
nullable: true
firstName:
type: string
nullable: true
description: Customer/Payor first name.
identifierFields:
$ref: '#/components/schemas/Identifierfields'
nullable: true
lastName:
type: string
nullable: true
description: Customer/Payor last name.
shippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
shippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
shippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
shippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
shippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
shippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
PayorDataResponse:
title: PayorDataResponse
type: object
description: Customer information.
properties:
AdditionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
BillingAddress1:
$ref: '#/components/schemas/BillingAddressNullable'
nullable: true
BillingAddress2:
$ref: '#/components/schemas/BillingAddressAddtlNullable'
nullable: true
BillingCity:
$ref: '#/components/schemas/BillingCityNullable'
nullable: true
BillingCountry:
$ref: '#/components/schemas/BillingCountryNullable'
nullable: true
BillingEmail:
$ref: '#/components/schemas/Email'
nullable: true
BillingPhone:
$ref: '#/components/schemas/PhoneNumber'
nullable: true
BillingState:
$ref: '#/components/schemas/BillingStateNullable'
nullable: true
BillingZip:
$ref: '#/components/schemas/BillingZip'
nullable: true
description: >-
Customer's billing 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 "37615".
CompanyName:
type: string
nullable: true
description: Customer's company name.
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
CustomerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
nullable: true
customerStatus:
$ref: '#/components/schemas/CustomerStatus'
nullable: true
description: >-
Customer status. This is used to determine if the customer is active
or inactive.
FirstName:
type: string
nullable: true
description: Customer/Payor first name.
Identifiers:
$ref: '#/components/schemas/Identifierfields'
nullable: true
LastName:
type: string
nullable: true
description: Customer/Payor last name.
ShippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
ShippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
ShippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
ShippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
ShippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
ShippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
required:
- AdditionalData
- BillingAddress1
- BillingAddress2
- BillingCity
- BillingCountry
- BillingEmail
- BillingPhone
- BillingState
- BillingZip
- CompanyName
- customerId
- CustomerNumber
- customerStatus
- FirstName
- Identifiers
- LastName
- ShippingAddress1
- ShippingAddress2
- ShippingCity
- ShippingCountry
- ShippingState
- ShippingZip
PayorId:
title: PayorId
type: integer
format: int64
description: >-
Unique ID for the customer linked to the transaction. This is the same
value as the `customerId` used when creating or referencing a customer.
PayorElement:
title: PayorElement
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
fields:
type: array
items:
$ref: '#/components/schemas/PayorFields'
nullable: true
description: Array of Customer/Payor fields to show in section
header:
type: string
nullable: true
description: Custom header text for section
order:
$ref: '#/components/schemas/Order'
nullable: true
PayorFields:
title: PayorFields
type: object
properties:
display:
type: boolean
nullable: true
description: Flag indicating if the input field will show in container
fixed:
type: boolean
nullable: true
description: Flag indicating if the value in input field is read-only or not.
identifier:
type: boolean
nullable: true
description: Flag indicating if the input field is a customer identifier
label:
type: string
nullable: true
description: Label to display for field
name:
type: string
nullable: true
description: >-
Name of field to show. Should be one of the standard customer fields
or a custom field name
order:
$ref: '#/components/schemas/Order'
nullable: true
required:
type: boolean
nullable: true
description: Flag indicating if the input field is required for validation
validation:
type: string
nullable: true
description: |-
Type of validation to apply to the input field Accepted values:
- alpha for alphabetical
- numbers for numeric
- text for alphanumeric
- email for masked email address input
- phone for US phone numbers
value:
type: string
nullable: true
description: Pre-populated value for field
width:
type: integer
nullable: true
description: >-
Numeric value indicating the size of input relative to the
container. Accepted values:
- 4 = 1/3
- 6 = 1/2
- 8 = 2/3
- 12 = 3/3
PayoutAverageMonthlyVolume:
title: PayoutAverageMonthlyVolume
type: number
format: double
description: >-
The total number of bills the business pays each month. For example, if
your business pays an electric bill of \$500, an internet bill of \$150,
and various suppliers \$5,000 every month then your monthly bill volume
would be \$5,650.
PayoutAverageTicketLimit:
title: PayoutAverageTicketLimit
type: number
format: double
description: >-
The average amount of each bill you pay through our service. For
example, if your business paid 3 bills for a total of \$1,500 then your
average bill size is \$500.
PayoutCreditLimit:
title: PayoutCreditLimit
type: number
format: double
description: >-
The maximum amount of credit that our lending partner has authorized to
the business for on-demand payouts. It's the upper boundary on how much
you can spend or owe on a credit account at any given time.
PayoutHighTicketAmount:
title: PayoutHighTicketAmount
type: number
format: double
description: >-
The largest amount for bill you will pay through our service. For
example, if your business paid for 3 bills each month for \$500, \$1000,
and \$5000 respectively, then your highest ticket is \$5000.
PayoutGatewayConnector:
title: PayoutGatewayConnector
type: object
properties:
configuration:
type: string
nullable: true
Name:
type: string
nullable: true
Mode:
type: integer
nullable: true
Bank:
type: string
nullable: true
Descriptor:
type: string
nullable: true
gatewayID:
type: integer
nullable: true
Enabled:
type: boolean
nullable: true
EnableACHValidation:
type: boolean
nullable: true
TestMode:
type: boolean
nullable: true
PayoutProgram:
title: PayoutProgram
type: string
description: >-
The payout program associated with the transaction: managed or
on-demand.
PaypointData:
title: PaypointData
type: object
properties:
address1:
$ref: '#/components/schemas/AddressNullable'
nullable: true
address2:
$ref: '#/components/schemas/AddressAddtlNullable'
nullable: true
bankData:
$ref: '#/components/schemas/BankData'
nullable: true
boardingId:
$ref: '#/components/schemas/BoardingId'
nullable: true
city:
$ref: '#/components/schemas/CityNullable'
nullable: true
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
country:
$ref: '#/components/schemas/CountryNullable'
nullable: true
credentials:
type: array
items:
$ref: '#/components/schemas/PayabliCredentialsPascal'
nullable: true
dbaName:
$ref: '#/components/schemas/Dbaname'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
fax:
$ref: '#/components/schemas/PhoneNumber'
nullable: true
description: Fax number
idPaypoint:
$ref: '#/components/schemas/Idpaypoint'
nullable: true
legalName:
$ref: '#/components/schemas/Legalname'
nullable: true
parentOrg:
$ref: '#/components/schemas/OrgData'
nullable: true
paypointStatus:
$ref: '#/components/schemas/Paypointstatus'
nullable: true
phone:
$ref: '#/components/schemas/PhoneNumber'
nullable: true
serviceData:
$ref: '#/components/schemas/Services'
nullable: true
state:
$ref: '#/components/schemas/StateNullable'
nullable: true
summary:
$ref: '#/components/schemas/PaypointSummary'
nullable: true
timeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
websiteAddress:
$ref: '#/components/schemas/Website'
nullable: true
zip:
$ref: '#/components/schemas/Zip'
nullable: true
statementEmail:
$ref: '#/components/schemas/StatementEmailConfig'
nullable: true
description: >-
Configuration for billing statement email recipients and sender
address. `null` if not configured.
StatementEmailConfig:
title: StatementEmailConfig
type: object
description: Configuration for statement email recipients and the sender address.
properties:
sender:
type: string
nullable: true
description: >-
The email address from which statements are sent. Always uses a
Payabli domain, for example `acme-partners@payabli.com`. If `null`,
`noreply@payabli.com` is used.
recipients:
type: array
items:
type: string
nullable: true
description: >-
List of email addresses that receive billing statements. These are
merchant or partner contacts.
PaypointEntryConfig:
title: PaypointEntryConfig
type: object
properties:
EntryComment:
type: string
nullable: true
EntryLogo:
type: string
nullable: true
EntryName:
type: string
nullable: true
EntryPages:
type: array
items:
$ref: '#/components/schemas/PayabliPages'
nullable: true
EntrySubtitle:
type: string
nullable: true
EntryTitle:
type: string
nullable: true
IdEntry:
type: integer
format: int64
nullable: true
Paypoint:
$ref: '#/components/schemas/PaypointData'
nullable: true
PayabliCredentialsPascal:
title: PayabliCredentialsPascal
type: object
properties:
Service:
type: string
nullable: true
description: >-
The payment service that this credential applies to. A paypoint can
support multiple services, each represented by its own credential
object in the array. Possible values are `card` (credit/debit card),
`ach` (ACH bank transfer), `check` (paper check), `vcard` (virtual
card), `cloud` (card-present), `cash`, `managed` (managed payment
service), and `wallet`.
Mode:
type: integer
nullable: true
description: >-
The payment mode supported by this service. `0` for one-time
payments, `1` for recurring payments, `2` for both.
MinTicket:
$ref: '#/components/schemas/MinTicket'
nullable: true
MaxTicket:
$ref: '#/components/schemas/MaxTicket'
nullable: true
CfeeFix:
type: number
format: double
nullable: true
CfeeFloat:
type: number
format: double
nullable: true
CfeeMin:
type: number
format: double
nullable: true
CfeeMax:
type: number
format: double
nullable: true
AccountId:
$ref: '#/components/schemas/AccountId'
nullable: true
description: >-
The identifier for the payment connector, matching the `accountId`
of the linked bank account.
ReferenceId:
type: integer
format: int64
nullable: true
acceptSameDayACH:
type: boolean
nullable: true
Currency:
type: string
nullable: true
description: The default currency for the paypoint, either `USD` or `CAD`.
GreaterValueAllowed:
$ref: '#/components/schemas/GreaterValueAllowed'
nullable: true
AbsorbDifference:
$ref: '#/components/schemas/AbsorbDifference'
nullable: true
AllowOverride:
$ref: '#/components/schemas/AllowOverride'
nullable: true
PaypointId:
title: PaypointId
type: integer
format: int64
description: The paypoint's ID. Note that this is different than the entryname.
PaypointName:
title: PaypointName
type: string
description: The paypoint name.
Paypointstatus:
title: Paypointstatus
type: integer
description: |-
The paypoint's status.
Active - `1`
Inactive - 0
PaypointSummary:
title: PaypointSummary
type: object
properties:
amountSubs:
type: number
format: double
nullable: true
amountTx:
type: number
format: double
nullable: true
countSubs:
type: integer
nullable: true
countTx:
type: integer
nullable: true
customers:
type: integer
nullable: true
PendingFeeAmount:
title: PendingFeeAmount
type: number
format: double
description: >-
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 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](/guides/pay-in-fees-passthrough-overview#fee-configuration)
to learn more about pass-through fee settings.
PhoneNumber:
title: PhoneNumber
type: string
description: Phone number.
PoiDevice:
title: PoiDevice
type: object
description: >-
Information about the point of interaction device (also known as a
terminal or cloud device) used to process the transaction.
properties:
connected:
type: boolean
nullable: true
description: The device connection status.
dateDeRegistered:
type: string
format: date-time
nullable: true
description: The date the device was unregistered.
dateRegistered:
type: string
format: date-time
nullable: true
description: The date the device was registered.
deviceId:
type: string
nullable: true
description: The device identifier.
deviceLicense:
type: string
nullable: true
description: Device license. This is typically the same as `deviceId`.
deviceNickName:
type: string
nullable: true
description: Device description provided during registration.
lastConnectedDate:
type: string
format: date-time
nullable: true
description: Last connected date.
lastDisconnectedDate:
type: string
format: date-time
nullable: true
description: Last disconnected date.
lastTransactionDate:
type: string
format: date-time
nullable: true
description: Last transaction date.
make:
type: string
nullable: true
description: The device manufacturer.
model:
type: string
nullable: true
description: The device model.
registered:
type: boolean
nullable: true
description: The device registration status.
serialNumber:
type: string
nullable: true
description: The device serial number.
PolicyId:
title: PolicyId
type: string
description: >-
Used to identify the risk workflow used to review this account. Policy
IDs must be created before using automatic underwriting, and is
**required** when `method` is `automatic`.
PosCol:
title: PosCol
type: integer
description: The element's column position.
PosRow:
title: PosRow
type: integer
description: The element's row position.
ProcessingSection:
title: ProcessingSection
type: object
properties:
avgmonthly:
$ref: '#/components/schemas/TemplateElement'
nullable: true
binperson:
$ref: '#/components/schemas/TemplateElement'
nullable: true
binphone:
$ref: '#/components/schemas/TemplateElement'
nullable: true
binweb:
$ref: '#/components/schemas/TemplateElement'
nullable: true
bsummary:
$ref: '#/components/schemas/TemplateElement'
nullable: true
highticketamt:
$ref: '#/components/schemas/TemplateElement'
nullable: true
mcc:
$ref: '#/components/schemas/TemplateElement'
nullable: true
subFooter:
$ref: '#/components/schemas/SubFooter'
nullable: true
subHeader:
$ref: '#/components/schemas/SubHeader'
nullable: true
ticketamt:
$ref: '#/components/schemas/TemplateElement'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
whenCharged:
$ref: '#/components/schemas/TemplateElement'
nullable: true
whenDelivered:
$ref: '#/components/schemas/TemplateElement'
nullable: true
whenProvided:
$ref: '#/components/schemas/TemplateElement'
nullable: true
whenRefunded:
$ref: '#/components/schemas/TemplateElement'
nullable: true
PSection:
title: PSection
type: object
properties:
avgmonthly:
$ref: '#/components/schemas/LinkData'
nullable: true
binperson:
$ref: '#/components/schemas/LinkData'
nullable: true
binphone:
$ref: '#/components/schemas/LinkData'
nullable: true
binweb:
$ref: '#/components/schemas/LinkData'
nullable: true
bsummary:
$ref: '#/components/schemas/LinkData'
nullable: true
highticketamt:
$ref: '#/components/schemas/LinkData'
nullable: true
mcc:
$ref: '#/components/schemas/LinkData'
nullable: true
ticketamt:
$ref: '#/components/schemas/LinkData'
nullable: true
whenCharged:
$ref: '#/components/schemas/LinkData'
nullable: true
whenDelivered:
$ref: '#/components/schemas/LinkData'
nullable: true
whenProvided:
$ref: '#/components/schemas/LinkData'
nullable: true
whenRefunded:
$ref: '#/components/schemas/LinkData'
nullable: true
PurchaseOrder:
title: PurchaseOrder
type: string
description: Purchase order number.
PushPayLinkRequest:
title: PushPayLinkRequest
oneOf:
- type: object
allOf:
- type: object
properties:
channel:
type: string
enum:
- email
- $ref: '#/components/schemas/PushPayLinkRequestEmail'
required:
- channel
- type: object
allOf:
- type: object
properties:
channel:
type: string
enum:
- sms
- $ref: '#/components/schemas/PushPayLinkRequestSms'
required:
- channel
description: Request body for the push paylink operation.
PushPayLinkRequestEmail:
title: PushPayLinkRequestEmail
type: object
properties:
additionalEmails:
type: array
items:
type: string
nullable: true
description: >-
List of additional email addresses you want to send the paylink to,
formatted as an array.
Payment links and opt-in requests are sent to the customer email
address on file, and additional
recipients can be specified here.
attachFile:
type: boolean
nullable: true
description: When `true`, attaches a PDF version of the invoice to the email.
PushPayLinkRequestSms:
title: PushPayLinkRequestSms
type: object
properties: {}
QueryBatchesOutResponse:
title: QueryBatchesOutResponse
type: object
description: Response body for queries about money out batches.
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryBatchesOutResponseRecordsItem'
Summary:
$ref: '#/components/schemas/BatchSummary'
required:
- Records
- Summary
QueryBatchesOutResponseRecordsItem:
title: QueryBatchesOutResponseRecordsItem
type: object
properties:
AchAmount:
type: number
format: double
nullable: true
description: ''
AchRecords:
type: integer
nullable: true
description: ''
AchStatus:
type: integer
nullable: true
description: ''
AchStatusText:
type: string
nullable: true
description: ''
BatchAmount:
type: number
format: double
nullable: true
description: The amount of the batch.
BatchCancelledAmount:
type: number
format: double
nullable: true
description: ''
BatchCancelledRecords:
type: integer
nullable: true
description: ''
BatchDate:
type: string
format: date-time
nullable: true
description: The batch date.
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
nullable: true
BatchPaidAmount:
type: number
format: double
nullable: true
description: ''
BatchPaidRecords:
type: integer
nullable: true
description: ''
BatchProcessedAmount:
type: number
format: double
nullable: true
description: ''
BatchProcessedRecords:
type: integer
nullable: true
description: ''
BatchProcessingAmount:
type: number
format: double
nullable: true
description: ''
BatchProcessingRecords:
type: integer
nullable: true
description: ''
BatchRecords:
type: integer
nullable: true
description: The number of records in the batch.
BatchStatus:
type: integer
nullable: true
description: >-
The batch status. See [Batch
Status](/developers/references/money-out-statuses#batch-statuses)
for more.
BatchStatusText:
type: string
nullable: true
description: A text description of the batch status.
CardAmount:
type: number
format: double
nullable: true
description: ''
CardRecords:
type: integer
nullable: true
description: ''
CardStatus:
type: integer
nullable: true
description: ''
CardStatusText:
type: string
nullable: true
description: ''
CheckAmount:
type: number
format: double
nullable: true
description: ''
CheckRecords:
type: integer
nullable: true
description: ''
CheckStatus:
type: integer
nullable: true
description: ''
CheckStatusText:
type: string
nullable: true
description: ''
EntryName:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
IdBatch:
type: integer
nullable: true
description: The batch ID.
ParentOrgName:
type: string
nullable: true
description: The entrypoint's parent org.
PaypointDba:
type: string
nullable: true
description: Paypoint DBA name.
PaypointId:
type: integer
nullable: true
description: Paypoint ID.
PaypointName:
type: string
nullable: true
description: Paypoint legal name.
VcardAmount:
type: number
format: double
nullable: true
description: ''
VcardRecords:
type: integer
nullable: true
description: ''
VcardStatus:
type: integer
nullable: true
description: ''
VcardStatusText:
type: string
nullable: true
description: ''
WireAmount:
type: number
format: double
nullable: true
description: ''
WireRecords:
type: integer
nullable: true
description: ''
WireStatus:
type: integer
nullable: true
description: ''
WireStatusText:
type: string
nullable: true
description: ''
QueryBoardingAppsListResponse:
title: QueryBoardingAppsListResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/ApplicationQueryRecord'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryBoardingLinksResponse:
title: QueryBoardingLinksResponse
type: object
description: ' '
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryBoardingLinksResponseRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryBoardingLinksResponseRecordsItem:
title: QueryBoardingLinksResponseRecordsItem
type: object
properties:
AcceptOauth:
$ref: '#/components/schemas/AcceptOauth'
nullable: true
AcceptRegister:
$ref: '#/components/schemas/AcceptRegister'
nullable: true
EntryAttributes:
$ref: '#/components/schemas/EntryAttributes'
nullable: true
Id:
type: integer
nullable: true
description: The record ID.
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
OrgParentName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ReferenceName:
$ref: '#/components/schemas/ReferenceName'
nullable: true
ReferenceTemplateId:
$ref: '#/components/schemas/ReferenceTemplateId'
nullable: true
TemplateCode:
$ref: '#/components/schemas/TemplateCode'
nullable: true
TemplateName:
$ref: '#/components/schemas/TemplateName'
nullable: true
QueryCFeeTransaction:
title: QueryCFeeTransaction
type: object
properties:
cFeeTransid:
type: string
nullable: true
feeAmount:
type: number
format: double
nullable: true
operation:
type: string
nullable: true
refundId:
type: integer
format: int64
nullable: true
responseData:
type: object
additionalProperties: true
nullable: true
settlementStatus:
type: integer
nullable: true
transactionTime:
$ref: '#/components/schemas/TransactionTime'
nullable: true
transStatus:
type: integer
nullable: true
QueryChargebacksResponse:
title: QueryChargebacksResponse
type: object
description: Response body for queries about chargebacks.
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryChargebacksResponseRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryChargebacksResponseRecordsItem:
title: QueryChargebacksResponseRecordsItem
type: object
properties:
AccountType:
type: string
nullable: true
description: Type of account.
CaseNumber:
type: string
nullable: true
description: Case number of the chargeback.
ChargebackDate:
type: string
format: date-time
nullable: true
description: Date of the chargeback.
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
Id:
type: integer
nullable: true
description: Unique identifier of the record.
LastFour:
type: string
nullable: true
description: Last four digits of the account number.
Method:
type: string
nullable: true
description: Method of payment.
NetAmount:
type: number
format: float
nullable: true
description: Net amount after deductions.
OrderId:
$ref: '#/components/schemas/OrderId'
nullable: true
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
description: Payment data associated with the transaction.
PaymentTransId:
type: string
nullable: true
description: Transaction ID for the payment.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The 'Doing Business As' (DBA) name of the paypoint.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: Entryname for the paypoint.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: Legal name of the paypoint.
Reason:
type: string
nullable: true
description: Description of the reason for chargeback.
ReasonCode:
type: string
nullable: true
description: Code representing the reason for chargeback.
ReferenceNumber:
type: string
nullable: true
description: Reference number for the transaction.
ReplyBy:
$ref: '#/components/schemas/Replyby'
nullable: true
Responses:
type: string
nullable: true
description: Responses related to the transaction.
ScheduleReference:
type: integer
nullable: true
description: Reference for any scheduled transactions.
Status:
type: integer
nullable: true
description: Status of the transaction.
Transaction:
$ref: '#/components/schemas/TransactionQueryRecords'
nullable: true
TransactionTime:
$ref: '#/components/schemas/TransactionTime'
nullable: true
QueryCustomerResponse:
title: QueryCustomerResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/CustomerQueryRecords'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryEntrypointResponse:
title: QueryEntrypointResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryEntrypointResponseRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryEntrypointResponseRecordsItem:
title: QueryEntrypointResponseRecordsItem
type: object
properties:
AverageMonthlyVolume:
$ref: '#/components/schemas/Avgmonthly'
nullable: true
AverageTicketAmount:
$ref: '#/components/schemas/Avgticketamt'
nullable: true
BAddress1:
$ref: '#/components/schemas/Baddress1'
nullable: true
BAddress2:
$ref: '#/components/schemas/Baddress2'
nullable: true
BankData:
$ref: '#/components/schemas/BankData'
nullable: true
BCity:
$ref: '#/components/schemas/Bcity'
nullable: true
BCountry:
$ref: '#/components/schemas/Bcountry'
nullable: true
BFax:
$ref: '#/components/schemas/Bphone'
nullable: true
description: The business's fax number.
BinPerson:
$ref: '#/components/schemas/Binperson'
nullable: true
BinPhone:
$ref: '#/components/schemas/Binphone'
nullable: true
BinWeb:
$ref: '#/components/schemas/Binweb'
nullable: true
BoardingId:
$ref: '#/components/schemas/BoardingId'
nullable: true
BPhone:
$ref: '#/components/schemas/Bphone'
nullable: true
BStartdate:
$ref: '#/components/schemas/Busstartdate'
nullable: true
BState:
$ref: '#/components/schemas/Bstate'
nullable: true
BSummary:
$ref: '#/components/schemas/Bsummary'
nullable: true
BTimeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
BZip:
$ref: '#/components/schemas/Bzip'
nullable: true
ContactData:
$ref: '#/components/schemas/ContactsField'
nullable: true
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
DbaName:
$ref: '#/components/schemas/Dbaname'
nullable: true
DocumentsRef:
type: string
nullable: true
Ein:
$ref: '#/components/schemas/Ein'
nullable: true
EntryPoints:
type: array
items:
$ref: '#/components/schemas/PaypointEntryConfig'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
ExternalProcessorInformation:
$ref: '#/components/schemas/ExternalProcessorInformation'
nullable: true
HighTicketAmount:
$ref: '#/components/schemas/Highticketamt'
nullable: true
IdPaypoint:
$ref: '#/components/schemas/Idpaypoint'
nullable: true
LastModified:
$ref: '#/components/schemas/LastModified'
nullable: true
LegalName:
$ref: '#/components/schemas/Legalname'
nullable: true
License:
$ref: '#/components/schemas/License'
nullable: true
LicenseState:
$ref: '#/components/schemas/Licensestate'
nullable: true
MAddress1:
$ref: '#/components/schemas/Maddress'
nullable: true
MAddress2:
$ref: '#/components/schemas/Maddress1'
nullable: true
Mccid:
type: string
nullable: true
MCity:
$ref: '#/components/schemas/Mcity'
nullable: true
MCountry:
$ref: '#/components/schemas/Mcountry'
nullable: true
MState:
$ref: '#/components/schemas/Mstate'
nullable: true
MZip:
$ref: '#/components/schemas/Mzip'
nullable: true
OrgId:
$ref: '#/components/schemas/Orgid'
nullable: true
OrgParentName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
OwnerData:
$ref: '#/components/schemas/Ownership'
nullable: true
OwnType:
$ref: '#/components/schemas/OwnType'
nullable: true
PaypointStatus:
$ref: '#/components/schemas/Paypointstatus'
nullable: true
SalesCode:
$ref: '#/components/schemas/SalesCode'
nullable: true
ServiceData:
$ref: '#/components/schemas/Services'
nullable: true
summary:
$ref: '#/components/schemas/PaypointSummary'
nullable: true
Taxfillname:
$ref: '#/components/schemas/Taxfillname'
nullable: true
TemplateId:
$ref: '#/components/schemas/TemplateId'
nullable: true
WebsiteAddress:
$ref: '#/components/schemas/Website'
nullable: true
description: Business website.
Whencharged:
$ref: '#/components/schemas/Whencharged'
nullable: true
Whendelivered:
$ref: '#/components/schemas/Whendelivered'
nullable: true
Whenprovided:
$ref: '#/components/schemas/Whenprovided'
nullable: true
Whenrefund:
$ref: '#/components/schemas/Whenrefunded'
nullable: true
QueryPaymentData:
title: QueryPaymentData
type: object
properties:
AccountExp:
$ref: '#/components/schemas/Accountexp'
nullable: true
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
AccountType:
$ref: '#/components/schemas/Accounttype'
nullable: true
AccountZip:
$ref: '#/components/schemas/Accountzip'
nullable: true
binData:
$ref: '#/components/schemas/BinData'
nullable: true
HolderName:
$ref: '#/components/schemas/Holdername'
nullable: true
Initiator:
$ref: '#/components/schemas/Initiator'
nullable: true
MaskedAccount:
$ref: '#/components/schemas/Maskedaccount'
nullable: true
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
paymentDetails:
$ref: '#/components/schemas/PaymentDetail'
nullable: true
Sequence:
$ref: '#/components/schemas/Sequence'
nullable: true
SignatureData:
$ref: '#/components/schemas/Signaturedata'
nullable: true
StoredId:
$ref: '#/components/schemas/Storedmethodid'
nullable: true
description: Identifier of stored payment method used in transaction.
StoredMethodUsageType:
$ref: '#/components/schemas/StoredMethodUsageType'
nullable: true
QueryPayoutTransaction:
title: QueryPayoutTransaction
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryPayoutTransactionRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QueryPayoutTransactionSummary'
nullable: true
QueryPayoutTransactionRecordsItem:
title: QueryPayoutTransactionRecordsItem
type: object
properties:
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
nullable: true
BatchId:
type: integer
nullable: true
description: Identifier of the batch associated with payout transaction.
Bills:
type: array
items:
$ref: '#/components/schemas/BillPayOutData'
nullable: true
description: Bills associated with this transaction.
CardToken:
type: string
nullable: true
CheckData:
$ref: '#/components/schemas/FileContent'
nullable: true
description: Object referencing paper check image.
CheckNumber:
type: string
nullable: true
description: Paper check number related to payout transaction.
Comments:
$ref: '#/components/schemas/Comments'
nullable: true
description: Any comment or description for payout transaction.
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp when the payment was created, in UTC.
EntryName:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
Events:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
nullable: true
description: Events associated with this transaction.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
nullable: true
Gateway:
$ref: '#/components/schemas/Gatewayfield'
nullable: true
HasVcardTransactions:
$ref: '#/components/schemas/HasVcardTransactions'
nullable: true
IdOut:
type: integer
format: int64
nullable: true
description: Identifier of payout transaction.
IsSameDayACH:
$ref: '#/components/schemas/IsSameDayACH'
nullable: true
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: Timestamp when payment record was updated.
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: Net amount paid.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ParentOrgId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPayoutTransactionRecordsItemPaymentData'
nullable: true
PaymentId:
$ref: '#/components/schemas/PaymentIdString'
nullable: true
PaymentMethod:
type: string
nullable: true
description: The payment method for the transaction.
PaymentStatus:
type: string
nullable: true
description: >-
Status of payout transaction. See [Payout Transaction
Statuses](guides/money-out-statuses#payout-transaction-statuses) for
a full reference.
PayoutProgram:
$ref: '#/components/schemas/PayoutProgram'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: Paypoint legal name.
RiskAction:
$ref: '#/components/schemas/RiskAction'
nullable: true
RiskActionCode:
$ref: '#/components/schemas/RiskActionCode'
nullable: true
RiskFlagged:
$ref: '#/components/schemas/RiskFlagged'
nullable: true
RiskFlaggedOn:
$ref: '#/components/schemas/RiskFlaggedOn'
nullable: true
RiskReason:
$ref: '#/components/schemas/RiskReason'
nullable: true
RiskStatus:
$ref: '#/components/schemas/RiskStatus'
nullable: true
ScheduleId:
$ref: '#/components/schemas/ScheduleId'
nullable: true
SettlementStatus:
$ref: '#/components/schemas/SettlementStatusPayout'
nullable: true
Source:
$ref: '#/components/schemas/Source'
nullable: true
Status:
type: integer
nullable: true
description: Internal status of transaction.
TotalAmount:
type: number
format: double
nullable: true
description: Transaction total amount (including service fee or sub-charge).
Vendor:
$ref: '#/components/schemas/VendorQueryRecord'
nullable: true
description: Vendor related to the payout transaction.
QueryPayoutTransactionRecordsItemPaymentData:
title: QueryPayoutTransactionRecordsItemPaymentData
type: object
properties:
AccountExp:
$ref: '#/components/schemas/Accountexp'
nullable: true
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
AccountType:
$ref: '#/components/schemas/Accounttype'
nullable: true
AccountZip:
$ref: '#/components/schemas/Accountzip'
nullable: true
bankAccount:
type: string
nullable: true
binData:
$ref: '#/components/schemas/BinData'
nullable: true
cloudSignatureData:
type: string
nullable: true
cloudSignatureFormat:
type: string
nullable: true
gatewayConnector:
$ref: '#/components/schemas/PayoutGatewayConnector'
nullable: true
HolderName:
$ref: '#/components/schemas/Holdername'
nullable: true
description: Card or bank account holder name.
Initiator:
$ref: '#/components/schemas/Initiator'
nullable: true
MaskedAccount:
$ref: '#/components/schemas/Maskedaccount'
nullable: true
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
paymentDetails:
$ref: '#/components/schemas/PaymentDetail'
nullable: true
payorData:
type: string
nullable: true
Sequence:
$ref: '#/components/schemas/Sequence'
nullable: true
StoredId:
$ref: '#/components/schemas/Storedmethodid'
nullable: true
description: Identifier of stored payment method used in transaction.
StoredMethodUsageType:
$ref: '#/components/schemas/StoredMethodUsageType'
nullable: true
QueryPayoutTransactionSummary:
title: QueryPayoutTransactionSummary
type: object
properties:
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSize:
$ref: '#/components/schemas/Pagesize'
nullable: true
totalAmount:
type: number
format: double
nullable: true
totalAuthorized:
type: integer
nullable: true
totalAuthorizedAmount:
type: number
format: double
nullable: true
totalCanceled:
type: integer
nullable: true
totalCanceledAmount:
type: number
format: double
nullable: true
totalCaptured:
type: integer
nullable: true
totalCapturedAmount:
type: number
format: double
nullable: true
totalNetAmount:
type: number
format: double
nullable: true
totalOpen:
type: integer
nullable: true
totalOpenAmount:
type: number
format: double
nullable: true
totalPages:
type: integer
nullable: true
totalPaid:
type: integer
nullable: true
totalPaidAmount:
type: number
format: double
nullable: true
totalOnHold:
type: integer
nullable: true
description: Total number of transactions that are currently on hold.
totalOnHoldAmount:
type: number
format: double
nullable: true
description: Total amount of transactions that are currently on hold.
totalProcessing:
type: integer
nullable: true
totalProcessingAmount:
type: number
format: double
nullable: true
totalRecords:
type: integer
nullable: true
QueryResponse:
title: QueryResponse
type: object
description: ' '
properties:
records:
type: array
items: {}
nullable: true
summary:
type: string
nullable: true
QueryResponseData:
title: QueryResponseData
type: object
description: The transaction's response data.
properties:
authcode:
$ref: '#/components/schemas/Authcode'
nullable: true
avsresponse:
$ref: '#/components/schemas/AvsResponse'
nullable: true
avsresponse_text:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
cvvresponse:
$ref: '#/components/schemas/CvvResponse'
nullable: true
cvvresponse_text:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
emv_auth_response_data:
$ref: '#/components/schemas/EmvAuthResponseData'
nullable: true
orderid:
$ref: '#/components/schemas/OrderId'
nullable: true
response:
type: string
nullable: true
description: 'Response text for operation: ''Success'' or ''Declined''.'
response_code:
type: string
nullable: true
description: >-
Internal result code processing the transaction. Value 1 indicates
successful operation, values 2 and 3 indicate errors.
response_code_text:
type: string
nullable: true
description: >-
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.
responsetext:
type: string
nullable: true
description: >-
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.
resultCode:
$ref: '#/components/schemas/ResultCodev2'
nullable: true
resultCodeText:
$ref: '#/components/schemas/ResultCodeText'
nullable: true
transactionid:
type: string
nullable: true
description: The transaction identifier in Payabli.
type:
type: string
nullable: true
description: Type of transaction or operation.
QueryResponseItems:
title: QueryResponseItems
type: object
description: Response for line item queries
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryResponseItemsRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryResponseItemsRecordsItem:
title: QueryResponseItemsRecordsItem
type: object
properties:
LineItem:
$ref: '#/components/schemas/LineItem'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: The paypoint's entry name (entrypoint).
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: the Paypoint's legal name.
QueryResponseNotificationReports:
title: QueryResponseNotificationReports
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryResponseNotificationReportsRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryResponseNotificationReportsRecordsItem:
title: QueryResponseNotificationReportsRecordsItem
type: object
properties:
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
id:
type: integer
nullable: true
description: Unique identifier for the report.
isDownloadable:
type: boolean
nullable: true
description: Indicator of whether the report can be downloaded.
reportName:
type: string
nullable: true
description: Name of the report.
QueryResponseNotifications:
title: QueryResponseNotifications
type: object
description: Response payload for queries related to notifications
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryResponseNotificationsRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryResponseNotificationsRecordsItem:
title: QueryResponseNotificationsRecordsItem
type: object
properties:
content:
$ref: '#/components/schemas/NotificationContent'
nullable: true
description: Notification content.
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp of when notification was created, in UTC.
frequency:
$ref: '#/components/schemas/Frequencynotification'
nullable: true
lastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: Timestamp of when notification was last updated, in UTC.
method:
$ref: '#/components/schemas/Methodnotification'
nullable: true
notificationId:
$ref: '#/components/schemas/NotificationId'
nullable: true
ownerId:
$ref: '#/components/schemas/Ownerid'
nullable: true
ownerName:
type: string
nullable: true
description: Name of entity owner of notification.
ownerType:
$ref: '#/components/schemas/Ownertype'
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
description: Custom descriptor of source of notification.
status:
$ref: '#/components/schemas/Statusnotification'
nullable: true
target:
$ref: '#/components/schemas/Target'
nullable: true
QueryResponseSettlements:
title: QueryResponseSettlements
type: object
description: Describes the response for settlement queries.
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryResponseSettlementsRecordsItem'
nullable: true
Summary:
$ref: '#/components/schemas/QueryResponseSettlementsSummary'
nullable: true
QueryResponseSettlementsRecordsItem:
title: QueryResponseSettlementsRecordsItem
type: object
properties:
BatchAmount:
type: number
format: double
nullable: true
description: The batch amount.
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
nullable: true
Category:
$ref: '#/components/schemas/Category'
nullable: true
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
nullable: true
DepositDate:
$ref: '#/components/schemas/DepositDate'
nullable: true
ExpectedDepositDate:
$ref: '#/components/schemas/ExpectedDepositDate'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
GatewayTransId:
type: string
nullable: true
description: Internal identifier used for processing.
Id:
type: integer
nullable: true
invoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
isHold:
type: integer
nullable: true
description: |-
Describes whether the transaction is being held or not.
1 - Transaction is held
0 - Transaction isn't being held
MaskedAccount:
$ref: '#/components/schemas/Maskedaccount'
nullable: true
Method:
type: string
nullable: true
description: The payment method.
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: Net amount paid.
Operation:
type: string
nullable: true
description: The operation performed.
OrderId:
$ref: '#/components/schemas/OrderId'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
PaymentTransId:
type: string
nullable: true
description: The transaction ID for the payment.
PaymentTransStatus:
$ref: '#/components/schemas/TransStatus'
nullable: true
PaypointDbaname:
type: string
nullable: true
description: Paypoint DBA name.
PaypointEntryname:
type: string
nullable: true
description: Paypoint entryname.
PaypointLegalname:
type: string
nullable: true
description: Paypoint legal name.
ResponseData:
$ref: '#/components/schemas/QueryResponseData'
nullable: true
ScheduleReference:
type: integer
nullable: true
description: Reference to the subscription originating the transaction.
SettledAmount:
type: number
format: double
nullable: true
description: The transaction amount.
SettlementDate:
type: string
format: date-time
nullable: true
description: >-
The date and time when the transaction was settled. This field is
null when the transaction's `SettlementStatus` is -1, -5, or -6
(Exception, Held, or Released).
Source:
$ref: '#/components/schemas/Source'
nullable: true
Status:
$ref: '#/components/schemas/SettlementStatus'
nullable: true
TransactionEvents:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
nullable: true
description: Events associated with this transaction.
TransactionTime:
$ref: '#/components/schemas/TransactionTime'
nullable: true
TransMethod:
type: string
nullable: true
description: 'Payment method used: card or ach.'
Type:
type: string
nullable: true
description: 'The transaction type: credit or debit.'
QueryResponseSettlementsSummary:
title: QueryResponseSettlementsSummary
type: object
properties:
heldAmount:
type: number
format: double
nullable: true
description: Funds being held for fraud or risk concerns.
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSize:
type: integer
nullable: true
description: Number of records per page.
refunds:
type: number
format: double
nullable: true
description: Total refunds deducted from the transfer.
serviceFees:
type: number
format: double
nullable: true
description: >-
Service fees are any pass-through fees charged to the customer at
the time of payment. These aren't transferred to the merchant when
the batch is transferred and funded.
totalAmount:
type: number
format: double
nullable: true
description: The total sum of the settlements in the response.
totalNetAmount:
type: number
format: double
nullable: true
description: The total sum of the settlements in the response.
totalPages:
type: integer
nullable: true
description: Number of pages in the response.
totalRecords:
type: integer
nullable: true
description: Number of records in the response.
transferAmount:
type: number
format: double
nullable: true
description: >-
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's
transferred to the merchant bank account.
QueryResponseTransactions:
title: QueryResponseTransactions
type: object
description: Response payload for queries related to transactions
properties:
Records:
type: array
items:
$ref: '#/components/schemas/TransactionQueryRecords'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QueryResponseVendors:
title: QueryResponseVendors
type: object
description: Response payload for queries related to vendors.
properties:
Records:
type: array
items:
$ref: '#/components/schemas/VendorQueryRecord'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QuerySubscriptionResponse:
title: QuerySubscriptionResponse
type: object
description: Subscription query response body.
properties:
Records:
type: array
items:
$ref: '#/components/schemas/SubscriptionQueryRecords'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
QuerySummary:
title: QuerySummary
type: object
properties:
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSize:
$ref: '#/components/schemas/Pagesize'
nullable: true
totalAmount:
type: number
format: double
nullable: true
description: Total amount for the records.
totalNetAmount:
type: number
format: double
nullable: true
description: Total net amount for the records.
totalPages:
$ref: '#/components/schemas/Totalrecords'
nullable: true
totalRecords:
$ref: '#/components/schemas/Totalrecords'
nullable: true
QuerySummaryNoAmt:
title: QuerySummaryNoAmt
type: object
properties:
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSize:
$ref: '#/components/schemas/Pagesize'
nullable: true
totalPages:
$ref: '#/components/schemas/Totalrecords'
nullable: true
totalRecords:
$ref: '#/components/schemas/Totalrecords'
nullable: true
QueryTransactionEvents:
title: QueryTransactionEvents
type: object
properties:
EventData:
$ref: '#/components/schemas/QueryTransactionEventsEventData'
nullable: true
description: >-
Any data associated to the event received from processor. Contents
vary by event type.
EventTime:
type: string
format: date-time
nullable: true
description: Date and time of event.
TransEvent:
type: string
nullable: true
description: >-
Event descriptor. See [TransEvent
Reference](/guides/pay-in-transevents-reference) for more details.
QueryTransactionEventsEventData:
title: QueryTransactionEventsEventData
oneOf:
- type: object
additionalProperties: true
- type: string
description: >-
Any data associated to the event received from processor. Contents vary
by event type.
QueryTransactionPayorData:
title: QueryTransactionPayorData
type: object
properties:
Identifiers:
type: array
items: {}
nullable: true
description: Array of field names to be used as identifiers.
FirstName:
type: string
nullable: true
description: Customer/Payor first name.
LastName:
type: string
nullable: true
description: Customer/Payor last name.
CompanyName:
type: string
nullable: true
description: Customer's company name.
BillingAddress1:
type: string
nullable: true
description: Customer's billing address.
BillingAddress2:
type: string
nullable: true
description: Additional line for Customer's billing address.
BillingCity:
type: string
nullable: true
description: Customer's billing city.
BillingState:
type: string
nullable: true
description: >-
Customer's billing state. Must be 2-letter state code for address in
US.
BillingZip:
$ref: '#/components/schemas/BillingZip'
nullable: true
description: Customer's billing ZIP code.
BillingCountry:
type: string
nullable: true
description: Customer's billing country.
BillingPhone:
type: string
nullable: true
description: Customer's phone number.
BillingEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: Customer's email address.
CustomerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
nullable: true
ShippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
ShippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
ShippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
ShippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
ShippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
ShippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
customerStatus:
$ref: '#/components/schemas/CustomerStatus'
nullable: true
AdditionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
QueryTransactionPayorDataCustomer:
title: QueryTransactionPayorDataCustomer
type: object
properties:
Identifiers:
type: array
items: {}
nullable: true
description: Array of field names to be used as identifiers.
FirstName:
type: string
nullable: true
description: Customer/Payor first name.
LastName:
type: string
nullable: true
description: Customer/Payor last name.
CompanyName:
type: string
nullable: true
description: Customer's company name.
BillingAddress1:
type: string
nullable: true
description: Customer's billing address.
BillingAddress2:
type: string
nullable: true
description: Additional line for Customer's billing address.
BillingCity:
type: string
nullable: true
description: Customer's billing city.
BillingState:
type: string
nullable: true
description: >-
Customer's billing state. Must be 2-letter state code for address in
US.
BillingZip:
$ref: '#/components/schemas/BillingZip'
nullable: true
description: Customer's billing ZIP code.
BillingCountry:
type: string
nullable: true
description: Customer's billing country.
BillingPhone:
type: string
nullable: true
description: Customer's phone number.
BillingEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: Customer's email address.
CustomerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
nullable: true
ShippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
ShippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
ShippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
ShippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
ShippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
ShippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
customerStatus:
$ref: '#/components/schemas/CustomerStatus'
nullable: true
AdditionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
QueryUserResponse:
title: QueryUserResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/UserQueryRecord'
nullable: true
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
ReadOnly:
title: ReadOnly
type: boolean
description: When `true`, the element is read-only.
ReceiptContent:
title: ReceiptContent
type: object
description: Object containing receipt body configuration
properties:
amount:
$ref: '#/components/schemas/Element'
nullable: true
description: Section amount of payment receipt
contactUs:
$ref: '#/components/schemas/Element'
nullable: true
description: Section contactUs of payment receipt
details:
$ref: '#/components/schemas/Element'
nullable: true
description: Section payment details of payment receipt
logo:
$ref: '#/components/schemas/Element'
nullable: true
description: Section logo of payment receipt
messageBeforeButton:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Section message of payment receipt
page:
$ref: '#/components/schemas/PageElement'
nullable: true
description: Section page of payment receipt
paymentButton:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Section payment button of payment receipt
paymentInformation:
$ref: '#/components/schemas/Element'
nullable: true
description: Section payment information of payment receipt
settings:
$ref: '#/components/schemas/SettingElement'
nullable: true
description: The receipt's settings.
RecipientEmailNotification:
title: RecipientEmailNotification
type: boolean
description: >-
When `true`, Payabli will send the applicant a boarding link. Set this
value to `false` if you are sending pre-filled applications via the API
and don't want Payabli to send the applicant an email to complete the
boarding application.
Referenceidtrans:
title: Referenceidtrans
type: string
description: The transaction identifier in Payabli.
ReferenceName:
title: ReferenceName
type: string
ReferenceTemplateId:
title: ReferenceTemplateId
type: integer
format: int64
RefundDetail:
title: RefundDetail
type: object
description: >-
Object containing details about the refund, including line items and
optional split instructions.
properties:
categories:
type: array
items:
$ref: '#/components/schemas/PaymentCategories'
nullable: true
description: >-
Array of payment categories/line items describing the amount to be
paid. Note: These categories are for information only and aren't
validated against the total amount provided.
splitRefunding:
type: array
items:
$ref: '#/components/schemas/SplitFundingRefundContent'
nullable: true
description: Array of objects containing split instructions for the refund.
RefundId:
title: RefundId
type: integer
format: int64
description: Identifier of refund transaction linked to this payment.
Remitaddress1:
title: Remitaddress1
type: string
description: >-
Remittance street address. Used for mailing paper checks. Required if
any remittance address field is provided. Allowed characters are
letters, numbers, spaces, and `. ,
Remitaddress2:
title: Remitaddress2
type: string
description: >-
Remittance address additional line, such as a suite or unit number. Used
for mailing paper checks. Always optional.
Remitcity:
title: Remitcity
type: string
description: >-
Remittance address city. Used for mailing paper checks. Required if any
remittance address field is provided.
Remitcountry:
title: Remitcountry
type: string
description: >-
Remittance address country. Used for mailing paper checks. Must be `US`
or `CA`. Defaults to `US` if not provided.
Remitstate:
title: Remitstate
type: string
description: >-
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 province abbreviation.
Remitzip:
title: Remitzip
type: string
description: >-
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 or ZIP+4 format.
RemitEmail:
title: RemitEmail
type: string
format: email
description: >-
Remittance email address. Used for sending virtual cards and other
information about payouts.
RepCode:
title: RepCode
type: string
description: >-
Sales representative code. This is an optional field that can be used to
track the sales representative associated with the application.
RepName:
title: RepName
type: string
description: >-
Sales representative name. This is an optional field that can be used to
track the sales representative associated with the application.
RepOffice:
title: RepOffice
type: string
description: >-
Sales representative office location. This is an optional field that can
be used to track the sales representative office associated with the
application.
Replyby:
title: Replyby
type: string
format: date-time
description: Time that a response to a chargeback is due, in UTC.
ReplyToEmail:
title: ReplyToEmail
type: string
format: email
description: >-
Email address for organization-level communications, such as messages
about why an application was declined. This is required by commerce laws
in the US.
RequiredElement:
title: RequiredElement
type: boolean
description: When `true`, the element is required.
Responsecode:
title: Responsecode
type: integer
description: >-
Code for the response. Learn more in [API Response
Codes](/developers/api-reference/api-responses).
Responsedata:
title: Responsedata
type: object
additionalProperties: true
description: The object containing the response data.
Responsedatanonobject:
title: Responsedatanonobject
oneOf:
- type: string
- type: integer
description: The response data.
ResponseText:
title: ResponseText
type: string
description: 'Response text for operation: ''Success'' or ''Declined''.'
ResultCode:
title: ResultCode
type: integer
description: >-
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 initiated and is pending.
Resulttext:
title: Resulttext
type: string
description: >-
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 or decline.
ResultCodev2:
title: ResultCodev2
type: string
description: >-
Unified result code for the transaction. See [Pay In unified response
codes](/developers/references/pay-in-unified-response-codes-reference)
for more information.
ResultCodeText:
title: ResultCodeText
type: string
description: >-
Description of the result code. See [Pay In unified response
codes](/developers/references/pay-in-unified-response-codes-reference)
for more information.
Resumable:
title: Resumable
type: boolean
description: >-
When `true`, the applicant can save an incomplete application and resume
it later. When `false`, the applicant won't have an option to save
their progress, and must complete the application in one session.
RetrievalId:
title: RetrievalId
type: integer
format: int64
description: Identifier of retrieval request
ReturnedId:
title: ReturnedId
type: integer
format: int64
description: Identifier of return/chargeback transaction linked to this payment.
RiskFlagged:
title: RiskFlagged
type: boolean
description: Indicates if the transaction was flagged for risk
RiskFlaggedOn:
title: RiskFlaggedOn
type: string
format: date-time
description: Timestamp when the transaction was flagged for risk
RiskStatus:
title: RiskStatus
type: string
description: Current risk status of the transaction
RiskReason:
title: RiskReason
type: string
description: Reason for risk flagging
RiskAction:
title: RiskAction
type: string
description: Action taken due to risk assessment
RiskActionCode:
title: RiskActionCode
type: integer
description: Numeric code representing the risk action
RoutingAccount:
title: RoutingAccount
type: string
description: Routing number of bank account.
SalesCode:
title: SalesCode
type: string
SalesSection:
title: SalesSection
type: object
properties:
salesCode:
$ref: '#/components/schemas/SalesCode'
nullable: true
salesCRM:
type: string
nullable: true
SaveIfSuccess:
title: SaveIfSuccess
type: boolean
description: >-
When `true`, Payabli saves the payment method if the transaction is
successful. The payment method ID is returned in the response as
`methodReferenceId`. Defaults to `false`.
ScheduleDetail:
title: ScheduleDetail
type: object
properties:
endDate:
type: string
nullable: true
description: >-
Subscription end date in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY or the value `untilcancelled` to indicate a scheduled
payment with infinite cycle.
frequency:
$ref: '#/components/schemas/Frequency'
nullable: true
description: Frequency of the subscription.
planId:
type: integer
nullable: true
description: >-
This field is for future development, leave null. Identifier of
subscription plan applied in the scheduled payment/subscription.
startDate:
type: string
nullable: true
description: >-
Subscription start date in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY. This must be a future date.
ScheduleId:
title: ScheduleId
type: integer
format: int64
description: ID of the recurring payment schedule associated with the transaction.
Sequence:
title: Sequence
type: string
description: >-
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](/guides/pay-in-transactions-cit-mit-overview) for more information.
ServiceCost:
title: ServiceCost
type: object
properties:
description:
type: string
nullable: true
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
monthlyCost:
type: number
format: double
nullable: true
name:
type: string
nullable: true
reseller:
type: boolean
nullable: true
setupCost:
type: number
format: double
nullable: true
txCost:
type: number
format: double
nullable: true
txPercentCost:
type: number
format: double
nullable: true
Services:
title: Services
type: object
description: Controls which services will be enabled for the merchant.
properties:
ach:
$ref: '#/components/schemas/AchSetup'
nullable: true
card:
$ref: '#/components/schemas/CardSetup'
nullable: true
odp:
$ref: '#/components/schemas/OdpSetup'
nullable: true
ServicesSection:
title: ServicesSection
type: object
description: Details about pricing and payment services for a business.
properties:
ach:
$ref: '#/components/schemas/AchService'
nullable: true
card:
$ref: '#/components/schemas/CardService'
nullable: true
subFooter:
$ref: '#/components/schemas/SubFooter'
nullable: true
subHeader:
$ref: '#/components/schemas/SubHeader'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
SettingElement:
title: SettingElement
type: object
properties:
enabled:
$ref: '#/components/schemas/Enabled'
nullable: true
fields:
type: array
items:
$ref: '#/components/schemas/DisplayProperty'
nullable: true
description: Fields to display on the reciept.
order:
$ref: '#/components/schemas/Order'
nullable: true
sendAuto:
type: boolean
nullable: true
description: >-
When `true`, Payabli automatically sends the receipt to the payor
email address.
sendManual:
type: boolean
nullable: true
description: >-
When `true`, you must send the reciept to the payor manually using
the
[/MoneyIn/sendreceipt/\{transId\}](/developers/api-reference/moneyin/send-receipt-for-transaction)
endpoint.
SettingsQueryRecord:
title: SettingsQueryRecord
type: object
properties:
customFields:
type: array
items:
$ref: '#/components/schemas/KeyValue'
nullable: true
description: Any custom fields defined for the org.
forInvoices:
type: array
items:
$ref: '#/components/schemas/KeyValue'
nullable: true
forPayOuts:
type: array
items:
$ref: '#/components/schemas/KeyValue'
nullable: true
forWallets:
type: array
items:
$ref: '#/components/schemas/KeyValue'
nullable: true
description: >-
Information about digital wallet settings for the entity. Available
values are `isApplePayEnabled` and `isGooglePayEnabled`.
general:
type: array
items:
$ref: '#/components/schemas/KeyValue'
nullable: true
description: ''
identifiers:
type: array
items:
$ref: '#/components/schemas/KeyValue'
nullable: true
SettlementStatusPayout:
title: SettlementStatusPayout
type: string
description: >-
The settlement status of the payout transaction. See [Payout Transaction
Statuses](guides/money-out-statuses#payout-transaction-statuses) for a
full reference.
SettlementStatus:
title: SettlementStatus
type: integer
description: >-
Settlement status for transaction. See [the
docs](/developers/references/money-in-statuses#payment-funding-status)
for a full reference.
Shippingaddress:
title: Shippingaddress
type: string
description: The shipping address.
Shippingaddressadditional:
title: Shippingaddressadditional
type: string
description: Additional line for shipping address.
Shippingcity:
title: Shippingcity
type: string
description: Shipping city.
Shippingcountry:
title: Shippingcountry
type: string
description: Shipping address country.
ShippingFromZip:
title: ShippingFromZip
type: string
description: Sender shipping ZIP code.
Shippingstate:
title: Shippingstate
type: string
description: Shipping state or province.
Shippingzip:
title: Shippingzip
type: string
description: >-
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 "37615".
Signaturedata:
title: Signaturedata
type: string
SignerAcceptance:
title: SignerAcceptance
type: boolean
description: >-
The signer's acceptance status. A true or false indicating an acceptance
to the terms of service with the root org or provider.
Signeraddress:
title: Signeraddress
type: string
description: >-
The signer's address. This must be the physical address of the signer,
not a P.O. box.
SignerAddress1:
title: SignerAddress1
type: string
description: >-
Additional line for the signer's address. If used, this must be the
physical address of the signer, not a P.O. box.
SignerCity:
title: SignerCity
type: string
description: The signer's city.
SignerCountry:
title: SignerCountry
type: string
description: >-
The signer's country in ISO-3166-1 alpha 2 format. See this reference
for more: https://en.wikipedia.org/wiki/ISO_3166-1.
SignerData:
title: SignerData
type: object
description: Information about the application's signer.
properties:
signerUuid:
type: string
nullable: true
description: The signer's ID. This is automatically generated by Payabli.
name:
$ref: '#/components/schemas/SignerName'
nullable: true
ssn:
$ref: '#/components/schemas/SignerSsn'
nullable: true
dob:
$ref: '#/components/schemas/SignerDob'
nullable: true
phone:
$ref: '#/components/schemas/SignerPhone'
nullable: true
email:
$ref: '#/components/schemas/Email'
nullable: true
description: The signer's email address.
address:
$ref: '#/components/schemas/Signeraddress'
nullable: true
address1:
$ref: '#/components/schemas/SignerAddress1'
nullable: true
city:
$ref: '#/components/schemas/SignerCity'
nullable: true
state:
$ref: '#/components/schemas/SignerState'
nullable: true
zip:
$ref: '#/components/schemas/SignerZip'
nullable: true
country:
$ref: '#/components/schemas/SignerCountry'
nullable: true
acceptance:
$ref: '#/components/schemas/SignerAcceptance'
nullable: true
signedDocumentReference:
type: string
nullable: true
description: Reference to the signed document.
pciAttestation:
$ref: '#/components/schemas/PciAttestation'
nullable: true
attestationDate:
$ref: '#/components/schemas/AttestationDate'
nullable: true
signDate:
$ref: '#/components/schemas/SignDate'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
SignerDataRequest:
title: SignerDataRequest
type: object
description: Information about the application's signer.
properties:
name:
$ref: '#/components/schemas/SignerName'
nullable: true
ssn:
$ref: '#/components/schemas/SignerSsn'
nullable: true
dob:
$ref: '#/components/schemas/SignerDob'
nullable: true
phone:
$ref: '#/components/schemas/SignerPhone'
nullable: true
email:
$ref: '#/components/schemas/Email'
nullable: true
description: The signer's email address.
address:
$ref: '#/components/schemas/Signeraddress'
nullable: true
address1:
$ref: '#/components/schemas/SignerAddress1'
nullable: true
city:
$ref: '#/components/schemas/SignerCity'
nullable: true
country:
$ref: '#/components/schemas/SignerCountry'
nullable: true
state:
$ref: '#/components/schemas/SignerState'
nullable: true
zip:
$ref: '#/components/schemas/SignerZip'
nullable: true
acceptance:
$ref: '#/components/schemas/SignerAcceptance'
nullable: true
signedDocumentReference:
$ref: '#/components/schemas/SignedDocumentReference'
nullable: true
pciAttestation:
$ref: '#/components/schemas/PciAttestation'
nullable: true
attestationDate:
$ref: '#/components/schemas/AttestationDate'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
signDate:
$ref: '#/components/schemas/SignDate'
nullable: true
SignedDocumentReference:
title: SignedDocumentReference
type: string
description: Reference to the signed document.
AttestationDate:
title: AttestationDate
type: string
description: >-
Date the attestation was provided for PCI Compliance (`pciAttestation`),
in MM/DD/YYYY format.
PciAttestation:
title: PciAttestation
type: boolean
description: >-
When `true`, indicates that the merchant acknowledges PCI
responsibilities and can be enrolled in the PCI program for breach
insurance
SignerDob:
title: SignerDob
type: string
description: The signer's date of birth.
SignerName:
title: SignerName
type: string
description: The signer's name.
SignerPhone:
title: SignerPhone
type: string
description: The signer's phone number.
SignerSsn:
title: SignerSsn
type: string
description: The signer's SSN.
SignerState:
title: SignerState
type: string
description: The signer's state.
SignerZip:
title: SignerZip
type: string
description: The signer's zip code.
SignDate:
title: SignDate
type: string
description: |-
Date when the signer signed the document. Accepted formats:
YYYY-MM-DD, MM/DD/YYYY
SignerSection:
title: SignerSection
type: object
properties:
visible:
$ref: '#/components/schemas/Visible'
nullable: true
name:
$ref: '#/components/schemas/TemplateElement'
nullable: true
ssn:
$ref: '#/components/schemas/TemplateElement'
nullable: true
dob:
$ref: '#/components/schemas/TemplateElement'
nullable: true
phone:
$ref: '#/components/schemas/TemplateElement'
nullable: true
email:
$ref: '#/components/schemas/TemplateElement'
nullable: true
address:
$ref: '#/components/schemas/TemplateElement'
nullable: true
address1:
$ref: '#/components/schemas/TemplateElement'
nullable: true
city:
$ref: '#/components/schemas/TemplateElement'
nullable: true
country:
$ref: '#/components/schemas/TemplateElement'
nullable: true
state:
$ref: '#/components/schemas/TemplateElement'
nullable: true
zip:
$ref: '#/components/schemas/TemplateElement'
nullable: true
acceptance:
$ref: '#/components/schemas/TemplateElement'
nullable: true
signedDocumentReference:
$ref: '#/components/schemas/TemplateElement'
nullable: true
additionalData:
$ref: '#/components/schemas/TemplateAdditionalDataSection'
nullable: true
Source:
title: Source
type: string
description: Custom identifier to indicate the transaction or request source.
SplitFunding:
title: SplitFunding
type: array
items:
$ref: '#/components/schemas/SplitFundingContent'
description: >-
Split funding instructions for the transaction. The total amount of the
splits must match the total amount of the transaction.
SplitFundingContent:
title: SplitFundingContent
type: object
properties:
accountId:
type: string
nullable: true
description: The accountId for the account the split should be sent to.
amount:
type: number
format: double
nullable: true
description: Amount from the transaction to send to this recipient.
description:
type: string
nullable: true
description: A description for the split.
recipientEntryPoint:
type: string
nullable: true
description: The entrypoint the split should be sent to.
SplitFundingRefundContent:
title: SplitFundingRefundContent
type: object
properties:
accountId:
type: string
nullable: true
description: The accountId for the account the transaction was routed to.
amount:
type: number
format: double
nullable: true
description: The amount to refund to this account.
description:
type: string
nullable: true
description: Refund description.
originationEntryPoint:
type: string
nullable: true
description: The entrypoint the transaction belongs to.
SSection:
title: SSection
type: object
properties:
ach:
$ref: '#/components/schemas/AchSection'
nullable: true
card:
$ref: '#/components/schemas/CardSection'
nullable: true
StateNullable:
title: StateNullable
type: string
description: The state or province.
Statusnotification:
title: Statusnotification
type: integer
description: |-
Status of notification:
- `0`: Inactive
- `1`: Active
Storedmethodid:
title: Storedmethodid
type: string
description: >-
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 token.
StoredMethodUsageType:
title: StoredMethodUsageType
type: string
description: >-
**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](/guides/pay-in-transactions-cit-mit-overview) for more
information.
Subdomain:
title: Subdomain
type: string
description: >-
Refers to the payment page identifier. If provided, then the transaction
is linked to the payment page.
SubFooter:
title: SubFooter
type: string
SubHeader:
title: SubHeader
type: string
Subscriptionid:
title: Subscriptionid
type: integer
format: int64
description: Payabli identifier of the subscription associated with the transaction.
SubscriptionQueryRecords:
title: SubscriptionQueryRecords
type: object
properties:
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp of when the subscription ws created, in UTC.
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
nullable: true
EndDate:
type: string
format: date-time
nullable: true
description: The subscription's end date.
EntrypageId:
$ref: '#/components/schemas/EntrypageId'
nullable: true
ExternalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
FeeAmount:
type: number
format: double
nullable: true
description: Fee applied to the subscription.
Frequency:
type: string
nullable: true
description: The subscription's frequency.
IdSub:
type: integer
format: int64
nullable: true
description: The subscription's ID.
InvoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
LastRun:
type: string
format: date-time
nullable: true
description: The last time the subscription was processed.
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: The last date and time the subscription was updated.
LeftCycles:
type: integer
nullable: true
description: The number of cycles the subscription has left.
Method:
type: string
nullable: true
description: The subscription's payment method.
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: The subscription amount, minus any fees.
NextDate:
type: string
format: date-time
nullable: true
description: The next date the subscription will be processed.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: The paypoint's entryname.
PaypointId:
$ref: '#/components/schemas/PaypointId'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint's legal name.
PlanId:
type: integer
nullable: true
description: Payment plan ID.
Source:
$ref: '#/components/schemas/Source'
nullable: true
StartDate:
type: string
format: date-time
nullable: true
description: The subscription start date.
SubEvents:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: Events associated with the subscription.
SubStatus:
type: integer
nullable: true
description: |-
The subscription's status.
- 0: Paused
- 1: Active
TotalAmount:
type: number
format: double
nullable: true
description: The subscription amount, including any fees.
TotalCycles:
type: integer
nullable: true
description: The total number of cycles the subscription is set to run.
UntilCancelled:
type: boolean
nullable: true
description: >-
When `true`, the subscription has no explicit end date and will run
until canceled.
required:
- EndDate
- LastRun
- NextDate
- StartDate
SummaryCommodityCode:
title: SummaryCommodityCode
type: string
description: Commodity code.
SummaryOrg:
title: SummaryOrg
type: object
properties:
amountSubs:
type: number
format: double
nullable: true
amountTx:
type: number
format: double
nullable: true
childOrgs:
type: integer
nullable: true
childPaypoints:
type: integer
nullable: true
countSubs:
type: integer
nullable: true
countTx:
type: integer
nullable: true
Target:
title: Target
type: string
description: >-
Specify the notification target.
For **method**=*email* the expected value is a list of email addresses
separated by semicolon.
For **method**=*sms* the expected value is a list of phone numbers
separated by semicolon.
For **method**=*web*. the expected value is a valid and complete URL.
Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.
Tax:
title: Tax
type: number
format: double
description: Tax rate in percent applied to the invoice.
Taxfillname:
title: Taxfillname
type: string
description: >-
Business name in tax document. This is only relevant if a government
entity has given you an alternative name to file tax documents with.
TemplateAdditionalDataSection:
title: TemplateAdditionalDataSection
type: object
properties:
visible:
$ref: '#/components/schemas/Visible'
nullable: true
fields:
type: object
additionalProperties:
$ref: '#/components/schemas/TemplateAdditionalDataField'
required:
- fields
TemplateAdditionalDataField:
title: TemplateAdditionalDataField
type: object
properties:
visible:
$ref: '#/components/schemas/Visible'
nullable: true
readOnly:
$ref: '#/components/schemas/ReadOnly'
nullable: true
required:
$ref: '#/components/schemas/RequiredElement'
nullable: true
posRow:
$ref: '#/components/schemas/PosRow'
nullable: true
posCol:
$ref: '#/components/schemas/PosCol'
nullable: true
value:
$ref: '#/components/schemas/ValueTemplates'
nullable: true
label:
type: string
nullable: true
type:
type: string
nullable: true
TemplateCode:
title: TemplateCode
type: string
description: The internal code for the template.
TemplateContent:
title: TemplateContent
type: object
properties:
businessData:
$ref: '#/components/schemas/BusinessSection'
nullable: true
documentsData:
$ref: '#/components/schemas/DocumentSection'
nullable: true
ownershipData:
$ref: '#/components/schemas/OwnersSection'
nullable: true
processingData:
$ref: '#/components/schemas/ProcessingSection'
nullable: true
salesData:
$ref: '#/components/schemas/SalesSection'
nullable: true
servicesData:
$ref: '#/components/schemas/ServicesSection'
nullable: true
underwritingData:
$ref: '#/components/schemas/UnderwritingData'
nullable: true
TemplateContentResponse:
title: TemplateContentResponse
type: object
properties:
businessData:
$ref: '#/components/schemas/BusinessSection'
nullable: true
documentsData:
$ref: '#/components/schemas/DocumentSection'
nullable: true
ownershipData:
$ref: '#/components/schemas/OwnersSection'
nullable: true
processingData:
$ref: '#/components/schemas/ProcessingSection'
nullable: true
salesData:
$ref: '#/components/schemas/SalesSection'
nullable: true
servicesData:
$ref: '#/components/schemas/ServicesSection'
nullable: true
underwritingData:
$ref: '#/components/schemas/UnderwritingDataResponse'
nullable: true
TemplateData:
title: TemplateData
type: object
description: Object containing the template's data.
properties:
orgId:
$ref: '#/components/schemas/Orgid'
nullable: true
description: 'The ID of the organization the template belongs to. '
pricingId:
type: integer
format: int64
nullable: true
templateCode:
$ref: '#/components/schemas/TemplateCode'
nullable: true
templateContent:
$ref: '#/components/schemas/TemplateContent'
nullable: true
templateDescription:
type: string
nullable: true
description: A description for the template.
templateName:
$ref: '#/components/schemas/TemplateName'
nullable: true
TemplateElement:
title: TemplateElement
type: object
properties:
posCol:
$ref: '#/components/schemas/PosCol'
nullable: true
posRow:
$ref: '#/components/schemas/PosRow'
nullable: true
readOnly:
$ref: '#/components/schemas/ReadOnly'
nullable: true
value:
$ref: '#/components/schemas/ValueTemplates'
nullable: true
visible:
$ref: '#/components/schemas/Visible'
nullable: true
TemplateId:
title: TemplateId
type: integer
format: int64
description: The associated boarding template's ID in Payabli.
TemplateName:
title: TemplateName
type: string
description: 'The template name. '
TemplateQueryRecord:
title: TemplateQueryRecord
type: object
properties:
addPrice:
type: boolean
nullable: true
boardingLinks:
type: array
items:
$ref: '#/components/schemas/BoardingQueryLinks'
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
idTemplate:
type: integer
format: int64
nullable: true
isRoot:
$ref: '#/components/schemas/IsRoot'
nullable: true
orgParentName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
recipientEmailNotification:
$ref: '#/components/schemas/RecipientEmailNotification'
nullable: true
resumable:
$ref: '#/components/schemas/Resumable'
nullable: true
templateCode:
$ref: '#/components/schemas/TemplateCode'
nullable: true
templateContent:
$ref: '#/components/schemas/TemplateContentResponse'
nullable: true
templateDescription:
type: string
nullable: true
templateTitle:
type: string
nullable: true
usedBy:
type: integer
nullable: true
TemplateQueryResponse:
title: TemplateQueryResponse
type: object
properties:
records:
type: array
items:
$ref: '#/components/schemas/TemplateQueryRecord'
nullable: true
summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
Terms:
title: Terms
type: string
description: >-
Payment terms for invoice. If no terms are defined, then response data
for this field defaults to `NET30`.
**Available Values:**
- `PIA`: Payment in advance
- `CIA`: Cash in advance
- `UR`: Upon receipt
- `NET10`: 10 days after invoice date
- `NET20`: 20 days after invoice date
- `NET30`: 30 days after invoice date
- `NET45`: 45 days after invoice date
- `NET60`: 60 days after invoice date
- `NET90`: 90 days after invoice date
- `EOM`: Due end of this month
- `MFI`: 1st of the month following the invoice date
- `5MFI`: 5th of the month following the invoice date
- `10MFI`: 10th of the month following the invoice date
- `15MFI`: 15th of the month following the invoice date
- `20MFI`: 20th of the month following the invoice date
- `2/10NET30`: 2% discount if paid within 10 days, otherwise net 30 days
- `UF`: Until further notice
- `10UF`: 10 days until further notice
- `20UF`: 20 days until further notice
- `25UF`: 25 days until further notice
- `50UF`: 50 days until further notice
TermsConditions:
title: TermsConditions
type: string
description: Custom terms and conditions included in the invoice.
Ticketamt:
title: Ticketamt
type: number
format: double
description: >-
The average transaction size that the business expects to process. For
example, if you process \$10,000 a month across 10 transactions, that's
an average ticket of \$1000.
TierItem:
title: TierItem
type: object
properties:
amountxAuth:
type: number
format: double
nullable: true
highPayRange:
type: number
format: double
nullable: true
lowPayRange:
type: number
format: double
nullable: true
percentxAuth:
type: number
format: double
nullable: true
TierItemPass:
title: TierItemPass
type: object
properties:
amountFeeone-time:
type: number
format: double
nullable: true
amountFeeRecurring:
type: number
format: double
nullable: true
highPayRange:
type: number
format: double
nullable: true
lowPayRange:
type: number
format: double
nullable: true
percentFeeone-time:
type: number
format: double
nullable: true
percentFeeRecurring:
type: number
format: double
nullable: true
Timezone:
title: Timezone
type: integer
description: Timezone, in UTC offset. For example, -5 is Eastern time.
Totalpages:
title: Totalpages
type: integer
description: Total number of pages in response.
Totalrecords:
title: Totalrecords
type: integer
description: Total number of records in response.
TransactionOutQueryRecord:
title: TransactionOutQueryRecord
type: object
properties:
IdOut:
type: integer
format: int64
nullable: true
description: Identifier of payout transaction.
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
Comments:
$ref: '#/components/schemas/Comments'
nullable: true
description: Any comment or description for payout transaction.
Vendor:
$ref: '#/components/schemas/VendorQueryRecord'
nullable: true
description: Vendor related to the payout transaction.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
Status:
type: integer
nullable: true
description: Internal status of transaction.
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: Timestamp when payment record was updated, in UTC.
TotalAmount:
type: number
format: double
nullable: true
description: Transaction total amount (including service fee or sub-charge).
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
nullable: true
Source:
$ref: '#/components/schemas/Source'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ParentOrgId:
$ref: '#/components/schemas/Orgid'
nullable: true
BatchNumber:
type: string
nullable: true
description: The batch number for the payout transaction.
PaymentStatus:
type: string
nullable: true
description: Status of payout transaction.
PaymentMethod:
type: string
nullable: true
description: Method of payment applied to the transaction.
CardToken:
type: string
nullable: true
CheckNumber:
type: string
nullable: true
description: Paper check number related to payout transaction.
CheckData:
$ref: '#/components/schemas/FileContent'
nullable: true
description: Object referencing to paper check image.
PaymentId:
$ref: '#/components/schemas/PaymentIdString'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
Bills:
type: array
items:
$ref: '#/components/schemas/BillPayOutData'
nullable: true
description: Bills associated with this transaction.
Events:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
nullable: true
description: Events associated with this transaction.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
EntryName:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
Gateway:
$ref: '#/components/schemas/Gatewayfield'
nullable: true
BatchId:
type: string
nullable: true
description: ID of the batch the transaction belongs to.
HasVcardTransactions:
$ref: '#/components/schemas/HasVcardTransactions'
nullable: true
IsSameDayACH:
$ref: '#/components/schemas/IsSameDayACH'
nullable: true
ScheduleId:
$ref: '#/components/schemas/ScheduleId'
nullable: true
SettlementStatus:
$ref: '#/components/schemas/SettlementStatusPayout'
nullable: true
RiskFlagged:
$ref: '#/components/schemas/RiskFlagged'
nullable: true
RiskFlaggedOn:
$ref: '#/components/schemas/RiskFlaggedOn'
nullable: true
RiskStatus:
$ref: '#/components/schemas/RiskStatus'
nullable: true
RiskReason:
$ref: '#/components/schemas/RiskReason'
nullable: true
RiskAction:
$ref: '#/components/schemas/RiskAction'
nullable: true
RiskActionCode:
$ref: '#/components/schemas/RiskActionCode'
nullable: true
PayoutProgram:
$ref: '#/components/schemas/PayoutProgram'
nullable: true
TransactionQueryRecords:
title: TransactionQueryRecords
type: object
properties:
AchHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
AchSecCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
BatchAmount:
type: number
format: double
nullable: true
description: Batch amount.
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
nullable: true
CfeeTransactions:
type: array
items:
$ref: '#/components/schemas/QueryCFeeTransaction'
nullable: true
description: >-
Service Fee or sub-charge transaction associated to the main
transaction.
ConnectorName:
type: string
nullable: true
description: Connector used for transaction.
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
nullable: true
DeviceId:
$ref: '#/components/schemas/Device'
nullable: true
EntrypageId:
$ref: '#/components/schemas/EntrypageId'
nullable: true
ExternalProcessorInformation:
$ref: '#/components/schemas/ExternalProcessorInformation'
nullable: true
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
nullable: true
GatewayTransId:
type: string
nullable: true
description: Internal identifier used for processing.
InvoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
Method:
type: string
nullable: true
description: 'Payment method used: card, ach, or wallet.'
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: Net amount paid.
Operation:
$ref: '#/components/schemas/Operation'
nullable: true
OrderId:
$ref: '#/components/schemas/OrderId'
nullable: true
OrgId:
$ref: '#/components/schemas/Orgid'
nullable: true
description: ID of immediate parent organization.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
PaymentTransId:
type: string
nullable: true
description: Unique Transaction ID.
PayorId:
$ref: '#/components/schemas/PayorId'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: Paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: Paypoint's entryname.
PaypointId:
type: integer
format: int64
nullable: true
description: InternalId for paypoint.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: Paypoint's legal name.
PendingFeeAmount:
$ref: '#/components/schemas/PendingFeeAmount'
nullable: true
RefundId:
$ref: '#/components/schemas/RefundId'
nullable: true
ResponseData:
$ref: '#/components/schemas/QueryResponseData'
nullable: true
ReturnedId:
$ref: '#/components/schemas/ReturnedId'
nullable: true
ScheduleReference:
type: integer
format: int64
nullable: true
description: Reference to the subscription that originated the transaction.
SettlementStatus:
type: integer
nullable: true
description: >-
Settlement status for transaction. See [the
docs](/developers/references/money-in-statuses#payment-funding-status)
for a full reference.
Source:
$ref: '#/components/schemas/Source'
nullable: true
splitFundingInstructions:
$ref: '#/components/schemas/SplitFunding'
nullable: true
TotalAmount:
type: number
format: double
nullable: true
description: Transaction total amount (including service fee or sub-charge)
TransactionEvents:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
nullable: true
description: Events associated with this transaction.
TransactionTime:
type: string
format: date-time
nullable: true
description: Transaction date and time, in UTC.
TransAdditionalData:
nullable: true
TransStatus:
type: integer
nullable: true
description: >-
Status of transaction. See [the
docs](/developers/references/money-in-statuses#money-in-transaction-status)
for a full reference.
required:
- TransactionTime
TransactionQueryRecordsCustomer:
title: TransactionQueryRecordsCustomer
type: object
properties:
AchHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
AchSecCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
BatchAmount:
type: number
format: double
nullable: true
description: Batch amount.
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
nullable: true
CfeeTransactions:
type: array
items:
$ref: '#/components/schemas/QueryCFeeTransaction'
nullable: true
description: >-
Service Fee or sub-charge transaction associated to the main
transaction.
ConnectorName:
type: string
nullable: true
description: Connector used for transaction.
Customer:
$ref: '#/components/schemas/QueryTransactionPayorDataCustomer'
nullable: true
DeviceId:
$ref: '#/components/schemas/Device'
nullable: true
EntrypageId:
$ref: '#/components/schemas/EntrypageId'
nullable: true
ExternalProcessorInformation:
$ref: '#/components/schemas/ExternalProcessorInformation'
nullable: true
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
nullable: true
GatewayTransId:
type: string
nullable: true
description: Internal identifier used for processing.
invoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
Method:
type: string
nullable: true
description: 'Payment method used: card, ach, or wallet.'
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: Net amount paid.
Operation:
$ref: '#/components/schemas/Operation'
nullable: true
OrderId:
$ref: '#/components/schemas/OrderId'
nullable: true
OrgId:
$ref: '#/components/schemas/Orgid'
nullable: true
description: ID of immediate parent organization.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
PaymentTransId:
type: string
nullable: true
description: Unique Transaction ID.
PayorId:
$ref: '#/components/schemas/PayorId'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: Paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: Paypoint's entryname.
PaypointId:
type: integer
format: int64
nullable: true
description: InternalId for paypoint.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: Paypoint's legal name.
PendingFeeAmount:
$ref: '#/components/schemas/PendingFeeAmount'
nullable: true
RefundId:
$ref: '#/components/schemas/RefundId'
nullable: true
ResponseData:
$ref: '#/components/schemas/QueryResponseData'
nullable: true
ReturnedId:
$ref: '#/components/schemas/ReturnedId'
nullable: true
ScheduleReference:
type: integer
format: int64
nullable: true
description: Reference to the subscription that originated the transaction.
SettlementStatus:
type: integer
nullable: true
description: >-
Settlement status for transaction. See [the
docs](/developers/references/money-in-statuses#payment-funding-status)
for a full reference.
Source:
$ref: '#/components/schemas/Source'
nullable: true
splitFundingInstructions:
$ref: '#/components/schemas/SplitFunding'
nullable: true
TotalAmount:
type: number
format: double
nullable: true
description: Transaction total amount (including service fee or sub-charge)
TransactionEvents:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
nullable: true
description: Events associated with this transaction.
TransactionTime:
type: string
format: date-time
nullable: true
description: Transaction date and time, in UTC.
TransAdditionalData:
nullable: true
TransStatus:
type: integer
nullable: true
description: >-
Status of transaction. See [the
docs](/developers/references/money-in-statuses#money-in-transaction-status)
for a full reference.
required:
- TransactionTime
TransactionTime:
title: TransactionTime
type: string
format: date-time
description: Timestamp when transaction was submitted, in UTC.
TransferIdentifier:
title: TransferIdentifier
type: string
description: Unique identifier for the transfer.
Transfer:
title: Transfer
type: object
properties:
transferId:
type: integer
description: The transfer ID.
paypointId:
$ref: '#/components/schemas/PaypointId'
batchNumber:
$ref: '#/components/schemas/BatchNumber'
batchCurrency:
type: string
nullable: true
description: The currency of the batch, either USD or CAD.
batchRecords:
type: integer
nullable: true
description: Number of records in the batch.
transferIdentifier:
$ref: '#/components/schemas/TransferIdentifier'
batchId:
type: integer
description: The ID of the batch the transfer belongs to.
paypointEntryName:
type: string
nullable: true
description: The paypoint entryname.
paypointLegalName:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint legal name.
paypointDbaName:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint DBA name.
paypointLogo:
type: string
nullable: true
description: The paypoint logo URL.
parentOrgName:
type: string
nullable: true
description: The parent organization name.
parentOrgId:
type: integer
nullable: true
description: The parent organization ID.
parentOrgEntryName:
type: string
nullable: true
description: The parent organization entryname.
parentOrgLogo:
type: string
nullable: true
description: The parent organization logo URL.
externalPaypointID:
type: string
nullable: true
description: The external paypoint ID.
bankAccount:
$ref: '#/components/schemas/TransferBankAccount'
nullable: true
description: Bank account information for the transfer.
transferDate:
type: string
description: Date when the transfer occurred.
processor:
type: string
description: The payment processor used for the transfer.
transferStatus:
type: integer
description: The current status of the transfer.
grossAmount:
type: number
format: double
description: >-
Gross batch is the total amount of the payments grouped in the
batch. This amount includes service fees.
chargeBackAmount:
type: number
format: double
description: Amount of chargebacks to be deducted from batch.
returnedAmount:
type: number
format: double
description: Amount of ACH returns to be deducted from batch.
holdAmount:
type: number
format: double
description: Amount being held for fraud or risk concerns.
releasedAmount:
type: number
format: double
description: >-
Amount of previously held funds that have been released after a risk
review.
billingFeesAmount:
type: number
format: double
description: Amount of charges and fees applied for services and transactions.
thirdPartyPaidAmount:
type: number
format: double
description: >-
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.
adjustmentsAmount:
type: number
format: double
description: Amount of corrections applied to Billing & Fees charges.
netTransferAmount:
type: number
format: double
description: The net transfer amount after all deductions and additions.
splitAmount:
type: number
format: double
nullable: true
description: The sum of each splitFundingAmount of each record in the transfer.
eventsData:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: List of events associated with the transfer.
messages:
type: array
items:
$ref: '#/components/schemas/TransferMessage'
nullable: true
description: List of messages related to the transfer.
required:
- transferId
- paypointId
- batchNumber
- batchCurrency
- batchRecords
- transferIdentifier
- batchId
- paypointEntryName
- paypointLegalName
- paypointDbaName
- paypointLogo
- parentOrgName
- parentOrgId
- parentOrgEntryName
- parentOrgLogo
- externalPaypointID
- bankAccount
- transferDate
- processor
- transferStatus
- grossAmount
- chargeBackAmount
- returnedAmount
- holdAmount
- releasedAmount
- billingFeesAmount
- thirdPartyPaidAmount
- adjustmentsAmount
- netTransferAmount
- splitAmount
- eventsData
- messages
TransferBankAccount:
title: TransferBankAccount
type: object
properties:
accountNumber:
$ref: '#/components/schemas/AccountNumber'
routingNumber:
$ref: '#/components/schemas/RoutingAccount'
bankName:
$ref: '#/components/schemas/BankName'
required:
- accountNumber
- routingNumber
- bankName
TransferMessage:
title: TransferMessage
type: object
properties:
Id:
type: integer
nullable: true
RoomId:
type: integer
nullable: true
UserId:
type: integer
nullable: true
UserName:
type: string
nullable: true
Content:
type: string
nullable: true
CreatedAt:
type: string
nullable: true
MessageType:
type: integer
nullable: true
MessageProperties:
$ref: '#/components/schemas/TransferMessageProperties'
nullable: true
required:
- Id
- RoomId
- UserId
- UserName
- Content
- CreatedAt
- MessageType
- MessageProperties
TransferMessageProperties:
title: TransferMessageProperties
type: object
properties:
originalTransferStatus:
type: string
nullable: true
currentTransferStatus:
type: string
nullable: true
required:
- originalTransferStatus
- currentTransferStatus
TransferSummary:
title: TransferSummary
type: object
properties:
totalPages:
$ref: '#/components/schemas/Totalpages'
totalRecords:
$ref: '#/components/schemas/Totalrecords'
pageSize:
$ref: '#/components/schemas/Pagesize'
required:
- totalPages
- totalRecords
- pageSize
TransferQueryResponse:
title: TransferQueryResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/Transfer'
Summary:
$ref: '#/components/schemas/TransferSummary'
required:
- Records
- Summary
TransStatus:
title: TransStatus
type: integer
description: >-
Status of transaction. See [the
docs](/developers/references/money-in-statuses#money-in-transaction-status)
for a full reference.
PaymentTransStatusDescription:
title: PaymentTransStatusDescription
type: string
description: >-
Description of the payment transaction status. See [the
docs](/developers/references/money-in-statuses#money-in-transaction-status)
for a full reference.
TypeAccount:
title: TypeAccount
type: string
enum:
- Checking
- Savings
description: 'Type of bank account: Checking or Savings.'
UnderwritingData:
title: UnderwritingData
type: object
description: >-
Underwriting data is used to manage risk orchestration in the boarding
application lifecycle.
properties:
method:
$ref: '#/components/schemas/UnderWritingMethod'
policyId:
$ref: '#/components/schemas/PolicyId'
nullable: true
required:
- method
UnderwritingDataResponse:
title: UnderwritingDataResponse
type: object
description: >-
Underwriting data is used to manage risk orchestration in the boarding
application lifecycle.
properties:
method:
$ref: '#/components/schemas/UnderWritingMethod'
nullable: true
policyId:
$ref: '#/components/schemas/PolicyId'
nullable: true
UnderWritingMethod:
title: UnderWritingMethod
type: string
enum:
- automatic
- manual
- bypass
description: |-
This field controls which method is used to handle risk orchestration.
- `automatic`: Sends the application through the automatic underwriting workflow using the provided `policyId`.
- `manual`: Puts the application into the pending review status. An analyst must manually change it's final status to approved or declined.
- `bypass`: The application won't go through Payabli's review, and proceeds directly to boarding products and services.
UserData:
title: UserData
type: object
properties:
access:
type: array
items:
$ref: '#/components/schemas/UsrAccess'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
email:
$ref: '#/components/schemas/Email'
nullable: true
description: The user's email address.
language:
$ref: '#/components/schemas/Language'
nullable: true
mfaData:
$ref: '#/components/schemas/MfaData'
nullable: true
name:
$ref: '#/components/schemas/NameUser'
nullable: true
phone:
$ref: '#/components/schemas/PhoneNumber'
nullable: true
description: The user's phone number.
pwd:
type: string
nullable: true
scope:
type: array
items:
$ref: '#/components/schemas/OrgScope'
nullable: true
timeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
usrStatus:
$ref: '#/components/schemas/UsrStatus'
nullable: true
UserQueryRecord:
title: UserQueryRecord
type: object
properties:
Access:
type: array
items:
$ref: '#/components/schemas/UsrAccess'
nullable: true
AdditionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: The timestamp for the user's creation, in UTC.
Email:
$ref: '#/components/schemas/Email'
nullable: true
description: The user's email address.
language:
$ref: '#/components/schemas/Language'
nullable: true
lastAccess:
type: string
format: date-time
nullable: true
description: The timestamp for the user's last activity, in UTC.
Name:
$ref: '#/components/schemas/NameUser'
nullable: true
Phone:
$ref: '#/components/schemas/PhoneNumber'
nullable: true
description: The user's phone number.
Scope:
type: array
items:
$ref: '#/components/schemas/OrgXScope'
nullable: true
snData:
type: string
nullable: true
description: >-
Additional data provided by the social network related to the
customer.
snIdentifier:
type: string
nullable: true
description: Identifier or token for customer in linked social network.
snProvider:
type: string
nullable: true
description: >-
Social network linked to customer. Possible values: facebook,
google, twitter, microsoft.
timeZone:
$ref: '#/components/schemas/Timezone'
nullable: true
userId:
type: integer
format: int64
nullable: true
description: The user's ID in Payabli.
UsrMFA:
$ref: '#/components/schemas/Mfa'
nullable: true
UsrMFAMode:
$ref: '#/components/schemas/MfaMode'
nullable: true
UsrStatus:
$ref: '#/components/schemas/UsrStatus'
nullable: true
UsrAccess:
title: UsrAccess
type: object
properties:
roleLabel:
type: string
nullable: true
roleValue:
type: boolean
nullable: true
UsrStatus:
title: UsrStatus
type: integer
description: "The user's status: \n - Inactive:\t0\n - Active:\t1\n - Deleted:\t-99\n - Locked:\t85"
ValueTemplates:
title: ValueTemplates
type: string
VCardSummary:
title: VCardSummary
type: object
properties:
totalPages:
$ref: '#/components/schemas/Totalpages'
totalRecords:
$ref: '#/components/schemas/Totalrecords'
totalAmount:
type: number
format: double
description: Total amount for the records.
totalactive:
type: integer
description: Total number of active vCards.
totalamounteactive:
type: number
format: double
description: Total amount of active vCards.
totalbalanceactive:
type: number
format: double
description: Total balance of active vCards.
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
pageSize:
$ref: '#/components/schemas/Pagesize'
nullable: true
required:
- totalPages
- totalRecords
- totalAmount
- totalactive
- totalamounteactive
- totalbalanceactive
AssociatedVendor:
title: AssociatedVendor
type: object
properties:
VendorNumber:
$ref: '#/components/schemas/VendorNumber'
nullable: true
Name1:
type: string
nullable: true
description: Primary name for vendor.
Name2:
type: string
nullable: true
description: Secondary name for vendor.
EIN:
$ref: '#/components/schemas/Ein'
nullable: true
Phone:
type: string
nullable: true
description: Vendor's phone number.
Email:
$ref: '#/components/schemas/Email'
nullable: true
description: Vendor's email address.
Address1:
type: string
nullable: true
description: Vendor's address.
Address2:
type: string
nullable: true
description: Additional line for vendor's address.
City:
type: string
nullable: true
description: Vendor's city.
State:
type: string
nullable: true
description: Vendor's state.
Zip:
type: string
nullable: true
description: Vendor's postal code.
Country:
type: string
nullable: true
description: Vendor's country.
Mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
LocationCode:
$ref: '#/components/schemas/LocationCode'
nullable: true
Contacts:
type: array
items:
$ref: '#/components/schemas/Contacts'
nullable: true
description: Array of objects describing the vendor's contacts.
BillingData:
$ref: '#/components/schemas/BillingDataResponse'
nullable: true
PaymentMethod:
type: string
nullable: true
VendorStatus:
$ref: '#/components/schemas/Vendorstatus'
nullable: true
VendorId:
type: integer
nullable: true
EnrollmentStatus:
$ref: '#/components/schemas/EnrollmentStatus'
nullable: true
Summary:
$ref: '#/components/schemas/VendorSummary'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint's legal name.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: Paypoint's entryname.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
CreatedDate:
$ref: '#/components/schemas/CreatedAt'
nullable: true
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
payeeName1:
$ref: '#/components/schemas/PayeeName'
nullable: true
payeeName2:
$ref: '#/components/schemas/PayeeName'
nullable: true
customField1:
type: string
nullable: true
customField2:
type: string
nullable: true
customerVendorAccount:
type: string
nullable: true
InternalReferenceId:
$ref: '#/components/schemas/InternalReferenceId'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
externalPaypointID:
type: string
nullable: true
VCardRecord:
title: VCardRecord
type: object
properties:
vcardSent:
type: boolean
nullable: true
description: When `true`, the vCard has been sent.
cardToken:
type: string
nullable: true
cardNumber:
type: string
nullable: true
description: The vCard number.
cvc:
type: string
nullable: true
description: The vCard CVC number.
expirationDate:
type: string
nullable: true
description: >-
Expiration date in format YYYY-MM-DD. The minimum time to expire is
3 months, maximum is 3 years. If not provided, the default is 6
months.
status:
type: string
nullable: true
amount:
type: number
format: double
nullable: true
description: The vCard amount.
currentBalance:
type: number
format: double
nullable: true
description: The vCard's current balance.
expenseLimit:
type: number
format: double
nullable: true
expenseLimitPeriod:
type: string
nullable: true
maxNumberOfUses:
type: integer
nullable: true
currentNumberOfUses:
type: integer
nullable: true
exactAmount:
type: boolean
nullable: true
mcc:
type: string
nullable: true
description: MCC assigned to vCard.
tcc:
type: string
nullable: true
description: TCC assigned to vCard.
misc1:
type: string
nullable: true
description: Custom field 1.
misc2:
type: string
nullable: true
description: Custom field 2.
dateCreated:
$ref: '#/components/schemas/CreatedAt'
nullable: true
dateModified:
$ref: '#/components/schemas/LastModified'
nullable: true
associatedVendor:
$ref: '#/components/schemas/AssociatedVendor'
nullable: true
associatedCustomer:
$ref: '#/components/schemas/CustomerData'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint's legal name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: The paypoint's entry name (entrypoint).
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
paypointId:
type: integer
nullable: true
description: The paypoint's unique identifier.
VCardQueryResponse:
title: VCardQueryResponse
type: object
properties:
Summary:
$ref: '#/components/schemas/VCardSummary'
nullable: true
Records:
type: array
items:
$ref: '#/components/schemas/VCardRecord'
nullable: true
VendorCheckNumber:
title: VendorCheckNumber
type: string
description: >-
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. When no check number is provided, Payabli automatically
manages check numbering and sequencing for checks issued from the same
bank account.
VendorData:
title: VendorData
type: object
properties:
vendorNumber:
$ref: '#/components/schemas/VendorNumber'
nullable: true
AdditionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
address1:
$ref: '#/components/schemas/AddressNullable'
nullable: true
description: >-
Vendor's street address. If any address field is provided, this
field is required along with `city`, `state`, and `zip`. Allowed
characters are letters, numbers, spaces, and `. ,
address2:
$ref: '#/components/schemas/AddressAddtlNullable'
nullable: true
description: >-
Additional line for vendor's address, such as a suite or unit
number. Always optional.
billingData:
$ref: '#/components/schemas/BillingData'
nullable: true
description: Object containing vendor's bank information.
city:
type: string
nullable: true
description: Vendor's city. Required if any address field is provided.
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
description: Array of objects describing the vendor's contacts.
country:
type: string
nullable: true
description: >-
Vendor's country. Must be `US` or `CA`. Defaults to `US` if not
provided.
customField1:
type: string
nullable: true
description: Custom field 1 for vendor
customField2:
type: string
nullable: true
description: Custom field 2 for vendor
customerVendorAccount:
type: string
nullable: true
description: Account number of paypoint in the vendor side.
ein:
$ref: '#/components/schemas/VendorEin'
nullable: true
email:
$ref: '#/components/schemas/Email'
nullable: true
description: Vendor's email address. Required for vCard.
internalReferenceId:
type: integer
format: int64
nullable: true
description: Internal identifier for global vendor account.
locationCode:
$ref: '#/components/schemas/LocationCode'
nullable: true
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
name1:
$ref: '#/components/schemas/VendorName1'
nullable: true
name2:
$ref: '#/components/schemas/VendorName2'
nullable: true
payeeName1:
$ref: '#/components/schemas/PayeeName'
nullable: true
payeeName2:
$ref: '#/components/schemas/PayeeName'
nullable: true
paymentMethod:
$ref: '#/components/schemas/VendorPaymentMethodString'
nullable: true
phone:
$ref: '#/components/schemas/VendorPhone'
nullable: true
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
remitEmail:
$ref: '#/components/schemas/RemitEmail'
nullable: true
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
state:
type: string
nullable: true
description: >-
Vendor's state or province. Required if any address field is
provided. Must be a valid US state abbreviation (such as `CA`, `NY`)
or Canadian province abbreviation (such as `ON`, `BC`), depending on
the `country` value.
vendorStatus:
$ref: '#/components/schemas/Vendorstatus'
nullable: true
zip:
type: string
nullable: true
description: >-
Vendor's ZIP or postal code. Required if any address field is
provided. For US addresses, use five digits (`12345`) or ZIP+4
format (`12345-6789`).
VendorDataResponse:
title: VendorDataResponse
type: object
properties:
VendorNumber:
$ref: '#/components/schemas/VendorNumber'
Name1:
type: string
description: Primary name for vendor.
Name2:
type: string
description: Secondary name for vendor.
EIN:
type: string
description: >-
EIN/Tax ID for vendor. In responses, this field is masked, and looks
like: `"ein": "XXXXX6789"`.
Phone:
type: string
description: Vendor's phone number.
Email:
$ref: '#/components/schemas/Email'
RemitEmail:
type: string
nullable: true
description: Email address for remittance
Address1:
type: string
description: Vendor's address.
Address2:
type: string
description: Additional line for vendor's address.
City:
type: string
description: Vendor's city.
State:
type: string
description: Vendor's state. Must be a two-character state code.
Zip:
type: string
description: Vendor's zip code.
Country:
type: string
description: Vendor's country. Payabli supports only US and Canadian vendors.
Mcc:
$ref: '#/components/schemas/Mcc'
LocationCode:
$ref: '#/components/schemas/LocationCode'
Contacts:
type: array
items:
$ref: '#/components/schemas/ContactsResponse'
description: Array of objects describing the vendor's contacts.
BillingData:
$ref: '#/components/schemas/VendorResponseBillingData'
description: Object containing vendor's bank information.
PaymentMethod:
$ref: '#/components/schemas/VendorDataResponsePaymentMethod'
description: Preferred payment method for vendor.
VendorStatus:
$ref: '#/components/schemas/Vendorstatus'
VendorId:
$ref: '#/components/schemas/Vendorid'
EnrollmentStatus:
type: string
nullable: true
description: Vendor enrollment status
Summary:
$ref: '#/components/schemas/VendorResponseSummary'
description: Vendor bill summary statistics
PaypointLegalname:
type: string
description: Legal name of the paypoint
PaypointDbaname:
type: string
description: DBA name of the paypoint
PaypointEntryname:
type: string
description: Entry name of the paypoint
ParentOrgName:
type: string
description: Name of the parent organization
ParentOrgId:
type: integer
description: ID of the parent organization
CreatedDate:
type: string
format: date-time
description: Date when vendor was created
LastUpdated:
type: string
format: date-time
description: Date when vendor was last updated
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
remitCity:
$ref: '#/components/schemas/Remitcity'
remitState:
$ref: '#/components/schemas/Remitstate'
remitZip:
$ref: '#/components/schemas/Remitzip'
remitCountry:
$ref: '#/components/schemas/Remitcountry'
payeeName1:
$ref: '#/components/schemas/PayeeName'
payeeName2:
$ref: '#/components/schemas/PayeeName'
customField1:
type: string
description: Custom field 1 for vendor
customField2:
type: string
description: Custom field 2 for vendor
customerVendorAccount:
type: string
nullable: true
description: Account number of paypoint in the Vendor side.
InternalReferenceId:
$ref: '#/components/schemas/InternalReferenceId'
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
externalPaypointID:
type: string
description: External paypoint identifier
StoredMethods:
type: array
items:
$ref: '#/components/schemas/VendorResponseStoredMethod'
description: Array of stored payment methods for vendor
required:
- VendorNumber
- Name1
- Name2
- EIN
- Phone
- Email
- Address1
- Address2
- City
- State
- Zip
- Country
- Mcc
- LocationCode
- Contacts
- BillingData
- PaymentMethod
- VendorStatus
- VendorId
- Summary
- PaypointLegalname
- PaypointDbaname
- PaypointEntryname
- ParentOrgName
- ParentOrgId
- CreatedDate
- LastUpdated
- remitAddress1
- remitAddress2
- remitCity
- remitState
- remitZip
- remitCountry
- payeeName1
- payeeName2
- customField1
- customField2
- InternalReferenceId
- additionalData
- externalPaypointID
- StoredMethods
VendorResponseSummary:
title: VendorResponseSummary
type: object
description: Vendor bill summary statistics
properties:
ActiveBills:
type: integer
nullable: true
PendingBills:
type: integer
nullable: true
InTransitBills:
type: integer
nullable: true
PaidBills:
type: integer
nullable: true
OverdueBills:
type: integer
nullable: true
ApprovedBills:
type: integer
nullable: true
DisapprovedBills:
type: integer
nullable: true
TotalBills:
type: integer
nullable: true
ActiveBillsAmount:
type: number
format: double
nullable: true
PendingBillsAmount:
type: number
format: double
nullable: true
InTransitBillsAmount:
type: number
format: double
nullable: true
PaidBillsAmount:
type: number
format: double
nullable: true
OverdueBillsAmount:
type: number
format: double
nullable: true
ApprovedBillsAmount:
type: number
format: double
nullable: true
DisapprovedBillsAmount:
type: number
format: double
nullable: true
TotalBillsAmount:
type: number
format: double
nullable: true
VendorResponseStoredMethod:
title: VendorResponseStoredMethod
type: object
description: Stored payment method information
properties:
IdPmethod:
type: string
nullable: true
Method:
type: string
nullable: true
Descriptor:
type: string
nullable: true
MaskedAccount:
type: string
nullable: true
ExpDate:
type: string
nullable: true
HolderName:
type: string
nullable: true
AchSecCode:
type: string
nullable: true
AchHolderType:
type: string
nullable: true
IsValidatedACH:
type: boolean
nullable: true
BIN:
type: string
nullable: true
binData:
type: string
nullable: true
ABA:
type: string
nullable: true
PostalCode:
type: string
nullable: true
MethodType:
type: string
nullable: true
LastUpdated:
type: string
format: date-time
nullable: true
CardUpdatedOn:
type: string
format: date-time
nullable: true
required:
- IdPmethod
- Method
- Descriptor
- MaskedAccount
- ExpDate
- HolderName
- AchSecCode
- AchHolderType
- IsValidatedACH
- BIN
- binData
- ABA
- PostalCode
- MethodType
- LastUpdated
- CardUpdatedOn
VendorResponseBillingData:
title: VendorResponseBillingData
type: object
description: Object containing vendor's bank information
properties:
id:
type: integer
nullable: true
accountId:
type: string
nullable: true
nickname:
type: string
nullable: true
bankName:
type: string
nullable: true
routingAccount:
type: string
nullable: true
accountNumber:
type: string
nullable: true
typeAccount:
type: string
nullable: true
bankAccountHolderName:
type: string
nullable: true
bankAccountHolderType:
type: string
nullable: true
bankAccountFunction:
type: integer
nullable: true
verified:
type: boolean
nullable: true
status:
type: integer
nullable: true
services:
type: array
items: {}
nullable: true
default:
type: boolean
nullable: true
VendorDataResponsePaymentMethod:
title: VendorDataResponsePaymentMethod
type: string
enum:
- vcard
- ach
- check
- card
description: Preferred payment method for vendor.
VendorEin:
title: VendorEin
type: string
description: >-
EIN/Tax ID for vendor. Must be nine digits formatted as `XX-XXXXXXX`
(for example, `12-3456789`).
Vendorid:
title: Vendorid
type: integer
description: Payabli identifier for vendor record.
VendorName1:
title: VendorName1
type: string
description: >-
Primary name for vendor. Required for new vendor. Allowed characters are
letters, numbers, spaces, and the following symbols `. , ' & ( )
VendorName2:
title: VendorName2
type: string
description: >-
Secondary name for vendor. If provided, allowed characters are the same
as the `name1` field. Letters, numbers, spaces, and `. , ' & ( )
VendorNumber:
title: VendorNumber
type: string
description: >-
Custom number identifying the vendor. Must be unique in paypoint. Can't
be blank.
VendorOutData:
title: VendorOutData
type: object
properties:
additionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
Address1:
$ref: '#/components/schemas/AddressNullable'
nullable: true
description: >-
Vendor's street address. Allowed characters are letters, numbers,
spaces, and `. ,
Address2:
$ref: '#/components/schemas/AddressAddtlNullable'
nullable: true
description: >-
Additional line for vendor's address, such as a suite or unit
number.
BillingData:
$ref: '#/components/schemas/BillingData'
nullable: true
description: Object containing vendor's bank information.
City:
type: string
description: Vendor's city.
Contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
description: Array of objects describing the vendor's contacts.
Country:
type: string
description: Vendor's country. `US` or `CA`.
customerVendorAccount:
type: string
nullable: true
description: Account number of paypoint in the vendor side.
EIN:
type: string
description: >-
EIN/Tax ID for vendor. Must be nine digits formatted as
`XX-XXXXXXX`. In responses, this field is masked and looks like:
`XXXXX6789`.
Email:
$ref: '#/components/schemas/Email'
nullable: true
description: Vendor's email address. Required for vCard.
InternalReferenceId:
type: integer
format: int64
nullable: true
description: Internal identifier for global vendor account.
LocationCode:
$ref: '#/components/schemas/LocationCode'
nullable: true
Mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
Name1:
type: string
description: >-
Primary name for vendor. Required for new vendor. Allowed characters
are letters, numbers, spaces, and `. , ' & ( )
Name2:
type: string
nullable: true
description: >-
Secondary name for vendor. If provided, allowed characters are the
same as `Name1`.
payeeName1:
$ref: '#/components/schemas/PayeeName'
nullable: true
payeeName2:
$ref: '#/components/schemas/PayeeName'
nullable: true
PaymentMethod:
$ref: '#/components/schemas/VendorPaymentMethod'
nullable: true
Phone:
type: string
description: >-
Vendor's phone number. Digits only when creating or updating a
vendor.
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
State:
type: string
description: >-
Vendor's state or province. Must be a valid US state or Canadian
province abbreviation, depending on the `Country` value.
VendorId:
$ref: '#/components/schemas/Vendorid'
nullable: true
description: >-
Payabli identifier for vendor record. Required when `VendorNumber`
isn't included.
VendorNumber:
$ref: '#/components/schemas/VendorNumber'
nullable: true
VendorStatus:
$ref: '#/components/schemas/Vendorstatus'
nullable: true
Zip:
type: string
description: >-
Vendor's ZIP or postal code. For US addresses, five digits (`12345`)
or ZIP+4 format (`12345-6789`).
required:
- City
- Country
- EIN
- Name1
- Phone
- State
- Zip
VendorPaymentMethodString:
title: VendorPaymentMethodString
type: string
description: |-
The vendor's preferred payment method. Can be one of:
- `"managed"` - Managed payment method
- `"vcard"` - Virtual card payment method
- `"check"` - Check payment method
- `"ach"` - ACH payment method
VendorPaymentMethod:
title: VendorPaymentMethod
type: object
description: >-
Payment method object to use for the payout.
- `{ method: "managed" }` - Managed payment method
- `{ method: "vcard" }` - Virtual card payment method
- `{ method: "check" }` - Check payment method
- `{ method: "ach", storedMethodId?: "..." }` - ACH payment method with
optional stored method ID
properties:
method:
type: string
description: Payment method type - "managed", "vcard", "check", or "ach"
storedMethodId:
type: string
nullable: true
description: >-
ID of the stored ACH payment method. Only applicable when method is
"ach". Required when using a previously saved ACH method when the
vendor has more than one saved method. See the [Payouts with saved
ACH payment
methods](/developers/developer-guides/pay-out-manage-payouts)
section for more details.
required:
- method
AchPaymentMethod:
title: AchPaymentMethod
type: object
description: ACH payment method.
properties:
method:
type: string
const: ach
description: Payment method type
storedMethodId:
type: string
nullable: true
description: >-
ID of the stored ACH payment method. Required when using a
previously saved ACH method when the vendor has more than one saved
method. See the [Payouts with saved ACH payment
methods](/developers/developer-guides/pay-out-manage-payouts)
section for more details.
required:
- method
VendorPhone:
title: VendorPhone
type: string
pattern: ^[0-9]+$
description: >-
Vendor's phone number. Phone number can't contain non-digit characters
like hyphens or parentheses.
VendorQueryRecord:
title: VendorQueryRecord
type: object
properties:
additionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
Address1:
$ref: '#/components/schemas/AddressNullable'
nullable: true
Address2:
$ref: '#/components/schemas/AddressAddtlNullable'
nullable: true
BillingData:
$ref: '#/components/schemas/BillingDataResponse'
nullable: true
City:
$ref: '#/components/schemas/CityNullable'
nullable: true
Contacts:
$ref: '#/components/schemas/ContactsResponse'
nullable: true
Country:
type: string
nullable: true
CreatedDate:
$ref: '#/components/schemas/CreatedAt'
nullable: true
customerVendorAccount:
type: string
nullable: true
customField1:
type: string
nullable: true
customField2:
type: string
nullable: true
EIN:
$ref: '#/components/schemas/Ein'
nullable: true
Email:
$ref: '#/components/schemas/Email'
nullable: true
EnrollmentStatus:
$ref: '#/components/schemas/EnrollmentStatus'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
InternalReferenceId:
$ref: '#/components/schemas/InternalReferenceId'
nullable: true
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
LocationCode:
type: string
nullable: true
Mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
Name1:
type: string
nullable: true
Name2:
type: string
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ParentOrgId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
payeeName1:
$ref: '#/components/schemas/PayeeName'
nullable: true
payeeName2:
$ref: '#/components/schemas/PayeeName'
nullable: true
PaymentMethod:
$ref: '#/components/schemas/VendorPaymentMethodString'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
Phone:
type: string
nullable: true
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
RemitEmail:
$ref: '#/components/schemas/RemitEmail'
nullable: true
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
State:
$ref: '#/components/schemas/StateNullable'
nullable: true
StoredMethods:
type: array
items:
$ref: '#/components/schemas/VendorResponseStoredMethod'
nullable: true
Summary:
$ref: '#/components/schemas/VendorSummary'
nullable: true
VendorId:
$ref: '#/components/schemas/Vendorid'
nullable: true
VendorNumber:
$ref: '#/components/schemas/VendorNumber'
nullable: true
VendorStatus:
$ref: '#/components/schemas/Vendorstatus'
nullable: true
Zip:
$ref: '#/components/schemas/Zip'
nullable: true
Vendorstatus:
title: Vendorstatus
type: integer
description: |-
Vendor's status.
Allowed values:
- `0` Inactive
- `1` Active
- `-99` Deleted
VendorSummary:
title: VendorSummary
type: object
properties:
ActiveBills:
type: integer
nullable: true
PendingBills:
type: integer
nullable: true
InTransitBills:
type: integer
nullable: true
PaidBills:
type: integer
nullable: true
OverdueBills:
type: integer
nullable: true
ApprovedBills:
type: integer
nullable: true
DisapprovedBills:
type: integer
nullable: true
TotalBills:
type: integer
nullable: true
ActiveBillsAmount:
type: number
format: double
nullable: true
PendingBillsAmount:
type: number
format: double
nullable: true
InTransitBillsAmount:
type: number
format: double
nullable: true
PaidBillsAmount:
type: number
format: double
nullable: true
OverdueBillsAmount:
type: number
format: double
nullable: true
ApprovedBillsAmount:
type: number
format: double
nullable: true
DisapprovedBillsAmount:
type: number
format: double
nullable: true
TotalBillsAmount:
type: number
format: double
nullable: true
Visible:
title: Visible
type: boolean
description: When `true`, makes the section visible on the application.
WalletCascade:
title: WalletCascade
type: boolean
description: >-
When `true`, the wallet service configuration cascades to all paypoints
and suborganizations belonging to the parent entity.
WalletIsEnabled:
title: WalletIsEnabled
type: boolean
description: When `true`, wallet service is enabled.
Website:
title: Website
type: string
description: >-
The business website address. Include only the domain and TLD, do not
enter the protocol (http/https). For example: `www.example.com` is
acceptable.
Whencharged:
title: Whencharged
type: string
enum:
- When Service Provided
- In Advance
description: >-
Describes when customers are charged for goods or services. Accepted
values:
Whendelivered:
title: Whendelivered
type: string
enum:
- 0-7 Days
- 8-14 Days
- 15-30 Days
- Over 30 Days
description: When goods and services are delivered.
Whenprovided:
title: Whenprovided
type: string
enum:
- 30 Days or Less
- 31 to 60 Days
- 60+ Days
description: Describes when goods or services are provided, from time of transaction.
Whenrefunded:
title: Whenrefunded
type: string
enum:
- Exchange Only
- No Refund or Exchange
- More than 30 days
- 30 Days or Less
description: Describes the business refund policy.
Zip:
title: Zip
type: string
description: ZIP code for address.
AllowedCheckPaymentStatus:
title: AllowedCheckPaymentStatus
type: string
enum:
- '0'
- '5'
description: |-
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.
LotNumber:
title: LotNumber
type: string
description: Lot number associated with the bill.
AuthorizePayoutBody:
title: AuthorizePayoutBody
type: object
properties:
entryPoint:
$ref: '#/components/schemas/Entrypointfield'
source:
$ref: '#/components/schemas/Source'
nullable: true
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
paymentMethod:
$ref: '#/components/schemas/AuthorizePaymentMethod'
paymentDetails:
$ref: '#/components/schemas/RequestOutAuthorizePaymentDetails'
description: Object containing payment details.
vendorData:
$ref: '#/components/schemas/RequestOutAuthorizeVendorData'
description: Object containing vendor data.
invoiceData:
type: array
items:
$ref: '#/components/schemas/RequestOutAuthorizeInvoiceData'
description: Array of bills associated to the transaction
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
subscriptionId:
$ref: '#/components/schemas/Subscriptionid'
nullable: true
required:
- entryPoint
- paymentMethod
- paymentDetails
- vendorData
- invoiceData
AuthorizePaymentMethod:
title: AuthorizePaymentMethod
type: object
description: >-
Payment method object for vendor payouts.
- `{ method: "managed" }` - Managed payment method
- `{ method: "vcard" }` - Virtual card payment method
- `{ method: "check" }` - Check payment method
- `{ method: "ach", achHolder: "...", achRouting: "...", achAccount:
"...", achAccountType: "..." }` - ACH payment method with bank details
- `{ method: "ach", storedMethodId: "..." }` - ACH payment method using
stored method ID
properties:
method:
type: string
description: Payment method type - "managed", "vcard", "check", or "ach"
achHolder:
type: string
nullable: true
description: >-
Account holder name for ACH payments. Required when method is "ach"
and not using `storedMethodId`.
achRouting:
type: string
nullable: true
description: >-
Bank routing number for ACH payments. Required when method is "ach"
and not using `storedMethodId`.
achAccount:
type: string
nullable: true
description: >-
Bank account number for ACH payments. Required when method is "ach"
and not using `storedMethodId`.
achAccountType:
type: string
nullable: true
description: >-
Account type for ACH payments ("checking" or "savings"). Required
when method is "ach" and not using `storedMethodId`.
achCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
achHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
storedMethodId:
type: string
nullable: true
description: >-
ID of the stored ACH payment method. Only applicable when method is
`ach`. Use this to reference a previously saved ACH method instead
of providing bank details directly.
initiator:
$ref: '#/components/schemas/Initiator'
nullable: true
storedMethodUsageType:
$ref: '#/components/schemas/StoredMethodUsageType'
nullable: true
required:
- method
RequestOutAuthorizeVendorData:
title: RequestOutAuthorizeVendorData
type: object
description: Object containing vendor data.
properties:
vendorNumber:
$ref: '#/components/schemas/VendorNumber'
nullable: true
name1:
$ref: '#/components/schemas/VendorName1'
nullable: true
name2:
$ref: '#/components/schemas/VendorName2'
nullable: true
ein:
$ref: '#/components/schemas/VendorEin'
nullable: true
phone:
$ref: '#/components/schemas/VendorPhone'
nullable: true
email:
$ref: '#/components/schemas/Email'
nullable: true
address1:
$ref: '#/components/schemas/AddressNullable'
nullable: true
city:
type: string
nullable: true
state:
type: string
nullable: true
zip:
type: string
nullable: true
country:
type: string
nullable: true
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
billingData:
$ref: '#/components/schemas/RequestOutAuthorizeVendorBillingData'
nullable: true
vendorStatus:
$ref: '#/components/schemas/Vendorstatus'
nullable: true
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
customerVendorAccount:
type: string
nullable: true
customField1:
type: string
nullable: true
customField2:
type: string
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
address2:
$ref: '#/components/schemas/AddressAddtlNullable'
nullable: true
internalReferenceId:
type: integer
format: int64
nullable: true
locationCode:
$ref: '#/components/schemas/LocationCode'
nullable: true
payeeName1:
$ref: '#/components/schemas/PayeeName'
nullable: true
payeeName2:
$ref: '#/components/schemas/PayeeName'
nullable: true
paymentMethod:
$ref: '#/components/schemas/VendorPaymentMethod'
nullable: true
vendorId:
$ref: '#/components/schemas/Vendorid'
nullable: true
RequestOutAuthorizeVendorBillingData:
title: RequestOutAuthorizeVendorBillingData
type: object
description: >-
Object containing vendor's bank information. This object is deprecated
for this endpoint. Use the `paymentMethod` object in payout authorize
requests instead.
properties:
bankName:
$ref: '#/components/schemas/BankName'
nullable: true
routingAccount:
$ref: '#/components/schemas/RoutingAccount'
nullable: true
accountNumber:
$ref: '#/components/schemas/AccountNumber'
nullable: true
typeAccount:
$ref: '#/components/schemas/TypeAccount'
nullable: true
bankAccountHolderName:
$ref: '#/components/schemas/BankAccountHolderName'
nullable: true
RequestOutAuthorizeInvoiceData:
title: RequestOutAuthorizeInvoiceData
type: object
properties:
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
nullable: true
netAmount:
$ref: '#/components/schemas/NetAmountstring'
nullable: true
invoiceDate:
type: string
format: date
nullable: true
description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
dueDate:
type: string
format: date
nullable: true
description: >-
Invoice due date in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
comments:
$ref: '#/components/schemas/Comments'
nullable: true
lotNumber:
$ref: '#/components/schemas/LotNumber'
nullable: true
billId:
$ref: '#/components/schemas/BillId'
nullable: true
discount:
$ref: '#/components/schemas/Discount'
nullable: true
terms:
$ref: '#/components/schemas/Terms'
nullable: true
accountingField1:
$ref: '#/components/schemas/AccountingField'
nullable: true
accountingField2:
$ref: '#/components/schemas/AccountingField'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
AuthCapturePayoutResponse:
title: AuthCapturePayoutResponse
type: object
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
$ref: '#/components/schemas/RoomIdNotInUse'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/AuthCapturePayoutResponseData'
required:
- responseCode
- pageIdentifier
- roomId
- isSuccess
- responseText
- responseData
AuthCapturePayoutResponseData:
title: AuthCapturePayoutResponseData
type: object
properties:
authCode:
$ref: '#/components/schemas/Authcode'
nullable: true
referenceId:
$ref: '#/components/schemas/Referenceidtrans'
resultCode:
$ref: '#/components/schemas/ResultCode'
resultText:
$ref: '#/components/schemas/Resulttext'
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
customerId:
$ref: '#/components/schemas/Customeridtrans'
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
required:
- authCode
- referenceId
- resultCode
- resultText
- avsResponseText
- cvvResponseText
- customerId
- methodReferenceId
CaptureAllOutResponse:
title: CaptureAllOutResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
type: array
items:
$ref: '#/components/schemas/CaptureAllOutResponseResponseDataItem'
nullable: true
description: Array of objects describing the transactions.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
CaptureAllOutResponseResponseDataItem:
title: CaptureAllOutResponseResponseDataItem
type: object
properties:
CustomerId:
$ref: '#/components/schemas/Customeridtrans'
nullable: true
description: >-
Internal unique Id of vendor owner of transaction. Returns `0` if
the transaction wasn't assigned to an existing vendor or no vendor
was created.
ReferenceId:
$ref: '#/components/schemas/Referenceidtrans'
nullable: true
ResultCode:
$ref: '#/components/schemas/ResultCode'
nullable: true
ResultText:
$ref: '#/components/schemas/Resulttext'
nullable: true
description: |-
Text describing the result.
If `ResultCode`` = 1, returns 'Authorized'.
If `ResultCode` = 2 or 3, this contains the cause of the decline.
RequestOutAuthorizePaymentDetails:
title: RequestOutAuthorizePaymentDetails
type: object
description: Object containing payment details.
properties:
checkNumber:
$ref: '#/components/schemas/VendorCheckNumber'
nullable: true
currency:
type: string
nullable: true
description: >-
Currency code ISO-4217. If no code is provided, then the currency in
the paypoint setting is used. Default is **USD**.
serviceFee:
type: number
format: double
nullable: true
description: >-
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.
totalAmount:
type: number
format: double
nullable: true
description: >-
Total amount to be charged. If a service fee is included, then this
amount should include the service fee.
unbundled:
type: boolean
nullable: true
description: >-
Indicates whether the payout should be bundled into a single
transaction or processed separately. If set to `true`, each bill
will be processed as a separate payout. If `false` or not provided,
then multiple bills will be paid with a single payout.
RequestOutAuthorizeVendorDataOld:
title: RequestOutAuthorizeVendorDataOld
type: object
description: Object containing vendor data.
properties:
additionalData:
$ref: '#/components/schemas/AdditionalData'
nullable: true
address1:
$ref: '#/components/schemas/AddressNullable'
nullable: true
description: Vendor's address
address2:
$ref: '#/components/schemas/AddressAddtlNullable'
nullable: true
description: Additional line for vendor's address.
billingData:
$ref: '#/components/schemas/BillingData'
nullable: true
description: Object containing vendor's bank information.
city:
type: string
nullable: true
description: Vendor's city.
contacts:
$ref: '#/components/schemas/ContactsField'
nullable: true
description: Array of objects describing the vendor's contacts.
country:
type: string
nullable: true
description: Vendor's country.
customerVendorAccount:
type: string
nullable: true
description: Account number of paypoint in the vendor side.
customField1:
type: string
nullable: true
customField2:
type: string
nullable: true
ein:
$ref: '#/components/schemas/VendorEin'
nullable: true
email:
$ref: '#/components/schemas/Email'
nullable: true
description: Vendor's email address. Required for vCard.
internalReferenceId:
type: integer
format: int64
nullable: true
description: Internal identifier for global vendor account.
locationCode:
$ref: '#/components/schemas/LocationCode'
nullable: true
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
name1:
$ref: '#/components/schemas/VendorName1'
nullable: true
name2:
$ref: '#/components/schemas/VendorName2'
nullable: true
payeeName1:
$ref: '#/components/schemas/PayeeName'
nullable: true
payeeName2:
$ref: '#/components/schemas/PayeeName'
nullable: true
paymentMethod:
$ref: '#/components/schemas/VendorPaymentMethod'
nullable: true
phone:
$ref: '#/components/schemas/VendorPhone'
nullable: true
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
state:
type: string
nullable: true
description: Vendor's state. Must be a 2 character state code.
vendorId:
$ref: '#/components/schemas/Vendorid'
nullable: true
description: >-
Payabli identifier for vendor record. Required when `vendorNumber`
isn't included.
vendorNumber:
$ref: '#/components/schemas/VendorNumber'
nullable: true
vendorStatus:
$ref: '#/components/schemas/Vendorstatus'
nullable: true
zip:
type: string
nullable: true
description: Vendor's postal code.
VCardGetResponse:
title: VCardGetResponse
type: object
properties:
vcardSent:
type: boolean
nullable: true
description: Indicates if the virtual card was sent.
cardToken:
type: string
nullable: true
description: A unique token identifier for the card.
cardNumber:
type: string
nullable: true
description: The masked number of the card.
cvc:
type: string
nullable: true
description: Masked Card Verification Code.
expirationDate:
type: string
nullable: true
description: The expiration date of the card.
status:
type: string
nullable: true
description: The current status of the card.
amount:
type: number
format: double
nullable: true
description: The initial amount loaded on the card.
currentBalance:
type: number
format: double
nullable: true
description: The current balance available on the card.
expenseLimit:
type: number
format: double
nullable: true
description: The set limit for expenses.
expenseLimitPeriod:
type: string
nullable: true
description: The period for the expense limit.
maxNumberOfUses:
type: integer
nullable: true
description: Maximum number of uses allowed for the card.
currentNumberOfUses:
type: integer
nullable: true
description: The current number of times the card has been used.
exactAmount:
type: boolean
nullable: true
description: Indicates if only the exact amount is allowed for transactions.
mcc:
type: string
nullable: true
description: Merchant Category Code, if applicable.
tcc:
type: string
nullable: true
description: Transaction Category Code, if applicable.
misc1:
type: string
nullable: true
description: A miscellaneous field for additional information.
misc2:
type: string
nullable: true
description: Another miscellaneous field for extra information.
dateCreated:
type: string
nullable: true
description: The creation date of the record.
dateModified:
type: string
nullable: true
description: The last modified date of the record.
associatedVendor:
$ref: '#/components/schemas/VCardGetResponseAssociatedVendor'
nullable: true
description: Information about the associated vendor.
associatedCustomer:
type: string
nullable: true
description: Information about the associated customer, if applicable.
ParentOrgName:
type: string
nullable: true
description: Name of the parent organization.
PaypointDbaname:
type: string
nullable: true
description: The 'Doing Business As' name of the Paypoint.
PaypointLegalname:
type: string
nullable: true
description: The legal name of the Paypoint.
PaypointEntryname:
type: string
nullable: true
description: Entry name for the Paypoint, if applicable.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
paypointId:
type: integer
nullable: true
description: The unique identifier for the paypoint.
VCardGetResponseAssociatedVendor:
title: VCardGetResponseAssociatedVendor
type: object
description: Information about the associated vendor.
properties:
VendorNumber:
type: string
nullable: true
description: Unique code identifying the vendor.
Name1:
type: string
nullable: true
description: The primary name associated with the vendor.
Name2:
type: string
nullable: true
description: Additional name information for the vendor.
EIN:
type: string
nullable: true
description: Employer Identification Number of the vendor.
Phone:
type: string
nullable: true
description: Contact phone number of the vendor.
Email:
type: string
nullable: true
description: Contact email address of the vendor.
RemitEmail:
type: string
nullable: true
description: Email address for remittance.
Address1:
type: string
nullable: true
description: Primary address line of the vendor.
Address2:
type: string
nullable: true
description: Secondary address line of the vendor.
City:
type: string
nullable: true
description: City where the vendor is located.
State:
type: string
nullable: true
description: State where the vendor is located.
Zip:
type: string
nullable: true
description: ZIP code for the vendor's location.
Country:
type: string
nullable: true
description: Country where the vendor is located.
Mcc:
type: string
nullable: true
description: Merchant Category Code for the vendor.
LocationCode:
$ref: '#/components/schemas/LocationCode'
nullable: true
Contacts:
type: array
items:
$ref: '#/components/schemas/VCardGetResponseContact'
nullable: true
description: Array of objects describing the vendor's contacts.
BillingData:
$ref: '#/components/schemas/VCardGetResponseAssociatedVendorBillingData'
nullable: true
description: Billing data for the vendor.
PaymentMethod:
type: string
nullable: true
description: Preferred payment method for vendor.
VendorStatus:
type: integer
nullable: true
description: Status of the vendor.
VendorId:
type: integer
nullable: true
description: Unique identifier for the vendor.
EnrollmentStatus:
type: string
nullable: true
description: Enrollment status of the vendor.
Summary:
$ref: '#/components/schemas/VCardGetResponseAssociatedVendorSummary'
nullable: true
description: Summary of vendor's billing and transaction status.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: Legal name of the paypoint.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: DBA name of the paypoint.
PaypointEntryname:
type: string
nullable: true
description: Entryname of the paypoint.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ParentOrgId:
type: integer
nullable: true
description: ID of the parent organization.
CreatedDate:
type: string
nullable: true
description: Date when the vendor record was created.
LastUpdated:
type: string
nullable: true
description: Date when the vendor's information was last updated.
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
payeeName1:
type: string
nullable: true
description: Primary name of the payee.
payeeName2:
type: string
nullable: true
description: Secondary name of the payee.
customField1:
type: string
nullable: true
description: A custom field for additional data.
customField2:
type: string
nullable: true
description: Another custom field for extra data.
customerVendorAccount:
type: string
nullable: true
description: Account number of paypoint in the vendor side.
InternalReferenceId:
type: integer
nullable: true
description: Internal reference ID used within the system.
additionalData:
type: string
nullable: true
description: Field for additional data, if any.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
StoredMethods:
type: string
nullable: true
description: Stored payment methods for the vendor.
VCardGetResponseContact:
title: VCardGetResponseContact
type: object
description: Contact information structure.
properties:
ContactName:
type: string
nullable: true
description: Name of the contact.
ContactEmail:
type: string
nullable: true
description: Email of the contact.
ContactTitle:
type: string
nullable: true
description: Title of the contact.
ContactPhone:
type: string
nullable: true
description: Phone number of the contact.
VCardGetResponseAssociatedVendorBillingData:
title: VCardGetResponseAssociatedVendorBillingData
type: object
description: Billing data for the vendor.
properties:
id:
type: integer
nullable: true
description: Unique identifier for billing data.
accountId:
type: string
nullable: true
description: Account identifier.
nickname:
type: string
nullable: true
description: Nickname for the account.
bankName:
type: string
nullable: true
description: Name of the bank used for transactions.
routingAccount:
type: string
nullable: true
description: Routing number for the bank account.
accountNumber:
type: string
nullable: true
description: Masked account number for transactions.
typeAccount:
type: string
nullable: true
description: Type of the bank account.
bankAccountHolderName:
type: string
nullable: true
description: Name of the bank account holder.
bankAccountHolderType:
type: string
nullable: true
description: Type of bank account holder.
bankAccountFunction:
type: integer
nullable: true
description: Function of the bank account.
verified:
type: boolean
nullable: true
description: Indicates if the account is verified.
status:
type: integer
nullable: true
description: Status of the billing data.
services:
type: array
items: {}
nullable: true
description: Services associated with the account.
default:
type: boolean
nullable: true
description: Indicates if this is the default billing account.
VCardGetResponseAssociatedVendorSummary:
title: VCardGetResponseAssociatedVendorSummary
type: object
description: Summary of vendor's billing and transaction status.
properties:
ActiveBills:
type: integer
nullable: true
description: Number of active bills.
PendingBills:
type: integer
nullable: true
description: Number of bills pending approval or payment.
InTransitBills:
type: integer
nullable: true
description: Number of bills in transit.
PaidBills:
type: integer
nullable: true
description: Number of bills that have been paid.
OverdueBills:
type: integer
nullable: true
description: Number of bills that are overdue.
ApprovedBills:
type: integer
nullable: true
description: Number of bills that have been approved.
DisapprovedBills:
type: integer
nullable: true
description: Number of bills that have been disapproved.
TotalBills:
type: integer
nullable: true
description: Total number of bills.
ActiveBillsAmount:
type: number
format: double
nullable: true
description: Total amount of active bills.
PendingBillsAmount:
type: number
format: double
nullable: true
description: Total amount of pending bills.
InTransitBillsAmount:
type: number
format: double
nullable: true
description: Total amount of bills in transit.
PaidBillsAmount:
type: number
format: double
nullable: true
description: Total amount of paid bills.
OverdueBillsAmount:
type: number
format: double
nullable: true
description: Total amount of overdue bills.
ApprovedBillsAmount:
type: number
format: double
nullable: true
description: Total amount of approved bills.
DisapprovedBillsAmount:
type: number
format: double
nullable: true
description: Total amount of rejected bills.
TotalBillsAmount:
type: number
format: double
nullable: true
description: Total amount of all bills.
ReissuePaymentMethod:
title: ReissuePaymentMethod
type: object
description: >-
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 payment method.
- `{ method: "vcard" }` - Reissue as a virtual card
- `{ method: "check" }` - Reissue as a paper check
- `{ method: "ach", achHolder: "...", achRouting: "...", achAccount:
"...", achAccountType: "...", achHolderType: "..." }` - Reissue as ACH
with bank details
properties:
method:
type: string
description: Payment method type. Must be `"ach"`, `"check"`, or `"vcard"`.
achHolder:
type: string
nullable: true
description: Account holder name. Required when `method` is `"ach"`.
achRouting:
type: string
nullable: true
description: Bank routing number (9 digits). Required when `method` is `"ach"`.
achAccount:
type: string
nullable: true
description: >-
Bank account number (8-17 digits). Required when `method` is
`"ach"`.
achAccountType:
type: string
nullable: true
description: >-
Bank account type (`"checking"` or `"savings"`). Required when
`method` is `"ach"`.
achHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
required:
- method
ReissuePayoutBody:
title: ReissuePayoutBody
type: object
description: Request body for reissuing a payout transaction.
properties:
paymentMethod:
$ref: '#/components/schemas/ReissuePaymentMethod'
required:
- paymentMethod
ReissuePayoutResponse:
title: ReissuePayoutResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseCode:
$ref: '#/components/schemas/Responsecode'
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/ReissuePayoutResponseData'
required:
- isSuccess
- responseCode
- responseText
- responseData
ReissuePayoutResponseData:
title: ReissuePayoutResponseData
type: object
properties:
transactionId:
type: string
description: The transaction ID of the newly created payout.
status:
type: string
description: The status of the new transaction.
originalTransactionId:
type: string
nullable: true
description: The transaction ID of the original payout that was reissued.
required:
- transactionId
- status
OperationResult:
title: OperationResult
type: object
properties:
message:
type: string
nullable: true
description: >-
Message describing the result. If the virtual card link was sent
successfully, this contains the email address to which the link was
sent.
success:
type: boolean
description: Indicates whether the operation was successful.
required:
- success
MethodsListOut:
title: MethodsListOut
type: object
description: >-
Payment methods available for Pay Out payment links. Controls which
payout options are offered to the vendor.
properties:
ach:
type: boolean
nullable: true
description: When `true`, ACH bank transfer is offered as a payout method.
check:
type: boolean
nullable: true
description: When `true`, physical check is offered as a payout method.
vcard:
type: boolean
nullable: true
description: When `true`, virtual card (vCard) is offered as a payout method.
MethodElementOut:
title: MethodElementOut
type: object
description: Configuration for payment method selection on Pay Out payment links.
properties:
allMethodsChecked:
type: boolean
nullable: true
description: Flag indicating if all allowed payment methods will be pre-selected.
allowMultipleMethods:
type: boolean
nullable: true
description: >-
When `true`, the vendor can select from multiple payment methods.
When `false`, only the default method is shown.
defaultMethod:
type: string
nullable: true
description: >-
The default payment method to highlight on the payment link page.
For example, `"vcard"`, `"ach"`, or `"check"`.
enabled:
type: boolean
nullable: true
description: >-
When `true`, the payment methods section is displayed on the payment
link page.
header:
type: string
nullable: true
description: Header text for the payment methods section.
methods:
$ref: '#/components/schemas/MethodsListOut'
nullable: true
order:
type: integer
nullable: true
description: Display order of the payment methods section on the page.
showPreviewVirtualCard:
type: boolean
nullable: true
description: >-
When `true`, a preview of the virtual card is shown on the payment
link page.
PaymentLinkStatus:
title: PaymentLinkStatus
type: string
enum:
- Active
- Expired
- Canceled
- Deleted
description: The status of a payment link.
limitRecord:
title: limitRecord
type: integer
description: >-
Max number of records to return for the query. Use `0` or negative value
to return all records. Defaults to 20.
ListOrganizationsResponse:
title: ListOrganizationsResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/OrganizationQueryRecord'
Summary:
$ref: '#/components/schemas/QuerySummary'
required:
- Records
- Summary
QueryTransferSummary:
title: QueryTransferSummary
type: object
properties:
achReturns:
type: number
format: double
nullable: true
description: ACH returns deducted from the batch.
adjustments:
type: number
format: double
nullable: true
description: Corrections applied to Billing & Fees charges.
billingFees:
type: number
format: double
nullable: true
description: Charges applied for transactions and services.
chargebacks:
type: number
format: double
nullable: true
description: Chargebacks deducted from batch.
grossTransferAmount:
type: number
format: double
nullable: true
description: The gross batch amount before deductions.
releaseAmount:
type: number
format: double
nullable: true
description: Previously held funds that have been released after a risk review.
thirdPartyPaid:
type: number
format: double
nullable: true
description: >-
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.
totalNetAmountTransfer:
type: number
format: double
nullable: true
description: The gross batch amount minus service fees.
splitAmount:
type: number
format: double
nullable: true
description: The sum of each splitFundingAmount of each record in the transfer.
serviceFees:
type: number
format: double
nullable: true
description: >-
Service fees are any pass-through fees charged to the customer at
the time of payment. These aren't transferred to the merchant when
the batch is transferred and funded.
netBatchAmount:
type: number
format: double
nullable: true
description: >-
The net batch amount is the gross batch amount minus any returns,
refunds,
billing and fees items, chargebacks, adjustments, and third party
payments.
transferAmount:
type: number
format: double
nullable: true
description: >-
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.
refunds:
type: number
format: double
nullable: true
description: Refunds deducted from batch.
heldAmount:
type: number
format: double
nullable: true
description: Funds being held for fraud or risk concerns.
totalRecords:
$ref: '#/components/schemas/Totalrecords'
nullable: true
description: Number of records in the response.
totalAmount:
type: number
format: double
nullable: true
description: The total sum of the transfers in the response.
totalNetAmount:
type: number
format: double
nullable: true
description: The total sum of the transfers in the response.
totalPages:
$ref: '#/components/schemas/Totalpages'
nullable: true
description: Number of pages in the response.
pageSize:
$ref: '#/components/schemas/Pagesize'
nullable: true
description: Number of records per page.
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
description: >-
Auxiliary validation used internally by payment pages and
components.
required:
- achReturns
- adjustments
- billingFees
- chargebacks
- grossTransferAmount
- releaseAmount
- thirdPartyPaid
- totalNetAmountTransfer
- splitAmount
- serviceFees
- netBatchAmount
- transferAmount
- refunds
- heldAmount
- totalRecords
- totalAmount
- totalNetAmount
- totalPages
- pageSize
- pageidentifier
QueryTransferResponse:
title: QueryTransferResponse
type: object
properties:
Summary:
$ref: '#/components/schemas/QueryTransferSummary'
description: Summary information about the transfers.
Records:
type: array
items:
$ref: '#/components/schemas/TransactionQueryRecords'
description: List of transfer transaction records.
required:
- Summary
- Records
QueryTransferDetailResponse:
title: QueryTransferDetailResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/TransferDetailRecord'
description: List of transfer detail records
Summary:
$ref: '#/components/schemas/QueryTransferSummary'
description: Summary of the transfer details query
required:
- Records
- Summary
TransferDetailRecord:
title: TransferDetailRecord
type: object
properties:
transferDetailId:
type: integer
nullable: true
description: Unique identifier for the transfer detail record
transferId:
type: integer
nullable: true
description: The ID of the transfer this detail belongs to
transactionId:
type: string
nullable: true
description: The transaction ID in Payabli's system
transactionNumber:
type: string
nullable: true
description: External transaction reference number
type:
type: string
nullable: true
description: The transaction type (credit or debit)
category:
type: string
nullable: true
description: >-
A field used to categorize the transaction details. Values include:
auth, decline, refund, adj, cb, split
grossAmount:
type: number
format: double
nullable: true
description: The gross amount of the transaction
chargeBackAmount:
type: number
format: double
nullable: true
description: Chargeback amount deducted from transaction
returnedAmount:
type: number
format: double
nullable: true
description: ACH return amount deducted from transaction
refundAmount:
type: number
format: double
nullable: true
description: Refund amount deducted from transaction
holdAmount:
type: number
format: double
nullable: true
description: Amount being held for fraud or risk concerns
releasedAmount:
type: number
format: double
nullable: true
description: Previously held funds that have been released after a risk review
billingFeesAmount:
type: number
format: double
nullable: true
description: Charges applied for transactions and services
thirdPartyPaidAmount:
type: number
format: double
nullable: true
description: >-
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.
adjustmentsAmount:
type: number
format: double
nullable: true
description: Corrections applied to Billing & Fees charges
netTransferAmount:
type: number
format: double
nullable: true
description: The net amount after all deductions
splitFundingAmount:
type: number
format: double
nullable: true
description: Total amount directed to split funding destinations
billingFeesDetails:
type: array
items:
$ref: '#/components/schemas/BillingFeeDetail'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
PaypointEntryname:
type: string
nullable: true
description: The paypoint's entryname
PaymentTransId:
type: string
nullable: true
description: The transaction ID for the payment
ConnectorName:
type: string
nullable: true
description: The payment connector used to process the transaction
ExternalProcessorInformation:
$ref: '#/components/schemas/ExternalProcessorInformation'
nullable: true
GatewayTransId:
type: string
nullable: true
description: Internal identifier used for processing
OrderId:
$ref: '#/components/schemas/OrderId'
nullable: true
Method:
type: string
nullable: true
description: 'Payment method used: card, ach, or wallet'
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
nullable: true
BatchAmount:
type: number
format: double
nullable: true
description: The amount of the batch
PayorId:
$ref: '#/components/schemas/PayorId'
nullable: true
description: Unique ID for customer linked to the transaction
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
TransStatus:
type: integer
nullable: true
description: >-
Status of transaction. See [the
docs](/developers/references/money-in-statuses#money-in-transaction-status)
for a
full reference.
PaypointId:
$ref: '#/components/schemas/PaypointId'
nullable: true
TotalAmount:
type: number
format: double
nullable: true
description: Transaction total amount (including service fee or sub-charge)
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: Net amount paid
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
nullable: true
SettlementStatus:
type: integer
nullable: true
description: >-
Settlement status for transaction. See [the
docs](/developers/references/money-in-statuses#payment-funding-status)
for a full reference.
Operation:
$ref: '#/components/schemas/Operation'
nullable: true
ResponseData:
$ref: '#/components/schemas/QueryResponseData'
nullable: true
Source:
$ref: '#/components/schemas/Source'
nullable: true
ScheduleReference:
type: integer
nullable: true
description: >-
Reference to the subscription or schedule that originated the
transaction
OrgId:
$ref: '#/components/schemas/Orgid'
nullable: true
RefundId:
$ref: '#/components/schemas/RefundId'
nullable: true
ReturnedId:
$ref: '#/components/schemas/ReturnedId'
nullable: true
ChargebackId:
$ref: '#/components/schemas/ChargebackId'
nullable: true
RetrievalId:
$ref: '#/components/schemas/RetrievalId'
nullable: true
TransAdditionalData:
nullable: true
description: Additional transaction data
invoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
description: Associated invoice data
EntrypageId:
$ref: '#/components/schemas/EntrypageId'
nullable: true
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
IsValidatedACH:
type: boolean
nullable: true
description: Indicates whether the ACH account has been validated
TransactionTime:
type: string
format: date-time
nullable: true
description: Transaction date and time, in UTC
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
nullable: true
splitFundingInstructions:
$ref: '#/components/schemas/SplitFunding'
nullable: true
CfeeTransactions:
type: array
items:
$ref: '#/components/schemas/QueryCFeeTransaction'
nullable: true
TransactionEvents:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
nullable: true
PendingFeeAmount:
$ref: '#/components/schemas/PendingFeeAmount'
nullable: true
RiskFlagged:
$ref: '#/components/schemas/RiskFlagged'
nullable: true
RiskFlaggedOn:
$ref: '#/components/schemas/RiskFlaggedOn'
nullable: true
RiskStatus:
$ref: '#/components/schemas/RiskStatus'
nullable: true
RiskReason:
$ref: '#/components/schemas/RiskReason'
nullable: true
RiskAction:
$ref: '#/components/schemas/RiskAction'
nullable: true
RiskActionCode:
$ref: '#/components/schemas/RiskActionCode'
nullable: true
DeviceId:
$ref: '#/components/schemas/DeviceId'
nullable: true
AchSecCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
AchHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
IpAddress:
$ref: '#/components/schemas/IpAddress'
nullable: true
IsSameDayACH:
type: boolean
nullable: true
description: Indicates if this was a same-day ACH transaction.
WalletType:
type: string
nullable: true
description: Type of wallet used for the transaction (if applicable)
required:
- transferDetailId
- transferId
- transactionId
- transactionNumber
- type
- category
- grossAmount
- chargeBackAmount
- returnedAmount
- refundAmount
- holdAmount
- releasedAmount
- billingFeesAmount
- thirdPartyPaidAmount
- adjustmentsAmount
- netTransferAmount
- splitFundingAmount
- billingFeesDetails
- ParentOrgName
- PaypointDbaname
- PaypointLegalname
- PaypointEntryname
- PaymentTransId
- ConnectorName
- ExternalProcessorInformation
- GatewayTransId
- OrderId
- Method
- BatchNumber
- BatchAmount
- PayorId
- PaymentData
- TransStatus
- PaypointId
- TotalAmount
- NetAmount
- FeeAmount
- SettlementStatus
- Operation
- ResponseData
- Source
- ScheduleReference
- OrgId
- RefundId
- ReturnedId
- ChargebackId
- RetrievalId
- TransAdditionalData
- invoiceData
- EntrypageId
- externalPaypointID
- IsValidatedACH
- TransactionTime
- Customer
- splitFundingInstructions
- CfeeTransactions
- TransactionEvents
- PendingFeeAmount
- RiskFlagged
- RiskFlaggedOn
- RiskStatus
- RiskReason
- RiskAction
- RiskActionCode
- DeviceId
- AchSecCode
- AchHolderType
- IpAddress
- IsSameDayACH
- WalletType
QueryBatchesDetailResponse:
title: QueryBatchesDetailResponse
type: object
description: Response body for queries about batch details.
properties:
Records:
type: array
items:
$ref: '#/components/schemas/BatchDetailResponseRecord'
Summary:
$ref: '#/components/schemas/BatchDetailResponseSummary'
required:
- Records
- Summary
BatchDetailResponseRecord:
title: BatchDetailResponseRecord
type: object
properties:
Id:
type: integer
Method:
type: string
WalletType:
type: string
nullable: true
SettledAmount:
type: number
format: double
Type:
type: string
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
BatchAmount:
type: number
format: double
PaymentTransId:
type: string
PaymentTransStatus:
type: integer
ScheduleReference:
type: integer
GatewayTransId:
type: string
OrderId:
$ref: '#/components/schemas/OrderId'
TransMethod:
type: string
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
Operation:
$ref: '#/components/schemas/Operation'
Category:
$ref: '#/components/schemas/Category'
Source:
$ref: '#/components/schemas/Source'
nullable: true
Status:
type: integer
TransactionTime:
$ref: '#/components/schemas/TransactionTime'
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
nullable: true
SettlementDate:
type: string
format: date-time
PaymentSettlementStatus:
type: integer
BatchStatus:
type: integer
DepositDate:
$ref: '#/components/schemas/DepositDate'
ExpectedDepositDate:
$ref: '#/components/schemas/ExpectedDepositDate'
MaskedAccount:
$ref: '#/components/schemas/Maskedaccount'
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
ResponseData:
$ref: '#/components/schemas/QueryResponseData'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
ParentOrgId:
type: integer
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
DeviceId:
$ref: '#/components/schemas/Device'
nullable: true
RetrievalId:
$ref: '#/components/schemas/RetrievalId'
ChargebackId:
$ref: '#/components/schemas/ChargebackId'
AchHolderType:
$ref: '#/components/schemas/AchHolderType'
AchSecCode:
$ref: '#/components/schemas/AchSecCode'
ConnectorName:
type: string
EntrypageId:
$ref: '#/components/schemas/EntrypageId'
FeeAmount:
$ref: '#/components/schemas/FeeAmount'
OrgId:
$ref: '#/components/schemas/Orgid'
PayorId:
$ref: '#/components/schemas/PayorId'
PaypointId:
$ref: '#/components/schemas/PaypointId'
PendingFeeAmount:
$ref: '#/components/schemas/PendingFeeAmount'
nullable: true
RefundId:
$ref: '#/components/schemas/RefundId'
ReturnedId:
$ref: '#/components/schemas/ReturnedId'
splitFundingInstructions:
$ref: '#/components/schemas/SplitFunding'
nullable: true
TotalAmount:
type: number
format: double
CfeeTransactions:
type: array
items:
$ref: '#/components/schemas/QueryCFeeTransaction'
invoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
TransactionEvents:
type: array
items:
$ref: '#/components/schemas/QueryTransactionEvents'
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
isHold:
type: integer
required:
- Id
- Method
- WalletType
- SettledAmount
- Type
- BatchNumber
- BatchAmount
- PaymentTransId
- PaymentTransStatus
- ScheduleReference
- GatewayTransId
- OrderId
- TransMethod
- PaymentData
- Operation
- Category
- Source
- Status
- TransactionTime
- Customer
- SettlementDate
- PaymentSettlementStatus
- BatchStatus
- DepositDate
- ExpectedDepositDate
- MaskedAccount
- CreatedAt
- PaypointLegalname
- ResponseData
- PaypointDbaname
- ParentOrgName
- ParentOrgId
- PaypointEntryname
- DeviceId
- RetrievalId
- ChargebackId
- AchHolderType
- AchSecCode
- ConnectorName
- EntrypageId
- FeeAmount
- OrgId
- PayorId
- PaypointId
- RefundId
- ReturnedId
- TotalAmount
- CfeeTransactions
- invoiceData
- TransactionEvents
- externalPaypointID
- isHold
BatchDetailResponseSummary:
title: BatchDetailResponseSummary
type: object
properties:
serviceFees:
type: number
format: double
transferAmount:
type: number
format: double
refunds:
type: number
format: double
heldAmount:
type: number
format: double
totalRecords:
$ref: '#/components/schemas/Totalrecords'
totalAmount:
type: number
format: double
totalNetAmount:
type: number
format: double
totalPages:
$ref: '#/components/schemas/Totalpages'
pageSize:
$ref: '#/components/schemas/Pagesize'
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
required:
- serviceFees
- transferAmount
- refunds
- heldAmount
- totalRecords
- totalAmount
- totalNetAmount
- totalPages
- pageSize
- pageidentifier
QueryBatchesResponse:
title: QueryBatchesResponse
type: object
description: Response body for queries about batches.
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryBatchesResponseRecordsItem'
Summary:
$ref: '#/components/schemas/BatchSummary'
required:
- Records
- Summary
QueryBatchesResponseRecordsItem:
title: QueryBatchesResponseRecordsItem
type: object
properties:
IdBatch:
type: integer
nullable: true
description: The batch ID.
BatchNumber:
$ref: '#/components/schemas/BatchNumber'
nullable: true
TransferIdentifier:
$ref: '#/components/schemas/TransferIdentifier'
nullable: true
EventsData:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: Events associated with the batch.
ConnectorName:
type: string
nullable: true
description: ''
BatchDate:
type: string
format: date-time
nullable: true
description: The batch date.
BatchAmount:
type: number
format: double
nullable: true
description: The amount of the batch.
BatchFeesAmount:
type: number
format: double
nullable: true
description: The total of fees in the batch.
BatchAuthAmount:
type: number
format: double
nullable: true
description: ''
BatchReleasedAmount:
type: number
format: double
nullable: true
description: Previously held funds that have been released after a risk review.
BatchHoldAmount:
type: number
format: double
nullable: true
description: >-
The total amount of the batch that's being held for fraud or risk
concerns.
BatchReturnedAmount:
type: number
format: double
nullable: true
description: Total amount of ACH returns deducted from batch.
BatchRefundAmount:
type: number
format: double
nullable: true
description: The total amount of refunds deducted from batch.
BatchSplitAmount:
type: number
format: double
nullable: true
description: >-
Total of split transactions that included split funding instructions
at the time of authorization.
BatchStatus:
type: integer
description: >-
The batch status. See [Batch
Status](/developers/references/money-in-statuses#batch-status) for
more.
BatchRecords:
type: integer
description: The number of records in the batch.
PaypointId:
$ref: '#/components/schemas/PaypointId'
nullable: true
PaypointName:
$ref: '#/components/schemas/PaypointName'
nullable: true
PaypointDba:
$ref: '#/components/schemas/Dbaname'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
description: The entrypoint's parent org.
ParentOrgId:
type: integer
description: The parent organization ID.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
EntryName:
$ref: '#/components/schemas/Entrypointfield'
BankName:
type: string
nullable: true
description: The bank name.
BatchType:
type: integer
nullable: true
description: The batch type.
Method:
type: string
nullable: true
description: The payment method used.
ExpectedDepositDate:
$ref: '#/components/schemas/ExpectedDepositDate'
nullable: true
DepositDate:
$ref: '#/components/schemas/DepositDate'
nullable: true
TransferDate:
type: string
format: date-time
nullable: true
description: The batch transfer date.
Transfer:
$ref: '#/components/schemas/QueryBatchesTransfer'
nullable: true
description: Transfer details for the batch.
required:
- IdBatch
- BatchNumber
- TransferIdentifier
- EventsData
- ConnectorName
- BatchDate
- BatchAmount
- BatchFeesAmount
- BatchAuthAmount
- BatchReleasedAmount
- BatchHoldAmount
- BatchReturnedAmount
- BatchRefundAmount
- BatchSplitAmount
- BatchStatus
- BatchRecords
- PaypointId
- PaypointName
- PaypointDba
- ParentOrgName
- ParentOrgId
- externalPaypointID
- EntryName
- BankName
- BatchType
- Method
- ExpectedDepositDate
- DepositDate
- TransferDate
- Transfer
QueryBatchesTransfer:
title: QueryBatchesTransfer
type: object
description: Transfer details within a batch response.
properties:
TransferId:
type: integer
nullable: true
description: The transfer ID.
TransferDate:
type: string
format: date-time
nullable: true
description: The transfer date.
Processor:
type: string
nullable: true
description: The processor used for the transfer.
TransferStatus:
type: integer
nullable: true
description: The transfer status.
GrossAmount:
type: number
format: double
nullable: true
description: The gross amount of the transfer.
ChargeBackAmount:
type: number
format: double
nullable: true
description: The chargeback amount.
ReturnedAmount:
type: number
format: double
nullable: true
description: The returned amount.
RefundAmount:
type: number
format: double
nullable: true
description: The refund amount.
HoldAmount:
type: number
format: double
nullable: true
description: The amount being held.
ReleasedAmount:
type: number
format: double
nullable: true
description: The amount that has been released.
BillingFeesAmount:
type: number
format: double
nullable: true
description: The billing fees amount.
ThirdPartyPaidAmount:
type: number
format: double
nullable: true
description: The third party paid amount.
AdjustmentsAmount:
type: number
format: double
nullable: true
description: The adjustments amount.
NetFundedAmount:
type: number
format: double
nullable: true
description: The net funded amount.
required:
- TransferId
- TransferDate
- Processor
- TransferStatus
- GrossAmount
- ChargeBackAmount
- ReturnedAmount
- RefundAmount
- HoldAmount
- ReleasedAmount
- BillingFeesAmount
- ThirdPartyPaidAmount
- AdjustmentsAmount
- NetFundedAmount
TransferOutQueryResponse:
title: TransferOutQueryResponse
type: object
description: Response body for queries about outbound transfers.
properties:
Summary:
$ref: '#/components/schemas/TransferOutSummary'
description: Summary information about the transfers.
Records:
type: array
items:
$ref: '#/components/schemas/TransferOutRecord'
description: List of outbound transfer records.
required:
- Summary
- Records
TransferOutSummary:
title: TransferOutSummary
type: object
description: Summary information for outbound transfer queries.
properties:
totalPages:
type: integer
nullable: true
description: Number of pages in the response.
totalRecords:
type: integer
nullable: true
description: Number of records in the response.
pageSize:
type: integer
nullable: true
description: Number of records per page.
required:
- totalPages
- totalRecords
- pageSize
TransferOutBankAccount:
title: TransferOutBankAccount
type: object
description: Bank account information for an outbound transfer.
properties:
accountNumber:
type: string
nullable: true
description: The masked bank account number.
routingNumber:
type: string
nullable: true
description: The bank routing number.
bankName:
type: string
nullable: true
description: The bank name.
required:
- accountNumber
- routingNumber
- bankName
TransferOutEventData:
title: TransferOutEventData
type: object
description: Event data associated with an outbound transfer.
properties:
description:
type: string
nullable: true
description: Description of the event.
eventTime:
type: string
nullable: true
description: The time the event occurred.
refData:
type: string
nullable: true
description: Reference data for the event.
extraData:
nullable: true
description: >-
Additional event data, which may contain detailed transaction
information.
source:
type: string
nullable: true
description: The source of the event.
required:
- description
- eventTime
- refData
- extraData
- source
TransferOutMessageProperties:
title: TransferOutMessageProperties
type: object
description: Properties associated with a transfer message.
properties:
originalTransferStatus:
type: string
nullable: true
description: The original status of the transfer before the message.
currentTransferStatus:
type: string
nullable: true
description: The current status of the transfer after the message.
required:
- originalTransferStatus
- currentTransferStatus
TransferOutMessage:
title: TransferOutMessage
type: object
description: A message associated with an outbound transfer.
properties:
Id:
type: integer
nullable: true
description: Unique identifier for the message.
RoomId:
type: integer
nullable: true
description: The ID of the room where the message was sent.
UserId:
type: integer
nullable: true
description: The ID of the user who sent the message.
UserName:
type: string
nullable: true
description: The name of the user who sent the message.
Content:
type: string
nullable: true
description: The content of the message.
CreatedAt:
type: string
nullable: true
description: The time the message was created.
MessageType:
type: integer
nullable: true
description: The type of message.
MessageProperties:
$ref: '#/components/schemas/TransferOutMessageProperties'
nullable: true
description: Additional properties for the message.
required:
- Id
- RoomId
- UserId
- UserName
- Content
- CreatedAt
- MessageType
- MessageProperties
TransferOutRecord:
title: TransferOutRecord
type: object
description: A record representing an outbound transfer.
properties:
transferId:
type: integer
nullable: true
description: Unique identifier for the transfer.
paypointId:
type: integer
nullable: true
description: The ID of the paypoint associated with the transfer.
batchNumber:
type: string
nullable: true
description: The batch number for the transfer.
batchCurrency:
type: string
nullable: true
description: The currency of the batch.
batchRecords:
type: integer
nullable: true
description: The number of records in the batch.
transferIdentifier:
type: string
nullable: true
description: An identifier for the transfer.
batchId:
type: integer
nullable: true
description: The ID of the batch.
batchNetAmount:
type: number
format: double
nullable: true
description: The net amount of the batch.
batchStatus:
type: integer
nullable: true
description: The status of the batch.
paypointEntryName:
type: string
nullable: true
description: The entry name for the paypoint.
paypointLegalName:
type: string
nullable: true
description: The legal name of the paypoint.
paypointDbaName:
type: string
nullable: true
description: The DBA name of the paypoint.
paypointLogo:
type: string
nullable: true
description: URL to the paypoint's logo.
parentOrgName:
type: string
nullable: true
description: The name of the parent organization.
parentOrgId:
type: integer
nullable: true
description: The ID of the parent organization.
parentOrgLogo:
type: string
nullable: true
description: URL to the parent organization's logo.
parentOrgEntryName:
type: string
nullable: true
description: The entry name for the parent organization.
externalPaypointID:
type: string
nullable: true
description: External identifier for the paypoint.
bankAccount:
$ref: '#/components/schemas/TransferOutBankAccount'
nullable: true
description: Bank account information for the transfer.
transferDate:
type: string
format: date-time
nullable: true
description: The date of the transfer.
processor:
type: string
nullable: true
description: The processor used for the transfer.
transferStatus:
type: integer
nullable: true
description: The status of the transfer.
grossAmount:
type: number
format: double
nullable: true
description: The gross amount of the transfer.
chargeBackAmount:
type: number
format: double
nullable: true
description: The chargeback amount deducted from the transfer.
returnedAmount:
type: number
format: double
nullable: true
description: The returned amount deducted from the transfer.
holdAmount:
type: number
format: double
nullable: true
description: The amount being held.
releasedAmount:
type: number
format: double
nullable: true
description: The amount that has been released.
billingFeesAmount:
type: number
format: double
nullable: true
description: The billing fees amount.
thirdPartyPaidAmount:
type: number
format: double
nullable: true
description: The third party paid amount.
adjustmentsAmount:
type: number
format: double
nullable: true
description: The adjustments amount.
netTransferAmount:
type: number
format: double
nullable: true
description: The net transfer amount after all deductions.
splitAmount:
type: number
format: double
nullable: true
description: The split funding amount.
eventsData:
type: array
items:
$ref: '#/components/schemas/TransferOutEventData'
nullable: true
description: List of events associated with the transfer.
messages:
type: array
items:
$ref: '#/components/schemas/TransferOutMessage'
nullable: true
description: List of messages associated with the transfer.
required:
- transferId
- paypointId
- batchNumber
- batchCurrency
- batchRecords
- transferIdentifier
- batchId
- batchNetAmount
- batchStatus
- paypointEntryName
- paypointLegalName
- paypointDbaName
- paypointLogo
- parentOrgName
- parentOrgId
- parentOrgLogo
- parentOrgEntryName
- externalPaypointID
- bankAccount
- transferDate
- processor
- transferStatus
- grossAmount
- chargeBackAmount
- returnedAmount
- holdAmount
- releasedAmount
- billingFeesAmount
- thirdPartyPaidAmount
- adjustmentsAmount
- netTransferAmount
- splitAmount
- eventsData
- messages
TransferOutDetailQueryResponse:
title: TransferOutDetailQueryResponse
type: object
description: Response body for queries about outbound transfer details.
properties:
Summary:
$ref: '#/components/schemas/QueryTransferSummary'
description: Summary information about the transfer details.
Records:
type: array
items:
$ref: '#/components/schemas/TransferOutDetailRecord'
description: List of outbound transfer detail records.
required:
- Summary
- Records
TransferOutDetailVendorBillingData:
title: TransferOutDetailVendorBillingData
type: object
description: Billing data for a vendor.
properties:
id:
type: integer
nullable: true
description: Unique identifier for the billing data.
accountId:
type: string
nullable: true
description: The account ID.
nickname:
type: string
nullable: true
description: A nickname for the account.
bankName:
type: string
nullable: true
description: The name of the bank.
routingAccount:
type: string
nullable: true
description: The routing number.
accountNumber:
type: string
nullable: true
description: The account number.
typeAccount:
type: string
nullable: true
description: The type of account.
bankAccountHolderName:
type: string
nullable: true
description: The name of the account holder.
bankAccountHolderType:
type: string
nullable: true
description: The type of account holder.
bankAccountFunction:
type: integer
nullable: true
description: The function of the bank account.
verified:
type: boolean
nullable: true
description: Whether the account is verified.
status:
type: integer
nullable: true
description: The status of the billing data.
services:
type: array
items: {}
nullable: true
description: Services associated with the billing data.
default:
type: boolean
nullable: true
description: Whether this is the default billing data.
country:
type: string
nullable: true
description: The country of the bank account.
required:
- id
- accountId
- nickname
- bankName
- routingAccount
- accountNumber
- typeAccount
- bankAccountHolderName
- bankAccountHolderType
- bankAccountFunction
- verified
- status
- services
- default
- country
TransferOutDetailVendor:
title: TransferOutDetailVendor
type: object
description: Vendor information for an outbound transfer detail.
properties:
VendorNumber:
type: string
nullable: true
description: The vendor's unique number.
Name1:
type: string
nullable: true
description: Primary name of the vendor.
Name2:
type: string
nullable: true
description: Secondary name of the vendor.
EIN:
type: string
nullable: true
description: Employer Identification Number.
Phone:
type: string
nullable: true
description: Vendor's phone number.
Email:
type: string
nullable: true
description: Vendor's email address.
RemitEmail:
type: string
nullable: true
description: Email for remittance notifications.
Address1:
type: string
nullable: true
description: Primary address line.
Address2:
type: string
nullable: true
description: Secondary address line.
City:
type: string
nullable: true
description: City of the vendor.
State:
type: string
nullable: true
description: State of the vendor.
Zip:
type: string
nullable: true
description: ZIP code of the vendor.
Country:
type: string
nullable: true
description: Country of the vendor.
Mcc:
type: string
nullable: true
description: Merchant Category Code.
LocationCode:
type: string
nullable: true
description: Location code for the vendor.
Contacts:
type: array
items:
$ref: '#/components/schemas/ContactsResponse'
nullable: true
description: List of contacts for the vendor.
BillingData:
$ref: '#/components/schemas/TransferOutDetailVendorBillingData'
nullable: true
description: Billing data for the vendor.
PaymentMethod:
type: string
nullable: true
description: Preferred payment method.
VendorStatus:
type: integer
nullable: true
description: Status of the vendor.
VendorId:
type: integer
nullable: true
description: Unique identifier for the vendor.
EnrollmentStatus:
type: integer
nullable: true
description: Enrollment status of the vendor.
Summary:
type: string
nullable: true
description: Summary information about the vendor.
PaypointLegalname:
type: string
nullable: true
description: Legal name of the paypoint.
PaypointId:
type: integer
nullable: true
description: ID of the paypoint.
PaypointDbaname:
type: string
nullable: true
description: DBA name of the paypoint.
PaypointEntryname:
type: string
nullable: true
description: Entry name of the paypoint.
ParentOrgName:
type: string
nullable: true
description: Name of the parent organization.
ParentOrgId:
type: integer
nullable: true
description: ID of the parent organization.
CreatedDate:
type: string
nullable: true
description: Date the vendor was created.
LastUpdated:
type: string
nullable: true
description: Date the vendor was last updated.
remitAddress1:
type: string
nullable: true
description: Primary remittance address line.
remitAddress2:
type: string
nullable: true
description: Secondary remittance address line.
remitCity:
type: string
nullable: true
description: Remittance city.
remitState:
type: string
nullable: true
description: Remittance state.
remitZip:
type: string
nullable: true
description: Remittance ZIP code.
remitCountry:
type: string
nullable: true
description: Remittance country.
payeeName1:
type: string
nullable: true
description: Primary payee name.
payeeName2:
type: string
nullable: true
description: Secondary payee name.
customField1:
type: string
nullable: true
description: Custom field 1.
customField2:
type: string
nullable: true
description: Custom field 2.
customerVendorAccount:
type: string
nullable: true
description: Customer vendor account number.
InternalReferenceId:
type: integer
nullable: true
description: Internal reference ID.
additionalData:
type: object
additionalProperties: true
nullable: true
description: Additional data for the vendor.
externalPaypointID:
type: string
nullable: true
description: External paypoint ID.
StoredMethods:
type: array
items: {}
nullable: true
description: Stored payment methods for the vendor.
required:
- VendorNumber
- Name1
- Name2
- EIN
- Phone
- Email
- RemitEmail
- Address1
- Address2
- City
- State
- Zip
- Country
- Mcc
- LocationCode
- Contacts
- BillingData
- PaymentMethod
- VendorStatus
- VendorId
- EnrollmentStatus
- Summary
- PaypointLegalname
- PaypointId
- PaypointDbaname
- PaypointEntryname
- ParentOrgName
- ParentOrgId
- CreatedDate
- LastUpdated
- remitAddress1
- remitAddress2
- remitCity
- remitState
- remitZip
- remitCountry
- payeeName1
- payeeName2
- customField1
- customField2
- customerVendorAccount
- InternalReferenceId
- additionalData
- externalPaypointID
- StoredMethods
TransferOutDetailPaymentData:
title: TransferOutDetailPaymentData
type: object
description: Payment data for an outbound transfer detail.
properties:
MaskedAccount:
type: string
nullable: true
description: Masked account number.
AccountType:
type: string
nullable: true
description: Type of account.
AccountExp:
type: string
nullable: true
description: Account expiration date.
AccountZip:
type: string
nullable: true
description: ZIP code associated with the account.
HolderName:
type: string
nullable: true
description: Name of the account holder.
StoredId:
type: string
nullable: true
description: ID of the stored payment method.
Initiator:
type: string
nullable: true
description: Initiator of the payment.
StoredMethodUsageType:
type: string
nullable: true
description: Usage type for stored method.
Sequence:
type: string
nullable: true
description: Sequence number.
orderDescription:
type: string
nullable: true
description: Description of the order.
cloudSignatureData:
type: string
nullable: true
description: Cloud signature data.
cloudSignatureFormat:
type: string
nullable: true
description: Format of cloud signature.
paymentDetails:
nullable: true
description: Additional payment details.
payorData:
type: string
nullable: true
description: Data about the payor.
accountId:
type: string
nullable: true
description: Account ID.
bankAccount:
type: string
nullable: true
description: Bank account information.
gatewayConnector:
type: string
nullable: true
description: Gateway connector used.
binData:
nullable: true
description: BIN data for the card.
required:
- MaskedAccount
- AccountType
- AccountExp
- AccountZip
- HolderName
- StoredId
- Initiator
- StoredMethodUsageType
- Sequence
- orderDescription
- cloudSignatureData
- cloudSignatureFormat
- paymentDetails
- payorData
- accountId
- bankAccount
- gatewayConnector
- binData
TransferOutDetailCheckData:
title: TransferOutDetailCheckData
type: object
description: Check data for an outbound transfer detail.
properties:
CheckNumber:
type: string
nullable: true
description: The check number.
CheckData:
type: string
nullable: true
description: Additional check data.
required:
- CheckNumber
- CheckData
TransferOutDetailBillAttachment:
title: TransferOutDetailBillAttachment
type: object
description: Attachment for a bill.
properties:
ftype:
type: string
nullable: true
description: File type.
filename:
type: string
nullable: true
description: File name.
fileDescriptor:
type: string
nullable: true
description: File descriptor.
furl:
type: string
nullable: true
description: File URL.
fContent:
type: string
nullable: true
description: File content.
required:
- ftype
- filename
- fileDescriptor
- furl
- fContent
TransferOutDetailBill:
title: TransferOutDetailBill
type: object
description: Bill information for an outbound transfer detail.
properties:
billId:
type: integer
nullable: true
description: Unique identifier for the bill.
LotNumber:
type: string
nullable: true
description: Lot number.
AccountingField1:
type: string
nullable: true
description: Accounting field 1.
AccountingField2:
type: string
nullable: true
description: Accounting field 2.
Terms:
type: string
nullable: true
description: Payment terms.
AdditionalData:
type: object
additionalProperties: true
nullable: true
description: Additional data for the bill.
attachments:
type: array
items:
$ref: '#/components/schemas/TransferOutDetailBillAttachment'
nullable: true
description: Attachments for the bill.
invoiceNumber:
type: string
nullable: true
description: Invoice number.
netAmount:
type: string
nullable: true
description: Net amount of the bill.
invoiceDate:
type: string
nullable: true
description: Date of the invoice.
dueDate:
type: string
nullable: true
description: Due date for the bill.
comments:
type: string
nullable: true
description: Comments on the bill.
identifier:
type: string
nullable: true
description: Identifier for the bill.
discount:
type: number
format: double
nullable: true
description: Discount applied.
totalAmount:
type: number
format: double
nullable: true
description: Total amount of the bill.
required:
- billId
- LotNumber
- AccountingField1
- AccountingField2
- Terms
- AdditionalData
- attachments
- invoiceNumber
- netAmount
- invoiceDate
- dueDate
- comments
- identifier
- discount
- totalAmount
TransferOutDetailEvent:
title: TransferOutDetailEvent
type: object
description: Event data for an outbound transfer detail.
properties:
TransEvent:
type: string
nullable: true
description: Description of the transaction event.
EventData:
type: string
nullable: true
description: Additional event data.
EventTime:
type: string
nullable: true
description: Time the event occurred.
required:
- TransEvent
- EventData
- EventTime
TransferOutDetailRecord:
title: TransferOutDetailRecord
type: object
description: A record representing an outbound transfer detail.
properties:
transferDetailId:
type: integer
nullable: true
description: Unique identifier for the transfer detail.
transferId:
type: integer
nullable: true
description: The ID of the transfer this detail belongs to.
transactionId:
type: string
nullable: true
description: The transaction ID in Payabli's system.
IdOut:
type: integer
nullable: true
description: The outbound transaction ID.
method:
type: string
nullable: true
description: Payment method used.
type:
type: string
nullable: true
description: The transaction type (credit or debit).
category:
type: string
nullable: true
description: Category of the transaction detail.
grossAmount:
type: number
format: double
nullable: true
description: The gross amount of the transaction.
returnedAmount:
type: number
format: double
nullable: true
description: Amount returned.
refundAmount:
type: number
format: double
nullable: true
description: Amount refunded.
holdAmount:
type: number
format: double
nullable: true
description: Amount being held.
releasedAmount:
type: number
format: double
nullable: true
description: Amount released.
billingFeesAmount:
type: number
format: double
nullable: true
description: Billing fees amount.
adjustmentsAmount:
type: number
format: double
nullable: true
description: Adjustments amount.
netTransferAmount:
type: number
format: double
nullable: true
description: Net transfer amount after deductions.
billingFeesDetails:
type: array
items:
$ref: '#/components/schemas/BillingFeeDetail'
nullable: true
description: Detailed breakdown of billing fees.
CreatedAt:
type: string
nullable: true
description: Date and time the record was created.
Comments:
type: string
nullable: true
description: Comments on the transfer detail.
Vendor:
$ref: '#/components/schemas/TransferOutDetailVendor'
nullable: true
description: Vendor information.
PaypointDbaname:
type: string
nullable: true
description: DBA name of the paypoint.
PaypointLegalname:
type: string
nullable: true
description: Legal name of the paypoint.
PaypointId:
type: integer
nullable: true
description: ID of the paypoint.
Status:
type: integer
nullable: true
description: Status of the transfer detail.
PaymentId:
type: string
nullable: true
description: Payment ID.
TransId:
type: string
nullable: true
description: Transaction ID.
TransStatus:
type: integer
nullable: true
description: Transaction status.
TransStatusDetail:
type: string
nullable: true
description: Detailed transaction status.
TransStatusName:
type: string
nullable: true
description: Name of the transaction status.
TransStatusCategory:
type: string
nullable: true
description: Category of the transaction status.
LastUpdated:
type: string
nullable: true
description: Date and time the record was last updated.
TotalAmount:
type: number
format: double
nullable: true
description: Total amount of the transaction.
NetAmount:
type: number
format: double
nullable: true
description: Net amount of the transaction.
FeeAmount:
type: number
format: double
nullable: true
description: Fee amount for the transaction.
Source:
type: string
nullable: true
description: Source of the transaction.
ParentOrgName:
type: string
nullable: true
description: Name of the parent organization.
ParentOrgId:
type: integer
nullable: true
description: ID of the parent organization.
BatchNumber:
type: string
nullable: true
description: Batch number for the transfer.
PaymentStatus:
type: string
nullable: true
description: Status of the payment.
PaymentMethod:
type: string
nullable: true
description: Payment method used.
CardToken:
type: string
nullable: true
description: Token for the card used.
CheckNumber:
type: string
nullable: true
description: Check number if paid by check.
CheckData:
$ref: '#/components/schemas/TransferOutDetailCheckData'
nullable: true
description: Check data if paid by check.
PaymentData:
$ref: '#/components/schemas/TransferOutDetailPaymentData'
nullable: true
description: Payment data for the transaction.
Bills:
type: array
items:
$ref: '#/components/schemas/TransferOutDetailBill'
nullable: true
description: Bills associated with the transfer.
Events:
type: array
items:
$ref: '#/components/schemas/TransferOutDetailEvent'
nullable: true
description: Events associated with the transfer.
externalPaypointID:
type: string
nullable: true
description: External paypoint ID.
EntryName:
type: string
nullable: true
description: Entry name for the paypoint.
Gateway:
type: string
nullable: true
description: Gateway used for the transaction.
BatchId:
type: integer
nullable: true
description: ID of the batch.
HasVcardTransactions:
type: boolean
nullable: true
description: Whether the transfer has virtual card transactions.
IsSameDayACH:
type: boolean
nullable: true
description: Whether this is a same-day ACH transaction.
ScheduleId:
type: integer
nullable: true
description: ID of the schedule if applicable.
SettlementStatus:
type: string
nullable: true
description: Settlement status.
SettlementStatusName:
type: string
nullable: true
description: Name of the settlement status.
SettlementDate:
type: string
nullable: true
description: Date of settlement.
RiskFlagged:
type: boolean
nullable: true
description: Whether the transaction was flagged for risk.
RiskFlaggedOn:
type: string
nullable: true
description: Date and time the transaction was flagged.
RiskStatus:
type: string
nullable: true
description: Risk status of the transaction.
RiskReason:
type: string
nullable: true
description: Reason for the risk flag.
RiskAction:
type: string
nullable: true
description: Action taken for risk.
RiskActionCode:
type: integer
nullable: true
description: Code for the risk action.
PayoutProgram:
type: string
nullable: true
description: Payout program used.
AchTraceNumber:
type: string
nullable: true
description: ACH trace number.
required:
- transferDetailId
- transferId
- transactionId
- IdOut
- method
- type
- category
- grossAmount
- returnedAmount
- refundAmount
- holdAmount
- releasedAmount
- billingFeesAmount
- adjustmentsAmount
- netTransferAmount
- billingFeesDetails
- CreatedAt
- Comments
- Vendor
- PaypointDbaname
- PaypointLegalname
- PaypointId
- Status
- PaymentId
- TransId
- TransStatus
- TransStatusDetail
- TransStatusName
- TransStatusCategory
- LastUpdated
- TotalAmount
- NetAmount
- FeeAmount
- Source
- ParentOrgName
- ParentOrgId
- BatchNumber
- PaymentStatus
- PaymentMethod
- CardToken
- CheckNumber
- CheckData
- PaymentData
- Bills
- Events
- externalPaypointID
- EntryName
- Gateway
- BatchId
- HasVcardTransactions
- IsSameDayACH
- ScheduleId
- SettlementStatus
- SettlementStatusName
- SettlementDate
- RiskFlagged
- RiskFlaggedOn
- RiskStatus
- RiskReason
- RiskAction
- RiskActionCode
- PayoutProgram
- AchTraceNumber
V2ResponseCode:
title: V2ResponseCode
type: string
description: >-
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 result. See [Pay In unified response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
V2ResponseReason:
title: V2ResponseReason
type: string
description: Human-readable reason corresponding to the response code.
V2ResponseExplanation:
title: V2ResponseExplanation
type: string
description: Detailed description of the response code.
V2ResponseAction:
title: V2ResponseAction
type: string
description: Recommended resolution approach or next steps based on the response.
V2TransactionResponseWrapper:
title: V2TransactionResponseWrapper
type: object
description: >-
Standard response wrapper for v2 Money In transaction endpoints. All v2
transaction endpoints return responses in this format with consistent
`code`, `reason`, `explanation`, and `action` fields. The `data` field
contains transaction details.
properties:
code:
$ref: '#/components/schemas/V2ResponseCode'
reason:
$ref: '#/components/schemas/V2ResponseReason'
explanation:
$ref: '#/components/schemas/V2ResponseExplanation'
action:
$ref: '#/components/schemas/V2ResponseAction'
data:
$ref: '#/components/schemas/V2TransactionDetails'
token:
type: string
nullable: true
description: >-
Pagination token (equivalent to `pageIdentifier` in v1 APIs).
Returns `null` when pagination is not applicable.
required:
- code
- reason
- explanation
- action
- data
- token
V2DeclinedTransactionResponseWrapper:
title: V2DeclinedTransactionResponseWrapper
type: object
description: >-
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 responses use this format with unified response
codes starting with 'D'. The `data` field contains transaction details.
properties:
code:
$ref: '#/components/schemas/V2ResponseCode'
reason:
$ref: '#/components/schemas/V2ResponseReason'
explanation:
$ref: '#/components/schemas/V2ResponseExplanation'
action:
$ref: '#/components/schemas/V2ResponseAction'
data:
$ref: '#/components/schemas/V2TransactionDetails'
token:
type: string
nullable: true
description: >-
Pagination token (equivalent to `pageIdentifier` in v1 APIs).
Returns `null` when pagination is not applicable.
required:
- code
- reason
- explanation
- action
- data
- token
V2BadRequestErrorDetail:
title: V2BadRequestErrorDetail
type: object
description: Individual field error detail for bad request responses.
properties:
message:
type: string
description: Description of the validation error.
suggestion:
type: string
description: Suggested action to fix the error.
required:
- message
- suggestion
V2BadRequestError:
title: V2BadRequestError
type: object
description: >-
Bad request error response (HTTP 400) returned when request validation
fails. Follows RFC 7807 Problem Details format with additional
Payabli-specific fields.
properties:
type:
type: string
description: >-
A URI reference that identifies the problem type. Points to
human-readable documentation for this error type.
title:
type: string
description: Always "Bad Request" for 400 errors.
status:
type: integer
description: HTTP status code, always 400 for bad requests.
detail:
type: string
description: Short description of the error.
instance:
type: string
description: Request URL that caused the error.
code:
type: string
description: >-
Payabli's unified response code for validation errors. Starts with
'E'. See [Pay In unified response codes
reference](/guides/pay-in-unified-response-codes-reference) for more
information.
errors:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/V2BadRequestErrorDetail'
description: >-
Dictionary of field-specific validation errors. Keys are field paths
(e.g., "paymentMethod.cardnumber") and values are arrays of error
details.
token:
type: string
nullable: true
description: >-
Pagination token (equivalent to pageIdentifier in v1 APIs). Usually
null for errors.
required:
- type
- title
- status
- detail
- instance
- code
- errors
- token
V2InternalServerError:
title: V2InternalServerError
type: object
description: >-
Internal server error response (HTTP 500) returned when an unexpected
error occurs. Follows RFC 7807 Problem Details format.
properties:
title:
type: string
description: Always "Internal Server Error" for 500 errors.
status:
type: integer
description: HTTP status code, always 500 for internal errors.
detail:
type: string
description: Additional details about the internal error.
instance:
type: string
description: Request URL that caused the error.
required:
- title
- status
- detail
- instance
V2TransactionDetailResponseData:
title: V2TransactionDetailResponseData
type: object
description: Response data from payment processor
properties:
resultCode:
$ref: '#/components/schemas/ResultCodev2'
resultCodeText:
$ref: '#/components/schemas/ResultCodeText'
response:
type: string
nullable: true
responsetext:
$ref: '#/components/schemas/Resulttext'
authcode:
$ref: '#/components/schemas/Authcode'
nullable: true
transactionid:
type: string
description: >-
Unique identifier for the transaction assigned by the payment
processor.
avsresponse:
$ref: '#/components/schemas/AvsResponse'
nullable: true
avsresponse_text:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
cvvresponse:
$ref: '#/components/schemas/CvvResponse'
nullable: true
cvvresponse_text:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
orderid:
$ref: '#/components/schemas/OrderId'
nullable: true
type:
type: string
nullable: true
response_code:
type: string
description: Processor-specific response code.
response_code_text:
type: string
description: Description of the response code.
customer_vault_id:
$ref: '#/components/schemas/CustomerVaultId'
nullable: true
emv_auth_response_data:
$ref: '#/components/schemas/EmvAuthResponseData'
nullable: true
required:
- resultCode
- resultCodeText
- response
- responsetext
- authcode
- transactionid
- avsresponse
- avsresponse_text
- cvvresponse
- cvvresponse_text
- orderid
- type
- response_code
- response_code_text
- customer_vault_id
- emv_auth_response_data
V2TransactionDetails:
title: V2TransactionDetails
type: object
description: >-
Complete transaction details returned by v2 Money In endpoints. This
matches the structure of the transaction details previously returned by
the v1 details endpoint.
properties:
parentOrgName:
$ref: '#/components/schemas/OrgParentName'
paypointDbaname:
$ref: '#/components/schemas/Dbaname'
paypointLegalname:
$ref: '#/components/schemas/Legalname'
paypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
paymentTransId:
type: string
description: Unique transaction identifier.
connectorName:
type: string
description: Name of the payment connector used.
externalProcessorInformation:
$ref: '#/components/schemas/ExternalProcessorInformation'
gatewayTransId:
type: string
description: Gateway transaction identifier.
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
method:
type: string
description: Payment method used for the transaction.
batchNumber:
$ref: '#/components/schemas/BatchNumber'
batchAmount:
type: number
format: double
description: Total amount in the batch.
payorId:
$ref: '#/components/schemas/PayorId'
paymentData:
$ref: '#/components/schemas/TransactionDetailPaymentData'
transStatus:
$ref: '#/components/schemas/TransStatus'
paypointId:
$ref: '#/components/schemas/PaypointId'
totalAmount:
type: number
format: double
description: Total transaction amount including fees.
netAmount:
type: number
format: double
description: Net transaction amount excluding fees.
feeAmount:
$ref: '#/components/schemas/FeeAmount'
settlementStatus:
$ref: '#/components/schemas/SettlementStatus'
operation:
$ref: '#/components/schemas/Operation'
responseData:
$ref: '#/components/schemas/V2TransactionDetailResponseData'
source:
$ref: '#/components/schemas/Source'
scheduleReference:
type: integer
format: int64
description: Reference to associated payment schedule if applicable.
orgId:
$ref: '#/components/schemas/Orgid'
refundId:
$ref: '#/components/schemas/RefundId'
returnedId:
$ref: '#/components/schemas/ReturnedId'
chargebackId:
$ref: '#/components/schemas/ChargebackId'
retrievalId:
$ref: '#/components/schemas/RetrievalId'
transAdditionalData:
nullable: true
invoiceData:
$ref: '#/components/schemas/TransactionDetailInvoiceData'
entrypageId:
$ref: '#/components/schemas/EntrypageId'
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
isValidatedACH:
type: boolean
description: Indicates if ACH account was validated in real-time.
transactionTime:
type: string
description: Timestamp when transaction was created.
customer:
$ref: '#/components/schemas/TransactionDetailCustomer'
splitFundingInstructions:
$ref: '#/components/schemas/SplitFunding'
nullable: true
cfeeTransactions:
type: array
items:
$ref: '#/components/schemas/QueryCFeeTransaction'
transactionEvents:
type: array
items:
$ref: '#/components/schemas/TransactionDetailEvent'
pendingFeeAmount:
$ref: '#/components/schemas/PendingFeeAmount'
nullable: true
riskFlagged:
$ref: '#/components/schemas/RiskFlagged'
nullable: true
riskFlaggedOn:
$ref: '#/components/schemas/RiskFlaggedOn'
nullable: true
riskStatus:
$ref: '#/components/schemas/RiskStatus'
riskReason:
$ref: '#/components/schemas/RiskReason'
riskAction:
$ref: '#/components/schemas/RiskAction'
riskActionCode:
$ref: '#/components/schemas/RiskActionCode'
nullable: true
deviceId:
$ref: '#/components/schemas/Device'
achSecCode:
$ref: '#/components/schemas/AchSecCode'
achHolderType:
$ref: '#/components/schemas/AchHolderType'
ipAddress:
$ref: '#/components/schemas/IpAddress'
isSameDayACH:
type: boolean
description: Indicates if ACH transaction uses same-day processing.
walletType:
type: string
nullable: true
description: Digital wallet type if applicable.
required:
- parentOrgName
- paypointDbaname
- paypointLegalname
- paypointEntryname
- paymentTransId
- connectorName
- externalProcessorInformation
- gatewayTransId
- orderId
- method
- batchNumber
- batchAmount
- payorId
- paymentData
- transStatus
- paypointId
- totalAmount
- netAmount
- feeAmount
- settlementStatus
- operation
- responseData
- source
- scheduleReference
- orgId
- refundId
- returnedId
- chargebackId
- retrievalId
- transAdditionalData
- invoiceData
- entrypageId
- externalPaypointID
- isValidatedACH
- transactionTime
- customer
- splitFundingInstructions
- cfeeTransactions
- transactionEvents
- riskStatus
- riskReason
- riskAction
- deviceId
- achSecCode
- achHolderType
- ipAddress
- isSameDayACH
- walletType
EditBillResponse:
title: EditBillResponse
type: object
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
$ref: '#/components/schemas/RoomIdNotInUse'
nullable: true
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
type: integer
nullable: true
description: >-
If `isSuccess` = true, this contains the bill identifier. If
`isSuccess` = false, this contains the reason for the error.
required:
- responseText
GetBillResponse:
title: GetBillResponse
type: object
description: >-
A successful response returns a bill object with all its details. If the
bill isn't found, the response will contain an error message.
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
$ref: '#/components/schemas/RoomIdNotInUse'
nullable: true
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/BillResponseData'
nullable: true
required:
- responseText
BillResponseData:
title: BillResponseData
type: object
properties:
IdBill:
$ref: '#/components/schemas/BillId'
nullable: true
BillNumber:
type: string
nullable: true
description: Unique identifier for the bill.
NetAmount:
type: number
format: double
nullable: true
description: Net amount owed in bill.
Discount:
type: number
format: double
nullable: true
description: Bill discount amount.
TotalAmount:
type: number
format: double
nullable: true
description: Total amount for the bill.
BillDate:
type: string
format: date
nullable: true
description: 'Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY'
DueDate:
type: string
format: date
nullable: true
description: 'Due Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY'
Comments:
type: string
nullable: true
description: >-
Comments associated with the bill. For managed payables, the
character limit is 200. For on demand payouts, the characters limit
is 250.
BatchNumber:
type: string
nullable: true
description: The batch number that the bill belongs to.
BillItems:
$ref: '#/components/schemas/Billitems'
nullable: true
description: Array of `LineItems` contained in bill.
Mode:
type: integer
nullable: true
description: >-
Bill mode: value `0` for single/one-time bills, `1` for scheduled
bills.
PaymentMethod:
type: string
nullable: true
description: Payment method used for the bill.
PaymentId:
type: string
nullable: true
description: Payment ID associated with the bill.
AccountingField1:
$ref: '#/components/schemas/AccountingField'
nullable: true
AccountingField2:
$ref: '#/components/schemas/AccountingField'
nullable: true
Terms:
$ref: '#/components/schemas/Terms'
nullable: true
Source:
type: string
nullable: true
description: The source of the bill, such as "API" or "UI".
AdditionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
Vendor:
$ref: '#/components/schemas/VendorDataResponse'
nullable: true
Status:
$ref: '#/components/schemas/Billstatus'
nullable: true
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
EndDate:
type: string
format: date
nullable: true
description: End date for scheduled bills. Applied only in `Mode` = 1.
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
Frequency:
$ref: '#/components/schemas/Frequency'
nullable: true
description: Frequency for scheduled bills. Applied only in `Mode` = 1.
Transaction:
$ref: '#/components/schemas/TransactionOutQueryRecord'
nullable: true
description: MoneyOut transaction associated to the bill
billEvents:
$ref: '#/components/schemas/BillEvents'
nullable: true
billApprovals:
$ref: '#/components/schemas/BillApprovals'
nullable: true
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
ParentOrgId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
paylinkId:
$ref: '#/components/schemas/PaylinkId'
nullable: true
DocumentsRef:
$ref: '#/components/schemas/DocumentsRef'
nullable: true
description: Object with the attached documents.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
LotNumber:
type: string
nullable: true
description: Lot number of the bill.
EntityID:
$ref: '#/components/schemas/EntityId'
nullable: true
required:
- BillDate
- DueDate
- EndDate
ModifyApprovalBillResponse:
title: ModifyApprovalBillResponse
type: object
properties:
responseData:
type: integer
nullable: true
description: >-
If `isSuccess` = true, this contains the bill identifier. If
`isSuccess` = false, this contains the reason for the error.
allOf:
- $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
SetApprovedBillResponse:
title: SetApprovedBillResponse
type: object
properties:
responseData:
type: integer
nullable: true
description: >-
If `isSuccess` = true, this contains the bill identifier. If
`isSuccess` = false, this contains the reason for the error.
allOf:
- $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
BillOutData:
title: BillOutData
type: object
properties:
accountingField1:
$ref: '#/components/schemas/AccountingField'
nullable: true
accountingField2:
$ref: '#/components/schemas/AccountingField'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataString'
nullable: true
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
description: >-
An array of bill images. Attachments aren't required, but we
strongly recommend including them. Including a bill image can make
payouts smoother and prevent delays. You can include either the
Base64-encoded file content, or you can include an fURL to a public
file. The maximum file size for image uploads is 30 MB.
billDate:
type: string
format: date
nullable: true
description: 'Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
billItems:
$ref: '#/components/schemas/Billitems'
nullable: true
billNumber:
type: string
nullable: true
description: Unique identifier for the bill. Required when adding a bill.
comments:
$ref: '#/components/schemas/Comments'
nullable: true
discount:
type: number
format: double
nullable: true
description: Discount amount applied to the bill.
dueDate:
type: string
format: date
nullable: true
description: 'Due date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
endDate:
type: string
format: date
nullable: true
description: >-
End Date for scheduled bills. Applied only in `Mode` = 1. Accepted
formats: YYYY-MM-DD, MM/DD/YYYY
frequency:
$ref: '#/components/schemas/Frequency'
nullable: true
description: Frequency for scheduled bills. Applied only in `Mode` = 1.
lotNumber:
type: string
nullable: true
description: Lot number associated with the bill.
mode:
type: integer
nullable: true
description: 'Bill mode: value `0` for one-time bills, `1` for scheduled bills.'
netAmount:
type: number
format: double
nullable: true
description: Net Amount owed in bill. Required when adding a bill.
scheduledOptions:
$ref: '#/components/schemas/BillOutDataScheduledOptions'
nullable: true
description: Options for scheduled bills.
status:
$ref: '#/components/schemas/Billstatus'
nullable: true
terms:
$ref: '#/components/schemas/Terms'
nullable: true
totalAmount:
type: number
format: double
nullable: true
description: Total amount of the bill.
vendor:
$ref: '#/components/schemas/VendorData'
nullable: true
description: >-
The vendor associated with the bill. Although you can create a
vendor in a create bill request, Payabli recommends creating a
vendor separately and passing a valid `vendorNumber` here. At
minimum, the `vendorNumber` is required.
BillOutDataScheduledOptions:
title: BillOutDataScheduledOptions
type: object
properties:
storedMethodId:
type: string
nullable: true
description: The ID of the stored payment method to use for the bill.
BillResponse:
title: BillResponse
type: object
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
$ref: '#/components/schemas/RoomIdNotInUse'
nullable: true
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
description: >-
If `isSuccess` = true, this contains the bill identifier. If
`isSuccess` = false, this contains the reason for the error.
required:
- responseText
AddApplicationRequest:
title: AddApplicationRequest
oneOf:
- description: Fields for Pay In processing applications
$ref: '#/components/schemas/ApplicationDataPayIn'
- description: Fields for Managed Payout processing applications
$ref: '#/components/schemas/ApplicationDataManaged'
- description: Fields for On-Demand Payout processing applications
$ref: '#/components/schemas/ApplicationDataOdp'
- description: All fields for boarding applications
$ref: '#/components/schemas/ApplicationData'
AddResponseResponse:
title: AddResponseResponse
type: object
properties:
responseData:
type: integer
nullable: true
description: >-
If `isSuccess` = true, this contains the chargeback identifier. If
`isSuccess` = false, this contains the reason for the error.
allOf:
- $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
ChargebackQueryRecords:
title: ChargebackQueryRecords
type: object
properties:
Id:
type: integer
format: int64
description: Identifier of chargeback or return.
ChargebackDate:
type: string
format: date-time
description: Date of chargeback in format YYYY-MM-DD or MM/DD/YYYY.
CaseNumber:
type: string
description: Number of case assigned to the chargeback.
ReasonCode:
type: string
description: R code for returned ACH or custom code identifying the reason.
Reason:
type: string
description: Text describing the chargeback or ACH return reason.
ReferenceNumber:
type: string
description: Processor reference number to the chargeback.
LastFour:
type: string
description: >-
Last 4 digits of card or bank account involved in chargeback or
return.
AccountType:
$ref: '#/components/schemas/Accounttype'
Status:
type: integer
description: |-
Status for chargeback or ACH return
- 0: Open (chargebacks only)
- 1: Pending (chargebacks only)
- 2: Closed-Won (chargebacks only)
- 3: Closed-Lost (chargebacks only)
- 4: ACH Return (ACH only)
- 5: ACH Dispute, Not Authorized (ACH only)
Method:
type: string
description: 'Type of payment vehicle: **ach** or **card**.'
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
description: Timestamp when the register was created, in UTC.
ReplyBy:
$ref: '#/components/schemas/Replyby'
PaymentTransId:
type: string
description: ReferenceId of the transaction in Payabli.
ScheduleReference:
type: integer
format: int64
nullable: true
description: Reference to the subscription originating the transaction.
OrderId:
$ref: '#/components/schemas/OrderId'
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: Net amount in chargeback or ACH return.
TransactionTime:
$ref: '#/components/schemas/TransactionTime'
Customer:
$ref: '#/components/schemas/QueryTransactionPayorData'
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
description: The paypoint's legal name.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
description: The paypoint's DBA name.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
ParentOrgId:
type: integer
format: int64
description: The ID of the parent organization.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
description: The paypoint's entryname.
Responses:
type: array
items:
$ref: '#/components/schemas/ChargeBackResponse'
description: Chargeback response records.
Transaction:
$ref: '#/components/schemas/TransactionQueryRecords'
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
messages:
type: array
items:
$ref: '#/components/schemas/ChargebackMessage'
description: Messages related to the chargeback.
ServiceGroup:
type: string
description: Service group classification.
DisputeType:
type: string
description: Type of dispute classification.
ProcessorName:
type: string
description: Name of the payment processor.
required:
- Id
- ChargebackDate
- CaseNumber
- ReasonCode
- Reason
- ReferenceNumber
- LastFour
- AccountType
- Status
- Method
- CreatedAt
- ReplyBy
- PaymentTransId
- OrderId
- TransactionTime
- Customer
- PaymentData
- PaypointLegalname
- PaypointDbaname
- ParentOrgName
- ParentOrgId
- PaypointEntryname
- Responses
- Transaction
- messages
- ServiceGroup
- DisputeType
- ProcessorName
ChargebackMessage:
title: ChargebackMessage
type: object
properties:
Id:
type: integer
description: Message identifier.
RoomId:
type: integer
description: Room identifier for the message.
UserId:
type: integer
description: User identifier who sent the message.
UserName:
type: string
description: Name of the user who sent the message.
Content:
type: string
description: Content of the message.
CreatedAt:
type: string
format: date-time
description: Timestamp when the message was created.
MessageType:
type: integer
description: Type of message.
MessageProperties:
type: object
additionalProperties:
type: string
nullable: true
description: Additional properties of the message.
required:
- Id
- RoomId
- UserId
- UserName
- Content
- CreatedAt
- MessageType
ChargeBackResponse:
title: ChargeBackResponse
type: object
properties:
attachments:
$ref: '#/components/schemas/BoardingApplicationAttachments'
nullable: true
description: Object with attached files to response
contactEmail:
$ref: '#/components/schemas/Email'
nullable: true
description: Email of response submitter.
contactName:
type: string
nullable: true
description: Name of response submitter
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp when response was submitted, in UTC.
id:
type: integer
format: int64
nullable: true
description: Chargeback response identifier
notes:
type: string
nullable: true
description: Response notes
CheckCaptureRequest:
title: CheckCaptureRequest
type: object
description: Request model for check capture processing.
properties:
entryPoint:
$ref: '#/components/schemas/Entry'
frontImage:
type: string
description: >-
Base64-encoded image of the front of the check. Must be JPEG or PNG
format and less than 1MB. Image must show the entire check clearly
with no partial, blurry, or illegible portions.
rearImage:
type: string
description: >-
Base64-encoded image of the back of the check. Must be JPEG or PNG
format and less than 1MB. Image must show the entire check clearly
with no partial, blurry, or illegible portions.
checkAmount:
type: integer
description: >-
Check amount in cents (maximum 32-bit integer value). For example,
$125.50 is represented as 12550.
required:
- entryPoint
- frontImage
- rearImage
- checkAmount
CheckCaptureResponse:
title: CheckCaptureResponse
type: object
description: Response model for check capture processing.
properties:
id:
type: string
nullable: true
description: >-
Unique ID for the check capture, to be used with the
/api/MoneyIn/getpaid endpoint.
success:
type: boolean
description: Indicates whether the check processing was successful.
processDate:
type: string
description: The date and time when the check was processed (ISO 8601 format).
ocrMicr:
type: string
nullable: true
description: >-
The OCR-extracted MICR (Magnetic Ink Character Recognition) line
from the check.
ocrMicrStatus:
type: string
nullable: true
description: Status of the MICR extraction process.
ocrMicrConfidence:
type: string
nullable: true
description: Confidence score for the MICR extraction (0 to 100).
ocrAccountNumber:
type: string
nullable: true
description: The bank account number extracted from the check.
ocrRoutingNumber:
type: string
nullable: true
description: The bank routing number extracted from the check.
ocrCheckNumber:
type: string
nullable: true
description: The check number extracted from the check.
ocrCheckTranCode:
type: string
nullable: true
description: The transaction code extracted from the check.
ocrAmount:
type: string
nullable: true
description: The amount extracted via OCR from the check.
ocrAmountStatus:
type: string
nullable: true
description: Status of the amount extraction process.
ocrAmountConfidence:
type: string
nullable: true
description: Confidence score for the amount extraction (0 to 100).
amountDiscrepancyDetected:
type: boolean
description: >-
Flag indicating whether there's a discrepancy between the provided
amount and the OCR-detected amount.
endorsementDetected:
type: boolean
description: Flag indicating whether an endorsement was detected on the check.
errors:
type: array
items:
type: string
nullable: true
description: List of error messages that occurred during processing.
messages:
type: array
items:
type: string
nullable: true
description: List of informational messages about the processing.
carLarMatchConfidence:
type: string
nullable: true
description: >-
Confidence score for the match between Courtesy Amount Recognition
(CAR) and Legal Amount Recognition (LAR).
carLarMatchStatus:
type: string
nullable: true
description: Status of the CAR/LAR match.
frontImage:
type: string
nullable: true
description: Processed front image of the check (Base64-encoded).
rearImage:
type: string
nullable: true
description: Processed rear image of the check (Base64-encoded).
checkType:
type: number
format: double
description: |-
Identifier for the type of check.
Personal = 1
Business = 2
Only personal checks are supported for check capture.
referenceNumber:
type: string
nullable: true
description: Reference number for the transaction.
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
required:
- success
- processDate
- amountDiscrepancyDetected
- endorsementDetected
- checkType
AddDeviceResponse:
title: AddDeviceResponse
type: object
properties:
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseData:
type: string
nullable: true
description: |-
If `isSuccess` = true, this contains the device identifier.
If `isSuccess` = false, this contains the reason for the error.
allOf:
- $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
RemoveDeviceResponse:
title: RemoveDeviceResponse
type: object
properties:
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseData:
type: string
nullable: true
description: |-
If `isSuccess` = true, this contains the device identifier.
If `isSuccess` = false, this contains the reason for the error.
allOf:
- $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
ExportFormat1:
title: ExportFormat1
type: string
enum:
- csv
- xlsx
CreateGhostCardResponse:
title: CreateGhostCardResponse
type: object
description: Response for creating a ghost card.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/CreateGhostCardResponseData'
nullable: true
required:
- responseText
CreateGhostCardResponseData:
title: CreateGhostCardResponseData
type: object
properties:
ReferenceId:
type: string
nullable: true
description: >-
Card token for the ghost card. Use this value to reference the card
in subsequent operations (update, cancel, etc.).
ResultCode:
$ref: '#/components/schemas/ResultCode'
nullable: true
ResultText:
$ref: '#/components/schemas/Resulttext'
nullable: true
CardStatus:
title: CardStatus
type: string
enum:
- Active
- Inactive
- Cancelled
- Expired
description: >-
The status to set on the card. Not all transitions are valid: `Active`
can change to `Inactive`, `Cancelled`, or `Expired`. `Inactive` can
change to `Active`. `Expired` can change to `Active` (renews the card).
`Cancelled` is terminal and can't be changed.
InvoicePaidAmount:
title: InvoicePaidAmount
type: number
format: double
description: Amount partially paid to the invoice.
InvoiceId:
title: InvoiceId
type: integer
format: int64
description: Identifier of invoice.
InvoiceDataRequest:
title: InvoiceDataRequest
type: object
properties:
customerData:
$ref: '#/components/schemas/PayorDataRequest'
nullable: true
description: >-
Object describing the customer/payor. Required for POST requests.
Which fields are required depends on the paypoint's custom
identifier settings.
invoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
description: Object describing the invoice. Required for POST requests.
scheduledOptions:
$ref: '#/components/schemas/BillOptions'
nullable: true
description: Object with options for scheduled invoices.
GetInvoiceRecord:
title: GetInvoiceRecord
type: object
properties:
invoiceId:
$ref: '#/components/schemas/InvoiceId'
customerId:
$ref: '#/components/schemas/CustomerId'
paypointId:
$ref: '#/components/schemas/PaypointId'
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
invoiceDate:
type: string
format: date
nullable: true
invoiceDueDate:
type: string
format: date
nullable: true
invoiceSentDate:
type: string
format: date-time
nullable: true
invoiceEndDate:
type: string
format: date
nullable: true
lastPaymentDate:
type: string
format: date-time
nullable: true
createdAt:
$ref: '#/components/schemas/CreatedAt'
invoiceStatus:
$ref: '#/components/schemas/Invoicestatus'
invoiceType:
$ref: '#/components/schemas/InvoiceType'
frequency:
$ref: '#/components/schemas/Frequency'
paymentTerms:
$ref: '#/components/schemas/Terms'
termsConditions:
$ref: '#/components/schemas/TermsConditions'
nullable: true
notes:
type: string
nullable: true
tax:
$ref: '#/components/schemas/Tax'
nullable: true
discount:
$ref: '#/components/schemas/Discount'
nullable: true
invoiceAmount:
$ref: '#/components/schemas/InvoiceAmount'
invoicePaidAmount:
$ref: '#/components/schemas/InvoicePaidAmount'
freightAmount:
$ref: '#/components/schemas/FreightAmount'
nullable: true
dutyAmount:
$ref: '#/components/schemas/DutyAmount'
nullable: true
purchaseOrder:
$ref: '#/components/schemas/PurchaseOrder'
firstName:
type: string
nullable: true
description: First name of the recipient of the invoice.
lastName:
type: string
nullable: true
description: Last name of the recipient of the invoice.
company:
type: string
nullable: true
description: Company name of the recipient of the invoice.
shippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
shippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
shippingCity:
$ref: '#/components/schemas/Shippingcity'
shippingState:
$ref: '#/components/schemas/Shippingstate'
shippingZip:
$ref: '#/components/schemas/Shippingzip'
shippingFromZip:
$ref: '#/components/schemas/ShippingFromZip'
shippingCountry:
$ref: '#/components/schemas/Shippingcountry'
shippingEmail:
$ref: '#/components/schemas/Email'
shippingPhone:
type: string
summaryCommodityCode:
$ref: '#/components/schemas/SummaryCommodityCode'
items:
type: array
items:
$ref: '#/components/schemas/BillItem'
Customer:
$ref: '#/components/schemas/PayorDataResponse'
paylinkId:
$ref: '#/components/schemas/PaylinkId'
billEvents:
$ref: '#/components/schemas/BillEvents'
nullable: true
scheduledOptions:
$ref: '#/components/schemas/BillOptions'
PaypointLegalname:
type: string
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
AdditionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
DocumentsRef:
$ref: '#/components/schemas/DocumentsRef'
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
required:
- invoiceId
- customerId
- paypointId
- invoiceNumber
- invoiceDate
- invoiceDueDate
- invoiceSentDate
- invoiceEndDate
- lastPaymentDate
- createdAt
- invoiceStatus
- invoiceType
- frequency
- paymentTerms
- termsConditions
- notes
- invoiceAmount
- invoicePaidAmount
- purchaseOrder
- shippingAddress1
- shippingAddress2
- shippingCity
- shippingState
- shippingZip
- shippingFromZip
- shippingCountry
- shippingEmail
- shippingPhone
- summaryCommodityCode
- items
- Customer
- paylinkId
- scheduledOptions
- PaypointLegalname
- PaypointDbaname
- PaypointEntryname
- ParentOrgName
- DocumentsRef
QueryInvoiceResponse:
title: QueryInvoiceResponse
type: object
properties:
Records:
type: array
items:
$ref: '#/components/schemas/QueryInvoiceResponseRecordsItem'
Summary:
$ref: '#/components/schemas/QuerySummary'
required:
- Records
- Summary
QueryInvoiceResponseRecordsItem:
title: QueryInvoiceResponseRecordsItem
type: object
properties:
invoiceId:
$ref: '#/components/schemas/InvoiceId'
customerId:
$ref: '#/components/schemas/CustomerId'
paypointId:
$ref: '#/components/schemas/PaypointId'
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
invoiceDate:
type: string
format: date
nullable: true
description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
invoiceDueDate:
type: string
format: date
nullable: true
description: >-
Invoice due date in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
invoiceSentDate:
type: string
format: date
nullable: true
description: >-
Invoice sent date in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
invoiceEndDate:
type: string
format: date
nullable: true
description: The end date for a scheduled invoice cycle (`invoiceType` = 1).
lastPaymentDate:
type: string
format: date-time
nullable: true
description: Timestamp of last payment.
createdAt:
$ref: '#/components/schemas/CreatedAt'
invoiceStatus:
$ref: '#/components/schemas/Invoicestatus'
invoiceType:
$ref: '#/components/schemas/InvoiceType'
frequency:
$ref: '#/components/schemas/Frequency'
description: Frequency of scheduled invoice.
paymentTerms:
$ref: '#/components/schemas/Terms'
termsConditions:
$ref: '#/components/schemas/TermsConditions'
nullable: true
notes:
type: string
nullable: true
description: Invoice notes.
tax:
$ref: '#/components/schemas/Tax'
nullable: true
discount:
$ref: '#/components/schemas/Discount'
nullable: true
invoiceAmount:
$ref: '#/components/schemas/InvoiceAmount'
invoicePaidAmount:
$ref: '#/components/schemas/InvoicePaidAmount'
freightAmount:
$ref: '#/components/schemas/FreightAmount'
nullable: true
dutyAmount:
$ref: '#/components/schemas/DutyAmount'
nullable: true
purchaseOrder:
$ref: '#/components/schemas/PurchaseOrder'
nullable: true
firstName:
type: string
description: First name of the recipient of the invoice.
lastName:
type: string
description: Last name of the recipient of the invoice.
company:
type: string
nullable: true
description: Company name of the recipient of the invoice.
shippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
shippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
shippingCity:
$ref: '#/components/schemas/Shippingcity'
shippingState:
$ref: '#/components/schemas/Shippingstate'
shippingZip:
$ref: '#/components/schemas/Shippingzip'
shippingFromZip:
$ref: '#/components/schemas/ShippingFromZip'
shippingCountry:
$ref: '#/components/schemas/Shippingcountry'
shippingEmail:
$ref: '#/components/schemas/Email'
description: Shipping recipient's contact email address.
shippingPhone:
type: string
description: Recipient phone number.
summaryCommodityCode:
$ref: '#/components/schemas/SummaryCommodityCode'
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/BillItem'
description: Array of line items included in the invoice.
Customer:
$ref: '#/components/schemas/PayorDataResponse'
paylinkId:
type: string
billEvents:
$ref: '#/components/schemas/BillEvents'
nullable: true
scheduledOptions:
$ref: '#/components/schemas/BillOptions'
nullable: true
description: Object with options for scheduled invoices.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
description: Paypoint's legal name.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
description: Paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
description: Paypoint's entryname.
ParentOrgId:
$ref: '#/components/schemas/Orgid'
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
AdditionalData:
type: object
additionalProperties: true
nullable: true
description: >-
Custom list of key:value pairs. This field is used to store any data
related to the invoice or for your system.
DocumentsRef:
$ref: '#/components/schemas/DocumentsRef'
nullable: true
description: Object containing attachments associated to the invoice.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
required:
- invoiceId
- customerId
- paypointId
- invoiceNumber
- invoiceDate
- invoiceDueDate
- invoiceSentDate
- invoiceEndDate
- lastPaymentDate
- createdAt
- invoiceStatus
- invoiceType
- frequency
- paymentTerms
- termsConditions
- notes
- invoiceAmount
- invoicePaidAmount
- purchaseOrder
- firstName
- lastName
- company
- shippingAddress1
- shippingAddress2
- shippingCity
- shippingState
- shippingZip
- shippingFromZip
- shippingCountry
- shippingEmail
- shippingPhone
- summaryCommodityCode
- items
- Customer
- paylinkId
- scheduledOptions
- PaypointLegalname
- PaypointDbaname
- PaypointEntryname
- ParentOrgId
- ParentOrgName
- AdditionalData
- DocumentsRef
- externalPaypointID
- pageIdentifier
InvoiceResponseWithoutData:
title: InvoiceResponseWithoutData
type: object
description: Response schema for invoice operations.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseCode:
$ref: '#/components/schemas/Responsecode'
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
description: >-
If `isSuccess` = true, this contains the identifier of the invoice.
If `isSuccess` = false, this contains the reason for the failure.
responseText:
$ref: '#/components/schemas/ResponseText'
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
$ref: '#/components/schemas/RoomIdNotInUse'
required:
- isSuccess
- responseCode
- responseData
- responseText
- pageidentifier
- roomId
SendInvoiceResponse:
title: SendInvoiceResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- responseText
InvoiceNumberResponse:
title: InvoiceNumberResponse
type: object
description: >-
Response schema for operations for sending invoices or getting next
invoice number.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
type: string
description: >-
If `isSuccess` = true, this contains the next available invoice
number in the format defined by paypoint settings. If `isSuccess` =
false, this contains the reason for the error.
required:
- isSuccess
- responseText
- responseData
DeleteItemResponse:
title: DeleteItemResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- responseText
InvalidTransStatusErrorType:
title: InvalidTransStatusErrorType
type: object
properties:
responseText:
type: string
description: Error message describing the reason for the decline
required:
- responseText
ReceiptResponse:
title: ReceiptResponse
type: object
description: Response for SendReceipt endpoint.
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
CaptureResponse:
title: CaptureResponse
type: object
description: Response for MoneyIn/capture endpoint
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
$ref: '#/components/schemas/RoomIdNotInUse'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/CaptureResponseData'
required:
- responseCode
- pageIdentifier
- roomId
- isSuccess
- responseText
- responseData
CaptureResponseData:
title: CaptureResponseData
type: object
description: Response data for capture transactions
properties:
authCode:
$ref: '#/components/schemas/Authcode'
referenceId:
$ref: '#/components/schemas/Referenceidtrans'
resultCode:
$ref: '#/components/schemas/ResultCode'
resultText:
$ref: '#/components/schemas/Resulttext'
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
customerId:
$ref: '#/components/schemas/Customeridtrans'
nullable: true
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
required:
- authCode
- referenceId
- resultCode
- resultText
- avsResponseText
- cvvResponseText
- customerId
- methodReferenceId
PayabliAPIResponseGetPaid:
title: PayabliAPIResponseGetPaid
type: object
description: >-
General response for GetPaid endpoint supporting multiple payment
methods
properties:
responseText:
$ref: '#/components/schemas/ResponseText'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
type: string
nullable: true
responseData:
$ref: '#/components/schemas/GetPaidResponseData'
required:
- responseText
- isSuccess
- responseData
GetPaidResponseData:
title: GetPaidResponseData
type: object
description: Response data for GetPaid transactions
properties:
authCode:
$ref: '#/components/schemas/Authcode'
nullable: true
transactionDetails:
$ref: '#/components/schemas/TransactionDetailRecord'
nullable: true
description: >-
Details of the transaction. Present only if `includeDetails` query
parameter is set to `true` in the request.
referenceId:
$ref: '#/components/schemas/Referenceidtrans'
resultCode:
$ref: '#/components/schemas/ResultCode'
resultText:
$ref: '#/components/schemas/Resulttext'
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
customerId:
$ref: '#/components/schemas/Customeridtrans'
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
required:
- authCode
- referenceId
- resultCode
- resultText
- avsResponseText
- cvvResponseText
- customerId
TransRequestBody:
title: TransRequestBody
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
customerData:
$ref: '#/components/schemas/PayorDataRequest'
nullable: true
description: >-
Object describing the Customer/Payor. Which fields are required
depends on the paypoint's custom identifier settings.
entryPoint:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
invoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
description: Object describing an Invoice linked to the transaction.
ipaddress:
$ref: '#/components/schemas/IpAddress'
nullable: true
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
paymentDetails:
$ref: '#/components/schemas/PaymentDetail'
description: Object describing details of the payment. Required.
paymentMethod:
$ref: '#/components/schemas/PaymentMethod'
description: >-
Information about the payment method for the transaction. Required
and recommended fields for each payment method type are described in
each schema below.
source:
$ref: '#/components/schemas/Source'
nullable: true
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
subscriptionId:
$ref: '#/components/schemas/Subscriptionid'
nullable: true
required:
- paymentDetails
- paymentMethod
AuthResponse:
title: AuthResponse
type: object
description: Response for MoneyIn/authorize.
properties:
responseText:
$ref: '#/components/schemas/ResponseText'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseData:
$ref: '#/components/schemas/AuthResponseResponseData'
required:
- responseText
- isSuccess
- responseData
AuthResponseResponseData:
title: AuthResponseResponseData
type: object
properties:
authCode:
$ref: '#/components/schemas/Authcode'
referenceId:
$ref: '#/components/schemas/Referenceidtrans'
resultCode:
$ref: '#/components/schemas/ResultCode'
resultText:
$ref: '#/components/schemas/Resulttext'
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
customerId:
$ref: '#/components/schemas/Customeridtrans'
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
required:
- authCode
- referenceId
- resultCode
- resultText
- avsResponseText
- cvvResponseText
- customerId
ReverseResponse:
title: ReverseResponse
type: object
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
type: integer
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/ResponseDataRefunds'
required:
- responseCode
- roomId
- isSuccess
- responseText
- responseData
RefundResponse:
title: RefundResponse
type: object
properties:
responseText:
$ref: '#/components/schemas/ResponseText'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseData:
$ref: '#/components/schemas/ResponseDataRefunds'
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
required:
- responseText
- isSuccess
- responseData
RefundWithInstructionsResponse:
title: RefundWithInstructionsResponse
type: object
properties:
responseText:
$ref: '#/components/schemas/ResponseText'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseData:
$ref: '#/components/schemas/ResponseDataRefunds'
pageidentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
required:
- responseText
- isSuccess
- responseData
ResponseDataRefunds:
title: ResponseDataRefunds
type: object
properties:
authCode:
$ref: '#/components/schemas/Authcode'
expectedProcessingDateTime:
$ref: '#/components/schemas/ExpectedProcessingDateTime'
nullable: true
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
description: This field isn't applicable to refund operations.
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
description: This field isn't applicable to refund operations.
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
description: This field isn't applicable to refund operations.
referenceId:
$ref: '#/components/schemas/Referenceidtrans'
resultCode:
$ref: '#/components/schemas/ResultCode'
resultText:
type: string
description: Text description of the transaction result
required:
- authCode
- expectedProcessingDateTime
- customerId
- cvvResponseText
- methodReferenceId
- referenceId
- resultCode
- resultText
RequestCreditPaymentMethod:
title: RequestCreditPaymentMethod
type: object
description: Object describing the ACH payment method to use for transaction.
properties:
achAccount:
$ref: '#/components/schemas/Achaccount'
nullable: true
achAccountType:
$ref: '#/components/schemas/Achaccounttype'
nullable: true
achCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
achHolder:
$ref: '#/components/schemas/AchHolder'
nullable: true
description: Bank account holder.
achRouting:
$ref: '#/components/schemas/Achrouting'
nullable: true
method:
type: string
const: ach
description: Method to use for the transaction. Must be ACH.
required:
- method
RequestPaymentAuthorizePaymentMethod:
title: RequestPaymentAuthorizePaymentMethod
oneOf:
- description: Object describing a credit card payment method
$ref: '#/components/schemas/PayMethodCredit'
- description: Object describing a stored method payment method
$ref: '#/components/schemas/PayMethodStoredMethod'
- description: Object describing a cloud payment method
$ref: '#/components/schemas/PayMethodCloud'
description: Object describing payment method to use for transaction.
VoidResponse:
title: VoidResponse
type: object
description: Response for MoneyIn/void endpoint
properties:
responseCode:
$ref: '#/components/schemas/Responsecode'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
roomId:
$ref: '#/components/schemas/RoomIdNotInUse'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/VoidResponseData'
required:
- responseCode
- roomId
- isSuccess
- responseText
- responseData
VoidResponseData:
title: VoidResponseData
type: object
description: Response data for void transactions
properties:
authCode:
$ref: '#/components/schemas/Authcode'
referenceId:
$ref: '#/components/schemas/Referenceidtrans'
resultCode:
$ref: '#/components/schemas/ResultCode'
resultText:
$ref: '#/components/schemas/Resulttext'
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
customerId:
$ref: '#/components/schemas/Customeridtrans'
nullable: true
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
required:
- authCode
- referenceId
- resultCode
- resultText
ValidateResponse:
title: ValidateResponse
type: object
description: Response for card validation endpoint
properties:
responseText:
$ref: '#/components/schemas/ResponseText'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseData:
$ref: '#/components/schemas/ValidateResponseData'
required:
- responseText
- isSuccess
- responseData
ValidateResponseData:
title: ValidateResponseData
type: object
description: Response data for card validation
properties:
authCode:
$ref: '#/components/schemas/Authcode'
referenceId:
$ref: '#/components/schemas/Referenceidtrans'
resultCode:
$ref: '#/components/schemas/ResultCode'
resultText:
$ref: '#/components/schemas/Resulttext'
avsResponseText:
$ref: '#/components/schemas/AvsResponseText'
cvvResponseText:
$ref: '#/components/schemas/CvvResponseText'
customerId:
$ref: '#/components/schemas/Customeridtrans'
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
required:
- authCode
- referenceId
- resultCode
- resultText
- avsResponseText
- cvvResponseText
- customerId
RequestPaymentValidatePaymentMethod:
title: RequestPaymentValidatePaymentMethod
type: object
description: Object describing payment method to use for validation.
properties:
method:
$ref: '#/components/schemas/RequestPaymentValidatePaymentMethodMethod'
cardnumber:
$ref: '#/components/schemas/Cardnumber'
cardexp:
$ref: '#/components/schemas/Cardexp'
cardzip:
$ref: '#/components/schemas/Cardzip'
cardHolder:
$ref: '#/components/schemas/Cardholder'
required:
- method
- cardnumber
- cardexp
- cardzip
- cardHolder
RequestPaymentValidatePaymentMethodMethod:
title: RequestPaymentValidatePaymentMethodMethod
type: string
enum:
- card
- cloud
description: The card validation method.
CaptureRequest:
title: CaptureRequest
type: object
properties:
paymentDetails:
$ref: '#/components/schemas/CapturePaymentDetails'
required:
- paymentDetails
CapturePaymentDetails:
title: CapturePaymentDetails
type: object
properties:
totalAmount:
type: number
format: double
description: >-
Total amount to be captured, including the `serviceFee` amount. The
amount can't be greater the original
total amount of the transaction, and can't be more than 15% lower
than the original amount.
serviceFee:
type: number
format: double
nullable: true
description: Service fee to capture for the transaction.
required:
- totalAmount
TransactionDetailRecord:
title: TransactionDetailRecord
type: object
description: >-
Complete transaction details including payment information, customer
data, and processing metadata. This is returned when
includeDetails=true.
properties:
parentOrgName:
$ref: '#/components/schemas/OrgParentName'
paypointDbaname:
$ref: '#/components/schemas/Dbaname'
paypointLegalname:
$ref: '#/components/schemas/Legalname'
paypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
paymentTransId:
type: string
connectorName:
type: string
externalProcessorInformation:
$ref: '#/components/schemas/ExternalProcessorInformation'
gatewayTransId:
type: string
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
method:
$ref: '#/components/schemas/TransactionDetailRecordMethod'
batchNumber:
$ref: '#/components/schemas/BatchNumber'
batchAmount:
type: number
format: double
payorId:
$ref: '#/components/schemas/PayorId'
paymentData:
$ref: '#/components/schemas/TransactionDetailPaymentData'
transStatus:
$ref: '#/components/schemas/TransStatus'
paypointId:
$ref: '#/components/schemas/PaypointId'
totalAmount:
type: number
format: double
netAmount:
type: number
format: double
feeAmount:
$ref: '#/components/schemas/FeeAmount'
settlementStatus:
$ref: '#/components/schemas/SettlementStatus'
operation:
$ref: '#/components/schemas/Operation'
responseData:
$ref: '#/components/schemas/TransactionDetailResponseData'
source:
$ref: '#/components/schemas/Source'
scheduleReference:
type: integer
format: int64
orgId:
$ref: '#/components/schemas/Orgid'
refundId:
$ref: '#/components/schemas/RefundId'
returnedId:
$ref: '#/components/schemas/ReturnedId'
chargebackId:
$ref: '#/components/schemas/ChargebackId'
retrievalId:
$ref: '#/components/schemas/RetrievalId'
transAdditionalData:
nullable: true
invoiceData:
$ref: '#/components/schemas/TransactionDetailInvoiceData'
entrypageId:
$ref: '#/components/schemas/EntrypageId'
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
isValidatedACH:
type: boolean
transactionTime:
type: string
customer:
$ref: '#/components/schemas/TransactionDetailCustomer'
splitFundingInstructions:
$ref: '#/components/schemas/SplitFunding'
nullable: true
cfeeTransactions:
type: array
items:
$ref: '#/components/schemas/QueryCFeeTransaction'
transactionEvents:
type: array
items:
$ref: '#/components/schemas/TransactionDetailEvent'
pendingFeeAmount:
$ref: '#/components/schemas/PendingFeeAmount'
nullable: true
riskFlagged:
$ref: '#/components/schemas/RiskFlagged'
nullable: true
riskFlaggedOn:
$ref: '#/components/schemas/RiskFlaggedOn'
nullable: true
riskStatus:
$ref: '#/components/schemas/RiskStatus'
riskReason:
$ref: '#/components/schemas/RiskReason'
riskAction:
$ref: '#/components/schemas/RiskAction'
riskActionCode:
$ref: '#/components/schemas/RiskActionCode'
nullable: true
deviceId:
$ref: '#/components/schemas/Device'
achSecCode:
$ref: '#/components/schemas/AchSecCode'
achHolderType:
$ref: '#/components/schemas/AchHolderType'
ipAddress:
$ref: '#/components/schemas/IpAddress'
isSameDayACH:
type: boolean
walletType:
type: string
nullable: true
required:
- parentOrgName
- paypointDbaname
- paypointLegalname
- paypointEntryname
- paymentTransId
- connectorName
- externalProcessorInformation
- gatewayTransId
- orderId
- method
- batchNumber
- batchAmount
- payorId
- paymentData
- transStatus
- paypointId
- totalAmount
- netAmount
- feeAmount
- settlementStatus
- operation
- responseData
- source
- scheduleReference
- orgId
- refundId
- returnedId
- chargebackId
- retrievalId
- transAdditionalData
- invoiceData
- entrypageId
- externalPaypointID
- isValidatedACH
- transactionTime
- customer
- splitFundingInstructions
- cfeeTransactions
- transactionEvents
- riskStatus
- riskReason
- riskAction
- deviceId
- achSecCode
- achHolderType
- ipAddress
- isSameDayACH
- walletType
TransactionDetailRecordMethod:
title: TransactionDetailRecordMethod
type: string
enum:
- ach
- card
description: Payment method used for the transaction
TransactionDetailPaymentData:
title: TransactionDetailPaymentData
type: object
description: Payment method and transaction details
properties:
maskedAccount:
$ref: '#/components/schemas/Maskedaccount'
accountType:
$ref: '#/components/schemas/Accounttype'
accountExp:
$ref: '#/components/schemas/Accountexp'
nullable: true
holderName:
$ref: '#/components/schemas/Holdername'
storedId:
$ref: '#/components/schemas/Storedmethodid'
nullable: true
initiator:
$ref: '#/components/schemas/Initiator'
nullable: true
storedMethodUsageType:
$ref: '#/components/schemas/StoredMethodUsageType'
nullable: true
sequence:
$ref: '#/components/schemas/Sequence'
nullable: true
orderDescription:
$ref: '#/components/schemas/Orderdescription'
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
signatureData:
$ref: '#/components/schemas/Signaturedata'
nullable: true
binData:
$ref: '#/components/schemas/BinData'
nullable: true
paymentDetails:
$ref: '#/components/schemas/TransactionDetailPaymentDetails'
required:
- maskedAccount
- accountType
- accountExp
- holderName
- storedId
- initiator
- storedMethodUsageType
- sequence
- orderDescription
- accountId
- signatureData
- binData
- paymentDetails
TransactionDetailPaymentDetails:
title: TransactionDetailPaymentDetails
type: object
description: Detailed breakdown of payment amounts and identifiers
properties:
totalAmount:
type: number
format: double
serviceFee:
type: number
format: double
checkNumber:
type: string
nullable: true
checkImage:
nullable: true
checkUniqueId:
type: string
currency:
type: string
orderDescription:
$ref: '#/components/schemas/Orderdescription'
nullable: true
orderId:
$ref: '#/components/schemas/OrderId'
nullable: true
orderIdAlternative:
type: string
nullable: true
paymentDescription:
type: string
nullable: true
groupNumber:
type: string
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
payabliTransId:
type: string
nullable: true
unbundled:
nullable: true
categories:
type: array
items: {}
splitFunding:
type: array
items: {}
required:
- totalAmount
- serviceFee
- checkNumber
- checkImage
- checkUniqueId
- currency
- orderDescription
- orderId
- orderIdAlternative
- paymentDescription
- groupNumber
- source
- payabliTransId
- unbundled
- categories
- splitFunding
TransactionDetailResponseData:
title: TransactionDetailResponseData
type: object
description: Response data from payment processor
properties:
resultCode:
type: string
nullable: true
description: >-
Unified result code for the transaction. See [Pay In unified
response codes](/guides/pay-in-unified-response-codes-reference) for
more information.
resultCodeText:
type: string
nullable: true
description: >-
Description of the result code. See [Pay In unified response
codes](/guides/pay-in-unified-response-codes-reference) for more
information.
response:
type: string
nullable: true
responsetext:
$ref: '#/components/schemas/Resulttext'
authcode:
$ref: '#/components/schemas/Authcode'
nullable: true
transactionid:
type: string
avsresponse:
type: string
nullable: true
avsresponse_text:
$ref: '#/components/schemas/AvsResponseText'
nullable: true
cvvresponse:
type: string
nullable: true
cvvresponse_text:
$ref: '#/components/schemas/CvvResponseText'
nullable: true
orderid:
$ref: '#/components/schemas/OrderId'
nullable: true
type:
type: string
nullable: true
response_code:
type: string
response_code_text:
type: string
customer_vault_id:
type: string
nullable: true
emv_auth_response_data:
$ref: '#/components/schemas/EmvAuthResponseData'
nullable: true
required:
- response
- responsetext
- authcode
- transactionid
- avsresponse
- avsresponse_text
- cvvresponse
- cvvresponse_text
- orderid
- type
- response_code
- response_code_text
- customer_vault_id
- emv_auth_response_data
TransactionDetailInvoiceData:
title: TransactionDetailInvoiceData
type: object
description: Invoice information if transaction is associated with an invoice
properties:
invoiceNumber:
$ref: '#/components/schemas/InvoiceNumber'
nullable: true
invoiceDate:
type: string
format: date
nullable: true
invoiceDueDate:
type: string
format: date
nullable: true
invoiceEndDate:
type: string
format: date
nullable: true
invoiceStatus:
$ref: '#/components/schemas/Invoicestatus'
nullable: true
invoiceType:
$ref: '#/components/schemas/InvoiceType'
nullable: true
frequency:
$ref: '#/components/schemas/Frequency'
nullable: true
paymentTerms:
type: string
nullable: true
termsConditions:
$ref: '#/components/schemas/TermsConditions'
nullable: true
notes:
type: string
nullable: true
tax:
$ref: '#/components/schemas/Tax'
nullable: true
discount:
$ref: '#/components/schemas/Discount'
nullable: true
invoiceAmount:
$ref: '#/components/schemas/InvoiceAmount'
nullable: true
freightAmount:
$ref: '#/components/schemas/FreightAmount'
nullable: true
dutyAmount:
$ref: '#/components/schemas/DutyAmount'
nullable: true
purchaseOrder:
$ref: '#/components/schemas/PurchaseOrder'
nullable: true
firstName:
type: string
nullable: true
lastName:
type: string
nullable: true
company:
type: string
nullable: true
shippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
nullable: true
shippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
nullable: true
shippingCity:
$ref: '#/components/schemas/Shippingcity'
nullable: true
shippingState:
$ref: '#/components/schemas/Shippingstate'
nullable: true
shippingZip:
$ref: '#/components/schemas/Shippingzip'
nullable: true
shippingCountry:
$ref: '#/components/schemas/Shippingcountry'
nullable: true
shippingEmail:
$ref: '#/components/schemas/Email'
nullable: true
shippingPhone:
type: string
nullable: true
shippingFromZip:
$ref: '#/components/schemas/ShippingFromZip'
nullable: true
summaryCommodityCode:
$ref: '#/components/schemas/SummaryCommodityCode'
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/BillItem'
nullable: true
attachments:
$ref: '#/components/schemas/Attachments'
nullable: true
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
required:
- invoiceNumber
- invoiceDate
- invoiceDueDate
- invoiceEndDate
- invoiceStatus
- invoiceType
- frequency
- paymentTerms
- termsConditions
- notes
- tax
- discount
- invoiceAmount
- freightAmount
- dutyAmount
- purchaseOrder
- firstName
- lastName
- company
- shippingAddress1
- shippingAddress2
- shippingCity
- shippingState
- shippingZip
- shippingCountry
- shippingEmail
- shippingPhone
- shippingFromZip
- summaryCommodityCode
- items
- attachments
- additionalData
TransactionDetailCustomer:
title: TransactionDetailCustomer
type: object
description: Customer information associated with the transaction
properties:
identifiers:
$ref: '#/components/schemas/Identifierfields'
nullable: true
firstName:
type: string
lastName:
type: string
companyName:
type: string
billingAddress1:
$ref: '#/components/schemas/BillingAddressNullable'
billingAddress2:
$ref: '#/components/schemas/BillingAddressAddtlNullable'
billingCity:
$ref: '#/components/schemas/BillingCityNullable'
billingState:
$ref: '#/components/schemas/BillingStateNullable'
billingZip:
$ref: '#/components/schemas/BillingZip'
billingCountry:
$ref: '#/components/schemas/BillingCountryNullable'
billingPhone:
$ref: '#/components/schemas/PhoneNumber'
billingEmail:
$ref: '#/components/schemas/Email'
customerNumber:
$ref: '#/components/schemas/CustomerNumberNullable'
shippingAddress1:
$ref: '#/components/schemas/Shippingaddress'
shippingAddress2:
$ref: '#/components/schemas/Shippingaddressadditional'
shippingCity:
$ref: '#/components/schemas/Shippingcity'
shippingState:
$ref: '#/components/schemas/Shippingstate'
shippingZip:
$ref: '#/components/schemas/Shippingzip'
shippingCountry:
$ref: '#/components/schemas/Shippingcountry'
customerId:
$ref: '#/components/schemas/CustomerId'
customerStatus:
$ref: '#/components/schemas/CustomerStatus'
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
required:
- identifiers
- firstName
- lastName
- companyName
- billingAddress1
- billingAddress2
- billingCity
- billingState
- billingZip
- billingCountry
- billingPhone
- billingEmail
- customerNumber
- shippingAddress1
- shippingAddress2
- shippingCity
- shippingState
- shippingZip
- shippingCountry
- customerId
- customerStatus
- additionalData
TransactionDetailEvent:
title: TransactionDetailEvent
type: object
description: Event associated with transaction processing
properties:
transEvent:
type: string
eventData:
type: string
eventTime:
type: string
required:
- transEvent
- eventData
- eventTime
AddNotificationRequest:
title: AddNotificationRequest
oneOf:
- description: Create a standard webhook, email, or SMS notification.
$ref: '#/components/schemas/NotificationStandardRequest'
- description: Create an auto-generated report.
$ref: '#/components/schemas/NotificationReportRequest'
UpdateNotificationRequest:
title: UpdateNotificationRequest
oneOf:
- $ref: '#/components/schemas/NotificationStandardRequest'
- $ref: '#/components/schemas/NotificationReportRequest'
NotificationLog:
title: NotificationLog
type: object
properties:
id:
type: string
format: uuid
description: The unique identifier for the notification.
orgId:
type: integer
format: int64
nullable: true
description: The ID of the organization that the notification belongs to.
paypointId:
type: integer
format: int64
nullable: true
description: The ID of the paypoint that the notification is related to.
notificationEvent:
type: string
nullable: true
description: The event that triggered the notification.
target:
type: string
nullable: true
description: The target URL for the notification.
responseStatus:
type: string
nullable: true
description: The HTTP response status of the notification.
success:
type: boolean
description: Indicates whether the notification was successful.
jobData:
type: string
nullable: true
description: Contains the body of the notification.
createdDate:
type: string
format: date-time
description: The date and time when the notification was created.
successDate:
type: string
format: date-time
nullable: true
description: The date and time when the notification was successfully delivered.
lastFailedDate:
type: string
format: date-time
nullable: true
description: The date and time when the notification last failed.
isInProgress:
type: boolean
description: Indicates whether the notification is currently in progress.
required:
- id
- orgId
- paypointId
- notificationEvent
- target
- responseStatus
- success
- jobData
- createdDate
- successDate
- lastFailedDate
- isInProgress
NotificationLogDetail:
title: NotificationLogDetail
type: object
properties:
webHeaders:
type: array
items:
$ref: '#/components/schemas/StringStringKeyValuePair'
nullable: true
responseHeaders:
type: array
items:
$ref: '#/components/schemas/KeyValueArray'
nullable: true
responseContent:
type: string
nullable: true
allOf:
- $ref: '#/components/schemas/NotificationLog'
StringStringKeyValuePair:
title: StringStringKeyValuePair
type: object
properties:
key:
type: string
nullable: true
value:
type: string
nullable: true
KeyValueArray:
title: KeyValueArray
type: object
properties:
key:
type: string
nullable: true
value:
type: array
items:
type: string
nullable: true
NotificationLogSearchRequest:
title: NotificationLogSearchRequest
type: object
properties:
startDate:
type: string
format: date-time
description: The start date for the search.
endDate:
type: string
format: date-time
description: The end date for the search.
notificationEvent:
type: string
nullable: true
description: The type of notification event to filter by.
succeeded:
type: boolean
nullable: true
description: Indicates whether the notification was successful.
orgId:
type: integer
format: int64
nullable: true
description: The ID of the organization to filter by.
paypointId:
type: integer
format: int64
nullable: true
description: The ID of the paypoint to filter by.
required:
- startDate
- endDate
BulkRetryRequest:
title: BulkRetryRequest
type: array
items:
type: string
format: uuid
description: >-
A list of notification log IDs to retry. The maximum number of IDs that
can be retried in a single request is 50.
typeResult:
title: typeResult
type: string
description: >-
The type of object to create in Payabli. Accepted values are `bill` and
`invoice`.
PayabliApiResponseOCR:
title: PayabliApiResponseOCR
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseText:
$ref: '#/components/schemas/ResponseText'
responseCode:
$ref: '#/components/schemas/Responsecode'
responseData:
$ref: '#/components/schemas/OcrResponseData'
nullable: true
description: Details of the OCR processing result
required:
- isSuccess
- responseText
- responseCode
OcrResponseData:
title: OcrResponseData
type: object
properties:
resultData:
$ref: '#/components/schemas/OcrResultData'
nullable: true
FileContentImageOnly:
title: FileContentImageOnly
type: object
properties:
ftype:
$ref: '#/components/schemas/FileContentFtype'
nullable: true
filename:
type: string
nullable: true
description: The name of the file to be uploaded
furl:
type: string
nullable: true
description: Optional URL link to the file
fContent:
type: string
nullable: true
description: Base64-encoded file content
OcrVendorBillingData:
title: OcrVendorBillingData
type: object
properties:
id:
type: integer
nullable: true
bankName:
type: string
nullable: true
routingAccount:
type: string
nullable: true
accountNumber:
type: string
nullable: true
typeAccount:
type: string
nullable: true
bankAccountHolderName:
type: string
nullable: true
bankAccountHolderType:
type: string
nullable: true
bankAccountFunction:
type: integer
nullable: true
OcrVendorAdditionalData:
title: OcrVendorAdditionalData
type: object
properties:
web:
type: string
nullable: true
OcrVendor:
title: OcrVendor
type: object
properties:
vendorNumber:
type: string
nullable: true
name1:
type: string
nullable: true
name2:
type: string
nullable: true
ein:
type: string
nullable: true
phone:
type: string
nullable: true
email:
type: string
nullable: true
address1:
type: string
nullable: true
address2:
type: string
nullable: true
city:
type: string
nullable: true
state:
type: string
nullable: true
zip:
type: string
nullable: true
country:
type: string
nullable: true
mcc:
type: string
nullable: true
locationCode:
type: string
nullable: true
contacts:
type: array
items:
$ref: '#/components/schemas/Contacts'
nullable: true
billingData:
$ref: '#/components/schemas/OcrVendorBillingData'
nullable: true
paymentMethod:
type: string
nullable: true
vendorStatus:
type: integer
nullable: true
remitAddress1:
type: string
nullable: true
remitAddress2:
type: string
nullable: true
remitCity:
type: string
nullable: true
remitState:
type: string
nullable: true
remitZip:
type: string
nullable: true
remitCountry:
type: string
nullable: true
payeeName1:
type: string
nullable: true
payeeName2:
type: string
nullable: true
customerVendorAccount:
type: string
nullable: true
internalReferenceId:
type: integer
format: int64
nullable: true
customField1:
type: string
nullable: true
customField2:
type: string
nullable: true
additionalData:
$ref: '#/components/schemas/OcrVendorAdditionalData'
nullable: true
OcrBillItemAdditionalData:
title: OcrBillItemAdditionalData
type: object
properties:
category:
type: string
nullable: true
currency_code:
type: string
nullable: true
type:
type: string
nullable: true
reference_number:
type: string
nullable: true
OcrBillItem:
title: OcrBillItem
type: object
properties:
itemTotalAmount:
type: number
format: double
nullable: true
itemTaxAmount:
type: number
format: double
nullable: true
itemTaxRate:
type: number
format: double
nullable: true
itemProductCode:
type: string
nullable: true
itemProductName:
type: string
nullable: true
itemDescription:
type: string
nullable: true
itemCommodityCode:
type: string
nullable: true
itemUnitOfMeasure:
type: string
nullable: true
itemCost:
type: number
format: double
nullable: true
itemQty:
type: integer
nullable: true
itemMode:
type: integer
nullable: true
itemCategories:
type: array
items:
type: string
nullable: true
OcrAttachment:
title: OcrAttachment
type: object
properties:
ftype:
type: string
nullable: true
filename:
type: string
nullable: true
fileDescriptor:
type: string
nullable: true
furl:
type: string
nullable: true
fContent:
type: string
nullable: true
OcrResultData:
title: OcrResultData
type: object
properties:
billNumber:
type: string
nullable: true
netAmount:
type: number
format: double
nullable: true
billDate:
type: string
format: date-time
nullable: true
dueDate:
type: string
format: date-time
nullable: true
comments:
type: string
nullable: true
billItems:
type: array
items:
$ref: '#/components/schemas/OcrBillItem'
nullable: true
mode:
type: integer
nullable: true
accountingField1:
type: string
nullable: true
accountingField2:
type: string
nullable: true
additionalData:
$ref: '#/components/schemas/OcrBillItemAdditionalData'
nullable: true
vendor:
$ref: '#/components/schemas/OcrVendor'
nullable: true
endDate:
type: string
format: date-time
nullable: true
frequency:
type: string
nullable: true
terms:
type: string
nullable: true
status:
type: integer
nullable: true
lotNumber:
type: string
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/OcrAttachment'
nullable: true
AddOrganizationResponse:
title: AddOrganizationResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
description: Returns the organization ID.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
DeleteOrganizationResponse:
title: DeleteOrganizationResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
description: Returns the organization ID.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
EditOrganizationResponse:
title: EditOrganizationResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
nullable: true
description: Returns the organization ID.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseCode
- responseText
PaymentPageRequestBody:
title: PaymentPageRequestBody
type: object
properties:
contactUs:
$ref: '#/components/schemas/ContactElement'
nullable: true
description: ContactUs section of payment link page
invoices:
$ref: '#/components/schemas/InvoiceElement'
nullable: true
description: Invoices section of payment link page
logo:
$ref: '#/components/schemas/Element'
nullable: true
description: Logo section of payment link page
messageBeforePaying:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Message section of payment link page
notes:
$ref: '#/components/schemas/NoteElement'
nullable: true
description: Notes section of payment link page
page:
$ref: '#/components/schemas/PageElement'
nullable: true
description: Page header section of payment link page
paymentButton:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Payment button section of payment link page
paymentMethods:
$ref: '#/components/schemas/MethodElement'
nullable: true
description: Payment methods section of payment link page
payor:
$ref: '#/components/schemas/PayorElement'
nullable: true
description: Customer/Payor section of payment link page
review:
$ref: '#/components/schemas/HeaderElement'
nullable: true
description: Review section of payment link page
settings:
$ref: '#/components/schemas/PagelinkSetting'
nullable: true
description: Settings section of payment link page
PaymentPageRequestBodyOut:
title: PaymentPageRequestBodyOut
type: object
description: >-
Configuration for the Pay Out payment link page. Controls branding,
messaging, vendor fields, and which payout methods are offered to the
vendor.
properties:
contactUs:
$ref: '#/components/schemas/ContactElement'
nullable: true
description: ContactUs section of payment link page.
logo:
$ref: '#/components/schemas/Element'
nullable: true
description: Logo section of payment link page.
messageBeforePaying:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Message section of payment link page.
notes:
$ref: '#/components/schemas/NoteElement'
nullable: true
description: Notes section of payment link page.
page:
$ref: '#/components/schemas/PageElement'
nullable: true
description: Page header section of payment link page.
paymentButton:
$ref: '#/components/schemas/LabelElement'
nullable: true
description: Payment button section of payment link page.
paymentMethods:
$ref: '#/components/schemas/MethodElementOut'
nullable: true
description: >-
Payment methods section of payment link page. Use this to configure
which payout methods (ACH, vCard, check) are offered to the vendor.
review:
$ref: '#/components/schemas/HeaderElement'
nullable: true
description: Review section of payment link page.
bills:
$ref: '#/components/schemas/Element'
nullable: true
description: Bills section of payment link page.
settings:
$ref: '#/components/schemas/PagelinkSetting'
nullable: true
description: Settings section of payment link page.
PatchOutPaymentLinkRequest:
title: PatchOutPaymentLinkRequest
type: object
description: Request body for partially updating a Pay Out payment link.
properties:
billPageData:
$ref: '#/components/schemas/PaymentPageRequestBodyOut'
nullable: true
description: Updated payment link page configuration.
expirationDate:
type: string
nullable: true
description: >-
New expiration date for the payment link. Must be a future date. If
null and the link is expired, uses the default expiration from
settings. Updating the expiration date reactivates an expired
payment link to Active status.
status:
$ref: '#/components/schemas/PaymentLinkStatus'
nullable: true
description: Updated status for the payment link.
GetPayLinkFromIdResponse:
title: GetPayLinkFromIdResponse
type: object
properties:
responseData:
$ref: '#/components/schemas/GetPayLinkFromIdResponseResponseData'
nullable: true
allOf:
- $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
GetPayLinkFromIdResponseResponseData:
title: GetPayLinkFromIdResponseResponseData
type: object
properties: {}
allOf:
- $ref: '#/components/schemas/PayabliPages'
PayabliApiResponsePaymentLinks:
title: PayabliApiResponsePaymentLinks
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseData:
type: string
nullable: true
description: >-
If `isSuccess` = true, this contains the payment link identifier. If
`isSuccess` = false, this contains the reason of the error.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- responseText
AddPaymentMethodDomainRequestApplePay:
title: AddPaymentMethodDomainRequestApplePay
type: object
description: Apple Pay configuration information.
properties:
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
AddPaymentMethodDomainRequestGooglePay:
title: AddPaymentMethodDomainRequestGooglePay
type: object
description: Google Pay configuration information.
properties:
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
DeletePaymentMethodDomainResponse:
title: DeletePaymentMethodDomainResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
responseData:
$ref: '#/components/schemas/Responsedatanonobject'
description: The deleted domain's domain ID.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- pageIdentifier
- responseData
- responseText
ListPaymentMethodDomainsResponse:
title: ListPaymentMethodDomainsResponse
type: object
properties:
records:
type: array
items:
$ref: '#/components/schemas/PaymentMethodDomainApiResponse'
summary:
$ref: '#/components/schemas/QuerySummaryNoAmt'
required:
- records
- summary
UpdatePaymentMethodDomainRequestWallet:
title: UpdatePaymentMethodDomainRequestWallet
type: object
properties:
isEnabled:
$ref: '#/components/schemas/IsEnabled'
nullable: true
PayoutSetPause:
title: PayoutSetPause
type: boolean
description: >-
Flag indicating if the payout subscription is paused. When a payout
subscription is paused, no payouts are processed until it's unpaused,
and the next payment date isn't calculated automatically.
PayoutScheduleDetail:
title: PayoutScheduleDetail
type: object
properties:
startDate:
type: string
nullable: true
description: >-
Subscription start date in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY. This must be a future date.
endDate:
type: string
nullable: true
description: >-
Subscription end date in any of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY or the value `untilcancelled` to indicate a scheduled
payout with infinite cycle.
frequency:
$ref: '#/components/schemas/Frequency'
nullable: true
description: Frequency of the payout subscription.
PayoutSubscriptionRequestBody:
title: PayoutSubscriptionRequestBody
type: object
properties:
entryPoint:
$ref: '#/components/schemas/Entrypointfield'
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
accountId:
$ref: '#/components/schemas/AccountId'
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
setPause:
$ref: '#/components/schemas/PayoutSetPause'
nullable: true
paymentMethod:
$ref: '#/components/schemas/AuthorizePaymentMethod'
description: >-
Payment method for the payout subscription. Supports `ach`, `vcard`,
and `check`. The `managed` method isn't supported for payout
subscriptions.
paymentDetails:
$ref: '#/components/schemas/PayoutPaymentDetail'
nullable: true
description: Object describing details of the payout.
vendorData:
$ref: '#/components/schemas/RequestOutAuthorizeVendorData'
description: >-
Object identifying the vendor for this subscription. Only a
`vendorId` or `vendorNumber` is needed to link to an existing
vendor.
billData:
type: array
items:
$ref: '#/components/schemas/BillPayOutDataRequest'
nullable: true
description: >-
Array of bills associated with the payout subscription. If omitted
and `doNotCreateBills` isn't set to `true`, the system creates a
bill automatically.
scheduleDetails:
$ref: '#/components/schemas/PayoutScheduleDetail'
nullable: true
description: Object describing the schedule for the payout subscription.
required:
- entryPoint
- paymentMethod
- vendorData
PayoutPaymentDetail:
title: PayoutPaymentDetail
type: object
description: Payment details for payout subscriptions.
properties:
totalAmount:
type: number
format: double
description: >-
Total payout amount. If a service fee is included, this amount
should include the service fee.
serviceFee:
type: number
format: double
nullable: true
description: >-
Service fee to be deducted from the total amount. This amount must
be a number, percentages aren't accepted.
currency:
type: string
nullable: true
description: >-
Currency code ISO-4217. If no code is provided, the currency in the
paypoint setting is used. Default is `USD`.
checkNumber:
type: string
nullable: true
description: >-
A check number for the payout. Required when the payment method is
`check`.
orderDescription:
type: string
nullable: true
description: Description of the payout order.
orderId:
type: string
nullable: true
description: Order identifier associated with the payout.
orderIdAlternative:
type: string
nullable: true
description: Alternative order identifier.
paymentDescription:
type: string
nullable: true
description: Description of the payment.
settlementDescriptor:
type: string
nullable: true
description: Settlement descriptor for the payout.
groupNumber:
type: string
nullable: true
description: Group number for the payout.
source:
type: string
nullable: true
description: Source identifier for the payout.
payabliTransId:
type: string
nullable: true
description: Payabli transaction identifier.
unbundled:
type: boolean
nullable: true
description: >-
When `true`, each bill is processed as a separate payout. When
`false` or not provided, multiple bills are paid with a single
payout.
required:
- totalAmount
UpdatePayoutSubscriptionBody:
title: UpdatePayoutSubscriptionBody
type: object
properties:
setPause:
$ref: '#/components/schemas/PayoutSetPause'
nullable: true
paymentDetails:
$ref: '#/components/schemas/PayoutPaymentDetail'
nullable: true
description: Object describing details of the payout.
paymentMethod:
$ref: '#/components/schemas/AuthorizePaymentMethod'
nullable: true
scheduleDetails:
$ref: '#/components/schemas/PayoutScheduleDetail'
nullable: true
description: Object describing the schedule for the payout subscription.
AddPayoutSubscriptionResponse:
title: AddPayoutSubscriptionResponse
type: object
description: Success response
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
type: integer
description: The identifier of the newly created payout subscription.
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
description: >-
The identifier of the vendor associated with the payout
subscription.
required:
- responseText
- responseData
UpdatePayoutSubscriptionResponse:
title: UpdatePayoutSubscriptionResponse
type: object
description: Success response
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
type: string
nullable: true
description: >-
If `isSuccess` = true, this contains the payout subscription ID.
When the subscription is paused, it also includes a description (for
example, "42 paused").
If `isSuccess` = false, this contains the reason for the failure.
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
required:
- responseText
GetPayoutSubscriptionResponse:
title: GetPayoutSubscriptionResponse
type: object
description: Success response
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
responseData:
$ref: '#/components/schemas/PayoutSubscriptionQueryRecord'
nullable: true
description: The payout subscription record.
required:
- responseText
DeletePayoutSubscriptionResponse:
title: DeletePayoutSubscriptionResponse
type: object
description: Success response
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
type: string
nullable: true
description: >-
If `isSuccess` = true, this contains the identifier of the payout
subscription.
If `isSuccess` = false, this contains the reason for the failure.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
PayoutSubscriptionQueryRecord:
title: PayoutSubscriptionQueryRecord
type: object
properties:
idOutSubscription:
type: integer
format: int64
nullable: true
description: The payout subscription's ID.
status:
type: integer
nullable: true
description: |-
The payout subscription's status.
- 0: Paused
- 1: Active
events:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: Events associated with the payout subscription.
vendor:
$ref: '#/components/schemas/VendorQueryRecord'
nullable: true
billData:
type: array
items:
$ref: '#/components/schemas/BillPayOutData'
nullable: true
description: Bills associated with the payout subscription.
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
method:
type: string
nullable: true
description: The payout subscription's payment method.
paypointId:
$ref: '#/components/schemas/PaypointId'
nullable: true
totalAmount:
type: number
format: double
nullable: true
description: The payout subscription amount, including any fees.
netAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: The payout subscription amount, minus any fees.
feeAmount:
type: number
format: double
nullable: true
description: Fee applied to the payout subscription.
paymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
startDate:
type: string
format: date-time
nullable: true
description: The payout subscription start date.
endDate:
type: string
format: date-time
nullable: true
description: The payout subscription's end date.
nextDate:
type: string
format: date-time
nullable: true
description: The next date the payout subscription will be processed.
frequency:
type: string
nullable: true
description: The payout subscription's frequency.
totalCycles:
type: integer
nullable: true
description: The total number of cycles the payout subscription is set to run.
leftCycles:
type: integer
nullable: true
description: The number of cycles the payout subscription has left.
lastRun:
type: string
format: date-time
nullable: true
description: The last time the payout subscription was processed.
entrypageId:
$ref: '#/components/schemas/EntrypageId'
nullable: true
untilCancelled:
type: boolean
nullable: true
description: >-
When `true`, the payout subscription has no explicit end date and
runs until canceled.
lastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: The last date and time the payout subscription was updated.
createdAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp of when the payout subscription was created, in UTC.
paypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint's legal name.
paypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
paypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: The paypoint's entryname.
parentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
parentOrgId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
required:
- startDate
- endDate
- nextDate
- lastRun
PayoutSubscriptionQueryRecordPascal:
title: PayoutSubscriptionQueryRecordPascal
type: object
properties:
IdOutSubscription:
type: integer
format: int64
nullable: true
description: The payout subscription's ID.
Status:
type: integer
nullable: true
description: |-
The payout subscription's status.
- 0: Paused
- 1: Active
Events:
type: array
items:
$ref: '#/components/schemas/GeneralEvents'
nullable: true
description: Events associated with the payout subscription.
Vendor:
$ref: '#/components/schemas/VendorQueryRecord'
nullable: true
BillData:
type: array
items:
$ref: '#/components/schemas/BillPayOutData'
nullable: true
description: Bills associated with the payout subscription.
ExternalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
Method:
type: string
nullable: true
description: The payout subscription's payment method.
PaypointId:
$ref: '#/components/schemas/PaypointId'
nullable: true
TotalAmount:
type: number
format: double
nullable: true
description: The payout subscription amount, including any fees.
NetAmount:
$ref: '#/components/schemas/Netamountnullable'
nullable: true
description: The payout subscription amount, minus any fees.
FeeAmount:
type: number
format: double
nullable: true
description: Fee applied to the payout subscription.
PaymentData:
$ref: '#/components/schemas/QueryPaymentData'
nullable: true
StartDate:
type: string
format: date-time
nullable: true
description: The payout subscription start date.
EndDate:
type: string
format: date-time
nullable: true
description: The payout subscription's end date.
NextDate:
type: string
format: date-time
nullable: true
description: The next date the payout subscription will be processed.
Frequency:
type: string
nullable: true
description: The payout subscription's frequency.
TotalCycles:
type: integer
nullable: true
description: The total number of cycles the payout subscription is set to run.
LeftCycles:
type: integer
nullable: true
description: The number of cycles the payout subscription has left.
LastRun:
type: string
format: date-time
nullable: true
description: The last time the payout subscription was processed.
EntrypageId:
$ref: '#/components/schemas/EntrypageId'
nullable: true
UntilCancelled:
type: boolean
nullable: true
description: >-
When `true`, the payout subscription has no explicit end date and
runs until canceled.
LastUpdated:
$ref: '#/components/schemas/LastModified'
nullable: true
description: The last date and time the payout subscription was updated.
CreatedAt:
$ref: '#/components/schemas/CreatedAt'
nullable: true
description: Timestamp of when the payout subscription was created, in UTC.
PaypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
description: The paypoint's legal name.
PaypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
description: The paypoint's DBA name.
PaypointEntryname:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: The paypoint's entryname.
ParentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
ParentOrgId:
$ref: '#/components/schemas/OrgParentId'
nullable: true
Source:
$ref: '#/components/schemas/Source'
nullable: true
required:
- StartDate
- EndDate
- NextDate
- LastRun
QueryPayoutSubscriptionResponse:
title: QueryPayoutSubscriptionResponse
type: object
description: Payout subscription query response body.
properties:
Summary:
$ref: '#/components/schemas/QuerySummary'
nullable: true
Records:
type: array
items:
$ref: '#/components/schemas/PayoutSubscriptionQueryRecordPascal'
nullable: true
GetBasicEntryByIdResponse:
title: GetBasicEntryByIdResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/PaypointEntryConfig'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- responseText
GetBasicEntryResponse:
title: GetBasicEntryResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/PaypointEntryConfig'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- responseText
GetEntryConfigResponse:
title: GetEntryConfigResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
pageIdentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseData:
$ref: '#/components/schemas/PaypointEntryConfig'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- responseText
PaypointMoveRequest:
title: PaypointMoveRequest
type: object
properties:
entryPoint:
$ref: '#/components/schemas/Entrypointfield'
newParentOrganizationId:
type: integer
description: The ID for the paypoint's new parent organization.
notificationRequest:
$ref: '#/components/schemas/NotificationRequest'
nullable: true
description: Optional notification request object for a webhook
required:
- entryPoint
- newParentOrganizationId
NotificationRequest:
title: NotificationRequest
type: object
properties:
notificationUrl:
type: string
description: Complete HTTP URL receiving the notification
webHeaderParameters:
type: array
items:
$ref: '#/components/schemas/WebHeaderParameter'
nullable: true
description: >-
A dictionary of key-value pairs to be inserted in the header when
the notification request is submitted
required:
- notificationUrl
WebHeaderParameter:
title: WebHeaderParameter
type: object
properties:
key:
type: string
value:
type: string
required:
- key
- value
MigratePaypointResponse:
title: MigratePaypointResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
responseCode:
$ref: '#/components/schemas/Responsecode'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- isSuccess
- responseText
StatBasicQueryRecord:
title: StatBasicQueryRecord
type: object
properties:
statX:
type: string
description: Statistical grouping identifier
inTransactions:
type: integer
description: Number of incoming transactions
inTransactionsVolume:
type: number
format: double
description: Volume of incoming transactions
inWalletTransactions:
type: integer
description: Number of incoming wallet transactions
inWalletVolume:
type: number
format: double
description: Volume of incoming wallet transactions
required:
- statX
- inTransactions
- inTransactionsVolume
- inWalletTransactions
- inWalletVolume
StatBasicExtendedQueryRecord:
title: StatBasicExtendedQueryRecord
type: object
properties:
statX:
type: string
description: The time window based on the mode and frequency used for the query.
outCustomers:
type: integer
description: Number of active vendors.
outNewCustomers:
type: integer
description: Number of new vendors.
outTransactions:
type: integer
description: Outbound (payout) transactions count.
outSubscriptionsPaid:
type: integer
description: Recurring outbound (payout) transactions count.
outCardTransactions:
type: integer
description: Outbound (payout) pCard transactions count.
outVCardTransactions:
type: integer
description: Outbound (payout) vCard transactions count.
outACHTransactions:
type: integer
description: Outbound (payout) ACH transactions count.
outCheckTransactions:
type: integer
description: Outbound (payout) check transactions count.
outPendingMethodTransactions:
type: integer
description: Outbound (payout) Managed Payables transactions count.
outTransactionsVolume:
type: number
format: double
description: Outbound (payout) volume.
outSubscriptionsPaidVolume:
type: number
format: double
description: Recurring outbound (payout) volume.
outCardVolume:
type: number
format: double
description: Outbound (payout) pCard transactions volume.
outVCardVolume:
type: number
format: double
description: Outbound (payout) vCard transactions volume.
outACHVolume:
type: number
format: double
description: Outbound (payout) ACH transactions volume.
outCheckVolume:
type: number
format: double
description: Outbound (payout) check transactions volume.
outPendingMethodVolume:
type: number
format: double
description: Outbound (payout) Managed Payables volume.
inTransactions:
type: integer
description: Inbound transactions count.
inSubscriptionsPaid:
type: integer
description: Inbound recurring transactions count.
inCustomers:
type: integer
description: Number of active customers.
inNewCustomers:
type: integer
description: Number of new customers.
inCardTransactions:
type: integer
description: Inbound card transactions count.
inACHTransactions:
type: integer
description: Inbound ACH transactions count.
inCheckTransactions:
type: integer
description: Inbound check transactions count.
inCashTransactions:
type: integer
description: Inbound cash transactions count.
inWalletTransactions:
type: integer
description: Inbound wallet transactions count.
inCardChargeBacks:
type: integer
description: Inbound card chargebacks and returns count.
inACHReturns:
type: integer
description: Inbound ACH returns count.
inTransactionsVolume:
type: number
format: double
description: Inbound volume.
inSubscriptionsPaidVolume:
type: number
format: double
description: Inbound recurring payments volume.
inCardVolume:
type: number
format: double
description: Inbound card volume.
inACHVolume:
type: number
format: double
description: Inbound ACH volume.
inCheckVolume:
type: number
format: double
description: Inbound check volume.
inCashVolume:
type: number
format: double
description: Inbound cash volume recognized.
inWalletVolume:
type: number
format: double
description: Inbound wallet transactions.
inCardChargeBackVolume:
type: number
format: double
description: Inbound Card chargebacks and returns volume.
inACHReturnsVolume:
type: number
format: double
description: Inbound ACH returns volume.
required:
- statX
- outCustomers
- outNewCustomers
- outTransactions
- outSubscriptionsPaid
- outCardTransactions
- outVCardTransactions
- outACHTransactions
- outCheckTransactions
- outPendingMethodTransactions
- outTransactionsVolume
- outSubscriptionsPaidVolume
- outCardVolume
- outVCardVolume
- outACHVolume
- outCheckVolume
- outPendingMethodVolume
- inTransactions
- inSubscriptionsPaid
- inCustomers
- inNewCustomers
- inCardTransactions
- inACHTransactions
- inCheckTransactions
- inCashTransactions
- inWalletTransactions
- inCardChargeBacks
- inACHReturns
- inTransactionsVolume
- inSubscriptionsPaidVolume
- inCardVolume
- inACHVolume
- inCheckVolume
- inCashVolume
- inWalletVolume
- inCardChargeBackVolume
- inACHReturnsVolume
SubscriptionStatsQueryRecord:
title: SubscriptionStatsQueryRecord
type: object
properties:
interval:
type: string
description: Time interval identifier
count:
type: integer
description: Number of subscriptions
volume:
type: number
format: double
description: Subscription volume
required:
- interval
- count
- volume
StatisticsVendorQueryRecord:
title: StatisticsVendorQueryRecord
type: object
properties:
statX:
type: string
description: Statistical grouping identifier
active:
type: integer
description: Number of active transactions
activeVolume:
type: number
format: double
description: Volume of active transactions
sentToApproval:
type: integer
description: Number of transactions sent to approval
sentToApprovalVolume:
type: number
format: double
description: Volume of transactions sent to approval
toApproval:
type: integer
description: Number of transactions to approval
toApprovalVolume:
type: number
format: double
description: Volume of transactions to approval
approved:
type: integer
description: Number of approved transactions
approvedVolume:
type: number
format: double
description: Volume of approved transactions
disapproved:
type: integer
description: Number of disapproved transactions
disapprovedVolume:
type: number
format: double
description: Volume of disapproved transactions
cancelled:
type: integer
description: Number of cancelled transactions
cancelledVolume:
type: number
format: double
description: Volume of cancelled transactions
inTransit:
type: integer
description: Number of transactions in transit
inTransitVolume:
type: number
format: double
description: Volume of transactions in transit
paid:
type: integer
description: Number of paid transactions
paidVolume:
type: number
format: double
description: Volume of paid transactions
required:
- statX
- active
- activeVolume
- sentToApproval
- sentToApprovalVolume
- toApproval
- toApprovalVolume
- approved
- approvedVolume
- disapproved
- disapprovedVolume
- cancelled
- cancelledVolume
- inTransit
- inTransitVolume
- paid
- paidVolume
SetPause:
title: SetPause
type: boolean
description: >-
Flag indicating if subscription is paused. When a subscription is
paused, no payments are processed until the subscription is unpaused,
and the next payment date isn't calculated automatically. If you want to
skip a payment instead, set the `totalAmount` to 0 in the
`paymentDetails` object.
RemoveSubscriptionResponse:
title: RemoveSubscriptionResponse
type: object
description: Success response
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
type: string
nullable: true
description: >-
If `isSuccess` = true, this contains the identifier of the
subscription.
If `isSuccess` = false, this contains the reason for the failure.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
RequestSchedulePaymentMethod:
title: RequestSchedulePaymentMethod
oneOf:
- $ref: '#/components/schemas/PayMethodCredit'
- $ref: '#/components/schemas/PayMethodACH'
- description: >-
The required and recommended fields for a payment made with a stored
payment method.
$ref: '#/components/schemas/RequestSchedulePaymentMethodInitiator'
description: >-
Information about the payment method for the transaction. Required and
recommended fields for each payment method type are described in each
schema below.
RequestSchedulePaymentMethodInitiator:
title: RequestSchedulePaymentMethodInitiator
type: object
description: >-
The required and recommended fields for a payment made with a stored
payment method.
properties:
initiator:
$ref: '#/components/schemas/Initiator'
nullable: true
storedMethodId:
$ref: '#/components/schemas/Storedmethodid'
nullable: true
description: Payabli identifier of a tokenized payment method.
storedMethodUsageType:
$ref: '#/components/schemas/StoredMethodUsageType'
nullable: true
UpdateSubscriptionResponse:
title: UpdateSubscriptionResponse
type: object
description: Success response
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
type: string
nullable: true
description: >-
If `isSuccess` = true, this contains the identifier of the
subscription, and sometimes extra information, depending on what was
updated.
If `isSuccess` = false, this contains the reason for the failure.
responseText:
$ref: '#/components/schemas/ResponseText'
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
required:
- responseText
SubscriptionRequestBody:
title: SubscriptionRequestBody
type: object
properties:
customerData:
$ref: '#/components/schemas/PayorDataRequest'
nullable: true
description: Object describing the customer/payor.
entryPoint:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
invoiceData:
$ref: '#/components/schemas/BillData'
nullable: true
description: Object describing an Invoice linked to the subscription.
paymentDetails:
$ref: '#/components/schemas/PaymentDetail'
nullable: true
description: >-
Object describing details of the payment. To skip the payment, set
the `totalAmount` to 0. Payments will be paused until the amount is
updated to a non-zero value. When `totalAmount` is set to 0, the
`serviceFee` must also be set to 0.
paymentMethod:
$ref: '#/components/schemas/RequestSchedulePaymentMethod'
nullable: true
description: >-
Information about the payment method for the transaction. Required
and recommended fields for each payment method type are described in
each schema below.
scheduleDetails:
$ref: '#/components/schemas/ScheduleDetail'
nullable: true
description: Object describing the schedule for subscription.
setPause:
$ref: '#/components/schemas/SetPause'
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
AddSubscriptionResponse:
title: AddSubscriptionResponse
type: object
description: Success response
properties:
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
type: integer
description: The identifier of the newly created subscription.
required:
- responseText
- responseData
VendorDataRequest:
title: VendorDataRequest
type: object
description: >-
Object describing the vendor owner of payment method. Required when
saving an ACH payment method on behalf of a vendor (for Pay Out
transactions).
properties:
vendorId:
type: integer
format: int64
nullable: true
description: >-
The unique numeric ID assigned to the vendor in Payabli. Either
`vendorId` or `vendorNumber` is required.
vendorNumber:
type: string
nullable: true
description: >-
Custom vendor number assigned by the business. Either `vendorId` or
`vendorNumber` is required.
Temporary:
title: Temporary
type: boolean
description: >-
Creates a temporary, one-time-use token for the payment method that
expires in 12 hours. Defaults to `false`.
CreateAnonymous:
title: CreateAnonymous
type: boolean
description: >-
When `true`, creates a saved method with no associated customer
information. The token will be associated with customer information the
first time it's used to make a payment. Defaults to `false`.
AddMethodResponse:
title: AddMethodResponse
type: object
properties:
responseData:
$ref: '#/components/schemas/AddMethodResponseResponseData'
nullable: true
allOf:
- $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
AddMethodResponseResponseData:
title: AddMethodResponseResponseData
type: object
properties:
referenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
description: >-
Stored method identifier in Payabli platform. This ID is used to
manage the stored method.
resultCode:
$ref: '#/components/schemas/ResultCode'
nullable: true
resultText:
$ref: '#/components/schemas/Resulttext'
nullable: true
customerId:
$ref: '#/components/schemas/CustomerId'
nullable: true
description: >-
Internal unique ID of customer owner of the stored method.
Returns `0` if the method wasn't assigned to an existing customer or
no customer was created."
methodReferenceId:
$ref: '#/components/schemas/MethodReferenceId'
nullable: true
GetMethodResponse:
title: GetMethodResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
$ref: '#/components/schemas/GetMethodResponseResponseData'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
GetMethodResponseResponseData:
title: GetMethodResponseResponseData
type: object
properties:
aba:
type: string
nullable: true
description: Bank routing number
achHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
achSecCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
bin:
type: string
nullable: true
description: The bank identification number (BIN)
binData:
$ref: '#/components/schemas/BinData'
nullable: true
cardUpdatedOn:
type: string
format: date-time
nullable: true
description: Timestamp for when card was last updated
customers:
type: array
items:
$ref: '#/components/schemas/GetMethodResponseResponseDataCustomersItem'
nullable: true
descriptor:
$ref: '#/components/schemas/Descriptor'
nullable: true
expDate:
type: string
nullable: true
description: Expiration date for card in stored method in format MM/YY
holderName:
$ref: '#/components/schemas/Holdername'
nullable: true
description: Account holder name in stored method
idPmethod:
type: string
nullable: true
description: The stored payment method's identifier in Payabli
isValidatedACH:
type: boolean
nullable: true
description: Whether the ACH account has been validated
lastUpdated:
type: string
format: date-time
nullable: true
description: Timestamp for last update of stored method, in UTC
maskedAccount:
$ref: '#/components/schemas/Maskedaccount'
nullable: true
method:
type: string
nullable: true
description: 'The saved method''s type: `card` or `ach`.'
methodType:
type: string
nullable: true
description: The payment method's token type
postalCode:
type: string
nullable: true
description: The payment method postal code
vendors:
type: array
items:
$ref: '#/components/schemas/GetMethodResponseResponseDataVendorsItem'
nullable: true
GetMethodResponseResponseDataCustomersItem:
title: GetMethodResponseResponseDataCustomersItem
type: object
properties:
balance:
type: number
format: float
nullable: true
description: Customer's current balance
created:
type: string
format: date-time
nullable: true
description: Creation timestamp
customerConsent:
type: object
additionalProperties: true
nullable: true
description: Customer consent information
customerStatus:
type: integer
nullable: true
description: Status code for the customer
customerSummary:
$ref: '#/components/schemas/CustomerSummaryRecord'
nullable: true
customerUsername:
type: string
nullable: true
description: Username of the customer
externalPaypointID:
$ref: '#/components/schemas/ExternalPaypointId'
nullable: true
lastUpdated:
type: string
format: date-time
nullable: true
description: Last update timestamp
mfa:
type: boolean
nullable: true
description: Multi-factor authentication status
mfaMode:
type: integer
nullable: true
description: MFA mode setting
pageindentifier:
$ref: '#/components/schemas/PageIdentifier'
nullable: true
parentOrgId:
type: integer
nullable: true
description: Parent organization ID
parentOrgName:
$ref: '#/components/schemas/OrgParentName'
nullable: true
paypointDbaname:
$ref: '#/components/schemas/Dbaname'
nullable: true
paypointEntryname:
type: string
nullable: true
description: The paypoint entryname the customer is associated with
paypointLegalname:
$ref: '#/components/schemas/Legalname'
nullable: true
snData:
type: object
additionalProperties: true
nullable: true
description: Social network data
snIdentifier:
type: string
nullable: true
description: Social network identifier
snProvider:
type: string
nullable: true
description: Social network provider
storedMethods:
type: array
items:
$ref: '#/components/schemas/MethodQueryRecords'
nullable: true
description: List of payment methods associated to the customer
subscriptions:
type: array
items:
$ref: '#/components/schemas/SubscriptionQueryRecords'
nullable: true
description: List of subscriptions associated to the customer
timeZone:
type: integer
nullable: true
description: Customer's timezone
allOf:
- $ref: '#/components/schemas/PayorDataRequest'
GetMethodResponseResponseDataVendorsItem:
title: GetMethodResponseResponseDataVendorsItem
type: object
properties:
additionalData:
$ref: '#/components/schemas/AdditionalDataMap'
nullable: true
description: Additional data for vendor
address1:
type: string
nullable: true
description: Vendor's address
address2:
type: string
nullable: true
description: Additional line for vendor's address
billingData:
$ref: '#/components/schemas/VendorResponseBillingData'
nullable: true
description: Object containing vendor's bank information
city:
type: string
nullable: true
description: Vendor's city
contacts:
type: array
items:
$ref: '#/components/schemas/Contacts'
nullable: true
description: Array of objects describing the vendor's contacts
country:
type: string
nullable: true
description: Vendor's country
createdDate:
type: string
format: date-time
nullable: true
description: Date when vendor was created
customField1:
type: string
nullable: true
description: Custom field 1 for vendor
customField2:
type: string
nullable: true
description: Custom field 2 for vendor
customerVendorAccount:
type: string
nullable: true
description: Account number of paypoint in the vendor's side
ein:
type: string
nullable: true
description: EIN/Tax ID for vendor. In responses, this field is masked.
email:
$ref: '#/components/schemas/Email'
nullable: true
description: Vendor's email address
enrollmentStatus:
type: string
nullable: true
description: Vendor enrollment status
externalPaypointID:
type: string
nullable: true
description: External paypoint identifier
internalReferenceId:
$ref: '#/components/schemas/InternalReferenceId'
nullable: true
description: Internal reference ID for vendor
lastUpdated:
type: string
format: date-time
nullable: true
description: Date when vendor was last updated
locationCode:
$ref: '#/components/schemas/LocationCode'
nullable: true
description: Location code for vendor
mcc:
$ref: '#/components/schemas/Mcc'
nullable: true
description: Merchant category code
name1:
type: string
nullable: true
description: Primary name for vendor
name2:
type: string
nullable: true
description: Secondary name for vendor
parentOrgId:
type: integer
nullable: true
description: ID of the parent organization
parentOrgName:
type: string
nullable: true
description: Name of the parent organization
payeeName1:
$ref: '#/components/schemas/PayeeName'
nullable: true
description: Primary payee name
payeeName2:
$ref: '#/components/schemas/PayeeName'
nullable: true
description: Secondary payee name
paymentMethod:
type: string
nullable: true
description: Preferred payment method for vendor
paypointDbaname:
type: string
nullable: true
description: DBA name of the paypoint
paypointEntryname:
type: string
nullable: true
description: Entry name of the paypoint
paypointId:
type: string
nullable: true
description: Paypoint ID
paypointLegalname:
type: string
nullable: true
description: Legal name of the paypoint
phone:
type: string
nullable: true
description: Vendor's phone number
remitAddress1:
$ref: '#/components/schemas/Remitaddress1'
nullable: true
description: Remittance address line 1
remitAddress2:
$ref: '#/components/schemas/Remitaddress2'
nullable: true
description: Remittance address line 2
remitCity:
$ref: '#/components/schemas/Remitcity'
nullable: true
description: Remittance city
remitCountry:
$ref: '#/components/schemas/Remitcountry'
nullable: true
description: Remittance country
remitEmail:
type: string
nullable: true
description: Email address for remittance
remitState:
$ref: '#/components/schemas/Remitstate'
nullable: true
description: Remittance state
remitZip:
$ref: '#/components/schemas/Remitzip'
nullable: true
description: Remittance ZIP code
state:
type: string
nullable: true
description: Vendor's state
storedMethods:
type: array
items:
$ref: '#/components/schemas/VendorResponseStoredMethod'
nullable: true
description: Array of stored payment methods for vendor
summary:
$ref: '#/components/schemas/VendorResponseSummary'
nullable: true
description: Vendor bill summary statistics
vendorId:
$ref: '#/components/schemas/Vendorid'
nullable: true
description: The unique numeric ID assigned to the vendor in Payabli
vendorNumber:
$ref: '#/components/schemas/VendorNumber'
nullable: true
description: Custom vendor number assigned by the business
vendorStatus:
$ref: '#/components/schemas/Vendorstatus'
nullable: true
description: Status code for the vendor
zip:
type: string
nullable: true
description: Vendor's ZIP code
RequestTokenStorage:
title: RequestTokenStorage
type: object
properties:
customerData:
$ref: '#/components/schemas/PayorDataRequest'
nullable: true
description: >-
Object describing the Customer/Payor owner of payment method.
Required for POST requests. Which fields are required depends on the
paypoint's custom identifier settings.
entryPoint:
$ref: '#/components/schemas/Entrypointfield'
nullable: true
description: Entrypoint identifier. Required for POST requests.
fallbackAuth:
type: boolean
nullable: true
description: >-
When `true`, if tokenization fails, Payabli will attempt an
authorization transaction to request a permanent token for the card.
If the authorization is successful, the card will be tokenized and
the authorization will be voided automatically.
fallbackAuthAmount:
type: integer
nullable: true
description: >-
The amount for the `fallbackAuth` transaction. Defaults to one
dollar (`100`).
methodDescription:
type: string
nullable: true
description: Custom description for stored payment method.
paymentMethod:
$ref: '#/components/schemas/RequestTokenStoragePaymentMethod'
nullable: true
description: Information about the payment method for the transaction.
vendorData:
$ref: '#/components/schemas/VendorDataRequest'
nullable: true
source:
$ref: '#/components/schemas/Source'
nullable: true
description: Custom identifier to indicate the source for the request
subdomain:
$ref: '#/components/schemas/Subdomain'
nullable: true
RequestTokenStoragePaymentMethod:
title: RequestTokenStoragePaymentMethod
oneOf:
- description: Tokenize a card payment method.
$ref: '#/components/schemas/TokenizeCard'
- description: Tokenize an ACH payment method.
$ref: '#/components/schemas/TokenizeACH'
- description: 'Converts a temporary token to a permanent token. '
$ref: '#/components/schemas/ConvertToken'
description: Information about the payment method for the transaction.
TokenizeCard:
title: TokenizeCard
type: object
properties:
method:
type: string
description: >-
The type of payment method to tokenize. For cards, this is always
`card`.
cardcvv:
$ref: '#/components/schemas/Cardcvv'
nullable: true
cardexp:
$ref: '#/components/schemas/Cardexp'
cardHolder:
$ref: '#/components/schemas/Cardholder'
cardnumber:
$ref: '#/components/schemas/Cardnumber'
cardzip:
$ref: '#/components/schemas/Cardzip'
nullable: true
required:
- method
- cardexp
- cardHolder
- cardnumber
TokenizeACH:
title: TokenizeACH
type: object
properties:
method:
type: string
description: >-
The type of payment method to tokenize. For ACH, this is always
`ach`.
achAccount:
$ref: '#/components/schemas/Achaccount'
achAccountType:
$ref: '#/components/schemas/Achaccounttype'
achCode:
$ref: '#/components/schemas/AchSecCode'
nullable: true
achHolder:
type: string
pattern: ^[A-Za-z0-9\s\-'.]+$
description: >-
Bank account holder. This field is **required** when `method` is
`ach`. Only letters, numbers, spaces, hyphens, apostrophes, and
periods are allowed.
achHolderType:
$ref: '#/components/schemas/AchHolderType'
nullable: true
achRouting:
$ref: '#/components/schemas/Achrouting'
device:
$ref: '#/components/schemas/Device'
nullable: true
required:
- method
- achAccount
- achAccountType
- achHolder
- achRouting
ConvertToken:
title: ConvertToken
type: object
description: >-
Object containing the information needed to convert a temporary token to
a permanent token.
properties:
method:
type: string
description: >-
The type of payment method to tokenize. When converting a temp token
to a permanent token, this should match the `method` set for the
temporary token, either `ach` or `card`.
tokenId:
type: string
description: A temporary stored token ID to be converted to permanent.
required:
- method
- tokenId
AddUserResponse:
title: AddUserResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseData:
type: string
nullable: true
description: The response data.
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
AuthResetUserResponse:
title: AuthResetUserResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
ChangePswUserResponse:
title: ChangePswUserResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
DeleteUserResponse:
title: DeleteUserResponse
type: object
properties:
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
EditMfaUserResponse:
title: EditMfaUserResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
LogoutUserResponse:
title: LogoutUserResponse
type: object
properties:
isSuccess:
$ref: '#/components/schemas/IsSuccess'
nullable: true
responseText:
$ref: '#/components/schemas/ResponseText'
required:
- responseText
securitySchemes:
APIKeyAuth:
type: apiKey
in: header
name: requestToken
servers:
- url: https://api-sandbox.payabli.com/api
description: Sandbox
- url: https://api.payabli.com/api
description: Production