tuutti/php-klarna

API to handle order lifecycle

2.0.0 2020-10-18 14:51 UTC

Requires

• php: >=7.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^7.4
• squizlabs/php_codesniffer: ~2.6

unlicense

• OpenAPI-Generator contributors

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

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

Class	Method	HTTP request	Description
CapturesApi	appendShippingInfo	POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info	Add shipping info to a capture
CapturesApi	captureOrder	POST /ordermanagement/v1/orders/{order_id}/captures	Create capture
CapturesApi	getCapture	GET /ordermanagement/v1/orders/{order_id}/captures/{capture_id}	Get capture
CapturesApi	getCaptures	GET /ordermanagement/v1/orders/{order_id}/captures	Get all captures for one order
CapturesApi	triggerSendOut	POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-out	Trigger resend of customer communication
OrdersApi	acknowledgeOrder	POST /ordermanagement/v1/orders/{order_id}/acknowledge	Acknowledge order
OrdersApi	cancelOrder	POST /ordermanagement/v1/orders/{order_id}/cancel	Cancel order
OrdersApi	extendAuthorizationTime	POST /ordermanagement/v1/orders/{order_id}/extend-authorization-time	Extend authorization time
OrdersApi	getOrder	GET /ordermanagement/v1/orders/{order_id}	Get order
OrdersApi	releaseRemainingAuthorization	POST /ordermanagement/v1/orders/{order_id}/release-remaining-authorization	Release remaining authorization
OrdersApi	updateAuthorization	PATCH /ordermanagement/v1/orders/{order_id}/authorization	Set new order amount and order lines
OrdersApi	updateConsumerDetails	PATCH /ordermanagement/v1/orders/{order_id}/customer-details	Update customer addresses
OrdersApi	updateMerchantReferences	PATCH /ordermanagement/v1/orders/{order_id}/merchant-references	Update merchant references
PaymentOrdersApi	cancelAuthorization	DELETE /payments/v1/authorizations/{authorizationToken}	Cancel an existing authorization
PaymentOrdersApi	createOrder	POST /payments/v1/authorizations/{authorizationToken}/order	Create a new order
PaymentOrdersApi	purchaseToken	POST /payments/v1/authorizations/{authorizationToken}/customer-token	Generate a consumer token
RefundsApi	get	GET /ordermanagement/v1/orders/{order_id}/refunds/{refund_id}	Get refund
RefundsApi	refundOrder	POST /ordermanagement/v1/orders/{order_id}/refunds	Create a refund
SessionsApi	createCreditSession	POST /payments/v1/sessions	Create a new credit session
SessionsApi	readCreditSession	GET /payments/v1/sessions/{session_id}	Read an existing credit session
SessionsApi	updateCreditSession	POST /payments/v1/sessions/{session_id}	Update an existing credit session

Documentation For Models

• Addon
• Address
• AssetUrls
• Attachment
• AuthorizedPaymentMethod
• CancelNotAllowedErrorMessage
• Capture
• CaptureNotAllowedErrorMessage
• CaptureObject
• CarrierProduct
• CreateOrderRequest
• Customer
• CustomerTokenCreationRequest
• CustomerTokenCreationResponse
• ErrorV2
• InitialPaymentMethodDto
• Instant
• Location
• MerchantSession
• MerchantUrls
• NoSuchCaptureErrorMessage
• NoSuchOrderErrorMessage
• NotAllowedErrorMessage
• NotFoundErrorMessage
• Options
• Order
• OrderLine
• Ordersaddress
• Orderscustomer
• OrdersorderLine
• OrdersproductIdentifiers
• PaymentMethodCategory
• PaymentOrder
• ProductIdentifiers
• Refund
• RefundNotAllowedErrorMessage
• RefundObject
• SelectedShippingOptionDto
• Session
• ShippingInfo
• Timeslot
• UpdateAuthorization
• UpdateConsumer
• UpdateMerchantReferences
• UpdateShippingInfo

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Author