Skip to navigation
API ReferencePayments

Report payment export errors

Beta

Queues an asynchronous job that records up to 100 payment export failures reported by your own ERP or export process — the failure-reporting counterpart to mark-exported. Each failure is classified and logged against the payment without altering its export state (exported_date and export_transaction_id are left untouched). A payment that is already exported, or that is canceled, failed, or archived, is reported as failed rather than logged. Poll GET /v1/batch/{batch_id}/progress, then GET /v1/batch/{batch_id}/results for per-payment outcomes once processing completes.

Authentication

AuthorizationBearer
OAuth2 authentication flows. Auth server URLs will vary by environment

Headers

X-Api-KeystringRequired
API key for authentication
X-API-VersionstringOptional

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Idempotency-KeystringOptionalformat: "^[A-Za-z0-9._\-+=/]{1,128}$"<=128 characters

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Request

This endpoint expects an object.
paymentslist of objectsRequired
Up to 100 payment export errors to report.

Response

Accepted for asynchronous processing.
versionstring
API version of this response
statusstring
Processing status
batch_idstring
Unique identifier for this batch job. Use to poll for progress.
batch_urlstring

URL to poll for batch progress (GET)

results_urlstring

URL to retrieve batch results once completed (GET)

summaryobject
Summary of the submitted request

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error