Skip to main content
Postman

Use the Inttegro API in Postman

Import ready-to-send requests for every public Inttegro API operation. The collections include request examples, shared variables, response checks, and a safe hosted-checkout workflow.

Import and configure

  1. Download and import 00-environment.postman_environment.json.
  2. Import the API-area collections you need, or import all of them.
  3. Select the Inttegro API environment and set api_key locally. The published value is empty and marked secret.
  4. Give idempotency_key a new stable value for each new logical operation. Reuse it only when retrying the same request with the same body.
  5. Replace the example variables required by the request you want to send.

Successful create requests save returned IDs to the selected environment. For example, a customer created in the Customers collection becomes available to Payment Methods and Checkout without copying its ID by hand.

What is available

AreaWhat you can test
Checkout and ordersHosted checkout and the complete order lifecycle
Customers and payment methodsCustomer records and reusable payment methods
Catalog and Purchase intentsProducts, prices, Purchase intents, and Buy links
Money movementFinancial accounts, balances, balance transactions, and payouts
CommunicationsNotifications, schedules, broadcasts, templates, and one-time passwords
FilesFiles, file links, and third-party upload requests
PlatformApps, API keys, and reference data
RefundsRefund creation, lookup, and history

Start with hosted checkout

Import workflows/checkout-quickstart.postman_collection.json and run its two requests in order. It creates a finalized order, captures order_id and checkout_url, and looks the order up. It does not request or confirm payment.

To run the same workflow in CI, provide the key and request-specific values as environment variables and pass them to Newman at runtime:

npx newman run postman/workflows/checkout-quickstart.postman_collection.json \
--environment postman/00-environment.postman_environment.json \
--env-var "api_key=${INTTEGRO_API_KEY}" \
--env-var "base_url=${INTTEGRO_API_BASE_URL}" \
--env-var "order_number=${INTTEGRO_ORDER_NUMBER}" \
--env-var "idempotency_key=${INTTEGRO_IDEMPOTENCY_KEY}" \
--bail

Choose a new order number and idempotency key together for each new checkout. Keep both unchanged when retrying that checkout after a timeout.

Run only the operation you intend

Some collections can send messages, schedule payouts, change settings, cancel resources, or delete files. Do not run every collection indiscriminately against a live account.

Versions

The collection bundle version matches the public API contract version. Postman Collection 2.1 is the file format, not the Inttegro API version. The version is available in each collection's info.version and as collection_version in the shared environment. Pin the bundle's Git commit for repeatable CI.