v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Bill Payments

Generate remittance advice

Generate a remittance advice document for a bill payment.

Formats

  • PDF (default): Set Accept header to application/pdf
  • JSON: Set Accept header to application/json
get/bill-payments/{id}/remittance-advice

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Response

Remittance advice generated

paymentDatestring date
paymentMethodstring
referencestring
totalAmountnumber