Zapier Trigger: Payment Status Change

Zapier trigger that fires when a payment’s status changes in Portal.io.

This endpoint is used by the Portal.io Zapier integration. It fires when a payment’s status changes in your Portal.io account — for example, when a payment moves from Submitted to Paid, or from Paid to Refunded.

Endpoint

GET /zapier/trigger/payment

Headers

Header	Required	Description
Accept	Yes	Must be application/json

Response

A 200 response returns the payment details including status, amount, client information, and associated proposal.

Response Fields

Field	Type	Description
id	integer	Payment ID.
number	integer	Payment request number.
description	string or null	Payment description.
status	string	Current payment status (see payment statuses).
amount	number	Payment amount.
createdDate	string (ISO 8601)	When the payment was created.
modifiedDate	string (ISO 8601)	When the payment was last modified.
dueDate	string (ISO 8601)	Payment due date.
initiatedPaymentDate	string or null	When the payment was initiated by the client.
paidDate	string or null	When the payment was marked as paid.
clientFirstName	string or null	Client first name.
clientLastName	string or null	Client last name.
clientName	string	Full client name (firstName lastName).
personId	integer	ID of the client contact.
proposalId	integer or null	Associated proposal ID.
proposalNumber	integer or null	Associated proposal number.
paidVia	string or null	Payment method or processor name (e.g. Stripe, Square).
isEstExpired	boolean	Whether the payment estimate has expired.
paymentProcessorType	string	Payment processor type.
proposalPaymentScheduleItemId	integer or null	Associated payment schedule item ID.

Payment Statuses

Value	Description
Undefined	Unset/default status.
Draft	Payment is being prepared, not yet sent.
Submitted	Payment request has been sent to client.
Viewed	Client has viewed the payment request.
Paid	Payment has been collected.
Declined	Payment was declined.
Refunded	Payment has been refunded.
Pending	Payment is pending processing.
RequiresAction	Payment requires additional action (e.g. 3D Secure).
Verifying	Payment is being verified.
Cancelled	Payment has been cancelled.

{
  "id": 3042,
  "number": 1,
  "description": "50% deposit",
  "status": "Paid",
  "amount": 3225.00,
  "createdDate": "2026-04-06T00:00:00Z",
  "modifiedDate": "2026-04-07T14:30:00Z",
  "dueDate": "2026-04-20T00:00:00Z",
  "initiatedPaymentDate": "2026-04-07T14:25:00Z",
  "paidDate": "2026-04-07T14:30:00Z",
  "clientFirstName": "Jane",
  "clientLastName": "Smith",
  "clientName": "Jane Smith",
  "personId": 88,
  "proposalId": 4123,
  "proposalNumber": 1001,
  "paidVia": "Stripe",
  "isEstExpired": false,
  "paymentProcessorType": "Stripe",
  "proposalPaymentScheduleItemId": 501
}

This endpoint is designed for the Portal.io Zapier integration. If you are building a direct integration, consider using the webhook subscription endpoints instead.