Mollie.Settlements (mollie v0.7.2)
Successful payments, together with refunds, captures and chargebacks are collected into settlements, which are then paid out according to your organization’s payout schedule.
Link to this section Summary
Functions
Retrieve a single settlement.
Retrieve all settlements, ordered from new to old. Results are paginated.
Retrieve all captures included in a settlement.
Retrieve all chargebacks included in a settlement.
Retrieve all payments included in a settlement.
Retrieve all refunds included in a settlement.
Retrieve the details of the current settlement that has not yet been paid out.
Retrieve the details of the open balance of the organization.
Link to this section Functions
find(client, id)
Specs
find(Mollie.Client.t(), binary()) :: Mollie.response()
Retrieve a single settlement.
example
Example
Mollie.Settlements.find client, "stl_jDk30akdN"More info at: https://docs.mollie.com/reference/v2/settlements-api/get-settlement
list(client, params)
Specs
list(Mollie.Client.t(), map() | list()) :: Mollie.response()
Retrieve all settlements, ordered from new to old. Results are paginated.
example
Example
Mollie.Settlements.list clientMore info at: https://docs.mollie.com/reference/v2/settlements-api/list-settlements
list_captures(client, id)
Specs
list_captures(Mollie.Client.t(), binary()) :: Mollie.response()
Retrieve all captures included in a settlement.
example
Example
Mollie.Settlements.list_captures client, "stl_jDk30akdN"More info at: https://docs.mollie.com/reference/v2/settlements-api/list-settlement-captures
list_chargebacks(client, id)
Specs
list_chargebacks(Mollie.Client.t(), binary()) :: Mollie.response()
Retrieve all chargebacks included in a settlement.
example
Example
Mollie.Settlements.list_chargebacks client, "stl_jDk30akdN"More info at: https://docs.mollie.com/reference/v2/settlements-api/list-settlement-chargebacks
list_payments(client, id)
Specs
list_payments(Mollie.Client.t(), binary()) :: Mollie.response()
Retrieve all payments included in a settlement.
example
Example
Mollie.Settlements.list_payments client, "stl_jDk30akdN"More info at: https://docs.mollie.com/reference/v2/settlements-api/list-settlement-payments
list_refunds(client, id)
Specs
list_refunds(Mollie.Client.t(), binary()) :: Mollie.response()
Retrieve all refunds included in a settlement.
example
Example
Mollie.Settlements.list_refunds client, "stl_jDk30akdN"More info at: https://docs.mollie.com/reference/v2/settlements-api/list-settlement-refunds
next(client)
Specs
next(Mollie.Client.t()) :: Mollie.response()
Retrieve the details of the current settlement that has not yet been paid out.
example
Example
Mollie.Settlements.next clientMore info at: https://docs.mollie.com/reference/v2/settlements-api/get-next-settlement
open(client)
Specs
open(Mollie.Client.t()) :: Mollie.response()
Retrieve the details of the open balance of the organization.
example
Example
Mollie.Settlements.open clientMore info at: https://docs.mollie.com/reference/v2/settlements-api/get-open-settlement