Sign in
Payments

Get a payment

Returns a payment. Use expand to include related records.

get/payments/{paymentId}

Request

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

Path parameters

paymentIdstring required

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

Example:txn_8f2a1c9e

Query parameters

expandPaymentExpand[]

Related records to include, separated by commas.

Response

The payment.

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
paymentRequestIdstring nullable required
purchaseOrderIdstring nullable required
contactIdstring nullable required
budgetLineIdstring nullable required
status'requested' | 'needs_approval' | 'scheduled' | 'sending' | 'settled' | 'returned' | 'failed' | 'rejected' | 'canceled' required

Current payment status.

railstring nullable required
descriptionstring nullable required
memostring nullable required
notesstring nullable required
scheduledForstring date-time nullable required
expectedArrivalAtstring date-time nullable required
cancellationRequestedboolean required
needsSupportboolean required
failureReasonstring nullable required
createdAtstring date-time required
updatedAtstring date-time required

Example response

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

Changes

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