v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

PaymentMethod

Retrieves the collection of PaymentMethod resources.

get/payment_methods

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

PaymentMethod collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

The unique identifier of the source 3rd party integration

namestring nullable

Name for the payment method

typestring nullable

Type of the payment method

createdstring date-time nullable

Date the payment method was created

modifiedstring date-time nullable

Date the payment method was last modified

Example response

[
  {
    "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
    "integration": "quickbooks",
    "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
    "name": "Diners Club",
    "type": "CREDIT_CARD",
    "created": "2021-10-22 19:30:17",
    "modified": "2021-10-22 19:30:17"
  }
]