Esse objeto representa o payment criado após a geração da sessão de checkout para 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 payment (MAX 255; MIN 3).
Exemplo: Compra na web
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 da transação.
Exemplo: SUCCEEDED
sub_status enum
É um complemento às informações de status.
Exemplo: DECLINED
merchant_order_id string
O identificador exclusivo do pedido do cliente (MAX 255; MIN 3).
Example: 2022-05-09T20:20:54.786342Z
created_at carimbo de data/hora
A data e a hora em que o payment 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 payment.
Example: 2022-05-09T20:46:54.786342Z
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: 111111
currency_conversion objeto
Especifica o objeto de conversão de moeda.
provider_currency_conversion_id string
O identificador exclusivo da consulta de taxa de conversão do provedor (MAX 526; MIN 3).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
cardholder_currency enum
A moeda para fazer a conversão (ISO 4217 MAX 3; MIN 3).
Exemplo: USD
cardholder_amount número
Valor do payment antes da conversão
Exemplo: 100
refunded número
O valor do reembolso (múltiplo de 0,0001).
Exemplo: 111111
captured número
O valor capturado (múltiplo de 0,0001).
Exemplo: 111111
checkout objeto
Especifica o objeto de checkout. Esse objeto não é obrigatório para pagamentos consecutivos. Obrigatório quando
WORKFLOW é definido como CHECKOUT ou não é enviado. Não é necessário para DIRECT
pagamentos.
WORKFLOW é definido como CHECKOUT ou não é enviado. Não é necessário para DIRECT
pagamentos.
session string
A sessão de checkout foi criada para o payment (MAX 64; MIN 36).
Example: 757eefc7-e28c-4333-9a07-3b16e610745d
sdk_action_required booleano
Define se o payment é assíncrono e requer etapas adicionais com base em uma request ao SDK.
Exemplo: false
payment_method objeto
Especifica o objeto payment.
vaulted_token string
O vaulted_token representa um payment_method armazenado com segurança associado a uma transação anterior. Quando
utilizar um vaulted_token para criar um pagamento, não há necessidade de enviar um token adicional; ele pode ser definido como
nulo (MAX: 64; MIN: 36).
Este campo é retornado na resposta de pagamento quando vault_on_success = true e o status do pagamento é SUCCEEDED, desde que o pagamento faça referência a um cliente Yuno existente através de customer_payer.id.
Example: 8604911d-5ds9-229e-8468-bd41abear14s
type enum
Tipo de método de Payment . Obrigatório para DIRECT ou REDIRECT fluxo de trabalho. Necessário ao integrar carteiras, mesmo ao usar o SDK.
Valores de enum possíveis:
Valores de enum possíveis: verificar a referência do tipo depayment .
vault_on_success booleano
Sinalizador para registrar o cartão após um pagamento bem-sucedido. Requer que o pagamento faça referência a um cliente Yuno existente por meio de customer_payer.id.
Quando definido como true e o status do pagamento é SUCCEEDED, a resposta de pagamento incluirá um vaulted_token que pode ser usado para transações futuras. Sem um ID de cliente, não ocorre nenhum armazenamento e nenhum vaulted_token é retornado, mesmo que os detalhes do cliente estejam incluídos na linha.
Valores possíveis: True ou False
token string
O token de método de pagamento de uso único fornecido pelo sdk da Yuno. Se um pagamento for criado usando um token,
não é necessário enviar um vaulted_token também, ele pode ser definido como nulo. Não é necessário para pagamentos consecutivos.
pagamentos (MAX: 64; MIN: 36).
Exemplo: 5104911d-5df9-229e-8468-bd41abea1a4s
detail objeto
Especifica o objeto de detalhes da forma de payment , que fornece detalhes dos diferentes tipos de categoria de transação
que fazem parte do objeto de forma de payment .
card objeto
Especifica os detalhes do método de payment ao usar um cartão.
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
first_installments_deferral inteiro
Número de meses a serem aguardados para o débito da primeira parcela.
Exemplo: 1
installments_type string
Define o tipo de parcelas.
Exemplo: string
installments_amount inteiro
O valor da parcela inclui juros associados à parcela e as informações são
definidas pelo provedor.
Exemplo: 3
soft_descriptor string
O descritor passado por transação para nossa plataforma. Ele será apresentado no extrato bancário físico do cliente
extrato bancário físico do cliente (MAX 15; MIN 0).
Exemplo: EMPRESA1
authorization_code string
O código de resposta do adquirente.
Exemplo: 742A64
retrieval_reference_number string
O identificador exclusivo atribuído por um adquirente a uma autorização. No caso do Brasil, você receberá o nsu.
Exemplo: 200000000012
voucher string
O identificador exclusivo do recibo de pagamento atribuído pelo banco emissor para uma transação com cartão.
Esse campo estará vazio se o gateway não fornecer informações sobre a transação (MAX 255; MIN 3).
Exemplo: 43564
card_data objeto
Especifica os detalhes do cartão.
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: Fannie Weissnat
country_code string
Código do país do cartão do usuário (MAX 2; MIN 2).
Exemplo: EUA
expiration_month inteiro
Mês de validade do cartão (MM) (MAX 2; MIN 2).
Exemplo: 03
expiration_year inteiro
Ano de validade do cartão (AAAA) (MAX 4; MIN 2).
Exemplo: 2030
iin string
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 41961111
lfd string
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 19; MIN 8).
Exemplo: 41961111
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: VISA
issuer_name string
O emissor do cartão (MAX 255; MIN 3).
Exemplo: Banco Galicia
issuer_code inteiro
O código de identificação do emissor do cartão (MAX 255; MIN 3).
category string
A categoria do emissor do cartão (MAX 255; MIN 3).
Exemplo: Ouro
type string
O tipo do emissor do cartão (MAX 255; MIN 3).
Exemplo: CREDIT, DEBIT ou CHARGE_CARD
fingerprint string
Quando um cliente registra um cartão de crédito várias vezes relacionado a uma ou várias contas Yuno, vários vaulted_tokens serão gerados, mas a fingerprint permite identificar quando o mesmo cartão é usado para o cliente (MAX 255; MIN 3).
Exemplo: 55a7fe38-cdc3-45dc-8c5f-820751799c76
three_d_secure objeto
Especifica os detalhes da transação 3DS.
three_d_secure_setup_id string
ID de configuração obtida para o fluxo 3DS Direct.
Example: 24127d61-b852-42fb-acd4-1ee661645376
version enum
Refere-se à versão do protocolo da especificação EMV 3-D Secure utilizada. 1.0, 2.0, 2.1.0,
2.2.0, 2.2.1.
Exemplo: 2.2.1
electronic_commerce_indicator string
Esse campo deve ser preenchido com o resultado do ECI fornecido pelo serviço 3d Secure
serviço. O Indicador de Comércio Eletrônico (ECI) informa ao emissor do cartão se a transação foi
protegida por um protocolo de segurança como VbV ou MCSC. É exigido pela Visa e pela MasterCard que todas as transações
transações 3-D Secure tenham esse valor preenchido na request autorização (MAX: 2, MIN: 0).
Exemplo: 05
cryptogram string
Esse campo deve ser preenchido com o resultado do campo de criptograma fornecido pelo serviço 3DSecure
serviço. Nas transações Visa, ele representa o valor de verificação de autenticação do titular do cartão
(CAVV), um valor criptográfico gerado pelo emissor como evidência de autenticação payment durante a
compra on-line para se qualificar para a proteção contra chargeback. As transações da MasterCard têm um valor semelhante
chamado Accountholder Authentication Value (AAV) ou Universal Cardholder Authentication Field (UCAF).
(UCAF). Ao enviar uma transação para autorização, o comerciante deve incluir o CAVV ou o
AAV/UCAF para demonstrar que o titular do cartão foi autenticado. Normalmente, ele é codificado em base64.
(MÁXIMO: 40, MÍNIMO: 0).
Exemplo: BA0BB1Z3N5Q4kjkBU3c3ELGUsJY =
transaction_id string
Para 3DS v1:
Esse é o Identificador exclusivo de transação. Ele é gerado automaticamente pelo MPI. Normalmente, ele tem
28 bytes de comprimento e codificado em base64. É comumente chamado de XID (MAX: 40, MIN: 0).
Para 3DS v2:
Identificador de transação universalmente exclusivo atribuído pelo DS para identificar uma única transação. (MAX:
36, MIN:36).
Ex para V1: "TjY0MjAxRjA4MD4987DUzMzYyNjU="
Ex para V2: “c4e59ceb-a382-4d6a-bc87-385d591fa09d”
directory_server_transaction_id string
ID da transação gerada pelo servidor de diretório da Mastercard durante a autenticação (MAX 255;
MÍNIMO 3).
Example: f38e6948-5388-41a6-bca4-b49723c19437
network_token objeto
Informações sobre o token de rede usado para a transação. Se aplicável.
network enum
O provedor associado ao token fornecido. VISA, MASTERCARD, AMERICAN_EXPRESS.
Exemplo: MASTERCARD
status enum
Status do token para o método de pagamento. CREATED, ATIVO, SUSPENSO, CANCELADO.
Exemplo: ATIVO
par string
Referência da conta de Payment .
Exemplo: MCC123456789012
token_data objeto
Detalhes do Token .
number número
[Obrigatório] - Número do Tokensem nenhum separador (MÁX. 19; MÍN. 8) disponível somente para comerciantes certificados pela PCI.
Exemplo: 450799000001234
holder_name string
Nome completo do titular do cartão conforme aparece no Token (MAX 26; MIN 3).
Exemplo: John Doe
iin número
O número de identificação da instituição (IIN) refere-se aos primeiros dígitos de um número de token de rede emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd número
Os últimos quatro dígitos do token de rede (MAX 4; MIN 4).
Exemplo: 1234
expiration_month número
Mês de expiração do Tokende rede (MM) (MAX 2; MIN 2).
Exemplo: 12
expiration_year número
Ano de expiração do Tokende rede (AAAA) (MÁX 4; MÍN 2).
Exemplo: 2027
cryptogram string
[Obrigatório] - O criptograma exclusivo gerado pelo emissor para o token de rede em uso na transação.
electronic_commerce_indicator string
[Apenas necessário para determinados provedores] - Caso o token tenha sido autenticado pela Mastercard, o campo deve ser definido como 02. Para tokens Visa ou não autenticados, não é necessário enviar o campo.
token_requestor_id string
[Necessário apenas para determinados provedores] - ID do solicitante do Token do comerciante
response objeto
Detalhes da transação de rede.
code número
Código de resposta do provedor de serviços.
Exemplo: bem-sucedido
message número
Código de resposta do provedor de serviços.
Exemplo: Transação bem-sucedida
stored_credentials objeto
Indica o tipo de processamento da transação.
reason enum
Indica o tipo de processamento da transação.Enum:CARD_ON_FILE, SUBSCRIPTION, UNSCHEDULED_CARD_ON_FILE
Exemplo: SUBSCRIPTION
usage enum
Esse campo permite que você indique se essa é a primeira vez que o vaulted_token/network_token é usado para um payment ou se já foi usado para um payment anterior. Enum: FIRST, USED
Exemplo: USADO
subscription_agreement_id string
Esse campo permite que você indique a identificação do contrato com o cliente para uma assinatura. Principalmente para MX (MAX 255; MIN 3).
Exemplo: AA0001
network_Transaction_id string
Identificador exclusivo atribuído a uma transação pela rede de cartões. É usado para rastrear e referenciar transações específicas, especialmente em cenários de payment recorrente, garantindo consistência e rastreabilidade em todo o ciclo de vida do payment (MAX 255; MIN 3).
Exemplo: 583103536844189
bnpl objeto
Especifica os detalhes do método de payment ao usar o Buy Now Pay Later (BNPL).
installments inteiro
As parcelas do empréstimo (MAX 50; MIN 1).
Exemplo: 10
provider_image string
O URL do provedor (MAX 255; MIN 3).
Exemplo: https://www.company.com/
redirect_url string
O URL com a versão completa do tíquete, caso você queira redirecionar seu cliente (MAX 255;
MIN
3).
Exemplo: https://www.company.com/ticket_1231324
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
customer_data objeto
Especifica os detalhes do cliente.
name string
O nome legal do cliente (MAX 32, MIN 8).
Exemplo: Nome legal
username string
Nome de usuário do cliente na plataforma do provedor (MAX 32, MIN 8).
Exemplo: Nome_legal_01
tax_id_type string
O identificador de imposto do cliente (MAX 32, MIN 8).
Exemplo: CUIT
tax_id string
O número de identificação fiscal do cliente (MAX 32, MIN 8).
Exemplo: 20-34566123-7
type string
O tipo de crédito (MAX 255; MIN 3).
Exemplo: PESSOAL/EMPRESARIAL
area string
O setor do cliente (MAX 255; MIN 3).
Exemplo: OUTROS
role string
A função do cliente na empresa (MAX 255; MIN 3).
Exemplo: PROPRIETÁRIO
bank_transfer objeto
Especifica os detalhes do método de payment ao usar transferência bancária.
provider_image string
O URL do provedor (MAX 255; MIN 3).
Exemplo: https://www.company.com/
account_type string
Tipo da conta bancária (MAX 255; MIN 3).
Exemplo: CHEQUES/POUPANÇA
bank_name string
Nome do banco associado à conta (MAX 255; MIN 3).
Exemplo: Banco Galicia
bank_id string
Identificador do banco selecionado quando o provedor exige a escolha de um (MÁX. 255; MÍN. 1). Opcional.
Exemplo: galicia
beneficiary_name string
O nome do titular da conta (MAX 255; MIN 3).
Exemplo: John Doe
bank_account string
O número da conta bancária (MAX 255; MIN 3).
Exemplo: 54653211313333
bank_account_2 string
O número secundário da conta bancária (MAX 255; MIN 3).
Exemplo: 78900000000123
beneficiary_document_type string
Tipo de documento do titular da conta (MAX 255; MIN 3).
Valores possíveis: Verificar a
Referência do país. Exemplo: DNI
beneficiary_document string
Número do documento do titular da conta (MAX 255; MIN 3).
Exemplo: 54666897
reference string
Código de referência para o usuário (MAX 255; MIN 3).
Exemplo: AA01234-BC
retrieval_reference_number string
O identificador exclusivo atribuído por um adquirente a uma autorização. No caso do Brasil, você receberá o nsu.
Exemplo: 200000000012
payment_instruction string
Instruções de pagamento relacionadas ao payment (MAX 255; MIN 3).
Exemplo: Vá até sua conta bancária e transfira o valor usando a referência detalhada
abaixo
redirect_url string
O URL com a versão completa do tíquete, caso você queira redirecionar seu cliente (MAX 255;
MIN
3).
Exemplo: https://www.company.com/ticket_1231324
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
wallet objeto
Especifica os detalhes do método de payment ao usar uma carteira.
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
cryptogram string
Criptograma para integrações diretas com carteiras de cartões (MAX 526; MIN 3).
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
payment_method_id string
O método de payment do usuário usado em sua carteira.
Exemplo: credit_card
detail string
O detalhe do método de payment usado em sua carteira.
Exemplo: visto
money_release_date data
Data em que o dinheiro do provedor estará disponível para uso.
Example: 2022-05-09T00:00:00.000000Z
sponsor_id string
Conta de provedor do parceiro (MAX 255; MIN 3).
Exemplo: 4562103
authorization_code string
Código de resposta do Acquire.
Exemplo: 742A64
customer_data objeto
Especifica os detalhes do cliente.
email string
O email do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
first_name string
O primeiro nome do cliente (MAX 32, MIN 8).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 32, MIN 8).
Exemplo: Doe
username string
O nome de usuário do cliente na plataforma (MAX 32, MIN 8).
Exemplo: John_Doe_01
identification_type string
O tipo de documento do cliente (MAX 32, MIN 8).
Verifique a
Referência do país. Exemplo: DNI
identification_number string
O número de identificação do cliente (MAX 32, MIN 8).
Exemplo: 34566123
fee_details objeto
Especifica os detalhes das taxas.
amount flutuar
Valor da transação (múltiplo de 0,0001).
Exemplo: 40.5
card_data objeto
Especifica os detalhes do cartão.
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 2; MIN 1).
Exemplo: 16
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: visto
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: JOHN DOE
store_credentials objeto
Indica o tipo de processamento da transação. Este objeto é usado para enviar informações adicionais sobre recorrência. É opcional e poucos provedores o exigem (por exemplo, Mercado Pago). Entre em contato com seu TAM para confirmar se ele é necessário para sua integração.
reason enum
Indica o motivo para armazenar credenciais para a transação. Enumeração: CARD_ON_FILE, SUBSCRIPTION, UNSCHEDULED_CARD_ON_FILE
Exemplo: SUBSCRIPTION
usage enum
Esse campo permite que você indique se essa é a primeira vez que o vaulted_token/network_token é usado para um payment ou se já foi usado para um payment anterior. Enum: FIRST, USED
Exemplo: USADO
subscription_agreement_id string
Este campo permite indicar a identificação do contrato com o cliente para uma assinatura. Principalmente para MX (MÁX. 255; MÍN. 3).
Exemplo: AA0001
network_Transaction_id string
Identificador exclusivo atribuído a uma transação pela rede de cartões. É usado para rastrear e referenciar transações específicas, especialmente em cenários de payment recorrente, garantindo consistência e rastreabilidade em todo o ciclo de vida do payment (MAX 255; MIN 3).
Exemplo: 583103536844189
additional_data objeto
Essa estrutura é usada para enviar informações adicionais sobre a recorrência. Ela é opcional e poucos provedores a exigem (por exemplo, o Mercado Pago). Entre em contato com seu TAM para confirmar se ela é necessária para sua integração.
billing_cycles objeto
Especifica o billing_cycles objeto. Define o número de cobranças associadas à assinatura. Se estiver usando esse objeto, você deverá inserir dados em todos os campos.
billing_cycles objeto. Define o número de cobranças associadas à assinatura. Se estiver usando esse objeto, você deverá inserir dados em todos os campos.current inteiro
Exemplo: 1
total inteiro
O número total de ciclos de faturamento da assinatura (MIN 1).
frequency objeto
Especifica o tipo de frequência (por exemplo, DIA, SEMANA, MÊS, ANO) e o valor. Insira dados em todos os campos se estiver usando esse objeto.
type string
Especifica o tipo de frequência (por exemplo, DAY, WEEK, MONTH, YEAR).
Exemplo: MÊS
value string
Especifica o valor da frequência.
availability objeto
Especifica o availability objeto. Define um intervalo de datas com base nas datas de início e término em que a assinatura está disponível para uso.
availability objeto. Define um intervalo de datas com base nas datas de início e término em que a assinatura está disponível para uso.start_at string
A data de início em que o plano de assinatura estará disponível para uso. Se não for definida, a assinatura estará disponível a partir do momento em que for criada. start_at torna-se obrigatório ao usar finish_at.
finish_at string
A data final em que o plano de assinatura estará disponível para uso. Se não for definida, a assinatura estará disponível indefinidamente. finish_at torna-se obrigatório ao usar start_at.
ticket objeto
Especifica os detalhes do método de payment ao usar o tíquete.
type string
O tipo do tíquete.
Exemplo: number, barcode, custom, reference_code, qr
benefit_type enum
Tipo de benefício do usuário para o método payment de tíquetes. JUNAEB, PRIVATE
Exemplo: PRIVATE
provider_number inteiro
O número do bilhete.
Exemplo: 13141
provider_barcode inteiro
O código de barras do bilhete.
Exemplo: 456789009878765u7654
provider_logo string
O logotipo da passagem.
Exemplo: https://www.company.com/logo
provider_format string
O formato do bilhete.
Exemplo: código de barras, personalizado
payment_instruction string
Instruções de pagamento relacionadas ao payment (MAX 255; MIN 3).
Exemplo: Vá até a loja mais próxima e pague o valor total usando a referência detalhada abaixo
redirect_url string
O URL com a versão completa do tíquete.
Exemplo: https://www.company.com/ticket_1231324
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
payment_link objeto
Especifica os detalhes do método de payment ao usar um link de payment .
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
payment_method_id string
O método de payment do usuário usado em sua carteira.
Exemplo: credit_card
detail string
O detalhe do método de payment usado em sua carteira.
Exemplo: visto
money_release_date data
Data em que o dinheiro do provedor estará disponível para uso.
Example: 2022-05-09T00:00:00.000000Z
sponsor_id string
Conta de provedor do parceiro (MAX 255; MIN 3).
Exemplo: 4562103
authorization_code string
Código de resposta do Acquire.
Exemplo: 742A64
customer_data objeto
Especifica os detalhes do cliente.
email string
O email do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
first_name string
O primeiro nome do cliente (MAX 32, MIN 8).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 32, MIN 8).
Exemplo: Doe
username string
O nome de usuário do cliente na plataforma (MAX 32, MIN 8).
Exemplo: John_Doe_01
identification_type string
O tipo de documento do cliente (MAX 32, MIN 8).
Valores possíveis: Verificar a
Referência do país. Exemplo: DNI
identification_number string
O número de identificação do cliente (MAX 32, MIN 8).
Exemplo: 34566123
fee_details objeto
Especifica os detalhes das taxas.
amount flutuar
Valor da transação (múltiplo de 0,0001).
Exemplo: 40.5
card_data objeto
Especifica os detalhes do cartão.
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 2; MIN 1).
Exemplo: 16
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: visto
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: John Doe
expiration_month inteiro
Mês de validade do cartão (MM) (MAX 2; MIN 2).
Exemplo: 03
expiration_year inteiro
Ano de validade do cartão (AAAA) (MAX 4; MIN 2).
Exemplo: 30
customer_payer objeto
Especifica o objeto do cliente para pagamentos.
id string
O identificador exclusivo do cliente (MAX 64; MIN 36). Especifica o objeto de checkout. Esse objeto não é
obrigatório para pagamentos consecutivos. Obrigatório quando WORKFLOW é definido como CHECKOUT ou
não é enviado.
Example: faa89e18-5a11-11ed-9b6a-0242ac120002
merchant_customer_id string
O identificador exclusivo do cliente no comerciante externo (MAX 255; MIN 3).
Exemplo: 4ce6f7e1-bf2e-4e7f-bc1b-84b26082a1d3
merchant_customer_created_at carimbo de data/hora
Data de registro do cliente na plataforma de comerciantes (ISO 8601 MAX 27; MIN 27).
Example: 2022-05-09T20:46:54.786342Z
merchant_customer_validations objeto
Validações de fraude para o pagador do cliente.
account_is_verified booleano
Se a conta do cliente foi validada anteriormente no lado do comerciante. O padrão é true.
Valores possíveis: True ou False
email_is_verified booleano
Se email do cliente foi validado antes no lado do comerciante. O padrão é true.
Valores possíveis: True ou False
phone_is_verified booleano
Se o telefone do cliente tiver sido validado antes no lado do comerciante. O padrão é true.
Valores possíveis: True ou False
first_name string
O primeiro nome do cliente (MAX 255; MIN 1).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 255; MIN 1).
Exemplo: Doe
gender enum
O gênero do cliente (MAX 1; 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.
device_fingerprint string
A fingerprint do dispositivo do cliente (MAX 4000; MIN 1). Para integrações que usam o checkout da Yuno, o valor é
obtido automaticamente, não envie esse campo.
Example: hi88287gbd8d7d782ge.....
device_fingerprints matriz de objetos
Caso esteja usando uma integração DIRECT e queira oferecer suporte a mais de um provedor de fraude no fluxo de payment , você pode usar esse objeto para especificar as informações necessárias. Para integrações que usam o checkout Yuno, o valor é obtido automaticamente; não envie esse campo.
provider_id enum
A identificação do provedor de rastreamento de fraude
Exemplo: RISCADO
id string
A fingerprint do dispositivo associada ao provedor
Example: hi88287gbd8d7d782ge.....
ip_address string
O endereço IP do cliente (MAX 45; MIN 7).
Exemplo: 192.168.123.167
browser_info objeto
Especifica o objeto browser_info.
accept_header booleano
O valor header aceitação do navegador do cliente.
Valores possíveis: True ou False
accept_browser string
O valor do navegador aceito do navegador do cliente
Valores possíveis: "True" ou "False"
accept_content string
O valor do conteúdo aceito do navegador do cliente
Valores possíveis: "True" ou "False"
platform enum
A plataforma da qual o cliente está fazendo o payment.
Valores de enum possíveis: WEB, IOS, ANDROID
color_depth flutuar
A profundidade de cor do navegador do cliente em bits por pixel. Isso deve ser obtido usando a propriedade
propriedade screen.colorDepth do navegador. Valores aceitos: 1, 4, 8, 15, 16, 24, 30, 32 ou 48 bits de profundidade de cor
(MAX
5; MIN 1).
Exemplo: 15
javascript_enabled booleano
Indica se o Javascript está ativado ou não no dispositivo.
Valores possíveis: True ou False
java_enabled booleano
Indica se o Java está ativado ou não no dispositivo.
Valores possíveis: True ou False
browser_time_difference string
Indica a diferença de horário da Brosner
Exemplo: -3:00
language string
O valor navigator.language do navegador do cliente (conforme definido no IETF BCP 47) (MAX 5; MIN 1).
Exemplo: es-ES
screen_height string
A altura total da tela do dispositivo do cliente em pixels (MAX 255; MIN 3).
Exemplo: 2048
screen_width string
A largura total da tela do dispositivo do cliente em pixels (MAX 255; MIN 3).
Exemplo: 1152
user_agent string
O valor do agente do usuário do navegador do cliente (MAX 255; MIN 3).
Exemplo: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, como o
Gecko)
Versão/9.0.2 Safari/601.3.9
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
neighborhood string
A vizinhança da linha de endereço do cliente (MAX 255; MIN 2).
Exemplo: Barrio 11
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
neighborhood string
A vizinhança da linha de endereço do cliente (MAX 255; MIN 2).
Exemplo: Barrio 11
geolocation objeto
Localização geográfica do cliente.
latitude string
Distância angular de um local na Terra ao sul ou ao norte do equador (MIN: 1, MAX:11)
Exemplo: -34.4905
longitude string
Medida angular da distância de um local na Terra a leste ou oeste do observatório de Greenwich. (MIN: 1, MAX:11)
Exemplo: -58.5555
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
type enum
Tipo de viagem.
Valores possíveis: ONE_WAY, ROUNDTRIP, MULTIPLE_DESTINATIONS
legs matriz de objetos
Especifica a matriz de pernas de objetos.
order inteiro
Um índice de corrida (começa com 1), descrevendo a ordem das pernas na mesma rota.
Exemplo: 2
route_order inteiro
Um índice em execução (começa com 1), descrevendo a ordem das rotas por tempo. Por exemplo: se uma ordem contiver 2 rotas: Nova Iorque→Londres→Paris (conexão em Londres) Nova Iorque→Londres deve ter route_order=1, order=1; Londres→Paris deve ter route_order=1, order=2; Paris→Londres→Nova Iorque: Paris→Londres deve ter route_order=2, order=1; Londres→Nova York deve ter route_order=2, order=2.
Exemplo: 1
arrival_airport string
Código IATA do aeroporto (MAX 3; MIN 3). Veja http://www.iata.org.
Exemplo: AMS
arrival_airport_country string
País do aeroporto de chegada (MAX 2; MIN 2; ISO 3166-1).
Exemplo: AR
arrival_airport_city string
A cidade considerada para o aeroporto de chegada (MAX 255; MIN 3).
Exemplo: BUE
arrival_airport_timezone string
Fuso horário do aeroporto (MAX 6; MIN 6).
Exemplo: -03:00
arrival_datetime carimbo de data/hora
A data e a hora de chegada no horário local do aeroporto de chegada.
Example: 2022-05-09T24:46:54.786342Z
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_country string
País do aeroporto de partida (MAX 2; MIN 2; ISO 3166-1).
Exemplo: AR
departure_airport_city string
A cidade do aeroporto de partida (MAX 2; MIN 2; ISO 3166-1).
Exemplo: AR
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. Verifique a referência de informações da companhia aérea.
Exemplo: Y
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.
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
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.
phone objeto
Especifica o objeto de telefone para o passageiro.
country_code string
O código de chamada do país do telefone do passageiro (MAX 3; MIN 1).
Valores possíveis: Verificar a
Referência do país
number string
O número de telefone do passageiro, sem o código do país (MAX 32; MIN 1).
Exemplo: 1130292837
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 bilhete é reembolsá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
zip_code string
Código postal do agente que vendeu o bilhete.
Exemplo: 1636
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
booking_system_code string
Código do sistema de reservas que emite o bilhete. (MÁXIMO 255; MÍNIMO 1).
Exemplo: TEST001
booking_system_name string
Nome do sistema de reservas que está emitindo o bilhete. (MÁXIMO 255; MÍNIMO 1).
Exemplo: Sistema de reservas
transport objeto
Especifica o objeto de transporte.
id string
A identificação do veículo de transporte (MAX 255; MIN 1).
Exemplo: ASONDAKS-1234
order objeto
Especifica o objeto de pedido.
shipping_amount flutuar
Esse campo é para fins informativos; o valor do frete já está incluído no valor final da transação e não é adicionado separadamente.
Exemplo: 5190
fee_amount flutuar
O valor da taxa do pedido (múltiplo de 0,0001). Esse campo é para fins informativos; o valor da taxa já está incluído no valor final da transação e não é adicionado separadamente.
Exemplo: 789,50
tip_amount flutuar
O valor da gorjeta do pedido (múltiplo de 0,0001). Esse campo é para fins informativos; o valor da gorjeta já está incluído no valor final da transação e não é adicionado separadamente.
Exemplo: 215,10
sales_channel string
ID do canal de vendas do payment. (MIN:3 y MAX:255)
Exemplo: AA01
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
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
discounts matriz de objetos
Especifica o objeto de descontos do pedido.
id string
ID do desconto (MAX 255; MIN 3).
Exemplo: 10OFF
name string
O nome do desconto (MAX 255; MIN 3).
Exemplo: Oferta
unit_amount flutuar
O valor do desconto (múltiplo de 0,0001).
Exemplo: 100
tickets matriz de objetos
Especifica o objeto de tickets.
id string
Id do tíquete (mínimo: 1, máximo: 255)
Exemplo: 3214
name string
Nome do tíquete (mínimo: 1, máximo: 255)
Exemplo: Concerto
description string
Descrição do tíquete (mínimo: 1, máximo: 255)
Exemplo: Concerto
type enum
Tipo de bilhete
VIRTUAL / FÍSICO
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: 111111
event objeto
Especifica o objeto de detalhes do evento.
id string
Id do evento relacionado ao tíquete
Exemplo: AA01
name string
Nome do evento (Mín: 1, máx:255)
Exemplo: Música
description string
Descrição do evento (mín.: 1, máx.: 255)
Exemplo: festival
type enum
Tipo de evento
FESTA, UNIVERSIDADE, FESTIVAL, CIRCO, ESPORTES, CINEMA, TEATRO, SHOW, OUTROS.
date data
Data do evento
Exemplo: 2025-10-25
address objeto
Especifica o objeto de endereço do evento.
address_line_1 string
A linha de endereço principal do evento (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
A linha do endereço de cobrança secundário do evento (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
A cidade considerada para o endereço do evento (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
O país considerado para o endereço do evento (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 evento (MAX 255; MIN 3).
Exemplo: Cundinamarca
zip_code string
O CEP considerado para o endereço do evento (MAX 11; MIN 4).
Exemplo: 111111
shipping objeto
Especifica o objeto de detalhes de envio.
type enum
Tipo de remessa.
Exemplo: PADRÃO
Possíveis valores de enum: Verifique a referência de remessa.
description string
A descrição da remessa (MAX 255; MIN 1).
Exemplo: Envio de camisa de amostra
carrier enum
A transportadora usada para a entrega.
Exemplo: UPS
Possíveis valores de enum: Verifique a referência de remessa.
deliver_at carimbo de data/hora
Data estimada de entrega (ISO 8601 MAX 27; MIN 27).
Example: 2025-09-17T20:43:54.786342Z
account_funding objeto
Especifica a estrutura de financiamento da conta para transferências e pagamentos.
sender objeto
Especifica as informações do remetente.
national_entity enum
Tipo de entidade nacional do remetente. Valores possíveis:
INDIVIDUALENTITY
first_name string
Primeiro nome do remetente (MAX 80).
Exemplo: João
last_name string
Sobrenome do remetente (MAX 80).
Exemplo: Doe
legal_name string
Nome legal do destinatário. Obrigatório se national_entity é ENTITY (MAX 80).
Exemplo: Arcos dorados S.A.
email string
email do remetente (MAX 255; MIN 3).
Exemplo: [email protected]
country enum
País do remetente (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
date_of_birth data
Data de nascimento do remetente no YYYY-MM-DD formato (MAX 10; MIN 10).
Exemplo: 1990-02-28
phone objeto
Especifica o objeto telefone.
country_code string
Código do país do telefone do remetente (MAX 3; MIN 2).
Exemplo: 57
number string
Número de telefone do remetente (MAX 32; MIN 1).
Exemplo: 3132450765
document objeto
Especifica o objeto do documento.
document_number string
ID do documento nacional do remetente (MAX 40; MIN 3).
Exemplo: 1093333333
document_type enum
Tipo de documento do remetente (MAX 6; MIN 2).
Exemplo: CC
address objeto
Especifica o objeto de endereço.
address_line_1 string
Endereço de cobrança principal (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
Endereço de cobrança secundário (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
Cidade para o endereço de cobrança (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
País para o endereço de cobrança (ISO 3166-1; MAX 2; MIN 2).
Exemplo: CO
state string
Estado ou província do endereço de cobrança (MAX 255; MIN 3).
Exemplo: Cundinamarca
zip_code string
Código postal do endereço de cobrança (MAX 11; MIN 4).
Exemplo: 111111
recipient objeto
Especifica as informações do destinatário.
national_entity enum
Tipo de entidade nacional do destinatário. Valores possíveis:
INDIVIDUALENTITY
first_name string
Primeiro nome do remetente (MAX 80).
Exemplo: João
last_name string
Sobrenome do remetente (MAX 80).
Exemplo: Doe
legal_name string
Nome legal do destinatário. Obrigatório se national_entity é ENTITY (MAX 80).
Exemplo: Arcos dorados S.A.
email string
email do destinatário (MAX 255; MIN 3).
Exemplo: [email protected]
country enum
País do destinatário (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
date_of_birth data
Data de nascimento do destinatário na YYYY-MM-DD formato (MAX 10; MIN 10).
Exemplo: 1985-07-15
phone objeto
Especifica o objeto telefone.
country_code string
Código do país do telefone do destinatário (MAX 3; MIN 2).
Exemplo: 57
number string
Número de telefone do destinatário (MAX 32; MIN 1).
Exemplo: 3132450765
document objeto
Especifica o objeto do documento.
document_number string
ID do documento nacional do destinatário (MAX 40; MIN 3).
Exemplo: 1093333333
document_type enum
Tipo de documento do destinatário (MAX 6; MIN 2).
Exemplo: CC
address objeto
Especifica o objeto de endereço.
address_line_1 string
Endereço de cobrança principal (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
Endereço de cobrança secundário (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
Cidade para o endereço de cobrança (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
País para o endereço de cobrança (ISO 3166-1; MAX 2; MIN 2).
Exemplo: CO
state string
Estado ou província do endereço de cobrança (MAX 255; MIN 3).
Exemplo: Cundinamarca
zip_code string
Código postal do endereço de cobrança (MAX 11; MIN 4).
Exemplo: 111111
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.
merchant_category_code string
MCC - O código da categoria do comerciante (MAX 235; MIN 1).
Exemplo: 6199
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
transportations matriz de objetos
Especifica a matriz de objetos de transporte.
id string
O ID do registro de transporte (MAX 255; MIN 1).
description string
A descrição da reserva de transporte (MAX 255; MIN 1).
type string
O tipo de reserva de transporte.
legs matriz de objetos
Especifica a matriz de pernas de objetos.
order inteiro
Um índice de corrida (começa com 1), descrevendo a ordem das pernas na mesma rota.
route_order inteiro
Um índice em execução (começa com 1), descrevendo a ordem das rotas por tempo.
departure_country string
País da partida (MAX 2; MIN 2; ISO 3166-1).
departure_city string
A cidade da partida (MAX 255; MIN 1).
departure_timezone string
Fuso horário de partida (MAX 6; MIN 6).
departure_datetime string
A data e a hora de partida no horário local da partida.
departure_reference string
A referência da partida (MAX 255; MIN 1).
arrival_country string
País de chegada (MAX 2; MIN 2; ISO 3166-1).
arrival_city string
A cidade da chegada (MAX 255; MIN 1).
arrival_timezone string
Fuso horário de chegada (MAX 6; MIN 6).
arrival_datetime string
A data e a hora de chegada no horário local da chegada.
arrival_reference string
A referência da chegada (MAX 255; MIN 1).
transport objeto
Especifica o objeto de transporte.
id string
A identificação do veículo de transporte (MAX 255; MIN 1).
type string
O tipo de veículo de transporte.
description string
A descrição do veículo de transporte (MAX 255; MIN 1).
transactions objeto
Especifica os detalhes da transação associados a um payment.
id string
O identificador exclusivo da transação (MAX 64; MIN 36).
Example: 7bf8f1f6-4081-41ec-a024-a927056e00ab
type string
O tipo de transação.
Exemplo: COMPRAR
status enum
O status da transação.
Exemplo: SUCCEEDED
category string
A categoria do método de payment usado na transação.
Exemplo: CARTÃO
amount string
O valor da transação.
Exemplo: 100
provider_id string
O ID do provedor que processou a transação.
Exemplo: DLOCAL
payment_method objeto
Especifica os detalhes do método de payment usado na transação.
vaulted_token string
O token abobadado para um payment armazenado anteriormente. Se um pagamento for criado usando um
vaulted_token, não é necessário enviar um token também, ele pode ser definido como nulo (MAX: 64; MIN: 36).
Example: 8604911d-5ds9-229e-8468-bd41abear14s
type string
Tipo do método de payment . Obrigatório para DIRECT ou REDIRECT fluxo de trabalho. Necessário ao integrar carteiras, mesmo ao usar o SDK.
Valores de enum possíveis:
Possíveis valores de enum: Verificar a referência do tipo depayment .
vault_on_success booleano
Sinalizador para enroll o cartão após um payment bem-sucedido.
Valores possíveis: True ou False
token string
O token de método de pagamento de uso único fornecido pelo sdk da Yuno. Se um pagamento for criado usando um
token, não é necessário enviar um vaulted_token também, ele pode ser definido como nulo. Não é necessário para
pagamentos consecutivos (MAX: 64; MIN: 36).
Exemplo: 5104911d-5df9-229e-8468-bd41abea1a4s
parent_payment_method_type enum
Ao usar uma carteira para pagamentos por meio de um integração diretaEsse campo indica o provedor do qual as informações do cartão foram obtidas.
Exemplo: APPLE_PAY
detail objeto
Especifica o objeto de detalhes do método de payment , que fornece detalhes das diferentes transações
categoria
que fazem parte do objeto de forma de payment .
card objeto
Especifica os detalhes do método de payment ao usar um cartão.
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
permite
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
first_installments_deferral inteiro
Número de meses a serem aguardados para o débito da primeira parcela.
Exemplo: 1
installments_type string
Tipo de parcelas usadas no payment com cartão.
Exemplo: string
installments_amount inteiro
O valor da parcela inclui juros associados à parcela e as informações
são
definidas pelo provedor.
Exemplo: 3
soft_descriptor string
O descritor passado por transação para nossa plataforma. Ele será apresentado no extrato bancário físico do cliente
extrato bancário físico do cliente (MAX 15; MIN 0).
Exemplo: EMPRESA1
authorization_code string
O código de resposta do adquirente.
Exemplo: 742A64
retrieval_reference_number inteiro
O identificador exclusivo atribuído por um adquirente a uma autorização. No caso do Brasil, você receberá o nsu.
Exemplo: 200000000012
voucher string
O identificador exclusivo do recibo de pagamento atribuído pelo banco emissor para uma transação com cartão
transação com cartão.
Esse campo estará vazio se o gateway não fornecer informações sobre a transação (MAX 255; MIN
3).
Exemplo: 43564
card_data objeto
Especifica os detalhes do cartão.
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: Fannie Weissnat
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 41961111
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 2; MIN 1).
Exemplo: 16
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: VISA
issuer_name string
O emissor do cartão (MAX 255; MIN 3).
Exemplo: Banco Galicia
category string
A categoria do emissor do cartão (MAX 255; MIN 3).
Exemplo: Ouro
type string
O tipo do emissor do cartão (MAX 255; MIN 3).
Exemplo: CREDIT, DEBIT ou CHARGE_CARD
fingerprint string
Quando um cliente registra um cartão de crédito várias vezes relacionado a uma ou várias contas Yuno, vários vaulted_tokens serão gerados, mas a fingerprint permite identificar quando o mesmo cartão é usado para o cliente (MAX 255; MIN 3).
Exemplo: 55a7fe38-cdc3-45dc-8c5f-820751799c76
three_d_secure objeto
Especifica os detalhes da transação 3DS.
three_d_secure_setup_id string
ID de configuração obtida para o fluxo 3DS Direct.
Example: 24127d61-b852-42fb-acd4-1ee661645376
version enum
Refere-se à versão do protocolo da especificação EMV 3-D Secure utilizada. 1.0, 2.0, 2.1.0,
2.2.0, 2.2.1.
Exemplo: 2.2.1
electronic_commerce_indicator string
Esse campo deve ser preenchido com o resultado do ECI fornecido pelo serviço 3d Secure
serviço. O Indicador de Comércio Eletrônico (ECI) informa ao emissor do cartão se a transação foi
protegida por um protocolo de segurança como VbV ou MCSC. É exigido pela Visa e pela MasterCard que
todas as transações 3-D Secure tenham esse valor preenchido na request autorização (MAX: 2,
MIN: 0).
Exemplo: 04
cryptogram string
Esse campo deve ser preenchido com o resultado do campo de criptograma fornecido pelo serviço
serviço 3DSecure. Nas transações Visa, ele representa o Cardholder Authentication Verification Value (CAVV)
(CAVV), um valor criptográfico gerado pelo emissor como evidência de autenticação payment
autenticação de pagamento durante a compra on-line para se qualificar para a proteção contra estorno. As transações MasterCard
têm um valor semelhante chamado Accountholder Authentication Value (AAV) ou o
Universal Cardholder Authentication Field (UCAF) (Campo de autenticação universal do titular do cartão). Ao enviar uma transação para
autorização, o comerciante deve incluir o CAVV ou AAV/UCAF para demonstrar que o titular do cartão foi autenticado.
foi autenticado. Normalmente, ele é codificado em base64 (MAX: 40, MIN: 0).
Exemplo: BA0BB1Z3N5Q4kjkBU3c3ELGUsJY =
transaction_id string
Para 3DS v1:
Esse é o Identificador exclusivo de transação. Ele é gerado automaticamente pelo MPI. Ele tem
normalmente 28 bytes de comprimento e codificado em base64. É comumente chamado de XID (MAX: 40, MIN:
0).
Para 3DS v2:
Identificador de transação universalmente exclusivo atribuído pelo DS para identificar uma única transação.
(MÁX.: 36, MÍN.: 36).
Ex para V1: "TjY0MjAxRjA4MD4987DUzMzYyNjU="
Ex para V2: “c4e59ceb-a382-4d6a-bc87-385d591fa09d”
directory_server_transaction_id string
ID da transação gerada pelo servidor de diretório da Mastercard durante a autenticação (MAX
255; MIN 3).
Example: f38e6948-5388-41a6-bca4-b49723c19437
pares_status string
Indica o resultado da autenticação do titular do cartão durante o processo do 3-D Secure. Ele informa se a autenticação foi bem-sucedida (Y), falhou (N), não pôde ser concluída (U) ou foi apenas tentada (A).
Exemplo: Y
acs_id string
Identificador exclusivo fornecido pelo servidor de controle de acesso (ACS) durante o processo de autenticação do 3-D Secure.
Exemplo: ACS-1234567890
network_token objeto
Informações sobre o token de rede usado para a transação. Se aplicável.
network enum
O provedor associado ao token fornecido. VISA, MASTERCARD, AMERICAN_EXPRESS.
Exemplo: MASTERCARD
status enum
Status do token para o método de pagamento. CREATED, ATIVO, SUSPENSO, CANCELADO.
Exemplo: ATIVO
par string
Referência da conta de Payment .
Exemplo: MCC123456789012
token_data objeto
Detalhes do Token .
number número
[Obrigatório] Número do Tokensem nenhum separador (MÁX. 19; MÍN. 8) disponível apenas para comerciantes certificados pela PCI.
Exemplo: 450799000001234
holder_name string
Nome completo do titular do cartão conforme aparece no Token (MAX 26; MIN 3).
Exemplo: John Doe
iin número
O número de identificação da instituição (IIN) refere-se aos primeiros dígitos de um número de token de rede emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd número
Os últimos quatro dígitos do token de rede (MAX 4; MIN 4).
Exemplo: 1234
expiration_month número
Mês de expiração do Tokende rede (MM) (MAX 2; MIN 2).
Exemplo: 12
expiration_year número
Ano de expiração do Tokende rede (AAAA) (MÁX 4; MÍN 2).
Exemplo: 2027
cryptogram string
[Obrigatório] - O criptograma exclusivo gerado pelo emissor para o token de rede em uso na transação.
electronic_commerce_indicator string
[Apenas necessário para determinados provedores] - Caso o token tenha sido autenticado pela Mastercard, o campo deve ser definido como 02. Para tokens Visa ou não autenticados, não é necessário enviar o campo.
token_requestor_id string
[Necessário apenas para determinados provedores] - ID do solicitante do Token do comerciante
response objeto
Detalhes da transação de rede.
code número
Código de resposta do provedor de serviços.
Exemplo: bem-sucedido
message número
Código de resposta do provedor de serviços.
Exemplo: Transação bem-sucedida
stored_credentials objeto
Indica o tipo de processamento da transação.
reason enum
Indica o tipo de processamento da transação.Enum:CARD_ON_FILE, SUBSCRIPTION, UNSCHEDULED_CARD_ON_FILE
Exemplo: SUBSCRIPTION
usage enum
Esse campo permite que você indique se essa é a primeira vez que o vaulted_token/network_token é usado para um payment ou se já foi usado para um payment anterior. Enum: FIRST, USED
Exemplo: USADO
subscription_agreement_id string
Esse campo permite que você indique a identificação do contrato com o cliente para uma assinatura. Principalmente para MX (MAX 255; MIN 3).
Exemplo: AA0001
network_Transaction_id string
Identificador exclusivo atribuído a uma transação pela rede de cartões. É usado para rastrear e referenciar transações específicas, especialmente em cenários de payment recorrente, garantindo consistência e rastreabilidade em todo o ciclo de vida do payment (MAX 255; MIN 3).
Exemplo: 583103536844189
wallet objeto
Especifica os detalhes do método de payment ao usar uma carteira.
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
cryptogram string
Criptograma para integrações diretas com carteiras de cartões (MAX 526; MIN 3).
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
permite
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
payment_method_id string
O método de payment do usuário usado em sua carteira.
Exemplo: credit_card
detail string
O detalhe do método de payment usado em sua carteira.
Exemplo: visto
money_release_date data
Data em que o dinheiro do provedor estará disponível para uso.
Example: 2022-05-09T00:00:00.000000Z
sponsor_id string
Conta de provedor do parceiro (MAX 255; MIN 3).
Exemplo: 4562103
authorization_code string
Código de resposta do Acquire.
Exemplo: 742A64
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
customer_data objeto
Especifica os detalhes do cliente.
email string
O email do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
first_name string
O primeiro nome do cliente (MAX 32, MIN 8).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 32, MIN 8).
Exemplo: Doe
username string
O nome de usuário do cliente na plataforma (MAX 32, MIN 8).
Exemplo: John_Doe_01
identification_type string
O tipo de documento do cliente (MAX 32, MIN 8).
Verifique a
Referência do país. Exemplo: DNI
identification_number string
O número de identificação do cliente (MAX 32, MIN 8).
Exemplo: 34566123
fee_details objeto
Especifica os detalhes das taxas.
amount flutuar
Valor da transação (múltiplo de 0,0001).
Exemplo: 40.5
card_data objeto
Especifica os detalhes do cartão.
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 19; MIN 8).
Exemplo: 19
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: visto
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: JOHN DOE
bnpl objeto
Especifica os detalhes do método de payment ao usar o BNPL.
installments inteiro
As parcelas do empréstimo (MAX 50; MIN 1).
Exemplo: 10
provider_image string
O URL do provedor (MAX 255; MIN 3).
Exemplo: https://www.company.com/
redirect_url string
O URL com a versão completa do tíquete, caso você queira redirecionar seu cliente (MAX
255;
MIN
3).
Exemplo: https://www.company.com/ticket_1231324
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
customer_data objeto
Especifica os detalhes do cliente.
name string
O nome legal do cliente (MAX 32, MIN 8).
Exemplo: Nome legal
username string
Nome de usuário do cliente na plataforma do provedor (MAX 32, MIN 8).
Exemplo: Nome_legal_01
tax_id_type string
O identificador de imposto do cliente (MAX 32, MIN 8).
Exemplo: CUIT
tax_id string
O número de identificação fiscal do cliente (MAX 32, MIN 8).
Exemplo: 20-34566123-7
type string
O tipo de crédito (MAX 255; MIN 3).
Exemplo: PESSOAL/EMPRESARIAL
area string
O setor do cliente (MAX 255; MIN 3).
Exemplo: OUTROS
role string
A função do cliente na empresa (MAX 255; MIN 3).
Exemplo: PROPRIETÁRIO
bank_transfer objeto
Especifica os detalhes do método de payment ao usar transferência bancária.
provider_image string
O URL do provedor (MAX 255; MIN 3).
Exemplo: https://www.company.com/logo
account_type string
Tipo da conta bancária (MAX 255; MIN 3).
Exemplo: CHEQUES/POUPANÇA
bank_name string
Nome do banco associado à conta (MAX 255; MIN 3).
Exemplo: Banco Galicia
bank_id string
Identificador do banco selecionado quando o provedor exige a escolha de um. Retornado apenas se o comerciante enviou um valor.
Exemplo: galicia
beneficiary_name string
O nome do titular da conta (MAX 255; MIN 3).
Exemplo: John Doe
bank_account string
O número da conta bancária (MAX 255; MIN 3).
Exemplo: 54653211313333
bank_account_2 string
O número secundário da conta bancária (MAX 255; MIN 3).
Exemplo: 78900000000123
beneficiary_document_type string
Tipo de documento do titular da conta (MAX 255; MIN 3).
Valores possíveis: Verificar a
Referência do país. Exemplo: DNI
beneficiary_document string
Número do documento do titular da conta (MAX 255; MIN 3).
Exemplo: 54666897
reference string
Código de referência para o usuário (MAX 255; MIN 3).
Exemplo: AA01234-BC
retrieval_reference_number string
O identificador exclusivo atribuído por um adquirente a uma autorização. No caso do Brasil, você receberá o nsu.
Exemplo: 200000000012
payment_instruction string
Instruções de pagamento relacionadas ao payment (MAX 255; MIN 3).
Exemplo: Vá até sua conta bancária e transfira o valor usando a referência detalhada
abaixo
redirect_url string
O URL com a versão completa do tíquete, caso você queira redirecionar seu cliente (MAX
255;
MIN
3).
Exemplo: https://www.company.com/ticket_1231324
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
ticket objeto
Especifica os detalhes do método de payment ao usar o tíquete.
type string
O tipo do tíquete.
Exemplo: number, barcode, custom, reference_code, qr
benefit_type enum
Tipo de benefício do usuário para o método payment de tíquetes. JUNAEB, PRIVATE
Exemplo: PRIVATE
provider_number inteiro
O número do bilhete.
Exemplo: 13141
provider_barcode inteiro
O código de barras do bilhete.
Exemplo: 456789009878765u7654
provider_logo string
O logotipo da passagem.
Exemplo: https://www.company.com/logo
provider_format string
O formato do bilhete.
Exemplo: código de barras, personalizado
payment_instruction string
Instruções de pagamento relacionadas ao payment (MAX 255; MIN 3).
Exemplo: Vá até a loja mais próxima e pague o valor total usando a referência detalhada abaixo
redirect_url string
O URL com a versão completa do tíquete.
Exemplo: https://www.company.com/ticket_1231324
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
payment_link objeto
Especifica os detalhes do método de payment ao usar um link de payment .
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
permite
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
expires_at carimbo de data/hora
Data de expiração dos métodos Payment . "aaaa-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
payment_method_id string
O método de payment do usuário usado em sua carteira.
Exemplo: credit_card
detail string
O detalhe do método de payment usado em sua carteira.
Exemplo: visto
money_release_date data
Data em que o dinheiro do provedor estará disponível para uso.
Example: 2022-05-09T00:00:00.000000Z
sponsor_id string
Conta de provedor do parceiro (MAX 255; MIN 3).
Exemplo: 4562103
authorization_code string
Código de resposta do Acquire.
Exemplo: 742A64
customer_data objeto
Especifica os detalhes do cliente.
email string
O email do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
first_name string
O primeiro nome do cliente (MAX 32, MIN 8).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 32, MIN 8).
Exemplo: Doe
username string
O nome de usuário do cliente na plataforma (MAX 32, MIN 8).
Exemplo: John_Doe_01
identification_type string
O tipo de documento do cliente (MAX 32, MIN 8).
Valores possíveis: Verificar a
Referência do país. Exemplo: DNI
identification_number string
O número de identificação do cliente (MAX 32, MIN 8).
Exemplo: 34566123
fee_details objeto
Especifica os detalhes das taxas.
amount flutuar
Valor da transação (múltiplo de 0,0001).
Exemplo: 40.5
card_data objeto
Especifica os detalhes do cartão.
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 19; MIN 8).
Exemplo: 19
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: visto
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: John Doe
response_code string
O código que representa a resposta do resultado da transação.
Exemplo: SUCCEEDED
response_message string
A descrição do response_code.
Exemplo: Transação bem-sucedida
reason string
O motivo da transação. Aplica-se a transações secundárias, como reembolsos ou capturas.
Valores possíveis: CANCELLED, DISMISS, DUPLICATE, DUPLICATED, FRAUDULENT, MISSED, NOT_FOUND, ORDER_STOPPED, REFUNDED, REQUESTED_BY_CUSTOMER, RESOLVED, REVERSE, SERVICE_SUSPENDED
description string
A descrição do payment (MAX 255; MIN 3).
Exemplo: Compra na web
merchant_reference string
A referência gerada pelo comerciante para identificar o payment.
Exemplo: AA01
merchant_advice_code enum
Código de aviso ao comerciante normalizado para transações recusadas; use-o para orientar o comportamento de nova tentativa e o roteamento.
Exemplo: TRY_AGAIN_LATER
merchant_advice_code_message string
Mensagem legível por humanos que explica o conselho retornado em merchant_advice_code.
Exemplo: Repetir em 24 horas
provider_data objeto
Especifica os dados do provedor que processou o payment.
id string
A identificação do provedor que processou o payment.
Exemplo: DLOCAL
transaction_id string
O ID da transação do provedor.
Exemplo: 5a1fa541-5fa2-496e-9fdc-29b34e09a107
third_party_account_id string
O ID da conta do processador do provedor. Se aplicável.
Exemplo: AA001298
third_party_transaction_id string
O ID da transação do processador do provedor. Se aplicável.
Exemplo: 1309982
account_id string
O identificador exclusivo da conta (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
status enum
O status da transação.
Exemplo: SUCCEEDED
status_detail string
O status_detail da transação.
Exemplo: APROVADO
merchant_advice_code string
Raw Merchant Advice Code retornado pelo provedor para transações recusadas.
Exemplo: 25
merchant_advice_code_message string
Mensagem do provedor que explica o significado do Merchant Advice Code bruto.
Exemplo: Repetir após 24 horas
response_code string
O código que representa a resposta do resultado da transação do provedor.
Exemplo: SUCCEEDED
response_message string
Mensagem para fornecer informações adicionais sobre o status da operação.
Exemplo: Transação bem-sucedida
iso8583_response_code objeto
O código do padrão internacional para mensagens de intercâmbio originadas por cartões de transações financeiras (ISO 8583).
Exemplo: 00
iso8583_response_message objeto
A mensagem do padrão internacional para mensagens de intercâmbio originadas por cartões de transações financeiras (ISO 8583).
Exemplo: Aprovado ou concluído com êxito
raw_notification matriz de objetos
A notificação direta do provedor para a transação. O formato do objeto depende da resposta do
resposta do provedor.
Exemplos: JSON, XML, string
detail objeto
Especifica o objeto de detalhes do método de payment retornado pelo provedor, que especifica os detalhes da
diferentes transações
tipos de categoria de transação.
card objeto
Especifica os detalhes do método de payment ao usar um cartão.
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
permite
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
first_installments_deferral inteiro
Número de meses a serem aguardados para o débito da primeira parcela.
Exemplo: 1
installments_type string
Tipo de parcelas usadas no payment com cartão.
Exemplo: string
installments_amount inteiro
O valor da parcela inclui juros associados à parcela e as informações
são
definidas pelo provedor.
Exemplo: 3
soft_descriptor string
O descritor passado por transação para nossa plataforma. Ele será apresentado no extrato bancário físico do cliente
extrato bancário físico do cliente (MAX 15; MIN 0).
Exemplo: EMPRESA1
authorization_code string
O código de resposta do adquirente.
Exemplo: 742A64
retrieval_reference_number inteiro
O identificador exclusivo atribuído por um adquirente a uma autorização. No caso do Brasil, você receberá o nsu.
Exemplo: 200000000012
voucher string
O identificador exclusivo do recibo de pagamento atribuído pelo banco emissor para uma transação com cartão
transação com cartão.
Esse campo estará vazio se o gateway não fornecer informações sobre a transação (MAX 255; MIN
3).
Exemplo: 43564
card_data objeto
Especifica os detalhes do cartão.
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: Fannie Weissnat
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 41961111
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 2; MIN 1).
Exemplo: 16
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: VISA
issuer_name string
O emissor do cartão (MAX 255; MIN 3).
Exemplo: Banco Galicia
category string
A categoria do emissor do cartão (MAX 255; MIN 3).
Exemplo: Ouro
type string
O tipo do emissor do cartão (MAX 255; MIN 3).
Exemplo: CREDIT, DEBIT ou CHARGE_CARD
wallet objeto
Especifica os detalhes do método de payment ao usar uma carteira.
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
cryptogram string
Criptograma para integrações diretas com carteiras de cartões (MAX 526; MIN 3).
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
permite
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
payment_method_id string
O método de payment do usuário usado em sua carteira.
Exemplo: credit_card
detail string
O detalhe do método de payment usado em sua carteira.
Exemplo: visto
money_release_date data
Data em que o dinheiro do provedor estará disponível para uso.
Example: 2022-05-09T00:00:00.000000Z
sponsor_id string
Conta de provedor do parceiro (MAX 255; MIN 3).
Exemplo: 4562103
authorization_code string
Código de resposta do Acquire.
Exemplo: 742A64
customer_data objeto
Especifica os detalhes do cliente.
email string
O email do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
first_name string
O primeiro nome do cliente (MAX 32, MIN 8).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 32, MIN 8).
Exemplo: Doe
username string
O nome de usuário do cliente na plataforma (MAX 32, MIN 8).
Exemplo: John_Doe_01
identification_type string
O tipo de documento do cliente (MAX 32, MIN 8).
Verifique a
Referência do país. Exemplo: DNI
identification_number string
O número de identificação do cliente (MAX 32, MIN 8).
Exemplo: 34566123
fee_details objeto
Especifica os detalhes das taxas.
amount flutuar
Valor da transação (múltiplo de 0,0001).
Exemplo: 40.5
card_data objeto
Especifica os detalhes do cartão.
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 19; MIN 8).
Exemplo: 19
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: visto
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: JOHN DOE
bnpl objeto
Especifica os detalhes do método de payment ao usar o BNPL.
installments inteiro
As parcelas do empréstimo (MAX 50; MIN 1).
Exemplo: 10
provider_image string
O URL do provedor (MAX 255; MIN 3).
Exemplo: https://www.company.com/logo
redirect_url string
O URL com a versão completa do tíquete, caso você queira redirecionar seu cliente (MAX
255;
MIN
3).
Exemplo: https://www.company.com/ticket_1231324
customer_data objeto
Especifica os detalhes do cliente.
name string
O nome legal do cliente (MAX 32, MIN 8).
Exemplo: Nome legal
username string
Nome de usuário do cliente na plataforma do provedor (MAX 32, MIN 8).
Exemplo: Nome_legal_01
tax_id_type string
O identificador de imposto do cliente (MAX 32, MIN 8).
Exemplo: CUIT
tax_id string
O número de identificação fiscal do cliente (MAX 32, MIN 8).
Exemplo: 20-34566123-7
type string
O tipo de crédito (MAX 255; MIN 3).
Exemplo: PESSOAL/EMPRESARIAL
area string
O setor do cliente (MAX 255; MIN 3).
Exemplo: OUTROS
role string
A função do cliente na empresa (MAX 255; MIN 3).
Exemplo: PROPRIETÁRIO
bank_transfer objeto
Especifica os detalhes do método de payment ao usar transferência bancária.
provider_image string
O URL do provedor (MAX 255; MIN 3).
Exemplo: https://www.company.com/
account_type string
Tipo da conta bancária (MAX 255; MIN 3).
Exemplo: CHEQUES/POUPANÇA
bank_name string
Nome do banco associado à conta (MAX 255; MIN 3).
Exemplo: Banco Galicia
bank_id string
Identificador do banco selecionado pelo pagador, quando fornecido na solicitação de pagamento original.
Exemplo: galicia
beneficiary_name string
O nome do titular da conta (MAX 255; MIN 3).
Exemplo: John Doe
bank_account string
O número da conta bancária (MAX 255; MIN 3).
Exemplo: 54653211313333
bank_account_2 string
O número secundário da conta bancária (MAX 255; MIN 3).
Exemplo: 78900000000123
beneficiary_document_type string
Tipo de documento do titular da conta (MAX 255; MIN 3).
Valores possíveis: Verificar a
Referência do país. Exemplo: DNI
beneficiary_document string
Número do documento do titular da conta (MAX 255; MIN 3).
Exemplo: 54666897
payment_instruction string
Instruções de pagamento relacionadas ao payment (MAX 255; MIN 3).
Exemplo: Vá até sua conta bancária e transfira o valor usando a referência detalhada
abaixo
redirect_url string
O URL com a versão completa do tíquete, caso você queira redirecionar seu cliente (MAX
255;
MIN
3).
Exemplo: https://www.company.com/ticket_1231324
ticket objeto
Especifica os detalhes do método de payment ao usar o tíquete.
type string
O tipo do tíquete.
Exemplo: number, barcode, custom, reference_code, qr
provider_number inteiro
O número do bilhete.
Exemplo: 13141
provider_barcode inteiro
O código de barras do bilhete.
Exemplo: 456789009878765u7654
provider_logo string
O logotipo da passagem.
Exemplo: https://www.company.com/logo
provider_format string
O formato do bilhete.
Exemplo: código de barras, personalizado
redirect_url string
A url com a versão completa do tíquete.
Exemplo: https://www.company.com/ticket_1231324
payment_link objeto
Especifica os detalhes do método de payment ao usar um link de payment .
verify booleano
Usando amount = 0 e verify = true, é possível verificar o cartão do usuário sem autorizar um valor real.
valor real.
Valores possíveis: True ou False
capture booleano
Decide se deve autorizar o payment ou capturá-lo. A autorização de um payment com cartão permite que você
permite
reservar fundos na conta bancária de um cliente.
Valores possíveis: True ou False
installments inteiro
As parcelas do cartão (MAX 50; MIN 1).
Exemplo: 3
payment_method_id string
O método de payment do usuário usado em sua carteira.
Exemplo: credit_card
detail string
O detalhe do método de payment usado em sua carteira.
Exemplo: visto
money_release_date data
Data em que o dinheiro do provedor estará disponível para uso.
Example: 2022-05-09T00:00:00.000000Z
sponsor_id string
Conta de provedor do parceiro (MAX 255; MIN 3).
Exemplo: 4562103
authorization_code string
Código de resposta do Acquire.
Exemplo: 742A64
customer_data objeto
Especifica os detalhes do cliente.
email string
O email do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
first_name string
O primeiro nome do cliente (MAX 32, MIN 8).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 32, MIN 8).
Exemplo: Doe
username string
O nome de usuário do cliente na plataforma (MAX 32, MIN 8).
Exemplo: John_Doe_01
identification_type string
O tipo de documento do cliente (MAX 32, MIN 8).
Valores possíveis: Verificar a
Referência do país. Exemplo: DNI
identification_number string
O número de identificação do cliente (MAX 32, MIN 8).
Exemplo: 34566123
fee_details objeto
Especifica os detalhes das taxas.
amount flutuar
Valor da transação (múltiplo de 0,0001).
Exemplo: 40.5
card_data objeto
Especifica os detalhes do cartão.
iin inteiro
O número de identificação do emissor (IIN) refere-se aos primeiros dígitos do número do cartão payment
emitido por uma instituição financeira (MAX 8; MIN 6).
Exemplo: 45079900
lfd inteiro
Os últimos quatro dígitos do cartão (MAX 4; MIN 4).
Exemplo: 0010
number_length inteiro
O comprimento do número do cartão (MAX 19; MIN 8).
Exemplo: 19
security_code_length inteiro
O comprimento do código de segurança do cartão (MAX 1; MIN 1).
Exemplo: 3
brand string
As informações de marca do cartão (MAX 255; MIN 3).
Exemplo: visto
holder_name string
Nome completo do titular do cartão como aparece no cartão (MAX 26; MIN 3) disponível apenas para comerciantes certificados pela PCI
comerciantes certificados pelo PCI.
Exemplo: John Doe
connection_data objeto
Especifica o objeto de dados de conexão, que representa a conexão usada para processar a transação.
id string
O identificador exclusivo da conexão payment no Yuno (MAX 64; MIN 36).
Example: 88292fd3-bf5b-4b23-bb95-7186ba4e7f88
created_at carimbo de data/hora
A data e a hora em que a transação foi criada.
Example: 2022-05-09T20:46:54.786342Z
updated_at carimbo de data/hora
A data e a hora da última vez em que a transação foi atualizada.
Example: 2022-05-09T20:46:54.786342Z
split_marketplace matriz de objetos
Dividir a matriz de objetos do marketplace
recipient_id string
O identificador exclusivo do destinatário no sistema Yuno.
Você deve fornecer o recipient_id (gerado pela Yuno) ou o "provider_recipient_id" (ID do provedor externo) ao criar um payment.
provider_recipient_id string
O ID do destinatário fornecido pelo provedor de payment externo, se aplicável.
Você deve fornecer o provider_recipient_id ou o recipient_id (gerado pela Yuno) ao criar um payment.
type string
O tipo de divisão.
Exemplo: COMPRAR
merchant_reference string
Identificador exclusivo opcional para a transação dividida.
amount objeto
Define o valor da divisão.
value flutuar
O valor da divisão (múltiplo de 0,0001).
currency string
A moeda usada para fazer o payment (MAX 3; MIN 3; ISO 4217).
liability objeto
Informações opcionais sobre a responsabilidade do destinatário por taxas e estornos.
processing_fee string
Indica a quem será cobrada a taxa de transação.
chargebacks booleano
O destinatário é responsável no caso de um estorno.
transactions_history matriz de objetos
A lista das transações que fazem parte de um payment. Isso dependerá de quantos provedores você configurou em sua rota de método de payment .
workflow enum
Oworkflow payment . Indica se a integração usará o SDK da Yuno ou será uma conexão back to back
(implementação de cartão disponível apenas para comerciantes em conformidade com o PCI).
Valores de enum possíveis:
SDK_CHECKOUT: Use o Yuno SDK.DIRECT: Integração consecutiva com informações do provedor para payment personalizado experiência.REDIRECT: Integração back to back com redirecionamento de provedor.
callback_url string
O URL para onde redirecionar o cliente após o payment. Necessário somente para integrações DIRECT que tenham um
redirecionamento (MAX 526; MIN 3).
Exemplo: https://www.company.com/customer_1231324
metadata matriz de objetos
Especifica uma lista de pares de valores-chave personalizados associados ao pagamento (para referências internas, segmentação ou tags de fluxo de trabalho). Você pode adicionar até 100 objetos de metadados.
metadata object objeto
Especifica uma chave de metadados e o respectivo valor.
Use para anexar o contexto definido pelo comerciante (por exemplo: order_id, customer_tier). Evite enviar dados confidenciais ou pessoais.
order_id, customer_tier). Evite enviar dados confidenciais ou pessoais.key string
Especifica uma chave de metadados (MAX 48).
Exemplo: idade
value string
Especifica o valor da chave de metadados definida (MAX 512).
Exemplo: 28
routing_rules matriz de objetos
Retorna as informações das regras de roteamento durante a criação do payment .
smart_routing bool
Especifica se uma transação passou ou não pelo recurso de roteamento inteligente.
Exemplo: false
monitors bool
Especifica se uma transação passou ou não pelo recurso de monitores.
Exemplo: false
condition objeto
Objeto com as informações correspondentes para a condição de roteamento que se aplica ao payment
id string
ID da condição correspondente ao payment.
Example: 2404911d-5df9-429e-8488-ad41abea1a4b
subscription_id string
O identificador exclusivo da assinatura associada ao payment (MAX 64; MIN 36).
Example: 7304911d-5df9-429e-8488-ad41abea1a4c
subscription estrutura
Retorna os detalhes da assinatura associados ao payment.
billing_cycle int
Especifica o ciclo de faturamento da assinatura associada ao payment.
Exemplo: 1
retry int
Especifica a tentativa de nova tentativa associada ao ciclo de faturamento da assinatura.
Exemplo: 2
fraud_screening matriz de objetos
Fornece informações sobre as varreduras de fraude usadas para o payment.
status enum
O status final do processo de triagem do payment.
Exemplo: SUCCEEDED
stand_alone booleano
Campo opcional para enviar o payment , indicando se a verificação de fraude é autônoma, o que significa que um payment não será executado depois que a verificação de fraude for feita. Você pode usar esse campo ao criar sua rota CARD.
Exemplo: false
transactions objeto
Especifica os detalhes da transação associados a um processo de triagem do payment.
id string
O ID da transação de fraude (MAX 64; MIN 36).
Exemplo: ft12
type enum
Tipo de transação de fraude.
Valores de enum possíveis: PRE_AUTH, POS_AUTH
status enum
O status da transação (MAX 255; MIN 3).
Exemplo: SUCCEEDED
response_code enum
O código de resposta da transação.
Exemplo: FRAUD_VERIFIED
response_message enum
A mensagem de resposta da transação.
Exemplo: Fraude aprovada
provider_data objeto
Especifica os dados do provedor que processou o payment.
provider_id string
A identificação do provedor de prevenção contra fraudes.
Exemplo: CLEARSALE
transaction_id string
O ID da transação de fraude do provedor.
Exemplo: AA001234567
status string
O status da transação de fraude do provedor.
Exemplo: APM
score string
A pontuação do provedor para a transação.
Exemplo: 0,7
raw_response string
A raw_response do provedor.
Exemplo: JSON
created_at carimbo de data/hora
A data e a hora em que a triagem de fraude foi criada.
Example: 2022-05-09T20:46:54.786342Z
updated_at carimbo de data/hora
A data e a hora da última vez em que a triagem de fraude foi atualizada.
Example: 2022-05-09T20:46:54.786342Z