tuutti/php-klarna

API to handle order lifecycle

2.0.0 2020-10-18 14:51 UTC

This package is not auto-updated.

Last update: 2024-03-23 12:56:08 UTC


README

API to handle order lifecycle

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://gitlab.com/tuutti/php-klarna.git"
    }
  ],
  "require": {
    "tuutti/php-klarna": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/php-klarna/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure HTTP basic authorization: basicAuth
$config = Klarna\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Klarna\Api\CapturesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$order_id = 'order_id_example'; // string | Order id
$capture_id = 'capture_id_example'; // string | Capture id
$klarna_idempotency_key = 'klarna_idempotency_key_example'; // string | This header will guarantee the idempotency of the operation. The key should be unique and is recommended to be a UUID version 4. Retries of requests are safe to be applied in case of errors such as network errors, socket errors and timeouts.
$body = new \Klarna\Model\UpdateShippingInfo(); // \Klarna\Model\UpdateShippingInfo | 

try {
    $apiInstance->appendShippingInfo($order_id, $capture_id, $klarna_idempotency_key, $body);
} catch (Exception $e) {
    echo 'Exception when calling CapturesApi->appendShippingInfo: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.klarna.com

ClassMethodHTTP requestDescription
CapturesApiappendShippingInfoPOST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-infoAdd shipping info to a capture
CapturesApicaptureOrderPOST /ordermanagement/v1/orders/{order_id}/capturesCreate capture
CapturesApigetCaptureGET /ordermanagement/v1/orders/{order_id}/captures/{capture_id}Get capture
CapturesApigetCapturesGET /ordermanagement/v1/orders/{order_id}/capturesGet all captures for one order
CapturesApitriggerSendOutPOST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-outTrigger resend of customer communication
OrdersApiacknowledgeOrderPOST /ordermanagement/v1/orders/{order_id}/acknowledgeAcknowledge order
OrdersApicancelOrderPOST /ordermanagement/v1/orders/{order_id}/cancelCancel order
OrdersApiextendAuthorizationTimePOST /ordermanagement/v1/orders/{order_id}/extend-authorization-timeExtend authorization time
OrdersApigetOrderGET /ordermanagement/v1/orders/{order_id}Get order
OrdersApireleaseRemainingAuthorizationPOST /ordermanagement/v1/orders/{order_id}/release-remaining-authorizationRelease remaining authorization
OrdersApiupdateAuthorizationPATCH /ordermanagement/v1/orders/{order_id}/authorizationSet new order amount and order lines
OrdersApiupdateConsumerDetailsPATCH /ordermanagement/v1/orders/{order_id}/customer-detailsUpdate customer addresses
OrdersApiupdateMerchantReferencesPATCH /ordermanagement/v1/orders/{order_id}/merchant-referencesUpdate merchant references
PaymentOrdersApicancelAuthorizationDELETE /payments/v1/authorizations/{authorizationToken}Cancel an existing authorization
PaymentOrdersApicreateOrderPOST /payments/v1/authorizations/{authorizationToken}/orderCreate a new order
PaymentOrdersApipurchaseTokenPOST /payments/v1/authorizations/{authorizationToken}/customer-tokenGenerate a consumer token
RefundsApigetGET /ordermanagement/v1/orders/{order_id}/refunds/{refund_id}Get refund
RefundsApirefundOrderPOST /ordermanagement/v1/orders/{order_id}/refundsCreate a refund
SessionsApicreateCreditSessionPOST /payments/v1/sessionsCreate a new credit session
SessionsApireadCreditSessionGET /payments/v1/sessions/{session_id}Read an existing credit session
SessionsApiupdateCreditSessionPOST /payments/v1/sessions/{session_id}Update an existing credit session

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Author