Payments

List payments

Returns payments.

get/payments

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/payments
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

status'requested' | 'needs_approval' | 'scheduled' | 'sending' | 'settled' | 'returned' | 'failed' | 'rejected' | 'canceled'

Current payment status.

Only payments with this status.

projectIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only payments for this project.

purchaseOrderIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only payments linked to this purchase order.

paymentRequestIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only payments created from this payment request.

contactIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only payments for this contact.

expandPaymentExpand[]

Related records to include, separated by commas.

Response

Payments.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e",
      "workspaceId": "txn_8f2a1c9e",
      "amount": {
        "amount": 152900,
        "currency": "USD"
      },
      "destinationAmount": {
        "amount": 152900,
        "currency": "USD"
      },
      "request": {
        "id": "txn_8f2a1c9e",
        "workspaceId": "txn_8f2a1c9e",
        "amount": {
          "amount": 152900,
          "currency": "USD"
        }
      },
      "purchaseOrder": {
        "id": "txn_8f2a1c9e"
      },
      "transactions": [
        {
          "id": "txn_8f2a1c9e",
          "amount": {
            "amount": 152900,
            "currency": "USD"
          }
        }
      ],
      "contact": {
        "id": "txn_8f2a1c9e"
      },
      "budgetLine": {
        "id": "txn_8f2a1c9e"
      },
      "document": {
        "id": "txn_8f2a1c9e"
      }
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.