Get money to the people and businesses you need to pay.

# Illustrative request — see docs.localpayment.com for the exact contract curl -X POST https://api.v3.localpayment.com/api/payout/ \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "externalId": "3f9c1b2e-0000-4000-8000-000000000042", "paymentMethod": { "type": "BankTransfer", "code": "0130", "flow": "DIRECT" }, "country": "MEX", "currency": "MXN", "amount": 18400.00, "accountNumber": "<your-account-number>", "conceptCode": "0001", "beneficiary": { "type": "INDIVIDUAL", "name": "Lucía", "lastname": "Méndez", "document": { "type": "RFC", "id": "MEML900101XXX" }, "bank": { "account": { "type": "C", "number": "012180000000000000" } } } }'

# Illustrative request — see docs.localpayment.com for the exact contract
curl -X POST https://api.v3.localpayment.com/api/payout/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "3f9c1b2e-0000-4000-8000-000000000042",
    "paymentMethod": { "type": "BankTransfer", "code": "0130", "flow": "DIRECT" },
    "country": "MEX",
    "currency": "MXN",
    "amount": 18400.00,
    "accountNumber": "<your-account-number>",
    "conceptCode": "0001",
    "beneficiary": {
      "type": "INDIVIDUAL",
      "name": "Lucía",
      "lastname": "Méndez",
      "document": { "type": "RFC", "id": "MEML900101XXX" },
      "bank": { "account": { "type": "C", "number": "012180000000000000" } }
    }
  }'

// Illustrative. Credentials are injected from your secrets manager, never hard-coded. const auth = await fetch('https://api.v3.localpayment.com/api/token/', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ username: process.env.LP_API_USER, password: process.env.LP_API_PASSWORD, }), }); const { access } = await auth.json(); // Send a Pix payout (fields simplified) const res = await fetch('https://api.v3.localpayment.com/api/payout/', { method: 'POST', headers: { Authorization: `Bearer ${access}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ externalId: crypto.randomUUID(), paymentMethod: { type: 'BankTransfer', code: '0031', flow: 'DIRECT' }, // Pix country: 'BRA', currency: 'BRL', amount: 1250.0, accountNumber: process.env.LP_ACCOUNT_NUMBER, conceptCode: '0001', beneficiary: { type: 'INDIVIDUAL', name: 'Marina', lastname: 'Costa', document: { type: 'CPF', id: '000.000.000-00' }, bank: { account: { alias: 'marina.costa@example.com' } }, // Pix key: send alias, omit account type and number }, }), }); const payout = await res.json(); // status.description: INPROGRESS — the final status arrives by signed webhook await savePayout(payout.externalId, payout.internalId);

// Illustrative. Credentials are injected from your secrets manager, never hard-coded.
const auth = await fetch('https://api.v3.localpayment.com/api/token/', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    username: process.env.LP_API_USER,
    password: process.env.LP_API_PASSWORD,
  }),
});
const { access } = await auth.json();

// Send a Pix payout (fields simplified)
const res = await fetch('https://api.v3.localpayment.com/api/payout/', {
  method: 'POST',
  headers: { Authorization: `Bearer ${access}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    externalId: crypto.randomUUID(),
    paymentMethod: { type: 'BankTransfer', code: '0031', flow: 'DIRECT' }, // Pix
    country: 'BRA',
    currency: 'BRL',
    amount: 1250.0,
    accountNumber: process.env.LP_ACCOUNT_NUMBER,
    conceptCode: '0001',
    beneficiary: {
      type: 'INDIVIDUAL',
      name: 'Marina',
      lastname: 'Costa',
      document: { type: 'CPF', id: '000.000.000-00' },
      bank: { account: { alias: 'marina.costa@example.com' } }, // Pix key: send alias, omit account type and number
    },
  }),
});
const payout = await res.json(); // status.description: INPROGRESS — the final status arrives by signed webhook
await savePayout(payout.externalId, payout.internalId);