Payabli Export API
The Export API from Payabli — 29 operation(s) for export.
OpenAPI Specification
openapi: 3.1.0
info:
title: API reference Bill Export API
version: 1.0.0
servers:
- url: https://api-sandbox.payabli.com/api
description: Sandbox
- url: https://api.payabli.com/api
description: Production
tags:
- name: Export
paths:
/Export/batches/{format}/{entry}:
get:
operationId: ExportBatches
summary: Export list of batches for entrypoint
description: "<Warning>\n This endpoint is deprecated. To export this data, use [List batches for paypoint](/developers/api-reference/query/get-list-of-batches-for-an-entrypoint) with the `exportFormat` query parameter instead.\n</Warning>\n\nExport a list of batches for an entrypoint. Use filters to limit results."
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: format
in: path
description: Format for the export, either XLSX or CSV.
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: columnsExport
in: query
required: false
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
default: 0
- 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
default: 25000
- name: parameters
in: query
description: "Collection of field names, conditions, and values used to filter the query\n\n<Info>\n **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**\n\n 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.\n\n For example:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20\n\n should become:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20\n</Info>\n\nSee [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.\n\nList of field names accepted:\n- `batchDate` (gt, ge, lt, le, eq, ne)\n- `batchNumber` (ne, eq)\n- `connectorName` (ne, eq, ct, nct)\n- `method` (in, nin, eq, ne)\n- `batchAmount` (gt, ge, lt, le, eq, ne)\n- `feeBatchAmount` (gt, ge, lt, le, eq, ne)\n- `netBatchAmount` (gt, ge, lt, le, eq, ne)\n- `releaseAmount` (gt, ge, lt, le, eq, ne)\n- `heldAmount` (gt, ge, lt, le, eq, ne)\n- `status` (in, nin, eq, ne)\n- `paypointLegal` (ne, eq, ct, nct)\n- `paypointDba` (ne, eq, ct, nct)\n- `orgName` (ne, eq, ct, nct)\n- `paypointId` (ne, eq)\n- `externalPaypointID` (ct, nct, eq, ne)\n- `expectedDepositDate` (gt, ge, lt, le, eq, ne)\n- `batchRecords` (gt, ge, lt, le, eq, ne)\n- `transferId` (ne, eq)\n- `transferDate` (gt, ge, lt, le, eq, ne)\n- `grossAmount` (gt, ge, lt, le, eq, ne)\n- `chargeBackAmount` (gt, ge, lt, le, eq, ne)\n- `returnedAmount` (gt, ge, lt, le, eq, ne)\n- `billingFeeAmount` (gt, ge, lt, le, eq, ne)\n- `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)\n- `netFundedAmount` (gt, ge, lt, le, eq, ne)\n- `adjustmentAmount` (gt, ge, lt, le, eq, ne)\n- `processor` (ne, eq, ct, nct)\n- `transferStatus` (ne, eq, in, nin)\n\nList of parameters accepted:\n- limitRecord: max number of records for query (default=\"20\", \"0\" or negative value for all)\n- fromRecord: initial record in query\n\nExample: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type:
- string
- 'null'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
/Export/batches/{format}/org/{orgId}:
get:
operationId: ExportBatchesOrg
summary: Export list of batches for organization
description: "<Warning>\n This endpoint is deprecated. To export this data, use [List batches for org](/developers/api-reference/query/get-list-of-batches-for-an-organization) with the `exportFormat` query parameter instead.\n</Warning>\n\nExport a list of batches for an organization. Use filters to limit results."
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
- name: fromRecord
in: query
description: The number of records to skip before starting to collect the result set.
required: false
schema:
type: integer
default: 0
- 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
default: 25000
- name: parameters
in: query
description: "Collection of field names, conditions, and values used to filter the query\n\n<Info>\n **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**\n\n 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.\n\n For example:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20\n\n should become:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20\n</Info>\nSee [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.\n\nList of field names accepted:\n- `batchDate` (gt, ge, lt, le, eq, ne)\n- `batchNumber` (ne, eq)\n- `connectorName` (ne, eq, ct, nct)\n- `method` (in, nin, eq, ne)\n- `batchAmount` (gt, ge, lt, le, eq, ne)\n- `feeBatchAmount` (gt, ge, lt, le, eq, ne)\n- `netBatchAmount` (gt, ge, lt, le, eq, ne)\n- `releaseAmount` (gt, ge, lt, le, eq, ne)\n- `heldAmount` (gt, ge, lt, le, eq, ne)\n- `status` (in, nin, eq, ne)\n- `paypointLegal` (ne, eq, ct, nct)\n- `paypointDba` (ne, eq, ct, nct)\n- `orgName` (ne, eq, ct, nct)\n- `paypointId` (ne, eq)\n- `externalPaypointID` (ct, nct, eq, ne)\n- `expectedDepositDate` (gt, ge, lt, le, eq, ne)\n- `batchRecords` (gt, ge, lt, le, eq, ne)\n- `transferId` (ne, eq)\n- `transferDate` (gt, ge, lt, le, eq, ne)\n- `grossAmount` (gt, ge, lt, le, eq, ne)\n- `chargeBackAmount` (gt, ge, lt, le, eq, ne)\n- `returnedAmount` (gt, ge, lt, le, eq, ne)\n- `billingFeeAmount` (gt, ge, lt, le, eq, ne)\n- `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)\n- `netFundedAmount` (gt, ge, lt, le, eq, ne)\n- `adjustmentAmount` (gt, ge, lt, le, eq, ne)\n- `processor` (ne, eq, ct, nct)\n- `transferStatus` (ne, eq, in, nin)\n\nList of parameters accepted:\n- `limitRecord`: max number of records for query (default=\"20\", \"0\" or negative value for all)\n- `fromRecord`: initial record in query\nExample: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type:
- string
- 'null'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
/Export/batchDetails/{format}/{entry}:
get:
operationId: ExportBatchDetails
summary: Export batch details for a paypoint
description: "<Warning>\n This endpoint is deprecated. To export this data, use [List batch details](/developers/api-reference/query/get-list-of-batchdetails-for-an-entrypoint) with the `exportFormat` query parameter instead.\n</Warning>\n\nExport batch details for a paypoint. Use filters to limit results."
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: format
in: path
description: Format for the export, either XLSX or CSV.
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: columnsExport
in: query
required: false
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
default: 0
- 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
default: 25000
- name: parameters
in: query
description: "Collection of field names, conditions, and values used to filter the query\n\n<Info>\n **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**\n\n 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.\n\n For example:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20\n\n should become:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20\n</Info>\n\nSee [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.\n\n**List of field names accepted:**\n\n - `settlementDate` (gt, ge, lt, le, eq, ne)\n - `depositDate` (gt, ge, lt, le, eq, ne)\n - `transId` (ne, eq, ct, nct)\n - `gatewayTransId` (ne, eq, ct, nct)\n - `method` (in, nin, eq, ne)\n - `settledAmount` (gt, ge, lt, le, eq, ne)\n - `operation` (in, nin, eq, ne)\n - `source` (in, nin, eq, ne)\n - `batchNumber` (ct, nct, eq, ne)\n - `payaccountLastfour` (nct, ct)\n - `payaccountType` (ne, eq, in, nin)\n - `customerFirstname` (ct, nct, eq, ne)\n - `customerLastname` (ct, nct, eq, ne)\n - `customerName` (ct, nct)\n - `customerId` (eq, ne)\n - `customerNumber` (ct, nct, eq, ne)\n - `customerCompanyname` (ct, nct, eq, ne)\n - `customerAddress` (ct, nct, eq, ne)\n - `customerCity` (ct, nct, eq, ne)\n - `customerZip` (ct, nct, eq, ne)\n - `customerState` (ct, nct, eq, ne)\n - `customerCountry` (ct, nct, eq, ne)\n - `customerPhone` (ct, nct, eq, ne)\n - `customerEmail` (ct, nct, eq, ne)\n - `customerShippingAddress` (ct, nct, eq, ne)\n - `customerShippingCity` (ct, nct, eq, ne)\n - `customerShippingZip` (ct, nct, eq, ne)\n - `customerShippingState` (ct, nct, eq, ne)\n - `customerShippingCountry` (ct, nct, eq, ne)\n - `orgId` (eq) *mandatory when entry=org*\n - `isHold` (eq, ne)\n - `paypointId` (ne, eq)\n - `paypointLegal` (ne, eq, ct, nct)\n - `paypointDba` (ne, eq, ct, nct)\n - `orgName` (ne, eq, ct, nct)\n - `batchId` (ct, nct, eq, neq)\n - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name\n\nList of parameters accepted:\n- limitRecord: max number of records for query (default=\"20\", \"0\" or negative value for all)\n- fromRecord: initial record in query\n\nExample: `amount(gt)=20` return all records with amount greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type:
- string
- 'null'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
/Export/batchDetails/{format}/org/{orgId}:
get:
operationId: ExportBatchDetailsOrg
summary: Export batch details for an org
description: "<Warning>\n This endpoint is deprecated. To export this data, use [List batch details for org](/developers/api-reference/query/get-list-of-batchdetails-for-an-organization) with the `exportFormat` query parameter instead.\n</Warning>\n\nExport batch details for an organization. Use filters to limit results."
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
- name: fromRecord
in: query
description: The number of records to skip before starting to collect the result set.
required: false
schema:
type: integer
default: 0
- 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
default: 25000
- name: parameters
in: query
description: "Collection of field names, conditions, and values used to filter the query\n\n<Info>\n **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**\n\n 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.\n\n For example:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20\n\n should become:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20\n</Info>\n\nSee [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.\n\n**List of field names accepted:**\n\n - `settlementDate` (gt, ge, lt, le, eq, ne)\n - `depositDate` (gt, ge, lt, le, eq, ne)\n - `transId` (ne, eq, ct, nct)\n - `gatewayTransId` (ne, eq, ct, nct)\n - `method` (in, nin, eq, ne)\n - `settledAmount` (gt, ge, lt, le, eq, ne)\n - `operation` (in, nin, eq, ne)\n - `source` (in, nin, eq, ne)\n - `batchNumber` (ct, nct, eq, ne)\n - `payaccountLastfour` (nct, ct)\n - `payaccountType` (ne, eq, in, nin)\n - `customerFirstname` (ct, nct, eq, ne)\n - `customerLastname` (ct, nct, eq, ne)\n - `customerName` (ct, nct)\n - `customerId` (eq, ne)\n - `customerNumber` (ct, nct, eq, ne)\n - `customerCompanyname` (ct, nct, eq, ne)\n - `customerAddress` (ct, nct, eq, ne)\n - `customerCity` (ct, nct, eq, ne)\n - `customerZip` (ct, nct, eq, ne)\n - `customerState` (ct, nct, eq, ne)\n - `customerCountry` (ct, nct, eq, ne)\n - `customerPhone` (ct, nct, eq, ne)\n - `customerEmail` (ct, nct, eq, ne)\n - `customerShippingAddress` (ct, nct, eq, ne)\n - `customerShippingCity` (ct, nct, eq, ne)\n - `customerShippingZip` (ct, nct, eq, ne)\n - `customerShippingState` (ct, nct, eq, ne)\n - `customerShippingCountry` (ct, nct, eq, ne)\n - `orgId` (eq) *mandatory when entry=org*\n - `isHold` (eq, ne)\n - `paypointId` (ne, eq)\n - `paypointLegal` (ne, eq, ct, nct)\n - `paypointDba` (ne, eq, ct, nct)\n - `orgName` (ne, eq, ct, nct)\n - `batchId` (ct, nct, eq, neq)\n - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name\n\nList of parameters accepted:\n- limitRecord: max number of records for query (default=\"20\", \"0\" or negative value for all)\n- fromRecord: initial record in query\n\nExample: `amount(gt)=20` return all records with amount greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type:
- string
- 'null'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
/Export/settlements/{format}/{entry}:
get:
operationId: ExportSettlements
summary: Export list of settled transactions for entrypoint
description: "<Warning>\n This endpoint is deprecated. To export this data, use [List settled transactions for paypoint](/developers/api-reference/query/get-list-of-settled-transactions-for-an-entrypoint) with the `exportFormat` query parameter instead.\n</Warning>\n\nExport a list of settled transactions for an entrypoint. Use filters to limit results."
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: format
in: path
description: Format for the export, either XLSX or CSV.
required: true
schema:
$ref: '#/components/schemas/ExportFormat1'
- name: columnsExport
in: query
required: false
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
default: 0
- 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
default: 25000
- name: parameters
in: query
description: "Collection of field names, conditions, and values used to filter the query\n\n<Info>\n **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**\n\n 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.\n\n For example:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20\n\n should become:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20\n</Info>\n\nSee [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.\n\nList of field names accepted:\n- `settlementDate` (gt, ge, lt, le, eq, ne)\n- `transId` (ne, eq, ct, nct)\n- `gatewayTransId` (ne, eq, ct, nct)\n- `method` (in, nin, eq, ne)\n- `settledAmount` (gt, ge, lt, le, eq, ne)\n- `operation` (in, nin, eq, ne)\n- `source` (in, nin, eq, ne)\n- `batchNumber` (ct, nct, eq, ne)\n- `payaccountLastfour` (nct, ct)\n- `payaccountType` (ne, eq, in, nin)\n- `customerFirstname` (ct, nct, eq, ne)\n- `customerLastname` (ct, nct, eq, ne)\n- `customerName` (ct, nct)\n- `customerId` (eq, ne)\n- `customerNumber` (ct, nct, eq, ne)\n- `customerCompanyname` (ct, nct, eq, ne)\n- `customerAddress` (ct, nct, eq, ne)\n- `customerCity` (ct, nct, eq, ne)\n- `customerZip` (ct, nct, eq, ne)\n- `customerState` (ct, nct, eq, ne)\n- `customerCountry` (ct, nct, eq, ne)\n- `customerPhone` (ct, nct, eq, ne)\n- `customerEmail` (ct, nct, eq, ne)\n- `customerShippingAddress` (ct, nct, eq, ne)\n- `customerShippingCity` (ct, nct, eq, ne)\n- `customerShippingZip` (ct, nct, eq, ne)\n- `customerShippingState` (ct, nct, eq, ne)\n- `customerShippingCountry` (ct, nct, eq, ne)\n- `orgId` (eq) *mandatory when entry=org*\n- `paypointId` (ne, eq)\n- `paypointLegal` (ne, eq, ct, nct)\n- `paypointDba` (ne, eq, ct, nct)\n- `orgName` (ne, eq, ct, nct)\n- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name\n\nList of comparison accepted - enclosed between parentheses:\n- eq or empty => equal\n- gt => greater than\n- ge => greater or equal\n- lt => less than\n- le => less or equal\n- ne => not equal\n- ct => contains\n- nct => not contains\n- in => inside array separated by \"|\"\n- nin => not inside array separated by \"|\"\n\nList of parameters accepted:\n- limitRecord: max number of records for query (default=\"20\", \"0\" or negative value for all)\n- fromRecord: initial record in query\n\nExample: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type:
- string
- 'null'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/File'
'400':
description: Bad request / invalid data.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'401':
description: Unauthorized request.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
'503':
description: Database connection error.
content:
application/json:
schema:
$ref: '#/components/schemas/PayabliErrorBody'
/Export/settlements/{format}/org/{orgId}:
get:
operationId: ExportSettlementsOrg
summary: Export list of settled transactions for organization
description: "<Warning>\n This endpoint is deprecated. To export this data, use [List settled transactions for org](/developers/api-reference/query/get-list-of-settled-transactions-for-an-org) with the `exportFormat` query parameter instead.\n</Warning>\n\nExport a list of settled transactions for an organization. Use filters to limit results."
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
- name: fromRecord
in: query
description: The number of records to skip before starting to collect the result set.
required: false
schema:
type: integer
default: 0
- 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
default: 25000
- name: parameters
in: query
description: "Collection of field names, conditions, and values used to filter the query\n\n<Info>\n **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**\n\n 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.\n\n For example:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20\n\n should become:\n\n --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20\n</Info>\n\nSee [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.\n\nList of field names accepted:\n- `settlementDate` (gt, ge, lt, le, eq, ne)\n- `transId` (ne, eq, ct, nct)\n- `gatewayTransId` (ne, eq, ct, nct)\n- `method` (in, nin, eq, ne)\n- `settledAmount` (gt, ge, lt, le, eq, ne)\n- `operation` (in, nin, eq, ne)\n- `source` (in, nin, eq, ne)\n- `batchNumber` (ct, nct, eq, ne)\n- `payaccountLastfour` (nct, ct)\n- `payaccountType` (ne, eq, in, nin)\n- `customerFirstname` (ct, nct, eq, ne)\n- `customerLastname` (ct, nct, eq, ne)\n- `customerName` (ct, nct)\n- `customerId` (eq, ne)\n- `customerNumber` (ct, nct, eq, ne)\n- `customerCompanyname` (ct, nct, eq, ne)\n- `customerAddress` (ct, nct, eq, ne)\n- `customerCity` (ct, nct, eq, ne)\n- `customerZip` (ct, nct, eq, ne)\n- `customerState` (ct, nct, eq, ne)\n- `customerCountry` (ct, nct, eq, ne)\n- `customerPhone` (ct, nct, eq, ne)\n- `customerEmail` (ct, nct, eq, ne)\n- `customerShippingAddress` (ct, nct, eq, ne)\n- `customerShippingCity` (ct, nct, eq, ne)\n- `customerShippingZip` (ct, nct, eq, ne)\n- `customerShippingState` (ct, nct, eq, ne)\n- `customerShippingCountry` (ct, nct, eq, ne)\n- `orgId` (eq) *mandatory when entry=org*\n- `paypointId` (ne, eq)\n- `paypointLegal` (ne, eq, ct, nct)\n- `paypointDba` (ne, eq, ct, nct)\n- `orgName` (ne, eq, ct, nct)\n- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name\n\nList of comparison accepted - enclosed between parentheses:\n- eq or empty => equal\n- gt => greater than\n- ge => greater or equal\n- lt => less than\n- le => less or equal\n- ne => not equal\n- ct => contains\n- nct => not contains\n- in => inside array separated by \"|\"\n- nin => not inside array separated by \"|\"\n\nList of parameters accepted:\n- limitRecord: max number of records for query (default=\"20\", \"0\" or negative value for all)\n- fromRecord: initial record in query\n\nExample: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00"
required: false
schema:
type: object
additionalProperties:
type:
- string
- 'null'
- name: Authorization
in: header
description: 'OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/devel
# --- truncated at 32 KB (152 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/payabli/refs/heads/main/openapi/payabli-export-api-openapi.yml