El objeto de enlace de pago

Atributos

Este objeto representa un enlace de pago que se puede asociar con un cliente.

id string
El identificador único del cliente (MÁX 64 ; MÍN 36).
Ejemplo: 8546df3a-b83e-4bb5-a4b3-57aa6385924f

account_id string
El identificador único de la cuenta (MÁX 64; MÍN 36).
Ejemplo: 9104911d-5df9-429e-8488-ad41abea1a4b

description string
La descripción del enlace de pago (MAX 255; MIN 3).
Ejemplo: pago del mercado

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.

status enum
El estado del enlace de Pago (MAX 255; MIN 3) (CREATED, USED, CANCELED, EXPIRED, ERROR).
Ejemplo: ACTIVO

merchant_order_id string
Identificación del enlace de pago (MAX 255; MIN 3).
Ejemplo: 432245

created_at marca de tiempo
La fecha y hora en que se creó el enlace de pago.
Ejemplo: 2022-05-09T20:46:54.786342Z

updated_at marca de tiempo
La fecha y hora de la última actualización del enlace de pago.
Ejemplo: 2022-05-09T20:46:54.786342Z

capture boolean
Decide si autorizar el pago o capturarlo. Autorizar un pago con tarjeta te permite reservar fondos en la cuenta bancaria de un cliente. Si el campo no se envía, lo tomaremos como verdadero. Posteriormente puedes capturar el pago mediante el panel de control de Yuno o Método API.
Ejemplo: verdadero

amount objeto

Especifica el objeto monto del pago, incluyendo su importe y moneda.

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.

value number
Monto del pago (múltiplo de 0,0001).
Ejemplo: 12100,00

customer_payer objeto

Especifica el objeto de cliente para los enlaces de pagos.

id string
El identificador único del cliente en plataforma Yuno (MAX 255; MIN 3).
Ejemplo: faa89e18-5a11-11ed-9b6a-0242ac120002

customer_id string
El identificador único del cliente en el comercio externo (MÁX 255; MÍN 3).
Ejemplo: 23456

first_name string
El nombre del cliente (MÁX 255; MÍN 3).
Ejemplo: John

last_name string
El apellido del cliente (MÁX 255; MÍN 3).
Ejemplo: Doe

gender enum
El sexo del cliente (MÁX. 2; MÍN. 1; (M=Hombre/F=Mujer/NA=No aplicable/NK=No conocido)).
Posibles valores de enum: M, F, NA, o NK.

date_of_birth string
La fecha de nacimiento del cliente en el formato AAAA-MM-DD (Longitud: 10).
Ejemplo: 1990-02-28

email string
El e-mail del cliente (MÁX 255; MÍN 3).
Ejemplo: [email protected]

nationality enum
La nacionalidad del cliente (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

document objeto

Especifica el objeto de documento del cliente, incluido su número y tipo.

document_number string
El número de documento del cliente (MÁX 40; MÍN 3).
Ejemplo: 1093333333

document_type enum
El tipo de documento del cliente (MÁX 6, MÍN 2).
Posibles valores del enum: Compruebe la Referencia del país.

phone objeto

Especifica el objeto de teléfono del cliente, incluidos el número y el código.

number string
El número de teléfono del cliente (MAX 40; MIN 3).
Ejemplo: 11992149494

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

billing_address objeto

Especifica el objeto de dirección de facturación del cliente.

address_line_1 string
La línea de dirección de facturación principal del cliente (MÁX 255; MÍN 3).
Ejemplo: Calle 34 # 56 - 78

address_line_2 string
La línea de dirección de facturación secundaria del cliente (MÁX 255; MÍN 3).
Ejemplo: Apartamento 502, Torre I

city string
La ciudad considerada para la dirección de facturación (MÁX 255; MÍN 3).
Ejemplo: Bogotá

country enum
El país considerado para la dirección de facturación (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

state string
El estado considerado para la dirección de facturación (MÁX 255; MÍN 3).
Ejemplo: Cundinamarca

zip_code string
El código postal considerado para la dirección de facturación (MÁX 11; MÍN 4).
Ejemplo: 111111

shipping_address objeto

Especifica el objeto de dirección de envío del cliente.

address_line_1 string
La línea de dirección de envío principal del cliente (MÁX 255; MÍN 3).
Ejemplo: Calle 34 # 56 - 78

address_line_2 string
La línea de dirección de envío secundaria del cliente (MÁX 255; MÍN 3).
Ejemplo: Apartamento 502, Torre I

city string
La ciudad considerada para la dirección de envío (MÁX 255; MÍN 3).
Ejemplo: Bogotá

country enum
El país considerado para la dirección de envío (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

state string
El estado considerado para la dirección de envío (MÁX 255; MÍN 3).
Ejemplo: Cundinamarca

zip_code string
El código postal considerado para la dirección de envío (MÁX 11; MÍN 4).
Ejemplo: 111111

additional_data objeto

Especifica el objeto additional_data. Este objeto no es obligatorio. Sin embargo, si envía esta información, la experiencia de pago será mejorada para su usuario.

airline objeto

Especifica el objeto de la línea aérea. Los pasajeros y los billetes deben tener la misma información de pedido.

pnr string
Registro de nombre de pasajero (MÁX 10; MÍN 1).
Ejemplo: 1P-2UUGJW

legs array de objetos

Especifica el array de objetos de piernas.

arrival_airport string
Código de aeropuerto IATA (MÁX 3; MÍN 3). Ver http://www.iata.org.
Ejemplo: MAM

base_fare float
El importe de la transacción, excluidos impuestos y tasas, la unidad monetaria más pequeña (múltiplo de 0.0001).
Ejemplo: 23.5676

base_fare_currency string
La moneda utilizada para el monto de la transacción (MÁX 3; MÍN 3; ISO 4217).
Ejemplo: Compruebe la referencia del país.

carrier_code string
Código de operador IATA (MÁX 2; MÍN 2). Ver http://www.iata.org.
Ejemplo: KL

departure_airport string
Código IATA (MÁX 3; MÍN 3). Ver http://www.iata.org.
Ejemplo: EZE

departure_airport_timezone string
Zona horaria del aeropuerto (MÁX 6; MÍN 6).
Ejemplo: -03:00

departure_datetime marca de tiempo
La fecha y hora de salida en hora local en el aeropuerto de salida.
Ejemplo: 2022-05-09T20:46:54.786342Z

fare_basis_code string
El código de tarifa base proporciona información específica sobre la tarifa además del servicio de clase, ambos necesarios para la reserva (MAX 15; MIN 1).
Ejemplo: HL7LNR

fare_class_code string
El código de clase de tarifa de la línea aérea (MAX 1; MIN 1). Los valores pueden ser una letra (A-Z) pero pueden variar dependiendo de la definición de la aerolínea.
Ejemplo: C

flight_number string
El número de vuelo asignado por la aerolínea (MÁX 5; MÍN 1).
Ejemplo: 842

stopover_code string
El código de escala (código de 1 letra que indica si el pasajero está autorizado a hacer una escala. Sólo se permiten dos tipos de caracteres O: Escala autorizada (la letra "O", no cero) / X: Escala no permitida).
Ejemplo: O

passengers array de objects

Especifica la matriz de objetos que representa a los pasajeros asociados a los billetes.

document objeto

Especifica el objeto de documento para el pasajero.

document_number string
El número de documento del pasajero (MÁX 40; MÍN 3).
Ejemplo: 1093333333

document_type enum
El tipo de documento del pasajero (MÁX 6, MÍN 2).
Posibles valores del enum: Compruebe la Referencia del país.

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

date_of_birth string
La fecha de nacimiento del pasajero en formato AAAA-MM-DD (MÁX 10; MÍN 10).
Ejemplo: 1990-02-28

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

first_name string
El nombre del pasajero (MÁX 255; MÍN 3).
Ejemplo: John

last_name string
El apellido del pasajero (MÁX 255; MÍN 3).
Ejemplo: Doe

loyalty_number string
Número de programa de fidelización de pasajeros (MÁX 20, MÍN 1).
Ejemplo: 254587547

loyalty_tier enum
Nivel del programa de fidelización de pasajeros (MÁX 255; MÍN 3).
Posibles valores del enum: Comprueba el Nivel de fidelidad.

middle_name string
El segundo nombre del pasajero (MÁX 255; MÍN 3).
Ejemplo: Carlos

nationality enum
La nacionalidad del pasajero (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

type enum
El tipo de pasajero (MÁX 1; MÍN 1).
Posibles valores del enum: Compruebe la lista de tipos de pasajero.

tickets array de objects

Especifica la matriz de boletos asociados con los pasajeros.

ticket_number string
Numero del billete (MÁX 14; MÍN 1).
Ejemplo: 7411823255523

e_ticket boolean
¿Es esto un billete electrónico?
Valores posibles: True o False

restricted boolean
Indica si el billete es reembolsable o no.
Valores posibles: True o False

total_fare_amount float
Importe total de la tarifa en la unidad monetaria más pequeña (múltiplo de 0,0001).
Ejemplo: 80000

total_tax_amount float
Importe total de los impuestos en la unidad monetaria más pequeña (múltiplo de 0,0001).
Ejemplo: 14800

total_fee_amount float
Importe total de la tarifa en la unidad monetaria más pequeña (múltiplo de 0,0001).
Ejemplo: 25200

issue objeto

Especifica el objeto en cuestión

address string
Dirección del agente que vendió el billete (MÁX 255; MÍN 3).
Ejemplo: Apartamento 502, Torre I

carrier_prefix_code string
Transportista emisor o validador. Se trata del prefijo AWB (Air waybill) código IATA de 3 cifras (MAX 3; MIN 3).
Ejemplo: 044

city string
Nombre de la ciudad del agente que vendió el boleto (MÁX 255; MÍN 3).
Ejemplo: Bogotá

country enum
Código del país donde se emitió el billete (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe el código de país de la lista.

date string
Fecha de emisión del billete.
Ejemplo: 1979-01-12

travel_agent_code string
Código de la agencia de viajes que emite el billete.
Ejemplo: 10655823

travel_agent_name string
Nombre con el que aparece el punto de venta en la lista de agencias o nombre de la franquicia (MAX 32; MIN 1).
Ejemplo: Agencia ACME Inc

order objeto

Especifica el objeto de orden.

fee_amount float
El importe de la tarifa del pedido (múltiplo de 0,0001).
Ejemplo 1

shipping_amount float
El importe de envío del pedido (múltiplo de 0,0001).
Ejemplo 1

items array de objetos

Especifica el objeto del elemento.

id string
El identificador único del elemento (MÁX 255; MÍN 3).
Ejemplo: 3214

name string
El nombre del elemento (MÁX 255; MÍN 3).
Ejemplo: iPhone 12 Pro Max

quantity int
La cantidad del artículo (MÁX 999; MÍN 1).
Ejemplo 1

unit_amount float
El importe unitario del artículo (múltiplo de 0,0001).
Ejemplo: 550

category string
La categoría del artículo (MÁX 255; MÍN 3).
Valores posibles: Compruebe la Lista de categorías de artículos.

brand string
La marca del artículo (MÁX 255; MÍN 3).
Ejemplo: manzana

sku_code string
La unidad de mantenimiento de existencias (SKU) del artículo (MÁX 255; MÍN 3).
Ejemplo: A2342

manufacture_part_number string
El número de pieza de fabricación del artículo (MÁX 255; MÍN 3).
Ejemplo: 345621234

picture_url string
La imagen del artículo (MAX 255; MIN 3).
Ejemplo: https://www.merchant_url.com/items/:id

seller_details objeto

Especifica el objeto de detalles del vendedor.

name string
El nombre legal del vendedor (MÁX 255; MÍN 3).
Ejemplo: John Doe

email string
El e-mail del vendedor (MÁX 255; MÍN 3).
Ejemplo: [email protected]

reference string
El código de identificación del vendedor (MÁX 255; MÍN 3).
Ejemplo: Vendedor

website string
La URL del sitio web del vendedor (MÁX 255; MÍN 3).
Ejemplo: https://www.test.com/1231324

industry enum
La industria del vendedor (MÁX 255; MÍN 3).
Posibles valores del enum: Compruebe la categoría Industria.

country enum
El país del vendedor (MÁX 255; MÍN 3).
Posibles valores del enum: Compruebe la lista de códigos de país.

document objeto

Especifica el objeto del documento del vendedor.

document_number string
El número de documento del vendedor (MÁX 40; MÍN 3).
Ejemplo: 1093333333

document_type enum
El tipo de documento del vendedor (MÁX 6, MÍN 2).
Posibles valores del enum: Compruebe la Referencia del país.

phone objeto

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

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

number string
El número de teléfono del vendedor, sin el código de país (MÁX 32; MÍN 1).
Ejemplo: 3132450765

address objeto

Especifica el objeto de dirección del vendedor.

address_line_1 string
La línea de dirección principal del vendedor (MÁX 255; MÍN 3).
Ejemplo: Calle 34 # 56 - 78

address_line_2 string
La línea de dirección de facturación secundaria del vendedor (MÁX 255; MÍN 3).
Ejemplo: Apartamento 502, Torre I

city string
La ciudad considerada para la dirección del vendedor (MÁX 255; MÍN 3).
Ejemplo: Bogotá

country enum
El país considerado para la dirección del vendedor (MAX 2; MIN 2,ISO 3166-1).
Posibles valores del enum: Compruebe el código de país de la lista.

state string
El estado considerado para la dirección del vendedor (MÁX 255; MÍN 3).
Ejemplo: Cundinamarca

zip_code string
El código postal considerado para la dirección del vendedor (MÁX 11; MÍN 4).
Ejemplo: 111111

taxes array de objects

Especifica el objeto de impuestos del pedido.

type string
Tipo del impuesto.
Ejemplo: VAT

tax_base float
El importe base para aplicar el impuesto definido.
Ejemplo: 10000

value float
El monto del impuesto.
Ejemplo: 2100

percentage float
El porcentaje del impuesto.
Ejemplo: 21

one_time_use boolean
Enlace único: Para un único cobro con información definida de producto, importe y cliente.
Enlace múltiple: Para usar y compartir tantas veces como sea necesario, con cantidad y producto definidos.

Opciones: false permite un solo uso, true múltiples pagos.

availability objeto

Especifica el objeto de disponibilidad. Se refiere a la fecha de caducidad pago Enlace.

start_at marca de tiempo
Inicio del periodo de validez del enlace de pago.
Ejemplo: 2022-05-09T20:46:54.786342Z

finish_at marca de tiempo
Fin del periodo de validez del enlace de pago.
Ejemplo: 2022-05-09T20:46:54.786342Z

callback_url string
URL para redirigir a su cliente después del pago (MAX 255; MIN 3).
Ejemplo: https://www.your-site.com/

redirect_url string
pago Enlace URL (MAX 255; MIN 3).
Ejemplo: https:pago

payment_method_types matriz de enumeraciones
La lista de tipos de métodos de pago que pueden utilizar los clientes. Si no se pasa ningún valor, Yuno mostrará los métodos de pago definidos en el panel de control.

payment array de objects
Matriz de objetos de pago

metadata array de objects

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

metadata object objeto

Especifica una clave de metadatos y el valor respectivo.

key string
Especifica una clave de metadatos.
Ejemplo: edad

value string
Especifica el valor de la clave de metadatos definida.
Ejemplo: 28

vault_on_success boolean
Bandera para inscribir la tarjeta después de un pago correcto. Falso por defecto.
Ejemplo: falso