HyperPay

https://hyperpay.docs.oppwa.com
Admin
HyperPay is a payment orchestration platform offering solutions for secure and efficient online...
Tokens:337,520
Snippets:3,702
Trust Score:7.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Pods in iOS Project

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/brand-configurations/klarna

After updating your Podfile, run this command to install the necessary dependencies for your iOS project.

```bash
pod install
```

--------------------------------

### Prepare Stand-alone Registration

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/prebuilt-ui/tokenization

Example cURL request to prepare a registration-only checkout session.

```bash
curl https://eu-test.oppwa.com/v1/checkouts \
 -d "entityId=8a8294174d0595bb014d05d829cb01cd" \
 -d "notificationUrl=http://www.example.com/notify" \
 -d "createRegistration=true" \
 -H "Authorization: Bearer OGE4Mjk0MTc0ZDA1OTViYjAxNGQwNWQ4MjllNzAxZDF8bk49a3NvQ3ROZjJacW9nOWYla0o="
```

--------------------------------

### COPYandPAY Widget Configuration

Source: https://hyperpay.docs.oppwa.com/integrations/widget/payfast

Example of how to include PAYPAL_PAYFAST and VENMO_PAYFAST brands in the payment widget form.

```APIDOC
## COPYandPAY Widget Integration

### Description
To enable PayPal PayFast or Venmo PayFast, specify the respective brand in the `data-brands` attribute of the payment widget form.

### Implementation
<form action="https://hyperpay.docs.oppwa.com/integrations/widget" class="paymentWidgets" data-brands="PAYPAL_PAYFAST VENMO_PAYFAST"></form>
```

--------------------------------

### Get Payment Status Resource Path

Source: https://hyperpay.docs.oppwa.com/integrations/widget

This is an example of a `resourcePath` used to retrieve the payment status after a transaction. It includes the checkout ID.

```plaintext
resourcePath=/v1/checkouts/{checkoutId}/payment
```

--------------------------------

### Initialize OPPPaymentProvider in Live Mode (Objective-C)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/first-integration

Configure the OPPPaymentProvider to use live credentials for production. This is a crucial step when moving from a sandbox to a live environment.

```objective-c
self.provider = [OPPPaymentProvider paymentProviderWithMode:OPPProviderModeLive];

```

--------------------------------

### Full PayPal Integration Example

Source: https://hyperpay.docs.oppwa.com/advanced-options

Complete implementation including HTML form, CSS styling, and JavaScript logic for toggling registration.

```html
<form action="https://hyperpay.docs.oppwa.com/integrations/widget" class="paymentWidgets" data-brands="PAYPAL"></form> <div id="registrationConfig"> <input type="checkbox" id="createRegistrationCheckbox" name="createRegistration" onclick="handleClick(this)" checked /> <label for="createRegistration">Create Registration</label> </div>
```

```css
body {background-color:#f6f6f5;}
```

```javascript
var wpwlOptions = { inlineFlow: ["PAYPAL","PAYPAL_CONTINUE"], locale: "en", style:"plain", paypal: {"createRegistration":"true"}, forter: {siteId : "1a4cd159d7ae"} } function handleClick(checkbox) { wpwlOptions.paypal.createRegistration = checkbox.checked.toString(); wpwl.reloadButton(); } $("#createRegistrationCheckbox").prop("checked", "true" === wpwlOptions.paypal.createRegistration);
```

--------------------------------

### Add Custom Fields to Payment Form

Source: https://hyperpay.docs.oppwa.com/advanced-options

Example of adding a custom installment selection field to the payment form using the onReady event.

```html
<form action="https://hyperpay.docs.oppwa.com/integrations/widget/advanced-options" class="paymentWidgets" data-brands="VISA MASTER AMEX"></form>
```

```css
body {background-color:#f6f6f5;}
```

```javascript
var wpwlOptions = { style: "card", onReady: function() { var numberOfInstallmentsHtml = '<div class="wpwl-label wpwl-label-custom" style="display:inline-block">Number of Installments</div>' + '<div class="wpwl-wrapper wpwl-wrapper-custom" style="display:inline-block">' + '<select name="recurring.numberOfInstallments"><option value="1">1</option><option value="3">3</option><option value="5">5</option></select>' + '</div>'; $('form.wpwl-form-card').find('.wpwl-button').before(numberOfInstallmentsHtml); } }
```

--------------------------------

### Initialize OPPCheckoutProvider (Objective-C & Swift)

Source: https://hyperpay.docs.oppwa.com/mobile-sdk-payment-button

Initialize the payment provider and configure checkout settings, including payment brands and the shopper result URL. This setup is required before presenting the checkout flow.

```Objective-C
OPPPaymentProvider *provider = [OPPPaymentProvider paymentProviderWithMode:OPPProviderModeTest];

OPPCheckoutSettings *checkoutSettings = [[OPPCheckoutSettings alloc] init];
checkoutSettings.paymentBrands = @[@"VISA"];
checkoutSettings.shopperResultURL = @"com.companyname.appname.payments://result";
OPPCheckoutProvider *checkoutProvider = [OPPCheckoutProvider checkoutProviderWithPaymentProvider:provider
                                                                                      checkoutID:checkoutID
                                                                                        settings:checkoutSettings];

```

```Swift
let provider = OPPPaymentProvider(mode: OPPProviderMode.test)

let checkoutSettings = OPPCheckoutSettings()
checkoutSettings.paymentBrands = ["VISA"]
checkoutSettings.shopperResultURL = "com.companyname.appname.payments://result"
let checkoutProvider = OPPCheckoutProvider(paymentProvider: provider, checkoutID: checkoutID!, settings: checkoutSettings)

```

--------------------------------

### Get transactions for a specified time frame

Source: https://hyperpay.docs.oppwa.com/reporting-transaction

Retrieve a list of transactions by specifying a start and end date. You can also limit the number of results per request. If `limit` is omitted, it defaults to 100.

```APIDOC
## Get transactions for a specified time frame

### Description
To retrieve a list of transactions for a specified time frame it is possible to add the `date.from` and `date.to` parameters to the request. To limit the number of entries returned for a request use the parameter `limit` (min: 100 ma: 500).
If the parameter `limit` is omitted in the request, the default value of 100 will be used and, depending on the number of results, pagination will be used.

Additionally, it is still possible to filter the result using `paymentTypes` and `paymentMethods` filtering options.
Request must contain either `merchantTransactionId` or `date.to`/`date.from` and parameters. Please see the API Reference for further details.

### Method
GET

### Endpoint
/v3/query

### Query Parameters
- **date.from** (string) - Required - The start date and time for the transaction search.
- **date.to** (string) - Required - The end date and time for the transaction search.
- **limit** (integer) - Optional - The maximum number of transactions to return (min: 100, max: 500). Defaults to 100.
- **paymentTypes** (string) - Optional - Filter by payment types.
- **paymentMethods** (string) - Optional - Filter by payment methods.

### Request Example
```curl
curl -G https://eu-test.oppwa.com/v3/query \
 -d "date.from=2023-01-01 00:00:00" \
 -d "date.to=2023-01-01 01:00:00" \
 -d "limit=20" \
 -d "entityId=8a8294174b7ecb28014b9699220015ca" \
 -H "Authorization: Bearer OGE4Mjk0MTc0YjdlY2IyODAxNGI5Njk5MjIwMDE1Y2N8ZmY0b1UhZSVlckI9YUJzQj82KyU="
```
```

--------------------------------

### Initialize OPPPaymentProvider in Live Mode (Swift)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui

Initialize the OPPPaymentProvider with `OPPProviderMode.live` for live transactions. Ensure your backend is configured for the live environment.

```swift
let provider = OPPPaymentProvider(mode: OPPProviderMode.live)
```

--------------------------------

### OPPCheckoutSettings / CheckoutSettings - Installment Configuration

Source: https://hyperpay.docs.oppwa.com/mobile-sdk-advanced-options

Configures the checkout settings to enable installment payments and define the available installment options.

```APIDOC
## Installment Configuration

### Description
Enables installment payments and sets the list of available installment options for the checkout process.

### Usage
- **installmentEnabled** (boolean) - Set to true to enable installments.
- **installmentOptions** (array) - List of integers representing installment counts (e.g., [1, 2, 3]).
```

--------------------------------

### Initial Payment Parameters for COPYandPAY Installment

Source: https://hyperpay.docs.oppwa.com/cof

Parameters to include in the /checkouts request for initial installment payments.

```text
* standingInstruction.mode=INITIAL 
* standingInstruction.type=INSTALLMENT
* standingInstruction.source=CIT
```

--------------------------------

### Initialize OPPPaymentProvider in Live Mode (Swift)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/first-integration

Set up the OPPPaymentProvider for live transactions in Swift. This ensures that your application uses the correct production endpoints and credentials.

```swift
let provider = OPPPaymentProvider(mode: OPPProviderMode.live)

```

--------------------------------

### Payment Status Response Example

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/prebuilt-ui/tokenization

Example JSON response containing the registrationId token after a successful payment.

```json
{
  "registrationId":"8a82944a580a782101581f3a0b4b5ab9",
  "result":{
    "code":"000.100.110",
    "description":"Request successfully processed in 'Merchant in Integrator Test Mode'"
  },
  // ...
}
```

--------------------------------

### Initialize OppPaymentProvider in Live Mode (Java)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui

Initialize the `OppPaymentProvider` with `Connnect.ProviderMode.LIVE` for live transactions. Ensure your backend is configured for the live environment.

```java
OppPaymentProvider paymentProvider = new OppPaymentProvider(context, Connnect.ProviderMode.LIVE);
```

--------------------------------

### Initialize OppPaymentProvider in Live Mode (Kotlin)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui

Initialize the `OppPaymentProvider` with `Connnect.ProviderMode.LIVE` for live transactions. Ensure your backend is configured for the live environment.

```kotlin
val paymentProvider = OppPaymentProvider(context, Connnect.ProviderMode.LIVE)
```

--------------------------------

### Initialize OPPPaymentProvider in Live Mode (Objective-C)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui

Initialize the OPPPaymentProvider with `OPPProviderModeLive` for live transactions. Ensure your backend is configured for the live environment.

```objective-c
self.provider = [OPPPaymentProvider paymentProviderWithMode:OPPProviderModeLive];
```

--------------------------------

### Example error callback payloads

Source: https://hyperpay.docs.oppwa.com/widget-api

Example JSON structures returned by the onError callback for various payment methods.

```json
{"brand":"PAYPAL_CONTINUE","event":"closed","message":{"orderID":"5ML88112J1669413J"}}
```

```json
{"brand":"PAYPAL_CONTINUE","event":"PAYPAL_CONTINUE:onError","message":{.....}}
```

```json
{"brand":"GOOGLEPAY","event":"closed","message":"User closed GooglePay Widget! {\"statusCode\":\"CANCELED\"}"}
```

```json
{"brand":"GOOGLEPAY","event":"developer_error","message":"The passed PaymentDataRequest object was improperly formatted..."}"
```

```json
{"brand":"APPLEPAY","event":"onValidateMerchant-fail","message":"Failure reason - .... Aborting Session."}"
```

--------------------------------

### Configure Installment Options

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/prebuilt-ui/advanced-options

Enable installment payments and define the available options list. Requires version 2.30.0 or higher.

```objective-c
OPPCheckoutSettings *checkoutSettings = [[OPPCheckoutSettings alloc] init];
checkoutSettings.installmentEnabled = YES;
checkoutSettings.installmentOptions = @[@1, @2, @3];
```

```swift
let checkoutSettings = OPPCheckoutSettings()
checkoutSettings.isInstallmentEnabled = true
checkoutSettings.installmentOptions = [1, 2, 3]
```

```java
CheckoutSettings checkoutSettings = new CheckoutSettings(
        checkoutId, paymentBrands, providerMode);

checkoutSettings.setInstallmentEnabled(true);
checkoutSettings.setInstallmentOptions(new Integer[] { 1, 2, 3 });
```

```kotlin
val checkoutSettings = CheckoutSettings(checkoutId, paymentBrands, providerMode) 
 
checkoutSettings.isInstallmentEnabled = true 
checkoutSettings.installmentOptions = arrayOf(1, 2, 3)
```

--------------------------------

### Configure CheckoutSettings with Payment Brands (Java)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/prebuilt-ui/payment-button

Set up CheckoutSettings to specify the payment brands available to the shopper. This example includes VISA and MASTER.

```java
Set<String> paymentBrands = new LinkedHashSet<String>();

paymentBrands.add("VISA");
paymentBrands.add("MASTER");

CheckoutSettings checkoutSettings = new CheckoutSettings(checkoutId, paymentBrands, Connect.ProviderMode.TEST);
// since mSDK version 6.0.0 the shopper result URL is not required
checkoutSettings.setShopperResultUrl("companyname://result");

```

--------------------------------

### Configure PayPal SDK Parameters

Source: https://hyperpay.docs.oppwa.com/integrations/widget/fast-checkout/paypal

Use the `sdkParams` option to pass PayPal SDK query parameters. This example shows how to enable components, specific funding sources, and enable debug mode.

```javascript
sdkParams:{
  components: "buttons, messages",
  "enable-funding": "paylater",
  debug: "true"
 }
```

--------------------------------

### Tieback Message Body Example

Source: https://hyperpay.docs.oppwa.com/fraud

Example of a custom message body for a Tieback request, including merchant-defined keys and values.

```text
client=000000&subclientid=100001&transactionid=ABC123&acitransactionid=000000100001ABC20160914090137168&decision=CANCEL&userid=ANUser&cancelreason=216&note=lorem+ipsum&processdate=2016-09-14 13:00:00.000&password=NX436T&username=test1
```

--------------------------------

### Initialize Payment Provider (Swift)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/first-integration

Initialize the OPPPaymentProvider in test mode.

```swift
let provider = OPPPaymentProvider(mode: OPPProviderMode.test)

```

--------------------------------

### HTTP Response Body Example

Source: https://hyperpay.docs.oppwa.com/api-reference

Example of a successful HTTP 200 response body in JSON format. Expect new fields to be added to this structure in future updates.

```json
HTTP 200
{
  "id":"8ac7a4a289d210fc0189d5b4e9572cc8",
  "paymentType":"DB",
  "paymentBrand":"VISA",
  "amount":"92.00",
  "currency":"EUR",
  "descriptor":"7766.2840.5126 OPP_Channel ",
  "result":{
    "code":"000.100.110",
    "description":"Request successfully processed in 'Merchant in Integrator Test Mode'"
  },
  "resultDetails":{
    "ExtendedDescription":"Authorized",
    "clearingInstituteName":"Your Clearing Institute Name",
    "ConnectorTxID1":"00000000776628405126",
    "ConnectorTxID3":"0170|085",
    "ConnectorTxID2":"012416",
    "AcquirerResponse":"0000"
  },
  "card":{
    "bin":"420000",
    "last4Digits":"0000",
    "holder":"Jane Jones",
    "expiryMonth":"05",
    "expiryYear":"2034"
  },
  "risk":{
    "score":"100"
  },
  "buildNumber":"5ce30a257f96b238fa8ecc669ffdc2a77040ba35@2023-08-08 07:36:04 +0000",
  "timestamp":"2023-08-08 15:12:30.752+0000",
  "ndc":"8a8294174b7ecb28014b9699220015ca_83281e556b1e4216bef5c3bc1f63c45c"
}
```

--------------------------------

### GET /v1/query/

Source: https://hyperpay.docs.oppwa.com/api-reference

Transaction search using merchantTransactionId.

```APIDOC
## GET /v1/query/

### Description
Transaction search using merchantTransactionId.

### Method
GET

### Endpoint
/v1/query/
```

--------------------------------

### Prepare Checkout with Registration

Source: https://hyperpay.docs.oppwa.com/integrations/widget/network-tokens

Initiates network token provisioning by setting createRegistration to true in the checkout request.

```curl
curl https://eu-test.oppwa.com/v1/checkouts \
 -d "entityId=8ac7a4ca8bd50add018bddc481060ab9" \
 -d "createRegistration=true" \
 -d "customParameters[3DS2_enrolled]=true" \
 -d "customParameters[3DS2_flow]=challenge" \
 -d "testMode=EXTERNAL" \
 -d "amount=11.12" \
 -d "currency=EUR" \
 -d "paymentType=DB" \
 -d "standingInstruction.mode=INITIAL" \
 -d "standingInstruction.source=CIT" \
 -d "standingInstruction.type=UNSCHEDULED" \
 -d "customer.givenName=Smith" \
 -d "customer.ip=192.168.0.0" \
 -d "customer.surname=John" \
 -d "customer.language=DE" \
 -d "customer.email=john.smith@gmail.com" \
 -d "billing.city=MyCity" \
 -d "billing.country=DE" \
 -d "billing.postcode=712121" \
 -d "billing.state=DE" \
 -d "billing.street1=MyStreet" \
 -d "integrity=true" \
 -H "Authorization: Bearer OGE4Mjk0MTc0ZDA1OTViYjAxNGQwNWQ4MjllNzAxZDF8bk49a3NvQ3ROZjJacW9nOWYla0o="
```

--------------------------------

### Initialize Klarna View with Client Token

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/brand-configurations/klarna

Initialize the Klarna view with the client token and return URL received from the mSDK. This is a prerequisite for authorizing the session.

```Objective-C
NSString *clientToken = transaction.brandSpecificInfo[OPPTransactionKlarnaInlineClientTokenKey];
[klarnaPaymentView initializeWithClientToken:clientToken returnUrl:transaction.paymentParams.shopperResultURL];
```

```Swift
let clientToken = transaction.brandSpecificInfo[OPPTransactionKlarnaInlineClientTokenKey]
klarnaPaymentView.initialize(clientToken: clientToken, returnUrl: transaction.paymentParams.shopperResultURL)
```

```Java
String clientToken = transaction.getBrandSpecificInfo().get(Transaction.KLARNA_INLINE_CLIENT_TOKEN_KEY);
klarnaPaymentsView.initialize(clientToken, transaction.getPaymentParams().getShopperResultUrl());
```

```Kotlin
val clientToken = transaction.brandSpecificInfo[Transaction.KLARNA_INLINE_CLIENT_TOKEN_KEY]
klarnaPaymentsView.initialize(clientToken, transaction.paymentParams.shopperResultUrl)
```

--------------------------------

### GET /v3/query/

Source: https://hyperpay.docs.oppwa.com/api-reference

Transaction search using merchantTransactionId (v3).

```APIDOC
## GET /v3/query/

### Description
Transaction search using merchantTransactionId (v3).

### Method
GET

### Endpoint
/v3/query/
```

--------------------------------

### GET /v1/secureRegistrations/{registrationId}

Source: https://hyperpay.docs.oppwa.com/api-reference

Query secure payment token.

```APIDOC
## GET /v1/secureRegistrations/{registrationId}

### Description
Query secure payment token.

### Method
GET

### Endpoint
/v1/secureRegistrations/{registrationId}

### Parameters
#### Path Parameters
- **registrationId** (string) - Required - The unique identifier for the registration.
```

--------------------------------

### Prepare Checkout for Tokenization

Source: https://hyperpay.docs.oppwa.com/integrations/widget/omni-tokens

Initiate a server-to-server POST request with createOmniToken set to true.

```bash
curl https://eu-test.oppwa.com/v1/checkouts \
 -d "entityId=8ac7a4c793bdf2a00193bff6f8c50307" \
 -d "testMode=EXTERNAL" \
 -d "createOmniToken=true" \
 -d "integrity=true" \
 -H "Authorization: Bearer OGE4Mjk0MTc0ZDA1OTViYjAxNGQwNWQ4MjllNzAxZDF8bk49a3NvQ3ROZjJacW9nOWYla0o="
```

--------------------------------

### GET /v1/query/{paymentId}/

Source: https://hyperpay.docs.oppwa.com/api-reference

Transaction search using paymentId.

```APIDOC
## GET /v1/query/{paymentId}/

### Description
Transaction search using paymentId.

### Method
GET

### Endpoint
/v1/query/{paymentId}/

### Parameters
#### Path Parameters
- **paymentId** (string) - Required - The unique identifier for the payment.
```

--------------------------------

### Import OPPWAMobile SDK in Objective-C

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/first-integration

Import the OPPWAMobile framework in your Objective-C project. Ensure the framework is correctly added to your project.

```objectivec
#import <OPPWAMobile/OPPWAMobile.h>
```

--------------------------------

### GET /v3/query/{paymentId}/

Source: https://hyperpay.docs.oppwa.com/api-reference

Transaction search using paymentId (v3).

```APIDOC
## GET /v3/query/{paymentId}/

### Description
Transaction search using paymentId (v3).

### Method
GET

### Endpoint
/v3/query/{paymentId}/

### Parameters
#### Path Parameters
- **paymentId** (string) - Required - The unique identifier for the payment.
```

--------------------------------

### Set Live Mode (Kotlin)

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/prebuilt-ui/payment-button

Initialize CheckoutSettings for live transactions by specifying Connect.ProviderMode.LIVE. This requires live credentials.

```kotlin
val checkoutSettings = CheckoutSettings(checkoutId, paymentBrand, Connect.ProviderMode.LIVE)
```

--------------------------------

### Initialize WpwlOptions for Android

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/prebuilt-ui/advanced-options

Configures brand-specific options and JavaScript callbacks for Android.

```java
WpwlOptions wpwlOption = new WpwlOptions().addValue("locale", "fr-BE");
wpwlOptions.addJSFunction("onReady","function() {/* function here */}");
```

```kotlin
val wpwlOption = WpwlOptions().addValue("inlineFlow", "fr-BE")
wpwlOptions.addJSFunction("onReady","function() {/* function here */}")
```

--------------------------------

### GET /v1/checkouts/{checkoutId}

Source: https://hyperpay.docs.oppwa.com/api-reference

Updates or retrieves details for a specific checkout.

```APIDOC
## GET /v1/checkouts/{checkoutId}

### Description
Retrieves details for a specific checkout.

### Method
GET

### Endpoint
/v1/checkouts/{checkoutId}

### Parameters
#### Path Parameters
- **checkoutId** (string) - Required - The unique identifier for the checkout.
```

--------------------------------

### Basic Widget Implementation

Source: https://hyperpay.docs.oppwa.com/tutorials/integration-guide/customisation

Initializes the payment widget with a specific style configuration.

```html
<form action="https://hyperpay.docs.oppwa.com/integrations/widget/customization" class="paymentWidgets" data-brands="VISA MASTER AMEX GOOGLEPAY GOOGLEPAYTKN MADA "></form> body {background-color:#f6f6f5;} var wpwlOptions = {style:"card"}
```

--------------------------------

### GET /v1/payments/{paymentId}

Source: https://hyperpay.docs.oppwa.com/api-reference

Retrieves the payment status for a specific payment ID.

```APIDOC
## GET /v1/payments/{paymentId}

### Description
Retrieves the payment status for a specific payment ID.

### Method
GET

### Endpoint
/v1/payments/{paymentId}

### Parameters
#### Path Parameters
- **paymentId** (string) - Required - The unique identifier for the payment.
```

--------------------------------

### GET /reports/v2/reconciliations/aggregations/{id}

Source: https://hyperpay.docs.oppwa.com/integrations/reporting/settlement

Retrieves detailed settlement information with pagination support.

```APIDOC
## GET /reports/v2/reconciliations/aggregations/{id}

### Description
Retrieves detailed settlement information for a particular aggregation ID with pagination. Records are split into pages of 100.

### Method
GET

### Endpoint
https://eu-test.oppwa.com/reports/v2/reconciliations/aggregations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The aggregation ID.

#### Query Parameters
- **entityId** (string) - Required - The entity identifier.
- **testMode** (string) - Optional - Set to 'INTERNAL' to return dummy data.
- **pageNo** (integer) - Optional - The page number to retrieve.
```

--------------------------------

### Initialize OPPWpwlOptions for iOS

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/prebuilt-ui/advanced-options

Configures brand-specific options and JavaScript callbacks for iOS.

```objective-c
NSDictionary *config = @{@"locale": @"fr-BE"};
NSDictionary *jsConfig = @{@"onReady": @"function() {/* function here */}"};
OPPWpwlOptions *wpwlOptions = [OPPWpwlOptions initWithConfiguration:config jsFunctions:jsConfig];
```

```swift
var config = [ "locale" : "fr-BE" ]
var jsConfig = [ "onReady" : "function() {/* function here */}" ] as [String : Any]
let wpwlOptions = OPPWpwlOptions.initWithConfiguration( config , jsFunctions: jsConfig)
```

--------------------------------

### Apple Pay Options and Callbacks

Source: https://hyperpay.docs.oppwa.com/applepay

Provides an example of configuring Apple Pay options and handling callbacks for shipping method selection and payment authorization. Ensure that the `getTotal` and `getLineItems` functions are defined and accessible.

```javascript
return update; },
// Triggered when a shipping method is selected
onShippingMethodSelected: function (shippingMethod) {
    console.log("onShippingMethodSelected: " + JSON.stringify(shippingMethod));
    // Calculate new total and new line items
    shippingAmount = (shippingMethod.identifier === "free") ? 0 : 500;
    return { newTotal: getTotal(), newLineItems: getLineItems() }
},
// Triggered when the user has authorized the Apple Pay payment
onPaymentAuthorized: function (payment) {
    console.log("onPaymentAuthorized payment: " + JSON.stringify(payment));
    // Save payment.shippingContact and payment.billingContact
    // Because the amount might be changed since the checkout creation, you will need to update it.
    // Default is SUCCESS, if nothing is returned
    // An example if you want to return an error
    /*return {
        // Possible values: SUCCESS, FAILURE
        status: "FAILURE",
        errors: [{
            // Possible values: shippingContactInvalid, billingContactInvalid,
            // addressUnserviceable
            code: "shippingContactInvalid",
            // Possible values: phoneNumber, emailAddress, name, phoneticName,
            // postalAddress, addressLines, locality, subLocality, postalCode,
            // administrativeArea, subAdministrativeArea, country, countryCode
            contactField: "phoneNumber",
            message: "Invalid phone number"
        }]
    };*/
}
}
};
```

--------------------------------

### Tokenization Status Resource Paths

Source: https://hyperpay.docs.oppwa.com/integrations/widget/network-tokens

The resourcePath returned as a GET parameter after redirection to the shopperResultUrl.

```text
resourcePath=/v1/checkouts/{checkoutId}/registration
```

```text
resourcePath=/v1/checkouts/{checkoutId}/omnitoken
```

--------------------------------

### Initialize OPPCheckoutProvider

Source: https://hyperpay.docs.oppwa.com/integrations/mobile-sdk/first-integration

Initialize the OPPCheckoutProvider with the payment provider, checkout ID, and settings. It's recommended to create this object at the class level.

```Objective-C
OPPCheckoutProvider *checkoutProvider = [OPPCheckoutProvider checkoutProviderWithPaymentProvider:self.provider
                                                                                      checkoutID:checkoutID
                                                                                        settings:checkoutSettings];
```

```Swift
let checkoutProvider = OPPCheckoutProvider(paymentProvider: self.provider, checkoutID: checkoutID!, settings: checkoutSettings)
```

--------------------------------

### GET /v1/checkouts/{id}/payment

Source: https://hyperpay.docs.oppwa.com/integrations/widget/external-tokens

Retrieves the payment status after the payment request is processed.

```APIDOC
## GET /v1/checkouts/{id}/payment

### Description
Retrieves the payment and external token status after the customer is redirected to the shopperResultUrl.

### Method
GET

### Endpoint
https://eu-test.oppwa.com/v1/checkouts/{id}/payment

### Parameters
#### Path Parameters
- **id** (string) - Required - The checkout ID received from the initial request.

#### Query Parameters
- **entityId** (string) - Required - The entity ID for the transaction.

### Request Example
curl -G https://eu-test.oppwa.com/v1/checkouts/{id}/payment \
 -d "entityId=8ac7a4c8876808f0018770b7edcd09c6" \
 -H "Authorization: Bearer OGE4Mjk0MTc0ZDA1OTViYjAxNGQwNWQ4MjllNzAxZDF8bk49a3NvQ3ROZjJacW9nOWYla0o="
```

--------------------------------

### Initial Server-to-Server Payment Request

Source: https://hyperpay.docs.oppwa.com/cof

Example of an initial /payments request using cURL to store a token for future use.

```bash
curl https://eu-test.oppwa.com/v1/payments \
 -d "entityId=8a8294174d0595bb014d05d829cb01cd" \
 -d "amount=92.00" \
 -d "currency=SAR" \
 -d "paymentBrand=VISA" \
 -d "paymentType=DB" \
 -d "card.number=4200000000000000" \
 -d "card.holder=Jane Jones" \
 -d "card.expiryMonth=05" \
 -d "card.expiryYear=2034" \
 -d "card.cvv=123" \
 -d "standingInstruction.mode=INITIAL" \
 -d "standingInstruction.source=CIT" \
 -d "standingInstruction.type=UNSCHEDULED" \
 -d "createRegistration=true" \
 -H "Authorization: Bearer OGE4Mjk0MTc0ZDA1OTViYjAxNGQwNWQ4MjllNzAxZDF8bk49a3NvQ3ROZjJacW9nOWYla0o="
```

--------------------------------

### GET /v1/checkouts/{id}/registration

Source: https://hyperpay.docs.oppwa.com/integrations/widget/registration-tokens

Retrieves the registration status after the tokenization process is complete.

```APIDOC
## GET /v1/checkouts/{id}/registration

### Description
Retrieves the status of a registration request using the resourcePath provided after redirection.

### Method
GET

### Endpoint
https://eu-test.oppwa.com/v1/checkouts/{id}/registration

### Parameters
#### Query Parameters
- **entityId** (string) - Required - The entity ID associated with the merchant.

### Request Example
curl -G https://eu-test.oppwa.com/v1/checkouts/{id}/registration \
 -d "entityId=8a8294174d0595bb014d05d829cb01cd" \
 -H "Authorization: Bearer OGE4Mjk0MTc0ZDA1OTViYjAxNGQwNWQ4MjllNzAxZDF8bk49a3NvQ3ROZjJacW9nOWYla0o="
```

--------------------------------

### Initiate Payment with MAC 03 Simulation

Source: https://hyperpay.docs.oppwa.com/integrations/mac-control

Perform a server-to-server POST request using an amount ending in .03 to trigger the MAC 03 decline simulation.

```curl
curl https://eu-test.oppwa.com/v1/payments \
 -d "entityId=Configuration not ready. Please reset in Administration > OPP > Developer Portal." \
 -d "amount=1234.03" \
 -d "paymentType=DB" \
 -d "currency=EUR" \
 -d "merchantTransactionId=OrderKIF0HDKEM7-MAC03" \
 -d "paymentBrand=VISA" \
 -d "card.holder=John Smith" \
 -d "card.number=4242428284137638" \
 -d "card.expiryMonth=12" \
 -d "card.expiryYear=2027" \
 -d "card.cvv=123" \
 -H "Authorization: Bearer OGE4Mjk0MTc0ZDA1OTViYjAxNGQwNWQ4MjllNzAxZDF8bk49a3NvQ3ROZjJacW9nOWYla0o="
```
Tokens:
Raw