Detalhes Payment

Nossa API oferece flexibilidade na estruturação dos valores de pagamento, acomodando vários fatores que podem contribuir para a soma total da transação. Quer se trate de encargos básicos, impostos, taxas ou gorjetas, nosso sistema foi projetado para lidar com diversos componentes sem problemas. Você pode integrar e gerenciar facilmente pagamentos com diferentes elementos que contribuem para o valor total

Esse recurso aumenta a transparência e a conveniência para comerciantes e clientes, permitindo o manuseio perfeito dos detalhes de pagamento no processo de pagamento.

Valor da taxa

Um campo dedicado (additiona_datal.order.fee_amount) permite que você especifique o valor da taxa de seus serviços que está incluído na transação.

No exemplo a seguir, você pode ver uma solicitação que esclarece que um valor de taxa de 180 JPY faz parte de uma transação final de 5.000 JPY. Esse campo é para fins informativos, o fee_amount já está incluído no valor final da transação e não é adicionado separadamente.

curl --request POST \
     --url https://api-sandbox.y.uno/v1/payments \
     --header 'X-Idempotency-Key: <Your idempotency-key>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'private-secret-key: <Your private-secret-key>' \
     --header 'public-api-key: <Your public-api-key>' \
     --data '
{
    "description": "Test",
    "account_id": "{{account-code}}",
    "merchant_order_id": "0000023",
    "country": "JP",
    "merchant_reference" : "reference-{{$randomUUID}}",
    "amount": {
        "currency": "JPY",
        "value": 5000.00
    },
    "customer_payer": {
        "id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
    },
    "additional_data": {
          "order": {
              "fee_amount": 180.00
          }
      },
    "workflow": "DIRECT",
    "payment_method": {
        "type":"CARD",
        "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
        "detail": {
           "card": {
               "stored_credentials":{
                  "reason":"CARD_ON_FILE",
                  "usage": "USED"
              }
           }
        }
    }
}
'

Valor da remessa

Um campo dedicado (additional_data.order.shipping_amount) permite que você especifique o valor do frete que está incluído na transação.

No exemplo a seguir, você pode ver uma solicitação que esclarece que um valor de remessa de 270 JPY faz parte de uma transação final de 5.000 JPY. Esse campo é para fins informativos, o shipping_amount já está incluído no valor final da transação e não é adicionado separadamente.

curl --request POST \
     --url https://api-sandbox.y.uno/v1/payments \
     --header 'X-Idempotency-Key: <Your idempotency-key>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'private-secret-key: <Your private-secret-key>' \
     --header 'public-api-key: <Your public-api-key>' \
     --data '
{
    "description": "Test",
    "account_id": "{{account-code}}",
    "merchant_order_id": "0000023",
    "country": "JP",
    "merchant_reference" : "reference-{{$randomUUID}}",
    "amount": {
        "currency": "JPY",
        "value": 5000.00
    },
    "customer_payer": {
        "id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
    },
    "additional_data": {
          "order": {
              "shipping_amount": 270.00
          }
      },
    "workflow": "DIRECT",
    "payment_method": {
        "type":"CARD",
        "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
        "detail": {
           "card": {
               "stored_credentials":{
                  "reason":"CARD_ON_FILE",
                  "usage": "USED"
              }
           }
        }
    }
}
'

Dicas

Um campo dedicado (additiona_datal.order.tip_amount) permite que você especifique o valor das gorjetas que está incluído na transação.

No exemplo a seguir, você pode ver uma solicitação que esclarece que um valor de gorjeta de 50 JPY faz parte de uma transação final de 5.000 JPY. Esse campo é para fins informativos, o tip_amount já está incluído no valor final da transação e não é adicionado separadamente.

curl --request POST \
     --url https://api-sandbox.y.uno/v1/payments \
     --header 'X-Idempotency-Key: <Your idempotency-key>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'private-secret-key: <Your private-secret-key>' \
     --header 'public-api-key: <Your public-api-key>' \
     --data '
{
    "description": "Test",
    "account_id": "{{account-code}}",
    "merchant_order_id": "0000023",
    "country": "JP",
    "merchant_reference" : "reference-{{$randomUUID}}",
    "amount": {
        "currency": "JPY",
        "value": 5000.00
    },
    "customer_payer": {
        "id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
    },
    "additional_data": {
          "order": {
              "tip_amount": 50.00
          }
      },
    "workflow": "DIRECT",
    "payment_method": {
        "type":"CARD",
        "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
        "detail": {
           "card": {
               "stored_credentials":{
                  "reason":"CARD_ON_FILE",
                  "usage": "USED"
              }
           }
        }
    }
}
'

Impostos

Uma matriz dedicada de objetos (additional_data.order.taxes) permite que você especifique os valores dos impostos para os serviços incluídos na transação.

Campo	Tipo	Descrição	Exemplo
tipo*	enum	Tipo de imposto.	IVA
tax_base	flutuar	Valor base tributado para o pagamento.	10000.00
valor*	flutuar	Valor do valor do imposto para o pagamento.	2100.00
porcentagem	flutuar	Taxa de imposto	21.00

Tipo de imposto	Disponibilidade	Descrição
IVA	COL, ECU	Imposto sobre valor agregado. Também conhecido como IVA.
CONSUMPTION_TAX	COL	Também conhecido como "Impuesto al consumo". Na Colômbia, o Imposto Nacional sobre o Consumo é um imposto indireto aplicado à venda de bens e serviços específicos, como bebidas alcoólicas, cigarros, serviços de telefonia móvel, entre outros. A alíquota varia de acordo com o bem ou serviço.
AEROPORTO-TAXI	COL, BRL	Esse imposto é uma taxa cobrada dos passageiros pelo uso das instalações do aeroporto. Essa taxa varia de acordo com o aeroporto e pode incluir tarifas nacionais e internacionais.
VAT_LAW_17934	UYU	No Uruguai, a Lei nº 17.934 refere-se aos regulamentos que estabelecem modificações e disposições específicas relacionadas ao Imposto sobre Valor Agregado (IVA). Essa lei pode incluir regulamentos sobre isenções, alíquotas especiais e procedimentos administrativos.
VAT_LAW_19210	UYU	No Uruguai, a Lei nº 19.210 estabelece regulamentações adicionais ou modificações nas regras do IVA. Essa lei pode se concentrar em aspectos como a digitalização dos processos fiscais, novas alíquotas de impostos ou ajustes nas isenções e tratamentos fiscais de determinados bens e serviços.
IVA_EXEMPTION	COL, ECU	Isenção de imposto sobre valor agregado
ISV	DOM	Imposto sobre vendas. Também conhecido como "Impuesto Sobre las Ventas". Na República Dominicana, o ISV, comumente conhecido como ITBIS (Impuesto a la Transferencia de Bienes Industrializados y Servicios), é um imposto sobre valor agregado aplicado à transferência de bens e serviços. O ITBIS é semelhante ao IVA em outros países, onde o imposto é cobrado em cada estágio do processo de produção e distribuição.

No exemplo a seguir, você pode ver uma solicitação que esclarece quais impostos fazem parte de uma transação final de US$ 1.000,00. Esse campo é para fins informativos; o campo taxesA estrutura já está incluída no valor final da transação e não foi adicionada separadamente.

curl --request POST \
     --url https://api-sandbox.y.uno/v1/payments \
     --header 'X-Idempotency-Key: <Your idempotency-key>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'private-secret-key: <Your private-secret-key>' \
     --header 'public-api-key: <Your public-api-key>' \
     --data '
{
    "description": "Test",
    "account_id": "{{account-code}}",
    "merchant_order_id": "0000023",
    "country": "US",
    "merchant_reference" : "reference-{{$randomUUID}}",
    "amount": {
        "currency": "USD",
        "value": 1000.00
    },
    "customer_payer": {
        "id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
    },
    "additional_data": {
          "order": {
              "taxes": [
                {
                  "type": "AIRPORT_TAX",
                  "tax_base":400000.00
                },
                {
                  "type": "VAT",
                  "value": 320000.00,
                  "tax_base":2000000.00
                }
              ]
          }
      },
    "workflow": "DIRECT",
    "payment_method": {
        "type":"CARD",
        "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
        "detail": {
           "card": {
               "stored_credentials":{
                  "reason":"CARD_ON_FILE",
                  "usage": "USED"
              }
           }
        }
    }
}
'

Descontos

Uma matriz dedicada de objetos (additional_data.order.discounts) permite que você especifique os descontos que estão incluídos na transação.

No exemplo a seguir, você pode ver uma solicitação que esclarece que um valor de gorjeta de 500 USD faz parte de uma transação final de 5000 USD. Esse campo é para fins informativos, o discounts já está incluído no valor final da transação e não é adicionado separadamente.

curl --request POST \
     --url https://api-sandbox.y.uno/v1/payments \
     --header 'X-Idempotency-Key: <Your idempotency-key>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'private-secret-key: <Your private-secret-key>' \
     --header 'public-api-key: <Your public-api-key>' \
     --data '
{
    "description": "Test",
    "account_id": "{{account-code}}",
    "merchant_order_id": "0000023",
    "country": "US",
    "merchant_reference" : "reference-{{$randomUUID}}",
    "amount": {
        "currency": "USD",
        "value": 5000.00
    },
    "customer_payer": {
        "id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
    },
    "additional_data": {
          "order": {
              "discounts": [
                {
                  "id": "10OFF",
                  "name":"Offer",
                  "unit_amount":500.00
                }
              ]
          }
      },
    "workflow": "DIRECT",
    "payment_method": {
        "type":"CARD",
        "vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
        "detail": {
           "card": {
               "stored_credentials":{
                  "reason":"CARD_ON_FILE",
                  "usage": "USED"
              }
           }
        }
    }
}
'

Validações de clientes

Um objeto dedicado (customer_payer.merchant_customer_validations) permite que você especifique determinadas regras de validação do cliente para consultas de prevenção contra fraudes.

campo	tipo	descrição
account_is_verified	bool	Se a conta do cliente tiver sido validada anteriormente no lado do comerciante. Verdadeiro por padrão
email	bool	Se email do cliente tiver sido validado anteriormente no lado do comerciante. Verdadeiro por padrão
phone_is_verified	bool	Se o telefone do cliente tiver sido validado anteriormente no lado do comerciante. Verdadeiro por padrão

No exemplo a seguir, você pode ver uma solicitação que esclarece que o cliente foi verificado anteriormente fora do Yuno.

[...]
  "description": "Test PIX",
    "account_id":"{{account-code}}",
    "merchant_order_id": "0000022",
    "country": "BR",
    "amount": {
        "currency": "BRL",
        "value": 50
    },
   "customer_payer": {
        "merchant_customer_id": "AA001",
        "first_name": "VALERIO",
        "last_name": "DE AGUIAR ZORZATO",
        "email": "[email protected]",
        "phone": {
                "number": "11992149494",
                "country_code": "55"
        },
        "document": {
                "document_type": "CPF",
                "document_number": "96050176876"
        },
        "merchant_customer_validations":{
          "phone_is_verified":true,
          "account_is_verified":true,
          "email_is_verified:":true
        }
    },
[...]