GET
View a settlement (organization)
Organization space Accounting module For: Accountant · Permission: settlements.retrieve Conditions
  • The accounting module must be active for the organization.
  • The caller must have been granted access to the book in the URL.
  • The book in the URL must be a company book; the organization’s own book or a client book is refused.
Part of Card and payment settlements.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

settlement
string
required

Identifier of the settlement (27-character KSUID string).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, company_id, source_type, source_id, direction, payment_method, creation_mode, status, money_account_id, payment_route_account_id, register_payment_method_id, original_amount, original_currency_code, original_currency_exponent, company_functional_amount, company_currency_code, company_currency_exponent, organization_functional_amount, organization_currency_code, organization_currency_exponent, conversion_snapshot, external_reference, initiated_at, settled_at, reversed_at, reversed_by, reversed_by_type, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

id

Identifier of the settlement (27-character KSUID string).

company_id

Identifier of the company the record belongs to.

source_type

Kind of business record whose payment is settled, for example order_payment or customer_credit_payment.

source_id

Identifier of that business record (27-character KSUID string). A payment can have only one settlement per company.

direction

Direction of the money flow; incoming for payments received.

payment_method

Payment method: credit_card (starts initiated, confirmed later by the organization), bank_transfer or mobile_money (created already settled).

creation_mode

manual or automatic: how the settlement was created. Settlements created for the supported methods are automatic.

status

initiated (waiting for the money), settled (money confirmed on the money account), cancelled (initiated one that was reversed) or reversed (settled one that was reversed).

money_account_id

Organization money account that receives the money (27-character KSUID string).

payment_route_account_id

Accounting account of the payment route the payment went through (27-character KSUID string).

register_payment_method_id

Identifier of the register payment method the payment went through (27-character KSUID string); null when the payment has none.

original_amount
integer

Amount in the currency the customer paid in, an integer in minor units (divide by 10 to the power original_currency_exponent).

original_currency_code

Currency the customer paid in (ISO 4217 code).

original_currency_exponent
integer

Number of decimal places of the original currency.

company_functional_amount
integer

Amount in the company currency, an integer in minor units, frozen from the payment conversion.

company_currency_code

Company currency (ISO 4217 code).

company_currency_exponent
integer

Number of decimal places of the company currency.

organization_functional_amount
integer

Amount in the organization currency, an integer in minor units, frozen from the payment conversion.

organization_currency_code

Organization currency (ISO 4217 code).

organization_currency_exponent
integer

Number of decimal places of the organization currency.

conversion_snapshot
object

Frozen record of the conversions, the fees applied when settled, a hash of the confirmation payload, the accounting posting status and the journal entry identifiers, and the reversal details. Never recalculated with newer rates.

external_reference

Reference supplied by the payment provider or the bank; null when none.

initiated_at

Date and time the settlement was initiated (ISO 8601).

settled_at

Date and time the money was confirmed (ISO 8601); null until settled.

reversed_at

Date and time the settlement was reversed or cancelled (ISO 8601); null otherwise.

reversed_by

Identifier of the member profile or agent account who reversed it; null otherwise.

reversed_by_type

Type of the actor who reversed it; null otherwise.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).