Create a recipient

post

https://api.balampay.com/sandbox/v1/recipients

Creates a new recipient for payouts. Recipients represent the destination bank accounts or wallets where funds will be sent.

Supported account types:

USD: ACH, WIRE, SWIFT
MXN: SPEI
COP: PSE
LATAM: ARS, BRL, CLP, CRC, DOP, ECUSD, GTQ, PAUSD, PEN, PEUSD, PYG, SVUSD, UYU
Crypto: WALLET (USDC/USDT on Solana, Polygon, TRON)

Authentication: Both x-api-key header and Authorization: Bearer <token> header are required.

Idempotency: Requires an idempotency key in the headers to prevent duplicate recipient creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

user_id

uuid

required

UUID of the user this recipient belongs to

type

string

enum

Recipient type. Defaults to 'individual' if not specified.

Allowed:

first_name

string

First name (required for individual recipients)

middle_name

string

Middle name (optional)

last_name

string

Last name (required for individual recipients)

company_name

string

Company name (required for business recipients)

phone

string

length ≤ 16

Phone number (optional)

string

Email address (optional)

address

object

Recipient's physical address (required for ACH, WIRE, SWIFT accounts)

account

required

Account details. Structure varies by account_type.

Headers

idempotency-key

uuid

required

Unique UUID to ensure idempotent requests

Responses

201Recipient created successfully

202Recipient already exists (idempotent response)

400Bad request - validation error

401Unauthorized - invalid or missing authentication

404User not found

409Conflict - idempotency key already used with different request

500Internal server error