For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
Logo
  • Home
    • Introduction
    • How it Works
    • Integrating your BillPay / AP
  • Validate
    • GETFind Validation Jobs
    • POSTCreate Validation Job
    • GETGet Validation Job
  • Process
    • GETFind Process Jobs
    • POSTCreate Process Job
    • GETGet Process Job
  • Webhooks
    • POSTPayment Gateway Validation Job Completed
    • POSTPayment Gateway Process Job Completed
Sign inBook a demo
Webhooks

Payment Gateway Process Job Completed

Payload
1{
2  "eventType": "paymentGateway.process.completed",
3  "jobId": "pgp_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
4  "data": {
5    "jobStatus": "success",
6    "attempts": [
7      {
8        "id": "pgpa_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
9        "status": "COMPLETED",
10        "createdAt": "2024-01-01T00:00:00Z",
11        "amount": 150.75,
12        "receiptUrl": "https://www.payment-gateway.com/receipt/123123"
13      }
14    ],
15    "createdAt": "2024-01-01T00:00:00Z",
16    "jobId": "pgp_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
17    "updatedAt": "2024-01-01T00:00:00Z",
18    "gatewayAmount": 155.5,
19    "invoiceAmount": 150.75,
20    "receiptUrl": "https://www.payment-gateway.com/receipt/123123",
21    "vendorName": "Acme Corporation"
22  }
23}
A payment gateway processing job has completed processing
Was this page helpful?
Previous
Built with

Payload

The payload of this webhook request is an object.
eventTypestringRequired
The type of the event.
jobIdstringRequired
The ID of the payment gateway process job that completed.
dataobjectRequired

Response

200
any
Return a 200 status to indicate that the data was received successfully.