Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Transactions

Create a delivery report from an external adapter (Shopify, WooCommerce, etc.) for observability

Create a delivery report from an external adapter (Shopify, WooCommerce, etc.) for observability

post/api/v1/transactions/{transactionId}/delivery-reports

Path parameters

transactionIdstring required

The transaction number (not UUID)

Example:TXN-2026-00123

The transaction number (not UUID)

Request body

platformstring required

Platform that performed the finalization

finalization_typestring required

Type of finalization performed

external_referencestring

External platform reference ID (e.g., Shopify GID)

request_payloadobject

The payload sent to the external platform

responseobject

The response received from the external platform

http_statusnumber

HTTP status code from the external platform

duration_msnumber

How long the finalization call took in milliseconds

payment_provider_status_idstring uuid

Correlation ID linking to the PaymentProviderStatus that triggered this

Example request

{
  "platform": "shopify",
  "finalization_type": "payment_resolved",
  "external_reference": "gid://shopify/PaymentSession/abc123",
  "http_status": 200,
  "duration_ms": 150
}

Response

Success

successboolean required