### Software Header Example

Source: https://docs.buckaroo.io/docs/json-authenticator

An example of the 'Software' header, used to define the client application details.

```json
{"PlatformName":"X","PlatformVersion":"1.0","ModuleSupplier":"X","ModuleName":"X","ModuleVersion":"1.0"}
```

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

### Install Buckaroo SDK

Source: https://docs.buckaroo.io/docs/python-sdk

Install the Buckaroo SDK using pip. Ensure you have Python 3.8 or newer.

```bash
pip install buckaroo-sdk
```

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

### Install Laravel Buckaroo Wrapper with Composer

Source: https://docs.buckaroo.io/docs/laravel-wrapper

Install the Laravel Buckaroo Wrapper using Composer. This is the recommended method for integration.

```bash
$ composer require buckaroo/laravel-buckaroo:^1.0
```

```json
{
    "require": {
        "buckaroo/laravel-laravel": "^1.0"
    }
}
```

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

### Initialize SdkClient in Setup Method

Source: https://docs.buckaroo.io/docs/net-sdk

This snippet shows how to initialize the SdkClient in a test setup method. The BuckarooClient property will be used for SDK interactions.

```csharp
internal SdkClient BuckarooClient { get; private set; }

[TestInitialize]
public void Setup()
{
	this.BuckarooClient = new SdkClient();
}
```

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

### Install Buckaroo Node SDK

Source: https://docs.buckaroo.io/docs/node-sdk

Install the Buckaroo Node.js SDK using npm. This command adds the necessary package to your project dependencies.

```plaintext
npm install @buckaroo/buckaroo_sdk
```

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

### Composer Installation for Buckaroo Plugin

Source: https://docs.buckaroo.io/docs/shopware-6-installation

Execute this command from your Shopware 6 root directory to install the Buckaroo extension using Composer. Ensure Composer is installed on your server.

```shell
composer require buckaroo/shopware6
bin/console plugin:refresh
bin/console plugin:install --activate BuckarooPayments
bin/console cache:clear
```

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

### CreatePaymentPlan

Source: https://docs.buckaroo.io/docs/steps-and-example-createpaymentplan

This operation allows you to create a payment plan for a customer, specifying details like invoices, installment amounts, and start dates.

```APIDOC
## CreatePaymentPlan

### Description
Creates a payment plan by specifying involved invoices, dossier number, installment details, start date, interval, cost amounts, and recipient email.

### Method
POST (inferred from example structure)

### Endpoint
(Not explicitly provided, inferred from context)

### Parameters
#### Request Body
- **IncludedInvoiceKey** (String) - Required - Comma-separated list of involved invoice keys.
- **DossierNumber** (String) - Required - Number of the to be created dossier/file.
- **InstallmentCount** (Integer) - Optional - Number of installments.
- **InstallmentAmount** (Decimal) - Optional - Amount for each installment.
- **InitialAmount** (Decimal) - Optional - Amount for the first installment.
- **StartDate** (Date) - Required - Start date of the payment plan.
- **Interval** (String) - Required - Interval between each installment.
- **PaymentPlanCostAmount** (Decimal) - Required - Amount of payment plan cost.
- **PaymentPlanCostAmountVat** (Decimal) - Optional - VAT amount of payment plan cost.
- **RecipientEmail** (String) - Required - Debtor email.
- **AllowedServices** (String) - Optional - Allowed payment methods. Comma-separated list of service codes.

### Request Example
```json
{
   "Description": "Payment in two intstallments",
   "Services": {
      "ServiceList": [
         {
            "Name": "CreditManagement3",
            "Action": "CreatePaymentPlan",
            "Parameters": [
               {
                  "Name": "IncludedInvoiceKey",
                  "Value": "20D09973FB5C4DBC9A33DB0F4F707xxx"
               },
               {
                  "Name": "DossierNumber",
                  "Value": "PaymentplanJohnsmith123"
               },
               {
                  "Name": "InstallmentCount",
                  "Value": "2"
               },
               {
                  "Name": "StartDate",
                  "Value": "2017-09-21"
               },
               {
                  "Name": "Interval",
                  "Value": "Day"
               },
               {
                  "Name": "PaymentPlanCostAmount",
                  "Value": "0.00"
               },
               {
                  "Name": "RecipientEmail",
                  "Value": "johnsmith@example.nl"
               }
            ]
         }
      ]
   }
}
```

### Response
#### Success Response (200)
- **Key** (String) - The unique key of the created payment plan.
- **Status** (Object) - The status of the transaction.
- **RequiredAction** (null) - Indicates if any further action is required.
- **Services** (Array) - Details about the services used.
- **CustomParameters** (null) - Custom parameters associated with the response.
- **AdditionalParameters** (null) - Additional parameters.
- **RequestErrors** (null) - Any errors encountered during the request.
- **ServiceCode** (String) - The service code used.
- **IsTest** (Boolean) - Indicates if the transaction was a test.
- **ConsumerMessage** (null) - A message for the consumer.

#### Response Example
```json
{
   "Key": "9E5E5D160C814C3D94DD9283978ABxxx",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2017-09-19T16:59:00"
   },
   "RequiredAction": null,
   "Services": [
      {
         "Name": "CreditManagement3",
         "Action": null,
         "Parameters": [
                {
                    "Name": "InvoiceKey",
                    "Value": "F8F6D18XXXXXXXXXXXXXXXXXD7DC2AB4,0F10849XXXXXXXXXXXXXXXXXXFAC3F96"
                },
                {
                    "Name": "DebtorGuid",
                    "Value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
                },
                {
                    "Name": "InvoicePayLink",
                    "Value": "https://testcheckout.buckaroo.nl/html/?brq_paydirect_inv=0F10849XXXXXXXXXXXXXXXXXXFAC3F96"
                }
            ]
        }
    ],
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "ServiceCode": "CreditManagement3",
   "IsTest": true,
   "ConsumerMessage": null
}
```
```

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

### Mounting Hosted Fields

Source: https://docs.buckaroo.io/docs/creditcards-hosted-fields

This example demonstrates how to mount the hosted fields for credit card input. Ensure the SDK is loaded before mounting.

```javascript
import { mount } from "@buckaroo/buckaroo-sdk";

const mountHostedFields = async () => {
    const hostedFields = await mount(
        "#hosted-fields-container",
        "#hosted-fields-card-number",
        "#hosted-fields-expiry",
        "#hosted-fields-cvc"
    );

    return hostedFields;
};

mountHostedFields();
```

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

### Example DebtorInfo Request

Source: https://docs.buckaroo.io/docs/example-debtorinfo

This JSON payload demonstrates how to structure a request to the Buckaroo API to get debtor information. It specifies the 'DebtorInfo' action and includes the 'DebtorCode' as a required parameter.

```json
{
   "Services": {
      "ServiceList": [
         {
            "Name": "CreditManagement3",
            "Action": "DebtorInfo",
            "Parameters": [
               {
                  "Name": "DebtorCode",
                  "GroupType": "Debtor",
                  "GroupID": "",
                  "Value": "JanVanPietersen123"
               }
            ]
         }
      ]
   }
}
```

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

### Create Payment Plan Request

Source: https://docs.buckaroo.io/docs/steps-and-example-createpaymentplan

This JSON object demonstrates how to structure a request to create a payment plan. It includes parameters like invoice key, dossier number, installment count, start date, interval, cost amount, and recipient email.

```json
{
   "Description": "Payment in two intstallments",
   "Services": {
      "ServiceList": [
         {
            "Name": "CreditManagement3",
            "Action": "CreatePaymentPlan",
            "Parameters": [
               {
                  "Name": "IncludedInvoiceKey",
                  "Value": "20D09973FB5C4DBC9A33DB0F4F707xxx"
               },
               {
                  "Name": "DossierNumber",
                  "Value": "PaymentplanJohnsmith123"
               },
               {
                  "Name": "InstallmentCount",
                  "Value": "2"
               },
               {
                  "Name": "StartDate",
                  "Value": "2017-09-21"
               },
               {
                  "Name": "Interval",
                  "Value": "Day"
               },
               {
                  "Name": "PaymentPlanCostAmount",
                  "Value": "0.00"
               },
               {
                  "Name": "RecipientEmail",
                  "Value": "johnsmith@example.nl"
               }
            ]
         }
      ]
   }
}
```

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

### Example Debtor File Push Notification

Source: https://docs.buckaroo.io/docs/credit-management-debtor-collection

This JSON payload represents a push notification for an invoice that is part of a Debtor File. It includes details about the invoice and specific parameters related to the Debtor File, such as its GUID, number, and pay link. This is typically sent when an event like 'SentReminderMessage' occurs.

```json
{
  "Invoice": {
    "InvoiceKey": "E3409F142BD94BB3B8047A73",
    "InvoiceNumber": "INV0001",
    "WebsiteKey": "vcKCNXSCDw",
    "DebtorCode": "JohnSmith123",
    "DebtorGuid": "903FADD72ABC4A6E91FCA5AE4",
    "SchemeKey": "abc123",
    "IsTest": false,
    "Type": "RegularInvoice",
    "Culture": "nl-NL",
    "InvoiceDate": "2021-10-01T00:00:00",
    "DueDate": "2021-10-01T00:00:00",
    "InvoiceStatusCode": 10,
    "PreviousStepIndex": 1,
    "PreviousStepDateTime": "2021-11-18T14:04:03",
    "InvoicePayLink": http://checkout.local/html/?brq_paydirect_inv=XXX,
    "Event": "SentReminderMessage",
    "EventCategory": "Other",
    "EventDateTime": "2021-11-18T14:06:29.7783014",
    "EventParameters": [
      {
        "Key": "CommunicationMethod",
        "Value": "Email"      },
      {
        "Key": "Template",
        "Value": "_Buckaroo.DebtorCollectionReminder.en.html"      }
    ],
    "Currency": "EUR",
    "AmountDebit": 0.0500,
    "AmountCredit": 0.0000,
    "AmountAdminCosts": 0.0000,
    "AmountCreditNotes": 0.0,
    "AmountPaid": 0.0,
    "AmountAdminCostsPaid": 0.0,
    "AmountPendingSlow": 0.0,
    "OpenAmount": 0.0500,
    "OpenAmountAdminCosts": 0.0000,
    "OpenAmountInclAdminCosts": 0.0500,
    "IsPaid": false,
    "CustomParameters": [
    ],
    "AdditionalParameters": [
    ],
    "DebtorFileGuid": "3B82F6ECDC1D4CF5BC856",
    "DebtorFileNumber": "DNR000000106",
    "DebtorFilePayLink": http://checkout.local/html/?brq_paydirect_debtor_file=123 }
}
```

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

### Java Payment Parameters Setup

Source: https://docs.buckaroo.io/docs/payment

Set up payment and configuration parameters for an app-to-app payment request in Java. Use this for initializing transaction details and enabling/disabling UI elements.

```java
PaymentParameters paymentParameters = new PaymentParameters();
paymentParameters.setAmount(100);
paymentParameters.setTransactionId(12312312314); // -> For Void and Refund Transactions Only!!
paymentParameters.setOrderId("09bda71c6-a4b1-414b-97ec-5d36873216f2");
paymentParameters.setTransactionType(200);
app2AppRequest.setPaymentParameters(paymentParameters);

ConfigParameters configParameters = new ConfigParameters();
configParameters.setDrawerMenuEnabled(true);
configParameters.setSalesButtonEnabled(true);
configParameters.setVoidButtonEnabled(true);
configParameters.setRefundButtonEnabled(true);
configParameters.setHistoryButtonEnabled(true);
configParameters.setSettingsButtonEnabled(false);
configParameters.setSettlementButtonEnabled(false);
configParameters.setTipScreenEnabled(false);
configParameters.setUserPhotoEnabled(false);
configParameters.setWorkingMode(0);
configParameters.setTimeout(-1);
// if timeout set to lower than zero, there is no timeout
// if time out set to greater than zero, softPOS will wait for that second value.

app2AppRequest.setConfigParameters(configParameters);

app2AppService.getPayment(app2AppRequest, eventListener);
```

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

### Create and Configure Buckaroo Client

Source: https://docs.buckaroo.io/docs/php-sdk

Initialize the Buckaroo client with your store and secret keys obtained from the Buckaroo Plaza.

```php
require __DIR__ . '/vendor/autoload.php';

# Get your store & secret key in your plaza.
$buckaroo = new 
\Buckaroo\BuckarooClient('STORE_KEY', 'SECRET_KEY');
```

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

### Example Authorization Header

Source: https://docs.buckaroo.io/docs/json-authenticator

An example of a correctly formatted Authorization header for HMAC authentication.

```plaintext
Authorization: hmac ABCD1234:WISKbwwMbWhMRSRJc0jFtg/LIvB9vM5VWPvfVa0JnMc=:134ee2ec5c9d43d7acfae9190ec7eb83:1434973589
```

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

### Java Call Example for Only Register

Source: https://docs.buckaroo.io/docs/only-register

Demonstrates how to initiate a registration-only request using the App2AppRequest object in Java. Ensure App2AppService and eventListener are properly initialized.

```java
App2AppRequest app2AppRequest = new App2AppRequest();

RegisterParameters registerParameters = new RegisterParameters();
registerParameters.setMerchantId("SOFTPOSMERCHANT");
registerParameters.setTerminalId("TERMINAL); 
registerParameters.setActivationCode("123456");
app2AppRequest.setRegisterParameters(registerParameters);

app2AppService.getOnlyRegister(app2appRequest, eventListener);
```

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

### Provide Custom Logger to SdkClient

Source: https://docs.buckaroo.io/docs/net-sdk

This example demonstrates how to provide a custom logger implementation to the SdkClient. The logger can be specified during client initialization.

```csharp
// Example for a function that returns a custom implemented logger,
// which can be provided in the constructor  like this:
// this.BuckarooClient = new SdkClient(TestSettings.Logger);
internal static Func<ILogger>
{
	get { return () => new CustomImplementationLogger(); }
}
```

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

### StopSubscription Response Example

Source: https://docs.buckaroo.io/docs/subscriptions-requests

This is an example of a successful response when stopping a subscription. It includes status codes and timestamps.

```json
{
  "Key": "ECA987898C654F4F9D554AD1E62B4xxx",
  "Status": {
    "Code": {
      "Code": 190,
      "Description": "Success"
    },
    "SubCode": {
      "Code": "S001",
      "Description": "Transaction successfully processed"
    },
    "DateTime": "2018-04-25T17:28:53"
  },
  "RequiredAction": null,
  "Services": null,
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "ServiceCode": "Subscriptions",
  "IsTest": true,
  "ConsumerMessage": null
}
```

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

### Twint Refund Response Example

Source: https://docs.buckaroo.io/docs/twint-requests

This is an example of a successful Twint refund response, confirming the refund transaction details.

```json
{
    "Key": " A5119DE5DE0144AF9EC99D886269123",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
        },
        "DateTime": "2020-01-08T16:05:56"
    },
    "RequiredAction": null,
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "testinvoice 123",
    "ServiceCode": " Twint",
    "IsTest": true,
    "Currency": "CHF",
    "AmountCredit": 1.0,
    "TransactionType": "C406",
    "MutationType": 1,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "948547CF2D8E456ABF3E84A948D62DAA "
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "4090E8741FE44442A09096D64E29345"
}
```

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

### Initialize Buckaroo Client

Source: https://docs.buckaroo.io/docs/node-sdk

Initialize the Buckaroo client with your secret and store keys. Configure test/live mode, currency, and return/push URLs.

```javascript
import Buckaroo from '@buckaroo/buckaroo_sdk';

const buckarooClient = Buckaroo.InitializeClient(
    {
        secretKey: 'KEY',
        websiteKey: 'SECRET',
    },
    {
        mode: 'TEST', // OR 'LIVE'
        currency: 'EUR',
        returnURL: 'RETURN_URL',
        pushURL: 'PUSH_URL',
    }
);
```

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

### Bancontact PayRecurring Response Example

Source: https://docs.buckaroo.io/docs/bancontact-requests

This is an example of a successful response after initiating a PayRecurring transaction. It contains transaction details and status.

```json
{
  "Key": "CA9A4CB1C1F1430AAC71D63562XXXXXX",
  "Status": {
    "Code": {
      "Code": 190,
      "Description": "Success"
    },
    "SubCode": {
      "Code": "S990",
      "Description": "The request was successful."
    },
    "DateTime": "2020-06-03T14:42:43"
  },
  "RequiredAction": null,
  "Services": null,
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "Invoice": "testinvoice 123",
  "ServiceCode": "bancontactmrcash",
  "IsTest": true,
  "Currency": "EUR",
  "AmountDebit": 10.0,
  "TransactionType": "C094",
  "MutationType": 1,
  "RelatedTransactions": null,
  "ConsumerMessage": null,
  "Order": null,
  "IssuingCountry": null,
  "StartRecurrent": false,
  "Recurring": false,
  "CustomerName": null,
  "PayerHash": null,
  "PaymentKey": "1E3F1CCEFE394410904AD41146XXXXXX"
}
```

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

### Initialize PayPal with Buckaroo SDK

Source: https://docs.buckaroo.io/docs/client-sdk

This snippet shows how to initialize the PayPal payment flow using the Buckaroo SDK. It includes mandatory and optional configuration parameters for the PayPalOptions object.

```javascript
$(document).ready(function() {
    let PayPalOptions = {
      containerSelector: "#paypal-container",
      buckarooWebsiteKey: "{{your_websitekey}}",
      paypalMerchantId: "{{your_PayPalMerchantId}}",
      currency: "EUR",
      amount: 0.01,
      createPaymentHandler: createPaymentHandler,
      onShippingChangeHandler: onShippingChangeHandler,
      onSuccessCallback: onSuccessCallback,
      onErrorCallback: onErrorCallback,
      onCancelCallback: onCancelCallback,
      onInitCallback: onInitCallback,
      onClickCallback: onClickCallback,
    };

    BuckarooSdk.PayPal.initiate(PayPalOptions);
});
```

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

### Activate and Update Buckaroo Magento 1 Extension

Source: https://docs.buckaroo.io/docs/magento-1-installation

Copy the plugin files to your Magento installation and activate the extension after Composer installation.

```shell
cp -ra vendor/buckaroo/magento1/app/* YOUR_MAGENTO_INSTALLATION_ROOT/appcp -ra vendor/buckaroo/magento1/skin/* YOUR_MAGENTO_INSTALLATION_ROOT/skin
```

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

### Initialize Google Pay Button

Source: https://docs.buckaroo.io/docs/googlepay-integration

Demonstrates how to initialize the Google Pay button using the Buckaroo SDK. This includes setting the environment and button display properties.

```javascript
function initGooglePayButton() {
    const googlePayPayment = new BuckarooSdk.GooglePay.GooglePayPayment({
        environment: 'TEST',
        buttonRadius: 7,
        buttonSizeMode: 'fill',
```

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

### Initialize Buckaroo Client

Source: https://docs.buckaroo.io/docs/python-sdk

Initialize the Buckaroo client using environment variables for store and secret keys. Use 'test' mode for development and 'live' for production.

```python
import os
from buckaroo.app import Buckaroo

app = Buckaroo.quick_setup(
    store_key=os.environ["BUCKAROO_STORE_KEY"],
    secret_key=os.environ["BUCKAROO_SECRET_KEY"],
    mode="test",   # use "live" in production
)
```

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

### PayPal Push Transaction Example

Source: https://docs.buckaroo.io/docs/paypal-requests

This snippet shows an example of a successful PayPal transaction push, including all relevant details and parameters.

```APIDOC
## POST /paypal/push

### Description
This endpoint facilitates the push of PayPal transaction data, including details about the transaction, service parameters, and related transactions.

### Method
POST

### Endpoint
/paypal/push

### Parameters
#### Request Body
- **Transaction** (object) - Required - Contains all details of the PayPal transaction.
  - **Key** (string) - Required - Unique identifier for the transaction.
  - **Invoice** (string) - Required - The invoice number associated with the transaction.
  - **ServiceCode** (string) - Required - The service code, expected to be 'paypal'.
  - **Status** (object) - Required - The status of the transaction.
    - **Code** (object) - Required - The main status code.
      - **Code** (integer) - Required - The status code number.
      - **Description** (string) - Required - A description of the status code.
    - **SubCode** (object) - Optional - The sub-code for more specific status information.
      - **Code** (string) - Required - The sub-code string.
      - **Description** (string) - Required - A description of the sub-code.
    - **DateTime** (string) - Required - The date and time when the status was recorded (ISO 8601 format).
  - **IsTest** (boolean) - Required - Indicates if the transaction is a test transaction.
  - **Order** (object | null) - Optional - Order details if applicable.
  - **Currency** (string) - Required - The currency of the transaction amount.
  - **AmountDebit** (number) - Required - The amount debited in the transaction.
  - **TransactionType** (string) - Required - The type of transaction.
  - **Services** (array) - Required - An array of services used in the transaction.
    - **Name** (string) - Required - The name of the service (e.g., 'paypal').
    - **Action** (string | null) - Optional - The action performed by the service.
    - **Parameters** (array) - Required - An array of parameters for the service.
      - **Name** (string) - Required - The name of the parameter.
      - **Value** (string) - Required - The value of the parameter.
  - **CustomParameters** (object | null) - Optional - Custom parameters for the transaction.
  - **AdditionalParameters** (object | null) - Optional - Additional parameters for the transaction.
  - **MutationType** (integer) - Required - The type of mutation.
  - **RelatedTransactions** (array) - Optional - An array of related transactions.
    - **RelationType** (string) - Required - The type of relation.
    - **RelatedTransactionKey** (string) - Required - The key of the related transaction.
  - **IsCancelable** (boolean) - Required - Indicates if the transaction is cancelable.
  - **IssuingCountry** (string | null) - Optional - The issuing country of the payment instrument.
  - **StartRecurrent** (boolean) - Required - Indicates if the transaction starts a recurring payment.
  - **Recurring** (boolean) - Required - Indicates if the transaction is part of a recurring payment.
  - **CustomerName** (string) - Required - The name of the customer.
  - **PayerHash** (string | null) - Optional - A hash of the payer.
  - **PaymentKey** (string) - Required - The payment key for the transaction.

### Request Example
```json
{
    "Transaction": {
      "Key": "C123FD5003FA407297A39C46D0XXXXXX",
      "Invoice": "testinvoice 123",
      "ServiceCode": "paypal",
      "Status": {
        "Code": {
          "Code": 190,
          "Description": "Success"
        },
        "SubCode": {
          "Code": "P904",
          "Description": "The PayPal payment has been completed."
        },
        "DateTime": "2026-05-22T17:12:11"
      },
      "IsTest": true,
      "Order": null,
      "Currency": "EUR",
      "AmountDebit": 10.0,
      "TransactionType": "V107",
      "Services": [
        {
          "Name": "paypal",
          "Action": null,
          "Parameters": [
            { "Name": "orderId",             "Value": "3C786053MK04XXXXX"   },
            { "Name": "paypalCaptureId",     "Value": "8XW27145C8910230F"   },
            { "Name": "paypalTransactionID", "Value": "8XW27145C8910230F"   },
            { "Name": "payerEmail",          "Value": "johnsmith@gmail.com" },
            { "Name": "payerFirstname",      "Value": "John"                },
            { "Name": "payerLastname",       "Value": "Smith"               },
            { "Name": "payerCountry",        "Value": "NL"                  },
            { "Name": "address_line_1",      "Value": "1 Main St"           },
            { "Name": "admin_area_2",        "Value": "Amsterdam"           },
            { "Name": "postal_code",         "Value": "1011AA"              },
            { "Name": "VersionAsProperty",   "Value": "2"                   }
          ]
        }
      ],
      "CustomParameters": null,
      "AdditionalParameters": null,
      "MutationType": 2,
      "RelatedTransactions": [
        {
          "RelationType": "capture",
          "RelatedTransactionKey": "8E04704995B74D679AACC59F87XXXXXX"
        }
      ],
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": "John Smith",
      "PayerHash": null,
      "PaymentKey": "9E66009180A245F99987E4972AXXXXXX"
    }
  }
```

### Response
#### Success Response (200)
- **Transaction** (object) - Contains the processed transaction details.
  - **Key** (string) - Unique identifier for the transaction.
  - **Invoice** (string) - The invoice number.
  - **ServiceCode** (string) - The service code used.
  - **Status** (object) - The status of the transaction.
    - **Code** (object)
      - **Code** (integer)
      - **Description** (string)
    - **SubCode** (object)
      - **Code** (string)
      - **Description** (string)
    - **DateTime** (string) - ISO 8601 format.
  - **IsTest** (boolean)
  - **Order** (object | null)
  - **Currency** (string)
  - **AmountDebit** (number)
  - **TransactionType** (string)
  - **Services** (array)
    - **Name** (string)
    - **Action** (string | null)
    - **Parameters** (array)
      - **Name** (string)
      - **Value** (string)
  - **CustomParameters** (object | null)
  - **AdditionalParameters** (object | null)
  - **MutationType** (integer)
  - **RelatedTransactions** (array)
    - **RelationType** (string)
    - **RelatedTransactionKey** (string)
  - **IsCancelable** (boolean)
  - **IssuingCountry** (string | null)
  - **StartRecurrent** (boolean)
  - **Recurring** (boolean)
  - **CustomerName** (string)
  - **PayerHash** (string | null)
  - **PaymentKey** (string)

#### Response Example
```json
{
  "Transaction": {
    "Key": "C123FD5003FA407297A39C46D0XXXXXX",
    "Invoice": "testinvoice 123",
    "ServiceCode": "paypal",
    "Status": {
      "Code": {
        "Code": 190,
        "Description": "Success"
      },
      "SubCode": {
        "Code": "P904",
        "Description": "The PayPal payment has been completed."
      },
      "DateTime": "2026-05-22T17:12:11"
    },
    "IsTest": true,
    "Order": null,
    "Currency": "EUR",
    "AmountDebit": 10.0,
    "TransactionType": "V107",
    "Services": [
      {
        "Name": "paypal",
        "Action": null,
        "Parameters": [
          { "Name": "orderId",             "Value": "3C786053MK04XXXXX"   },
          { "Name": "paypalCaptureId",     "Value": "8XW27145C8910230F"   },
          { "Name": "paypalTransactionID", "Value": "8XW27145C8910230F"   },
          { "Name": "payerEmail",          "Value": "johnsmith@gmail.com" },
          { "Name": "payerFirstname",      "Value": "John"                },
          { "Name": "payerLastname",       "Value": "Smith"               },
          { "Name": "payerCountry",        "Value": "NL"                  },
          { "Name": "address_line_1",      "Value": "1 Main St"           },
          { "Name": "admin_area_2",        "Value": "Amsterdam"           },
          { "Name": "postal_code",         "Value": "1011AA"              },
          { "Name": "VersionAsProperty",   "Value": "2"                   }
        ]
      }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "MutationType": 2,
    "RelatedTransactions": [
      {
        "RelationType": "capture",
        "RelatedTransactionKey": "8E04704995B74D679AACC59F87XXXXXX"
      }
    ],
    "IsCancelable": false,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": "John Smith",
    "PayerHash": null,
    "PaymentKey": "9E66009180A245F99987E4972AXXXXXX"
  }
}
```
```

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

### Trustly Push Request Example

Source: https://docs.buckaroo.io/docs/trustly-requests

This JSON represents an example of a push request from Trustly, detailing a transaction with pending processing status.

```json
{
   "Transaction": {
      "Key": "A5119DE5DE0144AF9EC99D886269xxx",
      "Invoice": "Testinvoice 123",
      "ServiceCode": "Trustly",
      "Status": {
         "Code": {
            "Code": 791,
            "Description": "Pending processing"
         },
         "SubCode": {
            "Code": "C000",
            "Description": "Pending processing"
         },
         "DateTime": "2020-01-08T15:32:40"
      },
      "IsTest": true,
      "Order": null,
      "Currency": "EUR",
      "AmountDebit": 10,
      "TransactionType": "C054",
      "Services": [
         {
            "Name": "Trustly",
            "Action": null,
            "Parameters": [
               {
                  "Name": "BankStatementId",
                  "Value": "WKV 3QZIxx7"
               }
            ],
            "VersionAsProperty": 1
         }
      ],
      "CustomParameters": null,
      "AdditionalParameters": null,
      "MutationType": 1,
      "RelatedTransactions": null,
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": "John Smith",
      "PayerHash": null,
      "PaymentKey": "0A71D126521C4799932E547BAD81xxx"
   }
}
```

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

### Alipay Pay Request Example

Source: https://docs.buckaroo.io/docs/alipay-requests

This JSON object demonstrates the structure for initiating an Alipay payment. It includes basic transaction details and service-specific parameters like UseMobileView.

```json
{
   "Currency": "EUR",
   "AmountDebit": 0.01,
   "Invoice": "testinvoice 1234",
   "Services": {
      "ServiceList": [
         {
            "Name": "Alipay",
            "Action": "Pay",
            "Parameters": [
               {
                  "Name": "UseMobileView",
                  "Value": "true"
               }
            ]
         }
      ]
   }
}
```

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

### Start Payment Session

Source: https://docs.buckaroo.io/docs/creditcards-hosted-fields

Initiate a payment session. The callback function will be executed upon event.

```javascript
await sdkClient.startSession(function (event) {
```

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

### Bancontact CompletePayment Request Example

Source: https://docs.buckaroo.io/docs/bancontact-requests

Example JSON for completing a Bancontact payment using client-side encryption. Requires the OriginalTransactionKey and EncryptedCardData.

```json
{
  "OriginalTransactionKey": "AF4BB6D14C364404ADF925958FXXXXXX",
  "Services": {
    "ServiceList": [
      {
        "Name": "bancontactmrcash",
        "Action": "CompletePayment",
        "Parameters": [
          {
            "Name": "EncryptedCardData",
            "Value": "001SlXfd8MbiTd/JFwCiGVs3f6o4x6xt0aN29NzOSNZHPKlVsz/EWeQmyhb1gGZ86VY88DP7gfDV+UyjcPfpVfHZd7u+WkO71hnV2QfYILCBNqE1aiPv2GQVGdaGbuoQloKu1o3o3I1UDmVxivXTMQX76ovot89geA6hqbtakmpmvxeiwwea3l4htNoX1IlD1hfYkDDl9rzSu5ypcjvVs6aRGXK5iMHnyrmEsEnfdj/Q5XWbsD5xAm4u3y6J8d4UP7LB31VLECzZUTiJOtKKcCQlT01YThIkQlj8PWBBMtt4H52VN3IH2+wPYtR8HiOZzcA2HA7UxozogIpS53tIURj/g=="
          }
        ]
      }
    ]
  }
}
```