Payment Requests

Get a payment request

Returns a payment request. Use expand to include related records.

get/payment-requests/{paymentRequestId}

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/payment-requests/{paymentRequestId}
  • Auth: HTTP bearer

Path parameters

paymentRequestIdstring required

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

Example:txn_8f2a1c9e

Query parameters

expandPaymentRequestExpand[]

Related records to include, separated by commas.

Response

The payment request.

idstring required

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

workspaceIdstring required

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

projectIdstring nullable required
purchaseOrderIdstring nullable required
contactIdstring nullable required
budgetLineIdstring nullable required
descriptionstring nullable required
memostring nullable required
dueDatestring date-time nullable required
methodstring nullable required
status'submitted' | 'pending' | 'approved' | 'paid' | 'rejected' | 'canceled' | 'unknown' required

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

submittedAtstring date-time required
approvedAtstring date-time nullable required
rejectedAtstring date-time nullable required
completedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "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"
  }
}

Changes

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