Class SettlementStore

This API gives you access to your payouts and transactions. Resources are split into two broad types:

  • Collections, including pagination information: collections are queryable, typically by the attributes of the sub-resource as well as pagination.
  • Entity resources containing a single entity.
Inheritance
System.Object
BaseRestClient
BaseStore
SettlementStore
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Klarna.Rest.Core.Store
Assembly: Klarna.Rest.Core.dll
Syntax
public class SettlementStore : BaseStore

Methods

| Improve this Doc View Source

GetAllPayouts(String, String, String, Int32, Int32)

Returns a collection of payouts.

Declaration
public Task<SettlementsGetAllPayoutsResponse> GetAllPayouts(string startDate = "", string endDate = "", string currencyCode = "", int size = 0, int offset = 0)
Parameters
Type Name Description
System.String startDate

Optional. ISO-8601 formatted date with optional time string
System.String endDate

Optional. ISO-8601 formatted date with optional time string
System.String currencyCode

Optional. ISO-3166 Currency Code.
System.Int32 size

Optional. How many elements to include in the result. If no value for size is provided, a default of 20 will be used.
System.Int32 offset

Optional. The current offset. Describes "where" in a collection the current starts.
Returns
Type Description
System.Threading.Tasks.Task<SettlementsGetAllPayoutsResponse>

SettlementsGetAllPayoutsResponse
| Improve this Doc View Source

GetCsvPayoutReport(String)

Gets CSV Payout Report More information about this CSV format is available at: https://developers.klarna.com/en/gb/kco-v3/settlement-files

Declaration
public Task<Stream> GetCsvPayoutReport(string paymentReference)
Parameters
Type Name Description
System.String paymentReference

The reference id of the payout
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.IO.Stream of content type text/csv
| Improve this Doc View Source

GetCsvSummary(String, String)

Gets CSV summary More information about this CSV format is available at: https://developers.klarna.com/en/gb/kco-v3/settlement-files

Declaration
public Task<Stream> GetCsvSummary(string startDate, string endDate)
Parameters
Type Name Description
System.String startDate

Required. ISO-8601 formatted date with optional time string
System.String endDate

Required. ISO-8601 formatted date with optional time string
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.IO.Stream of content type text/csv
| Improve this Doc View Source

GetPayout(String)

Returns a specific payout based on a given payment reference.

Declaration
public Task<SettlementsPayout> GetPayout(string paymentReference)
Parameters
Type Name Description
System.String paymentReference

The reference id of the payout
Returns
Type Description
System.Threading.Tasks.Task<SettlementsPayout>

A single SettlementsPayout object
| Improve this Doc View Source

GetPayoutsSummary(String, String, String)

Returns a summary of payouts for each currency code in a date range.

Declaration
public Task<ICollection<SettlementsPayoutSummary>> GetPayoutsSummary(string startDate, string endDate, string currencyCode)
Parameters
Type Name Description
System.String startDate

ISO-8601 formatted date with optional time string
System.String endDate

ISO-8601 formatted date with optional time string
System.String currencyCode

ISO-3166 Currency Code.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<SettlementsPayoutSummary>>

Collection of SettlementsPayoutSummary
| Improve this Doc View Source

GetPdfPayoutSummary(String)

A single settlement summed up in pdf format

Declaration
public Task<Stream> GetPdfPayoutSummary(string paymentReference)
Parameters
Type Name Description
System.String paymentReference

Required. The reference id of the payout
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.IO.Stream of content type application/pdf
| Improve this Doc View Source

GetPdfSummary(String, String)

Returns a summary for all payouts between the given dates

Declaration
public Task<Stream> GetPdfSummary(string startDate, string endDate)
Parameters
Type Name Description
System.String startDate

Required. ISO-8601 formatted date with optional time string
System.String endDate

Required. ISO-8601 formatted date with optional time string
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.IO.Stream of content type application/pdf
| Improve this Doc View Source

GetTransactions(String, String, Int32, Int32)

Returns a collection of transactions.

Declaration
public Task<SettlementsGetTransactionsResponse> GetTransactions(string paymentReference = "", string orderId = "", int size = 0, int offset = 0)
Parameters
Type Name Description
System.String paymentReference

Optional. The reference id of the payout
System.String orderId

Optional. The Klarna assigned order id reference
System.Int32 size

Optional. How many elements to include in the result. If no value for size is provided, a default of 20 will be used.
System.Int32 offset

Optional. The current offset. Describes "where" in a collection the current starts.
Returns
Type Description
System.Threading.Tasks.Task<SettlementsGetTransactionsResponse>