The Whitelabel Charge API allows merchants to fully integrate UPayments’ payment capabilities into their own website or mobile application while maintaining complete control over the checkout experience. Instead of redirecting customers to a hosted payment page, you collect payment details within your own UI and securely pass the required data to UPayments for processing.
This API is designed for businesses that want a seamless, on-brand checkout flow with maximum customization. By handling your own payment interface, you can tailor the design, layout, and user experience while leveraging UPayments’ backend infrastructure, payment processing, and multi-method support. The Whitelabel API is ideal for advanced integrations where maintaining a unified customer journey is a top priority.
Request Model
{
"products": [
{
"name": "Logitech K380",
"description": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar ",
"price": 10,
"quantity": 1
},
{
"name": "Logitech M171 Wireless Optical Mouse",
"description": "Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)",
"price": 10,
"quantity": 1
}
],
"order": {
"id": "202210101255255144669",
"reference": "11111991",
"description": "Purchase order received for Logitech K380 Keyboard",
"currency": "KWD",
"amount": 20
},
"paymentGateway": {
"src": "knet"
},
"language": "en",
"reference": {
"id": "202210101202210101"
},
"customer": {
"uniqueId": "2129879kjbljg767881",
"name": "John Smith",
"email": "[email protected]",
"mobile": "+96512345678"
},
"returnUrl": "https://upayments.com/en/",
"cancelUrl": "https://error.com",
"notificationUrl": "https://webhook.site/d7c6e1c8-b98b-4f77-8b51-b487540df336",
"customerExtraData": "User define data"
}{
"products": [
{
"name": "Logitech K380",
"description": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar ",
"price": 10,
"quantity": 1
},
{
"name": "Logitech M171 Wireless Optical Mouse",
"description": "Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)",
"price": 10,
"quantity": 1
}
],
"order": {
"id": "202210101255255144669",
"reference": "11111991",
"description": "Purchase order received for Logitech K380 Keyboard",
"currency": "KWD",
"amount": 20
},
"paymentGateway": {
"src": "cc"
},
"language": "en",
"reference": {
"id": "202210101202210101"
},
"customer": {
"uniqueId": "2129879kjbljg767881",
"name": "John Smith",
"email": "[email protected]",
"mobile": "+96512345678"
},
"returnUrl": "https://upayments.com/en/",
"cancelUrl": "https://error.com",
"notificationUrl": "https://webhook.site/d7c6e1c8-b98b-4f77-8b51-b487540df336",
"customerExtraData": "User define data"
}{
"products": [
{
"name": "Logitech K380",
"description": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar ",
"price": 10.00,
"quantity": 1
},
{
"name": "Logitech M171 Wireless Optical Mouse",
"description": "Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)",
"price": 10.00,
"quantity": 1
}
],
"order": {
"id": "202210101255255144669",
"reference": "11111991",
"description": "Purchase order received for Logitech K380 Keyboard",
"currency": "KWD",
"amount": 20.00
},
"paymentGateway": {
"src": "samsung-pay"
},
"language": "en",
"reference": {
"id": "202210101202210101"
},
"customer": {
"uniqueId": "2129879kjbljg767881",
"name": "John Smith",
"email": "[email protected]",
"mobile": "+96512345678"
},
"returnUrl": "https://upayments.com/en/",
"cancelUrl": "https://error.com",
"notificationUrl": "https://webhook.site/2547b895-5899-4a21-a6f2-ed34c4228216",
"customerExtraData": "User define data"
}{
"products": [
{
"name": "Logitech K380",
"description": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar ",
"price": 10.00,
"quantity": 1
},
{
"name": "Logitech M171 Wireless Optical Mouse",
"description": "Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)",
"price": 10.00,
"quantity": 1
}
],
"order": {
"id": "202210101255255144669",
"reference": "11111991",
"description": "Purchase order received for Logitech K380 Keyboard",
"currency": "KWD",
"amount": 20.00
},
"paymentGateway": {
"src": "apple-pay"
},
"language": "en",
"reference": {
"id": "202210101202210101"
},
"customer": {
"uniqueId": "2129879kjbljg767881",
"name": "John Smith",
"email": "[email protected]",
"mobile": "+96512345678"
},
"returnUrl": "https://upayments.com/en/",
"cancelUrl": "https://error.com",
"notificationUrl": "https://webhook.site/2547b895-5899-4a21-a6f2-ed34c4228216",
"customerExtraData": "User define data"
}{
"products": [
{
"name": "Logitech K380",
"description": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar ",
"price": 10.00,
"quantity": 1
},
{
"name": "Logitech M171 Wireless Optical Mouse",
"description": "Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)",
"price": 10.00,
"quantity": 1
}
],
"order": {
"id": "202210101255255144669",
"reference": "11111991",
"description": "Purchase order received for Logitech K380 Keyboard",
"currency": "KWD",
"amount": 20.00
},
"paymentGateway": {
"src": "apple-pay-knet"
},
"language": "en",
"reference": {
"id": "202210101202210101"
},
"customer": {
"uniqueId": "2129879kjbljg767881",
"name": "John Smith",
"email": "[email protected]",
"mobile": "+96512345678"
},
"returnUrl": "https://upayments.com/en/",
"cancelUrl": "https://error.com",
"notificationUrl": "https://webhook.site/2547b895-5899-4a21-a6f2-ed34c4228216",
"customerExtraData": "User define data"
}{
"products": [
{
"name": "Logitech K380",
"description": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboard",
"price": 10.00,
"quantity": 1
},
{
"name": "Logitech M171 Wireless Optical Mouse",
"description": "Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)",
"price": 10.00,
"quantity": 1
}
],
"order": {
"id": "202210101255255144669",
"reference": "11111991",
"description": "Purchase order received for Logitech K380 Keyboard",
"currency": "KWD",
"amount": 20.00
},
"paymentGateway": {
"src": "google-pay"
},
"language": "en",
"reference": {
"id": "202210101202210101"
},
"customer": {
"uniqueId": "2129879kjbljg767881",
"name": "John Smith",
"email": "[email protected]",
"mobile": "+96512345678"
},
"returnUrl": "https://upayments.com/en/",
"cancelUrl": "https://error.com",
"notificationUrl": "https://webhook.site/2547b895-5899-4a21-a6f2-ed34c4228216",
"customerExtraData": "User define data"
}{
"products": [
{
"name": "Logitech K380",
"description": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar ",
"price": 10,
"quantity": 1
},
{
"name": "Logitech M171 Wireless Optical Mouse",
"description": "Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)",
"price": 10,
"quantity": 1
}
],
"order": {
"id": "202210101255255144669",
"reference": "11111991",
"description": "Purchase order received for Logitech K380 Keyboard",
"currency": "KWD",
"amount": 20
},
"paymentGateway": {
"src": "cc"
},
"tokens" : {
"creditCard" : "9738184142972217",
"customerUniqueToken" : "9904917379121"
},
"language": "en",
"reference": {
"id": "202210101202210101"
},
"customer": {
"uniqueId": "2129879kjbljg767881",
"name": "John Smith",
"email": "[email protected]",
"mobile": "+96512345678"
},
"returnUrl": "https://upayments.com/en/",
"cancelUrl": "https://error.com",
"notificationUrl": "https://webhook.site/d7c6e1c8-b98b-4f77-8b51-b487540df336",
"customerExtraData": "User define data"
}Response Model
{
"status": true,
"message": "Payment link generated successfully",
"data": {
"link": "https://kpaytest.com.kw/kpg/PaymentHTTP.htm?param=paymentInit&trandata=0c399ba69806a53e095952a7ca7ce1dc1f9abc35a06a5afd00ba8b941b48086da33836564d9c731427e89b4291d3f5826acdbaed91d529e1f04d4edd6d269a4f84c55ba74b3aa87ba72f1e197842c1250870b84b21aa01708e24d328ab507db2caf42bc8617645af400cfd1109a8e6cf19f2d5d8f634c1013027996cbc4a944cdcb10e1e3f86ad5792fa6e9dbc655cbdc465810e0b80c08e5e5025e63d0226867d58cddcaf476b460cb765ab5cd86e7571e0f0ddad6dfee21ddad2b0d6468c107ee1a8834b51e0b527aa28b251014e93e970b04c6927222031114802e3f5e8b3f47aeb65074d6b31bda9081351452355445252356ae3a65ab064c6f2dace79a876bcfda7ac0657cb77d793a177defa1552da53415c02ea7fa7f70193224947a56d8174ac3ae790398c8ea7f8ccb2970efef9e6955709235d43c2203d10f78cf342309d0fc51779085a7a0af83020539a7490e0e4b42fde1410d5d0d7053cbdf8&tranportalId=252501&responseURL=https://sandboxapi.upayments.com/get-knet-success-response&errorURL=http://sandboxapi.upayments.com/get-knet-error-response",
"trackId": "019777419ab7655df5b7432f53547b82v2"
}
}{
"status": true,
"message": "Payment link generated successfully",
"data": {
"link": "https://sandbox.upayments.com/merchant/?session_id=2025084848160690767131631345725261196703637002046",
"trackId": "019777487d8bd818182f81661f305ded"
}
}{
"status": true,
"message": "Payment link generated successfully",
"data": {
"link": "http://sandboxapi.upayments.com/get-pay-by-samsung?order_id=0197776570e7ed79e5f2dd8d5f7b4416&track_id=0197776570e7ed79e5f2dd8d5f7b4415v2&transaction_id=786783&ref_id=6037874¤cy=KWD&amount=20.00&success_url=https://upayments.com/en/&failure_url=https://error.com",
"trackId": "0197776570e7ed79e5f2dd8d5f7b4415v2"
}
}{
"status": true,
"message": "Payment link generated successfully",
"data": {
"link": "http://sandboxapi.upayments.com/get-pay-by-apple?order_id=01977769e63c6c157a37e02a481743e1&track_id=01977769e63c6c157a37e02a481743e0v2&transaction_id=786784¤cy=KWD&amount=20.00&success_url=https://upayments.com/en/&failure_url=https://error.com&is_from_knet=true",
"trackId": "01977769e63c6c157a37e02a481743e0v2"
}
}{
"status": true,
"message": "Payment link generated successfully",
"data": {
"link": "http://sandboxapi.upayments.com/get-pay-by-apple?order_id=0197776bb4263ae6b1d1bc72c22e3977&track_id=0197776bb4263ae6b1d1bc72c22e3976v2&transaction_id=786785¤cy=KWD&amount=20.00&success_url=https://upayments.com/en/&failure_url=https://error.com&is_from_knet=true&p_type=QlBZQmZWZ3MxOGZ4QzRKazc5TkdsU2U3SmFURXVYbVVBcFlOdHhKUTB0TT0.",
"trackId": "0197776bb4263ae6b1d1bc72c22e3976v2"
}
}{
"status": true,
"message": "Payment link generated successfully",
"data": {
"link": "http://sandboxapi.upayments.com/get-pay-by-google?order_id=0197776cefa180b9e3dad455b2e55388&track_id=0197776cefa180b9e3dad455b2e55387v2&transaction_id=786786¤cy=KWD&amount=20.00&success_url=https://upayments.com/en/&failure_url=https://error.com",
"trackId": "0197776cefa180b9e3dad455b2e55387v2"
}
}{
"status": true,
"message": "Data received successfully",
"data": {
"payMit": {
"result": "SUCCESS",
"order": {
"status": "CAPTURED"
}
},
"transactionData": {
"order_id": "019797658b3c8128002f40887fec3a95",
"refund_order_id": "019797658b3c8128002f40887fec3a95",
"payment_id": "019797658b3c8128002f40887fec3a94",
"invoice_id": 6038651,
"result": "CAPTURED",
"error_message": null,
"payment_type": "card",
"payment_method": "card",
"track_id": "019797658b3c8128002f40887fec3a96v2",
"tran_id": null,
"auth": null,
"ref": "019797658b3f60a8b467433108edcd5c",
"post_date": null,
"transaction_date": "2025-06-22 14:28:26",
"payment_date": "2025-06-22 14:28:27",
"is_save_card": false,
"from_plugin": false,
"product_details": "{\"title\":[\"Logitech K380\",\"Logitech M171 Wireless Optical Mouse\"],\"name\":[\"Logitech K380 \\/ Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar\",\"Logitech M171 Wireless Optical Mouse (2.4GHz Wireless, Blue Grey)\"],\"price\":[10,10],\"qty\":[1,1],\"more_details\":\"\"}",
"reference": "202210101202210101",
"total_paid_non_kwd": "20.00",
"total_price": "20.000",
"currency_type": "KWD",
"status": "done",
"session_id": "SESSION0002901154903M8536489L64",
"error_url": "https://error.com",
"success_url": "https://upayments.com/en/",
"redirect_url": "https://upayments.com/en/?payment_id=019797658b3c8128002f40887fec3a94&result=CAPTURED&post_date=&tran_id=&ref=019797658b3f60a8b467433108edcd5c&track_id=019797658b3c8128002f40887fec3a96v2&auth=&order_id=019797658b3c8128002f40887fec3a95&requested_order_id=202210101255255144669&refund_order_id=019797658b3c8128002f40887fec3a95&payment_type=card&invoice_id=6038651&transaction_date=2025-06-22 02:06:28&receipt_id=019797658b3c8128002f40887fec3a95&trn_udf=User define data",
"notify_url": "https://webhook.site/d7c6e1c8-b98b-4f77-8b51-b487540df336",
"notify_url_called": false,
"notify_url_response": null,
"whitelabled": true,
"customer_id": 2962509,
"customer_unique_id": "2129879kjbljg767881",
"merchant_requested_order_id": "202210101255255144669",
"extra_merchants_data": null,
"is_paid_from_knet": false,
"is_paid_from_cc": true,
"is_from_nbk": false,
"customer_extra_data": "User define data",
"created_at": "2025-06-22 14:28:26",
"customer": {
"name": "Dharmendra Kakde",
"email": "[email protected]",
"mobile_number": "+96566336537"
}
}
}
}
Enabling White Label FeatureContact your UPayments Account Manager or [email protected] to enable the white label feature