Skip to content
/Invoices

Invoices

Retrieve invoice details and download invoices as PDF or XLSX.

Operations

Get Invoice Details

Request

Retrieve invoice details for a transaction. Invoices are produced on the nightly billing cycle, so an invoice may not be available immediately after a payment.

Security
bearerAuth and appId
Query
confirmationsIdstringrequired

Transaction identifier returned by the payment request. Note the plural spelling — the invoice endpoints use confirmationsId while /external/paymentConfirmation uses confirmationId. Both accept the same identifier.

Example:confirmationsId=spf_81660037
curl -i -X GET \
  'https://developer.cargosprint.com/_mock/sprintpay/openapi/external/invoices/details?confirmationsId=spf_81660037' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-APP-ID: YOUR_API_KEY_HERE'

Responses

Invoice details.

Bodyapplication/json
property name*anyadditional property
Response
{
  "id": 15304166,
  "name": "INV15304166",
  "amount": 500,
  "status": "OPEN"
}