• Namespace
  • Class

Namespaces

  • Klarna
    • Exceptions
    • Rest
      • Checkout
      • CustomerToken
      • HostedPaymentPage
      • InstantShopping
      • MerchantCardService
      • OrderManagement
      • Payments
      • Settlements
      • Transport
        • Exception

Classes

  • VCCSettlements

Class VCCSettlements

Virtual Credit Card Settlements resource.

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by Klarna\Rest\Resource
Extended by Klarna\Rest\MerchantCardService\VCCSettlements
Namespace: Klarna\Rest\MerchantCardService
Located at Klarna/Rest/MerchantCardService/VCCSettlements.php

Methods summary

public
# __construct( Klarna\Rest\Transport\ConnectorInterface $connector, string $sessionId,… )

Constructs a session instance.

Constructs a session instance.

Parameters

$connector
HTTP transport connector
$sessionId,…
Session ID

Overrides

Klarna\Rest\Resource::__construct
public Klarna\Rest\MerchantCardService\VCCSettlements
# fetch( )

Not applicable.

Not applicable.

Returns

Klarna\Rest\MerchantCardService\VCCSettlements

Throws

Klarna\Exceptions\NotApplicableException

Overrides

Klarna\Rest\Resource::fetch
public array
# create( array $data )

Creates a new settlement.

Creates a new settlement.

Parameters

$data
Creation data

Returns

array
Settlement data

Throws

Klarna\Rest\Transport\Exception\ConnectorException
When the API replies with an error response
GuzzleHttp\Exception\RequestException
When an error is encountered
RuntimeException
If the location header is missing
RuntimeException
If the API replies with an unexpected response
LogicException
When Guzzle cannot populate the response

See

https://developers.klarna.com/api/#merchant-card-service-api-create-a-new-settlement
public array
# retrieveSettlement( array $settlementId, $keyId )

Retrieve an existing settlement.

Retrieve an existing settlement.

Parameters

$settlementId
$data Distribute data
$keyId

Returns

array
Settlement data

Throws

Klarna\Rest\Transport\Exception\ConnectorException
When the API replies with an error response
GuzzleHttp\Exception\RequestException
When an error is encountered
RuntimeException
On an unexpected API response
RuntimeException
If the response content type is not JSON
InvalidArgumentException
If the JSON cannot be parsed
LogicException
When Guzzle cannot populate the response

See

https://developers.klarna.com/api/#hosted-payment-page-api-distribute-link-to-the-hpp-session
public array
# retrieveOrderSettlement( array $orderId, $keyId )

Retrieves a settled order's settlement.

Retrieves a settled order's settlement.

Parameters

$orderId
$data Distribute data
$keyId

Returns

array
Order's settlement data

Throws

Klarna\Rest\Transport\Exception\ConnectorException
When the API replies with an error response
GuzzleHttp\Exception\RequestException
When an error is encountered
RuntimeException
On an unexpected API response
RuntimeException
If the response content type is not JSON
InvalidArgumentException
If the JSON cannot be parsed
LogicException
When Guzzle cannot populate the response

See

https://developers.klarna.com/api/#hosted-payment-page-api-distribute-link-to-the-hpp-session

Methods inherited from Klarna\Rest\Resource

delete(), exchangeArray(), get(), getId(), getLocation(), patch(), post(), put(), request(), setId(), setLocation()

Methods inherited from ArrayObject

append(), asort(), count(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()

Magic methods summary

Constants summary

Constants inherited from Klarna\Rest\Resource

ID_FIELD

Constants inherited from ArrayObject

ARRAY_AS_PROPS, STD_PROP_LIST

Properties summary

public static string $path

Path to the resource endpoint.

Path to the resource endpoint.

# '/merchantcard/v3/settlements'

Properties inherited from Klarna\Rest\Resource

$connector, $url

API documentation generated by ApiGen