> ## Documentation Index
> Fetch the complete documentation index at: https://docs.portal.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.


## OpenAPI

````yaml GET /zapier/trigger/payment
openapi: 3.1.0
info:
  title: Portal.Api
  version: '1.0'
servers:
  - url: http://127.0.0.1:5000
security: []
tags: []
paths:
  /zapier/trigger/payment:
    get:
      tags:
        - Zapier Triggers
      summary: Zapier Trigger for Payment Status Change
      description: >-
        Provides the sample response shape for the Zapier payment trigger. Use
        this trigger when you want Zapier to receive payment updates, including
        payment status changes and related payment details.
      operationId: GetZapierPaymentTrigger
      parameters:
        - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: Payment Item.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZapierPaymentItem'
        '401':
          description: >-
            Authentication failed. Verify the HMAC headers and credentials used
            for the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
      deprecated: false
      x-codeSamples: []
components:
  parameters:
    Accept:
      name: Accept
      in: header
      description: Accept Header
      required: true
      schema:
        type: string
        enum:
          - application/json
  schemas:
    ZapierPaymentItem:
      title: ZapierPaymentItem
      properties:
        id:
          type: integer
          format: int32
        description:
          type: string
        status:
          type: string
        amount:
          type: number
          format: double
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        dueDate:
          type: string
          format: date-time
        initiatedPaymentDate:
          type: string
          format: date-time
        paidDate:
          type: string
          format: date-time
        clientFirstName:
          type: string
        clientLastName:
          type: string
        clientName:
          type: string
        personId:
          type: integer
          format: int32
        proposalId:
          type: integer
          format: int32
        proposalNumber:
          type: integer
          format: int32
        number:
          type: integer
          format: int32
        paidVia:
          type: string
        isEstExpired:
          type: boolean
        paymentProcessorType:
          type: string
        proposalPaymentScheduleItemId:
          type: integer
          format: int32
      description: ZapierPaymentItem
      type: object
    HttpError:
      title: HttpError
      properties:
        errorCode:
          type: string
        stackTrace:
          type: string
        contentType:
          type: string
        headers:
          $ref: '#/components/schemas/Dictionary_String_String_'
        cookies:
          type: array
          items:
            $ref: '#/components/schemas/Cookie'
        status:
          type: integer
          format: int32
        statusCode:
          type: string
        statusDescription:
          type: string
        response:
          $ref: '#/components/schemas/Object'
        responseFilter:
          $ref: '#/components/schemas/IContentTypeWriter'
        requestContext:
          $ref: '#/components/schemas/IRequest'
        paddingLength:
          type: integer
          format: int32
        resultScope:
          $ref: '#/components/schemas/Func_IDisposable_'
        options:
          $ref: '#/components/schemas/IDictionary_String_String_'
        responseStatus:
          $ref: '#/components/schemas/ResponseStatus'
        targetSite:
          $ref: '#/components/schemas/MethodBase'
        message:
          type: string
        data:
          $ref: '#/components/schemas/IDictionary'
        innerException:
          $ref: '#/components/schemas/Exception'
        helpLink:
          type: string
        source:
          type: string
        hResult:
          type: integer
          format: int32
      description: HttpError
      type: object
    Dictionary_String_String_:
      title: Dictionary<String,String>
      additionalProperties:
        type: string
      description: Dictionary<String,String>
      type: object
    Cookie:
      title: Cookie
      properties: {}
      description: Cookie
      type: object
    Object:
      properties: {}
      description: Object
      type: object
    IContentTypeWriter:
      title: IContentTypeWriter
      properties: {}
      description: IContentTypeWriter
      type: object
    IRequest:
      title: IRequest
      properties: {}
      description: IRequest
      type: object
    Func_IDisposable_:
      title: Func`1
      properties: {}
      description: Func<IDisposable>
      type: object
    IDictionary_String_String_:
      title: IDictionary<String,String>
      additionalProperties:
        type: string
      description: IDictionary<String,String>
      type: object
    ResponseStatus:
      title: ResponseStatus
      properties:
        errorCode:
          type: string
        message:
          type: string
        stackTrace:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ResponseError'
        meta:
          $ref: '#/components/schemas/Dictionary_String_String_'
      description: ResponseStatus
      type: object
    MethodBase:
      title: MethodBase
      properties: {}
      description: MethodBase
      type: object
    IDictionary:
      title: IDictionary
      properties: {}
      description: IDictionary
      type: object
    Exception:
      title: Exception
      properties: {}
      description: Exception
      type: object
    ResponseError:
      title: ResponseError
      properties:
        errorCode:
          type: string
        fieldName:
          type: string
        message:
          type: string
        meta:
          $ref: '#/components/schemas/Dictionary_String_String_'
      description: ResponseError
      type: object

````