Payment instructions PDF

View as Markdown

A PDF telling the payer how to fund this route. The URL is short-lived — fetch it when the customer asks rather than storing it.

Authentication

X-API-Keystring
Your partner API key.

Path parameters

routeIdstringRequired
A payment route ULID.

Headers

X-Company-IdstringRequired

The company you are acting for (a company ULID).

Response

OK
urlstringOptionalformat: "uri"

A short-lived link to the generated PDF.

Errors

400
Bad Request Error
404
Not Found Error