Qualpay · Schema
InvoicePaymentListResponse
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-invoice-payment-list-response-schema.json",
"title": "InvoicePaymentListResponse",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/qualpay-invoicing-api-openapi.yml#/components/schemas/InvoicePaymentListResponse",
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href=\"/docs/api-conventions#platform-api-response-codes\" target=\"_blank\">Platform API Response Codes</a> for the entire list of return codes.",
"format": "int32",
"readOnly": true
},
"message": {
"type": "string",
"description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.",
"readOnly": true
},
"totalPages": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length N<br><strong>Description: </strong>Total number of pages. ",
"format": "int32",
"readOnly": true
},
"totalRecords": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 3 N<br><strong>Description: </strong>Total number of records up to a maximum of 100.",
"format": "int32",
"readOnly": true
},
"data": {
"type": "array",
"description": "An array of the resource object.",
"readOnly": true,
"items": {
"$ref": "#/$defs/InvoicePayment"
}
}
},
"$defs": {
"InvoicePayment": {
"type": "object",
"properties": {
"payment_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>The unique ID assigned to an invoice payment. Save this ID for managing invoice payments. ",
"format": "int64"
},
"merchant_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 16 N<br><strong>Description: </strong>The unique ID assigned to a merchant.",
"format": "int64"
},
"type": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>The mode of payment: <br><ul><li>`CARD` - An invoice payment that the customer made through Checkout using a card. </li><li>`CASH` - A cash payment.</li><li>`CHECK` - A check payment.</li><li>`OTHER` - Another mode of payment.</li></ul>",
"enum": [
"CARD",
"ACH",
"CREDIT",
"CASH",
"CHECK",
"OTHER"
]
},
"amt_paid": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 10,2 N<br><strong>Description: </strong>The amount paid. ",
"format": "double"
},
"description": {
"type": "string",
"description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the payment."
},
"pg_id": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>The Payment Gateway ID generated for the transaction. Applicable only to a `CARD`-`type` transaction."
},
"invoice_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>A unique number generated to identify an invoice. Save this ID to manage the invoice.",
"format": "int64"
},
"date_payment": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The date the payment was made."
},
"status": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 11 A<br><strong>Description: </strong>Status of an invoice. Possible values: <br><ul> <li>`SAVED` - The invoice is in draft state. An invoice in draft state can be updated. </li> <li>`OUTSTANDING` - The invoice has been sent to the customer. Once an invoice is sent, only `billing_contact` and `from_contact` can be updated. </li> <li>`PAID` - The invoice has been paid completely. A paid invoice cannot be updated. </li> <li>`CANCELED` - The invoice has been canceled. A canceled invoice cannot be updated. </li></ul>",
"enum": [
"SAVED",
"OUTSTANDING",
"PAID",
"CANCELED"
]
},
"tran_currency": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 3 AN<br><strong>Description: </strong>The ISO numeric currency code. This must be a currency code associated with one of your payment profiles; contact Qualpay to add currencies. Refer to <a href=\"/docs/references#currency-codes\" target=\"_blank\">Currency Codes</a> for a list of currency codes. "
},
"tran_status": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 1 A<br><strong>Description: </strong>The transaction status for `CARD` payments. The status will be empty for other payment types. Possible values: <br><ul><li>`A` - Transaction is approved</li><li>`H` - Transaction is held</li><li>`C` - Transaction is captured</li><li>`V` - Transaction is voided by the merchant</li><li>`v` - Transaction is voided by system</li><li>`K` - Transaction is canceled</li><li>`D` - Transaction is declined by issuer</li><li>`F` - Transaction failures other than issuer declines</li><li>`S` - Transaction settled</li><li>`P` - Deposit sent</li><li>`N` - Transaction settled but will be funded directly by issuer</li><li>`R` - Transaction rejected</li></ul>"
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/qualpay-invoice-payment-list-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.