PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List payments GETCreate a payment POSTGet a payment GETUpdate a payment PATCHRecord a purchase POSTReverse a purchase POST
Payments

List payments

GET
/payments

Authorization

x-api-key<token>

In: header

Query Parameters

limit?integer
Rangevalue <= 100
Default50
offset?integer
Range0 <= value
Default0
source?string

Value in

  • "INVOICE"
  • "MANUAL"
  • "STRIPE"
  • "XENDIT"
  • "RECEIPT"
  • "API"
  • "WORKFLOW"
  • "MCP"
  • "IMPORT"
sourceLabel?string
externalRef?string

Response Body

application/json

curl -X GET "https://example.com/payments"
{  "data": [    {      "id": "string",      "amount": 0,      "status": "string",      "paidAt": "2019-08-24T14:15:22Z",      "note": "string",      "invoiceId": "string",      "currency": "string",      "source": "INVOICE",      "sourceLabel": "string",      "externalRef": "string",      "contactId": "string",      "opportunityId": "string",      "items": [        {          "name": "string",          "sku": "string",          "quantity": 0,          "unitAmount": 0        }      ],      "metaEventId": "string",      "metaSend": true,      "reversedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "customer": {        "id": "string",        "name": "string",        "email": "string",        "company": "string"      },      "invoice": {        "id": "string",        "invoiceNumber": "string"      },      "metaConversion": {        "id": "string",        "siteId": "string",        "paymentId": "string",        "eventName": "string",        "eventId": "string",        "contactId": "string",        "value": 0,        "currency": "string",        "eventTime": "2019-08-24T14:15:22Z",        "status": "QUEUED",        "skipReason": "string",        "reversed": true,        "attempts": 0,        "lastError": "string",        "sentAt": "2019-08-24T14:15:22Z",        "exportedAt": "2019-08-24T14:15:22Z"      }    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Mark an invoice paid POST

Previous Page

Create a payment POST

Next Page