- Getting Started
- Getting Started Guide
Getting Started
Getting Started Guide
Set up your account and make your first request to the Remitian Public API.
This guide will walk you through the process of setting up your account and making your first API request to the Remitian Public API.
βStep 1: Request API Access
Account creation is currently managed through our support team to ensure secure onboarding.
To request access:
- Send an email to support@remitian.com
- Include the following information:
- Your company name
- Primary use case for the API
- Expected integration timeline
- Technical contact details
Response Time: Our support team typically responds within 1-2 business days.
βStep 2: Sign Up to the Developer Portal
Once your access is aligned with our team, youβll receive an email invitation to sign up to the Developer Portal. From there, everything is self-service: manage your credentials, team members, firm access, webhook configuration, and IP allowlist.
βπ External Application ID
A unique identifier for your application in the Remitian platform, provided during onboarding.
βπ Client Application Credentials
Create a Client Application in the Developer Portal to generate the credentials needed to authenticate your API requests:
- Client ID
- Client Secret
- API Key
Self-Service Credentials: Credentials are generated, copied, and regenerated directly in the Developer Portal β they are never sent by email. Members with the Editor role can rotate them at any time.
Important: Store the Client Secret securely. Never commit it to version control or expose it in client-side code.
βStep 3: Set Up Your Environment
βChoose Your Environment
Remitian provides two environments for development and production:
| Environment | Purpose | Base URL |
|---|---|---|
| Sandbox | Development & Testing | https://public-api.sandbox.remitian.com |
| Production | Live Applications | https://public-api.remitian.com |
Tip: Always start with the Sandbox environment to test your integration before moving to Production.
Learn more in our Environments Guide.
βStep 4: Authenticate Your Requests
All API requests require authentication using your credentials.
Authentication Steps:
- Use your Client Application credentials to authenticate
- Include the required authentication headers in your API requests
- Ensure your credentials are kept secure at all times
For detailed authentication instructions and examples, see our Authentication Guide.
βStep 5: Make Your First API Request
βExample: Health Check Endpoint
curl -X GET "https://public-api.sandbox.remitian.com/v1/health" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "x-api-key: YOUR_API_KEY"
βPostman Collection
We provide a pre-configured Postman collection to help you get started quickly:
- Download our Postman Collection
- Import it into Postman
- Configure your credentials in the collection variables
- Start making requests
βTry It in the API Reference
You can also call the endpoints without leaving the docs. Every page of the API Reference has a Try it panel that sends the request to Sandbox and shows the response.
βNext Steps
Now that youβre set up, explore these resources:
- π Environments - Understand sandbox vs production
- π Authentication - Detailed guide on securing your API requests
- π§ͺ Postman Collection - Test API endpoints interactively
- π€ Use the Docs with AI - Connect your AI assistant to these docs through MCP
- π Use Cases - Real-world integration scenarios with step-by-step examples
- π οΈ Developer Portal - Manage credentials, webhooks, firm access, IP allowlisting, and your team
- π Webhooks - Receive real-time event notifications
βNeed Help?
Our support team is here to assist you:
- Email: support@remitian.com
- Response Time: Within 1-2 business days
Ready to build something amazing? Letβs get started! π