Create Payout

post

https://api.stage.localpayment.com/api/payout/

Initiate seamless payouts from your Localpayment account to any beneficiary with a single API call. This endpoint enables you to transfer funds to customers, vendors, or partners by providing essential details including beneficiary information, transfer amount, source account, and concept code. You'll receive immediate confirmation of payout creation or detailed error messages for troubleshooting, streamlining your entire payment workflow while ensuring accurate, timely transfers.

💡
Want to lock an exchange rate before executing the transaction?
Use the Currency Exchange Quote API to generate a rate quote for the currency pair. The response includes an exchangeRateToken pass it in your payout request to lock in that rate. The quoted rate is guaranteed until the token's expirationDate, protecting both you and your user from market fluctuations.

About the comment field

This value is passed through the payment network to the receiving institution. Whether it is displayed to the final recipient depends on the receiving institution and how it presents transaction details.

Visibility	Countries
Confirmed visible to recipient	🇲🇽 Mexico · 🇧🇷 Brazil
Depends on the receiving institution	🇵🇦 Panama · 🇩🇴 Dominican Republic · 🇭🇳 Honduras · 🇨🇷 Costa Rica · 🇨🇱 Chile · 🇵🇪 Peru · 🇧🇴 Bolivia · 🇬🇹 Guatemala

Body Params

externalId

string

required

A unique identifier generated by your system to track the transaction (alphanumeric and hyphens). We recommend using UUID4 to ensure uniqueness.

country

string

enum

required

Your end user's country (i.e. country in which the payment will be processed), in ISO format.

currency

string

enum

required

Specify the currency code. Choose between: (A) the local currency of the selected country or (B) your account's currency. For (A), the customer is charged in their local currency. For (B), the amount is credited to your account, and Localpayment handles the foreign exchange to collect the equivalent local currency amount.

amount

number

required

The transaction amount must be specified as a decimal number using a dot separator, except for CLP (Chilean Peso) which must be provided with no decimal places.

accountNumber

string

required

Localpayment account number in which the amount will be debited.

conceptCode

string

enum

required

Concept code.

paymentMethod

object

required

sender

object

required

Sender's information.

beneficiary

object

required

Beneficiary's information.

merchant

object

required

Merchant's information.

comment

string

Free-text field for additional payment information. Transmitted through the payment network to the receiving institution; visibility to the final recipient depends on the bank. See country details on this page.

requireAuth

boolean

When the value is set to "True", the Authorizer endpoint must be run by Internal ID to update the status to received.

Responses

201Created

401Unauthorized.