---
updatedAt: 2026-08-05T12:09:51.000Z
agentTools:
  projectIndex: https://developers.deliverect.com/v3.0-ordering-experience/llms.txt
---

# Payment Events

## Purpose

Payment platforms should call this endpoint to confirm the status of a payment request

<HTMLBlock>{`
<div class="callout-banner callout-banner--important">
  <span class="callout-icon"><i class="fa-duotone fa-solid fa-triangle-exclamation"></i></span>
  <p>
    <strong>Payment Authorization Timeout</strong><br>
    Updates to authorize or refuse a payment should be sent within <strong>10 minutes</strong> of the initial payment request being received.
  </p>
</div>
`}</HTMLBlock>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "endpoints-1",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.staging.deliverect.com"
    }
  ],
  "security": [
    {
      "oauth2ClientCredentials": []
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2ClientCredentials": {
        "type": "oauth2",
        "description": "Obtain an access token using the partner client ID and client secret. Send the returned token with each API request in the Authorization header as a Bearer token.",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true,
    "oauth-options": {
      "useInsecureClientAuthentication": true
    }
  },
  "x-readme-fauxas": true,
  "paths": {
    "/pay/events/{integrationName}/gatewayProfiles/{gatewayProfileId}": {
      "post": {
        "summary": "Payment Events",
        "description": "",
        "operationId": "post_pay-events-integrationname-gatewayprofiles-gatewayprofileid",
        "parameters": [
          {
            "in": "path",
            "name": "integrationName",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "gatewayProfileId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "title": "Payment update",
                    "type": "object",
                    "required": [
                      "eventType",
                      "gatewayId",
                      "status",
                      "method"
                    ],
                    "properties": {
                      "eventType": {
                        "type": "string",
                        "enum": [
                          "payment_update"
                        ]
                      },
                      "gatewayId": {
                        "type": "string",
                        "example": "pay_gateway_123456"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "refused",
                          "authorized"
                        ]
                      },
                      "failureReason": {
                        "type": "string",
                        "example": "Insufficient Funds"
                      },
                      "method": {
                        "type": "string",
                        "example": "visa"
                      }
                    }
                  },
                  {
                    "title": "Refund update",
                    "type": "object",
                    "required": [
                      "eventType",
                      "gatewayId",
                      "status"
                    ],
                    "properties": {
                      "eventType": {
                        "type": "string",
                        "enum": [
                          "refund_update"
                        ]
                      },
                      "gatewayId": {
                        "type": "string",
                        "example": "refund_gateway_123456"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "failed",
                          "succeeded"
                        ]
                      },
                      "failureReason": {
                        "type": "string",
                        "example": "reason for refund failure"
                      }
                    }
                  }
                ]
              },
              "examples": {
                "Refund Failed": {
                  "summary": "Refund Failed",
                  "value": {
                    "eventType": "refund_update",
                    "gatewayId": "refund_gateway_123456",
                    "status": "failed",
                    "failureReason": "reason for refund failure"
                  }
                },
                "Refunded": {
                  "summary": "Refunded",
                  "value": {
                    "eventType": "refund_update",
                    "gatewayId": "refund_gateway_123456",
                    "status": "succeeded"
                  }
                },
                "Refused": {
                  "summary": "Refused",
                  "value": {
                    "eventType": "payment_update",
                    "gatewayId": "pay_gateway_123456",
                    "status": "refused",
                    "failureReason": "Insufficient Funds",
                    "method": "visa"
                  }
                },
                "Authorized": {
                  "summary": "Authorized",
                  "value": {
                    "eventType": "payment_update",
                    "gatewayId": "pay_gateway_123456",
                    "status": "authorized",
                    "method": "visa"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "examples": {
                  "OK": {
                    "summary": "OK",
                    "value": "{}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "Bad Request": {
                    "summary": "Bad Request",
                    "value": "{}"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```