Huch API Documentation

Appearance

🚀 Run in Postman (Sandbox) ​

This page explains how to test the HUCH Open Banking API in sandbox using Postman, without writing any code.

Prerequisites ​

  • Postman (Web or Desktop)
  • Sandbox credentials
  • Access to the HUCH API (see Authentication documentation)

Get the Collection ​

The collection and its environments live in the documentation repository under postman/:

FileWhat it is
huch-open-banking.postman_collection.jsonEvery documented endpoint
huch-sandbox.postman_environment.jsonSandbox base URL + credential placeholders
huch-production.postman_environment.jsonProduction base URL + credential placeholders

In Postman choose Import, then drop in the collection file and whichever environment file you need.

How to Use the Collection ​

  1. Import the collection and an environment file (see above)
  2. Select the Huch Sandbox environment
  3. Set the following environment variables with your credentials:
    • client_id
    • client_secret
    • merchant_id
  4. Execute the requests in the recommended order:
    1. 🔐 1. Authentication → /api/oauth2/token
    2. 💳 2. Payments → Create payment → /api/payment
    3. 🔍 2. Payments → Get payment details

The collection wires these together for you:

  • Get access token stores access_token, and the collection sends it as a bearer token on every other request — you never paste a token by hand.
  • Create payment stores the returned payment_id, so Get payment details runs with no editing.
  • Create payout does the same with payout_id.

Re-run Get access token when requests start returning 401 — tokens expire after expires_in seconds.

What's in the Collection ​

FolderRequests
1. AuthenticationGet access token
2. PaymentsCreate payment (basic, custom TTL, forced bank selection, IBAN bank detection); Get payment details
3. Webhook subscriptionsSubscribe, get details, update, delete
4. PayoutsCreate payout (SEPA / EUR), create payout (FPS / GBP), get payout details

💡 To target production, import the Huch Production environment instead — it only differs by base URL.

Available Environments ​

EnvironmentBase URL
Sandboxhttps://api-gateway-sandbox.huch.tech
Productionhttps://api-gateway.huchpay.com

Expected Sandbox Behaviour ​

When testing payments in sandbox:

  • Successful payments remain in processing status
  • Transactions are not automatically marked as PAID
  • No webhook notification is sent automatically
  • Notifications and PAID status must be triggered manually from the backoffice

Refer to Test Data (Sandbox) for bank credentials and detailed behaviour.