Saltar al contenido principal
POST
Esta solicitud te permite crear un payout para transferir fondos de tu cuenta a otra cuenta o a un destinatario. Se requiere un enrutamiento de payout publicado para el método de payout y el país. Sin uno, la API responde 201 con el status del payout en ERROR.
Guía de métodos de payoutPara ver las pautas de prueba y los detalles de la información del beneficiario que se necesitan para cada integración, consulta la guía de métodos de payout.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Cuerpo

application/json
account_id
string
predeterminado:{{account_id}}
requerido

El identificador único de la cuenta. Encuentras esta información en el dashboard de Yuno (UUID, 36 caracteres.)

merchant_reference
string
predeterminado:test-reference
requerido

El identificador único del payout del comercio (MAX 255; MIN 3).

country
enum<string>
requerido

País donde se debe procesar la transacción (MAX 2; MIN 2; ISO 3166-1).

Opciones disponibles:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
purpose
enum<string>
requerido

Indica el propósito del payout. Valores enum posibles: consulta la lista de propósitos.

Opciones disponibles:
FAMILY_AND_FRIENDS,
PERSONAL_TRANSFER,
REMITTANCES,
PROVIDER_SERVICES,
ADVERTISING_SERVICES,
REPRESENTATION_SERVICES,
ADVISORY_SERVICES,
FREELANCER_SERVICES,
SUPPLIER,
BUSINESS_TO_BUSINESS,
MARKETPLACE,
PAYROLL,
GIFTS_AND_BENEFITS,
EXPENSES,
CORPORATE_PAYMENT,
PURCHASE_OF _PHYSICAL_GOODS,
PURCHASE_OF _DIGITAL_GOODS,
PURCHASE_OF_SERVICES,
INVESTMENTS,
CAPITAL_CONTRIBUTION,
INVESTMENTS_SHARES,
TAXES,
LOGISTICS_AND_TRANSPORTATION,
DELIVERY,
AFFILIATION_PROGRAM,
LOANS,
REAL_STATE,
RENT,
TRAVEL_FLIGHTS,
TRAVEL_ACCOMMODATIONS,
EDUCATION,
TUITION_COSTS,
TRAININGS,
CHARITY,
MEDICAL_SERVICES,
SAVINGS,
RETIREMENT,
PENSION,
INSURANCE,
REWARDS,
TRADEMARKS_AND_COPYRIGHT,
ENTERTAINMENT,
GOVERNMENT,
OTHERS
amount
object
requerido

Especifica el objeto de monto del payout, con el valor y la moneda.

beneficiary
object
requerido

Especifica el objeto del beneficiario con su identificación.

withdrawal_method
object
requerido

El método de retiro para realizar el payout.

description
string

La descripción del payout (MAX 255; MIN 3).

metadata
object[]

Especifica una lista de objetos de metadatos. Puedes agregar hasta 50 objetos de metadatos.

Respuesta

201

id
string
Ejemplo:

"5223d101-0019-43d3-92cb-5c23391a7410"

account_id
string
Ejemplo:

"f7c5fe77-721b-49c2-84d3-957748df3c2c"

status
string
Ejemplo:

"SUCCEEDED"

merchant_reference
string
Ejemplo:

"MR-Test-123"

purpose
string
Ejemplo:

"EXPENSES"

country
string
Ejemplo:

"BR"

description
string
Ejemplo:

"Test"

amount
object
beneficiary
object
metadata
array
created_at
string
Ejemplo:

"2024-05-27T15:12:22.712914616Z"

updated_at
string
Ejemplo:

"2024-05-27T15:12:22.712916116Z"

transactions
object[]