Payment Requests

List payment requests

Returns payment requests. Use expand to include related records.

get/payment-requests

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/payment-requests
  • 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'submitted' | 'pending' | 'approved' | 'paid' | 'rejected' | 'canceled' | 'unknown'

Current payment-request status. unknown means the status is unavailable.

Only payment requests with this status.

projectIdstring

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

Example:txn_8f2a1c9e

Only payment requests for this project.

purchaseOrderIdstring

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

Example:txn_8f2a1c9e

Only payment requests linked to this purchase order.

contactIdstring

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

Example:txn_8f2a1c9e

Only payment requests for this contact.

expandPaymentRequestExpand[]

Related records to include, separated by commas.

Response

Payment requests.

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"
      },
      "contact": {
        "id": "txn_8f2a1c9e"
      },
      "purchaseOrder": {
        "id": "txn_8f2a1c9e"
      },
      "document": {
        "id": "txn_8f2a1c9e"
      },
      "payment": {
        "id": "txn_8f2a1c9e",
        "workspaceId": "txn_8f2a1c9e",
        "amount": {
          "amount": 152900,
          "currency": "USD"
        },
        "destinationAmount": {
          "amount": 152900,
          "currency": "USD"
        }
      },
      "transactions": [
        {
          "id": "txn_8f2a1c9e",
          "amount": {
            "amount": 152900,
            "currency": "USD"
          }
        }
      ],
      "budgetLine": {
        "id": "txn_8f2a1c9e"
      }
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

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