Skip to main content

Hubpay Connect Postman collection

Use the customer-ready collection to explore Hubpay Connect without building each request by hand. It is generated from the same OpenAPI specification as the API reference, with authentication and account context prepared for Postman.

Open in PostmanDownload collectionDownload OpenAPI specification

Import the collection​

Download the JSON file above and import it into Postman, or select Import → Link in Postman and paste:

https://docs.hubpay.io/postman/hubpay-connect.postman_collection.json

Importing from the URL makes it easy to repeat the import when the API reference changes. Postman creates a local copy; it does not send credentials to Hubpay during import.

Use the OpenAPI specification​

The downloadable openapi.json file is the OpenAPI 3.1 contract used to generate both the API reference and Postman collection. Import it into Swagger UI, Insomnia or an OpenAPI code generator when you prefer to work directly from the API contract.

The stable URL is:

https://docs.hubpay.io/openapi.json

Configure sandbox access​

  1. Open Hubpay Connect API → Variables.
  2. Set the current value for clientId, clientSecret and accountId using the sandbox credentials supplied by Hubpay.
  3. Run Authentication → Generate JWT access token.
  4. Confirm that the test passed. The request stores the returned token in accessToken for the other requests in the collection.
  5. Choose an endpoint and select Send.

The collection uses https://sandbox-api.hubpay.io by default. Keep production credentials separate and only change baseUrl when you are ready to test production access.

Protect credentials

Use Postman's current values for credentials and tokens. Do not populate shared initial values, export a populated collection or commit credentials to source control.

Get collection updates​

The downloadable collection is regenerated from the published OpenAPI specification on every documentation build. Re-import it when you want the latest endpoints and request schemas.

Troubleshooting​

ProblemCheck
401 UnauthorizedRun Generate JWT access token again and confirm accessToken has a current value.
403 ForbiddenConfirm the credentials have access to the endpoint and environment.
Missing account contextSet accountId; requests that require the AccountId header use this variable automatically.
Request points to the wrong environmentConfirm baseUrl and credentials both belong to sandbox or both belong to production.