Class Payouts

Payouts resource.

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable

Klarna\Rest\Settlements\Payouts

Namespace: Klarna\Rest\Settlements
Example: docs/examples/SettlementsAPI/Payouts/get_all_payouts.php Returns a collection of payouts
Example: docs/examples/SettlementsAPI/Payouts/get_payout.php Returns a specific payout based on a payment reference
Example: docs/examples/SettlementsAPI/Payouts/get_summary.php Returns a summary of payouts for each currency code
Located at Klarna/Rest/Settlements/Payouts.php

Methods summary

`public`	# `__construct( Klarna\Rest\Transport\ConnectorInterface $connector )` Constructs Payouts instance. Constructs Payouts instance. Parameters `$connector` HTTP transport connector Overrides `Klarna\Rest\Resource::__construct`
`public Klarna\Rest\Settlements\Payouts`	# `fetch( )` Not applicable. Not applicable. Returns `Klarna\Rest\Settlements\Payouts` Throws `Klarna\Exceptions\NotApplicableException` Overrides `Klarna\Rest\Resource::fetch`
`public array`	# `getPayout( string $paymentReference )` Returns a specific payout based on a given payment reference. Returns a specific payout based on a given payment reference. Parameters `$paymentReference` The reference id of the payout Returns array Payout 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
`public array`	# `getAllPayouts( array $params = [] )` Returns a collection of payouts. Returns a collection of payouts. Parameters `$params` Additional query params to filter payouts. Returns array Payouts 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/#settlements-api-get-all-payouts
`public array`	# `getSummary( array $params = [] )` Returns a summary of payouts for each currency code in a date range. Returns a summary of payouts for each currency code in a date range. Parameters `$params` Additional query params to filter summary data. Returns array summary of payouts 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/#settlements-api-get-summary-of-payouts

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.	# `'/settlements/v1/payouts'`

Properties inherited from Klarna\Rest\Resource

$connector, $url

Namespaces

Classes

Class Payouts

Methods summary

Parameters

Overrides

Returns

Throws

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

See

Parameters

Returns

Throws

See

Methods inherited from Klarna\Rest\Resource

Methods inherited from ArrayObject

Magic methods summary

Constants summary

Constants inherited from Klarna\Rest\Resource

Constants inherited from ArrayObject

Properties summary

Properties inherited from Klarna\Rest\Resource