Skip to main content
GET
Poll invoice status

Overview

Use this endpoint to get the latest invoice status and any associated payment/settlement summaries.

Authentication

  • Merchant server auth: x-api-key or Authorization: Bearer <jwt>

Request

SDK

cURL

Response

Errors

  • 400 invalid invoice id
  • 401 missing/invalid merchant auth
  • 404 invoice not found

Examples

Poll until the invoice is terminal:
Next: List merchant tokens

Authorizations

x-api-key
string
header
required

API key for server-to-server operations (scope=merchant or commerce)

Path Parameters

invoiceId
string<uuid>
required

Invoice ID

Response

Invoice status retrieved successfully

object
string
Example:

"invoice_status"

invoice
object

Canonical invoice object (snake_case, usd_millis amounts).

latest_payment
object | null

Canonical invoice_payment object (merchant surfaces include settlement fields; payor surfaces strip them).