Payment Amount Details
Our API offers flexibility in structuring payment amounts, accommodating various factors that may contribute to the total transaction sum. Whether it's base charges, taxes, fees, or tips, our system is designed to handle diverse components seamlessly. You can easily integrate and manage payments with different elements contributing to the overall amount
This feature enhances transparency and convenience for both merchants and customers, enabling seamless handling of payment details within the payment process.
Fee amount
A dedicated field (additiona_data.order.fee_amount) allows you to specify the fee amount for your services that is included in the transaction.
In the following example you can see a request that clarifies that a 180 JPY fee amount is part of a 5000 JPY final transaction. This field is for informational purposes, the fee_amount is already included in the final transaction amount and is not added separately.
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
},
"customer_payer": {
"id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
},
"additional_data": {
"order": {
"fee_amount": 180
}
},
"workflow": "DIRECT",
"payment_method": {
"type":"CARD",
"vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
"detail": {
"card": {
"stored_credentials":{
"reason":"CARD_ON_FILE",
"usage": "USED"
}
}
}
}
}
'
Shipping amount
A dedicated field (additiona_data.order.shipping_amount) allows you to specify the shipping amount that is included in the transaction.
In the following example you can see a request that clarifies that a 270 JPY shipping amount is part of a 5000 JPY final transaction. This field is for informational purposes, the shipping_amount is already included in the final transaction amount and is not added separately.
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
},
"customer_payer": {
"id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
},
"additional_data": {
"order": {
"shipping_amount": 270
}
},
"workflow": "DIRECT",
"payment_method": {
"type":"CARD",
"vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
"detail": {
"card": {
"stored_credentials":{
"reason":"CARD_ON_FILE",
"usage": "USED"
}
}
}
}
}
'
Tips
A dedicated field (additiona_data.order.tip_amount) allows you to specify the tips amount that is included in the transaction.
In the following example you can see a request that clarifies that a 50 JPY tip amount is part of a 5000 JPY final transaction. This field is for informational purposes, the tip_amount is already included in the final transaction amount and is not added separately.
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
},
"customer_payer": {
"id":"967ecd18-d898-4b88-9400-dd5b01b18edc"
},
"additional_data": {
"order": {
"tip_amount": 50
}
},
"workflow": "DIRECT",
"payment_method": {
"type":"CARD",
"vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
"detail": {
"card": {
"stored_credentials":{
"reason":"CARD_ON_FILE",
"usage": "USED"
}
}
}
}
}
'
Taxes
A dedicated array of objects (additiona_data.order.taxes) allows you to specify the taxes amounts for your services that are included in the transaction.
| Field | Type | Description | Example |
|---|---|---|---|
| type* | enum | Tax Type. | VAT |
| tax_base | float | Taxed base amount for the payment. | 10000.00 |
| value* | float | Tax amount value for the payment. | 2100.00 |
| percentage | float | Tax rate | 21.00 |
| Tax Type | Availability | Description |
|---|---|---|
| VAT | COL, ECU | Value Added Tax. Also known as IVA. |
| CONSUMPTION_TAX | COL | Also known as "Impuesto al consumo". In Colombia, the National Consumption Tax is an indirect tax applied to the sale of specific goods and services, such as alcoholic beverages, cigarettes, mobile phone services, among others. The rate varies depending on the good or service. |
| AIRPORT_TAX | COL, BRL | This tax is a fee charged to passengers for the use of airport facilities. This tax varies depending on the airport and may include national and international rates. |
| VAT_LAW_17934 | UYU | In Uruguay, Law No. 17.934 refers to the regulations that establish specific modifications and provisions related to the Value Added Tax (VAT). This law may include regulations on exemptions, special rates, and administrative procedures. |
| VAT_LAW_19210 | UYU | In Uruguay, Law No. 19.210 establishes additional regulations or modifications to VAT rules. This law may focus on aspects such as the digitization of tax processes, new tax rates, or adjustments in exemptions and tax treatments of certain goods and services. |
| VAT_EXEMPTION | COL, ECU | Value Added Tax Exemption |
| ISV | DOM | Sales Tax. Also known as "Impuesto Sobre las Ventas". In the Dominican Republic, the ISV, commonly known as ITBIS (Impuesto a la Transferencia de Bienes Industrializados y Servicios), is a value-added tax applied to the transfer of goods and services. The ITBIS is similar to the VAT in other countries, where the tax is levied at each stage of the production and distribution process. |
In the following example, you can see a request that clarifies what taxes are part of a 1000.00 USD final transaction. This field is for informational purposes; the taxesstruct is already included in the final transaction amount and has not been added separately.
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
},
{
"type": "VAT",
"value": 320000,
"tax_base":2000000
}
]
}
},
"workflow": "DIRECT",
"payment_method": {
"type":"CARD",
"vaulted_token": "eb8caa17-6407-457b-960e-125d8d7a90c1",
"detail": {
"card": {
"stored_credentials":{
"reason":"CARD_ON_FILE",
"usage": "USED"
}
}
}
}
}
'
Updated about 2 months ago