Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Path Parameters

invoiceId
string
required

Response

OK

invoiceId
string
required

The invoice ID.

hostedInvoiceUrl
string<uri>
required

The public payer page URL for this invoice.

manualTransfer
object
required

Wire and ACH instructions for the invoice account.

referenceIdentifier
string

The per-invoice wire or ACH reference identifier shown with manual transfer instructions. Omitted when the invoice has none.

cryptoDeposit
object

Cryptocurrency deposit instructions. Omitted when crypto deposit is not enabled for the invoice.