OPPWA HyperPay

https://wordpresshyperpay.docs.oppwa.com/
Admin
OPPWA HyperPay is a payments orchestration platform that enables secure online and in-person payment...
Tokens:549,900
Snippets:5,308
Trust Score:7.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize OppPaymentProvider in Live Mode (Java)

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

Initialize the OppPaymentProvider with the live server mode using the provided context. This is necessary for production transactions.

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

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

### Airline Passenger Example

Source: https://wordpresshyperpay.docs.oppwa.com/parameters

Illustrates how to access and set airline passenger data. The index [n] should be replaced with the appropriate number, starting from 0.

```plaintext
airline.passengers[0].name=Jane Jones
```

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

### Initialize OPPPaymentProvider in Live Mode (Swift)

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

Initialize the OPPPaymentProvider with the live server mode for production use. Ensure you have obtained live credentials from your account manager.

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

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

### Enable Installment Payments (Kotlin)

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

Enable installment payments and set custom installment options for the checkout process. Default options are 1, 3, 5.

```kotlin
val checkoutSettings = CheckoutSettings(checkoutId, paymentBrands, providerMode) 

checkoutSettings.isInstallmentEnabled = true 
checkoutSettings.installmentOptions = arrayOf(1, 2, 3)

```

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

### Enable Installment Payments (Java)

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

Enable installment payments and set custom installment options for the checkout process. Default options are 1, 3, 5.

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

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

```

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

### Initialize OppPaymentProvider in Live Mode (Kotlin)

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

Initialize the OppPaymentProvider with the live server mode using the provided context. This is necessary for production transactions.

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

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

### Enable Installment Payments (Swift)

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

Enable installment payments and set custom installment options for the checkout process. Default options are 1, 3, 5.

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

```

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

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

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

Initialize the OPPPaymentProvider with the live server mode for production use. Ensure you have obtained live credentials from your account manager.

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

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

### Enable Installment Payments (Objective-C)

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

Enable installment payments and set custom installment options for the checkout process. Default options are 1, 3, 5.

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

```

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

### Initialize OPPPaymentProvider (Swift)

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui/bin-detection

Initialize the OPPPaymentProvider in test mode for Swift projects.

```Swift
self.provider = OPPPaymentProvider(mode: .test)

```

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

### Initialize OppPaymentProvider (Kotlin)

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui/bin-detection

Initialize the OppPaymentProvider in test mode for Kotlin projects.

```Kotlin
val paymentProvider = OppPaymentProvider(context, Connnect.ProviderMode.TEST)

```

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

### Resource Path Example

Source: https://wordpresshyperpay.docs.oppwa.com/integration-guide

This is an example of a resourcePath that can be used to retrieve payment status. It includes the checkout ID.

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

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

### Create CheckoutSettings (Java)

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/mobile-sdk/brand-configurations/venmo_payfast

Initialize `CheckoutSettings` with a checkout ID, payment brands, and provider mode. Then, set the brand configuration for Venmo Payfast.

```java
Set<String> paymentBrands = new LinkedHashSet<String>();
paymentBrands.add("VENMO_PAYFAST");
CheckoutSettings checkoutSettings = new CheckoutSettings(checkoutId, paymentBrands, Connect.ProviderMode.TEST);
checkoutSettings.setBrandConfig(brandConfig);
```

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

### Install Pods (iOS)

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

After updating your Podfile, run this command to install the Klarna Mobile SDK and other project dependencies.

```bash
pod install
```

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

### Initialize Klarna View (Java)

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

Initialize the KlarnaPaymentsView with the client token and return URL received from the transaction.

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

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

### Get Registration Status

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

After tokenization, the customer is redirected to your shopperResultUrl with a GET parameter 'resourcePath' to check the registration status.

```APIDOC
## Get Registration Status

Retrieve the status of the registration after the customer is redirected.

### Endpoint

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

### Parameters

*   **resourcePath** (string) - Query Parameter - The path to retrieve the registration status, provided as a GET parameter upon redirection.
*   **id** (string) - Path Parameter - The checkout ID.

### Request Example (cURL)

```bash
curl -G https://eu-test.oppwa.com/v1/checkouts/{id}/registration \
 -d "entityId=8ac7a4c79394bdc801939736f17e063d" \
 -H "Authorization: Bearer OGFjN2E0Yzc5Mzk0YmRjODAxOTM5NzM2ZjFhNzA2NDF8enlac1lYckc4QXk6bjYzI1NHNng="
```
```

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

### HTTP Response Example

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

An example of a successful HTTP response from the OPPWA API, demonstrating the JSON structure and common fields.

```APIDOC
## HTTP 200

### Response Body
```json
{
  "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"
}
```
```

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

### Initialize OppPaymentProvider (Java)

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui/bin-detection

Initialize the OppPaymentProvider in test mode for Java projects.

```Java
OppPaymentProvider paymentProvider = new OppPaymentProvider(context, Connnect.ProviderMode.TEST);

```

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

### Initialize Klarna View (Objective-C)

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

Initialize the KlarnaPaymentsView with the client token and return URL received from the transaction.

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

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

### Unload Widget Example with Button

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

An example demonstrating how to attach the `unloadWidget` function to a button click event and prepend it to the body.

```javascript
var unloadWidget = function() {
    if (window.wpwl !== undefined && window.wpwl.unload !== undefined) {
        window.wpwl.unload();
        $("script").each(function () {
            if (this.src.indexOf("static.min.js") !== -1) {
                $(this).remove();
            }
        });
    }
};
var $unloadButton = $("<button>Unload Widget</button>").on("click", unloadWidget);
$("body").prepend($unloadButton);
```

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

### Example error for Paypal Continue callback

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/widget/api

Shows an example error structure when Paypal invokes its onError callback during an inline flow.

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

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

### Initialize OPPPaymentProvider (Objective-C)

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/mobile-sdk/custom-ui/bin-detection

Initialize the OPPPaymentProvider in test mode for Objective-C projects.

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

```

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

### Import Swift Framework

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

Import the OPPWAMobile framework in your Swift project.

```swift
import OPPWAMobile
```

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

### COPYandPAY - Get Payment Status Throttling

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

Limits GET requests to the /v1/checkouts/{checkoutId}/payment endpoint to 2 per minute.

```http
GET /v1/checkouts/{checkoutId}/payment
max-amount-request: 2
time-unit: minute
```

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

### Import Objective-C Framework

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

Import the OPPWAMobile framework in your Objective-C project.

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

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

### Subsequent Payment - Installment Card on File

Source: https://wordpresshyperpay.docs.oppwa.com/recurring

Use this for subsequent payments in an installment plan when the customer is absent. Requires the initial transaction ID.

```text
* standingInstruction.mode=REPEATED
* standingInstruction.type=INSTALLMENT
* standingInstruction.source=MIT
* standingInstruction.initialTransactionId=123456780 // Note: This value is received in original CIT transaction response
```

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

### Initial Payment - Installment Card on File

Source: https://wordpresshyperpay.docs.oppwa.com/recurring

Use this for the initial payment of an installment plan when the customer is present. Requires customer authentication parameters.

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

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

### Initialize OPPWpwlOptions with Configuration (Swift)

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

Initializes `OPPWpwlOptions` with configuration and JavaScript functions for COPYandPAY integration. Use this to set options like locale and callbacks.

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

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

### Example Risk Webhook Payload

Source: https://wordpresshyperpay.docs.oppwa.com/tutorials/webhooks

This is an example of a risk webhook payload received from the system. It contains details about the transaction, card information, and risk assessment.

```json
{
 "type": "RISK",
  "payload": {
    "id": "8ac9a4a86461239601646522acb26523",
    "referencedId": "8ac9a4a86461239601646522aaf96510",
    "paymentType": "RI",
    "paymentBrand": "VISA",
    "presentationAmount": "0.0",
    "result": {
      "code": "000.000.000",
      "description": "Transaction succeeded"
    },
    "card": {
      "bin": "420000",
      "last4Digits": "0000",
      "holder": "Jane Jones",
      "expiryMonth": "03",
      "expiryYear": "2025"
    },
    "authentication": {
      "entityId": "8a8294174b7ecb28014b9699220015ca"
    },
    "redirect": {
      "parameters": []
    },
    "risk": {
      "score": ""
    },
    "timestamp": "2018-07-04 11:52:08+0000",
    "ndc": "8a8294174b7ecb28014b9699220015ca_b1539494024c411684b544574716e608",
    "channelName": "OPP_Channel",
    "source": "SYSTEM",
    "paymentMethod": "RM",
    "shortId": "3833.0396.7654"
  }
}
```

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

### Create CheckoutSettings (Kotlin)

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/mobile-sdk/brand-configurations/venmo_payfast

Initialize `CheckoutSettings` with a checkout ID, payment brands, and provider mode. Then, set the brand configuration for Venmo Payfast.

```kotlin
val paymentBrands = hashSetOf("VENMO_PAYFAST") 
val checkoutSettings = CheckoutSettings(checkoutId, paymentBrands, Connect.ProviderMode.TEST)
checkoutSettings.setBrandConfig(brandConfig)
```

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

### Get Payment Status

Source: https://wordpresshyperpay.docs.oppwa.com/mobile-sdk-server

Retrieve the status of a transaction by making a GET request to the specified endpoint using the checkout ID obtained from the prepare checkout step.

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

### Description
Retrieves the status of a payment transaction using the checkout ID.

### Method
GET

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

### Parameters
#### Path Parameters
- **id** (string) - Required - The checkout ID obtained from the prepare checkout step.

#### Query Parameters
- **entityId** (string) - Required - Your entity ID.

### Headers
- **Authorization**: Bearer [Your_Access_Token]

### Response
#### Success Response (200)
- **id** (string) - The transaction ID.
- **amount** (string) - The transaction amount.
- **currency** (string) - The transaction currency.
- **brand** (string) - The payment brand.
- **type** (string) - The payment type.

#### Response Example
```json
{
  "id": "checkout_id_from_prepare",
  "amount": "92.00",
  "currency": "EUR",
  "brand": "VISA",
  "type": "DB"
}
```
```

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

### Initialize Klarna View (Swift)

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

Initialize the KlarnaPaymentsView with the client token and return URL received from the transaction.

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

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

### 3. Get the payment status

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/sdr

Retrieve the final status of a payment after the shopper has been redirected. The `shopperResultUrl` will contain a `resourcePath` GET parameter that can be used to query the payment status.

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

### Description
Retrieve the status of a payment transaction. After a payment attempt, the shopper is redirected to the `shopperResultUrl` which includes a `resourcePath` parameter. This path can be used to query the payment's final status.

### Method
GET

### Endpoint
/v1/payments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the payment transaction.

#### Query Parameters
- **resourcePath** (string) - Provided as a GET parameter in the `shopperResultUrl`, used to construct the full API path for status retrieval.
```

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

### Prepare Checkout with Registrations

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

Initiate network token provisioning by sending a server-to-server POST request. Use this when you have stored card IDs from previous registrations.

```curl
curl https://eu-test.oppwa.com/v1/checkouts \
 -d "entityId=8ac7a4c79394bdc801939736f1e3064c" \
 -d "customParameters[3DS2_enrolled]=true" \
 -d "customParameters[3DS2_flow]=challenge" \
 -d "testMode=EXTERNAL" \
 -d "registrations[0].id=8ac7a4a19f7ef0d9019f8024c3c722b3" \
 -d "registrations[1].id=8ac7a4a19f7ef0d9019f8024c7e422d8" \
 -d "registrations[2].id=8ac7a49f9f7ef141019f8024ca302f46" \
 -d "amount=11.13" \
 -d "currency=EUR" \
 -d "paymentType=DB" \
 -d "standingInstruction.mode=REPEATED" \
 -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 OGFjN2E0Yzc5Mzk0YmRjODAxOTM5NzM2ZjFhNzA2NDF8enlac1lYckc4QXk6bjYzI1NHNng="
```

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

### Get SMS Status

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/paybylink

Retrieves the status of an SMS distribution associated with a payment link. This is done via a GET request to the SMS status resource path.

```APIDOC
## GET /paybylink/v1/{id}/sms/status

### Description
Retrieves the status of the SMS distribution for a given payment link.

### Method
GET

### Endpoint
/paybylink/v1/{id}/sms/status

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the payment link.

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

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```curl
curl -G https://eu-test.oppwa.com/paybylink/v1/{id}/sms/status \
 -d "entityId=8ac7a4c79394bdc801939736f1d10646" \
 -H "Authorization: Bearer OGFjN2E0Yzc5Mzk0YmRjODAxOTM5NzM2ZjFhNzA2NDF8enlac1lYckc4QXk6bjYzI1NHNng="
```

### Response
#### Success Response (200)
- The response will contain the status details of the SMS distribution. (Specific fields not detailed in source)
```

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

### Initiate Initial Payment

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

This snippet shows how to send the initial payment for a Card on File transaction. It includes parameters for standing instructions like mode, type, and source, along with transaction details.

```APIDOC
## POST /v1/registrations/{id}/payments

### Description
Initiates the first payment in a Card on File (CoF) transaction series. This is used for setting up recurring or installment payments where the card details are stored securely.

### Method
POST

### Endpoint
/v1/registrations/{id}/payments

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the registration to which the payment will be associated.

#### Query Parameters
None

#### Request Body
- **entityId** (string) - Required - The entity ID for the payment gateway.
- **amount** (string) - Required - The transaction amount.
- **currency** (string) - Required - The currency of the transaction (e.g., EUR).
- **paymentType** (string) - Required - The type of payment (e.g., PA for pre-authorization).
- **standingInstruction.mode** (string) - Required - The mode for standing instructions (e.g., REPEATED).
- **standingInstruction.type** (string) - Required - The type of standing instruction (e.g., UNSCHEDULED).
- **standingInstruction.source** (string) - Required - The source of the standing instruction (e.g., MIT for Merchant Initiated Transaction).

### Request Example
```json
{
  "entityId": "8ac7a4c79394bdc801939736f17e063d",
  "amount": "92.00",
  "currency": "EUR",
  "paymentType": "PA",
  "standingInstruction.mode": "REPEATED",
  "standingInstruction.type": "UNSCHEDULED",
  "standingInstruction.source": "MIT"
}
```

### Response
#### Success Response (200)
(Response details not provided in source)

#### Response Example
(Response example not provided in source)
```

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

### Initial Card on File Payment Request (cURL)

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

This cURL command demonstrates an initial payment request for Card on File. It includes parameters for storing payment details for future use, such as 'standingInstruction.mode=INITIAL', 'standingInstruction.source=CIT', and 'standingInstruction.type=UNSCHEDULED'. The 'createRegistration=true' parameter is crucial for storing the card details.

```cURL
curl https://eu-test.oppwa.com/v1/payments \
 -d "entityId=8ac7a4c79394bdc801939736f17e063d" \
 -d "amount=92.00" \
 -d "currency=EUR" \
 -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 OGFjN2E0Yzc5Mzk0YmRjODAxOTM5NzM2ZjFhNzA2NDF8enlac1lYckc4QXk6bjYzI1NHNng="
```

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

### Schedule Webhook Notification Example

Source: https://wordpresshyperpay.docs.oppwa.com/tutorials/webhooks

Example of a webhook notification for a scheduled payment event. It details the scheduled transaction, including its ID, registration ID, and payment information.

```json
{
  "type": "SCHEDULE",
  "payload": {
    "id": "8acda4a489919d63018996faf10b2a66",
    "registrationId": "8acda4a889919e5e018996f86a8f127a",
    "paymentType": "SD",
    "presentationAmount": "92.00",
    "presentationCurrency": "EUR",
    "result": {
      "code": "000.000.000",
      "description": "Transaction succeeded",
      "randomField1730751282": "Please allow for new unexpected fields to be added"
    },
    "resultDetails": {
      "ConnectorTxID1": "8acda4a489919d63018996faf10b2a66"
    },
    "customer": {
         "givenName":"Jones",
         "surname":"Jane",
         "merchantCustomerId":"jjones",
         "sex":"F",
         "email":"jane@jones.com"
    },
    "authentication": {
      "entityId": "8a8294174b7ecb28014b9699220015ca"
    },
    "redirect": {
      "parameters": []
    },
    "risk": {
      "score": ""
    },
    "timestamp": "2023-07-27 10:52:55+0000",
    "ndc": "ef2c099f5b29455a9dbd260c59bcc224",
    "channelName": "OPP_Channel",
    "source": "SCHEDULER",
    "paymentMethod": "DC",
    "shortId": "3833.0396.7654"
  }
}

```

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

### Initialize Payment Provider for Live Mode (Objective-C)

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

Configure the OPPPaymentProvider to use live credentials by setting the mode to OPPProviderModeLive in Objective-C.

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

```

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

### Registration Webhook Notification Example

Source: https://wordpresshyperpay.docs.oppwa.com/tutorials/webhooks

Example of a webhook notification for a registration event, indicating that a new registration has been created. It includes details about the registration and associated card information.

```json
{
   "type":"REGISTRATION",
   "action": "CREATED",
   "payload":{
      "id":"8a82944a53e6a0150153eaf693584262",
      "paymentBrand":"VISA",
      "result":{
         "code":"000.000.000",
         "description":"Transaction succeeded",
         "randomField1315125026":"Please allow for new unexpected fields to be added"
      },
      "card":{
         "bin":"420000",
         "last4Digits":"0000",
         "holder":"Jane Jones"
      },
      "authentication":{
         "entityId":"8a8294174b7ecb28014b9699220015ca"
      },
      "redirect":{
         "parameters":[

         ]
      },
      "risk":{
         "score":""
      },
      "timestamp":"2016-04-06 09:45:41+0000",
      "ndc":"8a8294174b7ecb28014b9699220015ca_b1539494024c411684b544574716e608",
      "channelName": "OPP_Channel",
      "source": "SYSTEM",
      "paymentMethod": "CC",
      "shortId": "7820.6916.2918"
   }
}

```

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

### Initialize Klarna View (Kotlin)

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

Initialize the KlarnaPaymentsView with the client token and return URL received from the transaction.

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

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

### Payment Webhook Notification Example

Source: https://wordpresshyperpay.docs.oppwa.com/tutorials/webhooks

Example of a webhook notification for a successful payment event. It contains detailed information about the transaction, authentication, card, customer, and risk assessment.

```json
{
   "type":"PAYMENT",
   "payload":{
      "id":"8a829449515d198b01517d5601df5584",
      "paymentType":"PA",
      "paymentBrand":"VISA",
      "amount":"92.00",
      "currency":"EUR",
      "presentationAmount":"92.00",
      "presentationCurrency":"EUR",
      "descriptor":"3017.7139.1650 OPP_Channel ",
      "result":{
         "code":"000.000.000",
         "description":"Transaction succeeded"
      },
      "authentication":{
         "entityId":"8a8294185282b95b01528382b4940245"
      },
      "card":{
         "bin":"420000",
         "last4Digits":"0000",
         "holder":"Jane Jones",
         "expiryMonth":"05",
         "expiryYear":"2018"
      },
      "customer":{
         "givenName":"Jones",
         "surname":"Jane",
         "merchantCustomerId":"jjones",
         "sex":"F",
         "email":"jane@jones.com"
      },
      "customParameters":{
         "SHOPPER_promoCode":"AT052"
      },
      "risk":{
         "score":"0"
      },
      "buildNumber":"ec3c704170e54f6d7cf86c6f1969b20f6d855ce5@2015-12-01 12:20:39 +0000",
      "timestamp":"2015-12-07 16:46:07+0000",
      "ndc":"8a8294174b7ecb28014b9699220015ca_66b12f658442479c8ca66166c4999e78",
      "channelName": "OPP_Channel",
      "source": "SYSTEM",
      "paymentMethod": "CC",
      "shortId": "5420.6916.5424"
  }
}

```

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

### Android Asset Links JSON Example

Source: https://wordpresshyperpay.docs.oppwa.com/integrations/mobile-sdk/brand-configurations/paypal-payfast

Example of an assetlinks.json file used for Android App Link registration. This file associates your app with your website for deep linking.

```json
[
{
  "relation": ["delegate_permission/common.handle_all_urls"],
  "target": {
    "namespace": "android_app",
    "package_name": "com.example",
// This should be the SHA256 fingerprints of your app's signing certificate.
    "sha256_cert_fingerprints":
    ["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"]
  }
}]
}
```
Tokens:
Raw