Zapier Trigger: Payment Status Change - Portal.io API

Zapier Trigger for Payment Status Change

curl --request GET \
  --url https://sandbox.api.portal.io/zapier/trigger/payment \
  --header 'Accept: <accept>' \
  --header 'X-MSS-API-APPID: <api-key>' \
  --header 'X-MSS-API-USERKEY: <api-key>' \
  --header 'X-MSS-CUSTOM-DATE: <api-key>' \
  --header 'X-MSS-SIGNATURE: <api-key>'

import requests

url = "https://sandbox.api.portal.io/zapier/trigger/payment"

headers = {
    "Accept": "<accept>",
    "X-MSS-API-APPID": "<api-key>",
    "X-MSS-API-USERKEY": "<api-key>",
    "X-MSS-CUSTOM-DATE": "<api-key>",
    "X-MSS-SIGNATURE": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    Accept: '<accept>',
    'X-MSS-API-APPID': '<api-key>',
    'X-MSS-API-USERKEY': '<api-key>',
    'X-MSS-CUSTOM-DATE': '<api-key>',
    'X-MSS-SIGNATURE': '<api-key>'
  }
};

fetch('https://sandbox.api.portal.io/zapier/trigger/payment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 81376,
  "status": "Undefined",
  "amount": 982.49,
  "createdDate": "2030-08-21T00:22:19Z",
  "modifiedDate": "2031-01-12T00:22:19Z",
  "dueDate": "2031-03-12T00:22:19Z",
  "initiatedPaymentDate": "2030-05-18T00:22:19Z",
  "paidDate": "2030-12-17T00:22:19Z",
  "personId": 67965,
  "proposalId": 11538,
  "proposalNumber": 430,
  "number": 936,
  "isEstExpired": false,
  "paymentProcessorType": "None",
  "proposalPaymentScheduleItemId": 90716
}

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Authentication failed. Verify the HMAC headers and credentials used for the request."
  }
}

GET

/

zapier

/

trigger

/

payment

Zapier Trigger for Payment Status Change

curl --request GET \
  --url https://sandbox.api.portal.io/zapier/trigger/payment \
  --header 'Accept: <accept>' \
  --header 'X-MSS-API-APPID: <api-key>' \
  --header 'X-MSS-API-USERKEY: <api-key>' \
  --header 'X-MSS-CUSTOM-DATE: <api-key>' \
  --header 'X-MSS-SIGNATURE: <api-key>'

import requests

url = "https://sandbox.api.portal.io/zapier/trigger/payment"

headers = {
    "Accept": "<accept>",
    "X-MSS-API-APPID": "<api-key>",
    "X-MSS-API-USERKEY": "<api-key>",
    "X-MSS-CUSTOM-DATE": "<api-key>",
    "X-MSS-SIGNATURE": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    Accept: '<accept>',
    'X-MSS-API-APPID': '<api-key>',
    'X-MSS-API-USERKEY': '<api-key>',
    'X-MSS-CUSTOM-DATE': '<api-key>',
    'X-MSS-SIGNATURE': '<api-key>'
  }
};

fetch('https://sandbox.api.portal.io/zapier/trigger/payment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 81376,
  "status": "Undefined",
  "amount": 982.49,
  "createdDate": "2030-08-21T00:22:19Z",
  "modifiedDate": "2031-01-12T00:22:19Z",
  "dueDate": "2031-03-12T00:22:19Z",
  "initiatedPaymentDate": "2030-05-18T00:22:19Z",
  "paidDate": "2030-12-17T00:22:19Z",
  "personId": 67965,
  "proposalId": 11538,
  "proposalNumber": 430,
  "number": 936,
  "isEstExpired": false,
  "paymentProcessorType": "None",
  "proposalPaymentScheduleItemId": 90716
}

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Authentication failed. Verify the HMAC headers and credentials used for the request."
  }
}

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.

Authorizations

X-MSS-API-APPID

string

header

required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY

string

header

required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE

string

header

required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE

string

header

required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

Accept

enum<string>

required

Accept Header

Available options:

application/json

Response

Payment Item.

ZapierPaymentItem

id

integer<int32>

description

null | string

status

enum<string>

Available options:

Undefined,

Draft,

Submitted,

Viewed,

Paid,

Declined,

Refunded,

Pending,

RequiresAction,

Verifying,

Cancelled

amount

number<double>

createdDate

string<date-time>

modifiedDate

string<date-time>

dueDate

string<date-time>

initiatedPaymentDate

null | string<date-time>

paidDate

null | string<date-time>

clientFirstName

null | string

clientLastName

null | string

clientName

null | string

personId

integer<int32>

proposalId

null | integer<int32>

proposalNumber

null | integer<int32>

number

integer<int32>

paidVia

null | string

isEstExpired

boolean

paymentProcessorType

enum<string>

Available options:

None,

Stripe,

CardConnect,

Quickbooks,

Square,

PortalStripe

proposalPaymentScheduleItemId

null | integer<int32>

⌘I