Skip to content
/Invoices

API Reference (0.0.1)

Comprehensive reference for integrating with CargoSprint API endpoints

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://cargosprint.com/contact-us/
E-mail
support@cargosprint.com
Terms of Service
Languages
Servers
Mock server
https://developer.cargosprint.com/_mock/sprintpay/openapi
https://{service}-{environment}.cargosprintgroup.com

Oauth

The SprintPay API uses Authorization Tokens to authenticate requests.

SprintPay’s OAuth system that uses a access token that is private and reserved for specific official partnerships. To get set up with access please inquire directly with your SprintPay relationship manager.

This API enables partners to register their own systems or authorized third-party systems to be able to execute actions.

Operations

Facilities

API reference for facilities endpoints and webhooks.

The /get/facilities is an endpoint that allow you to retrieve facilities contacts information on file including Facility Name, Airport Code, Firms Code, Phone, Address, City and Delivery.

Operations

Cart

API reference for cart endpoints and webhooks.

The /post/payments is an endpoint that allow you to manage the end user’s cart, initiate and process the payments to the facilities.

Operations

Invoices

API reference for invoices endpoints and webhooks.

The /post/external/downloadinvoices is an endpoint that allow you to retrieve and manage open and paid invoices. This will be retrieved as an Excel file with information such as Cargo Payment Created Date, Email, Airport Code, Cargo Payment: Payment Reference #, Cargo Facility: Airline Cargo Facility Name, Airline AWB #, Customer Reference #, Cargo Payment: Amount and Total Invoice Amount.

Operations

Get invoices

Request

Download invoices.

Query
downloadFormatstring

Format to download in (e.g. PDF, XLSX).

Example: downloadFormat=XLSX
confirmationIdstring

Payment confirmation id.

Example: confirmationId=kevsdkxb
Headers
x-app-idstring

Encoded customer identifier.

Example: 2ZMEEX2otslHtRRgzQC0tPVwbasC23455vx0k=
curl -i -X POST \
  'https://developer.cargosprint.com/_mock/sprintpay/openapi/external/downloadInvoices?downloadFormat=XLSX&confirmationId=kevsdkxb' \
  -H 'x-app-id: 2ZMEEX2otslHtRRgzQC0tPVwbasC23455vx0k='

Responses

Success.

Bodyapplication/pdf
string(binary)
Response
No content

Payments

API reference for payments endpoints and webhooks.

The /post/external/paymentConfirmation is an endpoint that allows you to retrieve and manage electronic payment confirmations. This will be retrieved as a PDF file or a ZIP with multiple PDF files containing information such as Cargo Payment Created Date, Email, Facility Branch, Cargo Payment: Payment Reference #, Cargo Facility: Airline Cargo Facility Name, Airline AWB #, Customer Reference #, Cargo Payment: Amount and Total Invoice Amount.

Operations