El Objeto Payout

Este objeto representa el pago creado después de generar una transacción para transferir fondos desde tu cuenta a otra cuenta o destinatario.

id string
El identificador único del pago (MÁX 64; MÍN 36).
Ejemplo: 5404911d-5df9-429e-8488-ad41abea1a4b

account_id string
El identificador único de la cuenta (MAX 64 ; MIN 36).
Ejemplo: 2404911d-5df9-429e-8488-ad41abea1a4b

status enum
El estado del Pago (MÁX 255; MÍN 3).
Ejemplo: SUCCEEDED

merchant_reference string
El identificador único del pedido del cliente (MÁX 255; MÍN 3).
Ejemplo: 4234

description string
La descripción del pago (MÁX 255; MÍN 3).
Ejemplo: pago del mercado

purpose enum
Indica el propósito del pago.
Posibles valores del enum: Compruebe la lista Propósito.

country enum
País donde se debe procesar la transacción (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

amount objeto

Especifica el objeto de importe de pago, con el valor y la moneda.

value number
El monto del pago (múltiplo de 0.0001).
Ejemplo: 10000

currency enum
La moneda utilizada para realizar el pago (MÁX 3; MÍN 3; ISO 4217).
Posibles valores del enum: Compruebe la referencia del país.

beneficiary objeto

Especifica el objeto beneficiario con su identificación.

merchant_beneficiary_id string
Identificador único del beneficiario definido por el comercio.
Ejemplo: AAAA01

national_entity enum
Tipo de entidad nacional del beneficiario.
Posibles valores de enum: INDIVIDUAL o ENTITY

first_name string
El nombre del beneficiario (MAX 80; MIN 1).
Ejemplo: John

last_name string
El apellido del beneficiario (MAX 80; MIN 1).
Ejemplo: Doe

legal_name string
El nombre del beneficiario (Max: 80). Solo es necesario cuando national_entity es ENTITY.
Ejemplo: Arcos dorados SA

email string
El email del beneficiario (MAX 255; MIN 3).
Ejemplo: [email protected]

country enum
El país del beneficiario (MAX 2; MIN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

date_of_birth date
La fecha de nacimiento del beneficiario en formato AAAA-MM-DD (MAX 10; MIN 10).
Ejemplo: 1990-02-28

document objeto

Especifica el objeto del documento del beneficiario, incluidos su número y tipo.

document_number string
El número de documento del beneficiario (MAX 40; MIN 3).
Ejemplo: 1093333333

document_type enum
El tipo de documento del beneficiario (MAX 6, MIN 2).
Posibles valores del enum: Compruebe la referencia del país.

phone objeto

Especifica el objeto de número de teléfono del beneficiario.

country_code string
El código de llamada del país del teléfono del beneficiario (MAX 3; MIN 1). Valores posibles: Compruebe el Referencia de país.
Ejemplo: 57

number string
El número de teléfono del beneficiario, sin el prefijo del país (MAX 32; MIN 1).
Ejemplo: 3132450765

address objeto

Especifica el objeto de dirección del beneficiario.

address_line_1 string
Línea de la dirección principal del beneficiario (MAX 255; MIN 3).
Ejemplo: Calle 34 # 56 - 78

address_line_2 string
Línea de dirección secundaria del beneficiario (MAX 255; MIN 3).
Ejemplo: Apartamento 502, Torre I

city string
La ciudad considerada para el domicilio del beneficiario (MAX 255; MIN 3).
Ejemplo: Bogotá

country enum
El país de la dirección del beneficiario (MAX 2; MIN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

state string
Dirección del estado o provincia del beneficiario (MAX 255; MIN 3).
Ejemplo: Cundinamarca

zip_code string
El código postal considerado para la dirección del beneficiario (MAX 11; MIN 4).
Ejemplo: 111111

withdrawal_method objeto

Especifica el objeto retiro_método del beneficiario.

type enum
El tipo de withdrawal_method.
Ejemplo: ASTROPAY_WALLET

provider_id enum
El proveedor con el que procesar el pago.
Ejemplo: ASTROPAY

vaulted_token string
El token vaulted representa un método de pago almacenado de forma segura. Principalmente para tarjetas de crédito o débito en los pagos.
Ejemplo: 41032411d-5df9-429e-1238-ad41abea1cft

original_transaction_id string
Id de la operación de pago a la que se hace referencia. Solo para pagos con TARJETA. (MÁXIMO 64; MÍNIMO 36).
Ejemplo: 9104911d-5df9-429e-8488-ad41abea1a4b

on_hold bool
Define si el comerciante desea retener el pago y lo configura para que se procese más tarde mediante el punto final Liberar pago. Falso de forma predeterminada.
Ejemplo: falso

detail objeto

Especifica los detalles del método de retiro.

bank_transfer objeto

Especifica el objeto retiro_método del beneficiario.

code string
El código de la entidad financiera del beneficiario (MAX 3; MIN 3).
Ejemplo: 246

branch string
La sucursal de la institución financiera específica del beneficiario (MAX 3; MIN 3).
Ejemplo: XXX

branch_digit string
El dígito de la sucursal de la institución financiera específica del beneficiario (MAX 3; MIN 3).
Ejemplo: 123

account objeto

Especifica el objeto de cuenta bank_transfer del beneficiario.

number string
Número de cuenta de la institución financiera del beneficiario o alias de la cuenta de la institución financiera, como Clabe para MX (MAX 255; MIN 3).
Ejemplo: 1093333333

digit string
Dígito de la cuenta de la institución financiera del beneficiario (MAX 3; MIN 1).
Ejemplo: 123

type enum
Tipo de cuenta del beneficiario (MAX 255; MIN 3).
Posibles valores de enum: CHECKINGS, SAVINGS, VISTA, PIX_EMAIL, PIX_PHONE, PIX_DOCUMENT_ID, PIX_BANK_ACCOUNT

address objeto

Especifica el objeto de dirección del beneficiario.

address_line_1 string
Línea de la dirección principal del beneficiario (MAX 255; MIN 3).
Ejemplo: Calle 34 # 56 - 78

address_line_2 string
Línea de dirección secundaria del beneficiario (MAX 255; MIN 3).
Ejemplo: Apartamento 502, Torre I

city string
La ciudad considerada para el domicilio del beneficiario (MAX 255; MIN 3).
Ejemplo: Bogotá

country enum
El país de la dirección del beneficiario (MAX 2; MIN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

state string
Dirección del estado o provincia del beneficiario (MAX 255; MIN 3).
Ejemplo: Cundinamarca

zip_code string
El código postal considerado para la dirección del beneficiario (MAX 11; MIN 4).
Ejemplo: 111111

wallet objeto

Especifica el objeto retiro_método del beneficiario.

code string
El código de billetera del beneficiario (MAX 3; MIN 3).
Ejemplo: 246

email string
El correo electrónico de billetera específico del beneficiario (MAX 3; MIN 3).
Ejemplo: [email protected]

country enum
El país de la billetera del beneficiario (MAX 2; MIN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

document objeto

Especifica el objeto del documento del beneficiario, incluidos su número y tipo.

document_number string
El número de documento del beneficiario (MAX 40; MIN 3).
Ejemplo: 1093333333

document_type enum
El tipo de documento del beneficiario (MAX 6, MIN 2).
Posibles valores del enum: Compruebe la referencia del país.

phone objeto

Especifica el objeto de número de teléfono del beneficiario.

country_code string
El código de llamada del país del teléfono del beneficiario (MAX 3; MIN 1). Valores posibles: Compruebe el Referencia de país.
Ejemplo: 57

number string
El número de teléfono del beneficiario, sin el prefijo del país (MAX 32; MIN 1).
Ejemplo: 3132450765

transactions array de objects

Especifica una lista de objetos de pagos.

id string
El identificador único para la intención de pago (MAX 64; MIN 36).
Ejemplo: 9104911d-5df9-429e-8488-ad41abea1a4b

type enum
El tipo de intento de pago (MAX 255; MIN 3).

status enum
El estado de intención del pago (MAX 255; MIN 3).

response_code enum
El código de respuesta indica el estado de la solicitud de intento de pago (MAX 255; MIN 3).

merchant_reference string
La identificación de la transacción de pago definida por el comerciante (MAX 255; MIN 3).
Ejemplo: AAB01-432245

amount objeto

Especifica el objeto de importe de pago, con el valor y la moneda.

value number
El monto del pago (múltiplo de 0.0001).
Ejemplo: 10000

currency enum
La moneda utilizada para realizar el pago (MÁX 3; MÍN 3; ISO 4217).
Posibles valores del enum: Compruebe la referencia del país.

purpose enum
Especifica el propósito del pago.

description string
Descripción del pago (MAX 255; MIN 3).
Ejemplo: Salario

provider_data objeto

Especifica el proveedor de datos.

id enum
La identificación del proveedor de datos.
Valores posibles: ADDI, MERCADO_PAGO, SPINPAY, WOMPI

transaction_id string
El identificador único del pago del proveedor.
Ejemplo: 12345678

account_id string
La identificación de la cuenta del proveedor de pago del comerciante.
Ejemplo: 9990128

status string
Estado del proveedor de la transacción (MAX 255; MIN 3).
Ejemplo: accredited

status_detail string
El estado detallado de la transacción del proveedor de datos (MAX 255; MIN 3).
Ejemplo: approved

raw_response string
La respuesta sin procesar del proveedor de datos. El formato depende de la respuesta del proveedor.
La respuesta variará para cada proveedor de datos.

created_at marca de tiempo
Fecha de creación de transacciones (MAX 27; MIN 27, ISO 8601).
Ejemplo: 2022-05-09T20:46:54.786342Z

updated_at marca de tiempo
La última fecha de actualización de transacciones (MAX 27; MIN 27, ISO 8601).
Ejemplo: 2022-05-09T20:46:54.786342Z

metadata array de objects

Especifica una lista de pares clave-valor personalizados asociados al pago (para referencias internas, reconciliación o etiquetas de flujo de trabajo). Puedes añadir hasta 50 objetos de metadatos.

metadata object objeto

Especifica una clave de metadatos y el valor respectivo.

Se utiliza para adjuntar un contexto definido por el comerciante (por ejemplo: batch_id, payout_reason). Evita enviar datos sensibles o personales.

key string
La clave de metadatos (MAX 48 ; MIN 1).
Ejemplo: order_id

value string
El valor de la clave de metadatos (MAX 512 ; MIN 1).
Ejemplo: AA001

created_at marca de tiempo
Fecha de creación de transacciones (MAX 27; MIN 27, ISO 8601).
Ejemplo: 2022-05-09T20:46:54.786342Z

updated_at marca de tiempo
La última fecha de actualización de transacciones (MAX 27; MIN 27, ISO 8601).
Ejemplo: 2022-05-09T20:46:54.786342Z