Postman
Postman is a powerful tool that simplifies the process of exploring, testing, and integrating with APIs. At Localpayment, we provide a collection of pre-configured requests that allow you to quickly get started and interact with our endpoints without needing to write any code.
This guide walks you through how to use Postman with the Localpayment API, from importing our Postman collection to running your first test transaction.
Import postman collection
To streamline your integration, we provide:
- A Postman collection that includes example requests for operations such as payments, refunds, tokenization, and recurring billing.
- A predefined environment containing common variables such as base url, access token, and placeholder fields for your merchant-specific configuration.
You can import the collection by clicking the following link:
[Postman]
Alternatively, you can download the JSON collection file and import it manually into Postman by selecting File > Import, then choosing the file.
Complete the environment configuration
The imported environment includes placeholder variables that must be customized based on your Localpayment account and the country you're operating in.
Open the Localpayment environment and edit the following variables:
Variable | Description | Example |
---|---|---|
access_token | Your API access token. Generate it from the token request. | Bearer eyJ... |
account_number | The Localpayment account where funds will be deposited | 3.203.200.000.001 |
country | Country where the transaction will take place (ISO 3166-3) | MEX |
currency | Currency of the payment (ISO 4217) | MXN |
Generate your access token
From the collection, run the request named Generate Access Token. If the request is successful, the access token will be automatically extracted from the response and stored in the access_token variable within your environment — so you don’t need to copy or paste it manually. This token will then be used to authorize subsequent API requests.
Note
This token is required in the
Authorization
header of all other requests.
For more details, refer to the Authentication Guide.
Run your first request
Now that your environment is configured, try your first API call.
Go to the Create Payin folder and run one of the available examples, such as:
- Card payment
- Cash payment
- Bank transfer
The request will use your configured variables to simulate a payment. You'll receive a JSON response with a transaction ID, status, and additional payment details.
Explore more endpoints
The collection includes examples for many core features of the Localpayment platform:
- Recurring Payments: Create, update, or cancel subscription billing.
- Refunds: Process full refunds on supported payment methods.
- Tokenization: Tokenize card data for future payments.
- Pre-authorizations: Reserve funds before capture.
- Installments: Quote and process payments in multiple installments.
- Disputes: Receive and respond to chargebacks.
Each request contains helpful comments and placeholder values that you can customize.
Testing safely in sandbox mode
All requests in the collection point to the sandbox environment by default.
You can test payment flows using mock data and test card numbers without real financial impact. This allows you to validate your implementation before going live.
Need Help?
If you run into issues or need help configuring Postman or the API, feel free to reach out to our support team.
Updated 2 months ago