Payment 详情

我们的应用程序接口（API）可以灵活地构建支付金额，适应可能导致交易总额的各种因素。无论是基本费用、税金、手续费还是小费，我们的系统都能无缝地处理各种因素。您可以轻松整合和管理不同因素对总金额产生影响的付款

这一功能提高了透明度，方便了商户和客户，实现了在支付过程中无缝处理支付细节。

收费金额

专用字段 (additiona_datal.order.fee_amount) 允许您指定交易中包含的服务费金额。

在下面的示例中，您可以看到一个请求，说明 180 日元的费用金额是 5000 日元最终交易的一部分。该字段仅用于提供信息，而 fee_amount 已包含在最终交易金额中，无需单独添加。

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"
              }
           }
        }
    }
}
'

运输金额

专用字段 (additional_data.order.shipping_amount) 允许您指定交易中包含的运费金额。

在下面的示例中，您可以看到一个说明 270 日元运费金额是 5000 日元最终交易一部分的请求。该字段仅用于提供信息，而 shipping_amount 已包含在最终交易金额中，无需单独添加。

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"
              }
           }
        }
    }
}
'

小贴士

专用字段 (additiona_datal.order.tip_amount) 允许您指定包含在交易中的小费金额。

在下面的示例中，您可以看到一个请求，说明 50 日元的小费金额是 5000 日元最终交易的一部分。该字段仅用于提供信息，而 tip_amount 已包含在最终交易金额中，无需单独添加。

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"
              }
           }
        }
    }
}
'

税收

对象的专用数组 (additional_data.order.taxes) 允许您指定交易中包含的服务税额。

现场	类型	说明	示例
类型*	枚举	税种。	增值税
税基	浮动	付款的计税基数。	10000.00
值*	浮动	付款的税额值。	2100.00
百分比	浮动	税率	21.00

税种	可用性	说明
增值税	COL, ECU	增值税。又称 IVA。
消费税	COL	又称 "消费税"。在哥伦比亚，国家消费税是一种间接税，适用于特定商品和服务的销售，如酒精饮料、香烟、移动电话服务等。税率因商品或服务而异。
AIRPORT_TAX	COL, BRL	该税是向使用机场设施的旅客收取的费用。该税费因机场而异，可能包括国内和国际费率。
增值税法_17934	UYU	在乌拉圭，第 17.934 号法律指的是制定与增值税（VAT）相关的具体修改和规定的法规。该法律可能包括有关免税、特殊税率和行政程序的规定。
增值税法_19210	UYU	在乌拉圭，第 19.210 号法律对增值税规则做出了补充规定或修改。该法律可能侧重于税收流程数字化、新税率或某些商品和服务的免税和税收待遇调整等方面。
增值税减免	COL, ECU	免征增值税
ISV	DOM	销售税。也称为 "Impuesto Sobre las Ventas"。在多米尼加共和国，ISV 通常被称为 ITBIS（Impuesto a la Transferencia de Bienes Industrializados y Servicios），是一种适用于商品和服务转让的增值税。ITBIS 类似于其他国家的增值税，在生产和销售过程的每个阶段征税。

在下面的示例中，您可以看到一个请求，该请求说明了 1000.00 美元的最终交易中包含哪些税费。该字段仅用于提供信息； taxes结构已包含在最终交易金额中，无需单独添加。

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"
              }
           }
        }
    }
}
'

折扣

对象的专用数组 (additional_data.order.discounts)允许您指定交易中包含的折扣。

在下面的示例中，您可以看到一个请求，该请求说明 500 美元的小费金额是 5000 美元最终交易的一部分。该字段仅用于提供信息，而 discounts 已包含在最终交易金额中，无需单独添加。

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"
              }
           }
        }
    }
}
'

客户验证

专用对象 (customer_payer.merchant_customer_validations)允许您为防欺诈查询指定某些客户验证规则。

领域	类型	描述
帐户已验证	bool	客户的账户是否已在商家处通过验证。默认为 True
email	bool	客户的email 是否已在商家处通过验证。默认为 True
电话已验证	bool	顾客的手机是否已在商家处通过验证。默认为 True

在下面的示例中，您可以看到一个请求，该请求说明客户之前已在 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
        }
    },
[...]