On This Page {#jumplink-list} [Markdown](/docs/cybs/en-us/thunes/developer/all/rest/thunes.md) Thunes Integration Developer Guide {#thunes-about-guide} ======================================================== This section describes how to use this guide and where to find further information. Audience and Purpose -------------------- This guide is written for merchants who want to offer Thunes services to customers. It describes tasks that a merchant must complete in order to process a payment. It is intended to help the merchant provide a seamless customer payment experience. Customer Support ---------------- For support information about any service, visit the Support Center: Recent Revisions to This Document {#thunes-doc-revisions} ========================================================= 26.02.01 -------- Added REST support for BIZUM. See [Bizum Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-bizum-intro.md ""). 25.12.01 -------- Added REST support for BLIK. See [Blik Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-blik-intro.md ""). 25.09.01 -------- Added REST support for these payment methods: * [GrabPay Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-grabpay-intro.md "") * [GroupUp Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-groupup-intro.md "") * [iDEAL Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ideal-intro.md "") * [Multibanco Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-multibanco-intro.md "") * [MobilePay Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-mobilepay-intro.md "") * [Pluxee Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-pluxee-intro.md "") * [Przelewy24 Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-prz-intro.md "") * [ShopeePay Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-shopeepay-intro.md "") * [Turkey Card Processing Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-turkey-intro.md "") * [Twint Transaction Requests](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-twint-intro.md "") 25.08.01 -------- Added workflow graphics for services supported by the Simple Order API. VISA Platform Connect: Specifications and Conditions for Resellers/Partners {#vpc-partner-reseller-disclaimer} ============================================================================================================== The following are specifications and conditions that apply to a Reseller/Partner enabling its merchants through Cybersource for Visa Platform Connect ("VPC") processing. Failure to meet any of the specifications and conditions below is subject to the liability provisions and indemnification obligations under Reseller/Partner's contract with Visa/Cybersource. 1. Before boarding merchants for payment processing on a VPC acquirer's connection, Reseller/Partner and the VPC acquirer must have a contract or other legal agreement that permits Reseller/Partner to enable its merchants to process payments with the acquirer through the dedicated VPC connection and/or traditional connection with such VPC acquirer. 2. Reseller/Partner is responsible for boarding and enabling its merchants in accordance with the terms of the contract or other legal agreement with the relevant VPC acquirer. 3. Reseller/Partner acknowledges and agrees that all considerations and fees associated with chargebacks, interchange downgrades, settlement issues, funding delays, and other processing related activities are strictly between Reseller and the relevant VPC acquirer. 4. Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is responsible for payment processing issues, including but not limited to, transaction declines by network/issuer, decline rates, and interchange qualification, as may be agreed to or outlined in the contract or other legal agreement between Reseller/Partner and such VPC acquirer. DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR OMISSIONS BY THE Visa Platform Connect ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE RELEVANT Visa Platform Connect ACQUIRER. Introduction to Thunes Integration {#home} ========================================== Thunes is a payment service provider (PSP) offered by `Cybersource` that enables you to process payments using regional payment methods throughout the world. You can choose which Thunes payment method to integrate to in order to offer your customers a market-specific payment option. The different payment methods also offer different ways to pay, such as buy now pay laters (BNPLs), credit card processing, and digital wallets. Requirements ------------ You must have a `Cybersource` merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Getting Started with REST ------------------------- To begin processing payments through `Cybersource`, you must first set up your payment processing system to be REST compliant. `Cybersource` uses the REST architecture for developing web services. REST enables communication between a client and server using HTTP protocols. If you have not set up secure communications between your client and server using either a **JSON Web Token** or **HTTP signature** , see the [*Getting Started with REST Developer Guide*](https://developer.cybersource.com/docs/cybs/en-us/platform/developer/all/rest/rest-getting-started/restgs-intro.md ""). Bizum Transaction Requests {#thunes-blik-intro} =============================================== Bizum is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. You can process a payment by sending a sale API request message to `Cybersource`. `Cybersource` sends your request to Thunes. Thunes approves the transaction and sends the request to the processor for settlement. You can also send a follow-on refund and check status API requests. Requirements ------------ You must have a merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country, country code, and currency supported by Bizum. | Country | Country Code | Currency | Currency Code | |---------|--------------|----------|---------------| | Spain | `ES` | Euro | `EUR` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. Bizum by Thunes Payment Workflow {#thunes-intro-flow-blik} ========================================================== This workflow describes the sequence of events that comprises a successful Bizum payment. #### Figure: Bizum by Thunes Payment Workflow ![Bizum by Thunes Payment Workflow](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/ap-thns-bizum-600x445.svg/jcr:content/renditions/original) 1. The customer begins to checkout on the merchant's website and chooses the Bizum payment method.{#thunes-intro-flow-blik_step1} {#thunes-intro-flow-blik_step1} 2. The merchant sends a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-blik-intro/thunes-blik-sale-intro.md "").{#thunes-intro-flow-blik_step2} {#thunes-intro-flow-blik_step2} 3. `Cybersource` responds to the merchant with a `PENDING` status and a redirect URL.{#thunes-intro-flow-blik_step3} {#thunes-intro-flow-blik_step3} 4. The merchant redirects the customer to the URL.{#thunes-intro-flow-blik_step4} {#thunes-intro-flow-blik_step4} 5. The customer completes the checkout using Bizum and is redirected to the merchant website.{#thunes-intro-flow-blik_step5} {#thunes-intro-flow-blik_step5} 6. The merchant sends a check status API request to `Cybersource`. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-blik-intro/thunes-blik-status-intro.md "").{#thunes-intro-flow-blik_step6} {#thunes-intro-flow-blik_step6} 7. `Cybersource` responds to the merchant with a `SETTLED` status.{#thunes-intro-flow-blik_step7} {#thunes-intro-flow-blik_step7} 8. The merchant displays a confirmation of the completed payment to the customer.{#thunes-intro-flow-blik_step8} {#thunes-intro-flow-blik_step8} {#thunes-intro-flow-blik_steps} Transaction Statuses Workflow {#thunes-blik-status-flow} ======================================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-blik-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-blik-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-blik-sale-intro} ======================================== Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using Bizum. When the customer completes the checkout, the customer is redirected to your merchant website based on the success URL you include in the merchantInformation.successUrl request field. Line Items ---------- Line items are included in a request in the lineItem\[\] array. For more information about how to properly format line items in your request, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-blik-sale-intro_tax-info} ---------------------------------------------- You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-blik-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-blik-sale-intro_d7e355} Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-blik-intro/thunes-blik-status-intro.md ""). {#thunes-blik-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Processing a Sale {#thunes-blik-sale-task} ========================================== Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://api.cybersource.com``/pts/v2/payments`{#thunes-blik-sale-task_sale-prod-rest} endpoint and include these required fields: clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : paymentInformation.paymentType.method.name : Set to `BIZUM`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionlist : Set to `AP_SALE`. {#thunes-blik-sale-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#thunes-blik-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the processorInformation.paymentUrl response field. ``` "paymentUrl": "https://Bizum.limonetikqualif.com/PayPage/359299031517" ``` {#thunes-blik-sale-task_step-3-cmd} 4. When the customer completes the checkout using their Bizum credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl field.{#thunes-blik-sale-task_step-4-cmd} {#thunes-blik-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7652176144426365504805" ``` {#thunes-blik-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-blik-sale-ex-rest} ====================================================== Request ``` {     "clientReferenceInformation": {         "code": "123"     },     "merchantInformation": {         "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel",         "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure",         "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess"     },     "paymentInformation": {         "paymentType": {             "method": {                 "name": "BIZUM"             },             "name": "bankTransfer"         }     },     "orderInformation": {         "billTo": {             "country": "ES"         },         "amountDetails": {             "currency": "EUR",             "totalAmount": "8.00"         }     },     "processingInformation": {         "actionList": [             "AP_SALE"         ]     } } ``` Response to a Successful Request ``` {     "_links": {         "void": {             "method": "POST",             "href": "/pts/v2/payments/7652176144426365504805/voids"         },         "billingAgreement": {             "method": "POST",             "href": "/pts/v2/billing-agreements/7652176144426365504805"         },         "self": {             "method": "POST",             "href": "/pts/v2/payments/7652176144426365504805"         },         "refund": {             "method": "POST",             "href": "/pts/v2/payments/7652176144426365504805/refunds"         },         "status": {             "method": "POST",             "href": "/pts/v2/refresh-payment-status/7652176144426365504805"         }     },     "clientReferenceInformation": {         "code": "123"     },     "id": "7652176144426365504805",     "message": "Request was processed successfully.",     "orderInformation": {         "amountDetails": {             "totalAmount": "8.00",             "currency": "EUR"         }     },     "processorInformation": {         "responseDetails": "00001",         "paymentUrl": "https://Bizum.limonetikqualif.com/PayPage/359299031517",         "transactionId": "359299031517",         "responseCode": "00001"     },     "reconciliationId": "XFZ3ZIRG3CAE",     "status": "PENDING",     "submitTimeUtc": "2025-12-08T18:13:35Z" } ``` Check a Request Status {#thunes-blik-status-intro} ================================================== You can retrieve the status of a pending sale or refund by sending a check status request. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-blik-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-blik-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either Bizum rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either Bizum rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Required Fields for Checking Status {#thunes-blik-status-req-fields} ==================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `BIZUM`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `bankTransfer`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_STATUS`. Example: Checking a Request Status {#thunes-blik-status-ex-rest} ================================================================ Request ``` {     "clientReferenceInformation": {         "code": "refnum-1234"     },     "paymentInformation": {         "paymentType": {             "method": {                 "name": "BIZUM"             },             "name": "bankTransfer"         }     },     "processingInformation": {         "actionList": "AP_STATUS"     } } ``` Response to a Successful Request ``` {     "clientReferenceInformation": {         "code": "refnum-1234"     },     "id": "7652140009076673004807",     "processorInformation": {         "responseDetails": "00004",         "token": "524844527123",         "responseCode": "00004"     },     "reconciliationId": "XFZ3ZIR241FRH",     "status": "SETTLED" } ``` Refund a Payment {#thunes-blik-refund-intro} ============================================ You can refund a completed payment for the full amount or a partial amount by sending a refund request. Bizum supports multiple refund requests when the total amount of all of the refund requests is less than the captured amount. Requesting a refund requires the request ID from the sale response. The request ID is located in the id response field. Endpoints {#thunes-blik-refund-intro_section_t2w_424_jyb} --------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-blik-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-blik-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- `Cybersource` responds to your refund request with one of these statuses as the status field value: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-status-intro.md ""). When you send a check status request to retrieve an updated refund status, these are the possible responses: * `FAILED`: The refund request failed. * `REFUNDED`: The settled payment is successfully refunded. Required Fields for Refunding a Payment {#thunes-blik-refund-req-fields} ======================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [orderInformation.amountDetails.currency](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-currency.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `BIZUM`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `bankTransfer`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_REFUND`. Example: Refunding a Payment {#thunes-blik-refund-ex-rest} ========================================================== Request ``` {     "clientReferenceInformation": {         "code": "refnum-1234"     },     "paymentInformation": {         "paymentType": {             "method": {                 "name": "BIZUM"             },             "name": "bankTransfer"         }     },     "processingInformation": {         "actionList": "AP_REFUND"     },     "orderInformation": {         "amountDetails": {             "totalAmount": "60.00",             "currency": "EUR"         }     } } ``` Response to a Successful Request ``` {     "_links": {         "self": {             "method": "GET",             "href": "/pts/v2/refunds/7652176144426365504805"         },         "status": {             "method": "POST",             "href": "/pts/v2/refresh-payment-status/7652176144426365504805"         }     },     "clientReferenceInformation": {         "code": "refnum-1234",         "returnReconciliationId": "AE7GHI9V2XIS"     },     "id": "7652140293476589504806",     "orderInformation": {         "amountDetails": {             "currency": "EUR"         }     },     "processorInformation": {         "responseDetails": "00006",         "transactionId": "524844527123",         "responseCode": "00006"     },     "reconciliationId": "XFZ3ZIRG3C8C",     "refundAmountDetails": {         "refundAmount": "60.00"     },     "status": "REFUNDED",     "submitTimeUtc": "2025-12-08T17:13:51Z" } ``` Blik Transaction Requests {#thunes-blik-intro} ============================================== Blik is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. You can process a payment by sending a sale API request message to `Cybersource`. `Cybersource` sends your request to Thunes. Thunes approves the transaction and sends the request to the processor for settlement. You can also send a follow-on refund and check status API requests. Requirements ------------ You must have a merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country, country code, and currency supported by Blik. | Country | Country Code | Currency | Currency Code | |---------|--------------|--------------|---------------| | Poland | `PL` | Polish zloty | `PLN` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. Blik by Thunes Payment Workflow {#thunes-intro-flow-blik} ========================================================= This workflow describes the sequence of events that comprises a successful Blik payment. #### Figure: Blik by Thunes Payment Workflow ![Blik by Thunes Payment Workflow](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-blik.svg/jcr:content/renditions/original) 1. The customer begins to checkout on the merchant's website and chooses the Blik payment method.{#thunes-intro-flow-blik_step1} {#thunes-intro-flow-blik_step1} 2. The merchant sends a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-blik-intro/thunes-blik-sale-intro.md "").{#thunes-intro-flow-blik_step2} {#thunes-intro-flow-blik_step2} 3. `Cybersource` responds to the merchant with a `PENDING` status and a redirect URL.{#thunes-intro-flow-blik_step3} {#thunes-intro-flow-blik_step3} 4. The merchant redirects the customer to the URL.{#thunes-intro-flow-blik_step4} {#thunes-intro-flow-blik_step4} 5. The customer completes the checkout using Blik and is redirected to the merchant website.{#thunes-intro-flow-blik_step5} {#thunes-intro-flow-blik_step5} 6. The merchant sends a check status API request to `Cybersource`. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-blik-intro/thunes-blik-status-intro.md "").{#thunes-intro-flow-blik_step6} {#thunes-intro-flow-blik_step6} 7. `Cybersource` responds to the merchant with a `SETTLED` status.{#thunes-intro-flow-blik_step7} {#thunes-intro-flow-blik_step7} 8. The merchant displays a confirmation of the completed payment to the customer.{#thunes-intro-flow-blik_step8} {#thunes-intro-flow-blik_step8} {#thunes-intro-flow-blik_steps} Transaction Statuses Workflow {#thunes-blik-status-flow} ======================================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-blik-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-blik-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-blik-sale-intro} ======================================== Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using Blik. When the customer completes the checkout, the customer is redirected to your merchant website based on the success URL you include in the merchantInformation.successUrl request field. Line Items ---------- Line items are included in a request in the lineItem\[\] array. For more information about how to properly format line items in your request, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-blik-sale-intro_tax-info} ---------------------------------------------- You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-blik-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-blik-sale-intro_d7e355} Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-blik-intro/thunes-blik-status-intro.md ""). {#thunes-blik-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Processing a Sale {#thunes-blik-sale-task} ========================================== Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://api.cybersource.com``/pts/v2/payments`{#thunes-blik-sale-task_sale-prod-rest} endpoint and include these required fields: clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : paymentInformation.paymentType.method.name : Set to `BLIK`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionlist : Set to `AP_SALE`. {#thunes-blik-sale-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#thunes-blik-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the processorInformation.paymentUrl response field. ``` "paymentUrl": "https://payment.limonetikqualif.com/Blik/Order/PayPage/765137695558" ``` {#thunes-blik-sale-task_step-3-cmd} 4. When the customer completes the checkout using their Blik credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl field.{#thunes-blik-sale-task_step-4-cmd} {#thunes-blik-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7652141816856636104806" ``` {#thunes-blik-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-blik-sale-ex-rest} ====================================================== Request ``` {     "clientReferenceInformation": {         "code": "123"     },     "merchantInformation": {         "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel",         "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure",         "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess"     },     "paymentInformation": {         "paymentType": {             "method": {                 "name": "BLIK"             },             "name": "bankTransfer"         }     },     "orderInformation": {         "billTo": {             "firstName": "John",             "lastName": "Doe",             "country": "PT"         },         "amountDetails": {             "totalAmount": "600.00",             "currency": "PLN"         }     },     "processingInformation": {         "actionList": [             "AP_SALE"         ]     } } ``` Response to a Successful Request ``` {     "_links": {         "void": {             "method": "POST",             "href": "/pts/v2/payments/7652141816856636104806/voids"         },         "billingAgreement": {             "method": "POST",             "href": "/pts/v2/billing-agreements/7652141816856636104806"         },         "self": {             "method": "POST",             "href": "/pts/v2/payments/7652141816856636104806"         },         "refund": {             "method": "POST",             "href": "/pts/v2/payments/7652141816856636104806/refunds"         },         "status": {             "method": "POST",             "href": "/pts/v2/refresh-payment-status/7652141816856636104806"         }     },     "clientReferenceInformation": {         "code": "123"     },     "id": "7652141816856636104806",     "message": "Request was processed successfully.",     "orderInformation": {         "amountDetails": {             "totalAmount": "600.00",             "currency": "PLN"         }     },     "processorInformation": {         "responseDetails": "00001",         "paymentUrl": "https://payment.limonetikqualif.com/Blik/Order/PayPage/765137695558",         "transactionId": "765137695558",         "responseCode": "00001"     },     "reconciliationId": "XFZ55IRDYZ09",     "status": "PENDING",     "submitTimeUtc": "2025-12-08T17:16:22Z" } ``` Check a Request Status {#thunes-blik-status-intro} ================================================== You can retrieve the status of a pending sale or refund by sending a check status request. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-blik-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-blik-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either Blik rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either Blik rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Required Fields for Checking Status {#thunes-blik-status-req-fields} ==================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `BLIK`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `bankTransfer`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_STATUS`. Example: Checking a Request Status {#thunes-blik-status-ex-rest} ================================================================ Request ``` {     "clientReferenceInformation": {         "code": "refnum-1234"     },     "paymentInformation": {         "paymentType": {             "method": {                 "name": "BLIK"             },             "name": "bankTransfer"         }     },     "processingInformation": {         "actionList": "AP_STATUS"     } } ``` Response to a Successful Request ``` {     "clientReferenceInformation": {         "code": "refnum-1234"     },     "id": "7652140009076673004807",     "processorInformation": {         "responseDetails": "00004",         "token": "524844527089",         "responseCode": "00004"     },     "reconciliationId": "XFZ3ZIRG3C8H",     "status": "SETTLED" } ``` Refund a Payment {#thunes-blik-refund-intro} ============================================ You can refund a completed payment for the full amount or a partial amount by sending a refund request. Blik supports multiple refund requests when the total amount of all of the refund requests is less than the captured amount. Requesting a refund requires the request ID from the sale response. The request ID is located in the id response field. Endpoints {#thunes-blik-refund-intro_section_t2w_424_jyb} --------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-blik-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-blik-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- `Cybersource` responds to your refund request with one of these statuses as the status field value: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-status-intro.md ""). When you send a check status request to retrieve an updated refund status, these are the possible responses: * `FAILED`: The refund request failed. * `REFUNDED`: The settled payment is successfully refunded. Required Fields for Refunding a Payment {#thunes-blik-refund-req-fields} ======================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : orderInformation.amountDetails.currency : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `BLIK`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `bankTransfer`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_REFUND`. Optional Fields for Refunding a Payment {#thunes-blik-refund-opt-fields} ======================================================================== [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : [orderInformation.lineItems\[\].taxAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-tax-amount-request.md "") : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : Example: Refunding a Payment {#thunes-blik-refund-ex-rest} ========================================================== Request ``` {     "clientReferenceInformation": {         "code": "refnum-1234"     },     "paymentInformation": {         "paymentType": {             "method": {                 "name": "BLIK"             },             "name": "bankTransfer"         }     },     "processingInformation": {         "actionList": "AP_REFUND"     },     "orderInformation": {         "amountDetails": {             "totalAmount": "600.00",             "currency": "PLN"         }     } } ``` Response to a Successful Request ``` {     "_links": {         "self": {             "method": "GET",             "href": "/pts/v2/refunds/7652140293476589504806"         },         "status": {             "method": "POST",             "href": "/pts/v2/refresh-payment-status/7652140293476589504806"         }     },     "clientReferenceInformation": {         "code": "refnum-1234",         "returnReconciliationId": "AE7GHI9V2XIS"     },     "id": "7652140293476589504806",     "orderInformation": {         "amountDetails": {             "currency": "PLN"         }     },     "processorInformation": {         "responseDetails": "00006",         "transactionId": "524844527089",         "responseCode": "00006"     },     "reconciliationId": "XFZ3ZIRG3C8C",     "refundAmountDetails": {         "refundAmount": "600.00"     },     "status": "REFUNDED",     "submitTimeUtc": "2025-12-08T17:13:51Z" } ``` GrabPay Transaction Requests {#thunes-grabpay-intro} ==================================================== GrabPay is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. You can process a payment by sending a sale API request message to `Cybersource`. `Cybersource` sends your request to Thunes. Thunes approves the transaction and sends the request to the processor for settlement. You can also send a refund and check status API request as follow-on services. Requirements ------------ You must have a merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Supported Currencies -------------------- This table lists the currencies supported by GrabPay. | Currency | Currency Code | |----------|-------------------| | `IDR` | Indonesian rupiah | | `MYR` | Malaysian ringgit | | `PHP` | Philippine peso | [Supported Currencies and Currency Codes] Shipping Policy --------------- Goods can be shipped when the sale status is `SETTLED`. GrabPay by Thunes Payment Workflow {#thunes-intro-flow-grabpay} =============================================================== This workflow describes the sequence of events that comprises a successful GrabPay payment. #### Figure: GrabPay by Thunes Payment Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-grabpay.svg/jcr:content/renditions/original) 1. The customer begins to checkout on the merchant's website and chooses the GrabPay payment method.{#thunes-intro-flow-grabpay_step1} {#thunes-intro-flow-grabpay_step1} 2. The merchant sends a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-alipay-sale-intro.md "").{#thunes-intro-flow-grabpay_step2} {#thunes-intro-flow-grabpay_step2} 3. `Cybersource` responds to the merchant with a `PENDING` status and a redirect URL.{#thunes-intro-flow-grabpay_step3} {#thunes-intro-flow-grabpay_step3} 4. The merchant redirects the customer to the URL.{#thunes-intro-flow-grabpay_step4} {#thunes-intro-flow-grabpay_step4} 5. The customer completes the checkout using GrabPay and is redirected to the merchant website.{#thunes-intro-flow-grabpay_step5} {#thunes-intro-flow-grabpay_step5} 6. The merchant sends a check status API request to `Cybersource`. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-alipay-status-intro.md "").{#thunes-intro-flow-grabpay_step6} {#thunes-intro-flow-grabpay_step6} 7. `Cybersource` responds to the merchant with a `SETTLED` status.{#thunes-intro-flow-grabpay_step7} {#thunes-intro-flow-grabpay_step7} 8. The merchant displays a confirmation of the completed payment to the customer.{#thunes-intro-flow-grabpay_step8} {#thunes-intro-flow-grabpay_step8} {#thunes-intro-flow-grabpay_steps} Transaction Statuses Workflow {#thunes-grabpay-status-flow} =========================================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-grabpay-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-grabpay-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-grabpay-sale-intro} =========================================== Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using GrabPay. When the customer completes the checkout, the customer is redirected to the merchant website using the success-URL provided in the sale request. Line Items ---------- Line items are included in a request in the lineItem\[\] array. For more information about how to properly format line items in your request, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-grabpay-sale-intro_tax-info} ------------------------------------------------- You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-grabpay-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-grabpay-sale-intro_d7e355} Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-grabpay-intro/thunes-grabpay-status-intro.md ""). {#thunes-grabpay-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Processing a Sale {#thunes-grabpay-sale-task} ============================================= Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://api.cybersource.com``/pts/v2/payments`{#thunes-grabpay-sale-task_sale-prod-rest} endpoint and include these required fields: billTo.country : clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems.productCode : orderInformation.lineItems.productName : orderInformation.lineItems.productSKU : orderInformation.lineItems.quantity : orderInformation.lineItems.totalAmount : orderInformation.lineItems.unitPrice : orderInformation.shipTo.address1 : orderInformation.shipTo.country : orderInformation.shipTo.email : orderInformation.shipTo.firstName : orderInformation.shipTo.lastName : orderInformation.shipTo.locality : orderInformation.shipTo.phoneNumber : paymentInformation.paymentType.method.name : Set to GRABPAY. paymentInformation.paymentType.name : processingInformation.actionList : {#thunes-grabpay-sale-task_step-1-cmd} 2. You can include these optional fields in the request: [orderInformation.amountDetails.discountAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-discount-amount.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [orderInformation.billTo.address1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-address1.md "") : [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.billTo.locality](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-locality.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : orderInformation.lineItems\[\].productDescription : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : orderInformation.lineItems\[\].taxAmount : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : [orderInformation.shipTo.address1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-street1.md "") : [orderInformation.shipTo.address2](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-street2.md "") : [orderInformation.shipTo.administrativeArea](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-county.md "") : [orderInformation.shipTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-country.md "") : [orderInformation.shipTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-first-name.md "") : [orderInformation.shipTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-last-name.md "") : [orderInformation.shipTo.locality](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-locality.md "") : [orderInformation.shipTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-phone-num.md "") : [orderInformation.shipTo.postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-postal-code.md "") : {#thunes-grabpay-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#thunes-grabpay-sale-task_step-3-cmd} 4. When the customer completes the checkout using their GrabPay credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl field.{#thunes-grabpay-sale-task_step-4-cmd} {#thunes-grabpay-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7551853376466526104891" ``` {#thunes-grabpay-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-grabpay-sale-ex-rest} ========================================================= Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "GRABPAY" }, "name": "eWallet" } }, "billTo": { "country": "MY" }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "Paris", "administrativeArea": "AR", "postalCode": "75001", "country": "PT", "email": "nredhi@visa.com", "phoneNumber": "33623456789" }, "shipTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "Paris", "country": "MY", "email": "nredhi@visa.com", "phoneNumber": "33623456789" }, "amountDetails": { "totalAmount": "600.00", "currency": "MYR" }, "lineItems": [ { "unitPrice": "100.00", "quantity": "6", "productSKU": "testI", "productName": "TV", "productCode": "4564", "totalAmount": "600.00" } ] }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7551853376466526104891/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7551853376466526104891" }, "self": { "method": "POST", "href": "/pts/v2/payments/7551853376466526104891" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7551853376466526104891/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551853376466526104891" } }, "clientReferenceInformation": { "code": "123" }, "id": "7551853376466526104891", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "600.00", "currency": "MYR" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetik.com/Razer/Order/PayPage/755025063216", "transactionId": "755025063216", "responseCode": "00001" }, "reconciliationId": "XETXPDYE7WDK", "status": "PENDING", "submitTimeUtc": "2025-08-14T15:28:58Z" } ``` Check a Request Status {#thunes-grabpay-status-intro} ===================================================== You can retrieve the status of a pending sale or refund by sending a check status request. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-grabpay-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-grabpay-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either GrabPay rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either GrabPay rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Required Fields for Checking Status {#thunes-grabpay-status-req-fields} ======================================================================= [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `GRABPAY`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `eWallet`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_STATUS`. Example: Checking a Request Status {#thunes-grabpay-status-ex-rest} =================================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "GRABPAY" }, "name": "eWallet" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7551854954556394804888", "processorInformation": { "responseDetails": "00001", "token": "755025063216", "responseCode": "00001" }, "reconciliationId": "XEL42E9I5E3C", "status": "PENDING" } ``` Refund a Payment {#thunes-grabpay-refund-intro} =============================================== You can refund a completed payment for the full amount or a partial amount by sending a refund request. GrabPay supports multiple refund requests when the total amount of all of the refund requests is less than the captured amount. Requesting a refund requires the request ID from the sale response. The request ID is located in the id response field. Endpoints {#thunes-grabpay-refund-intro_section_t2w_424_jyb} ------------------------------------------------------------ **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-grabpay-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-grabpay-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- `Cybersource` responds to your refund request with one of these statuses as the status field value: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-grabpay-intro/thunes-grabpay-status-intro.md ""). When you send a check status request to retrieve an updated refund status, these are the possible responses: * `FAILED`: The refund request failed. * `REFUNDED`: The settled payment is successfully refunded. Required Fields for Refunding a Payment {#thunes-grabpay-refund-req-fields} =========================================================================== clientReferenceInformation.code : orderInformation.amountDetails.currency : Set to `MYR`. orderInformation.amountDetails.totalAmount : paymentInformation.paymentType.method.name : Set to `GRABPAY`. paymentInformation.paymentType.name : Set to `eWallet`. processingInformation.actionList : Set to `AP_REFUND`. Optional Fields for Refunding a Payment {#thunes-grabpay-refund-opt-fields} =========================================================================== [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : [orderInformation.lineItems\[\].taxAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-tax-amount-request.md "") : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : Example: Refunding a Payment {#thunes-grabpay-refund-ex-rest} ============================================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "GRABPAY" }, "name": "eWallet" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "600.00", "currency": "MYR" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7551855794346633404893" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551855794346633404893" } }, "id": "7551855794346633404893", "orderInformation": { "amountDetails": { "currency": "MYR" } }, "clientReferenceInformation": { "code": "refnum-1234" }, "processorInformation": { "responseDetails": "00006", "transactionId": "430844862998", "responseCode": "00006" }, "reconciliationId": "XFZ3ZE1G1DID", "refundAmountDetails": { "refundAmount": "5.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-08T18:14:18Z" } ``` GroupUp Transaction Requests {#thunes-groupup-intro} ==================================================== GroupUp is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. With GroupUp you can process payments, refund payments, and retrieve the status of a pending payment or refund. This section describes how to process GroupUp transactions using the `REST API`. Requirement ----------- You must receive a Thunes merchant ID before you can begin processing payments. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country and currency that is supported by GroupUp. | Supported Country | Country Code | Supported Currency | Currency Code | |-------------------|--------------|--------------------|---------------| | France | `FR` | Euro | `EUR` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. GroupUp by Thunes Transaction Workflow {#thunes-intro-flow-groupup} =================================================================== This workflow describes the sequence of events that comprises a successful GroupUp payment and refund. #### Figure: GroupUp by Thunes Transaction Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-groupup-600x700.svg/jcr:content/renditions/original) 1. The customer begins to checkout on your website and chooses the GroupUp payment method.{#thunes-intro-flow-groupup_step1} {#thunes-intro-flow-groupup_step1} 2. You send a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-groupup-intro/thunes-groupup-sale-intro.md "").{#thunes-intro-flow-groupup_step2} {#thunes-intro-flow-groupup_step2} 3. `Cybersource` responds to you with a `PENDING` status, GroupUp redirect URL, and sale request ID.{#thunes-intro-flow-groupup_step3} {#thunes-intro-flow-groupup_step3} 4. You redirect the customer to the GroupUp URL.{#thunes-intro-flow-groupup_step4} {#thunes-intro-flow-groupup_step4} 5. The customer completes the checkout using GroupUp and is redirected to your website.{#thunes-intro-flow-groupup_step5} {#thunes-intro-flow-groupup_step5} 6. You send a check status API request to `Cybersource`. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-groupup-intro/thunes-groupup-status-intro.md "").{#thunes-intro-flow-groupup_step6} {#thunes-intro-flow-groupup_step6} 7. `Cybersource` responds to you with a `SETTLED` status.{#thunes-intro-flow-groupup_step7} {#thunes-intro-flow-groupup_step7} 8. You confirm the payment to the customer.{#thunes-intro-flow-groupup_step8} {#thunes-intro-flow-groupup_step8} 9. The customer returns the purchase. 10. You send a refund API request to `Cybersource` with the sale request ID. For more information, see [Refund a Payment](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-groupup-intro/thunes-groupup-refund-intro.md ""). 11. `Cybersource` responds to you with a `REFUNDED` status and refund request ID. 12. You send a check status request to `Cybersource` to verify the refund status. 13. `Cybersource` respond to you with a `REFUNDED` status. 14. You confirm the refund to the customer. Transaction Statuses Workflow {#thunes-groupup-status-flow} =========================================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-groupup-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-groupup-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-groupup-sale-intro} =========================================== This section describes how to send a sale request to process a payment. A sale request authorizes and captures a payment in the same request. A successful sale response includes an GroupUp redirect URL and a `PENDING` status. Redirect the customer to the GroupUp URL to allow the customer to complete the checkout using their GroupUp account. When the customer completes the checkout, the customer is redirected to your website. When you receive a successful response, save the sale request ID in the id response field to perform a follow-on check status request or refund request. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-groupup-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-groupup-sale-intro_d7e355} Processing a Sale {#thunes-groupup-sale-task} ============================================= Follow these steps to successfully process sale. 1. Send a `POST` request to the endpoint and include these required fields: clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : paymentInformation.paymentType.method.name : Set to `GROUPUP`. paymentInformation.paymentType.name : processingInformation.actionList : Set to `AP_SALE`. {#thunes-groupup-sale-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#thunes-groupup-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#thunes-groupup-sale-task_step-3-cmd} 4. When the customer completes the checkout using their GroupUp credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl request field.{#thunes-groupup-sale-task_step-4-cmd} {#thunes-groupup-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7546757907606782704806" ``` {#thunes-groupup-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-groupup-sale-ex-rest} ========================================================= Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "GROUPUP" }, "name": "Voucher" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "country": "FR", "email": "test@test.com" }, "amountDetails": { "totalAmount": "10.00", "currency": "EUR" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7546757907606782704806/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7546757907606782704806" }, "self": { "method": "POST", "href": "/pts/v2/payments/7546757907606782704806" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7546757907606782704806/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546757907606782704806" } }, "clientReferenceInformation": { "code": "123" }, "id": "7546757907606782704806", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "10.00", "currency": "EUR" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/Conecs/Order/PayPage/960636547358", "transactionId": "960636547358", "responseCode": "00001" }, "reconciliationId": "XFZ55E33PZ6F", "status": "PENDING", "submitTimeUtc": "2025-08-08T17:56:32Z" } ``` Response Statuses for Processing a Sale {#thunes-groupup-sale-status} ===================================================================== `Cybersource` responds to your sale request with one of these statuses in the status field: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send a check status request as often as necessary to obtain the information that you need. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-groupup-intro/thunes-groupup-status-intro.md ""). {#thunes-groupup-sale-status_ul_pdp_lkr_3yb} Check a Transaction Status {#thunes-groupup-status-intro} ========================================================= This section describes how to retrieve the current status of a sale or refund. Send a check status request to know if a pending sale is settled, or to verify that a refund request is refunded. Use the check status request as often as necessary to obtain the information that you need. The check status request requires the request ID from the sale or refund response. The request ID is in the id response field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-groupup-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-groupup-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Required Fields for Checking a Status {#thunes-groupup-status-req-fields} ========================================================================= clientReferenceInformation.code : paymentInformation.paymentType.method.name : Set to `GROUPUP`. paymentInformation.paymentType.name : processingInformation.actionList : Set to `AP_STATUS`. Example: Checking a Status {#thunes-groupup-status-ex-rest} =========================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "GROUPUP" }, "name": "Voucher" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7546760673456997804806", "processorInformation": { "responseDetails": "00004", "token": "960636547358", "responseCode": "00004" }, "reconciliationId": "XFZ3ZE1G1DAT", "status": "SETTLED" } ``` Response Statuses for Checking a Status {#thunes-groupup-check-status} ====================================================================== `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either GroupUp rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either GroupUp rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Refund a Payment {#thunes-groupup-refund-intro} =============================================== This section describes how to refund a payment. You can refund a settled payment for the full amount or a partial amount by sending a refund request. Multiple partial refund requests are also supported, and the total amount of all of the refund requests must be less than the settled amount. Requesting a refund requires the sale request ID from the sale response. The sale request ID is in the id response field. Endpoints {#thunes-groupup-refund-intro_section_t2w_424_jyb} ------------------------------------------------------------ **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-groupup-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-groupup-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Required Fields for Refunding a Payment {#thunes-groupup-refund-req-fields} =========================================================================== clientReferenceInformation.code : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : paymentInformation.paymentType.method.name : Set to `GROUPUP`. paymentInformation.paymentType.name : processingInformation.actionList : Set to `AP_REFUND`. Example: Refunding a Payment {#thunes-groupup-refund-ex-rest} ============================================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "GROUPUP" }, "name": "Voucher" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "5.00", "currency": "EUR" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7546762147596482204807" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546762147596482204807" } }, "clientReferenceInformation": { "code": "refnum-1234", "returnReconciliationId": "R015AE1TJE8N" }, "id": "7546762147596482204807", "orderInformation": { "amountDetails": { "currency": "EUR" } }, "processorInformation": { "responseDetails": "00006", "transactionId": "960636547358", "responseCode": "00006" }, "reconciliationId": "XFZ55E33PZ6F", "refundAmountDetails": { "refundAmount": "5.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-08T18:03:35Z" } ``` Response Statuses for Refunding a Payment {#thunes-groupup-refund-status} ========================================================================= `Cybersource` responds to your refund request with one of these statuses in the status field: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Send a check status request to verify that the status is refunded. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-groupup-intro/thunes-groupup-status-intro.md ""). iDEAL Transaction Requests {#thunes-ideal-intro} ================================================ iDEAL is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. With iDEAL you can process payments, refund payments, and retrieve the status of a pending payment or refund. This section describes how to process iDEAL transactions using the `REST API`. Requirement ----------- You must receive a Thunes merchant ID before you can begin processing payments. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country and currency that is supported by iDEAL. | Supported Country | Country Code | Supported Currency | Currency Code | |-------------------|--------------|--------------------|---------------| | Netherlands | `NL` | Euro | `EUR` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. iDEAL by Thunes Transaction Workflow {#thunes-intro-flow-ideal} =============================================================== This workflow describes the sequence of events that comprises a successful iDEAL payment and refund. #### Figure: iDEAL by Thunes Transaction Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-ideal-600x700.svg/jcr:content/renditions/original) 1. The customer begins to checkout on your website and chooses the iDEAL payment method.{#thunes-intro-flow-ideal_step1} {#thunes-intro-flow-ideal_step1} 2. You send a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ideal-intro/thunes-ideal-sale-intro.md "").{#thunes-intro-flow-ideal_step2} {#thunes-intro-flow-ideal_step2} 3. `Cybersource` responds to you with a `PENDING` status, iDEAL redirect URL, and sale request ID.{#thunes-intro-flow-ideal_step3} {#thunes-intro-flow-ideal_step3} 4. You redirect the customer to the iDEAL URL.{#thunes-intro-flow-ideal_step4} {#thunes-intro-flow-ideal_step4} 5. The customer completes the checkout using iDEAL and is redirected to your website.{#thunes-intro-flow-ideal_step5} {#thunes-intro-flow-ideal_step5} 6. You send a check status API request to `Cybersource`. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ideal-intro/thunes-ideal-status-intro.md "").{#thunes-intro-flow-ideal_step6} {#thunes-intro-flow-ideal_step6} 7. `Cybersource` responds to you with a `SETTLED` status.{#thunes-intro-flow-ideal_step7} {#thunes-intro-flow-ideal_step7} 8. You confirm the payment to the customer.{#thunes-intro-flow-ideal_step8} {#thunes-intro-flow-ideal_step8} 9. The customer returns the purchase. 10. You send a refund API request to `Cybersource` with the sale request ID. For more information, see [Refund a Payment](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ideal-intro/thunes-ideal-refund-intro.md ""). 11. `Cybersource` responds to you with a `REFUNDED` status and refund request ID. 12. You send a check status request to `Cybersource` to verify the refund status. 13. `Cybersource` respond to you with a `REFUNDED` status. 14. You confirm the refund to the customer. Transaction Statuses Workflow {#thunes-ideal-status-flow} ========================================================= This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-ideal-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-ideal-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-ideal-sale-intro} ========================================= This section describes how to send a sale request to process a payment. A sale request authorizes and captures a payment in the same request. A successful sale response includes an iDEAL redirect URL and a `PENDING` status. Redirect the customer to the iDEAL URL to allow the customer to complete the checkout using their iDEAL account. When the customer completes the checkout, the customer is redirected to your website. When you receive a successful response, save the sale request ID in the id response field to perform a follow-on check status request or refund request. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-ideal-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-ideal-sale-intro_d7e355} Processing a Sale {#thunes-ideal-sale-task} =========================================== Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://apitest.cybersource.com``/pts/v2/payments`{#thunes-ideal-sale-task_sale-test-rest} endpoint and include these required fields: clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.phoneNumber : paymentInformation.paymentType.method.name : Set to `IDEALT`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionList : Set to `AP_SALE`. {#thunes-ideal-sale-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#thunes-ideal-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#thunes-ideal-sale-task_step-3-cmd} 4. When the customer completes the checkout using their iDEAL credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl request field.{#thunes-ideal-sale-task_step-4-cmd} {#thunes-ideal-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7551878413816917004807" ``` {#thunes-ideal-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-ideal-sale-ex-rest} ======================================================= Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "IDEALT" }, "name": "bankTransfer" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "country": "NL", "email": "test@test.com", "phoneNumber": "33623456789" }, "amountDetails": { "totalAmount": "600.00", "currency": "EUR" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7551878413816917004807/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7551878413816917004807" }, "self": { "method": "POST", "href": "/pts/v2/payments/7551878413816917004807" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7551878413816917004807/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551878413816917004807" } }, "clientReferenceInformation": { "code": "123" }, "id": "7551878413816917004807", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "600.00", "currency": "EUR" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/PPRO/Order/PayPage/555912063193", "transactionId": "555912063193", "responseCode": "00001" }, "reconciliationId": "XFZ55E5TB5S3", "status": "PENDING", "submitTimeUtc": "2025-08-14T16:10:42Z" } ``` Response Statuses for Processing a Sale {#thunes-ideal-sale-status} =================================================================== `Cybersource` responds to your sale request with one of these statuses in the status field: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send a check status request as often as necessary to obtain the information that you need. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ideal-intro/thunes-ideal-status-intro.md ""). {#thunes-ideal-sale-status_ul_pdp_lkr_3yb} Check a Transaction Status {#thunes-ideal-status-intro} ======================================================= This section describes how to retrieve the current status of a sale or refund. Send a check status request to know if a pending sale is settled, or to verify that a refund request is refunded. Use the check status request as often as necessary to obtain the information that you need. The check status request requires the request ID from the sale or refund response. The request ID is in the id response field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-ideal-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-ideal-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Required Fields for Checking a Status {#thunes-ideal-status-req-fields} ======================================================================= clientReferenceInformation.code : paymentInformation.paymentType.method.name : Set to `IDEALT`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionList : Set to `AP_STATUS`. Example: Checking a Status {#thunes-ideal-status-ex-rest} ========================================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "IDEALT" }, "name": "bankTransfer" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7551879994136016504807", "processorInformation": { "responseDetails": "00004", "token": "555912063193", "responseCode": "00004" }, "reconciliationId": "XFZ55E5TB5TR", "status": "SETTLED" } ``` Response Statuses for Checking a Status {#thunes-ideal-check-status} ==================================================================== `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either iDEAL rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either iDEAL rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Refund a Payment {#thunes-ideal-refund-intro} ============================================= This section describes how to refund a payment. You can refund a settled payment for the full amount or a partial amount by sending a refund request. Multiple partial refund requests are also supported, and the total amount of all of the refund requests must be less than the settled amount. Requesting a refund requires the sale request ID from the sale response. The sale request ID is in the id response field. Endpoints {#thunes-ideal-refund-intro_section_t2w_424_jyb} ---------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-ideal-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-ideal-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Required Fields for Refunding a Payment {#thunes-ideal-refund-req-fields} ========================================================================= clientReferenceInformation.code : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : paymentInformation.paymentType.method.name : Set to `P24`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionList : Set to `AP_REFUND`. Example: Refunding a Payment {#thunes-ideal-refund-ex-rest} =========================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "IDEALT" }, "name": "bankTransfer" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "600.00", "currency": "EUR" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7551880639626418704805" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551880639626418704805" } }, "clientReferenceInformation": { "code": "refnum-1234", "returnReconciliationId": "HX0HTE22MIIY" }, "id": "7551880639626418704805", "orderInformation": { "amountDetails": { "currency": "EUR" } }, "processorInformation": { "responseDetails": "00006", "transactionId": "555912063193", "responseCode": "00006" }, "reconciliationId": "XFZ55E5TB5S3", "refundAmountDetails": { "refundAmount": "600.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-14T16:14:25Z" } ``` Response Statuses for Refund a Payment {#thunes-ideal-refund-status} ==================================================================== `Cybersource` responds to your refund request with one of these statuses in the status field: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Send a check status request to verify that the status is refunded. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ideal-intro/thunes-ideal-status-intro.md ""). MobilePay Transaction Requests {#concept} ========================================= MobilePay is an e-wallet payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. With MobilePay you can process payments, refund payments, and retrieve the status of a pending payment or refund. This section describes how to process MobilePay transactions using the `REST API`. Requirement ----------- You must receive a Thunes merchant ID before you can begin processing payments. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country and currency that is supported by MobilePay. | Supported Country | Country Code | Supported Currency | Currency Code | |-------------------|--------------|--------------------|---------------| | Denmark | `DK` | Danish krone | `DKK` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. MobilePay by Thunes Transaction Workflow {#thunes-intro-flow-mobilepay} ======================================================================= This workflow describes the sequence of events that comprises a successful MobilePay payment and refund. #### Figure: MobilePay by Thunes Transaction Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-mobilepay-600x700.svg/jcr:content/renditions/original) 1. The customer begins to checkout on your website and chooses the MobilePay payment method.{#thunes-intro-flow-mobilepay_step1} {#thunes-intro-flow-mobilepay_step1} 2. You send a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-mobilepay-intro/thunes-mobilepay-sale-intro.md "").{#thunes-intro-flow-mobilepay_step2} {#thunes-intro-flow-mobilepay_step2} 3. `Cybersource` responds to you with a `PENDING` status, MobilePay redirect URL, and sale request ID.{#thunes-intro-flow-mobilepay_step3} {#thunes-intro-flow-mobilepay_step3} 4. You redirect the customer to the MobilePay URL.{#thunes-intro-flow-mobilepay_step4} {#thunes-intro-flow-mobilepay_step4} 5. The customer completes the checkout using MobilePay and is redirected to your website.{#thunes-intro-flow-mobilepay_step5} {#thunes-intro-flow-mobilepay_step5} 6. You send a check status API request to `Cybersource`. For more information, see [Check a Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-mobilepay-intro/thunes-mobilepay-status-intro.md "").{#thunes-intro-flow-mobilepay_step6} {#thunes-intro-flow-mobilepay_step6} 7. `Cybersource` responds to you with a `SETTLED` status.{#thunes-intro-flow-mobilepay_step7} {#thunes-intro-flow-mobilepay_step7} 8. You confirm the payment to the customer.{#thunes-intro-flow-mobilepay_step8} {#thunes-intro-flow-mobilepay_step8} 9. The customer returns the purchase. 10. You send a refund API request to `Cybersource` with the sale request ID. For more information, see [Refund a Payment](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-mobilepay-intro/thunes-mobilepay-refund-intro.md ""). 11. `Cybersource` responds to you with a `REFUNDED` status and refund request ID. 12. You send a check status request to `Cybersource` to verify the refund status. 13. `Cybersource` respond to you with a `REFUNDED` status. 14. You confirm the refund to the customer. Transaction Statuses Workflow {#concept} ======================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#concept_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#concept_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#concept} ========================= This section describes how to send a sale request to process a payment. A sale request authorizes and captures a payment in the same request. A successful sale response includes an MobilePay redirect URL and a `PENDING` status. Redirect the customer to the MobilePay URL to allow the customer to complete the checkout using their MobilePay account. When the customer completes the checkout, the customer is redirected to your website. When you receive a successful response, save the sale request ID in the id response field to perform a follow-on check status request or refund request. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#concept_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#concept_d7e355} Processing a Sale {#paypal-session-task} ======================================== Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://apitest.cybersource.com``/pts/v2/payments`{#paypal-session-task_sale-test-rest} endpoint and include these required fields: clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : Set to `DKK`. orderInformation.amountDetails.totalAmount : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : paymentInformation.paymentType.method.name : Set to `MOBILEPAY`. paymentInformation.paymentType.name : Set to `eWallet`. processingInformation.actionList : Set to `AP_SALE`. {#paypal-session-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#paypal-session-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#paypal-session-task_codeblock_us3_hdx_lgc} {#paypal-session-task_step-3-cmd} 4. When the customer completes the checkout using their MobilePay credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl request field.{#paypal-session-task_step-4-cmd} {#paypal-session-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7533004326616427604807" ``` {#paypal-session-task_step-5-cmd} Example: Processing a Sale {#x-ex-rest} ======================================= Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "MOBILEPAY" }, "name": "eWallet" } }, "billTo": { "country": "DK" }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "country": "DK", "email": "nredhi@visa.com", "phoneNumber": "33623456789" }, "shipTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "country": "DK", "email": "nredhi@visa.com", "phoneNumber": "33623456789" }, "amountDetails": { "totalAmount": "43.00", "currency": "DKK" }, "lineItems": [ { "unitPrice": "43.00", "quantity": "1", "productSKU": "testI", "productName": "TV", "productCode": "4564", "totalAmount": "43.00" } ] }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7533004326616427604807/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7533004326616427604807" }, "self": { "method": "POST", "href": "/pts/v2/payments/7533004326616427604807" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7533004326616427604807/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7533004326616427604807" } }, "clientReferenceInformation": { "code": "123" }, "id": "7533004326616427604807", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "43.00", "currency": "DKK" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://lmk.limonetikqualif.com/mobilepay/PayPage/823876344653", "transactionId": "823876344653", "responseCode": "00001" }, "reconciliationId": "XFZ3YDF243RW", "status": "PENDING", "submitTimeUtc": "2025-07-23T19:53:54Z" } ``` Response Statuses for Processing a Sale {#x-req-fields} ======================================================= `Cybersource` responds to your sale request with one of these statuses in the status field: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send a check status request as often as necessary to obtain the information that you need. For more information, see [Check a Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-mobilepay-intro/thunes-mobilepay-status-intro.md ""). {#x-req-fields_ul_pdp_lkr_3yb} Check a Status {#concept} ========================= This section describes how to retrieve the current status of a sale or refund. Send a check status request to know if a pending sale is settled, or to verify that a refund request is refunded. Use the check status request as often as necessary to obtain the information that you need. The check status request requires the request ID from the sale or refund response. The request ID is in the id response field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#concept_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#concept_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Required Fields for Checking a Status {#x-req-fields} ===================================================== clientReferenceInformation.code : paymentInformation.paymentType.method.name : Set to `MOBILEPAY`. paymentInformation.paymentType.name : Set to `eWallet`. processingInformation.actionList : Set to `AP_STATUS`. Example: Checking a Status {#x-ex-rest} ======================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "MOBILEPAY" }, "name": "eWallet" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7533005724356445104807", "processorInformation": { "responseDetails": "00004", "token": "823876344653", "responseCode": "00004" }, "reconciliationId": "XFZ3YDF243SA", "status": "SETTLED" } ``` Response Statuses for Checking a Status {#x-req-fields} ======================================================= `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either MobilePay rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either MobilePay rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Refund a Payment {#concept} =========================== This section describes how to refund a payment. You can refund a settled payment for the full amount or a partial amount by sending a refund request. Multiple partial refund requests are also supported, and the total amount of all of the refund requests must be less than the settled amount. Requesting a refund requires the sale request ID from the sale response. The sale request ID is in the id response field. Endpoints {#concept_section_t2w_424_jyb} ---------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#concept_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#concept_d7e385} The *{id}* is the request ID contained in the original transaction request. Required Fields for Refunding a Payment {#x-req-fields} ======================================================= clientReferenceInformation.code : orderInformation.amountDetails.currency : Set to `DKK`. orderInformation.amountDetails.totalAmount : paymentInformation.paymentType.method.name : Set to `MOBILEPAY`. paymentInformation.paymentType.name : Set to `eWallet`. processingInformation.actionList : Set to `AP_REFUND`. Example: Refunding a Payment {#x-ex-rest} ========================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "MOBILEPAY" }, "name": "eWallet" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "43.00", "currency": "DKK" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7533006119896971604805" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7533006119896971604805" } }, "clientReferenceInformation": { "code": "refnum-1234", "returnReconciliationId": "3MDKOCX65QSM" }, "id": "7533006119896971604805", "orderInformation": { "amountDetails": { "currency": "DKK" } }, "processorInformation": { "responseDetails": "00006", "transactionId": "823876344653", "responseCode": "00006" }, "reconciliationId": "XFZ3YDF243RW", "refundAmountDetails": { "refundAmount": "43.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-07-23T19:56:55Z" } ``` Response Statuses for Refunding a Payment {#x-req-fields} ========================================================= `Cybersource` responds to your refund request with one of these statuses in the status field: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Send a check status request to verify that the status is refunded. For more information, see [Check a Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-mobilepay-intro/thunes-mobilepay-status-intro.md ""). Multibanco Transaction Requests {#concept} ========================================== Multibanco is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. With Multibanco you can process payments, refund payments, and retrieve the status of a pending payment or refund. This section describes how to process Multibanco transactions using the `REST API`. Requirement ----------- You must receive a Thunes merchant ID before you can begin processing payments. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country and currency that is supported by Multibanco. | Supported Country | Country Code | Supported Currency | Currency Code | |-------------------|--------------|--------------------|---------------| | Portugal | `PT` | Euro | `EUR` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. Multibanco by Thunes Transaction Workflow {#thunes-intro-flow-multibanco} ========================================================================= This workflow describes the sequence of events that comprises a successful Multibanco payment and refund. #### Figure: Multibanco Transaction Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-multibanco-600x700.svg/jcr:content/renditions/original) 1. The customer begins to checkout on your website and chooses the Multibanco payment method.{#thunes-intro-flow-multibanco_step1} {#thunes-intro-flow-multibanco_step1} 2. You send a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-multibanco-intro/thunes-multibanco-sale-intro.md "").{#thunes-intro-flow-multibanco_step2} {#thunes-intro-flow-multibanco_step2} 3. `Cybersource` responds to you with a `PENDING` status, Multibanco redirect URL, and sale request ID.{#thunes-intro-flow-multibanco_step3} {#thunes-intro-flow-multibanco_step3} 4. You redirect the customer to the Multibanco URL.{#thunes-intro-flow-multibanco_step4} {#thunes-intro-flow-multibanco_step4} 5. The customer completes the checkout using Multibanco and is redirected to your website.{#thunes-intro-flow-multibanco_step5} {#thunes-intro-flow-multibanco_step5} 6. You send a check status API request to `Cybersource`. For more information, see [Check a Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-multibanco-intro/thunes-multibanco-status-intro.md "").{#thunes-intro-flow-multibanco_step6} {#thunes-intro-flow-multibanco_step6} 7. `Cybersource` responds to you with a `SETTLED` status.{#thunes-intro-flow-multibanco_step7} {#thunes-intro-flow-multibanco_step7} 8. You confirm the payment to the customer.{#thunes-intro-flow-multibanco_step8} {#thunes-intro-flow-multibanco_step8} 9. The customer returns the purchase. 10. You send a refund API request to `Cybersource` with the sale request ID. For more information, see [Refund a Payment](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-multibanco-intro/thunes-multibanco-refund-intro.md ""). 11. `Cybersource` responds to you with a `REFUNDED` status and refund request ID. 12. You send a check status request to `Cybersource` to verify the refund status. 13. `Cybersource` respond to you with a `REFUNDED` status. 14. You confirm the refund to the customer. Transaction Statuses Workflow {#concept} ======================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#concept_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#concept_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#concept} ========================= This section describes how to send a sale request to process a payment. A sale request authorizes and captures a payment in the same request. A successful sale response includes an Multibanco redirect URL and a `PENDING` status. Redirect the customer to the Multibanco URL to allow the customer to complete the checkout using their Multibanco account. When the customer completes the checkout, the customer is redirected to your website. When you receive a successful response, save the sale request ID in the id response field to perform a follow-on check status request or refund request. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#concept_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#concept_d7e355} Processing a Sale {#paypal-session-task} ======================================== Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://apitest.cybersource.com``/pts/v2/payments`{#paypal-session-task_sale-test-rest} endpoint and include these required fields: clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.phoneNumber : paymentInformation.paymentType.method.name : Set to `MULTIBANCO`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionList : Set to `AP_SALE`. {#paypal-session-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#paypal-session-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#paypal-session-task_codeblock_us3_hdx_lgc} {#paypal-session-task_step-3-cmd} 4. When the customer completes the checkout using their Multibanco credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl request field.{#paypal-session-task_step-4-cmd} {#paypal-session-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7551889104536542704807" ``` {#paypal-session-task_step-5-cmd} Example: Processing a Sale {#x-ex-rest} ======================================= Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "MULTIBANCO" }, "name": "bankTransfer" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "country": "PT", "email": "test@test.com", "phoneNumber": "33623456789" }, "amountDetails": { "totalAmount": "600.00", "currency": "EUR" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7551889104536542704807/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7551889104536542704807" }, "self": { "method": "POST", "href": "/pts/v2/payments/7551889104536542704807" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7551889104536542704807/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551889104536542704807" } }, "clientReferenceInformation": { "code": "123" }, "id": "7551889104536542704807", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "600.00", "currency": "EUR" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/IfThenPay/Order/PayPage/665437010510", "transactionId": "665437010510", "responseCode": "00001" }, "reconciliationId": "XFZ3ZE5XDZTC", "status": "PENDING", "submitTimeUtc": "2025-08-14T16:28:31Z" } ``` Response Statuses for Processing a Sale {#x-req-fields} ======================================================= `Cybersource` responds to your sale request with one of these statuses in the status field: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send a check status request as often as necessary to obtain the information that you need. For more information, see [Check a Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-multibanco-intro/thunes-multibanco-status-intro.md ""). {#x-req-fields_ul_pdp_lkr_3yb} Check a Status {#concept} ========================= This section describes how to retrieve the current status of a sale or refund. Send a check status request to know if a pending sale is settled, or to verify that a refund request is refunded. Use the check status request as often as necessary to obtain the information that you need. The check status request requires the request ID from the sale or refund response. The request ID is in the id response field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#concept_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#concept_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Required Fields for Checking a Status {#x-req-fields} ===================================================== clientReferenceInformation.code : paymentInformation.paymentType.method.name : Set to `MULTIBANCO`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionList : Set to `AP_STATUS`. Example: Checking a Status {#x-ex-rest} ======================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "MULTIBANCO" }, "name": "bankTransfer" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7551890187526961804805", "processorInformation": { "responseDetails": "00001", "token": "665437010510", "responseCode": "00001" }, "reconciliationId": "XFZ3ZE5XDZTI", "status": "PENDING" } ``` Response Statuses for Checking a Status {#x-req-fields} ======================================================= `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either Multibanco rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either Multibanco rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Refund a Payment {#concept} =========================== This section describes how to refund a payment. You can refund a settled payment for the full amount or a partial amount by sending a refund request. Multiple partial refund requests are also supported, and the total amount of all of the refund requests must be less than the settled amount. Requesting a refund requires the sale request ID from the sale response. The sale request ID is in the id response field. Endpoints {#concept_section_t2w_424_jyb} ---------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#concept_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#concept_d7e385} The *{id}* is the request ID contained in the original transaction request. Required Fields for Refunding a Payment {#x-req-fields} ======================================================= clientReferenceInformation.code : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : paymentInformation.paymentType.method.name : Set to `MULTIBANCO`. paymentInformation.paymentType.name : Set to `bankTransfer`. processingInformation.actionList : Set to `AP_REFUND`. Example: Refunding a Payment {#x-ex-rest} ========================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "MULTIBANCO" }, "name": "bankTransfer" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "5.00", "currency": "EUR" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7551890715256012504806" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551890715256012504806" } }, "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7551890715256012504806", "orderInformation": { "amountDetails": { "currency": "EUR" } }, "processorInformation": { "responseDetails": "00006", "transactionId": "555912063193", "responseCode": "00006" }, "reconciliationId": "XFZ55E5TB5S3", "refundAmountDetails": { "refundAmount": "5.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-14T16:14:25Z" } ``` Response Statuses for Refunding a Payment {#x-req-fields} ========================================================= `Cybersource` responds to your refund request with one of these statuses in the status field: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Send a check status request to verify that the status is refunded. For more information, see [Check a Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-multibanco-intro/thunes-multibanco-status-intro.md ""). Pluxee Transaction Requests {#thunes-pluxee-intro} ================================================== Pluxee, previously known as *Sodexo* , is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. With Pluxee you can process payments, refund payments, and retrieve the status of a pending payment or refund. This section describes how to process Pluxee transactions using the `REST API`. Requirement ----------- You must receive a Thunes merchant ID before you can begin processing payments. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country and currency that is supported by Pluxee. | Supported Country | Country Code | Supported Currency | Currency Code | |-------------------|--------------|--------------------|---------------| | France | `FR` | Euro | `EUR` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. Pluxee by Thunes Transaction Workflow {#thunes-intro-flow-pluxee} ================================================================= This workflow describes the sequence of events that comprises a successful Pluxee payment and refund. #### Figure: Pluxee by Thunes Transaction Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-pluxee-600x700.svg/jcr:content/renditions/original) 1. The customer begins to checkout on your website and chooses the Pluxee payment method.{#thunes-intro-flow-pluxee_step1} {#thunes-intro-flow-pluxee_step1} 2. You send a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-pluxee-intro/thunes-pluxee-sale-intro.md "").{#thunes-intro-flow-pluxee_step2} {#thunes-intro-flow-pluxee_step2} 3. `Cybersource` responds to you with a `PENDING` status, Pluxee redirect URL, and sale request ID.{#thunes-intro-flow-pluxee_step3} {#thunes-intro-flow-pluxee_step3} 4. You redirect the customer to the Pluxee URL.{#thunes-intro-flow-pluxee_step4} {#thunes-intro-flow-pluxee_step4} 5. The customer completes the checkout using Pluxee and is redirected to your website.{#thunes-intro-flow-pluxee_step5} {#thunes-intro-flow-pluxee_step5} 6. You send a check status API request to `Cybersource`. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-pluxee-intro/thunes-pluxee-status-intro.md "").{#thunes-intro-flow-pluxee_step6} {#thunes-intro-flow-pluxee_step6} 7. `Cybersource` responds to you with a `SETTLED` status.{#thunes-intro-flow-pluxee_step7} {#thunes-intro-flow-pluxee_step7} 8. You confirm the payment to the customer.{#thunes-intro-flow-pluxee_step8} {#thunes-intro-flow-pluxee_step8} 9. The customer returns the purchase. 10. You send a refund API request to `Cybersource` with the sale request ID. For more information, see [Refund a Payment](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-pluxee-intro/thunes-pluxee-refund-intro.md ""). 11. `Cybersource` responds to you with a `REFUNDED` status and refund request ID. 12. You send a check status request to `Cybersource` to verify the refund status. 13. `Cybersource` respond to you with a `REFUNDED` status. 14. You confirm the refund to the customer. Transaction Statuses Workflow {#thunes-pluxee-status-flow} ========================================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-pluxee-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-pluxee-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-pluxee-sale-intro} ========================================== This section describes how to send a sale request to process a payment. A sale request authorizes and captures a payment in the same request. A successful sale response includes an Pluxee redirect URL and a `PENDING` status. Redirect the customer to the Pluxee URL to allow the customer to complete the checkout using their Pluxee account. When the customer completes the checkout, the customer is redirected to your website. When you receive a successful response, save the sale request ID in the id response field to perform a follow-on check status request or refund request. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-pluxee-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-pluxee-sale-intro_d7e355} Processing a Sale {#thunes-pluxee-sale-task} ============================================ Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://apitest.cybersource.com``/pts/v2/payments`{#thunes-pluxee-sale-task_sale-test-rest} endpoint and include these required fields: clientReferenceInformation.code : merchantInformation.cancelUrl : merchantInformation.failureUrl : merchantInformation.successUrl : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : paymentInformation.paymentType.method.name : Set to `SODEXO`. paymentInformation.paymentType.name : Set to `Voucher`. processingInformation.actionList : Set to `AP_SALE`. {#thunes-pluxee-sale-task_step-1-cmd} 2. You can include these optional fields in the request: {#thunes-pluxee-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#thunes-pluxee-sale-task_step-3-cmd} 4. When the customer completes the checkout using their Pluxee credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl request field.{#thunes-pluxee-sale-task_step-4-cmd} {#thunes-pluxee-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7551878413816917004807" ``` {#thunes-pluxee-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-pluxee-sale-ex-rest} ======================================================== Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "SODEXO" }, "name": "Voucher" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "country": "FR", "email": "test@test.com" }, "amountDetails": { "totalAmount": "10.00", "currency": "EUR" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7546709037156463304805/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7546709037156463304805" }, "self": { "method": "POST", "href": "/pts/v2/payments/7546709037156463304805" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7546709037156463304805/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546709037156463304805" } }, "clientReferenceInformation": { "code": "123" }, "id": "7546709037156463304805", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "10.00", "currency": "EUR" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/PluxeeFrance/Order/PayPage/734260616764", "transactionId": "734260616764", "responseCode": "00001" }, "reconciliationId": "XFZ40E1G1A6G", "status": "PENDING", "submitTimeUtc": "2025-08-08T16:35:04Z" } ``` Response Statuses for Processing a Sale {#thunes-pluxee-sale-status} ==================================================================== `Cybersource` responds to your sale request with one of these statuses in the status field: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send a check status request as often as necessary to obtain the information that you need. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-pluxee-intro/thunes-pluxee-status-intro.md ""). {#thunes-pluxee-sale-status_ul_pdp_lkr_3yb} Check a Transaction Status {#thunes-pluxee-status-intro} ======================================================== This section describes how to retrieve the current status of a sale or refund. Send a check status request to know if a pending sale is settled, or to verify that a refund request is refunded. Use the check status request as often as necessary to obtain the information that you need. The check status request requires the request ID from the sale or refund response. The request ID is in the id response field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-pluxee-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-pluxee-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Required Fields for Checking a Status {#thunes-pluxee-status-req-fields} ======================================================================== clientReferenceInformation.code : paymentInformation.paymentType.method.name : Set to `SODEXO`. paymentInformation.paymentType.name : Set to `Voucher`. processingInformation.actionList : Set to `AP_STATUS`. Example: Checking a Status {#thunes-pluxee-status-ex-rest} ========================================================== Request ``` { "clientReferenceInformation": { "code": "" }, "paymentInformation": { "paymentType": { "method": { "name": "SODEXO" }, "name": "bankTransfer" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7546709711836385404806", "processorInformation": { "responseDetails": "00001", "token": "734260616764", "responseCode": "00001" }, "reconciliationId": "XFZ3ZE1G1BCB", "status": "PENDING" } ``` Response Statuses for Checking a Status {#thunes-pluxee-check-status} ===================================================================== `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either Pluxee rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either Pluxee rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Refund a Payment {#thunes-pluxee-refund-intro} ============================================== This section describes how to refund a payment. You can refund a settled payment for the full amount or a partial amount by sending a refund request. Multiple partial refund requests are also supported, and the total amount of all of the refund requests must be less than the settled amount. Requesting a refund requires the sale request ID from the sale response. The sale request ID is in the id response field. Endpoints {#thunes-pluxee-refund-intro_section_t2w_424_jyb} ----------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-pluxee-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-pluxee-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Required Fields for Refunding a Payment {#thunes-pluxee-refund-req-fields} ========================================================================== clientReferenceInformation.code : orderInformation.amountDetails.currency : Set to `EUR`. orderInformation.amountDetails.totalAmount : paymentInformation.paymentType.method.name : Set to `SODEXO`. paymentInformation.paymentType.name : Set to `Voucher`. processingInformation.actionList : Set to `AP_REFUND`. Example: Refunding a Payment {#thunes-pluxee-refund-ex-rest} ============================================================ Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "SODEXO" }, "name": "Voucher" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "5.00", "currency": "EUR" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7546712826736457204806" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546712826736457204806" } }, "clientReferenceInformation": { "code": "refnum-1234" }, "errorInformation": { "reason": "PAYMENT_REFUSED", "message": "Payment Service Error" }, "id": "7546712826736457204806", "processorInformation": { "responseCode": "30200" }, "status": "FAILED" } ``` Response Statuses for Refunding a Payment {#thunes-pluxee-refund-status} ======================================================================== `Cybersource` responds to your refund request with one of these statuses in the status field: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Send a check status request to verify that the status is refunded. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-pluxee-intro/thunes-pluxee-status-intro.md ""). Przelewy24 Transaction Requests {#thunes-prz-intro} =================================================== Przelewy24 (P24) is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. You can process a payment by sending a sale API request message to `Cybersource`. `Cybersource` sends your request to Thunes. Thunes approves the transaction and sends the request to the processor for settlement. You can also send a refund and check status API request as follow-on requests. Requirements ------------ You must have a merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country, country code, and currency supported by P24. | Country | Country Code | Currency Code | |---------|--------------|---------------| | Poland | `PL` | `PLN` | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. P24 by Thunes Payment Workflow {#thunes-intro-flow-prz} ======================================================= This workflow describes the sequence of events that comprises a successful P24 payment. #### Figure: P24 by Thunes Payment Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-prz.svg/jcr:content/renditions/original) 1. The customer begins to checkout on the merchant's website and chooses the P24 payment method.{#thunes-intro-flow-prz_step1} {#thunes-intro-flow-prz_step1} 2. The merchant sends a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-prz-intro/thunes-prz-sale-intro.md "").{#thunes-intro-flow-prz_step2} {#thunes-intro-flow-prz_step2} 3. `Cybersource` responds to the merchant with a `PENDING` status and a redirect URL.{#thunes-intro-flow-prz_step3} {#thunes-intro-flow-prz_step3} 4. The merchant redirects the customer to the URL.{#thunes-intro-flow-prz_step4} {#thunes-intro-flow-prz_step4} 5. The customer completes the checkout using P24 and is redirected to the merchant website.{#thunes-intro-flow-prz_step5} {#thunes-intro-flow-prz_step5} 6. The merchant sends a check status API request to `Cybersource`. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-prz-intro/thunes-prz-status-intro.md "").{#thunes-intro-flow-prz_step6} {#thunes-intro-flow-prz_step6} 7. `Cybersource` responds to the merchant with a `SETTLED` status.{#thunes-intro-flow-prz_step7} {#thunes-intro-flow-prz_step7} 8. The merchant displays a confirmation of the completed payment to the customer.{#thunes-intro-flow-prz_step8} {#thunes-intro-flow-prz_step8} {#thunes-intro-flow-prz_steps} Transaction Statuses Workflow {#thunes-prz-status-flow} ======================================================= This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-prz-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-prz-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-prz-sale-intro} ======================================= Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using P24. When the customer completes the checkout, the customer is redirected to the merchant website using the success-URL provided in the sale request. Line Items ---------- Line items are included in a request in the lineItem\[\] array. For more information about how to properly format line items in your request, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-prz-sale-intro_tax-info} --------------------------------------------- You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-prz-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-prz-sale-intro_d7e355} Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-prz-intro/thunes-prz-status-intro.md ""). {#thunes-prz-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Processing a Sale {#thunes-prz-sale-task} ========================================= Follow these steps to successfully process sale. > IMPORTANT You must include all of the listed required fields in your sale request to guarantee the redirect URL will display properly to the customer. 1. Send a `POST` request to the `https://api.cybersource.com``/pts/v2/payments`{#thunes-prz-sale-task_sale-prod-rest} endpoint and include these required fields: : {#thunes-prz-sale-task_step-1-cmd} 2. You can include these optional fields in the request: [orderInformation.amountDetails.discountAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-discount-amount.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [orderInformation.billTo.address1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-address1.md "") : [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.billTo.locality](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-locality.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : orderInformation.lineItems\[\].productDescription : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : orderInformation.lineItems\[\].taxAmount : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : [orderInformation.shipTo.address1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-street1.md "") : [orderInformation.shipTo.address2](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-street2.md "") : [orderInformation.shipTo.administrativeArea](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-county.md "") : [orderInformation.shipTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-country.md "") : [orderInformation.shipTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-first-name.md "") : [orderInformation.shipTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-last-name.md "") : [orderInformation.shipTo.locality](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-locality.md "") : [orderInformation.shipTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-phone-num.md "") : [orderInformation.shipTo.postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-postal-code.md "") : {#thunes-prz-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the processorInformation.paymentUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#thunes-prz-sale-task_step-3-cmd} 4. When the customer completes the checkout using their Prz24 credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl field.{#thunes-prz-sale-task_step-4-cmd} {#thunes-prz-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7546689587576406204805" ``` {#thunes-prz-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-prz-sale-ex-rest} ===================================================== Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "P24" }, "name": "bankTransfer" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "country": "PL", "email": "test@test.com" }, "amountDetails": { "totalAmount": "600.00", "currency": "PLN" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7546689587576406204805/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7546689587576406204805" }, "self": { "method": "POST", "href": "/pts/v2/payments/7546689587576406204805" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7546689587576406204805/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546689587576406204805" } }, "clientReferenceInformation": { "code": "123" }, "id": "7546689587576406204805", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "600.00", "currency": "PLN" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/P24/Order/PayPage/896435173864", "transactionId": "896435173864", "responseCode": "00001" }, "reconciliationId": "XFZ3ZE1G1ABL", "status": "PENDING", "submitTimeUtc": "2025-08-08T16:02:39Z" } ``` Check a Request Status {#thunes-prz-status-intro} ================================================= You can retrieve the status of a pending sale or refund by sending a check status request. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-prz-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-prz-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either P24 rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either P24 rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Required Fields for Checking Status {#thunes-prz-status-req-fields} =================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to . [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to . [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_STATUS`. Example: Checking a Request Status {#thunes-prz-status-ex-rest} =============================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "P24" }, "name": "bankTransfer" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7546690291866465104805", "processorInformation": { "responseDetails": "00004", "token": "896435173864", "responseCode": "00004" }, "reconciliationId": "XFZ40E1G19AF", "status": "SETTLED" } ``` Refund a Payment {#thunes-prz-refund-intro} =========================================== You can refund a completed payment for the full amount or a partial amount by sending a refund request. P24 supports multiple refund requests when the total amount of all of the refund requests is less than the captured amount. Requesting a refund requires the request ID from the sale response. The request ID is located in the response field. Endpoints {#thunes-prz-refund-intro_section_t2w_424_jyb} -------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-prz-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-prz-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- `Cybersource` responds to your refund request with one of these statuses as the status field value: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-prz-intro/thunes-prz-status-intro.md ""). When you send a check status request to retrieve an updated refund status, these are the possible responses: * `FAILED`: The refund request failed. * `REFUNDED`: The settled payment is successfully refunded. Required Fields for Refunding a Payment {#thunes-prz-refund-req-fields} ======================================================================= [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to . [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to . [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_REFUND`. Optional Fields for Refunding a Payment {#thunes-prz-refund-opt-fields} ======================================================================= [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : [orderInformation.lineItems\[\].taxAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-tax-amount-request.md "") : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : Example: Refunding a Payment {#thunes-prz-refund-ex-rest} ========================================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "P24" }, "name": "bankTransfer" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "60.00", "currency": "PLN" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7546693022266551304805" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546693022266551304805" } }, "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7546693022266551304805", "processorInformation": { "responseCode": "00006" }, "status": "REFUNDED" } ``` ShopeePay Transaction Requests {#thunes-shopeepay-intro} ======================================================== ShopeePay is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. You can process a payment by sending a sale API request message to `Cybersource`. `Cybersource` sends your request to Thunes. Thunes approves the transaction and sends the request to the processor for settlement. You can also send a refund and check status API request as follow-on services. Requirements ------------ You must have a merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Supported Currencies -------------------- This table lists the currencies supported by ShopeePay. | Currency | Currency Code | |----------|-------------------| | `IDR` | Indonesian rupiah | | `MYR` | Malaysian ringgit | | `PHP` | Philippine peso | [Supported Currencies and Currency Codes] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. ShopeePay by Thunes Payment Workflow {#thunes-intro-flow-shopeepay} =================================================================== This workflow describes the sequence of events that comprises a successful ShopeePay payment. #### Figure: ShopeePay by Thunes Payment Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-shopeepay.svg/jcr:content/renditions/original) 1. The customer begins to checkout on the merchant's website and chooses the ShopeePay payment method.{#thunes-intro-flow-shopeepay_step1} {#thunes-intro-flow-shopeepay_step1} 2. The merchant sends a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-shopeepay-intro/thunes-shopeepay-sale-intro.md "").{#thunes-intro-flow-shopeepay_step2} {#thunes-intro-flow-shopeepay_step2} 3. `Cybersource` responds to the merchant with a `PENDING` status and a redirect URL.{#thunes-intro-flow-shopeepay_step3} {#thunes-intro-flow-shopeepay_step3} 4. The merchant redirects the customer to the URL.{#thunes-intro-flow-shopeepay_step4} {#thunes-intro-flow-shopeepay_step4} 5. The customer completes the checkout using ShopeePay and is redirected to the merchant website.{#thunes-intro-flow-shopeepay_step5} {#thunes-intro-flow-shopeepay_step5} 6. The merchant sends a check status API request to `Cybersource`. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-shopeepay-intro/thunes-shopeepay-status-intro.md "").{#thunes-intro-flow-shopeepay_step6} {#thunes-intro-flow-shopeepay_step6} 7. `Cybersource` responds to the merchant with a `SETTLED` status.{#thunes-intro-flow-shopeepay_step7} {#thunes-intro-flow-shopeepay_step7} 8. The merchant displays a confirmation of the completed payment to the customer.{#thunes-intro-flow-shopeepay_step8} {#thunes-intro-flow-shopeepay_step8} {#thunes-intro-flow-shopeepay_steps} Transaction Statuses Workflow {#thunes-shopeepay-status-flow} ============================================================= This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-shopeepay-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-shopeepay-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-shopeepay-sale-intro} ============================================= Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using ShopeePay. When the customer completes the checkout, the customer is redirected to the merchant website using the success-URL provided in the sale request. Line Items ---------- Line items are included in a request in the lineItem\[\] array. For more information about how to properly format line items in your request, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-shopeepay-sale-intro_tax-info} --------------------------------------------------- You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: See [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-status-intro.md ""). {#thunes-shopeepay-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Processing a Sale {#thunes-shopeepay-sale-task} =============================================== Follow these steps to successfully process sale. > IMPORTANT You must include all of the listed required fields in your sale request to guarantee the redirect URL will display properly to the customer. 1. Send a `POST` request to the `https://api.cybersource.com``/pts/v2/payments`{#thunes-shopeepay-sale-task_sale-prod-rest} endpoint and include these required fields: : {#thunes-shopeepay-sale-task_step-1-cmd} 2. You can include these optional fields in the request: [orderInformation.amountDetails.discountAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-discount-amount.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [orderInformation.billTo.address1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-address1.md "") : [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.billTo.locality](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-locality.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : orderInformation.lineItems\[\].productDescription : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : orderInformation.lineItems\[\].taxAmount : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : [orderInformation.shipTo.address1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-street1.md "") : [orderInformation.shipTo.address2](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-street2.md "") : [orderInformation.shipTo.administrativeArea](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-county.md "") : [orderInformation.shipTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-country.md "") : [orderInformation.shipTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-first-name.md "") : [orderInformation.shipTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-last-name.md "") : [orderInformation.shipTo.locality](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-locality.md "") : [orderInformation.shipTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-phone-num.md "") : [orderInformation.shipTo.postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-shipto-postal-code.md "") : {#thunes-shopeepay-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the processorInformation.paymentUrl response field. ``` <successURL>https://www.testsuccess.com?action=success</successURL> ``` {#thunes-shopeepay-sale-task_step-3-cmd} 4. When the customer completes the checkout using their ShopeePay credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl field.{#thunes-shopeepay-sale-task_step-4-cmd} {#thunes-shopeepay-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7551867752176984004896" ``` {#thunes-shopeepay-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-shopeepay-sale-ex-rest} =========================================================== Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "SHOPEEPAY" }, "name": "eWallet" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "country": "MY", "email": "test@test.com", "phoneNumber": "33623456789" }, "amountDetails": { "totalAmount": "600.00", "currency": "MYR" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7551867752176984004896/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7551867752176984004896" }, "self": { "method": "POST", "href": "/pts/v2/payments/7551867752176984004896" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7551867752176984004896/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551867752176984004896" } }, "clientReferenceInformation": { "code": "123" }, "id": "7551867752176984004896", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "600.00", "currency": "MYR" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetik.com/Razer/Order/PayPage/614898130710", "transactionId": "614898130710", "responseCode": "00001" }, "reconciliationId": "XEKVLDYDE4BN", "status": "PENDING", "submitTimeUtc": "2025-08-14T15:52:56Z" } ``` Check a Request Status {#thunes-shopeepay-status-intro} ======================================================= You can retrieve the status of a pending sale or refund by sending a check status request. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either ShopeePay rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either ShopeePay rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Required Fields for Checking Status {#thunes-shopeepay-status-req-fields} ========================================================================= [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to . [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to . [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_STATUS`. Example: Checking a Request Status {#thunes-shopeepay-status-ex-rest} ===================================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "SHOPEEPAY" }, "name": "eWallet" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7551864268166401504883", "processorInformation": { "responseDetails": "00001", "token": "945165815864", "responseCode": "00001" }, "reconciliationId": "XEL3SE9I5TN6", "status": "PENDING" } ``` Refund a Payment {#thunes-shopeepay-refund-intro} ================================================= You can refund a completed payment for the full amount or a partial amount by sending a refund request. ShopeePay supports multiple refund requests when the total amount of all of the refund requests is less than the captured amount. Requesting a refund requires the request ID from the sale response. The request ID is located in the id response field. Endpoints {#thunes-shopeepay-refund-intro_section_t2w_424_jyb} -------------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-shopeepay-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-shopeepay-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- `Cybersource` responds to your refund request with one of these statuses as the status field value: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see [Refund a Payment](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-shopeepay-intro/thunes-shopeepay-refund-intro.md ""). When you send a check status request to retrieve an updated refund status, these are the possible responses: * `FAILED`: The refund request failed. * `REFUNDED`: The settled payment is successfully refunded. Required Fields for Refunding a Payment {#thunes-shopeepay-refund-req-fields} ============================================================================= [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to . [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to . [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_REFUND`. Optional Fields for Refunding a Payment {#thunes-shopeepay-refund-opt-fields} ============================================================================= [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : [orderInformation.lineItems\[\].taxAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-tax-amount-request.md "") : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : Example: Refunding a Payment {#thunes-shopeepay-refund-ex-rest} =============================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "SHOPEEPAY" }, "name": "eWallet" } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "5.00", "currency": "MYR" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7551868761676372704895" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7551868761676372704895" } }, "id": "7551868761676372704895", "orderInformation": { "amountDetails": { "currency": "MYR" } }, "clientReferenceInformation": { "code": "refnum-1234" }, "processorInformation": { "responseDetails": "00006", "transactionId": "430844862998", "responseCode": "00006" }, "reconciliationId": "XFZ3ZE1G1DID", "refundAmountDetails": { "refundAmount": "5.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-12T18:14:18Z" } ``` Turkey Card Processing Transaction Requests {#thunes-turkey-intro} ================================================================== Turkey card processing is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. To process a payment, send a sale API request message to `Cybersource`. `Cybersource` sends the request to Thunes. Thunes approves the transaction and sends the request to the processor for settlement. You can also send a refund and check status API request as follow-on requests. Requirements ------------ You must have a merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country, country code, and currency supported by Turkey credit card processing. | Country | Country Code | Currency Code | Supported Card Types | |---------|--------------|---------------|----------------------------| | Turkey | `TR` | `TRY` | * Mastercard * Troy * Visa | [Supported Country and Currency] Shipping Policy --------------- You can ship purchased goods when the sale status is `SETTLED`. Turkey Card Processing by Thunes Payment Workflow {#thunes-intro-flow-turkey} ============================================================================= This workflow illustrates the process of a Turkey local card payment. #### Figure: {#thunes-intro-flow-turkey_fig_uhz_mdk_tzb} Turkey credit card processing by Thunes Payment Workflow ![Turkey card by Thunes Payment Workflow](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-turkey.svg/jcr:content/renditions/original) 1. The customer begins to checkout on the merchant's website and chooses to pay with their credit or debit card.{#thunes-intro-flow-turkey_step1} {#thunes-intro-flow-turkey_step1} 2. The merchant sends a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-turkey-intro/thunes-turkey-sale-intro.md "").{#thunes-intro-flow-turkey_step2} {#thunes-intro-flow-turkey_step2} 3. `Cybersource` responds to the merchant with a `PENDING` status and a redirect URL.{#thunes-intro-flow-turkey_step3} {#thunes-intro-flow-turkey_step3} 4. The merchant redirects the customer to the URL.{#thunes-intro-flow-turkey_step4} {#thunes-intro-flow-turkey_step4} 5. The customer completes the checkout using their credit or debit card and is redirected to the merchant website.{#thunes-intro-flow-turkey_step5} {#thunes-intro-flow-turkey_step5} 6. The merchant sends a check status API request to `Cybersource`. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-turkey-intro/thunes-turkey-status-intro.md "").{#thunes-intro-flow-turkey_step6} {#thunes-intro-flow-turkey_step6} 7. `Cybersource` responds to the merchant with a `SETTLED` status.{#thunes-intro-flow-turkey_step7} {#thunes-intro-flow-turkey_step7} 8. The merchant displays a confirmation of the completed payment to the customer.{#thunes-intro-flow-turkey_step8} {#thunes-intro-flow-turkey_step8} {#thunes-intro-flow-turkey_steps} Transaction Statuses Workflow {#thunes-turkey-status-flow} ========================================================== This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-turkey-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-turkey-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-turkey-sale-intro} ========================================== Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using Turkey credit card processing. When the customer completes the checkout, the customer is redirected to the merchant website using the success-URL provided in the sale request. Line Items ---------- Line items are included in a request in the lineItem\[\] array. Tax Amounts {#thunes-turkey-sale-intro_tax-info} ------------------------------------------------ You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-turkey-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-turkey-sale-intro_d7e355} Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-turkey-intro/thunes-turkey-sale-intro.md ""). {#thunes-turkey-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Processing a Sale {#thunes-turkey-sale-task} ============================================ Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://api.cybersource.com``/pts/v2/payments`{#thunes-turkey-sale-task_sale-prod-rest} endpoint and include these required fields: [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [merchantInformation.cancelUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-cancel-url.md "") : [merchantInformation.failureUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-failure-url.md "") : [merchantInformation.successUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-success-url.md "") : [orderInformation.amountDetails.currency](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-currency.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `TURKEYCARDS`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `localCard`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_SALE`. {#thunes-turkey-sale-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.email : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#thunes-turkey-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#thunes-turkey-sale-task_step-3-cmd} 4. When the customer completes the checkout using their card credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl field.{#thunes-turkey-sale-task_step-4-cmd} {#thunes-turkey-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7546675945716557504805", ``` {#thunes-turkey-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-turkey-sale-ex-rest} ======================================================== Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "TURKEYCARDS" }, "name": "localCard" } }, "orderInformation": { "amountDetails": { "currency": "TRY", "totalAmount": "220.00" } }, "processingInformation" : { "actionList" : [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7546675945716557504805/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7546675945716557504805" }, "self": { "method": "POST", "href": "/pts/v2/payments/7546675945716557504805" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7546675945716557504805/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546675945716557504805" } }, "clientReferenceInformation": { "code": "123" }, "id": "7546675945716557504805", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "220.00", "currency": "TRY" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/GenericCreditCard/Order/PayPage/944772931372, "transactionId": "944772931372", "responseCode": "00001" }, "reconciliationId": "XFZ40E1G18JF", "status": "PENDING", "submitTimeUtc": "2025-08-08T15:39:55Z" } ``` Check a Request Status {#thunes-turkey-status-intro} ==================================================== You can retrieve the status of a pending sale or refund by sending a check status request. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-turkey-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-turkey-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either Turkey credit card processing rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either Turkey credit card processing rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Required Fields for Checking Status {#thunes-turkey-status-req-fields} ====================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `TURKEYCARDS`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `localCard`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_STATUS`. Example: Checking a Request Status {#thunes-turkey-status-ex-rest} ================================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "TURKEYCARDS" }, "name": "localCard" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7546677566956817204807", "processorInformation": { "responseDetails": "00004", "token": "944772931372", "responseCode": "00004" }, "reconciliationId": "XFZ3ZE1G19PT", "status": "SETTLED" } ``` Refund a Payment {#thunes-turkey-refund-intro} ============================================== You can refund a completed payment for the full amount or a partial amount by sending a refund request. Turkey card processing supports multiple refund requests when the total amount of all of the refund requests is less than the captured amount. Requesting a refund requires the request ID from the sale response. The request ID is located in the id response field. Endpoints {#thunes-turkey-refund-intro_section_t2w_424_jyb} ----------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-turkey-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-turkey-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- `Cybersource` responds to your refund request with one of these statuses as the status field value: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-turkey-intro/thunes-turkey-status-intro.md ""). When you send a check status request to retrieve an updated refund status, these are the possible responses: * `FAILED`: The refund request failed. * `REFUNDED`: The settled payment is successfully refunded. Required Fields for Refunding a Payment {#thunes-turkey-refund-req-fields} ========================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [orderInformation.amountDetails.currency](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-currency.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to `TURKEYCARDS`. [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to `localCard`. [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_REFUND`. Optional Fields for Refunding a Payment {#thunes-turkey-refund-opt-fields} ========================================================================== [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : [orderInformation.lineItems\[\].taxAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-tax-amount-request.md "") : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : Example: Refunding a Payment {#thunes-turkey-refund-ex-rest} ============================================================ Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "name": "localCard", "method": { "name": "TURKEYCARDS" } } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "10.00", "currency": "TRY" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7546680552276902104807" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546680552276902104807" } }, "clientReferenceInformation": { "code": "refnum-1234", "returnReconciliationId": "R015AE1TJE8I" }, "id": "7546680552276902104807", "orderInformation": { "amountDetails": { "currency": "TRY" } }, "processorInformation": { "responseDetails": "00006", "transactionId": "944772931372", "responseCode": "00006" }, "reconciliationId": "XFZ40E1G18JF", "refundAmountDetails": { "refundAmount": "10.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-08T15:47:37Z" } ``` Twint Transaction Requests {#thunes-twint-intro} ================================================ Twint is a payment method offered by the Thunes payment service provider (PSP) that you can offer your customers through `Cybersource`. You can process a payment by sending a sale API request message to `Cybersource`. `Cybersource` sends your request to Thunes. Thunes approves the transaction and sends the request to the processor for settlement. You can also send a refund and check status API request as follow-on requests. Requirements ------------ You must have a merchant ID and a Thunes API key for each country in which you process transactions. Contact your `Cybersource` account manager for more information. Supported Country and Currency ------------------------------ This table lists the country, country code, and currency supported by Twint. | Country | Country Code | Currency Code | |-------------|--------------|---------------| | Switzerland | `CH` | `CHF` | [Supported Country and Currency] Shipping Policy --------------- Goods can be shipped when the sale status is `SETTLED`. Twint by Thunes Payment Workflow {#thunes-intro-flow-twint} =========================================================== This workflow describes the sequence of events that comprises a successful Twint payment. #### Figure: Twint by Thunes Payment Workflow ![MB Way by Thunes Payment Workflow](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-flow-twint.svg/jcr:content/renditions/original) 1. The customer begins to checkout on the merchant's website and chooses the Twint payment method.{#thunes-intro-flow-twint_step1} {#thunes-intro-flow-twint_step1} 2. The merchant sends a sale API request to `Cybersource`. For more information, see [Process a Sale](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-alipay-sale-intro.md "").{#thunes-intro-flow-twint_step2} {#thunes-intro-flow-twint_step2} 3. `Cybersource` responds to the merchant with a `PENDING` status and a redirect URL.{#thunes-intro-flow-twint_step3} {#thunes-intro-flow-twint_step3} 4. The merchant redirects the customer to the URL.{#thunes-intro-flow-twint_step4} {#thunes-intro-flow-twint_step4} 5. The customer completes the checkout using Twint and is redirected to the merchant website.{#thunes-intro-flow-twint_step5} {#thunes-intro-flow-twint_step5} 6. The merchant sends a check status API request to `Cybersource`. For more information, see [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-alipay-status-intro.md "").{#thunes-intro-flow-twint_step6} {#thunes-intro-flow-twint_step6} 7. `Cybersource` responds to the merchant with a `SETTLED` status.{#thunes-intro-flow-twint_step7} {#thunes-intro-flow-twint_step7} 8. The merchant displays a confirmation of the completed payment to the customer.{#thunes-intro-flow-twint_step8} {#thunes-intro-flow-twint_step8} {#thunes-intro-flow-twint_steps} Transaction Statuses Workflow {#thunes-twint-status-flow} ========================================================= This workflow shows the statuses that can occur at each stage of processing a sale and refund. #### Figure: Transaction Statuses Workflow ![](/content/dam/documentation/cybs/en-us/topics/payments-processing/altpay/thunes/graphics/thunes-status-sale-refund-flow-600x670.svg/jcr:content/renditions/original) 1. When a customer begins to check out, you send a sale request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Send the check status request to retrieve status updates. 2. You send a check status request to `Cybersource` to verify the sale status and receive one of these statuses: * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale request failed. A failed request can be due to either a rejection or a technical error. * `PENDING`: The sale request is accepted but is not completed. Send the check status request as often as necessary to obtain the information that you need. * `SETTLED`: The sale request is settled for the requested amount. When the settled amount is deposited into the merchant's bank account, the status updates to `FUNDED`. {#thunes-twint-status-flow_d16e57} 3. If a customer returns a purchase, you send a refund request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. {#thunes-twint-status-flow_d16e92} 4. You send a check status request to `Cybersource` to verify the refund status and receive one of these statuses: * `FAILED`: The refund could not be completed. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-twint-sale-intro} ========================================= Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using Twint. When the customer completes the checkout, the customer is redirected to the merchant website using the success-URL provided in the sale request. Line Items ---------- Line items are included in a request in the lineItem\[\] array. For more information about how to properly format line items in your request, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-twint-sale-intro_tax-info} ----------------------------------------------- You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-twint-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-twint-sale-intro_d7e355} Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-twint-intro/thunes-twint-status-intro.md ""). {#thunes-twint-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Processing a Sale {#thunes-twint-sale-task} =========================================== Follow these steps to successfully process sale. 1. Send a `POST` request to the `https://api.cybersource.com``/pts/v2/payments`{#thunes-twint-sale-task_sale-prod-rest} endpoint and include these required fields: : {#thunes-twint-sale-task_step-1-cmd} 2. You can include these optional fields in the request: merchantDefinedInformation\[\].key : merchantInformation.merchantDescriptor : orderInformation.billTo.address1 : orderInformation.billTo.address2 : orderInformation.billTo.administrativeArea : orderInformation.billTo.email : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : orderInformation.lineItems\[\].productCode : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].taxAmount : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : {#thunes-twint-sale-task_step-2-cmd} 3. Redirect the customer to the returned URL in the merchantInformation.successUrl response field. ``` "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" ``` {#thunes-twint-sale-task_step-3-cmd} 4. When the customer completes the checkout using their Twint credentials, the customer is redirected to the merchant website based on the URL that you included in the merchantInformation.successUrl field.{#thunes-twint-sale-task_step-4-cmd} {#thunes-twint-sale-task_step-4} 5. Save the request ID in the id field from the sale response. Include the request ID in a check status request to confirm that the payment is complete. ``` "id": "7546697089506643204805" ``` {#thunes-twint-sale-task_step-5-cmd} Example: Processing a Sale {#thunes-twint-sale-ex-rest} ======================================================= Request ``` { "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "TWINT" }, "name": "eWallet" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "country": "CH", "email": "test@test.com" }, "amountDetails": { "currency": "CHF", "totalAmount": "220.00" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } } ``` Response to a Successful Request ``` { "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7546697089506643204805/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7546697089506643204805" }, "self": { "method": "POST", "href": "/pts/v2/payments/7546697089506643204805" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7546697089506643204805/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546697089506643204805" } }, "clientReferenceInformation": { "code": "123" }, "id": "7546697089506643204805", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "220.00", "currency": "CHF" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/Six/Order/PayPage/705811299014", "transactionId": "705811299014", "responseCode": "00001" }, "reconciliationId": "XFZ3ZE1G1AMM", "status": "PENDING", "submitTimeUtc": "2025-08-08T16:15:10Z" } ``` Check a Request Status {#thunes-twint-status-intro} =================================================== You can retrieve the status of a pending sale or refund by sending a check status request. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-twint-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-twint-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either Twint rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either Twint rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Required Fields for Checking Status {#thunes-twint-status-req-fields} ===================================================================== [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to . [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to . [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_STATUS`. Example: Checking a Request Status {#thunes-twint-status-ex-rest} ================================================================= Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "method": { "name": "TWINT" }, "name": "eWallet" } }, "processingInformation": { "actionList": "AP_STATUS" } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7546697971406661704805", "processorInformation": { "responseDetails": "00001", "token": "705811299014", "responseCode": "00001" }, "reconciliationId": "XFZ40E1G19P5", "status": "PENDING" } ``` Refund a Payment {#thunes-twint-refund-intro} ============================================= You can refund a completed payment for the full amount or a partial amount by sending a refund request. Twint supports multiple refund requests when the total amount of all of the refund requests is less than the captured amount. Requesting a refund requires the request ID from the sale response. The request ID is located in the id response field. Endpoints {#thunes-twint-refund-intro_section_t2w_424_jyb} ---------------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-twint-refund-intro_d7e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#thunes-twint-refund-intro_d7e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- `Cybersource` responds to your refund request with one of these statuses as the status field value: * `FAILED`: The refund request failed. * `REFUNDED`: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-status-intro.md ""). When you send a check status request to retrieve an updated refund status, these are the possible responses: * `FAILED`: The refund request failed. * `REFUNDED`: The settled payment is successfully refunded. Required Fields for Refunding a Payment {#thunes-twint-refund-req-fields} ========================================================================= [clientReferenceInformation.code](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-code.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [paymentInformation.paymentType.method.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-method-name.md "") : Set to . [paymentInformation.paymentType.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-payment-type-name.md "") : Set to . [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set to `AP_REFUND`. Optional Fields for Refunding a Payment {#thunes-twint-refund-opt-fields} ========================================================================= [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.lineItems\[\].productCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-code.md "") : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : [orderInformation.lineItems\[\].taxAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-tax-amount-request.md "") : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : Example: Refunding a Payment {#thunes-twint-refund-ex-rest} =========================================================== Request ``` { "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "TWINT" } } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "10.00", "currency": "CHF" } } } ``` Response to a Successful Request ``` { "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7546698758166740704805" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546698758166740704805" } }, "clientReferenceInformation": { "code": "refnum-1234", "returnReconciliationId": "R04NNE1TJDUA" }, "id": "7546698758166740704805", "orderInformation": { "amountDetails": { "currency": "CHF" } }, "processorInformation": { "responseDetails": "00006", "transactionId": "519468592154", "responseCode": "00006" }, "reconciliationId": "XFZ4084S9J0F", "refundAmountDetails": { "refundAmount": "10.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-08T16:17:57Z" } ``` Reference Information {#thunes-ref-info} ======================================== This section contains helpful information that you can use when processing transactions. Using Line Items {#thunes-intro-lineitems} ========================================== This section describes how to format line items in your API requests. Some Thunes API requests require line items or allow you include line items in addition to the required request information. Line items are used to include information about the goods that customers purchase, such as product name, quantity, and price. Line items are included in a request in the lineItem\[\] array. #### Figure: Required Fields for Line Items These fields are required for each line item included in your request: [orderInformation.lineItems\[\].productDescription](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-description.md "") : [orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "") : [orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "") : [orderInformation.lineItems\[\].taxAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-tax-amount-request.md "") : [orderInformation.lineItems\[\].totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-total-amount.md "") : [orderInformation.lineItems\[\].typeOfSupply](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-type-of-supply.md "") : [orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "") : Including Line Items This example shows three valid line items in the proper syntax. #### Figure: Line Items within a API Request Message ``` { "orderInformation": { "lineItems": [ { "productName": "test-product-1", "quantity": 5, "productDescription": "description-123", "unitPrice": "20", "taxAmount": "10", "totalAmount": "100", "typeOfSupply": "01" }, { "productName": "test-product-2", "quantity": 1, "productDescription": "description-456", "unitPrice": "5", "taxAmount": "1", "totalAmount": "6", "typeOfSupply": "01" }, { "productName": "test-product-3", "quantity": 2, "productDescription": "description-789", "unitPrice": "4", "taxAmount": "2", "totalAmount": "10", "typeOfSupply": "01" } ] } } ``` Generating Reports In the `Business Center` {#conref-altpay-reporting} ====================================================================== You can generate various types of reports for your financial and reconciliation data. For more information about how to automate your reports, see the [*Reporting Developer Guide*](https://developer.cybersource.com/docs/cybs/en-us/reporting/developer/all/rest/reporting/reporting_api.md ""). For more information about how to use your `Business Center` account to generate reports, see the [*Reporting User Guide*](https://developer.cybersource.com/library/documentation/dev_guides/reporting_and_reconciliation/Reporting_User.pdf ""). The Reporting User Guide contains these relevant topics: * How and When Reports Are Generated * Downloading Available Reports * Subscribing to Standard Reports Additional Resources -------------------- For additional information about how to use the `Business Center` and manage reports, see these helpful resources. `Business Center` Navigation : For an overview of the various resources available in the `Business Center`, see this YouTube video: [watch?v=UDmAWGHPbWs](https://www.youtube.com/watch?v=UDmAWGHPbWs "") Getting Started with the `Business Center` : For a step-by-step demonstration of how to navigate in the `Business Center`, see this YouTube video: [watch?v=2qi_g2DParI](https://www.youtube.com/watch?v=2qi_g2DParI "") Managing Report Subscriptions : For an overview of how to manage report subscriptions in the Downloadable Reports section in the `Business Center`, see this YouTube video: [watch?v=tFlmkXtvxWE](https://www.youtube.com/watch?v=tFlmkXtvxWE "") Downloading Reports : For an overview of how to download available reports in the Reports section of the `Business Center`, see this YouTube video: [watch?v=E0slUYjJvmw](https://www.youtube.com/watch?v=E0slUYjJvmw "") Check a Request Status {#thunes-alipay-status-intro} ==================================================== The check status service is a follow-on service used to retrieve a status update of a pending sale or refund. When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-alipay-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-alipay-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the field: Check Status Responses for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The service request failed. A failed request can be due to either Alipay+ rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The sale request is settled for the requested amount. Check Status Responses for a Refund : * `FAILED`: The service request failed. A failed request can be due to either Alipay+ rejecting the transaction or a technical error. * `REFUNDED`: The settled amount is successfully refunded. Process a Sale {#thunes-alipay-sale-intro} ========================================== Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using Alipay+. When the customer completes the checkout, the customer is redirected to your merchant website based on the success URL you include in the merchantInformation.successUrl request field. Supported Digital Wallets {#thunes-alipay-sale-intro_dw} -------------------------------------------------------- This table lists the supported digital wallet types and the relevant digital wallet code, country code, and currency code for each country. When sending a sale request, set these fields to the specified values listed in the table: | Country | Digital Wallet | Digital Wallet Code | Country Code | Currency Code | |----------------------------|---------------------|---------------------|--------------|---------------| | China | Alipay | `ALO` | `CN` | `CNY` | | Hong Kong (CN) | Alipay+ | `ALP` | `HK` | `HKD` | | Indonesia | Akulaku PayLater | `APL` | `ID` | `IDR` | | Indonesia | Dana | `DNA` | `ID` | `IDR` | | Korea, Republic of (South) | KakaoPay | `KPT` | `KR` | `KRW` | | Malaysia | Boost | `BST` | `MY` | `MYR` | | Malaysia | Touch'n'GO | `TNG` | `MY` | `MYR` | | Philippines | Bank of Philippines | `BPI` | `PH` | `PHP` | | Philippines | Gcash | `GCH` | `PH` | `PHP` | | Thailand | Rabbit Line Pay | `RPL` | `TH` | `THB` | | Thailand | TrueMoney | `TMY` | `TH` | `THB` | [Supported Digital Wallets] Line Items ---------- Line items are included in a request in the lineItem\[\] array. For more information about how to properly format line items in your request, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-alipay-sale-intro_tax-info} ------------------------------------------------ You can include the tax amount for every type of purchased product in the orderInformation.lineItems\[\].taxAmount field when you request the sale service. Calculating the Grand Total --------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#thunes-alipay-sale-intro_d7e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#thunes-alipay-sale-intro_d7e355} Response Statuses ----------------- `Cybersource` responds to your sale request with one of these statuses in the status field: Sale Status : * `FAILED`: The sale cannot be completed. * `PENDING`: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See [Check a Request Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-alipay-status-intro.md ""). {#thunes-alipay-sale-intro_ul_pdp_lkr_3yb} When you send a check status request to retrieve an updated sale status, these are the possible responses: Check Status for a Sale : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `FAILED`: The sale cannot be completed. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes. * `SETTLED`: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out. Check a Transaction Status {#thunes-status-intro} ================================================= You can retrieve the current status of a pending authorization, reversal, capture, or refund by sending a check status request. The check status request requires the request ID from the corresponding transaction. When a pending status updates, the check status request responds with the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the id response field. `Cybersource` recommends that you send a check status request hourly until the status updates from pending. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-status-intro_d7e193} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/refresh-payment-status/`*{id}*{#thunes-status-intro_d7e205} Set the *`{id}`* to the request ID of the API service you are retrieving. Response Statuses ----------------- `Cybersource` responds to your check status request with one of these statuses in the status field: Check Status Responses for a Session : * `ABANDONED`: The customer did not complete the payment using the redirect URL. * `COMPLETED`: The customer completed the checkout process. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. Check Status Responses for an Authorization : * `AUTHORIZED`: The customer's payment is authorized. * `FAILED`: The service request failed. A failed request can be due to either Oney rejecting the transaction or a technical error. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. Check Status Responses for a Capture : * `FAILED`: The service request failed. A failed request can be due to either Oney rejecting the transaction or a technical error. * `FUNDED`: The settled amount is funded to the merchant bank account. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. * `SETTLED`: The capture request is settled for the requested amount. Check Status Responses for an Authorization-Reversals : * `AUTH-REVERSED`: The authorization is successfully reversed. * `FAILED`: The service request failed. A failed request can be due to either Oney rejecting the transaction or a technical error. * `PENDING`: The service request is accepted but is not completed. Request the check status service to retrieve status updates. Create a Session {#thunes-session-intro} ======================================== To create a session, you must include shipping fields in your request. The shipping field values are included in the invoice Oney sends to the customer. When the session request is complete, the response message includes a pre-approval token from Oney. Use this pre-approval token when initializing the Oney authorization service. The session response message also includes a redirection URL that remains available for the customer up to 20 minutes after the session request. Line Items ---------- The session service requires you to include line items in your request. Line items correspond to the fields, starting with and increasing in numerical order. For more information on how to use line items, see [Using Line Items](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-ref-info/thunes-intro-lineitems.md ""). Tax Amounts {#thunes-session-intro_tax-info} -------------------------------------------- Include the tax amount for every type of purchased product in the field when you request the sessions service. Calculating the Grand Total {#thunes-session-intro_grand-total} --------------------------------------------------------------- Include the grand total in the request by using the orderInformation.amountDetails.totalAmount field. Endpoints {#thunes-session-intro_section_pxx_324_jyb} ----------------------------------------------------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payment-references` **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payment-references` Response Statuses ----------------- The session service responds with one of these statuses as the field value: * `PENDING`: The session is initiated and the customer may now checkout. Request the check status service to retrieve status updates. See [Check a Transaction Status](/docs/cybs/en-us/thunes/developer/all/rest/thunes/thunes-status-intro.md ""). {#thunes-session-intro_ul_gjc_lsn_jyb} The session service also responds with a reason code as the field value.