Skip to main content

Payouts

The Payouts feature allows a Merchant to initiate a payment to a Customer.

This service is currently available for selected Beta Testers, currently offering PIX in Brazil and SPEI in Mexico.

  https://api-sandbox.letpay.io/payoutTransaction

General Structure

All payouts must be sent using the payoutTransactions array, where each object represents an individual transaction.

Common Parameters

FieldTypeRequiredDescription
original_amountDecimalYesAmount to be paid in the original currency.
original_currencyStringYesOriginal currency code (e.g., BRL, MXN).
payment_currencyStringYesCurrency used for the actual payment. Must match the original currency.
payment_countryStringYesCountry of the recipient. Supported values: BR, MX.
payout_methodStringYesPayment method. Supported: PIX (Brazil), SPEI (Mexico).
contract_idUUIDYesIdentifier of the contract to be used for the payout.
reference_idStringYesUnique reference identifier for this transaction.
notification_urlStringYesURL to receive asynchronous status updates.
ttlIntegerNoTime-to-live in seconds. 0 means no expiration.