Settlements

Settlements represent a specific line-item, or transaction contained within a Project on the trustshare API. They connect one, or two, Participants to a project and describe the reason for payment.

Settlements are created once a Payment Intent has been confirmed by a participant. A settlement is used primarily as a reconciliation mechanism that expects funds from the from participant. If we can reliably confirm that the funds are from the buying participant then we will automatically reconcile funds paid by them to their outstanding settlements.

Settlement types

A payment intent is made up of a selection of settlements. When creating your payment intent you can decide on the kind of settlements that will be create for the transaction. Settlement types allow you to dsesribe the behaviour of funds moving through the system.

Most settlement types hold funds within themselves, disallowing the release of those funds from the project balance itself. This means that funds held in settlements must be released from the settlement itself and not the project balance. Only funding settlements do not earmark funds.

See how to create a payment intent

Moving funds instantly with the `immediate` type

An immediate type works, as the name suggests, as an immediate settlement to the supplied seller participant and will release the funds directly to the seller’s bank account as soon as the required funds are available within the dedicated account.

This is useful if you want to route money to multiple sellers as quickly as possible whilst splitting your fees.

Holding funds indefinitely with the `escrow` type

The escrow type is a flexible intent that can describe not only a future requirement for funds, ie. funds not required immediately at checkout and therefore not included in the total for the payment initiation, but also a future release date where funds available will be automatically released to the seller participant once the supplied date is in the past.

By not supplying a requirement date, an escrow settlement is considered to be immediately required and will be included in the total for the checkout when it is confirmed via the SDK on the client-side. By not providing a release date for the funds, the funds will be held in escrow indefinitely until they are released via an API call.

This is useful if you need to hold funds until a good or service is delivered.

See how to release funds from a settlement

Collecting funds without a specific target with the `funding` type

The funding type can be used where the seller participant can not be determined up front, or where funds are held passively during a transaction to be returned to the buyer participant upon completion. Funds reconciled against a funding settlement will increment the underlying project balance.

This is useful if your payment flow is complex or you may not know the exact breakdown of where the money should go to up front.

Learn more about the project balance

Moving funds between projects with the `transfer` type

The transfer type allows you to immediately settle funds from any project, whether controlled or not, to a controlled project where funds can be held in project balances indefinitely.

This is useful if you wish your buyer to be provisioned a single pay in target that will route funds to projects provisioned for sellers.

What's next?

Now you have an understanding of how settlement types route funds through the system. Here are a few links to continue learning about the process.

The settlement model

The settlement object provides a comprehensive representation of a single line-item within the trustshare API, including involved participants and any associated data that may be useful for tracking and analysis purposes.

Properties

Name
id
Type
string
Description
A unique ID for the settlement.
A string in the format settlement_[0-9a-z].
Name
created_at
Type
string
Description
The date the settlement was created.
Name
updated_at
Type
string
Description
The date the settlement was last updated.
Name
currency
Type
enum
Description
gbp eur usd
The currency of the over-arching Project that this settlement is against.
Name
status
Type
enum
Description
settling settled executing executed in_review cancelled
The current status of the settlement.
Name
type
Type
enum
Description
funding immediate escrow transfer
The type of the settlement.
Name
project_id
Type
string
Description
The unique ID of the project which this settlement belongs to.
Name
from
Type
object
Description
Show moreless
An object describing the buyer Participant for the settlement.
Name
id
Type
string
Description
A unique ID of the participant.
A string in the format: participant_[0-9a-z].
Name
status
Type
enum
Description
unverified verifying verified
The participant status.
Name
type
Type
enum
Description
unknown individual business third_party organisation
The participant type.
Name
email
Type
string
Description
The participant's email.
Name
name
Type
string
Description
The participant's name.
Name
address
Type
object
Description
Show moreless
An object describing the participant's address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
An object describing the participant's address.
Name
bank_account
Type
object
Description
Show moreless
An object describing the participant's bank account.
Name
id
Type
string
Description
A unique ID for the bank_account.
A string in the format bank_account_[0-9a-z].
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country the bank account is held in.
Name
currency
Type
enum
Description
aed afn all amd ang aoa ars aud awg azn bam bbd bdt bgn bhd bif bmd bnd bob brl bsd btn bwp byn bzd cad cdf chf clp cny cop crc cup cve czk djf dkk dop dzd egp ern etb eur fjd fkp gbp gel ghs gip gmd gnf gtq gyd hkd hnl hrk htg huf idr ils inr iqd irr isk jmd jod jpy kes kgs khr kmf kpw krw kwd kyd kzt lak lbp lkr lrd lsl ltl lvl lyd mad mdl mga mkd mmk mnt mop mro mur mvr mwk mxn myr mzn nad ngn nio nok npr nzd omr pab pen pgk php pkr pln pyg qar ron rsd rub rwf sar sbd scr sdg sek sgd shp sll sos srd ssp std syp szl thb tjs tmt tnd top try ttd tvd twd tzs uah ugx usd uyu uzs ved vnd vuv wst xaf xcd xof xpf yer zar zmw
The currency the bank account is held in.
Name
account_number
Type
string
Description
The account number of the bank account.
Name
routing_code
Type
string
Description
The routing code of the bank account.
Name
routing_code_type
Type
enum
Description
bic_swift aba clabe cnaps wire ach bank_code ifsc sort_code
The routing code type of the bank account.
Name
routing_data
Type
object
Description
An object potentially containing further routing data.
An object describing the participant's bank account.
Name
business
Type
object
Description
Show moreless
An object describing the participant's business details.
Name
type
Type
enum
Description
unknown limited public partnership sole_trader
The type of business.
Name
company_number
Type
string
Description
The business' company number.
Name
registered_address
Type
object
Description
Show moreless
The business' registered address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The business' registered address.
Name
trading_address
Type
object
Description
Show moreless
The business' trading address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The business' trading address.
Name
shipping_address
Type
object
Description
Show moreless
The business' shipping address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The business' shipping address.
Name
phone_number
Type
string
Description
The business' phone number.
Name
website
Type
string
Description
The business' website.
Name
persons
Type
object[]
Description
Show moreless
A list of the business' employees with significant control.
Name
type
Type
enum
Description
unknown shareholder director partner applicant executive
The person's type.
Name
name
Type
string
Description
The person's name.
Name
address
Type
object
Description
Show moreless
The person's address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The person's address.
Name
email
Type
string
Description
The person's email address.
Name
phone_number
Type
string
Description
The person's phone number.
Name
date_of_birth
Type
string
Description
The person's date of birth.
A list of the business' employees with significant control.
An object describing the participant's business details.
Name
individual
Type
object
Description
Show moreless
An object describing the participant's individual details.
Name
date_of_birth
Type
string
Description
The individual's date of birth.
Name
residential_address
Type
object
Description
Show moreless
The individual's residential address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The individual's residential address.
Name
shipping_address
Type
object
Description
Show moreless
The individual's shipping address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The individual's shipping address.
Name
phone_number
Type
string
Description
The individual's phone number.
An object describing the participant's individual details.
Name
organisation
Type
object
Description
Show moreless
An object describing the participant's organisation details.
Name
type
Type
enum
Description
unknown overseas_government treaty non_profit political voluntary_group sports_club other
The type of organisation.
Name
organisation_number
Type
string
Description
The organisation's registered number.
Name
registered_address
Type
object
Description
Show moreless
The organisation's registered address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The organisation's registered address.
Name
shipping_address
Type
object
Description
Show moreless
The organisation's shipping address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The organisation's shipping address.
Name
phone_number
Type
string
Description
The organisation's phone number.
Name
website
Type
string
Description
The organisation's website.
Name
persons
Type
object[]
Description
Show moreless
The organisation's members with significant control.
Name
type
Type
enum
Description
unknown shareholder director partner applicant executive
The person's type.
Name
name
Type
string
Description
The person's name.
Name
address
Type
object
Description
Show moreless
The person's address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The person's address.
Name
email
Type
string
Description
The person's email address.
Name
phone_number
Type
string
Description
The person's phone number.
Name
date_of_birth
Type
string
Description
The person's date of birth.
The organisation's members with significant control.
An object describing the participant's organisation details.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the participant.
An object describing the buyer Participant for the settlement.
Name
to
Type
object
Description
Show moreless
An object describing the beneficiary Participant for the settlement. In the case of a funding settlement this value will always be null.
Name
id
Type
string
Description
A unique ID of the participant.
A string in the format: participant_[0-9a-z].
Name
status
Type
enum
Description
unverified verifying verified
The participant status.
Name
type
Type
enum
Description
unknown individual business third_party organisation
The participant type.
Name
email
Type
string
Description
The participant's email.
Name
name
Type
string
Description
The participant's name.
Name
address
Type
object
Description
Show moreless
An object describing the participant's address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
An object describing the participant's address.
Name
bank_account
Type
object
Description
Show moreless
An object describing the participant's bank account.
Name
id
Type
string
Description
A unique ID for the bank_account.
A string in the format bank_account_[0-9a-z].
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country the bank account is held in.
Name
currency
Type
enum
Description
aed afn all amd ang aoa ars aud awg azn bam bbd bdt bgn bhd bif bmd bnd bob brl bsd btn bwp byn bzd cad cdf chf clp cny cop crc cup cve czk djf dkk dop dzd egp ern etb eur fjd fkp gbp gel ghs gip gmd gnf gtq gyd hkd hnl hrk htg huf idr ils inr iqd irr isk jmd jod jpy kes kgs khr kmf kpw krw kwd kyd kzt lak lbp lkr lrd lsl ltl lvl lyd mad mdl mga mkd mmk mnt mop mro mur mvr mwk mxn myr mzn nad ngn nio nok npr nzd omr pab pen pgk php pkr pln pyg qar ron rsd rub rwf sar sbd scr sdg sek sgd shp sll sos srd ssp std syp szl thb tjs tmt tnd top try ttd tvd twd tzs uah ugx usd uyu uzs ved vnd vuv wst xaf xcd xof xpf yer zar zmw
The currency the bank account is held in.
Name
account_number
Type
string
Description
The account number of the bank account.
Name
routing_code
Type
string
Description
The routing code of the bank account.
Name
routing_code_type
Type
enum
Description
bic_swift aba clabe cnaps wire ach bank_code ifsc sort_code
The routing code type of the bank account.
Name
routing_data
Type
object
Description
An object potentially containing further routing data.
An object describing the participant's bank account.
Name
business
Type
object
Description
Show moreless
An object describing the participant's business details.
Name
type
Type
enum
Description
unknown limited public partnership sole_trader
The type of business.
Name
company_number
Type
string
Description
The business' company number.
Name
registered_address
Type
object
Description
Show moreless
The business' registered address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The business' registered address.
Name
trading_address
Type
object
Description
Show moreless
The business' trading address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The business' trading address.
Name
shipping_address
Type
object
Description
Show moreless
The business' shipping address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The business' shipping address.
Name
phone_number
Type
string
Description
The business' phone number.
Name
website
Type
string
Description
The business' website.
Name
persons
Type
object[]
Description
Show moreless
A list of the business' employees with significant control.
Name
type
Type
enum
Description
unknown shareholder director partner applicant executive
The person's type.
Name
name
Type
string
Description
The person's name.
Name
address
Type
object
Description
Show moreless
The person's address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The person's address.
Name
email
Type
string
Description
The person's email address.
Name
phone_number
Type
string
Description
The person's phone number.
Name
date_of_birth
Type
string
Description
The person's date of birth.
A list of the business' employees with significant control.
An object describing the participant's business details.
Name
individual
Type
object
Description
Show moreless
An object describing the participant's individual details.
Name
date_of_birth
Type
string
Description
The individual's date of birth.
Name
residential_address
Type
object
Description
Show moreless
The individual's residential address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The individual's residential address.
Name
shipping_address
Type
object
Description
Show moreless
The individual's shipping address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The individual's shipping address.
Name
phone_number
Type
string
Description
The individual's phone number.
An object describing the participant's individual details.
Name
organisation
Type
object
Description
Show moreless
An object describing the participant's organisation details.
Name
type
Type
enum
Description
unknown overseas_government treaty non_profit political voluntary_group sports_club other
The type of organisation.
Name
organisation_number
Type
string
Description
The organisation's registered number.
Name
registered_address
Type
object
Description
Show moreless
The organisation's registered address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The organisation's registered address.
Name
shipping_address
Type
object
Description
Show moreless
The organisation's shipping address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The organisation's shipping address.
Name
phone_number
Type
string
Description
The organisation's phone number.
Name
website
Type
string
Description
The organisation's website.
Name
persons
Type
object[]
Description
Show moreless
The organisation's members with significant control.
Name
type
Type
enum
Description
unknown shareholder director partner applicant executive
The person's type.
Name
name
Type
string
Description
The person's name.
Name
address
Type
object
Description
Show moreless
The person's address.
Name
type
Type
enum
Description
unknown shipping billing residential registered trading
The address's type.
Name
address_line_1
Type
string
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Description
The postal code of the address.
Name
country
Type
enum
Description
AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW
The country code of the address.
The person's address.
Name
email
Type
string
Description
The person's email address.
Name
phone_number
Type
string
Description
The person's phone number.
Name
date_of_birth
Type
string
Description
The person's date of birth.
The organisation's members with significant control.
An object describing the participant's organisation details.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the participant.
An object describing the beneficiary Participant for the settlement. In the case of a funding settlement this value will always be null.
Name
amount
Type
integer
Description
The amount of the settlement.
Name
description
Type
string
Description
The provided description of the settlement.
Name
summary
Type
string
Description
The provided summary of the settlement.
Name
balance
Type
integer
Description
The current balance of the settlement. The balance for a settlement is calculated in the following way:
balance = received - (released + refunded)
A negative balance infers that funds have been released however we are still waiting for funds to reconcile into the settlement.
Name
fee_flat
Type
integer
Description
The flat fee to charge the beneficiary Participant on successfully releasing funds from the settlement.
Name
fee_percentage
Type
number
Description
The fee percentage to charge the beneficiary Participant on successfully releasing funds from the settlement.
Name
tax_flat
Type
integer
Description
The pre-computed flat tax charge that has been added to the value of the settlement. The settlement amount is inclusive of this value.
Name
tax_percentage
Type
number
Description
The tax charge that has been added to the value of the settlement, expressed as a percentage. The settlement amount is inclusive of the computed percentage amount.
Name
required_by
Type
string
Description
The date that describes when the funds are required.
Name
release_at
Type
string
Description
The date that describes when the funds will be automatically released.
Verification will be eagerly attempted if required.
Name
reference
Type
string
Description
The reference that will be used for releases from this settlement.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the underlying settlement intent.

Example

{
  "id": "settlement_58hQF4DupX",
  "created_at": "2023-12-19T18:41:24.398Z",
  "updated_at": "2023-12-19T18:41:24.398Z",
  "currency": "gbp",
  "status": "settling",
  "type": "escrow",
  "project_id": "project_36IRtw47Gz",
  "from": {
    "id": "participant_8yraDgeOOQ",
    "status": "unverified",
    "email": "sink+buyer@trustshare.co",
    "type": "individual",
    "name": "Rufus McGuire",
    "address": {
      "type": "unknown",
      "address_line_1": "50 Mereworth Road",
      "address_line_2": "Tunbridge Wells",
      "town_city": "Kent",
      "region": null,
      "postal_code": "GU10 3PL",
      "country": "GB"
    },
    "bank_account": null,
    "business": null,
    "individual": null,
    "organisation": null,
    "metadata": {}
  },
  "to": {
    "id": "participant_JevcdLf9Ky",
    "status": "unverified",
    "email": "sink+seller@trustshare.co",
    "type": "business",
    "name": null,
    "address": {
      "type": "unknown",
      "address_line_1": "1 Third Party Way",
      "address_line_2": null,
      "town_city": "Third Party City",
      "region": null,
      "postal_code": "TP1 1PT",
      "country": "GB"
    },
    "bank_account": {
      "id": "bank_account_tUKVDdAItY",
      "country": "GB",
      "currency": "gbp",
      "account_number": "01139097",
      "routing_code": "309455",
      "routing_code_type": "sort_code",
      "routing_data": {}
    },
    "business": null,
    "individual": null,
    "organisation": null,
    "metadata": {}
  },
  "amount": 100000,
  "description": "A Payment for something",
  "summary": "Local Outbound",
  "balance": 0,
  "fee_flat": 250,
  "fee_percentage": 0,
  "tax_flat": 0,
  "tax_percentage": 0.2,
  "required_by": "2023-12-19T18:41:24.192Z",
  "release_at": null,
  "reference": null,
  "metadata": {
    "foo": "managed to store meta on SETTLEMENT INTENT"
  }
}

GET/v1/settlement/{id}

Get a Settlement

Retrieve an existing settlement.

Required attributes

Name
id
Type
string
Required
Required
Description
A unique ID of an existing settlement.
A string in the format: settlement_[0-9a-z]

Request

GET

/v1/settlement/settlement_58hQF4DupX

curl https://rest.trustshare.io/v1/settlement/settlement_58hQF4DupX \ 
  -H "Authorization: <private_key>"

POST/v1/settlement/{id}/cancel

Cancel a Settlement

Used to cancel a settlement that has not yet finalised, i.e. it has a settling status.

A cancellable settlement may already have a reconciled balance, in which case, after being cancelled, the balance can be used in all the normal ways: release/refund/transfer. This situation can occur when the buyer is using manual bank transfers to pay.

The primary use for cancelling a settlement is to stop any funds being reconciled to it in the future.

Required attributes

Name
id
Type
string
Required
Required
Description
A unique ID for the settlement.
A string in the format settlement_[0-9a-z].

Request

POST

/v1/settlement/settlement_58hQF4DupX/cancel

curl -X POST https://rest.trustshare.io/v1/settlement/settlement_58hQF4DupX/cancel \ 
  -H "Authorization: <private_key>"

Settlements

Settlement types

Moving funds instantly with the immediate type

Holding funds indefinitely with the escrow type

Collecting funds without a specific target with the funding type

Moving funds between projects with the transfer type

What's next?

The settlement model

Properties

Example

Get a Settlement

Required attributes

Request

Cancel a Settlement

Required attributes

Request

Moving funds instantly with the `immediate` type

Holding funds indefinitely with the `escrow` type

Collecting funds without a specific target with the `funding` type

Moving funds between projects with the `transfer` type