Atributos
Esse objeto representa um link de pagamento que pode ser associado a um cliente.
id string
O identificador exclusivo do cliente (MAX 64; MIN 36).
Example: 8546df3a-b83e-4bb5-a4b3-57aa6385924f
account_id string
O identificador exclusivo da conta (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
description string
A descrição do link de pagamento (MAX 255; MIN 3).
Exemplo: Pagamento no mercado
country enum
País em que a transação deve ser processada (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
status enum
O status do link de pagamento (MAX 255; MIN 3)CREATED, USED, CANCELED, EXPIRED, ERROR).
Exemplo: ATIVO
merchant_order_id string
Identificação do link de pagamento (MAX 255; MIN 3).
Exemplo: 432245
created_at carimbo de data/hora
A data e a hora em que o link de pagamento foi criado.
Example: 2022-05-09T20:46:54.786342Z
updated_at carimbo de data/hora
A data e a hora da última atualização do link de pagamento.
Example: 2022-05-09T20:46:54.786342Z
capture booleano
Decide se deve autorizar o pagamento ou capturá-lo. A autorização de um pagamento com cartão permite que você reserve
fundos na conta bancária de um cliente. Se o campo não for enviado, nós o consideraremos como verdadeiro. Posteriormente, você pode capturar o
pagamento via painel de controle do Yuno ou Método API.
Exemplo: true
amount objeto
Especifica o objeto de valor de payment , com o valor e a moeda.
currency enum
A moeda usada para fazer o payment (MAX 3; MIN 3; ISO 4217).
Possíveis valores de enum: Verifique a referência do país.
value número
O valor payment (múltiplo de 0,0001).
Exemplo: 12100,00
customer_payer objeto
Especifica o objeto do cliente para links de pagamentos.
id string
O identificador exclusivo do cliente na
plataforma Yuno (MAX 255; MIN 3).
Example: faa89e18-5a11-11ed-9b6a-0242ac120002
customer_id string
O identificador exclusivo do cliente no comerciante externo (MAX 255; MIN 3).
Exemplo: 23456
first_name string
O primeiro nome do cliente (MAX 255; MIN 3).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 255; MIN 3).
Exemplo: Doe
gender enum
O gênero do cliente (MAX 2; MIN 1; (M=Male/F=Female/NA=Not applicable/NK=Not Known)).
Valores de enum possíveis: M, F, NAou NK.
date_of_birth string
A data de nascimento do cliente no formato AAAA-MM-DD (comprimento: 10).
Exemplo: 1990-02-28
email string
O e-mail do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
nationality enum
A nacionalidade do cliente (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
document objeto
Especifica o objeto de documento do cliente, incluindo seu número e tipo.
document_number string
O número do documento do cliente (MAX 40; MIN 3).
Exemplo: 1093333333
document_type enum
O tipo de documento do cliente (MAX 6, MIN 2).
Possíveis valores de enum: Verifique a
Referência do país.
phone objeto
Especifica o objeto de telefone do cliente, incluindo o número e o código.
number string
O número de telefone do cliente (MAX 40; MIN 3).
Exemplo: 11992149494
country_code string
O código de chamada do país do telefone do cliente (MAX 3; MIN 1)
Valores possíveis: Verificar a
Referência do país.
billing_address objeto
Especifica o objeto de endereço de cobrança do cliente.
address_line_1 string
A linha do endereço de cobrança principal do cliente (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
A linha de endereço de faturamento secundário do cliente (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
A cidade considerada para o endereço de cobrança (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
O país considerado para o endereço de cobrança (MAX 2; MIN 2); ISO
3166-1).
Possíveis valores de enum: Verifique a referência do país.
state string
O estado considerado para o endereço de cobrança (MAX 255; MIN 3).
Exemplo: Cundinamarca
zip_code string
O código postal considerado para o endereço de cobrança (MAX 11; MIN 4).
Exemplo: 111111
shipping_address objeto
Especifica o objeto de endereço de entrega do cliente.
address_line_1 string
A linha do endereço de entrega principal do cliente (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
A linha do endereço de entrega secundário do cliente (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
A cidade considerada para o endereço de entrega (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
O país considerado para o endereço de entrega (MAX 2; MIN 2); ISO
3166-1).
Possíveis valores de enum: Verifique a referência do país.
state string
O estado considerado para o endereço de entrega (MAX 255; MIN 3).
Exemplo: Cundinamarca
zip_code string
O CEP considerado para o endereço de entrega (MAX 11; MIN 4).
Exemplo: 111111
additional_data objeto
Especifica o objeto additional_data. Esse objeto não é obrigatório. No entanto, se você enviar essas informações, a experiência de
experiência payment será aprimorada para o seu usuário.
airline objeto
Especifica o objeto da companhia aérea. Os passageiros e os bilhetes devem ter as mesmas informações de pedido.
pnr string
Registro do nome do passageiro (MAX 10; MIN 1).
Exemplo: 1P-2UUGJW
legs matriz de objetos
Especifica a matriz de pernas de objetos.
arrival_airport string
Código IATA do aeroporto (MAX 3; MIN 3). Veja http://www.iata.org.
Exemplo: AMS
base_fare flutuar
O valor da transação, excluindo impostos e taxas, a menor unidade de moeda (múltiplo de
0.0001).
Exemplo: 23,5676
base_fare_currency string
A moeda usada para o valor da transação (MAX 3; MIN 3); ISO 4217).
Exemplo: Verifique a referência do país.
carrier_code string
Código IATA da companhia aérea (MAX 2; MIN 2). Veja http://www.iata.org.
Exemplo: KL
departure_airport string
Código IATA (MAX 3; MIN 3). Veja http://www.iata.org.
Exemplo: EZE
departure_airport_timezone string
Fuso horário do aeroporto (MAX 6; MIN 6).
Exemplo: -03:00
departure_datetime carimbo de data/hora
A data e o horário de partida no horário local do aeroporto de partida.
Example: 2022-05-09T20:46:54.786342Z
fare_basis_code string
A tarifa base do código fornece informações específicas sobre a tarifa, além do serviço de classe, ambos
necessárias para a reserva (MAX 15; MIN 1).
Exemplo: HL7LNR
fare_class_code string
O código da classe tarifária da companhia aérea (MAX 1; MIN 1). Os valores podem ser uma letra (A-Z), mas podem variar
dependendo da definição da companhia aérea.
Exemplo: C
flight_number string
O número do voo atribuído pela companhia aérea (MAX 5; MIN 1).
Exemplo: 842
stopover_code string
O código de escala (código de uma letra que indica se o passageiro tem permissão para fazer uma
escala.
Somente dois tipos de caracteres são permitidos: O: Escala permitida (a letra "O", não zero) / X: Escala
não
permitida).
Exemplo: O
passengers matriz de objetos
Especifica a matriz de objetos que representa os passageiros associados aos tíquetes.
document objeto
Especifica o objeto de documento para o passageiro.
document_number string
O número do documento do passageiro (MAX 40; MIN 3).
Exemplo: 1093333333
document_type enum
O tipo de documento do passageiro (MAX 6, MIN 2).
Possíveis valores de enum: Verifique a
Referência do país.
country enum
País onde o documento foi emitido (MAX 2; MIN 2; ISO
3166-1).
Possíveis valores de enum: Verifique a referência do país.
date_of_birth string
A data de nascimento do passageiro no formato AAAA-MM-DD (MAX 10; MIN 10).
Exemplo: 1990-02-28
email string
O email do passageiro (MAX 255; MIN 3).
Exemplo: [email protected]
first_name string
O primeiro nome do passageiro (MAX 255; MIN 3).
Exemplo: João
last_name string
O sobrenome do passageiro (MAX 255; MIN 3).
Exemplo: Doe
loyalty_number string
Número do programa de fidelidade do passageiro (MAX 20, MIN 1).
Exemplo: 254587547
loyalty_tier enum
Nível do programa de fidelidade do passageiro (MAX 255; MIN 3).
Possíveis valores de enum: Verificar o
Nível de fidelidade.
middle_name string
O nome do meio do passageiro (MAX 255; MIN 3).
Exemplo: Charles
nationality enum
A nacionalidade do passageiro (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
type enum
O tipo de passageiro (MAX 1; MIN 1).
Possíveis valores de enum: Verifique a lista de tipos de Passenger.
tickets matriz de objetos
Especifica a matriz de bilhetes associados aos passageiros.
ticket_number string
Número do bilhete (MAX 14; MIN 1).
Exemplo: 7411823255523
e_ticket booleano
É um bilhete eletrônico?
Valores possíveis: True ou False
restricted booleano
Indica se o tíquete é refuncionalizável ou não.
Valores possíveis: True ou False
total_fare_amount flutuar
Valor total da tarifa na menor unidade monetária (múltiplo de 0,0001).
Exemplo: 80000
total_tax_amount flutuar
Valor total dos impostos na menor unidade monetária (múltiplo de 0,0001).
Exemplo: 14800
total_fee_amount flutuar
Valor total da taxa na menor unidade monetária (múltiplo de 0,0001).
Exemplo: 25200
issue objeto
Especifica o objeto de problema.
address string
Endereço do agente que vendeu o bilhete (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
carrier_prefix_code string
Transportadora emissora ou validadora. Esse é o prefixo AWB (Air waybill), código IATA de 3 números (MAX
3; MIN
3).
Exemplo: 044
city string
Nome da cidade do agente que vendeu o bilhete (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
Código do país em que o bilhete foi emitido (MAX 2; MIN 2); ISO
3166-1).
Possíveis valores de enum: Verificar a lista de códigos de país
list.
date string
Data de emissão do bilhete.
Exemplo: 1979-01-12
travel_agent_code string
Código do agente de viagens que emitiu o bilhete.
Exemplo: 10655823
travel_agent_name string
O nome sob o qual o ponto de venda aparece na lista de agências ou no nome da franquia (MAX 32;
MIN
1).
Exemplo: ACME Agency Inc
order objeto
Especifica o objeto de pedido.
fee_amount flutuar
O valor da taxa do pedido (múltiplo de 0,0001).
Exemplo: 1
shipping_amount flutuar
O valor de envio do pedido (múltiplo de 0,0001).
Exemplo: 1
items matriz de objetos
Especifica o objeto do item.
id string
O identificador exclusivo do item (MAX 255; MIN 3).
Exemplo: 3214
name string
O nome do item (MAX 255; MIN 3).
Exemplo: iPhone 12 Pro Max
quantity int
A quantidade do item (MAX 999; MIN 1).
Exemplo: 1
unit_amount flutuar
O valor unitário do item (múltiplo de 0,0001).
Exemplo: 550
category string
A categoria do item (MAX 255; MIN 3).
Valores possíveis: Verificar a lista de categorias do item.
brand string
A marca do item (MAX 255; MIN 3).
Exemplo: Apple
sku_code string
A unidade de manutenção de estoque (SKU) do item (MAX 255; MIN 3).
Exemplo: A2342
manufacture_part_number string
O número da peça de fabricação do item (MAX 255; MIN 3).
Exemplo: 345621234
picture_url string
A imagem do item (MAX 255; MIN 3).
Exemplo: https://www.merchant_url.com/items/:id
seller_details objeto
Especifica o objeto de detalhes do vendedor.
name string
O nome legal do vendedor (MAX 255; MIN 3).
Exemplo: Jhon Doe
email string
O e-mail do vendedor (MAX 255; MIN 3).
Exemplo: [email protected]
reference string
O código de identificação do vendedor (MAX 255; MIN 3).
Exemplo: Vendedor
website string
URL do site do vendedor (MAX 255; MIN 3).
Exemplo: https://www.test.com/1231324
industry enum
O setor do vendedor (MAX 255; MIN 3).
Possíveis valores de enum: Verificar a categoria do setor.
country enum
O país do vendedor (MAX 255; MIN 3).
Possíveis valores de enum: Verifique a lista de códigos de país.
document objeto
Especifica o objeto de documento do vendedor.
document_number string
O número do documento do vendedor (MAX 40; MIN 3).
Exemplo: 1093333333
document_type enum
O tipo de documento do vendedor (MAX 6, MIN 2).
Possíveis valores de enum: Verifique a
Referência do país.
phone objeto
Especifica o objeto de número de telefone do vendedor.
country_code string
O código de chamada do país do telefone do vendedor (MAX 3; MIN 1). Valores possíveis: Verifique o
Referência do país.
Exemplo: 57
number string
O número de telefone do vendedor, sem o código do país (MAX 32; MIN 1).
Exemplo: 3132450765
address objeto
Especifica o objeto de endereço do vendedor.
address_line_1 string
A linha de endereço principal do vendedor (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
A linha de endereço de faturamento secundário do vendedor (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
A cidade considerada para o endereço do vendedor (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
O país considerado para o endereço do vendedor (MAX 2; MIN 2),ISO
3166-1).
Possíveis valores de enum: Verificar a lista de códigos de país
list.
state string
O estado considerado para o endereço do vendedor (MAX 255; MIN 3).
Exemplo: Cundinamarca
zip_code string
O CEP considerado para o endereço do vendedor (MAX 11; MIN 4).
Exemplo: 111111
taxes matriz de objetos
Especifica o objeto fiscal do pedido.
type string
Tipo de imposto.
Exemplo: IVA
tax_base flutuar
A base do valor para aplicar o imposto definido.
Exemplo: 10000
value flutuar
O valor do imposto.
Exemplo: 2100
percentage flutuar
A porcentagem do imposto.
Exemplo: 21
one_time_use booleano
Link único: Para uma única coleção com informações definidas de produto, valor e cliente.
Link múltiplo: Para usar e compartilhar quantas vezes forem necessárias, com quantidade e produto definidos.
Opções: false permite apenas um uso, true vários pagamentos.
availability objeto
Especifica o objeto de disponibilidade. Refere-se à data de expiração do Payment Link.
start_at carimbo de data/hora
Início do período de validade do link de pagamento.
Example: 2022-05-09T20:46:54.786342Z
finish_at carimbo de data/hora
Fim do período de validade do link de pagamento.
Example: 2022-05-09T20:46:54.786342Z
callback_url string
URL para redirecionar seu cliente após o pagamento (MAX 255; MIN 3).
Exemplo: https://www.your-site.com/
redirect_url string
URL do link de pagamento (MAX 255; MIN 3).
Exemplo: https://checkout.y.uno/payment_links/id
payment_method_types matriz de enums
A lista de tipos de métodos de pagamento que os clientes podem usar. Se nenhum valor for passado, o Yuno exibirá os
métodos de pagamento definidos no painel.
payment matriz de objetos
Matriz de Objetos de pagamento
metadata matriz de objetos
Especifica uma lista de objetos de metadados. Você pode adicionar até 50 objetos de metadados.
metadata object objeto
Especifica uma chave de metadados e o respectivo valor.
key string
Especifica uma chave de metadados.
Exemplo: idade
value string
Especifica o valor da chave de metadados definida.
Exemplo: 28
vault_on_success booleano
Sinalizador para registrar o cartão após um pagamento bem-sucedido. Falso por padrão.
Exemplo: false