Bank Transfer Payouts

Use this page to create payouts using Bank Transfer, a standard method for sending funds directly to a recipient’s bank account.

• Base URL: https://api.paylander.com/api/v1/payout/
• Endpoint: POST /v1/payout/

Overview

Bank Transfer allows merchants to send payouts to recipients’ bank accounts using basic bank details such as account number and bank code (varies by country).
Processing times depend on the destination bank and region.

Common fields (see Payout API):

• channel (UUID, required)
• amount (object, required)
  • currency (ISO 4217)
  • value (string, required)
• external_id (string, required) → your internal order or payout ID
• description (string, optional)
• payout_method (object, required)

---

payout_method (type: bank_transfer)

Required:

• type → "bank_transfer"
• bank_code → Recipient's bank code (SWIFT, routing code, IFSC, MFO — depends on region)
• bank_name → Name of recipient’s bank
• account_number → Recipient's bank account number
• first_name → Recipient’s first name
• last_name → Recipient’s last name

Optional:

• iban → IBAN (if applicable)
• branch_code → Branch/agency code (if applicable)
• phone → Recipient’s phone number
• email → Recipient’s email

---

Example Request

{
  "channel": "7f9df9e5-1e4d-4a19-9d47-57af564fd810",
  "amount": {
    "currency": "USD",
    "value": "150.00"
  },
  "payout_method": {
    "type": "bank_transfer",
    "bank_code": "BOFAUS3N",
    "bank_name": "Bank of America",
    "account_number": "987654321000",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+12025550123",
    "email": "john.doe@example.com"
  },
  "description": "Withdrawal Payout #20251",
  "external_id": "WITHDRAWAL-20251",
  "callback_url": "https://your-company.com/callback"
}

Example Response

{
  "status": "processing",
  "transaction_id": "b5cff6ed-f3f0-46df-a390-2ffdb11430f4",
  "external_id": null
}

Notes

• Bank Transfer payouts support multiple currencies depending on the channel configuration.
• The status field can be:
  • processing — payout created and awaiting confirmation.
  • completed — funds successfully transferred.
  • failed — payout could not be completed (check logs).
• To query payout status, use GET /api/v1/payout/?channel=<uuid>&transaction_id=<uuid>.

---

Error Handling

See Error Responses for the full list of possible API errors.