Streamline your API testing and integration with Localpayment's official Postman collection. This comprehensive collection provides pre-configured requests for all our endpoints, making it easy to explore, test, and understand our API without writing any code.
What is Postman?
API Development Platform
Postman is a collaborative platform for API development that simplifies building, testing, and documenting APIs
No-Code Testing
Test API endpoints visually with pre-built requests, environments, and automated workflows
Key Postman features
- Collections: Organize API requests into folders and share them with your team
- Environments: Manage different configurations (stage vs production) with variables
- Automated Testing: Write and run tests to validate API responses automatically
New to Postman? Download Postman for free and check out their learning center for comprehensive tutorials.
Get Started with Postman Collection
Download the Collection
Get the latest version of our Postman collection:
Or download the JSON file directly:
Import into Postman
Option 1: Direct Import
- Click the "Run in Postman" button above
- Postman will open and prompt you to import the collection
Option 2: Manual Import
- Open Postman
- Click Import in the top-left corner
- Drag and drop the downloaded JSON file or select it from your computer
- Click Import to add the collection to your workspace
Set Up Environment
Import our pre-configured environment template:
This includes all necessary variables for testing with Localpayment APIs.
Environment Configuration
The Localpayment environment contains essential variables that need to be configured for your testing scenarios. Update these values in your Postman environment before making requests.
Environment Variables
| Variable | Description | Example Value | Required |
|---|---|---|---|
accountNumber | Localpayment account number where the operation is performed | 3.203.200.000.001 | Yes |
baseUrl | API environment URL (stage or production) | https://api.stage.localpayment.com | Yes |
userName | Username for token generation requests | your_username | Yes |
password | Password for token generation requests | your_password | Yes |
accessToken | Bearer token for API authentication (auto-filled from token requests) | Bearer eyJhbGciOiJ... | No |
refreshToken | Refresh token for obtaining new access tokens | eyJhbGciOiJ... | No |
country | Country code for operations (ISO 3166-1 alpha-3) | MEX | Yes |
externalId | UUID4 identifier auto-generated by Postman | f47ac10b-58cc-4372-a567-0e02b2c3d479 | No |
internalId | Internal transaction identifier (auto-filled by API responses) | 0dcf3970-006a-46e8-b914-f3853abc3cf3 | No |
currency | Currency code for operations (ISO 4217) | MXN | Yes |
conceptCode | Predefined concept code from Localpayment's concept list | 0001 | Yes |
Configure Your Environment
- In Postman, click Environments in the sidebar
- Select Localpayment Environment
- Update the Current Value for each variable with your actual credentials
- Make sure the environment is selected in the top-right dropdown
Collection Structure
Our Postman collection is organized by product and functionality for easy navigation:
Localpayment API
├── Before a payment
│ ├── Authentication
│ ├── Validation Services
│ └── Resources
├── Payins
│ ├── Cards
│ ├── Virtual Accounts
│ └── Subscriptions
├── Payouts
└── Treasury & FX
├── FX Services
├── Reports
└── Transactions