Read Payout line

GET

/v1/object-types/hospitality.payout_line/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.payout_line/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.payout_line/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One balance transaction a payout carried (Stripe’s txn_…): its reporting category, the processor object it came from, the gross, the fee and the net, as the processor states them. matched when the source resolves to a ledger payment — a charge to the payment it captured, a refund to its refund leg or original, a dispute to the payment disputed, a destination charge’s py_… through its transfer to the platform charge. Append-only; a re-run reconciliation may match a line it could not before.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.payout_line:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.payout_line

properties

required

object

amount

required

Payout line amount

Gross, as the processor states it (negative for money out)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

available_on

The day the line's money became available to pay out

string format: date

fee

required

Payout line fee

The processor’s fee on the line

object

amount

required

string format: decimal

currency

required

string format: iso-4217

required

Payout line id

string

line_type

The processor's own transaction type (`payment`, `charge`, `payment_refund`, `stripe_fee`, …)

string

matched

required

Whether the line resolved to a ledger payment

boolean

net

required

Payout line net

Gross less fee — what the line added to the payout

object

amount

required

string format: decimal

currency

required

string format: iso-4217

payment_id

The ledger payment the line came from (its object id) — the payout_line_for_payment edge's target

string

payout_id

required

The payout that carried the line (its object id) — the payout_line_for_payout edge's target

string

property_id

required

The house the payout is for (its object id)

string

psp_reference

required

The processor's id for the balance transaction (Stripe `txn_…`) — the replay key

string

reporting_category

required

The processor's reporting category for the line

string

Allowed values: charge refund dispute dispute_reversal transfer transfer_reversal fee partial_capture_reversal payout payout_reversal adjustment other

source_reference

The processor object the money came from (`ch_…`, `py_…`, `re_…`, `du_…`, `tr_…`)

string

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.payout_line",
  "properties": {
    "reporting_category": "charge"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).