Home
Release Notes
Home
Release Notes
Linkedin
  1. Home
  • Balad™ Gateway Documentation 📖
  • Get Started
  • Authorization
  • Responses
  • Go Live!
  • FAQs
  • APIs
    • Authentication
      • Token
    • Core
      • Exchange rate
        • Exchange Rates
      • Balance
        • Get Current Balance
      • Secrets
        • Generate Secret
        • Delete Secret
        • Get Secrets
    • Link
      • Sandbox Testing Guide
      • Error Codes
      • Transaction Lifecycle V2
      • Lookups
        • Purposes List
        • Sources List
        • Banks List
        • Relations
      • Transactions
        • Create transaction
        • Update transaction
        • Cancel transaction
        • Get transaction status V2
        • Transactions List
        • Export Transactions List
        • Calculate receiving amount
        • Validate Account
      • Reconciliation
        • Reconciliation
  • Webhooks
    • Link.Transaction.StatusUpdateV2
  1. Home

Authorization

OAuth 2.0 Client Credentials Flow#

Balad™ APIs implement the OAuth 2.0 Client Credentials flow, which is designed for server-to-server authentication. This flow allows your application to request an access token directly using your Client ID and Client Secret without user interaction.
All API calls must include an Authorization header in this format:
Authorization: Bearer <ACCESS_TOKEN>

What You will Need Before You Start#

1
Step 1 — Get Onboarded
Contact the Balad® Support Team to complete the onboarding process and receive your credentials.
2
Step 2 — Get Your Base URL
The Base URL for your APIs will be provided during onboarding.
3
Step 3 — Obtain Your API Keys
After onboarding, you will need to generate client credentials from Dashboard

Generate Client Credentials from Dashboard#

1
Step 1 — Log in to Balad Dashboard
Go to the Balad® Dashboard and sign in using your provided credentials.
2
Step 2 — Navigate to Client Secrets
From the left-hand menu, go to Developer → Client Secrets to manage your client secrets.
Dashboard API Credentials
3
Step 3 — Add Client Secret
Click Add Client Secret, provide a Description and set the Expiration Date, then click Confirm.
Client Secret Screenshot
4
Step 4 — Copy and Store Your Client Secret
Once generated, copy the client secret immediately and store it in a secure location, as it will not be visible again for security reasons.
Copy Secret.jpg
You will use the Client ID and Client Secret when requesting an Access Token for your API requests. Token

🌟 Benefits of OAuth with Balad#

🔐 Secure Access
Every API request is authorized using access tokens, keeping transactions safe.
⚡ Fine-Grained Scopes
Tokens are scoped to specific APIs (remittances, collections, bills, vouchers).
⛓️ Revocable Tokens
Access can be revoked instantly from the Balad dashboard if compromised.
Previous
Get Started
Next
Responses
Built with