Resources Enums Interfaces Models Unions Annotations Clients

billing 0.19.12

History | Watch
  • Contact: N/A
  • License: N/A

Resources

channel_bank_account

Operations

Method and Path Description
GET /channel/:channel/bank/accounts
GET /channel/:channel/bank/accounts/:key
PUT /channel/:channel/bank/accounts/:key
DELETE /channel/:channel/bank/accounts/:key

channel_default_bank_account

Operations

Method and Path Description
GET /channel/:channel/default/bank/accounts
PUT /channel/:channel/default/bank/accounts
DELETE /channel/:channel/default/bank/accounts

channel_payout

Operations

Method and Path Description
GET /channel/:channel/billing/payouts
GET /channel/:channel/billing/payouts/:id

channel_pending_payout_transaction

Operations

Method and Path Description
GET /channel/:channel/billing/pending/payout/transactions
GET /channel/:channel/billing/pending/payout/transactions/:id

channel_statement

Operations

Method and Path Description
GET /channel/:channel/billing/statements
GET /channel/:channel/billing/statements/:id

channel_transaction

Operations

Method and Path Description
GET /channel/:channel/billing/transactions
GET /channel/:channel/billing/transactions/:id

flow_transaction

Operations

Method and Path Description
GET /internal/billing/transactions
GET /internal/billing/transactions/:id

organization_bank_account

Operations

Method and Path Description
GET /:organization/bank/accounts
GET /:organization/bank/accounts/:key
PUT /:organization/bank/accounts/:key
DELETE /:organization/bank/accounts/:key

organization_default_bank_account

Operations

Method and Path Description
GET /:organization/default/bank/accounts
PUT /:organization/default/bank/accounts
DELETE /:organization/default/bank/accounts

organization_payout

Operations

Method and Path Description
GET /:organization/billing/payouts
GET /:organization/billing/payouts/:id

organization_pending_payout_transaction

Operations

Method and Path Description
GET /:organization/billing/pending/payout/transactions
GET /:organization/billing/pending/payout/transactions/:id

statement

Operations

Method and Path Description
GET /:organization/billing/statements
GET /:organization/billing/statements/:id

transaction

Operations

Method and Path Description
GET /:organization/billing/transactions
GET /:organization/billing/transactions/:id

Headers

No headers

Imports

https://app.apibuilder.io/flow/billing-bank-account/latest/service.json
https://app.apibuilder.io/flow/error/latest/service.json
https://app.apibuilder.io/flow/label/latest/service.json
https://app.apibuilder.io/flow/payment/latest/service.json
https://app.apibuilder.io/flow/trueup/latest/service.json
https://app.apibuilder.io/flow/units/latest/service.json

Enums

fee_deduction_type

Name Value Description
duty_guarantee duty_guarantee
mor mor
fraud fraud
fx fx
processing processing
rate_lock rate_lock
transfer transfer
negative_balance_guarantee negative_balance_guarantee

payout_attachment_type

Name Value Description
transactions transactions

payout_status_failure_code

Modeled from stripe: https://stripe.com/docs/api/payouts/failures

Name Value Description
invalid_account_number invalid_account_number
account_closed account_closed
could_not_process could_not_process

pending_payout_transaction_reason_code

Name Value Description
waiting_for_full_refund waiting_for_full_refund
waiting_for_fulfillment waiting_for_fulfillment
waiting_for_in_transit waiting_for_in_transit
waiting_for_next_payout_date waiting_for_next_payout_date
waiting_for_tracking_info waiting_for_tracking_info
waiting_for_positive_account_balance waiting_for_positive_account_balance
unfulfilled_amount_greater_than_negative_balance unfulfilled_amount_greater_than_negative_balance
account_payment_hold account_payment_hold

statement_attachment_type

Name Value Description
csv csv

transaction_source

Name Value Description
capture capture
refund refund
dispute dispute
adjustment adjustment
reversal reversal
shipping_label shipping_label
shipping_label_service shipping_label_service
shipping_label_revenue_share shipping_label_revenue_share
trueup trueup
trueup_base trueup_base
trueup_surcharge trueup_surcharge
carrier_charge carrier_charge
carrier_charge_revenue_share carrier_charge_revenue_share
platform_fee platform_fee
tax tax
duty duty
withholding withholding
other_adjustment other_adjustment
tax_adjustment tax_adjustment
channel channel
channel_billed channel_billed
order_service order_service
virtual_card_capture virtual_card_capture
virtual_card_refund virtual_card_refund
failed_payout failed_payout
tax_refund tax_refund

trueup_source

Name Value Description
flow flow
channel channel
dhl-parcel dhl-parcel
dhl dhl
ups ups

withholding_deduction_type

Name Value Description
tax tax
duty duty
freight freight
insurance insurance

Interfaces

bank_account

Field Type Required? Default Description Annotations
id string Yes -

key string Yes -

last4 string Yes -

default_bank_account

Field Type Required? Default Description Annotations
id string Yes -

bank_account bank_account_reference Yes -

generic_statement

Field Type Required? Default Description Annotations
id string Yes -

account account_reference Yes -

ending_balance decimal Yes -

settlement settlement Yes -

attachments [attachment] Yes -

created_at date-time-iso8601 Yes -

generic_transaction

Field Type Required? Default Description Annotations
id string Yes -

account account_id_reference Yes -

metadata transaction_metadata No -

order billing_channel_order_summary No -

payment_request billing_channel_payment_request_reference No -

currency string Yes -

source transaction_source Yes -

parent parent_transaction_summary No -

gross decimal Yes -

fees [fee_deduction] Yes []

withholdings [withholding_deduction] Yes []

discounts [billing_discount] Yes []

net decimal Yes -

net = gross -fees - withholdings
identifiers map[string] Yes {}

We serialize any transaction level identifiers as key/value pairs here
created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

payout

Field Type Required? Default Description Annotations
id string Yes -

account account_reference Yes -

status payout_status Yes -

bank_account bank_account_summary No -

The bank account to which we sent this payout if known. This generally becomes available once a payment is 'sent'
amount decimal Yes -

attachments [payout_attachment] Yes -

created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

payout_interface

Field Type Required? Default Description Annotations
status payout_status Yes -

amount decimal Yes -

pending_payout_transaction

A transaction that is pending payout.

Field Type Required? Default Description Annotations
id string Yes -

The id of the actual transaction that is pending payout
reason pending_payout_transaction_reason Yes -

timeout pending_payout_transaction_timeout No -

created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

deleted_at date-time-iso8601 No -

Models

account_id_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

account_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

currency string Yes -

attachment

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
type statement_attachment_type Yes -

url string Yes -

bank_account_form_info

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
info io.flow.billing.bank.account.v0.unions.bank_account_info:0.19.12 Yes -

bank_account_form_simple

Example Json: Minimal | Full

Interfaces: None

A form to setup a bank account for any country - we'll automatically identify the country from the routing/account number provided

Field Type Required? Default Description Annotations
routing_number string Yes -

account_number string Yes -

bank_account_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

Bank account id

bank_account_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
last4 string Yes -

billing_channel_order_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
organization billing_channel_organization_summary Yes -

number string Yes -

identifiers map[string] No -

We serialize and order identifiers as key/value pairs here

billing_channel_organization_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

billing_channel_payment_request_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

reference string No -

billing_channel_statement_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

billing_discount

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
amount decimal Yes -

description string No -

channel_bank_account

Example Json: Minimal | Full

Interfaces: bank_account

Field Type Required? Default Description Annotations
id string Yes -

key string Yes -

last4 string Yes -

channel_default_bank_account

Example Json: Minimal | Full

Interfaces: default_bank_account

Field Type Required? Default Description Annotations
id string Yes -

bank_account bank_account_reference Yes -

channel_payout

Example Json: Minimal | Full

Interfaces: payout_interface, payout

Field Type Required? Default Description Annotations
id string Yes -

account account_reference Yes -

status payout_status Yes -

bank_account bank_account_summary No -

The bank account to which we sent this payout if known. This generally becomes available once a payment is 'sent'
amount decimal Yes -

attachments [payout_attachment] Yes -

created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

channel_pending_payout_transaction

Example Json: Minimal | Full

Interfaces: pending_payout_transaction

A transaction that is pending payout.

Field Type Required? Default Description Annotations
id string Yes -

The id of the actual transaction that is pending payout
reason pending_payout_transaction_reason Yes -

timeout pending_payout_transaction_timeout No -

created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

deleted_at date-time-iso8601 No -

channel_statement

Example Json: Minimal | Full

Interfaces: generic_statement

Field Type Required? Default Description Annotations
id string Yes -

account account_reference Yes -

ending_balance decimal Yes -

settlement settlement Yes -

attachments [attachment] Yes -

created_at date-time-iso8601 Yes -

channel_transaction

Example Json: Minimal | Full

Interfaces: generic_transaction

Field Type Required? Default Description Annotations
statement billing_channel_statement_reference No -

id string Yes -

account account_id_reference Yes -

metadata transaction_metadata No -

order billing_channel_order_summary No -

payment_request billing_channel_payment_request_reference No -

currency string Yes -

source transaction_source Yes -

parent parent_transaction_summary No -

gross decimal Yes -

fees [fee_deduction] Yes []

withholdings [withholding_deduction] Yes []

discounts [billing_discount] Yes []

net decimal Yes -

net = gross -fees - withholdings
identifiers map[string] Yes {}

We serialize any transaction level identifiers as key/value pairs here
created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

default_bank_account_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
bank_account_id string Yes -

fee_deduction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
type fee_deduction_type Yes -

amount decimal Yes -

description string No -

flow_transaction

Example Json: Minimal | Full

Interfaces: generic_transaction

Provides internal access to all transactions

Field Type Required? Default Description Annotations
statement billing_channel_statement_reference No -

id string Yes -

account account_id_reference Yes -

metadata transaction_metadata No -

order billing_channel_order_summary No -

payment_request billing_channel_payment_request_reference No -

currency string Yes -

source transaction_source Yes -

parent parent_transaction_summary No -

gross decimal Yes -

fees [fee_deduction] Yes []

withholdings [withholding_deduction] Yes []

discounts [billing_discount] Yes []

net decimal Yes -

net = gross -fees - withholdings
identifiers map[string] Yes {}

We serialize any transaction level identifiers as key/value pairs here
created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

organization_bank_account

Example Json: Minimal | Full

Interfaces: bank_account

Field Type Required? Default Description Annotations
id string Yes -

key string Yes -

last4 string Yes -

organization_default_bank_account

Example Json: Minimal | Full

Interfaces: default_bank_account

Field Type Required? Default Description Annotations
id string Yes -

bank_account bank_account_reference Yes -

organization_payout

Example Json: Minimal | Full

Interfaces: payout_interface, payout

Field Type Required? Default Description Annotations
id string Yes -

account account_reference Yes -

status payout_status Yes -

bank_account bank_account_summary No -

The bank account to which we sent this payout if known. This generally becomes available once a payment is 'sent'
amount decimal Yes -

attachments [payout_attachment] Yes -

created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

organization_pending_payout_transaction

Example Json: Minimal | Full

Interfaces: pending_payout_transaction

A transaction that is pending payout.

Field Type Required? Default Description Annotations
id string Yes -

The id of the actual transaction that is pending payout
reason pending_payout_transaction_reason Yes -

timeout pending_payout_transaction_timeout No -

created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

deleted_at date-time-iso8601 No -

parent_transaction_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

source transaction_source Yes -

payout_attachment

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
type payout_attachment_type Yes -

url string Yes -

payout_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

payout_status_failed

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
timestamp date-time-iso8601 Yes -

reason payout_status_failure_code Yes -

payout_status_scheduled

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
placeholder string No -

payout_status_sent

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
timestamp date-time-iso8601 Yes -

payout_transaction

Example Json: Minimal | Full

Interfaces: generic_transaction

Note there is no statement on the payout transaction. We intend to deprecate the statement field once payouts are fully rolled out

Field Type Required? Default Description Annotations
id string Yes -

account account_id_reference Yes -

metadata transaction_metadata No -

order billing_channel_order_summary No -

payment_request billing_channel_payment_request_reference No -

currency string Yes -

source transaction_source Yes -

parent parent_transaction_summary No -

gross decimal Yes -

fees [fee_deduction] Yes []

withholdings [withholding_deduction] Yes []

discounts [billing_discount] Yes []

net decimal Yes -

net = gross -fees - withholdings
identifiers map[string] Yes {}

We serialize any transaction level identifiers as key/value pairs here
created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

pending_payout_transaction_reason

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
code pending_payout_transaction_reason_code Yes -

created_at date-time-iso8601 Yes -

pending_payout_transaction_timeout

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
created_at date-time-iso8601 Yes -

settlement_no_payout

Example Json: Minimal | Full

Interfaces: None

This model indicates that a statement is generated with no funds due to the merchant

Field Type Required? Default Description Annotations
placeholder string No -

settlement_payout

Example Json: Minimal | Full

Interfaces: payout_interface

Field Type Required? Default Description Annotations
status payout_status Yes -

amount decimal Yes -

sent_on date-time-iso8601 No -

statement

Example Json: Minimal | Full

Interfaces: generic_statement

Field Type Required? Default Description Annotations
id string Yes -

account account_reference Yes -

ending_balance decimal Yes -

settlement settlement Yes -

attachments [attachment] Yes -

created_at date-time-iso8601 Yes -

transaction

Example Json: Minimal | Full

Interfaces: generic_transaction

Field Type Required? Default Description Annotations
statement billing_channel_statement_reference No -

id string Yes -

account account_id_reference Yes -

metadata transaction_metadata No -

order billing_channel_order_summary No -

payment_request billing_channel_payment_request_reference No -

currency string Yes -

source transaction_source Yes -

parent parent_transaction_summary No -

gross decimal Yes -

fees [fee_deduction] Yes []

withholdings [withholding_deduction] Yes []

discounts [billing_discount] Yes []

net decimal Yes -

net = gross -fees - withholdings
identifiers map[string] Yes {}

We serialize any transaction level identifiers as key/value pairs here
created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

transaction_metadata_carrier_charge

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
reason io.flow.trueup.v0.enums.carrier_charge_reason:0.19.12 Yes -

label_created_at date-time-iso8601 Yes -

carrier_id string Yes -

carrier_tracking_number string Yes -

revenue_share_percentage decimal Yes -

Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none. Values are expressed as '0.0295' to represent '2.95%'
outbound transaction_metadata_outbound_transaction No -

transaction_metadata_channel

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
method string Yes -

The id of the payment method associated with this transaction. See https://api.flow.io/reference/payment/methods
card transaction_metadata_channel_card_metadata No -

organization_transaction transaction_metadata_channel_organization_transaction Yes -

transaction_metadata_channel_card_metadata

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
type io.flow.payment.v0.enums.card_type:0.19.12 Yes -

issuer transaction_metadata_channel_card_metadata_issuer_summary Yes -

transaction_metadata_channel_card_metadata_issuer_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
iin string Yes -

country string Yes -

transaction_metadata_channel_organization_transaction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

metadata transaction_metadata_payment_transaction Yes -

transaction_metadata_failed_payout

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
failed_payout transaction_metadata_failed_payout_reference Yes -

transaction_metadata_failed_payout_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

transaction_metadata_manual

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
description string Yes -

original transaction_metadata_original_transaction No -

url string No -

transaction_metadata_original_transaction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

transaction_metadata_outbound_transaction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
transaction_id string Yes -

transaction_metadata_payment_transaction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string No -

key string No -

transaction_metadata_shipping_label

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
request_method io.flow.label.v0.enums.label_request_method:0.19.12 No -

carrier transaction_metadata_shipping_label_carrier Yes -

revenue_share_percentage decimal No -

Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none. Values are expressed as '0.0295' to represent '2.95%'

transaction_metadata_shipping_label_carrier

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

The carrier id of this label. See https://api.flow.io/reference/carriers
tracking_number string Yes -

transaction_metadata_trueup

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
original transaction_metadata_original_transaction Yes -

estimate transaction_metadata_trueup_data Yes -

actual transaction_metadata_trueup_data Yes -

transaction_metadata_trueup_base

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
original transaction_metadata_original_transaction Yes -

estimate transaction_metadata_trueup_base_data Yes -

actual transaction_metadata_trueup_base_data Yes -

transaction_metadata_trueup_base_data

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
source trueup_source Yes -

weights trueup_label_weights Yes -

units trueup_label_units Yes -

base trueup_label_base_v2 Yes -

fuel trueup_label_fuel No -

total decimal Yes -

transaction_metadata_trueup_data

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
source trueup_source Yes -

units trueup_label_units Yes -

base trueup_label_base Yes -

surcharges [trueup_label_surcharge] Yes -

total decimal Yes -

dead io.flow.trueup.v0.models.dead_weight:0.19.12 No -

dimensional io.flow.trueup.v0.models.dimensional_weight:0.19.12 No -

transaction_metadata_trueup_surcharge

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
original transaction_metadata_original_transaction Yes -

estimate transaction_metadata_trueup_surcharge_data Yes -

actual transaction_metadata_trueup_surcharge_data Yes -

transaction_metadata_trueup_surcharge_data

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
source trueup_source Yes -

surcharge trueup_label_surcharge Yes -

transaction_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

trueup_label_base

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
amount decimal Yes -

The base rate card charge (based on weight, before fees)
weight decimal Yes -

The actual weight used for ratecard lookup

trueup_label_base_v2

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
amount decimal Yes -

The base rate card charge (based on weight, before fees)

trueup_label_base_weight

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
weight decimal Yes -

The actual weight used for ratecard lookup

trueup_label_fuel

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
amount decimal Yes -

percentage decimal No -

When applicable, the % used to calculate this surcharge. Values are expressed as '10.5' to represent '10.5%'

Example: 15.5
per_weight_unit decimal No -

When applicable, the dollar amount per weight unit used to calculate this surcharge. Values are expressed as '0.04' to represent '4 cents' per unit (eg pound)

Example: 0.04

trueup_label_surcharge

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
amount decimal Yes -

type io.flow.trueup.v0.enums.trueup_surcharge_type:0.19.12 Yes -

percentage decimal No -

When applicable, the % used to calculate this surcharge. Values are expressed as '10.5' to represent '10.5%'

Example: 15.5
per_weight_unit decimal No -

When applicable, the dollar amount per weight unit used to calculate this surcharge. Values are expressed as '0.04' to represent '4 cents' per unit (eg pound)

Example: 0.04

trueup_label_units

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
weight io.flow.units.v0.enums.unit_of_weight:0.19.12 Yes -

Example: pound
length io.flow.units.v0.enums.unit_of_length:0.19.12 No -

Example: inch

trueup_label_weights

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
base trueup_label_base_weight Yes -

dead io.flow.trueup.v0.models.dead_weight:0.19.12 No -

dimensional io.flow.trueup.v0.models.dimensional_weight:0.19.12 No -

withholding_deduction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
type withholding_deduction_type Yes -

amount decimal Yes -

description string No -

Unions

bank_account_form

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
bank_account_form_info info (Default) Minimal | Full

bank_account_form_simple simple Minimal | Full

payout_status

Interfaces: None

  • Type discriminator: code
Type Discriminator Value Example Json Description
payout_status_scheduled scheduled Minimal | Full

payout_status_sent sent Minimal | Full

payout_status_failed failed Minimal | Full

settlement

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
settlement_no_payout no_payout Minimal | Full

settlement_payout payout Minimal | Full

transaction_metadata

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
transaction_metadata_shipping_label shipping_label Minimal | Full

transaction_metadata_channel channel Minimal | Full

transaction_metadata_trueup trueup Minimal | Full

transaction_metadata_trueup_base trueup_base Minimal | Full

transaction_metadata_trueup_surcharge trueup_surcharge Minimal | Full

transaction_metadata_carrier_charge carrier_charge Minimal | Full

transaction_metadata_manual manual Minimal | Full

transaction_metadata_failed_payout failed_payout Minimal | Full

transaction_metadata_payment_transaction payment_transaction Minimal | Full

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].