GET
View a payment source (organization)
Organization space Accounting module For: Accountant · Permission: accounting_payment_sources.list 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.
  • A cheque payment source is refused, because cheques have their own resource.
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

paymentSource
string
required

Identifier of the book segment of the URL (the company's book); see book.

payment_source
string
required

Identifier of the payment source (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, organization_id, source_type, source_id, payment_method, register_payment_method_id, money_account_id, functional_amount, currency_code, currency_exponent, original_amount, original_currency_code, original_currency_exponent, company_settlement_amount, company_incoming_fee_snapshot, customer, customer_id, order, reference, received_at, accounting_status, settlement_id, 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: settlement.

Response

Resource.

id

Identifier of the payment source (27-character KSUID string).

company_id

Identifier of the company the record belongs to.

organization_id

Identifier of the organization the record belongs to.

source_type

Kind of business record that received the payment, for example order_payment (a payment on an order) or customer_credit_payment (a customer paying off credit).

source_id

Identifier of that business record (27-character KSUID string). Unique per company and source_type.

payment_method

Method used: cash, credit_card, bank_transfer, mobile_money, cheque or other. Cheque sources are not returned by this API.

register_payment_method_id

Register payment method used at the point of sale (27-character KSUID string); null when none.

money_account_id

Money account the payment goes to (27-character KSUID string).

functional_amount
integer

Amount in the company currency, an integer in minor units (divide by 10 to the power currency_exponent).

currency_code

Company currency of functional_amount (ISO 4217 code).

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

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_settlement_amount
integer | null

Amount the company expects to be settled, in minor units of the company currency: the functional amount minus the incoming fee, if any.

company_incoming_fee_snapshot
object | null

Frozen details of the incoming fee taken when the payment was recorded (gross_amount, net_amount, direction and the fee figures); null when no fee applied.

customer
object

Customer who paid, as an object with id and name (both null when none).

customer_id

Customer who paid (27-character KSUID string); null when none.

order
object

Order the payment belongs to, as an object with id and number (both null for payments without an order).

reference

Payment reference recorded with the payment; null when none.

received_at

Date and time the payment was received (ISO 8601).

accounting_status

Where the payment stands in accounting: not_initiated (nothing posted yet), or the status of its settlement or cheque transfer (initiated, settled, cancelled, reversed, transferred).

settlement_id

Settlement attached to this payment (27-character KSUID string); null until one is created.

settlement
object | null

The settlement of the payment. Only returned when requested with ?include=settlement, to callers with the permission settlements.retrieve, and limited to your company.

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).