1. Getting Started
  2. Postman Setup

To facilitate testing and exploration of the Remitian Public API, we provide a pre-configured Postman collection. Follow these steps to set it up:


​
Prerequisites

  • Postman Installed: Download and install Postman from postman.com/downloads
  • API Credentials: Have your credentials ready (received from support team)

​
Setup Instructions

​
1. Download Collection Files

​
2. Import into Postman

  1. Open Postman
  2. Click “Import” in the top-left corner
  3. Select the downloaded collection and environment files
  4. Both files will be imported into your workspace
Postman Collection Example

​
3. Configure Environment Variables

  1. In Postman, navigate to the “Environments” tab
  2. Select the imported Remitian environment
  3. Update the following variables with your credentials:
VariableDescriptionExample
externalIntegratorIdYour External Integration ID019bc3f4-d65e-73f7-8133-f5800e825509
clientApplicationIdYour Client Application ID019b2952-c553-7a93-ba57-d3baf8e09cb0
apiSecretYour API Secretsec_8499e437...
apiKeyYour API Keyapi_019bc3f4...
apiScopeToken scope for the access token requestall
firm:{firmId}
firm:{firmId}:firmUser:{firmUserId}
taxpayer:{taxpayerId}
apiUrlEnvironment base URLSandbox: https://public-api.sandbox.remitian.com
Production: https://public-api.remitian.com

Important: Start with the Sandbox environment (https://public-api.sandbox.remitian.com) to test your integration safely.

​
4. Authenticate

  1. In the collection, find the “Get Access Token” request
  2. Click “Send” to execute the request
  3. The access token will be automatically stored in your environment variables
  4. All subsequent requests will use this token for authentication

​
5. Verify Setup

  1. Find the “Health Check” request in the collection
  2. Click “Send” to test the API connection
  3. You should receive a successful response confirming your setup is working

​
Collection Structure

The Postman collection includes organized folders for:

  • Authentication - Token management requests
  • Firms - Create, and read firms
  • Firm Users - Create and read firm users
  • Taxpayers - Manage taxpayer information
  • Tax Entities - Manage tax entities associated with taxpayers
  • Tax Accounts - Manage tax accounts associated with taxpayers & tax entities
  • Tax Identity Verifications - List connection types and create, get and list tax identity verifications of tax entities
  • Bank Accounts - Manage bank accounts associated with taxpayers
  • Payment Types - List the available payment types
  • Tax Payments - Schedule and manage tax payments
  • Tax Payment Batches - Submit tax payment batches and read their items
  • Tax Forms - Import tax forms and manage their status

​
Need Help?

Our support team is here to assist you:

For detailed API documentation, see our Authentication Guide and Use Cases.