PPRO {#ppro-about-guide} ======================== This section describes the audience and purpose of this developer guide as well as conventions and related documentation. Audience and Purpose : This guide is written for application developers who want to use the `REST` API to integrate PPRO with their payment system. Convention : The following special statement is used in this document: > IMPORTANT > An *Important* statement contains information essential to successfully completing a task or learning a concept. Related Documentation : For additional documentation, visit these documentation sites: * `Cybersource` Developer Center/Developer Guides: [developer-guides.html](https://developer.cybersource.com/api/developer-guides.md "") * `Cybersource` Support Center/Technical Documentation: [technical-documentation.html](https://www.cybersource.com/en-us/support/technical-documentation.md "") * `Cybersource` Technical Documentation Portal: [index.html](https://docs.cybersource.com/en/index.md "") {#ppro-about-guide_ul_c4g_lnx_mtb} Recent Revisions {#ppro-revisions} ================================== 25.03.01 -------- This revision contains only editorial changes and no technical updates. 25.01.01 -------- Update and added new workflow processes. See: * [Processing a Sale Workflow](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-intro/ppro-intro-workflow-sale.md "") * [Processing a Sale Using a Bank ID Workflow](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-intro/ppro-intro-workflow.md "") * [Refunding a Payment Workflow](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-intro/ppro-intro-workflow-refund.md "") Updated all possible response statuses and their descriptions. See [Response Statuses Workflow](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-intro/ppro-intro-workflow-statuses.md ""). 24.01.03 -------- Removed support for the Giropay service. 24.01.02 -------- The guide has undergone a major reorganization. Updated the iDEAL request examples for a sale, retrieve a transaction, refund and options. For more information, see: * [Example: Requesting an iDEAL Sale](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-ideal-intro/ppro-sale-intro-ideal/ppro-sale-ex-ideal-rest.md "") * [Example: Requesting an iDEAL Retrieve a Transaction](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-ideal-intro/ppro-status-ideal-intro/ppro-status-ex-ideal-rest.md "") * [Example: Requesting an iDEAL Refund](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-ideal-intro/ppro-refund-intro-ideal/ppro-refund-ex-ideal-rest.md "") * [Example: Requesting Options Using the REST API](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-option-ex-rest.md "") Added the sale and refund workflows. For information, see [Processing a Sale Using a Bank ID Workflow](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-intro/ppro-intro-workflow.md "") and [Refunding a Payment Workflow](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-intro/ppro-intro-workflow-refund.md ""). 24.01.01 -------- Updated the listed endpoints in the Supported Services section. See [Endpoints for the REST API](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-intro/ppro-intro-support-services.md ""). Updated the link to the *REST API Field Reference Guide* in the Related information sections. 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 PPRO Integration {#ppro-intro} ============================================== PPRO enables merchants to offer customers from all over the world their preferred local payment method. Payment service providers (PSPs) can access a global selection of alternative payment methods using PPRO's proprietary processing platform. PPRO is easy to integrate to and use through the REST API, making it scalable and reliable, while providing PSPs with critical value-added features. Funding Types ------------- There are two types of processing methods for securing the funds for a payment: * Guaranteed funds * Not guaranteed funds Payment methods that are guaranteed funds enable merchants to know immediately Supported Payment Methods ------------------------- These are the supported payment methods offered by PPRO. * [Alfamart](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-alfamart-intro.md "") * [Bancontact](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-bancontact-intro.md "") * [DOKU](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-doku-intro.md "") * [Dragonpay](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-dragonpay-intro.md "") * [eNets Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-enets-intro/ppro-sale-intro-enets.md "") * [EPS](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-eps-intro.md "") * [Estonia Banks](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-estonia-intro.md "") * [FPX Online Banking](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-fpx-intro.md "") * [GrabPay Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-grabpay-intro/ppro-sale-intro-grabpay.md "") * [iDEAL](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-ideal-intro.md "") * [Indomaret](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-indomaret-intro.md "") * [Indonesia Banks](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-indonesia-intro.md "") * [Jenius Pay](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-jenius-intro.md "") * [Konbini](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-konbini-intro.md "") * [Latvia Banks](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-latvia-intro.md "") * [LinkAja](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-linkaja-intro.md "") * [Lithuania Banks](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-lithuania-intro.md "") * [Multibanco](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-multibanco-intro.md "") * [MyBank](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-mybank-intro.md "") * [OVO](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-ovo-intro.md "") * [Payconiq](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payconiq-intro.md "") * [Pay-easy](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payeasy-intro.md "") * [PayU](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payu-intro.md "") * [Przelewy24](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-przelewy-intro.md "") * [7-Eleven](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-seveneleven-intro.md "") * [Sofort](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-sofort-intro.md "") * [Thailand Bank](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-thailand-intro.md "") * [Trustly](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-trustly-intro.md "") * [TrustPay](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-trustpay-intro.md "") Endpoints for the REST API {#ppro-intro-support-services} ========================================================= `Cybersource` supports these API requests and their corresponding endpoints: Sale (**`TRANSACTION`**) : * **Production:** `POST` `https://api.cybersource.com``/pts/v2/payments` * **Test:** `POST` `https://apitest.cybersource.com``/pts/v2/payments` Retrieve a Transaction (**`GETSTATUS`**) : * **Production:** `GET` `https://api.cybersource.com``/tss/v2/transactions/`*{id}* * **Test:** `GET` `https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* : For more information about the retrieve a transaction request, see: : [index.html#transaction-details_transaction-details_retrieve-a-transaction](https://developer.cybersource.com/api-reference-assets/index.md#transaction-details_transaction-details_retrieve-a-transaction "") Refund (**`REFUND`**) : * **Production:** `POST` `https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds` * **Test:** `POST` `https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds` Options : * **Production:** `POST` `https://api.cybersource.com``/pts/v2/payments-options` * **Test:** `POST` `https://apitest.cybersource.com``/pts/v2/payments-options` Processing a Sale Workflow {#ppro-intro-workflow-sale} ====================================================== This workflow describes the sequence of events that comprises a successful PPRO payment. #### Figure: Sale Workflow ![](/content/dam/new-documentation/documentation/en-us/topics/payments-processing/altpay/ppro-int/graphics/ppro-workflow-sale-600x475.svg/jcr:content/renditions/original) 1. The customer begins to check out on the merchant's website and chooses the PPRO payment method. 2. The merchant sends a sale API request to `Cybersource`. 3. `Cybersource` responds with one of these possible statuses: * `COMPLETED` * `PENDING` * `SUCCEEDED_PENDING_FUNDS` > IMPORTANT There are transactions that do not use redirect URLs because the payment process does not require customer interaction. For these transactions, you will receive a status response after the initial sale request. 4. If the sale status is `PENDING` or `SUCCEEDED_PENDING_FUNDS`, the merchant redirects the customer to the payment method's checkout URL included in the sale response. If the sale status is `COMPLETED`, see step 8. 5. The customer completes the payment using the payment method's website and is then redirected to the merchant's website. 6. The merchant sends a retrieve a transaction API request to `Cybersource`. #### ADDITIONAL INFORMATION You can send the retrieve a transaction request any time after a pending sale or refund request. `Cybersource` recommends sending a retrieve a transaction API request every 60-minutes for e-commerce transactions and every 3-minutes for in-store transactions until the payment is complete. 7. `Cybersource` responds with a `COMPLETED` status. 8. The merchant displays a confirmation of payment to the customer. Processing a Sale Using a Bank ID Workflow {#ppro-intro-workflow} ================================================================= This workflow describes the sequence of events that comprises a successful payment with the options API request. The bank options API request is optional and is only supported by some PPRO payment methods. #### Figure: Sale with Bank Options Workflow ![](/content/dam/new-documentation/documentation/en-us/topics/payments-processing/altpay/ppro-int/graphics/ppro-workflow-sale-ops-600x690.svg/jcr:content/renditions/original) 1. The merchant sends a bank options API request to `Cybersource` at the beginning of the business day.{#ppro-intro-workflow_step-1} {#ppro-intro-workflow_step-1} 2. `Cybersource` responds to merchant with a `SUCCESS` status and a list of supported banks.{#ppro-intro-workflow_step-2} {#ppro-intro-workflow_step-2} 3. The merchant caches the retrieved bank list.{#ppro-intro-workflow_step-3} {#ppro-intro-workflow_step-3} 4. The customer begins to check out on the merchant's website and chooses the PPRO payment method.{#ppro-intro-workflow_step-4} {#ppro-intro-workflow_step-4} 5. The merchant displays the list of supported banks to the customer.{#ppro-intro-workflow_step-5} {#ppro-intro-workflow_step-5} 6. The customer selects a supported bank.{#ppro-intro-workflow_step-6} {#ppro-intro-workflow_step-6} 7. The merchant sends a sale API request to `Cybersource`.{#ppro-intro-workflow_step-7} {#ppro-intro-workflow_step-7} 8. `Cybersource` responds with one of these possible statuses: * `COMPLETED` * `PENDING` * `SUCCEEDED_PENDING_FUNDS` > IMPORTANT There are transactions that do not use redirect URLs because the payment process does not require customer interaction. For these transactions, you will receive a status response after the initial sale request. > {#ppro-intro-workflow_step-8} > {#ppro-intro-workflow_step-8} 9. If the sale status is `PENDING` or `SUCCEEDED_PENDING_FUNDS`, the merchant redirects the customer to the bank URL included in the sale response. If the sale status is `COMPLETED`, see step 13. {#ppro-intro-workflow_step-9} {#ppro-intro-workflow_step-9} 10. The customer completes the payment on the bank's website and is then redirected to the merchant's website.{#ppro-intro-workflow_step-10} {#ppro-intro-workflow_step-10} 11. The merchant sends a retrieve a transaction API request to `Cybersource`. #### ADDITIONAL INFORMATION {#ppro-intro-workflow_step-11} You can send the retrieve a transaction request any time after a pending sale or refund request. `Cybersource` recommends sending a retrieve a transaction API request every 60-minutes for e-commerce transactions and every 3-minutes for in-store transactions until the payment is complete. {#ppro-intro-workflow_step-11} 12. `Cybersource` responds with a `COMPLETED` status.{#ppro-intro-workflow_step-12} {#ppro-intro-workflow_step-12} 13. The merchant displays a confirmation of payment to the customer.{#ppro-intro-workflow_step-13} {#ppro-intro-workflow_step-13} Refunding a Payment Workflow {#ppro-intro-workflow-refund} ========================================================== This workflow describes the sequence of events that comprises a successful refund. #### Figure: Refund Workflow ![](/content/dam/new-documentation/documentation/en-us/topics/payments-processing/altpay/ppro-int/graphics/ppro-workflow-refund-600x360.svg/jcr:content/renditions/original) 1. The customer returns purchase to the merchant. 2. The merchant sends a refund API request to `Cybersource`. 3. `Cybersource` responds to the merchant with a `REFUNDED` status. 4. The merchant sends a retrieve a transaction API request to `Cybersource`. #### ADDITIONAL INFORMATION You can send the retrieve a transaction request any time after a pending sale or refund request. `Cybersource` recommends sending a retrieve a transaction API request every 60-minutes for e-commerce transactions and every 3-minutes for in-store transactions until the refund is complete. 5. `Cybersource` responds to the merchant with a `REFUNDED` status. 6. The merchant displays the refund confirmation to the customer. Response Statuses Workflow {#ppro-intro-workflow-statuses} ========================================================== This workflow describes the sequence of possible statuses you can receive when processing a payment and refund. #### Figure: Response Statuses Workflow ![](/content/dam/new-documentation/documentation/en-us/topics/payments-processing/altpay/ppro-int/graphics/ppro-workflow-statuses-660x780.svg/jcr:content/renditions/original) 1. (Optiona) When the customer is ready to make a purchase, you send a sale API request to `Cybersource` and receive one of these possible statuses: 2. When the customer is ready to make a purchase, you send a sale API request to `Cybersource` and receive one of these possible statuses: * `COMPLETED`: The request is successful and the sale is complete. No further action is needed.{#ppro-intro-workflow-statuses_d11e69} {#ppro-intro-workflow-statuses_d11e69} * `FAILED`: The request is not successful due to the PPRO supported payment method declining the request. Send a new sale request.{#ppro-intro-workflow-statuses_d11e74} {#ppro-intro-workflow-statuses_d11e74} * `INVALID_REQUEST`: The request is not successful due to invalid information in the request. Send a new sale request.{#ppro-intro-workflow-statuses_d11e79} {#ppro-intro-workflow-statuses_d11e79} * `PENDING`: The request is successful and is currently processing. Redirect the customer to the payment method's URL in the response in order for the customer to complete the payment. Send periodic retrieve a transaction requests until the status updates.{#ppro-intro-workflow-statuses_d11e84} {#ppro-intro-workflow-statuses_d11e84} * `SERVER_ERROR`: The request is not successful due to a system timeout error. Resend the sale request.{#ppro-intro-workflow-statuses_d11e89} {#ppro-intro-workflow-statuses_d11e89} * `SUCCEEDED_PENDING_FUNDS`: The request is successful. PPRO is reviewing the request before releasing the funds. Send periodic retrieve a transaction requests until the status updates.{#ppro-intro-workflow-statuses_d11e95} {#ppro-intro-workflow-statuses_d11e95} 3. To verify that the sale is complete, you send a retrieve a transaction API request to `Cybersource` and receive one of these possible statuses: * `COMPLETED`: The customer has completed the checkout using the redirect URL and the sale is complete. No further action is needed.{#ppro-intro-workflow-statuses_d11e118} {#ppro-intro-workflow-statuses_d11e118} * `FAILED`: The request is not successful due to the PPRO supported payment method declining the request. Send a new request.{#ppro-intro-workflow-statuses_d11e123} {#ppro-intro-workflow-statuses_d11e123} * `PENDING`: The customer has not yet completed checking out using the redirect URL. Continue sending periodic retrieve a transaction requests until the status updates.{#ppro-intro-workflow-statuses_d11e128} {#ppro-intro-workflow-statuses_d11e128} * `SERVER_ERROR`: The request is not successful due to a system timeout error. Resend the request.{#ppro-intro-workflow-statuses_d11e133} {#ppro-intro-workflow-statuses_d11e133} * `SUCCEEDED_PENDING_FUNDS`: The request is successful. PPRO is reviewing the request before releasing the funds. Continue sending periodic retrieve a transaction requests until the status updates.{#ppro-intro-workflow-statuses_d11e138} {#ppro-intro-workflow-statuses_d11e138} 4. When the customer returns a purchase, you send a refund API request to `Cybersource` and receive one of these possible statuses: * `FAILED`: The request is not successful due to the PPRO supported payment method declining the request. Send a new refund request.{#ppro-intro-workflow-statuses_d11e160} {#ppro-intro-workflow-statuses_d11e160} * `INVALID_REQUEST`: The request is not successful due to invalid information in the request. Send a new sale request.{#ppro-intro-workflow-statuses_d11e165} {#ppro-intro-workflow-statuses_d11e165} * `PENDING_FUNDS`: The request is not successful due to either a financial limitation, legal restriction, or operational reason, such as money-holding regulations or anti-money laundering (AML) regulations. Send a new refund request.{#ppro-intro-workflow-statuses_d11e170} {#ppro-intro-workflow-statuses_d11e170} * `REFUNDED`: The request is successful and the refund is complete. No further action is needed.{#ppro-intro-workflow-statuses_d11e175} {#ppro-intro-workflow-statuses_d11e175} * `SERVER_ERROR`: The request is not successful due to a system timeout error. Resend the refund request.{#ppro-intro-workflow-statuses_d11e180} {#ppro-intro-workflow-statuses_d11e180} Alfamart {#ppro-alfamart-intro} =============================== This section describes how to integrate APIs that perform these functions: * [Alfamart Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-alfamart-intro/ppro-sale-intro-alfamart.md "") * [Alfamart Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-alfamart-intro/ppro-refund-intro-alfamart.md "") Alfamart Sales {#ppro-sale-intro-alfamart} ========================================== This section describes how to process a sale. `Cybersource` enables customers to make general purchases and purchases using Kredivo. For all general purchases, use the required fields and any optional field you may want. If you are making a purchase using Kredivo, you must use the required fields and the additional relevant fields. Airline Sales ------------- For all airline related purchases, set the industry type to airline: processingInformation.industryDataType : Set to `airline`. If the purchase is airline related but not for a flight ticket, set the field value to `No`. If the purchase is for a flight ticket, set the field value to `Yes`, and include the additional airline fields. Kredivo Sales ------------- For all purchases using Kredivo, set the payment type to `kredivo`: paymentInformation.paymentType.method.type : You will also need to include the address and locality fields when using Kredivo as the payment type. [See Kredivo Fields](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-alfamart-intro/ppro-sale-intro-alfamart/ppro-sale-req-fields-alfamart.md#ppro-sale-req-fields-alfamart_section_bzk_z5y_wtb "") Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-alfamart_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-alfamart_d10e355} Alfamart Required Fields for a Sale Using the REST API {#ppro-sale-req-fields-alfamart} ======================================================================================= These fields are required for all transactions. [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Airline Fields {#ppro-sale-req-fields-alfamart_section_nbz_v5y_wtb} ------------------------------------------------------------------- This field is required for all airline transactions. [processingInformation.industryDataType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-industry-data-type.md "") : Set to `airline`. These fields are required if **processingInformation.industryDataType=airline** is set to `Yes`. travelInformation.transit.airline.flightType : travelInformation.transit.airline.reservationSystemCode : [travelInformation.transit.airline.legs\[\].originatingAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-orig-airport-code.md "") : [travelInformation.transit.airline.legs\[\].destinationAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-dest-airport-code.md "") : [travelInformation.transit.airline.legs\[\].departureDate](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-departure-date.md "") : [travelInformation.transit.airline.legs\[\].departureTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-depart-time.md "") : [travelInformation.transit.airline.legs\[\].flightNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-flight-number.md "") : [travelInformation.transit.airline.passengerName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-pass-name.md "") : travelInformation.transit.airline.passengerType : travelInformation.transit.airline.legs\[\].departTaxAmount : travelInformation.transit.airline.totalInsuranceAmount : [orderInformation.amountDetails.surcharge.amount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-surcharge-amount.md "") : travelInformation.transit.airline.ticketIssuer.code : travelInformation.transit.airline.frequentFlyerNumber : Set to `AG`. Kredivo Fields {#ppro-sale-req-fields-alfamart_section_bzk_z5y_wtb} ------------------------------------------------------------------- These fields are required if **paymentInformation.paymentType.method.type** is set to `kredivo`. [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.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.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.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.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 "") : Alfamart Optional Field {#ppro-sale-req-fields-alfamart-opt} ============================================================ paymentInformation.paymentType.method.type : Example: Requesting an Alfamart Sale Using the REST API {#ppro-sale-ex-alfamart-rest} ===================================================================================== Request ``` { "clientReferenceInformation": { "reconciliationId": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "888888888800", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "12000" } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "alfamart", "type":"alfaVa" } }, "customer": { "customerid": "abcd" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1177494712", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1177494712&rs=LNWNzQnylSg25Pd4RdEftLK5ilXDOeWg&cs=5430e64522b04fa7d8b27c2125a977efdc56f67a00ca9cdd3e5ab1e0ce5167ac" }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "6523329019126743604765", "submitTimeUtc": "2022-06-15T02:54:23Z" } ``` Example: Requesting an Alfamart Kredivo Sale Using the REST API {#ppro-sale-ex-alfamart-kredivo-rest} ===================================================================================================== Request ``` { "clientReferenceInformation": { "reconciliation": "sale5623", "code":"alfaKred123" }, "orderInformation": { "amountDetails": { "totalAmount": "1000000", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "1200" } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "alfamart", "type":"kredivo" } }, "customer": { "customerid": "1278" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1175659126", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1175659126&rs=v0hSSuo0LOX0YfRgJ4lO0heL1QqHb8RQ&cs=610832f0d173f918673117622895715a2015fbbdcf173dc1937ffeb1dc6c6c57" }, "message": "Successful", "status": "PENDING", "id": "6523329019126743604781", "submitTimeUtc": "2022-06-13T04:44:26Z" } ``` Alfamart Retrieve a Transaction {#ppro-status-intro-alfamart} ============================================================= This section describes how to retrieve the status of a pending payment or refund. Alfamart Fields {#ppro-status-req-fields-alfamart} ================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-alfamart_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-alfamart_d49e24} Example: Requesting an Alfamart Status Using the REST API {#ppro-status-ex-alfamart-rest} ========================================================================================= Request ``` { ""orderInformation"": { ""amountDetails"": { ""totalAmount"": ""1"", ""currency"": ""IDR"" } }, ""clientReferenceInformation"": { ""reconciliationId"": ""sale1077"", ""originalTransactionId"": ""1177494712"" }, ""paymentInformation"": { ""paymentType"": { ""name"": ""offline"", ""method"": { ""name"": ""alfamart"", ""type"":""alfaVa"" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "144491809" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031944", "submitTimeUtc": "2022-06-15T02:55:39Z" } ``` Example: Requesting an Alfamart Retrieve a Transaction Kredivo Using the REST API {#ppro-status-ex-alfamart-kredivo-rest} ========================================================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "reconciliationId": "sale5623", "originalTransactionId": "838944272" }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "alfamart", "type":"kredivo" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "128349377" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031957", "submitTimeUtc": "2022-06-13T05:09:17Z" } ``` Alfamart Refunds {#ppro-refund-intro-alfamart} ============================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-alfamart_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-alfamart_d10e385} The *{id}* is the request ID contained in the original transaction request. Alfamart Required Fields {#ppro-refund-req-fields-alfamart} =========================================================== [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 "") : {#ppro-refund-req-fields-alfamart_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-alfamart_d7e27} [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 "") : {#ppro-refund-req-fields-alfamart_d7e39} [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 "") : {#ppro-refund-req-fields-alfamart_d7e47} [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 "") : {#ppro-refund-req-fields-alfamart_d7e55} [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 "") : {#ppro-refund-req-fields-alfamart_d7e69} Example: Requesting an Alfamart Refund Using the REST API {#ppro-refund-ex-alfamart-rest} ========================================================================================= Request ``` { ""orderInformation"": { ""amountDetails"": { ""totalAmount"": ""1"", ""currency"": ""IDR"" } }, ""clientReferenceInformation"": { ""reconciliationId"": ""sale1077"", ""originalTransactionId"": ""1177494712"" }, ""paymentInformation"": { ""paymentType"": { ""name"": ""offline"", ""method"": { ""name"": ""alfamart"" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "144491809" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031944", "submitTimeUtc": "2022-06-15T02:55:39Z" } ``` Bancontact {#ppro-bancontact-intro} =================================== This section describes how to integrate APIs that perform these functions: * [Bancontact Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-bancontact-intro/ppro-sale-intro-bancontact-rest.md "") * [Bancontact Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-bancontact-intro/ppro-refund-req-fields-bancontact.md "") Bancontact Sales {#ppro-sale-intro-bancontact-rest} =================================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-bancontact-rest_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-bancontact-rest_d10e355} Bancontact Required Fields {#ppro-sale-req-fields-bancontact} ============================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-bancontact_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-bancontact_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-bancontact_d23e41} [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 "") : {#ppro-sale-req-fields-bancontact_d23e54} [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 "") : {#ppro-sale-req-fields-bancontact_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-bancontact_d23e81} [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 "") : {#ppro-sale-req-fields-bancontact_d23e94} [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 "") : {#ppro-sale-req-fields-bancontact_d23e107} merchantInformation.successUrl : Example: Requesting an Bancontact Sale Using the REST API {#ppro-sale-ex-bancontact-rest} ========================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "100000", "currency": "EUR", "taxAmount": "9080" }, "billTo":{ "country":"BE", "firstName":"John", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "localCard", "method": { "name": "bcmc" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1165805002", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr3%2Epaygate%2Ede%2Fti%2Fsimbcmc%3Ftx%3D1165805002%26rs%3DLH3m1gjyyzue63noDu1TsUMgAlPU7YFS%26cs%3D7050f6a1ff2624c12bb26bc0a45e4c24eb748f97aaab4f5f6b5efc7ec949f26e" }, "reconciliationId": "sale1077", "paymentInformation": { "binCountry": "BE" }, "message": "Successful", "status": "PENDING", "id": "65233290191267436032912", "submitTimeUtc": "2022-06-02T14:14:54Z" } ``` Retrieve a Transaction {#ppro-status-intro-x} ============================================= This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Bancontact Retrieve a Transaction {#ppro-status-req-fields-bancontact} ====================================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-bancontact_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-bancontact_d49e24} Example: Requesting an Bancontact Status Using the REST API {#ppro-status-ex-bancontact-rest} ============================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1165805002" }, "paymentInformation": { "paymentType": { "name": "localCard", "method": { "name": "bcmc" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "143875117" }, "message": "Successful", "status": "REFUNDED", "id": "65233290191267436031868", "submitTimeUtc": "2022-06-02T14:38:40Z" } ``` Bancontact Refunds {#ppro-refund-req-fields-bancontact} ======================================================= [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 "") : {#ppro-refund-req-fields-bancontact_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-bancontact_d7e27} [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 "") : {#ppro-refund-req-fields-bancontact_d7e39} [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 "") : {#ppro-refund-req-fields-bancontact_d7e47} [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 "") : {#ppro-refund-req-fields-bancontact_d7e55} [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 "") : {#ppro-refund-req-fields-bancontact_d7e69} Example: Requesting an Bancontact Refund Using the REST API {#ppro-refund-ex-bancontact-rest} ============================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1165805002" }, "paymentInformation": { "paymentType": { "name": "localCard", "method": { "name": "bcmc" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "143875117" }, "message": "Successful", "status": "REFUNDED", "id": "65233290191267436031868", "submitTimeUtc": "2022-06-02T14:38:40Z" } ``` DOKU {#ppro-doku-intro} ======================= This section describes how to integrate APIs that perform these functions: * [DOKU Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-doku-intro/ppro-sale-intro-doku.md "") * [DOKU Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-doku-intro/ppro-refund-intro-doku.md "") DOKU Sales {#ppro-sale-intro-doku} ================================== `Cybersource` enables customers to make general purchases and purchases using Kredivo. For all general purchases, use the required fields and any optional field you may want. If you are making a purchase using Kredivo, you must use the required fields and the additional relevant fields. Airline Sales ------------- For all airline related purchases, set the industry type to airline: processingInformation.industryDataType : Set to `airline`. If the purchase is airline related but not for a flight ticket, set the field value to `No`. If the purchase is for a flight ticket, set the field value to `Yes`, and include the additional airline fields. Kredivo Sales ------------- For all purchases using Kredivo, set the payment type to `kredivo`: paymentInformation.paymentType.method.type : You will also need to include the address and locality fields when using Kredivo as the payment type. [See Kredivo Fields](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-doku-intro/ppro-sale-intro-doku/ppro-sale-req-fields-doku.md#ppro-sale-req-fields-doku_section_bzk_z5y_wtb "") Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-doku_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-doku_d10e355} DOKU Required Fields {#ppro-sale-req-fields-doku} ================================================= Use these fields to perform a successful sale. [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Airline Fields {#ppro-sale-req-fields-doku_section_nbz_v5y_wtb} --------------------------------------------------------------- This field is required for all airline transactions. [processingInformation.industryDataType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-industry-data-type.md "") : Set to `airline`. These fields are required if **processingInformation.industryDataType=airline** is set to `Yes`. travelInformation.transit.airline.flightType : travelInformation.transit.airline.reservationSystemCode : [travelInformation.transit.airline.legs\[\].originatingAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-orig-airport-code.md "") : [travelInformation.transit.airline.legs\[\].destinationAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-dest-airport-code.md "") : [travelInformation.transit.airline.legs\[\].departureDate](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-departure-date.md "") : [travelInformation.transit.airline.legs\[\].departureTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-depart-time.md "") : [travelInformation.transit.airline.legs\[\].flightNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-flight-number.md "") : [travelInformation.transit.airline.passengerName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-pass-name.md "") : travelInformation.transit.airline.passengerType : travelInformation.transit.airline.legs\[\].departTaxAmount : travelInformation.transit.airline.totalInsuranceAmount : [orderInformation.amountDetails.surcharge.amount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-surcharge-amount.md "") : travelInformation.transit.airline.ticketIssuer.code : travelInformation.transit.airline.frequentFlyerNumber : Set to `AG`. Kredivo Fields {#ppro-sale-req-fields-doku_section_bzk_z5y_wtb} --------------------------------------------------------------- These fields are required if **paymentInformation.paymentType.method.type** is set to `kredivo`. [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.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.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.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.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 "") : DOKU Optional Field {#ppro-sale-req-fields-doku-opt} ==================================================== paymentInformation.paymentType.method.type : Example: Requesting an DOKU Sale Using the REST API {#ppro-sale-ex-doku-rest} ============================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1000000", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "1200" } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "doku", "type":"dokuWallet" } }, "customer": { "customerid": "1234" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169585326", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1169585326&rs=KsDe6CmsEhILcRdYHIwTq6WuiplX1nHJ&cs=2a6c47283e3caac6890d5e1a18fff56579cedd80a7091b529426bad627093430" }, "message": "Successful", "status": "PENDING", "id": "6523329019126743603331", "submitTimeUtc": "2022-06-06T14:24:14Z" } ``` DOKU Retrieve a Transaction {#ppro-status-intro-doku} ===================================================== This section describes how to retrieve the status of a pending payment or refund. DOKU Required Fields {#ppro-status-req-fields-doku} =================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-doku_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-doku_d49e24} Example: Requesting an DOKU Retrieve a Transaction Using the REST API {#ppro-status-ex-doku-rest} ================================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169585326" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "doku", "type":"dokuWallet" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144051805" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031908", "submitTimeUtc": "2022-06-06T14:26:35Z" } ``` DOKU Refunds {#ppro-refund-intro-doku} ====================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-doku_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-doku_d10e385} The *{id}* is the request ID contained in the original transaction request. DOKU Fields {#ppro-refund-req-fields-doku} ========================================== [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 "") : {#ppro-refund-req-fields-doku_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-doku_d7e27} [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 "") : {#ppro-refund-req-fields-doku_d7e39} [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 "") : {#ppro-refund-req-fields-doku_d7e47} [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 "") : {#ppro-refund-req-fields-doku_d7e55} [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 "") : {#ppro-refund-req-fields-doku_d7e69} Example: Requesting an DOKU Refund Using the REST API {#ppro-refund-ex-doku-rest} ================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169585326" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "doku" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144051805" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031908", "submitTimeUtc": "2022-06-06T14:26:35Z" } ``` Dragonpay {#ppro-dragonpay-intro} ================================= This section describes how to integrate APIs that perform these functions: * [Dragonpay Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-dragonpay-intro/ppro-sale-intro-dragonpay-rest.md "") * [Dragonpay Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-dragonpay-intro/ppro-refund-intro-dragonpay.md "") Dragonpay Sales {#ppro-sale-intro-dragonpay-rest} ================================================= This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-dragonpay-rest_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-dragonpay-rest_d10e355} Dragonpay Required Fields {#ppro-sale-req-fields-dragonpay} =========================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-dragonpay_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-dragonpay_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-dragonpay_d23e41} [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 "") : {#ppro-sale-req-fields-dragonpay_d23e54} [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 "") : {#ppro-sale-req-fields-dragonpay_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-dragonpay_d23e81} [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 "") : {#ppro-sale-req-fields-dragonpay_d23e94} [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 "") : {#ppro-sale-req-fields-dragonpay_d23e107} [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.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.md "") : Example: Requesting an Dragonpay Sale Using the REST API {#ppro-sale-ex-dragonpay-rest} ======================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "5001", "currency": "PHP", "taxAmount": "900" }, "billTo":{ "country":"PH", "firstName":"John", "lastName":"Doe", "email":"hishriva@visa.com", "phoneNumber":"987654321" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "dragonPay" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169511625", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/molpay/S1321/I?tx=1169511625&rs=YkLYEOCpK0WUHQH3RUC76a0yMm7LkLfQ&cs=c9aa7308ba57f4790fb2eaf9421964d7980318023884f35055804d44ceefd5cc" }, "message": "Successful", "status": "PENDING", "id": "6523329019126743603310", "submitTimeUtc": "2022-06-06T13:07:11Z" } ``` Retrieve a Transaction {#ppro-status-status-dragonpay} ====================================================== This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Required Fields for a Retrieve a Transaction {#ppro-status-req-fields-dragonpay} ================================================================================ These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-dragonpay_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-dragonpay_d49e24} Example: Requesting an Dragonpay Retrieve a Transaction Using the REST API {#ppro-status-ex-dragonpay-rest} =========================================================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "PHP" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169511625" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "dragonPay" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144048964" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031901", "submitTimeUtc": "2022-06-06T13:11:15Z" } ``` Dragonpay Refunds {#ppro-refund-intro-dragonpay} ================================================ This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-dragonpay_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-dragonpay_d10e385} The *{id}* is the request ID contained in the original transaction request. Dragonpay Required Fields {#ppro-refund-req-fields-dragonpay} ============================================================= [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 "") : {#ppro-refund-req-fields-dragonpay_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-dragonpay_d7e27} [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 "") : {#ppro-refund-req-fields-dragonpay_d7e39} [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 "") : {#ppro-refund-req-fields-dragonpay_d7e47} [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 "") : {#ppro-refund-req-fields-dragonpay_d7e55} [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 "") : {#ppro-refund-req-fields-dragonpay_d7e69} Example: Requesting an Dragonpay Refund Using the REST API {#ppro-refund-ex-dragonpay-rest} =========================================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "PHP" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169511625" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "dragonPay" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144048964" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031901", "submitTimeUtc": "2022-06-06T13:11:15Z" } ``` eNets {#ppro-enets-intro} ========================= This section describes how to process eNets transactions. eNets Sales {#ppro-sale-intro-enets} ==================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-enets_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-enets_d10e355} eNETS Required Fields {#ppro-sale-req-fields-enets} =================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-enets_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-enets_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-enets_d23e41} [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 "") : {#ppro-sale-req-fields-enets_d23e54} [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 "") : {#ppro-sale-req-fields-enets_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-enets_d23e81} [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 "") : {#ppro-sale-req-fields-enets_d23e94} [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 "") : {#ppro-sale-req-fields-enets_d23e107} [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.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.md "") : Example: Requesting an eNets Sale Using the REST API {#ppro-sale-ex-enets-rest} =============================================================================== Request ``` { "clientReferenceInformation": { "reconciliationId": "sale1002" }, "orderInformation": { "amountDetails": { "totalAmount": "600", "currency": "SGD", "taxAmount": "5" }, "billTo": { "firstName": "Tester", "lastName": "Doe", "country": "SG", "email": "hishriva12345@visa.com", "phoneNumber": "1234567891" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "eNets" } } }, "merchantInformation": { "returnUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "testdescription" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "mobilePhone": "8095803465" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1176624208", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/molpayhpp/S1364/I?tx=1176624208&rs=9t8qB403zKAshn97CCkhfnMiVCmVAUmn&cs=2a3b6182a1bde0a2d5a8a8be36f71a54c63a2e4478bbf216f19a6af372ceaa5e" }, "reconciliationId": "sale1002", "message": "Successful", "status": "PENDING", "id": "6523329019126743604852", "submitTimeUtc": "2022-06-14T06:24:54Z" } ``` EPS {#ppro-eps-intro} ===================== This section describes how to integrate APIs that perform these functions: * [EPS Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-eps-intro/ppro-sale-intro-eps-rest.md "") * [EPS Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-eps-intro/ppro-refund-intro-eps.md "") EPS Sales {#ppro-sale-intro-eps-rest} ===================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-eps-rest_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-eps-rest_d10e355} EPS Required Fields {#ppro-sale-req-fields-eps} =============================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-eps_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-eps_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-eps_d23e41} [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 "") : {#ppro-sale-req-fields-eps_d23e54} [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 "") : {#ppro-sale-req-fields-eps_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-eps_d23e81} [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 "") : {#ppro-sale-req-fields-eps_d23e94} [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 "") : {#ppro-sale-req-fields-eps_d23e107} Example: Requesting an EPS Sale Using the REST API {#ppro-sale-ex-eps-rest} =========================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"AT", "firstName":"John", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "eps" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "832620566", "rawStatus": "PENDING", "paymentUrl": "https://r3.paygate.de/ti/simeps?tx=832620566&rs=PM6XKpSDAJJAAxcmITZcY2MerNcGGvkf&cs=6ea7d1e4be1d8d674b9a1758cd8841d27de842ad783077b5e32ca8d406418201" }, "paymentInformation": { "binCountry": "AT" }, "message": "Successful", "status": "PENDING", "id": "65233290191267436032979", "submitTimeUtc": "2022-06-06T10:43:32Z" } ``` EPS Refunds {#ppro-refund-intro-eps} ==================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-eps_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-eps_d10e385} The *{id}* is the request ID contained in the original transaction request. EPS Fields {#ppro-refund-req-fields-eps} ======================================== [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 "") : {#ppro-refund-req-fields-eps_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-eps_d7e27} [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 "") : {#ppro-refund-req-fields-eps_d7e39} [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 "") : {#ppro-refund-req-fields-eps_d7e47} [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 "") : {#ppro-refund-req-fields-eps_d7e55} [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 "") : {#ppro-refund-req-fields-eps_d7e69} Example: Requesting an EPS Refund Using the REST API {#ppro-refund-ex-eps-rest} =============================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "832620566" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "eps" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "128011817" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031896", "submitTimeUtc": "2022-06-06T10:47:04Z" } ``` Estonia Banks {#ppro-estonia-intro} =================================== This section describes how to integrate APIs that perform these functions: * [Retrieve Bank Options](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-option-intro.md "") * [Estonia Banks Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-estonia-intro/ppro-sale-intro-estonia.md "") * [Estonia Banks Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-estonia-intro/ppro-refund-intro-estonia.md "") Retrieve Bank Options {#ppro-option-estonia-intro} ================================================== This section describes how to send an options request in order to retrieve a list of participating banks for the day. Perform the options request to receive the latest updates for participating banks' redirect URLs, IDs, and any additional data. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments-options`{#ppro-option-estonia-intro_d10e140} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments-options`{#ppro-option-estonia-intro_d10e150} Required Fields for Options Using the REST API {#ppro-option-estonia-req-fields} ================================================================================ These fields are required for setting options. [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.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 "") : [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 "") : paymentInformation.paymentType.method.type : Example: Retrieving Bank Options {#ppro-options-estonia-ex-rest} ================================================================ Request ``` { "clientReferenceInformation" : { "code" : "123456" }, "paymentInformation" : { "paymentType" : { "method" : { "name" : "estoniabanks" }, "name" : "bankTransfer" } } } ``` Response to a Successful Request ``` { "submitTimeUtc": "Wed Nov 13 21:26:33 UTC 2024", "paymentOptions": { "resources": [ { "name": "BLIK - PSP", "id": "154" }, { "id": "94", "name": "Euro Bank" }, { "id": "25", "name": "mBank - mTransfer" }, { "id": "135", "name": "Płac ̨e z IKO" }, { "name": "Płac ̨e z Orange", "id": "146" }, { "name": "Przekaz tradycyjny", "id": "178" }, { "id": "102", "name": "Raiffeisen Bank PBL" }, { "id": "177", "name": "U ̇zyj przedpłaty" }, { "id": "1000", "name": "Przekaz/Przelew tradycyjny" } ], "type": "p24methods" }, "paymentInformation": { "paymentType": { "method": { "name": "p24" }, "name": "bankTransfer" } }, "id": "7315331927636272003955", "message": "Successful", "status": "SUCCEEDED" } ``` Estonia Banks Sales {#ppro-sale-intro-estonia} ============================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-estonia_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-estonia_d10e355} Estonia Banks Required Fields {#ppro-sale-req-fields-estonia} ============================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-estonia_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-estonia_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-estonia_d23e41} [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 "") : {#ppro-sale-req-fields-estonia_d23e54} [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 "") : {#ppro-sale-req-fields-estonia_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-estonia_d23e81} [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 "") : {#ppro-sale-req-fields-estonia_d23e94} [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 "") : {#ppro-sale-req-fields-estonia_d23e107} [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 "") : Estonia Banks Optional Field {#ppro-sale-req-fields-estonia-opt} ================================================================ paymentOptions.resources\[\].id : Example: Requesting an Estonia Banks Sale Using the REST API {#ppro-sale-ex-estonia-rest} ========================================================================================= Request ``` { "clientReferenceInformation": { "code": "zZx5WZ3dkbMp" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "orderInformation": { "billTo": { "country": "EE", "firstName": "firstName", "lastName": "lastName", "address1": "ABC city, XYZ street", "email": "abc@estoniabanks.com" }, "amountDetails": { "totalAmount": "1000", "currency": "EUR" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "paymentInformation": { "customer": { "customerid": "12345" }, "paymentType": { "method": { "name": "estonianbanks" }, "name": "bankTransfer" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "829605119", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr3%2Epaygate%2Ede%2Fti%2Fsimestonianbanks%3Ftx%3D829605119%26rs%3DzaphIHohw9wVXcI7SRHIvK52o5FUwbGy%26cs%3Db326db7ec24d01fb318bb6ce0a4f495b8d32f19f7a4e90451077ef9ca91a8a53" }, "reconciliationId": "zZx5WZ3dkbMp", "paymentInformation": { "binCountry": "EE" }, "message": "Successful", "status": "PENDING", "id": "65233290191267436032918", "submitTimeUtc": "2022-06-03T05:14:54Z" } ``` Retrieve a Transaction {#ppro-status-intro-x} ============================================= This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Required Fields for a Retrieve a Transaction {#ppro-status-req-fields-estonia} ============================================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-estonia_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-estonia_d49e24} Example: Requesting an Estonia Banks Retrieve a Transaction Using the REST API {#ppro-status-ex-estonia-rest} ============================================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "zZx5WZ3dkbMp", "originalTransactionId": "829605119" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "estonianbanks" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "zZx5WZ3dkbMp" }, "processorInformation": { "transactionId": "128019965" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031906", "submitTimeUtc": "2022-06-06T14:10:47Z" } ``` Estonia Banks Refunds {#ppro-refund-intro-estonia} ================================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-estonia_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-estonia_d10e385} The *{id}* is the request ID contained in the original transaction request. Estonia Banks Required Fields {#ppro-refund-req-fields-estonia} =============================================================== [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 "") : {#ppro-refund-req-fields-estonia_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-estonia_d7e27} [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 "") : {#ppro-refund-req-fields-estonia_d7e39} [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 "") : {#ppro-refund-req-fields-estonia_d7e47} [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 "") : {#ppro-refund-req-fields-estonia_d7e55} [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 "") : {#ppro-refund-req-fields-estonia_d7e69} Example: Requesting an Estonia Banks Refund Using the REST API {#ppro-refund-ex-estonia-rest} ============================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "zZx5WZ3dkbMp", "originalTransactionId": "829605119" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "estonianbanks" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "zZx5WZ3dkbMp" }, "processorInformation": { "transactionId": "128019965" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031906", "submitTimeUtc": "2022-06-06T14:10:47Z" } ``` FPX Online Banking {#ppro-fpx-intro} ==================================== This section describes how to integrate APIs that perform these functions: * [FPX Online Banking Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-fpx-intro/ppro-sale-intro-fpx.md "") * [FPX Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-fpx-intro/ppro-refund-intro-fpx.md "") FPX Online Banking Sales {#ppro-sale-intro-fpx} =============================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-fpx_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-fpx_d10e355} FPX Online Banking Required Fields {#ppro-sale-req-fields-fpx} ============================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-fpx_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-fpx_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-fpx_d23e41} [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 "") : {#ppro-sale-req-fields-fpx_d23e54} [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 "") : {#ppro-sale-req-fields-fpx_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-fpx_d23e81} [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 "") : {#ppro-sale-req-fields-fpx_d23e94} [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 "") : {#ppro-sale-req-fields-fpx_d23e107} [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.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.md "") : FPX Online Banking Optional Field {#ppro-sale-req-fields-fpx-opt} ================================================================= paymentInformation.bank.name : Example: Requesting an FPX Online Banking Sale Using the REST API {#ppro-sale-ex-fpx-rest} ========================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "MYR", "taxAmount": "900" }, "billTo":{ "country":"MY", "firstName":"Jane", "lastName":"Doe", "phoneNumber":"909090909", "email":"abc@email.com" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "fpx" } }, "bank":{ "name":"publicbank" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "832651358", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/molpay/T1418/I?tx=832651358&rs=VW9b6b9GdsVDe2oGhFyBSXd0n5OfeOeJ&cs=0edfbcae22459c249680b83939d993ef72107cdb854c91b309d46787ec5107f7" }, "message": "Successful", "status": "PENDING", "id": "65233290191267436032980", "submitTimeUtc": "2022-06-06T11:15:01Z" } ``` FPX Refunds {#ppro-refund-intro-fpx} ==================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-fpx_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-fpx_d10e385} The *{id}* is the request ID contained in the original transaction request. FPX Fields {#ppro-refund-req-fields-fpx} ======================================== [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 "") : {#ppro-refund-req-fields-fpx_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-fpx_d7e27} [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 "") : {#ppro-refund-req-fields-fpx_d7e39} [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 "") : {#ppro-refund-req-fields-fpx_d7e47} [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 "") : {#ppro-refund-req-fields-fpx_d7e55} [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 "") : {#ppro-refund-req-fields-fpx_d7e69} Example: Requesting an FPX Refund Using the REST API {#ppro-refund-ex-fpx-rest} =============================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "MYR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "832620566" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "fpx" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144051805" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031908", "submitTimeUtc": "2022-06-06T14:26:35Z" } ``` GrabPay {#ppro-grabpay-intro} ============================= This section describes how to process a GrabPay transaction using the `REST API`. GrabPay Sales {#ppro-sale-intro-grabpay} ======================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-grabpay_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-grabpay_d10e355} GrabPay Required Fields {#ppro-sale-req-fields-grabpay} ======================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-grabpay_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-grabpay_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-grabpay_d23e41} [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 "") : {#ppro-sale-req-fields-grabpay_d23e54} [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 "") : {#ppro-sale-req-fields-grabpay_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-grabpay_d23e81} [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 "") : {#ppro-sale-req-fields-grabpay_d23e94} [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 "") : {#ppro-sale-req-fields-grabpay_d23e107} [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.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.md "") : Example: Requesting an GrabPay Sale Using the REST API {#ppro-sale-ex-grabpay-rest} =================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "SGD", "taxAmount": "9080" }, "billTo":{ "country":"SG", "firstName":"Jane", "lastName":"Doe", "email":"abc@email.com" } }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "grabpayotp" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "829098179", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr2%2Epaygate%2Ede%2Fgrabpay%2FT1108%2FI%3Ftx%3D829098179%26rs%3DAq1IRTX1j5EavdyqFjbyNmwTyC0DS3Bj%26cs%3D4cc542fcaf38c695bfd2b039f086c8a921a819848bdc244c301ac539c43bffd4" }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032914", "submitTimeUtc": "2022-06-02T14:56:37Z" } ``` iDEAL {#ppro-ideal-intro} ========================= This section describes how to process an iDEAL payment, refund a payment, and retrieve the current status of a payment or refund using the `REST API`. Process a Sale {#ppro-sale-intro-ideal} ======================================= This section describes how to process an iDEAL sale. A successful sale request includes an iDEAL redirect URL in the response. You must redirect the customer to this URL in order for the customer to complete the payment using their iDEAL account. If the customer does not complete the payment within 60 minutes of the URL being generated, the URL will expire and the sale's status updates to `FAILED`. If the URL expires, send a new sale request to complete the payment. Shipping Information -------------------- `Cybersource` recommends that you do not ship purchased items until the sale is in the completed status. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-ideal_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-ideal_d10e355} Response Statuses ----------------- Cybersource responds to your request with one of these possible statuses in the status response field. * `PENDING`: The request is successful and is currently processing. Redirect the customer to the payment method's URL in the response in order for the customer to complete the payment. Send periodic retrieve a transaction requests until the status updates. * `FAILED`: The request is not successful due to the PPRO supported payment method declining the request. Send a new sale request. * `INVALID_REQUEST`: The request is not successful due to invalid information in the request. Send a new sale request. * `SERVER_ERROR`: The request is not successful due to a system timeout error. Resend the sale request. Required Fields for Processing a Sale {#ppro-sale-req-fields-ideal} =================================================================== [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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 "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.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 "") : [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 "") : Optional Fields for Processing a Sale {#ppro-sale-opt-fields-ideal} =================================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "")buyerInformation.language : [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 "") : clientReferenceInformation.appToAppUrl : [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 "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [paymentInformation.customer.customerId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-customer-customer-id.md "") : [paymentInformation.bank.swiftCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-bank-swift-code.md "") : Example: Requesting an iDEAL Sale {#ppro-sale-ex-ideal-rest} ============================================================ Request ``` { "orderInformation": { "billTo": { "country": "NL", "firstName": "Test", "lastName": "Tester" }, "amountDetails": { "totalAmount": "100.00", "currency": "EUR" } }, "merchantInformation": { "returnUrl": "https://www.test-merchant-return-url.com" }, "paymentInformation": { "paymentType": { "method": { "name": "ideal" }, "name": "bankTransfer" } } } ``` Response to a Successful Request ``` { "paymentInformation": { "purposeOfPayment": "68EISVZ ", "binCountry": "NL" }, "processorInformation": { "transactionId": "140340904161", "rawStatus": "PENDING", "paymentUrl": "https://r3.girogate.de/ti/simideal?tx=140340904161&rs=dwnkeySIlrsvFT4iu2SGVQoyaFNxJ17j&cs=c67fb2057becdd9212b3896f8c3558beee576b249dc21d8682634dd8b64bdec4" }, "message": "Successful", "status": "PENDING", "id": "7395648657446662204807", "submitTimeUtc": "2025-02-14T20:27:45Z" } ``` Retrieve a Transaction {#ppro-status-ideal-intro} ================================================= This section describes how to retrieve the current status of a sale or refund. You can send the retrieve a transaction request any time after sending sale or refund request. When you send a retrieve a transaction, `Cybersource` responds with the transaction's current status in the applicationInformation.status response field. `Cybersource` recommends sending a retrieve a transaction request every 60-minutes for e-commerce transactions and every 3-minutes for in-store transactions until the payment is complete. Shipping Information -------------------- `Cybersource` recommends that you do not ship purchased items until the sale is in the completed status. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Response Statuses ----------------- Cybersource responds to your request with one of these possible statuses in the status response field. * `COMPLETED`: The customer has completed the checkout using the redirect URL and the sale is complete. No further action is needed. * `FAILED`: The request is not successful due to the PPRO supported payment method declining the request. Send a new request. * `PENDING`: The customer has not yet completed checking out using the redirect URL. Continue sending periodic retrieve a transaction requests until the status updates. * `SERVER_ERROR`: The request is not successful due to a system timeout error. Resend the request. Example: Requesting an iDEAL Retrieve a Transaction {#ppro-status-ex-ideal-rest} ================================================================================ Request ``` {} ``` Response to a Successful Request ``` { "id": "7395648657446662204807", "rootId": "7395648657446662204807", "status": "PENDING", "submitTimeUTC": "2025-02-14T20:27:45Z", "merchantId": "test_merchant", "applicationInformation": { "status": "PENDING", "reasonCode": 201, "applications": [ { "name": "altpay_transaction", "status": "PENDING", "reasonCode": "201", "rMessage": "Successful" } ] }, "buyerInformation": {}, "clientReferenceInformation": { "partner": {} }, "consumerAuthenticationInformation": { "transactionId": "140340904161", "strongAuthentication": {} }, "deviceInformation": {}, "errorInformation": { "message": "Successful" }, "installmentInformation": {}, "fraudMarkingInformation": {}, "merchantInformation": { "merchantDescriptor": { "name": "test_merchant" } }, "orderInformation": { "billTo": { "firstName": "Test", "lastName": "Testerson", "country": "NL" }, "shipTo": {}, "amountDetails": { "totalAmount": "100", "currency": "EUR", "taxAmount": "0", "authorizedAmount": "100" }, "shippingDetails": {}, "invoiceDetails": {} }, "paymentInformation": { "customer": {}, "paymentInstrument": {}, "instrumentIdentifier": {}, "shippingAddress": {}, "paymentType": { "name": "ppro", "type": "bankTransfer", "method": "IDLPP" }, "card": { "type": "IDLPP" }, "invoice": {}, "accountFeatures": {}, "fluidData": {}, "issuerInformation": {}, "paymentAccountInformation": { "card": {}, "features": {}, "network": {} } }, "paymentInsightsInformation": { "responseInsights": {}, "ruleResults": {} }, "payoutInformation": { "pushFunds": {}, "pullFunds": {} }, "payoutOptions": {}, "processingInformation": { "paymentSolution": "BankTransfer Payment Ideal", "authorizationOptions": { "initiator": { "merchantInitiatedTransaction": {} }, "cardVerificationIndicator": false }, "bankTransferOptions": {}, "japanPaymentOptions": {}, "fundingOptions": { "firstRecurringPayment": false }, "captureOptions": {} }, "processorInformation": { "processor": { "name": "ppro" }, "transactionId": "140340904161", "responseCode": "201", "avs": {}, "cardVerification": {}, "achVerification": { "resultCodeRaw": "201" }, "electronicVerificationResults": {}, "eventStatus": "Pending" }, "pointOfSaleInformation": {}, "riskInformation": { "score": {} }, "recipientInformation": {}, "senderInformation": { "account": {}, "paymentInformation": { "customer": {}, "paymentType": { "name": "ppro", "type": "bankTransfer", "method": "IDLPP" }, "card": { "type": "IDLPP" }, "invoice": {}, "accountFeatures": {}, "fluidData": {}, "issuerInformation": {}, "paymentAccountInformation": {} } }, "tokenInformation": {}, "_links": { "self": { "href": "https://apitest.cybersource.com/tss/v2/transactions/7395648657446662204807", "method": "GET" } }, "recurringPaymentInformation": {}, "unscheduledPaymentInformation": {} } ``` Refund a Payment {#ppro-refund-intro-ideal} =========================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-ideal_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-ideal_d10e385} The *{id}* is the request ID contained in the original transaction request. Response Statuses ----------------- Cybersource responds to your request with one of these possible statuses in the status response field. * `FAILED`: The request is not successful due to the PPRO supported payment method declining the request. Send a new refund request.{#ppro-refund-intro-ideal_d11e160} {#ppro-refund-intro-ideal_d11e160} * `INVALID_REQUEST`: The request is not successful due to invalid information in the request. Send a new sale request.{#ppro-refund-intro-ideal_d11e165} {#ppro-refund-intro-ideal_d11e165} * `PENDING_FUNDS`: The request is not successful due to either a financial limitation, legal restriction, or operational reason, such as money-holding regulations or anti-money laundering (AML) regulations. Send a new refund request.{#ppro-refund-intro-ideal_d11e170} {#ppro-refund-intro-ideal_d11e170} * `REFUNDED`: The request is successful and the refund is complete. No further action is needed.{#ppro-refund-intro-ideal_d11e175} {#ppro-refund-intro-ideal_d11e175} * `SERVER_ERROR`: The request is not successful due to a system timeout error. Resend the refund request.{#ppro-refund-intro-ideal_d11e180} {#ppro-refund-intro-ideal_d11e180} {#ppro-refund-intro-ideal_d11e158} Required Fields for Refunding a Payment {#ppro-refund-req-fields-ideal} ======================================================================= clientReferenceInformation.originalTransactionId : [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 "") : [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 "") : Optional Fields for Refunding a Payment {#ppro-refund-opt-fields-ideal} ======================================================================= [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.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.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.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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 "") : [paymentInformation.customer.customerId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-customer-customer-id.md "") : Example: Requesting an iDEAL Refund {#ppro-refund-ex-ideal-rest} ================================================================ Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "45.00", "currency": "EUR" } }, "clientReferenceInformation": { "originalTransactionId": "2376538903" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "ideal" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1319551320" }, "message": "Successful", "status": "REFUNDED", "id": "7395660749286003504805", "submitTimeUtc": "2025-02-14T20:47:55Z" } ``` Indomaret {#ppro-indomaret-intro} ================================= This section describes how to integrate APIs that perform this function: * [Indomaret Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-indomaret-intro/ppro-sale-intro-indomaret.md "") Indomaret Sales {#ppro-sale-intro-indomaret} ============================================ `Cybersource` enables customers to make general purchases and purchases using Kredivo. For all general purchases, use the required fields and any optional field you may want. If you are making a purchase using Kredivo, you must use the required fields and the additional relevant fields. Airline Sales ------------- For all airline related purchases, set the industry type to airline: processingInformation.industryDataType : Set to `airline`. If the purchase is airline related but not for a flight ticket, set the field value to `No`. If the purchase is for a flight ticket, set the field value to `Yes`, and include the additional airline fields. Kredivo Sales ------------- For all purchases using Kredivo, set the payment type to `kredivo`: paymentInformation.paymentType.method.type : You will also need to include the address and locality fields when using Kredivo as the payment type. [See Kredivo Fields](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-indomaret-intro/ppro-sale-intro-indomaret/ppro-sale-req-fields-indomaret.md#ppro-sale-req-fields-indomaret_section_bzk_z5y_wtb "") Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-indomaret_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-indomaret_d10e355} Indomaret Fields {#ppro-sale-req-fields-indomaret} ================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Airline Fields {#ppro-sale-req-fields-indomaret_section_nbz_v5y_wtb} -------------------------------------------------------------------- This field is required for all airline transactions. [processingInformation.industryDataType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-industry-data-type.md "") : Set to `airline`. These fields are required if **processingInformation.industryDataType=airline** is set to `Yes`. travelInformation.transit.airline.flightType : travelInformation.transit.airline.reservationSystemCode : [travelInformation.transit.airline.legs\[\].originatingAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-orig-airport-code.md "") : [travelInformation.transit.airline.legs\[\].destinationAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-dest-airport-code.md "") : [travelInformation.transit.airline.legs\[\].departureDate](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-departure-date.md "") : [travelInformation.transit.airline.legs\[\].departureTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-depart-time.md "") : [travelInformation.transit.airline.legs\[\].flightNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-flight-number.md "") : [travelInformation.transit.airline.passengerName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-pass-name.md "") : travelInformation.transit.airline.passengerType : travelInformation.transit.airline.legs\[\].departTaxAmount : travelInformation.transit.airline.totalInsuranceAmount : [orderInformation.amountDetails.surcharge.amount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-surcharge-amount.md "") : travelInformation.transit.airline.ticketIssuer.code : travelInformation.transit.airline.frequentFlyerNumber : Set to `AG`. Kredivo Fields {#ppro-sale-req-fields-indomaret_section_bzk_z5y_wtb} -------------------------------------------------------------------- These fields are required if **paymentInformation.paymentType.method.type** is set to `kredivo`. [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.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.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.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.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 "") : Indomaret Optional Field {#ppro-sale-req-fields-indomaret-opt} ============================================================== paymentInformation.paymentType.method.type : Example: Requesting an Indomaret Sale Using the REST API {#ppro-sale-ex-indomaret-rest} ======================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1000000", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": 1200 } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" } }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "indomaret", "type":"alfaVa" } }, "customer": { "customerid": "abcd" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1166616607", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr2%2Epaygate%2Ede%2Fdoku%2FS1150%2FI%3Ftx%3D1166616607%26rs%3DE85JYxrmL2kbtET79vRYCfYijdhrQLbe%26cs%3D27a86537adeed14853ca13c56d3140fafa9c9d3b62cdc192cded9964348bcebd" }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032944", "submitTimeUtc": "2022-06-03T11:06:01Z" } ``` Indonesia Banks {#ppro-indonesia-intro} ======================================= This section describes how to integrate APIs that perform these functions: * [Indonesia Banks Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-indonesia-intro/ppro-sale-intro-indonesia.md "") * [Indonesia Banks Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-indonesia-intro/ppro-refund-intro-indonesia.md "") Indonesia Banks Sales {#ppro-sale-intro-indonesia} ================================================== `Cybersource` enables customers to make general purchases and purchases using Kredivo. For all general purchases, use the required fields and any optional field you may want. If you are making a purchase using Kredivo, you must use the required fields and the additional relevant fields. Airline Sales ------------- For all airline related purchases, set the industry type to airline: processingInformation.industryDataType : Set to `airline`. If the purchase is airline related but not for a flight ticket, set the field value to `No`. If the purchase is for a flight ticket, set the field value to `Yes`, and include the additional airline fields. Kredivo Sales ------------- For all purchases using Kredivo, set the payment type to `kredivo`: paymentInformation.paymentType.method.type : You will also need to include the address and locality fields when using Kredivo as the payment type. [See Kredivo Fields](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-indonesia-intro/ppro-sale-intro-indonesia/ppro-sale-req-fields-indonesia.md#ppro-sale-req-fields-indonesia_section_bzk_z5y_wtb "") Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-indonesia_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-indonesia_d10e355} Indonesia Banks Fields {#ppro-sale-req-fields-indonesia} ======================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Airline Fields {#ppro-sale-req-fields-indonesia_section_nbz_v5y_wtb} -------------------------------------------------------------------- This field is required for all airline transactions. [processingInformation.industryDataType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-industry-data-type.md "") : Set to `airline`. These fields are required if **processingInformation.industryDataType=airline** is set to `Yes`. travelInformation.transit.airline.flightType : travelInformation.transit.airline.reservationSystemCode : [travelInformation.transit.airline.legs\[\].originatingAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-orig-airport-code.md "") : [travelInformation.transit.airline.legs\[\].destinationAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-dest-airport-code.md "") : [travelInformation.transit.airline.legs\[\].departureDate](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-departure-date.md "") : [travelInformation.transit.airline.legs\[\].departureTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-depart-time.md "") : [travelInformation.transit.airline.legs\[\].flightNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-flight-number.md "") : [travelInformation.transit.airline.passengerName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-pass-name.md "") : travelInformation.transit.airline.passengerType : travelInformation.transit.airline.legs\[\].departTaxAmount : travelInformation.transit.airline.totalInsuranceAmount : [orderInformation.amountDetails.surcharge.amount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-surcharge-amount.md "") : travelInformation.transit.airline.ticketIssuer.code : travelInformation.transit.airline.frequentFlyerNumber : Set to `AG`. Kredivo Fields {#ppro-sale-req-fields-indonesia_section_bzk_z5y_wtb} -------------------------------------------------------------------- These fields are required if **paymentInformation.paymentType.method.type** is set to `kredivo`. [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.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.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.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.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 "") : Indonesia Optional Field {#ppro-sale-req-fields-indonesia-opt} ============================================================== paymentInformation.paymentType.method.type : Example: Requesting an Indonesia Banks Sale Using the REST API {#ppro-sale-ex-indonesia-rest} ============================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1000000", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "1200" } }, "billTo": { "firstName": "Jane", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "indonesiaBank", "type":"bankMandiri" } }, "customer": { "customerid": "1234" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169545123", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1169545123&rs=VfcxWb4wfxeZoayPogIz9cGE7LAzU33j&cs=06f532201a8075d3ba3d7e4abd3fe02974f6a21fd2f38dabffdd122187a8c5f4" }, "message": "Successful", "status": "PENDING", "id": "6523329019126743603320", "submitTimeUtc": "2022-06-06T13:42:08Z" } ``` Indonesia Banks Retrieve a Transaction {#ppro-status-intro-indonesia} ===================================================================== This section describes how to retrieve a transaction status. Indonesia Banks Fields {#ppro-status-req-fields-indonesia} ========================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-indonesia_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-indonesia_d49e24} Example: Requesting an Indonesia Banks Retrieve a Transaction Using the REST API {#ppro-status-ex-indonesia-rest} ================================================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "832812116" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "indonesiaBank", "type":"briVa" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "128019431" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031902", "submitTimeUtc": "2022-06-06T14:00:25Z" } ``` Indonesia Banks Refunds {#ppro-refund-intro-indonesia} ====================================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-indonesia_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-indonesia_d10e385} The *{id}* is the request ID contained in the original transaction request. Indonesia Banks Fields {#ppro-refund-req-fields-indonesia} ========================================================== [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 "") : {#ppro-refund-req-fields-indonesia_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-indonesia_d7e27} [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 "") : {#ppro-refund-req-fields-indonesia_d7e39} [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 "") : {#ppro-refund-req-fields-indonesia_d7e47} [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 "") : {#ppro-refund-req-fields-indonesia_d7e55} [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 "") : {#ppro-refund-req-fields-indonesia_d7e69} Example: Requesting an Indonesia Banks Refund Using the REST API {#ppro-refund-ex-indonesia-rest} ================================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "832812116" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "indonesiaBank" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "128019431" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031902", "submitTimeUtc": "2022-06-06T14:00:25Z" } ``` Jenius Pay {#ppro-jenius-intro} =============================== This section describes how to integrate APIs that perform these functions: * [Jenius Pay Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-jenius-intro/ppro-sale-intro-jenius.md "") * [Jenius Pay Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-jenius-intro/ppro-refund-intro-jenius.md "") Jenius Pay Sales {#ppro-sale-intro-jenius} ========================================== `Cybersource` enables customers to make general purchases and purchases using Kredivo. For all general purchases, use the required fields and any optional field you may want. If you are making a purchase using Kredivo, you must use the required fields and the additional relevant fields. Airline Sales ------------- For all airline related purchases, set the industry type to airline: processingInformation.industryDataType : Set to `airline`. If the purchase is airline related but not for a flight ticket, set the field value to `No`. If the purchase is for a flight ticket, set the field value to `Yes`, and include the additional airline fields. Kredivo Sales ------------- For all purchases using Kredivo, set the payment type to `kredivo`: paymentInformation.paymentType.method.type : You will also need to include the address and locality fields when using Kredivo as the payment type. [See Kredivo Fields](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-jenius-intro/ppro-sale-intro-jenius/ppro-sale-req-fields-jenius.md#ppro-sale-req-fields-jenius_section_bzk_z5y_wtb "") Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-jenius_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-jenius_d10e355} Jenius Pay Fields {#ppro-sale-req-fields-jenius} ================================================ [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Airline Fields {#ppro-sale-req-fields-jenius_section_nbz_v5y_wtb} ----------------------------------------------------------------- This field is required for all airline transactions. [processingInformation.industryDataType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-industry-data-type.md "") : Set to `airline`. These fields are required if **processingInformation.industryDataType=airline** is set to `Yes`. travelInformation.transit.airline.flightType : travelInformation.transit.airline.reservationSystemCode : [travelInformation.transit.airline.legs\[\].originatingAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-orig-airport-code.md "") : [travelInformation.transit.airline.legs\[\].destinationAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-dest-airport-code.md "") : [travelInformation.transit.airline.legs\[\].departureDate](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-departure-date.md "") : [travelInformation.transit.airline.legs\[\].departureTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-depart-time.md "") : [travelInformation.transit.airline.legs\[\].flightNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-flight-number.md "") : [travelInformation.transit.airline.passengerName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-pass-name.md "") : travelInformation.transit.airline.passengerType : travelInformation.transit.airline.legs\[\].departTaxAmount : travelInformation.transit.airline.totalInsuranceAmount : [orderInformation.amountDetails.surcharge.amount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-surcharge-amount.md "") : travelInformation.transit.airline.ticketIssuer.code : travelInformation.transit.airline.frequentFlyerNumber : Set to `AG`. Kredivo Fields {#ppro-sale-req-fields-jenius_section_bzk_z5y_wtb} ----------------------------------------------------------------- These fields are required if **paymentInformation.paymentType.method.type** is set to `kredivo`. [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.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.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.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.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 "") : Jenius Pay Optional Field {#ppro-sale-req-fields-jenius-opt} ============================================================ paymentInformation.paymentType.method.type : Example: Requesting an Jenius Pay Sale Using the REST API {#ppro-sale-ex-jenius-rest} ===================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1000000", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "1200" } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "jeniusPay", "type":"jeniusPayWallet" } }, "customer": { "customerid": "abcd" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169264974", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1169264974&rs=Q9WGk75aBVbznsyzS1T8u9pELeoqRB5R&cs=f2b678e730cb4bd53008a7c234d8e2d395bd97013d4bbe31aa961248c405654e" }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032971", "submitTimeUtc": "2022-06-06T09:01:52Z" } ``` Retrieve a Transaction {#ppro-status-intro-x} ============================================= This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Jenius Pay Fields {#ppro-status-req-fields-jenius} ================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-jenius_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-jenius_d49e24} Example: Requesting an Jenius Pay Retrieve a Transaction Using the REST API {#ppro-status-ex-jenius-rest} ========================================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169264974" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "jeniusPay", "type":"jeniusPayWallet" } } } } ``` Response to a Successful Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169264974" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "jeniusPay", "type":"jeniusPayWallet" } } } } ``` Jenius Pay Refunds {#ppro-refund-intro-jenius} ============================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-jenius_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-jenius_d10e385} The *{id}* is the request ID contained in the original transaction request. Jenius Pay Fields {#ppro-refund-req-fields-jenius} ================================================== [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 "") : {#ppro-refund-req-fields-jenius_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-jenius_d7e27} [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 "") : {#ppro-refund-req-fields-jenius_d7e39} [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 "") : {#ppro-refund-req-fields-jenius_d7e47} [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 "") : {#ppro-refund-req-fields-jenius_d7e55} [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 "") : {#ppro-refund-req-fields-jenius_d7e69} Example: Requesting an Jenius Pay Refund Using the REST API {#ppro-refund-ex-jenius-rest} ========================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169264974" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "jeniusPay" } } } } ``` Response to a Successful Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169264974" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "jeniusPay", "type":"jeniusPayWallet" } } } } ``` Konbini {#ppro-konbini-intro} ============================= This section describes how to integrate APIs that perform this function: * [Konbini Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-konbini-intro/ppro-sale-intro-konbini.md "") Konbini Sales {#ppro-sale-intro-konbini} ======================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-konbini_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-konbini_d10e355} Konbini Required Fields {#ppro-sale-req-fields-konbini} ======================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Example: Requesting an Konbini Sale Using the REST API {#ppro-sale-ex-konbini-rest} =================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "JPY", "taxAmount": "900" }, "billTo":{ "country":"JP", "firstName":"John", "lastName":"Doe", "email":"hishriva@visa.com", "phoneNumber":"1234567890" }, "lineItems":[ { "productName":"laptop" }, { "productName":"mobile" }] }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "konbini" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1165857820", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr2%2Epaygate%2Ede%2Fecontext%2FS1124%2FI%3Ftx%3D1165857820%26rs%3DRxJvDBtl4wQISKXcJliBJgZlWMAbFT15%26cs%3Df32d07e6bc266f83d5b920ab0a8d56a74214bafd5cf0dd6e7bdfedf649945277" }, "paymentInformation": { "paymentType": { "method": { "name": "Convenience+Store+via+Lawson", "type": "654321" } } }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032916", "submitTimeUtc": "2022-06-02T15:13:27Z" } ``` Retrieve a Transaction {#ppro-status-intro-x} ============================================= This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Konbini Required Fields {#ppro-status-req-fields-konbini} ========================================================= These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-konbini_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-konbini_d49e24} Example: Requesting an Konbini Retrieve a Transaction Using the REST API {#ppro-status-ex-konbini-rest} ======================================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "JPY", "taxAmount": "900" }, "billTo":{ "country":"JP", "firstName":"John", "lastName":"Doe", "email":"hishriva@visa.com", "phoneNumber":"1234567890" }, "lineItems":[ { "productName":"laptop" }, { "productName":"mobile" }] }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "konbini" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1165857820", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr2%2Epaygate%2Ede%2Fecontext%2FS1124%2FI%3Ftx%3D1165857820%26rs%3DRxJvDBtl4wQISKXcJliBJgZlWMAbFT15%26cs%3Df32d07e6bc266f83d5b920ab0a8d56a74214bafd5cf0dd6e7bdfedf649945277" }, "paymentInformation": { "paymentType": { "method": { "name": "Convenience+Store+via+Lawson", "type": "654321" } } }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032916", "submitTimeUtc": "2022-06-02T15:13:27Z" } ``` Latvia Banks {#ppro-latvia-intro} ================================= This section describes how to integrate APIs that perform these functions: * [Retrieve Bank Options](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-option-intro.md "") * [Latvia Banks Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-latvia-intro/ppro-sale-intro-latvia.md "") * [Latvia Banks Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-latvia-intro/ppro-refund-intro-latvia.md "") Retrieve Bank Options {#ppro-option-latvia-intro} ================================================= This section describes how to send an options request in order to retrieve a list of participating banks for the day. Perform the options request to receive the latest updates for participating banks' redirect URLs, IDs, and any additional data. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments-options`{#ppro-option-latvia-intro_d10e140} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments-options`{#ppro-option-latvia-intro_d10e150} Required Fields for Options Using the REST API {#ppro-option-latvia-req-fields} =============================================================================== These fields are required for setting options. [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.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 "") : [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 "") : paymentInformation.paymentType.method.type : Example: Retrieving Bank Options {#ppro-options-latvia-ex-rest} =============================================================== Request ``` { "clientReferenceInformation" : { "code" : "123456" }, "paymentInformation" : { "paymentType" : { "method" : { "name" : "latviabanks" }, "name" : "bankTransfer" } } } ``` Response to a Successful Request ``` { "submitTimeUtc": "Wed Nov 13 21:26:33 UTC 2024", "paymentOptions": { "resources": [ { "name": "BLIK - PSP", "id": "154" }, { "id": "94", "name": "Euro Bank" }, { "id": "25", "name": "mBank - mTransfer" }, { "id": "135", "name": "Płac ̨e z IKO" }, { "name": "Płac ̨e z Orange", "id": "146" }, { "name": "Przekaz tradycyjny", "id": "178" }, { "id": "102", "name": "Raiffeisen Bank PBL" }, { "id": "177", "name": "U ̇zyj przedpłaty" }, { "id": "1000", "name": "Przekaz/Przelew tradycyjny" } ], "type": "p24methods" }, "paymentInformation": { "paymentType": { "method": { "name": "p24" }, "name": "bankTransfer" } }, "id": "7315331927636272003955", "message": "Successful", "status": "SUCCEEDED" } ``` Latvia Banks Sales {#ppro-sale-intro-latvia} ============================================ This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-latvia_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-latvia_d10e355} Latvia Banks Required Fields {#ppro-sale-req-fields-latvia} =========================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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 "") : Latvia Banks Optional Field {#ppro-sale-req-fields-latvia-opt} ============================================================== paymentOptions.resources\[\].id : Example: Requesting an Latvia Banks Sale Using the REST API {#ppro-sale-ex-latvia-rest} ======================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"LV", "firstName":"John", "lastName":"Doe", "email":"hishriva@visa.com" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "latvianbanks" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1171091725", "rawStatus": "PENDING", "paymentUrl": "https://r3.paygate.de/ti/simlatvianbanks?tx=1171091725&rs=Fni7aQNdjESNFExW5o2KYd4LDrDvb62I&cs=26551daa033efee844ddee1fa6d0dc8eaccab89984d124608ff461064cb8caed" }, "paymentInformation": { "binCountry": "LV" }, "message": "Successful", "status": "PENDING", "id": "652332901912674360406", "submitTimeUtc": "2022-06-08T03:42:28Z" } ``` Retrieve a Transaction {#ppro-status-intro-x} ============================================= This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Latvia Banks Required Fields {#ppro-status-req-fields-latvia} ============================================================= These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-latvia_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-latvia_d49e24} Example: Requesting an Latvia Banks Retrieve a Transaction Using the REST API {#ppro-status-ex-latvia-rest} =========================================================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1171091725" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "latvianbanks" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144133396" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031954", "submitTimeUtc": "2022-06-08T03:48:01Z" } ``` Latvia Banks Refunds {#ppro-refund-intro-latvia} ================================================ This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-latvia_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-latvia_d10e385} The *{id}* is the request ID contained in the original transaction request. Latvia Banks Required Fields {#ppro-refund-req-fields-latvia} ============================================================= [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 "") : {#ppro-refund-req-fields-latvia_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-latvia_d7e27} [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 "") : {#ppro-refund-req-fields-latvia_d7e39} [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 "") : {#ppro-refund-req-fields-latvia_d7e47} [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 "") : {#ppro-refund-req-fields-latvia_d7e55} [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 "") : {#ppro-refund-req-fields-latvia_d7e69} Example: Requesting an Latvia Banks Refund Using the REST API {#ppro-refund-ex-latvia-rest} =========================================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1171091725" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "latvianbanks" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144133396" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031954", "submitTimeUtc": "2022-06-08T03:48:01Z" } ``` LinkAja {#ppro-linkaja-intro} ============================= This section describes how to integrate APIs that perform these functions: * [LinkAja Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-linkaja-intro/ppro-sale-intro-linkaja.md "") * [LinkAja Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-linkaja-intro/ppro-refund-intro-linkaja.md "") LinkAja Sales {#ppro-sale-intro-linkaja} ======================================== `Cybersource` enables customers to make general purchases and purchases using Kredivo. For all general purchases, use the required fields and any optional field you may want. If you are making a purchase using Kredivo, you must use the required fields and the additional relevant fields. Airline Sales ------------- For all airline related purchases, set the industry type to airline: processingInformation.industryDataType : Set to `airline`. If the purchase is airline related but not for a flight ticket, set the field value to `No`. If the purchase is for a flight ticket, set the field value to `Yes`, and include the additional airline fields. Kredivo Sales ------------- For all purchases using Kredivo, set the payment type to `kredivo`: paymentInformation.paymentType.method.type : You will also need to include the address and locality fields when using Kredivo as the payment type. [See Kredivo Fields](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-linkaja-intro/ppro-sale-intro-linkaja/ppro-sale-req-fields-linkaja.md#ppro-sale-req-fields-linkaja_section_bzk_z5y_wtb "") Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-linkaja_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-linkaja_d10e355} LinkAja Fields {#ppro-sale-req-fields-linkaja} ============================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Airline Fields {#ppro-sale-req-fields-linkaja_section_nbz_v5y_wtb} ------------------------------------------------------------------ This field is required for all airline transactions. [processingInformation.industryDataType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-industry-data-type.md "") : Set to `airline`. These fields are required if **processingInformation.industryDataType=airline** is set to `Yes`. travelInformation.transit.airline.flightType : travelInformation.transit.airline.reservationSystemCode : [travelInformation.transit.airline.legs\[\].originatingAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-orig-airport-code.md "") : [travelInformation.transit.airline.legs\[\].destinationAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-dest-airport-code.md "") : [travelInformation.transit.airline.legs\[\].departureDate](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-departure-date.md "") : [travelInformation.transit.airline.legs\[\].departureTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-depart-time.md "") : [travelInformation.transit.airline.legs\[\].flightNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-flight-number.md "") : [travelInformation.transit.airline.passengerName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-pass-name.md "") : travelInformation.transit.airline.passengerType : travelInformation.transit.airline.legs\[\].departTaxAmount : travelInformation.transit.airline.totalInsuranceAmount : [orderInformation.amountDetails.surcharge.amount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-surcharge-amount.md "") : travelInformation.transit.airline.ticketIssuer.code : travelInformation.transit.airline.frequentFlyerNumber : Set to `AG`. Kredivo Fields {#ppro-sale-req-fields-linkaja_section_bzk_z5y_wtb} ------------------------------------------------------------------ These fields are required if **paymentInformation.paymentType.method.type** is set to `kredivo`. [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.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.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.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.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 "") : LinkAja Optional Field {#ppro-sale-req-fields-linkaja-opt} ========================================================== paymentInformation.paymentType.method.type : Example: Requesting a LinkAja Sale Using the REST API {#ppro-sale-ex-linkaja-rest} ================================================================================== Request ``` { "clientReferenceInformation": { "reconciliationId": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "888888888800", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "12000" } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "linkAja", "type":"linkAjaWallet" } }, "customer": { "customerid": "abcd" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "JohnDoe" } ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169297041", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1169297041&rs=11eWulFck8iFKfESciVBg45avTZvxSw7&cs=a9b6b62cf675771adafb20b8d63f4b35acc22e2be0073edbf30d7d2216511545" }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032973", "submitTimeUtc": "2022-06-06T09:33:02Z" } ``` Example: Requesting an LinkAja Airline Sale Using the REST API {#ppro-sale-ex-linkaja-airline-rest} =================================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1000000", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "1200" } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "linkAja", "type":"linkAjaWallet" } }, "customer": { "customerid": "abcd" } }, "processingInformation": { "industryDataType": "airline" }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } ] } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169297041", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1169297041&rs=11eWulFck8iFKfESciVBg45avTZvxSw7&cs=a9b6b62cf675771adafb20b8d63f4b35acc22e2be0073edbf30d7d2216511545" }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032973", "submitTimeUtc": "2022-06-06T09:33:02Z" } ``` Example: Requesting an LinkAja Kredivo Sale Using the REST API {#ppro-sale-ex-linkaja-kredivo-rest} =================================================================================================== Request ``` { "clientReferenceInformation": { "reconciliationId": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "888888888800", "currency": "IDR", "taxAmount": "5", "surcharge": { "amount": "12000" } }, "billTo": { "firstName": "John", "lastName": "abc", "country": "ID", "address1": "xyz street 13 14", "phoneNumber": "12628123456", "email": "abc@email.com" }, "shipTo": { "country": "ID", "address1": "Sudirman", "address2" :"test", "locality": "Jakarta", "postalCode": "12190" }, "lineItems": [ { "productName": "mobile", "quantity": "9", "unitPrice": "32.4", "totalAmount": "70000" }, { "productName": "table", "quantity": "9", "unitPrice": "32.4", "totalAmount": "30000" } ] }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "linkAja", "type":"linkAjaWallet" } }, "customer": { "customerid": "abcd" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "merchantCustomerId": "143456789700" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } ] } } } } Sample code still being tested as of 06/14/22 per teamResponse { "processorInformation": { "transactionId": "1177494712", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1177494712&rs=LNWNzQnylSg25Pd4RdEftLK5ilXDOeWg&cs=5430e64522b04fa7d8b27c2125a977efdc56f67a00ca9cdd3e5ab1e0ce5167ac" }, "reconciliationId": "sale1077", ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169297041", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/doku/S1150/I?tx=1169297041&rs=11eWulFck8iFKfESciVBg45avTZvxSw7&cs=a9b6b62cf675771adafb20b8d63f4b35acc22e2be0073edbf30d7d2216511545" }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032973", "submitTimeUtc": "2022-06-06T09:33:02Z" } ``` Retrieve a Transaction {#ppro-linkaja-status-intro} =================================================== This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. LinkAja Fields {#ppro-status-req-fields-linkaja} ================================================ These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-linkaja_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-linkaja_d49e24} Example: Requesting an LinkAja Kredivo Retrieve a Transaction Using the REST API {#ppro-status-ex-linkaja-kredivo-rest} ======================================================================================================================= Request ``` ``` Response to a Successful Request ``` ``` Example: Requesting an LinkAja Retrieve a Transaction Using the REST API {#ppro-status-ex-linkaja-rest} ======================================================================================================= Request ``` ``` Response to a Successful Request ``` ``` LinkAja Refunds {#ppro-refund-intro-linkaja} ============================================ This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-linkaja_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-linkaja_d10e385} The *{id}* is the request ID contained in the original transaction request. LinkAja Fields {#ppro-refund-req-fields-linkaja} ================================================ [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 "") : {#ppro-refund-req-fields-linkaja_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-linkaja_d7e27} [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 "") : {#ppro-refund-req-fields-linkaja_d7e39} [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 "") : {#ppro-refund-req-fields-linkaja_d7e47} [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 "") : {#ppro-refund-req-fields-linkaja_d7e55} [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 "") : {#ppro-refund-req-fields-linkaja_d7e69} Example: Requesting a LinkAja Refund Using the REST API {#ppro-refund-ex-linkaja-rest} ====================================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "IDR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169297041" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "linkAja" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144040825" }, "message": "Successful", "status": "REFUNDED", "id": "65233290191267436031894", "submitTimeUtc": "2022-06-06T09:43:20Z" } ``` Lithuania Banks {#ppro-lithuania-intro} ======================================= This section describes how to integrate APIs that perform these functions: * [Retrieve Bank Options](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-option-intro.md "") * [Lithuania Banks Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-lithuania-intro/ppro-sale-intro-lithuania.md "") * [Lithuania Banks Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-lithuania-intro/ppro-refund-intro-lithuania.md "") Retrieve Bank Options {#ppro-option-lithuanian-intro} ===================================================== This section describes how to send an options request in order to retrieve a list of participating banks for the day. Perform the options request to receive the latest updates for participating banks' redirect URLs, IDs, and any additional data. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments-options`{#ppro-option-lithuanian-intro_d10e140} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments-options`{#ppro-option-lithuanian-intro_d10e150} Required Fields for Options Using the REST API {#ppro-option-lithuanian-req-fields} =================================================================================== These fields are required for setting options. [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.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 "") : [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 "") : paymentInformation.paymentType.method.type : Example: Retrieving Bank Options {#ppro-options-lithuanian-ex-rest} =================================================================== Request ``` { "clientReferenceInformation" : { "code" : "123456" }, "paymentInformation" : { "paymentType" : { "method" : { "name" : "lithuanianbanks" }, "name" : "bankTransfer" } } } ``` Response to a Successful Request ``` { "submitTimeUtc": "Wed Nov 13 21:26:33 UTC 2024", "paymentOptions": { "resources": [ { "name": "BLIK - PSP", "id": "154" }, { "id": "94", "name": "Euro Bank" }, { "id": "25", "name": "mBank - mTransfer" }, { "id": "135", "name": "Płac ̨e z IKO" }, { "name": "Płac ̨e z Orange", "id": "146" }, { "name": "Przekaz tradycyjny", "id": "178" }, { "id": "102", "name": "Raiffeisen Bank PBL" }, { "id": "177", "name": "U ̇zyj przedpłaty" }, { "id": "1000", "name": "Przekaz/Przelew tradycyjny" } ], "type": "p24methods" }, "paymentInformation": { "paymentType": { "method": { "name": "p24" }, "name": "bankTransfer" } }, "id": "7315331927636272003955", "message": "Successful", "status": "SUCCEEDED" } ``` Lithuania Banks Sales {#ppro-sale-intro-lithuania} ================================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-lithuania_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-lithuania_d10e355} Lithuania Banks Required Fields {#ppro-sale-req-fields-lithuania} ================================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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 "") : Lithuania Banks Optional Field {#ppro-sale-req-fields-lithuania-opt} ==================================================================== paymentOptions.resources\[\].id : Example: Retrieving Bank Options {#ppro-sale-ex-lithuania-rest} =============================================================== Request ``` { "clientReferenceInformation" : { "code" : "123456" }, "paymentInformation" : { "paymentType" : { "method" : { "name" : "lithuanianbanks" }, "name" : "bankTransfer" } } } ``` Response to a Successful Request ``` { "submitTimeUtc": "Wed Nov 13 21:26:33 UTC 2024", "paymentOptions": { "resources": [ { "name": "BLIK - PSP", "id": "154" }, { "id": "94", "name": "Euro Bank" }, { "id": "25", "name": "mBank - mTransfer" }, { "id": "135", "name": "Płac ̨e z IKO" }, { "name": "Płac ̨e z Orange", "id": "146" }, { "name": "Przekaz tradycyjny", "id": "178" }, { "id": "102", "name": "Raiffeisen Bank PBL" }, { "id": "177", "name": "U ̇zyj przedpłaty" }, { "id": "1000", "name": "Przekaz/Przelew tradycyjny" } ], "type": "p24methods" }, "paymentInformation": { "paymentType": { "method": { "name": "p24" }, "name": "bankTransfer" } }, "id": "7315331927636272003955", "message": "Successful", "status": "SUCCEEDED" } ``` Retrieve a Transaction {#ppro-lithuania-status-intro} ===================================================== This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Lithuania Banks Required Fields {#ppro-status-req-fields-lithuania} =================================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-lithuania_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-lithuania_d49e24} Example: Requesting an Lithuania Banks Retrieve a Transaction Using the REST API {#ppro-status-ex-lithuania-rest} ================================================================================================================= Request ``` { ""processingInformation"": { ""reconciliationId"": ""sale1077"" }, ""clientReferenceInformation"": { ""transactionId"": ""833388407"" }, ""paymentInformation"": { ""paymentType"": { ""name"": ""bankTransfer"", ""method"": { ""name"": ""lithuanianbanks"" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "833388407" }, "id": "64550699923879152", "message": "Successful", "status": "COMPLETED", "submitTimeUtc": "2022-04-07T07:03:39Z" } ``` Lithuania Banks Refunds {#ppro-refund-intro-lithuania} ====================================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-lithuania_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-lithuania_d10e385} The *{id}* is the request ID contained in the original transaction request. Lithuania Banks Required Fields {#ppro-refund-req-fields-lithuania} =================================================================== [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 "") : {#ppro-refund-req-fields-lithuania_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-lithuania_d7e27} [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 "") : {#ppro-refund-req-fields-lithuania_d7e39} [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 "") : {#ppro-refund-req-fields-lithuania_d7e47} [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 "") : {#ppro-refund-req-fields-lithuania_d7e55} [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 "") : {#ppro-refund-req-fields-lithuania_d7e69} Example: Requesting an Lithuania Banks Refund Using the REST API {#ppro-refund-ex-lithuania-rest} ================================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "reconciliationId": "sale1077", "originalTransactionId": "1172295556" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "lithuanianbanks" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "144202318" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031956", "submitTimeUtc": "2022-06-09T09:49:25Z" } ``` Multibanco {#ppro-multibanco-intro} =================================== This section describes how to integrate APIs that perform these functions: * [Multibanco Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-multibanco-intro/ppro-sale-intro-multibanco-rest.md "") * [Multibanco Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-multibanco-intro/ppro-refund-intro-multibanco.md "") Multibanco Sales {#ppro-sale-intro-multibanco-rest} =================================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-multibanco-rest_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-multibanco-rest_d10e355} Multibanco Required Fields {#ppro-sale-req-fields-multibanco} ============================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-multibanco_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-multibanco_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-multibanco_d23e41} [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 "") : {#ppro-sale-req-fields-multibanco_d23e54} [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 "") : {#ppro-sale-req-fields-multibanco_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-multibanco_d23e81} [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 "") : {#ppro-sale-req-fields-multibanco_d23e94} [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 "") : {#ppro-sale-req-fields-multibanco_d23e107} Example: Requesting an Multibanco Sale Using the REST API {#ppro-sale-ex-multibanco-rest} ========================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"PT", "firstName":"John", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "multibanco" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` ``` Multibanco Refunds {#ppro-refund-intro-multibanco} ================================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-multibanco_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-multibanco_d10e385} The *{id}* is the request ID contained in the original transaction request. Multibanco Required Fields {#ppro-refund-req-fields-multibanco} =============================================================== [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 "") : {#ppro-refund-req-fields-multibanco_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-multibanco_d7e27} [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 "") : {#ppro-refund-req-fields-multibanco_d7e39} [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 "") : {#ppro-refund-req-fields-multibanco_d7e47} [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 "") : {#ppro-refund-req-fields-multibanco_d7e55} [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 "") : {#ppro-refund-req-fields-multibanco_d7e69} Example: Requesting an Multibanco Refund Using the REST API {#ppro-refund-ex-multibanco-rest} ============================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"PT", "firstName":"John", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "multibanco" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1166518486", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr3%2Epaygate%2Ede%2Fti%2Fsimmultibanco%3Ftx%3D1166518486%26rs%3D4HNKar16wqSfYwhurWVN75CmPilk3Fsq%26cs%3De0bba833440757be432205062a29fb663cd70b485c7fa5a65f49cd87fc846359" }, "reconciliationId": "sale1077", "paymentInformation": { "binCountry": "PT" }, "message": "Successful", "status": "PENDING", "id": "65233290191267436032932", "submitTimeUtc": "2022-06-03T09:16:09Z" } ``` MyBank {#ppro-mybank-intro} =========================== This section describes how to integrate APIs that perform these functions: * [MyBank Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-mybank-intro/ppro-sale-intro-mybank.md "") * [MyBank Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-mybank-intro/ppro-refund-intro-mybank.md "") MyBank Sales {#ppro-sale-intro-mybank} ====================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-mybank_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-mybank_d10e355} MyBank Required Fields {#ppro-sale-req-fields-mybank} ===================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-mybank_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-mybank_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-mybank_d23e41} [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 "") : {#ppro-sale-req-fields-mybank_d23e54} [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 "") : {#ppro-sale-req-fields-mybank_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-mybank_d23e81} [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 "") : {#ppro-sale-req-fields-mybank_d23e94} [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 "") : {#ppro-sale-req-fields-mybank_d23e107} MyBank Optional Fields ---------------------- processingInformation.transactionTimeout : Example: Requesting an MyBank Sale Using the REST API {#ppro-sale-ex-mybank-rest} ================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"IT", "firstName":"John", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "mybank" } } }, "processingInformation":{ "transactionTimeout" :"6" }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169468614", "rawStatus": "PENDING", "paymentUrl": "https://r3.paygate.de/ti/simmybank?tx=1169468614&rs=qPoVWoAobZDyD94gDpxAi0HoXvn2sgjl&cs=892d439ffd5e7ab6a916127339c3fbb333a53cfb0152d73c6270d9dc3cf3f92e" }, "paymentInformation": { "binCountry": "IT" }, "message": "Successful", "status": "PENDING", "id": "6523329019126743603301", "submitTimeUtc": "2022-06-06T12:23:01Z" } ``` Retrieve a Transaction {#ppro-mybank-status-intro} ================================================== This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. MyBank Retrieve a Transaction {#ppro-status-req-fields-mybank} ============================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-mybank_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-mybank_d49e24} Example: Requesting an MyBank Retrieve a Transaction Using the REST API {#ppro-status-ex-mybank-rest} ===================================================================================================== Request ``` { "processingInformation": { "reconciliationId": "sale1077" }, "clientReferenceInformation": { "transactionId": "1169468614" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "mybank" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1169468614" }, "id": "64550699923879139", "message": "Successful", "status": "COMPLETED", "submitTimeUtc": "2022-04-07T07:03:39Z" } ``` MyBank Refunds {#ppro-refund-intro-mybank} ========================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-mybank_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-mybank_d10e385} The *{id}* is the request ID contained in the original transaction request. MyBank Required Fields {#ppro-refund-req-fields-mybank} ======================================================= [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 "") : {#ppro-refund-req-fields-mybank_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-mybank_d7e27} [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 "") : {#ppro-refund-req-fields-mybank_d7e39} [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 "") : {#ppro-refund-req-fields-mybank_d7e47} [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 "") : {#ppro-refund-req-fields-mybank_d7e55} [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 "") : {#ppro-refund-req-fields-mybank_d7e69} Example: Requesting an MyBank Refund Using the REST API {#ppro-refund-ex-mybank-rest} ===================================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169468614" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "mybank" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144047341" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031899", "submitTimeUtc": "2022-06-06T12:32:41Z" } ``` OVO {#ppro-ovo-intro} ===================== This section describes how to integrate APIs that perform this function: * [OVO Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-ovo-intro/ppro-sale-intro-ovo.md "") OVO Sales {#ppro-sale-intro-ovo} ================================ `Cybersource` enables customers to make general purchases and purchases using Kredivo. For all general purchases, use the required fields and any optional field you may want. If you are making a purchase using Kredivo, you must use the required fields and the additional relevant fields. Airline Sales ------------- For all airline related purchases, set the industry type to airline: processingInformation.industryDataType : Set to `airline`. If the purchase is airline related but not for a flight ticket, set the field value to `No`. If the purchase is for a flight ticket, set the field value to `Yes`, and include the additional airline fields. Kredivo Sales ------------- For all purchases using Kredivo, set the payment type to `kredivo`: paymentInformation.paymentType.method.type : You will also need to include the address and locality fields when using Kredivo as the payment type. [See Kredivo Fields](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-linkaja-intro/ppro-sale-intro-linkaja/ppro-sale-req-fields-linkaja.md#ppro-sale-req-fields-linkaja_section_bzk_z5y_wtb "") Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-ovo_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-ovo_d10e355} OVO Fields {#ppro-sale-req-fields-ovo} ====================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Airline Fields {#ppro-sale-req-fields-ovo_section_nbz_v5y_wtb} -------------------------------------------------------------- This field is required for all airline transactions. [processingInformation.industryDataType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-industry-data-type.md "") : Set to `airline`. These fields are required if **processingInformation.industryDataType=airline** is set to `Yes`. travelInformation.transit.airline.flightType : travelInformation.transit.airline.reservationSystemCode : [travelInformation.transit.airline.legs\[\].originatingAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-orig-airport-code.md "") : [travelInformation.transit.airline.legs\[\].destinationAirportCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-dest-airport-code.md "") : [travelInformation.transit.airline.legs\[\].departureDate](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-departure-date.md "") : [travelInformation.transit.airline.legs\[\].departureTime](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-depart-time.md "") : [travelInformation.transit.airline.legs\[\].flightNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-legs-flight-number.md "") : [travelInformation.transit.airline.passengerName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/travel-info-aa/travel-info-transit-airline-pass-name.md "") : travelInformation.transit.airline.passengerType : travelInformation.transit.airline.legs\[\].departTaxAmount : travelInformation.transit.airline.totalInsuranceAmount : [orderInformation.amountDetails.surcharge.amount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-surcharge-amount.md "") : travelInformation.transit.airline.ticketIssuer.code : travelInformation.transit.airline.frequentFlyerNumber : Set to `AG`. Kredivo Fields {#ppro-sale-req-fields-ovo_section_bzk_z5y_wtb} -------------------------------------------------------------- These fields are required if **paymentInformation.paymentType.method.type** is set to `kredivo`. [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.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.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.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.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 "") : OVO Optional Field {#ppro-sale-req-fields-ovo-opt} ================================================== paymentInformation.paymentType.method.type : Example: Requesting an OVO Sale Using the REST API {#ppro-sale-ex-ovo-rest} =========================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"BE", "firstName":"Jane", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "payconiq" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "appUrl": "HTTPS://PAYCONIQ.COM/PAY/2/E072C100432F7985B1U39D39", "transactionId": "1169164990", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/payconiq/S1147/I?tx=1169164990&rs=aFT6rrxK2NtgRR0IPSusq538I7Mn60v0&cs=a2347e6802ac046a256305544ac97dff3295e399b933fe084090c0530cf60ade" }, "paymentInformation": { "bank": { "iban": "LU9999999999" } }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032965", "submitTimeUtc": "2022-06-06T06:55:11Z" } ``` Retrieve a Transaction {#ppro-ovo-status-intro} =============================================== This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. OVO Retrieve a Transaction {#ppro-status-req-fields-ovo} ======================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-ovo_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-ovo_d49e24} Example: Requesting an OVO Retrieve Transaction Using the REST API {#ppro-status-ex-ovo-rest} ============================================================================================= Request ``` { "processingInformation": { "reconciliationId": "sale1077" }, "clientReferenceInformation": { "transactionId": "832491410" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "ovo", "type":"ovoWallet" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "832491410" }, "id": "64550699923879124", "message": "Successful", "status": "COMPLETED", "submitTimeUtc": "2022-04-07T07:03:39Z" } ``` Payconiq {#ppro-payconiq-intro} =============================== This section describes how to integrate APIs that perform these functions: * [Payconiq Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payconiq-intro/ppro-sale-intro-payconiq-rest.md "") * [Payconiq Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payconiq-intro/ppro-refund-intro-payconiq.md "") Payconiq Sales {#ppro-sale-intro-payconiq-rest} =============================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-payconiq-rest_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-payconiq-rest_d10e355} Payconiq Required Fields {#ppro-sale-req-fields-payconiq} ========================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-payconiq_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-payconiq_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-payconiq_d23e41} [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 "") : {#ppro-sale-req-fields-payconiq_d23e54} [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 "") : {#ppro-sale-req-fields-payconiq_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-payconiq_d23e81} [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 "") : {#ppro-sale-req-fields-payconiq_d23e94} [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 "") : {#ppro-sale-req-fields-payconiq_d23e107} Example: Requesting an Payconiq Sale Using the REST API {#ppro-sale-ex-payconiq-rest} ===================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"BE", "firstName":"Jane", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "payconiq" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "appUrl": "HTTPS://PAYCONIQ.COM/PAY/2/E072C100432F7985B1U39D39", "transactionId": "1169164990", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/payconiq/S1147/I?tx=1169164990&rs=aFT6rrxK2NtgRR0IPSusq538I7Mn60v0&cs=a2347e6802ac046a256305544ac97dff3295e399b933fe084090c0530cf60ade" }, "paymentInformation": { "bank": { "iban": "LU9999999999" } }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032965", "submitTimeUtc": "2022-06-06T06:55:11Z" } ``` Payconiq Refunds {#ppro-refund-intro-payconiq} ============================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-payconiq_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-payconiq_d10e385} The *{id}* is the request ID contained in the original transaction request. Payconiq Required Fields {#ppro-refund-req-fields-payconiq} =========================================================== [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 "") : {#ppro-refund-req-fields-payconiq_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-payconiq_d7e27} [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 "") : {#ppro-refund-req-fields-payconiq_d7e39} [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 "") : {#ppro-refund-req-fields-payconiq_d7e47} [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 "") : {#ppro-refund-req-fields-payconiq_d7e55} [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 "") : {#ppro-refund-req-fields-payconiq_d7e69} Example: Requesting an Payconiq Refund Using the REST API {#ppro-refund-ex-payconiq-rest} ========================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "1169226568" }, "paymentInformation": { "paymentType": { "name": "eWallet", "method": { "name": "payconiq" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "144037945" }, "message": "Successful", "status": "REFUNDED", "id": "65233290191267436031879", "submitTimeUtc": "2022-06-06T08:24:14Z" } ``` Pay-easy {#ppro-payeasy-intro} ============================== This section describes how to integrate an API that performs this function: * [Pay-easy Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payeasy-intro/ppro-sale-intro-payeasy.md "") Pay-easy Sales {#ppro-sale-intro-payeasy} ========================================= This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-payeasy_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-payeasy_d10e355} Pay-easy Required Fields {#ppro-sale-req-fields-payeasy} ======================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.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\[\].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.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 "") : Example: Requesting an Pay-easy Sale Using the REST API {#ppro-sale-ex-payeasy-rest} ==================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077", "reconciliationId":"payeasy123" }, "orderInformation": { "amountDetails": { "totalAmount": "600", "currency": "JPY", "taxAmount": "5" }, "billTo": { "firstName": "Tester", "lastName": "Doe", "country": "JP", "email": "hishriva12345@visa.com", "phoneNumber": "1234567891" }, "lineItems":[ { "productName" :"sega" }, { "productName" :"saturn" }, { "productName":"Console" } ] }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "payeasy" } } }, "merchantInformation": { "returnUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "testdescription" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "mobilePhone": "8095803465", "language":"en" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "840012782", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/econtext/S1125/I?tx=840012782&rs=YkcK0f8OKd836atFSL88KEuTCMMXtvjl&cs=3d244f6306310786500c1fa5257e4bfdf2a2b93bcd49614ebc6e10c1f4ac2e81" }, "reconciliationId": "payeasy123", "message": "Successful", "status": "PENDING", "id": "6523329019126743604730", "submitTimeUtc": "2022-06-14T08:54:17Z" } ``` Pay-easy Retrieve a Transaction {#ppro-status-req-fields-payeasy} ================================================================= These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-payeasy_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-payeasy_d49e24} Example: Requesting an Pay-easy Retrieve a Transaction Using the REST API {#ppro-status-ex-payeasy-rest} ======================================================================================================== Request ``` { "processingInformation": { "reconciliationId": "sale1077" }, "clientReferenceInformation": { "transactionId": "1170808336" }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "payeasy" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1170808336" }, "id": "645506999238791558", "message": "Successful", "status": "COMPLETED", "submitTimeUtc": "2022-04-07T07:03:39Z" } ``` PayU {#ppro-payu-intro} ======================= This section describes how to integrate APIs that perform these functions: * [PayU Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payu-intro/ppro-sale-intro-payu.md "") * [PayU Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-payu-intro/ppro-refund-intro-payu.md "") PayU Sales {#ppro-sale-intro-payu} ================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-payu_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-payu_d10e355} PayU Required Fields {#ppro-sale-req-fields-payu} ================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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 "") : Example: Requesting an PayU Sale Using the REST API {#ppro-sale-ex-payu-rest} ============================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "PLN", "taxAmount": "900" }, "billTo":{ "country":"PL", "firstName":"Jane", "lastName":"Doe", "email":"abc@email.com" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "payu" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "832762292", "rawStatus": "PENDING", "paymentUrl": "https://r3.paygate.de/ti/simpayu?tx=832762292&rs=Yw1Ar6yi7G4HE57Gi1aT8npSHFdFPiHm&cs=7f08fe44c9344cf45e7fd9e6a18541181c3f4a8748c50e6f2cd9873c670d7b24" }, "paymentInformation": { "binCountry": "PL" }, "message": "Successful", "status": "PENDING", "id": "6523329019126743603307", "submitTimeUtc": "2022-06-06T13:02:42Z" } ``` Retrieve a Transaction {#ppro-status-payu-intro} ================================================ This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. PayU Retrieve a Transaction {#ppro-status-req-fields-payu} ========================================================== These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-payu_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-payu_d49e24} Example: Requesting an PayU Retrieve a Transaction Using the REST API {#ppro-status-ex-payu-rest} ================================================================================================= Request ``` { "processingInformation": { "reconciliationId": "sale1077" }, "clientReferenceInformation": { "transactionId": "832762292" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "payu" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "832762292" }, "id": "64550699923879143", "message": "Successful", "status": "COMPLETED", "submitTimeUtc": "2022-04-07T07:03:39Z" } ``` PayU Refunds {#ppro-refund-intro-payu} ====================================== This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-payu_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-payu_d10e385} The *{id}* is the request ID contained in the original transaction request. PayU Required Fields {#ppro-refund-req-fields-payu} =================================================== [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 "") : {#ppro-refund-req-fields-payu_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-payu_d7e27} [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 "") : {#ppro-refund-req-fields-payu_d7e39} [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 "") : {#ppro-refund-req-fields-payu_d7e47} [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 "") : {#ppro-refund-req-fields-payu_d7e55} [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 "") : {#ppro-refund-req-fields-payu_d7e69} Example: Requesting an PayU Refund Using the REST API {#ppro-refund-ex-payu-rest} ================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "PLN" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "832762292" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "payu" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "128017136" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031900", "submitTimeUtc": "2022-06-06T13:03:57Z" } ``` Przelewy24 {#ppro-przelewy-intro} ================================= This section describes how to integrate APIs that perform these functions: * [Retrieve Bank Options](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-option-intro.md "") * [Przelewy24 Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-przelewy-intro/ppro-sale-intro-przelewy.md "") * [Przelewy24 Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-przelewy-intro/ppro-refund-intro-przelewy.md "") Retrieve Bank Options {#ppro-option-p24-intro} ============================================== This section describes how to send an options request in order to retrieve a list of participating banks for the day. Perform the options request to receive the latest updates for participating banks' redirect URLs, IDs, and any additional data. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments-options`{#ppro-option-p24-intro_d10e140} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments-options`{#ppro-option-p24-intro_d10e150} Required Fields for Options Using the REST API {#ppro-option-p24-req-fields} ============================================================================ These fields are required for setting options. [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.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 "") : [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 "") : paymentInformation.paymentType.method.type : Example: Retrieving Bank Options {#ppro-options-p24-ex-rest} ============================================================ Request ``` { "clientReferenceInformation" : { "code" : "123456" }, "paymentInformation" : { "paymentType" : { "method" : { "name" : "estoniabanks" }, "name" : "bankTransfer" } } } ``` Response to a Successful Request ``` { "submitTimeUtc": "Wed Nov 13 21:26:33 UTC 2024", "paymentOptions": { "resources": [ { "name": "BLIK - PSP", "id": "154" }, { "id": "94", "name": "Euro Bank" }, { "id": "25", "name": "mBank - mTransfer" }, { "id": "135", "name": "Płac ̨e z IKO" }, { "name": "Płac ̨e z Orange", "id": "146" }, { "name": "Przekaz tradycyjny", "id": "178" }, { "id": "102", "name": "Raiffeisen Bank PBL" }, { "id": "177", "name": "U ̇zyj przedpłaty" }, { "id": "1000", "name": "Przekaz/Przelew tradycyjny" } ], "type": "p24methods" }, "paymentInformation": { "paymentType": { "method": { "name": "p24" }, "name": "bankTransfer" } }, "id": "7315331927636272003955", "message": "Successful", "status": "SUCCEEDED" } ``` Przelewy24 Sales {#ppro-sale-intro-przelewy} ============================================ This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-przelewy_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-przelewy_d10e355} Przelewy24 Required Fields {#ppro-sale-req-fields-przelewy} =========================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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 "") : Przelewy24 Optional Fields {#ppro-sale-req-fields-prezelewy-opt} ================================================================ paymentInformation.options.optionDetails\[\].name : Example: Requesting an Przelewy24 Sale Using the REST API {#ppro-sale-ex-przelewy-rest} ======================================================================================= Request ``` { "clientReferenceInformation": { "reconciliationId": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1400", "currency": "EUR", "taxAmount": "5" }, "billTo": { "firstName": "Jane", "lastName": "Doe", "country": "PL", "address1": "xyz street 13 14", "email": "abc@email.com" }, "shipTo": { "country": "DE" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "p24" } }, "customer": { "customerid": "abcd" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "Vamseekrishna Puchakayala" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "mobilePhone": "8095803465" }, "consumerAuthenticationInformation": { "customerCardAlias": "SonaliShetty" } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "839959787", "rawStatus": "PENDING", "paymentUrl": "https://r3.paygate.de/ti/simp24?tx=839959787&rs=aZV0Fxr00Jq8cymqHqAZADf3gc6NzZtu&cs=5c7489ff097b879ac3004eefbc9c09fad766f9a8e195505d8146d0014f2ce35f" }, "reconciliationId": "sale1077", "paymentInformation": { "binCountry": "PL" }, "message": "Successful", "status": "PENDING", "id": "6523329019126743604721", "submitTimeUtc": "2022-06-14T07:46:31Z" } ``` Przelewy24 Refunds {#ppro-refund-intro-przelewy} ================================================ This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-przelewy_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-przelewy_d10e385} The *{id}* is the request ID contained in the original transaction request. Przelewy24 Required Fields {#ppro-refund-req-fields-przelewy} ============================================================= [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 "") : {#ppro-refund-req-fields-przelewy_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-przelewy_d7e27} [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 "") : {#ppro-refund-req-fields-przelewy_d7e39} [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 "") : {#ppro-refund-req-fields-przelewy_d7e47} [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 "") : {#ppro-refund-req-fields-przelewy_d7e55} [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 "") : {#ppro-refund-req-fields-przelewy_d7e69} Example: Requesting an Przelewy24 Refund Using the REST API {#ppro-refund-ex-przelewy-rest} =========================================================================================== Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "EUR" } }, "clientReferenceInformation": { "code":"3798_sale01", "originalTransactionId": "1193033287" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "p24" } } } } ``` Response to a Successful Request ``` { "paymentOptions": { "type": "p24method", "resources":[ { "id":"94", "name":"Euro Bank", "url": "", "type": "", "data": [] }, { "id":"25", "name":"mBank - mTransfer", "url": "", "type": "", "data": [] } ] } } ``` 7-Eleven {#ppro-seveneleven-intro} ================================== This section describes how to integrate an API that performs this function: * [7-Eleven Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-seveneleven-intro/ppro-sale-intro-seveneleven.md "") 7-Eleven Sales {#ppro-sale-intro-seveneleven} ============================================= This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-seveneleven_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-seveneleven_d10e355} 7-Eleven Malaysia Cash Required Fields {#ppro-sale-req-fields-seveneleven} ========================================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.md "") : Example: Requesting an 7-Eleven Sale Using the REST API {#ppro-sale-ex-seveneleven-rest} ======================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "SGD", "taxAmount": "9080" }, "billTo":{ "country":"SG", "firstName":"John", "lastName":"Doe", "email":"hishriva@visa.com", "phoneNumber":"90909090909" } }, "paymentInformation": { "paymentType": { "name": "offline", "method": { "name": "7eleven" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "reason": "INVALID_DATA", "processorInformation": { "transactionId": "1169581027", "rawStatus": "FAILED" }, "message": "Channel tag not found", "status": "FAILED", "submitTimeUtc": "2022-06-06T14:19:37Z" } ``` Thailand Bank {#ppro-thailand-intro} ==================================== This section describes how to integrate an API that performs this function: * [Thailand Banks Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-thailand-intro/ppro-sale-intro-thailand.md "") Thailand Banks Sales {#ppro-sale-intro-thailand} ================================================ This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-thailand_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-thailand_d10e355} Thailand Banks Required Fields {#ppro-sale-req-fields-thailand} =============================================================== [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-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 "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.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.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.md "") : Thailand Banks Optional Field {#ppro-sale-req-fields-thailand-opt} ================================================================== paymentInformation.bank.name : Example: Requesting an Thailand Banks Sale Using the REST API {#ppro-sale-ex-thailand-rest} =========================================================================================== Request ``` { "clientReferenceInformation": { "code": "zZx5WZ3dkbMp" }, "deviceInformation": { "ipAddress": "127.0.0.1" }, "orderInformation": { "billTo": { "country": "EE", "firstName": "firstName", "lastName": "lastName", "address1": "ABC city, XYZ street", "email": "abc@estoniabanks.com" }, "amountDetails": { "totalAmount": "1000", "currency": "THB" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "paymentInformation": { "customer": { "customerid": "12345" }, "paymentType": { "method": { "name": "thailandbanks" }, "name": "bankTransfer" } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "829605119", "rawStatus": "PENDING", "paymentUrl": "https%3A%2F%2Fr3%2Epaygate%2Ede%2Fti%2Fsimestonianbanks%3Ftx%3D829605119%26rs%3DzaphIHohw9wVXcI7SRHIvK52o5FUwbGy%26cs%3Db326db7ec24d01fb318bb6ce0a4f495b8d32f19f7a4e90451077ef9ca91a8a53" }, "reconciliationId": "zZx5WZ3dkbMp", "paymentInformation": { "binCountry": "EE" }, "message": "Successful", "status": "PENDING", "id": "65233290191267436032918", "submitTimeUtc": "2022-06-03T05:14:54Z" } ``` Trustly {#ppro-trustly-intro} ============================= This section describes how to integrate APIs that perform these functions: * [Trustly Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-trustly-intro/ppro-sale-intro-trustly.md "") * [Trustly Refunds](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-trustly-intro/ppro-refund-intro-trustly.md "") Trustly Sales {#ppro-sale-intro-trustly} ======================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-trustly_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-trustly_d10e355} Trustly Required Fields {#ppro-sale-req-fields-trustly} ======================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-trustly_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-trustly_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-trustly_d23e41} [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 "") : {#ppro-sale-req-fields-trustly_d23e54} [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 "") : {#ppro-sale-req-fields-trustly_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-trustly_d23e81} [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 "") : {#ppro-sale-req-fields-trustly_d23e94} [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 "") : {#ppro-sale-req-fields-trustly_d23e107} [orderInformation.billTo.middleName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-middle-name.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.address2](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-address2.md "") : [paymentInformation.customer.customerId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-customer-customer-id.md "") : Trusty Optional Fields {#ppro-sale-req-fields-trustly-opt} ========================================================== deviceInformation.ipAddress : buyerInformation.personalIdentification.id : Example: Requesting an Trustly Banks Sale Using the REST API {#ppro-sale-ex-trustly-rest} ========================================================================================= Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1400", "currency": "PLN", "taxAmount": "5" }, "billTo": { "firstName": "Jane", "lastName": "abc", "country": "PL", "address1": "xyz street 13 14", "address2": "abc street 13 14", "email": "abc@email.com" }, "shipTo": { "country": "DE" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "trustly" } }, "customer": { "customerid": "abcd" } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "test-merchant-descriptor" } }, "recipientInformation": { "beneficiaryAddress": "13735 SE 184th PL RN 98058", "beneficiaryId": "ben_id", "beneficiaryName": "John Doe" }, "deviceInformation": { "ipAddress": "64.78.88.63", "userAgentBrowserValue": "google" }, "buyerInformation": { "personalIdentification": [ { "id": "personal_Identification" } ], "mobilePhone": "8095803465", "merchantCustomerId":"123abc" }, "consumerAuthenticationInformation": { "customerCardAlias": "hishriva" } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "833406500", "rawStatus": "PENDING", "paymentUrl": "https://r3.paygate.de/ti/pprotrustly?tx=833406500&rs=Il0taHJJ66Hz7UicGb68M869vgmQ0bvo&cs=eed56688165a9567818885d956a695453ba421931a04d13e54d754d31564ed8d" }, "paymentInformation": { "binCountry": "PL" }, "message": "Successful", "status": "PENDING", "id": "652332901912674360347", "submitTimeUtc": "2022-06-07T06:08:08Z" } ``` Retrieve a Transaction {#ppro-trustly-status-intro} =================================================== This section describes how to retrieve the status of a pending transaction. Endpoints --------- **Production:** `GET ``https://api.cybersource.com``/tss/v2/transactions/`*{id}* **Test:** `GET ``https://apitest.cybersource.com``/tss/v2/transactions/`*{id}* Set the *`{id}`* to the request ID of the original transaction. Trustly Retrieve a Transaction {#ppro-status-req-fields-trustly} ================================================================ These fields are required for all get status requests. [processingInformation.reconciliationId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-reconciliation-id.md "") : {#ppro-status-req-fields-trustly_d49e16} [clientReferenceInformation.transactionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-transaction-id.md "") : {#ppro-status-req-fields-trustly_d49e24} Example: Requesting an Trustly Retrieve a Transaction Using the REST API {#ppro-status-ex-trustly-rest} ======================================================================================================= Request ``` { "processingInformation": { "reconciliationId": "sale1077" }, "clientReferenceInformation": { "transactionId": "1170772579" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "trustly" } } } } ``` Response to a Successful Request ``` { "processorInformation": { "transactionId": "1170772579" }, "id": "645506999238791550", "message": "Successful", "status": "SUCCEEDED_PENDING_FUNDS", "submitTimeUtc": "2022-04-07T07:03:39Z" } ``` Trustly Refunds {#ppro-refund-intro-trustly} ============================================ This section describes how to issue a refund. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-trustly_d10e372} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments/`*{id}*`/refunds`{#ppro-refund-intro-trustly_d10e385} The *{id}* is the request ID contained in the original transaction request. Trustly Required Fields {#ppro-refund-req-fields-trustly} ========================================================= [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 "") : {#ppro-refund-req-fields-trustly_d7e14} clientReferenceInformation.originalTransactionId : {#ppro-refund-req-fields-trustly_d7e27} [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 "") : {#ppro-refund-req-fields-trustly_d7e39} [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 "") : {#ppro-refund-req-fields-trustly_d7e47} [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 "") : {#ppro-refund-req-fields-trustly_d7e55} [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 "") : {#ppro-refund-req-fields-trustly_d7e69} Example: Requesting an Trustly Refund Using the REST API {#ppro-refund-ex-trustly-rest} ======================================================================================= Request ``` { "orderInformation": { "amountDetails": { "totalAmount": "1", "currency": "PLN" } }, "clientReferenceInformation": { "code": "sale1077", "originalTransactionId": "833406500" }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "trustly" } } } } ``` Response to a Successful Request ``` { "clientReferenceInformation": { "transactionid": "sale1077" }, "processorInformation": { "transactionId": "128053355" }, "message": "Successful", "status": "REFUNDED", "id": "6523329019126746031916", "submitTimeUtc": "2022-06-07T06:14:01Z" } ``` TrustPay {#ppro-trustpay-intro} =============================== This section describes how to integrate an API that performs this function: * [TrustPay Sales](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-trustpay-intro/ppro-sale-intro-trustpay-rest.md "") TrustPay Sales {#ppro-sale-intro-trustpay-rest} =============================================== This section describes how to process a sale. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-trustpay-rest_d10e345} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments`{#ppro-sale-intro-trustpay-rest_d10e355} TrustPay Required Fields {#ppro-sale-req-fields-trustpay} ========================================================= [buyerInformation.language](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/buyer-info-aa/buyer-info-language.md "") : {#ppro-sale-req-fields-trustpay_d23e15} [merchantInformation.merchantDescriptor.name](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-merchant-descriptor-name.md "") : {#ppro-sale-req-fields-trustpay_d23e28} [merchantInformation.returnUrl](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/merch-info-aa/merch-info-return-url.md "") : {#ppro-sale-req-fields-trustpay_d23e41} [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 "") : {#ppro-sale-req-fields-trustpay_d23e54} [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 "") : {#ppro-sale-req-fields-trustpay_d23e67} [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-country.md "") : {#ppro-sale-req-fields-trustpay_d23e81} [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 "") : {#ppro-sale-req-fields-trustpay_d23e94} [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 "") : {#ppro-sale-req-fields-trustpay_d23e107} Example: Requesting an TrustPay Sale Using the REST API {#ppro-sale-ex-trustpay-rest} ===================================================================================== Request ``` { "clientReferenceInformation": { "code": "sale1077" }, "orderInformation": { "amountDetails": { "totalAmount": "1055", "currency": "EUR", "taxAmount": "900" }, "billTo":{ "country":"SK", "firstName":"Jane", "lastName":"Doe" } }, "paymentInformation": { "paymentType": { "name": "bankTransfer", "method": { "name": "trustpay" } } }, "merchantInformation": { "successUrl": "https://www.example.org/feedback.php", "merchantDescriptor": { "name": "DynDescriptor" } } } ``` Response to a Successful Request ``` { "processorInformation": { "appUrl": "HTTPS://PAYCONIQ.COM/PAY/2/E072C100432F7985B1U39D39", "transactionId": "1169164990", "rawStatus": "PENDING", "paymentUrl": "https://r2.paygate.de/payconiq/S1147/I?tx=1169164990&rs=aFT6rrxK2NtgRR0IPSusq538I7Mn60v0&cs=a2347e6802ac046a256305544ac97dff3295e399b933fe084090c0530cf60ade" }, "paymentInformation": { "bank": { "iban": "LU9999999999" } }, "reconciliationId": "sale1077", "message": "Successful", "status": "PENDING", "id": "65233290191267436032965", "submitTimeUtc": "2022-06-06T06:55:11Z" } ``` `REST` API Field Reference Section {#ppro-intro-fields} ======================================================= This section describes the `REST` API Fields required to perform services using the alternative payment methods. merchantinformation.successURL {#merchantinformation-successurl-rest} ===================================================================== Custom app URL for redirecting the costumer back to the app after making payment. Services {#merchantinformation-successurl-rest_d99e18} ------------------------------------------------------ * **Sale:** Required Specifications {#merchantinformation-successurl-rest_d99e32} ------------------------------------------------------------ * **Field Type:** Request * **Data Type:** ascii * **Data Length:** xx Mapping Information {#merchantinformation-successurl-rest_d99e56} ----------------------------------------------------------------- * **REST API Field:** merchantinformation.successURL * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field paymentInformation.bank.account.name {#paymentinformation-bank-account-name-rest} ================================================================================= Name of the account holder. Only ASCII characters are supported. Services {#paymentinformation-bank-account-name-rest_d130e26} ------------------------------------------------------------- * **Sales:** Required Specifications {#paymentinformation-bank-account-name-rest_d130e40} ------------------------------------------------------------------- * **Field Type:** Request * **Data Type:** String * **Data Length:** 150 Mapping Information {#paymentinformation-bank-account-name-rest_d130e64} ------------------------------------------------------------------------ * **REST API Field:** paymentInformation.bank.account.name * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field paymentinformation.bank.account.number {#paymentinformation-bank-account-number-rest} ===================================================================================== Customer's bank account number. Only ASCII characters are supported. Services {#paymentinformation-bank-account-number-rest_d94e26} -------------------------------------------------------------- * **Sale:** Required Specifications {#paymentinformation-bank-account-number-rest_d94e40} -------------------------------------------------------------------- * **Field Type:** Request * **Data Type:** xxxx * **Data Length:** xx Mapping Information {#paymentinformation-bank-account-number-rest_d94e64} ------------------------------------------------------------------------- * **REST API Field:** field_name * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field Processor Field Names {#paymentinformation-bank-account-number-rest_d94e91} --------------------------------------------------------------------------- If you are documenting a Level II/III field, see the DITA API field template for Level II/III fields. paymentinformation.bank.code {#paymentinformation-bank-code-rest} ================================================================= Bank code for the customer's account. Only ASCII characters are supported. Services {#paymentinformation-bank-code-rest_d148e24} ----------------------------------------------------- * **Authorization:** Required Specifications {#paymentinformation-bank-code-rest_d148e38} ----------------------------------------------------------- * **Field Type:** Request * **Data Type:** String * **Data Length:** 50 Mapping Information {#paymentinformation-bank-code-rest_d148e62} ---------------------------------------------------------------- * **REST API Field:** paymentInformation.bank.code * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field paymentinformation.bank.iban {#paymentinformation-bank-iban-rest} ================================================================= Costumer's account IBAN. Only ASCII characters are supported. Services {#paymentinformation-bank-iban-rest_d42e24} ---------------------------------------------------- * **Authorization:** Required Specifications {#paymentinformation-bank-iban-rest_d42e38} ---------------------------------------------------------- * **Field Type:** Request * **Data Type:** String * **Data Length:** xx Mapping Information {#paymentinformation-bank-iban-rest_d42e62} --------------------------------------------------------------- * **REST API Field:** field_name * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field Processor Field Names {#paymentinformation-bank-iban-rest_d42e88} ----------------------------------------------------------------- If you are documenting a Level II/III field, see the DITA API field template for Level II/III fields. paymentinformation.bank.name {#paymentinformation-bank-name-rest} ================================================================= Simple Description Text **KeyRef for Processor Name** Processor-specific information. Services {#paymentinformation-bank-name-rest_d158e33} ----------------------------------------------------- * **Authorization:** Required * **Credit:** Optional Specifications {#paymentinformation-bank-name-rest_d158e52} ----------------------------------------------------------- * **Field Type:** Request * **Data Type:** xxxx * **Data Length:** xx Mapping Information {#paymentinformation-bank-name-rest_d158e76} ---------------------------------------------------------------- * **REST API Field:** field_name * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field paymentinformation.bank.swiftcode {#paymentinformation-bank-swiftcode-rest} =========================================================================== Valid iDEAL issuer's BIC. Can only contain 8 or 11 alphanumeric characters. Services {#paymentinformation-bank-swiftcode-rest_d76e24} --------------------------------------------------------- * **Authorization:** Required Specifications {#paymentinformation-bank-swiftcode-rest_d76e38} --------------------------------------------------------------- * **Field Type:** Request * **Data Type:** String * **Data Length:** 11 Mapping Information {#paymentinformation-bank-swiftcode-rest_d76e62} -------------------------------------------------------------------- * **REST API Field:** paymentInformation.bank.swiftCode * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field paymentOptions.resources\[\].id {#paymentinformation-options-optiondetails-id-rest} =================================================================================== Specifies a valid bank identifier to bypass PPRO's bank selection page. Only ASCII characters are supported. Services {#paymentinformation-options-optiondetails-id-rest_d112e24} -------------------------------------------------------------------- * **Authorization:** Required * **Credit:** Optional Specifications {#paymentinformation-options-optiondetails-id-rest_d112e43} -------------------------------------------------------------------------- * **Field Type:** Request Mapping Information {#paymentinformation-options-optiondetails-id-rest_d112e57} ------------------------------------------------------------------------------- * **REST API Field:** paymentOptions.resources\[\].id * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field paymentInformation.paymentType.method.type {#paymentinformation-paymenttype-method-type-rest} ============================================================================================= Indicates the channel used for the transaction. Channel options must be listed on merchant's site and the payment channel known. If value is not given, the customer is redirected to the alternative payment's hosted payment selection page. Services {#paymentinformation-paymenttype-method-type-rest_d146e24} ------------------------------------------------------------------- * **Authorization:** Required * **Credit:** Optional Specifications {#paymentinformation-paymenttype-method-type-rest_d146e43} ------------------------------------------------------------------------- * **Field Type:** Request * **Data Type:** String * **Data Length:** 35 Mapping Information {#paymentinformation-paymenttype-method-type-rest_d146e67} ------------------------------------------------------------------------------ * **REST API Field:** paymentInformation.paymentType.method.type * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field paymentInformation.purposeOfPayment {#paymentinformation-purposeofpayment-rest} =============================================================================== Simple Description Text Provide additional information about the field here. **KeyRef for Processor Name** Processor-specific information. Services {#paymentinformation-purposeofpayment-rest_d154e34} ------------------------------------------------------------ * **Authorization:** Required * **Credit:** Optional Specifications {#paymentinformation-purposeofpayment-rest_d154e53} ------------------------------------------------------------------ * **Field Type:** Request * **Data Type:** xxxx * **Data Length:** xx Mapping Information {#paymentinformation-purposeofpayment-rest_d154e77} ----------------------------------------------------------------------- * **REST API Field:** field_name * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field Processor Field Names {#paymentinformation-purposeofpayment-rest_d154e103} -------------------------------------------------------------------------- If you are documenting a Level II/III field, see the DITA API field template for Level II/III fields. processingInformation.transactionTimeout {#processinginformation-transactiontimeout-rest} ========================================================================================= Minutes until a pending transaction times out. Default value is 5. Services {#processinginformation-transactiontimeout-rest_d106e24} ----------------------------------------------------------------- * **Authorization:** Required Specifications {#processinginformation-transactiontimeout-rest_d106e38} ----------------------------------------------------------------------- * **Field Type:** Request * **Data Type:** String * **Data Length:** 30 Mapping Information {#processinginformation-transactiontimeout-rest_d106e62} ---------------------------------------------------------------------------- * **REST API Field:** processingInformation.transactionTimeout * **SCMP API Field:** No corresponding field * **Simple Order API Field:** No corresponding field Sofort {#ppro-sofort-intro} =========================== This section describes how to integrate an API that performs this function: * [Retrieve a Transaction](/docs/cybs/en-us/ppro/integration/all/rest/ppro/ppro-bancontact-intro/ppro-status-intro-x.md "") Retrieve Bank Options {#ppro-option-intro} ========================================== This section describes how to send an options request in order to retrieve a list of participating banks for the day. Perform the options request to receive the latest updates for participating banks' redirect URLs, IDs, and any additional data. Endpoints --------- **Production:** `POST ``https://api.cybersource.com``/pts/v2/payments-options`{#ppro-option-intro_d10e140} **Test:** `POST ``https://apitest.cybersource.com``/pts/v2/payments-options`{#ppro-option-intro_d10e150} Example: Requesting Options Using the REST API {#ppro-option-ex-rest} ===================================================================== Request ``` { "clientReferenceInformation" : { "code" : "123456" }, "paymentInformation" : { "paymentType" : { "method" : { "name" : "lithuanianbanks" }, "name" : "bankTransfer" } } } ``` Response to a Successful Request ``` { "paymentOptions": { "type": "lithuanianbanks", "resources":[ { "id":"94", "name":"ABN AMRO", "url": "", "type": "", "data": [] }, { "id":"25", "name":"ASN BANK", "url": "", "type": "", "data": [] } ] } } ```