Projects

Projects represent a transactional bank account in the trustshare API. All accounts are held by trustshare, which allows us to defer verification of Participants until the last possible moment.

A project can hold funds indefinitely in it's designated currency. Currently we support eur, gbp and usd projects. You can rely on us to automatically provision a project at the confirmation of a payment intent, or explicitly create a project for a specific use-case.

Controlled vs uncontrolled?

A project that is uncontrolled has been automatically provisioned for you as the result of a confirmed Payment Intent. As such, you will not be able to receive the project's collection details, ie. unique bank account number and sort code. If you need direct access to a project's collection details you must create a project via the API.

See how to create a project

The project balance

The project balance reflects only unreconciled funds in the project. Funds from Inbounds where we were unable to reconcile to a Checkout or Settlement are reflected in this value. Settlements of type funding also impact the project balance.

This mechanism allows you to take funds from a buyer participant before knowing who the seller or recipient of funds is. It also allows you to treat controlled projects like a standard bank account without the need for settlements at all.

Other settlement types hold funds within themselves, therefore disallowing release directly from the project balance. Depending on how you describe your releases when creating them will dictate how funds are relinquished from settlements and projects.

Learn more about settlement types

The project model

The project object provides a representation of a transactional bank account within the trustshare API, including it's associated Settlements and fund movements described by Inbounds, Outbounds, and Transfers.

Properties

Name
id
Type
string
Description
A unique ID for the project.
A string in the format project_[0-9a-z].
Name
created_at
Type
string
Description
The date the project was created.
Name
updated_at
Type
string
Description
The date the project was last updated.
Name
type
Type
enum
Description
uncontrolled controlled
A string of controlled | uncontrolled. Denotes whether the project has been explicitly created by calling the createProject end point. An explicitly created project will be of type controlled, while a project implicitly created through a payment intent is considered uncontrolled.
Name
currency
Type
enum
Description
gbp eur usd
The currency the project account is held in.
Name
status
Type
enum
Description
in_progress complete in_review closing closed
The status of the project.
Name
balance
Type
integer
Description
The sum of all unreconciled inbounds and funding settlement balances currently in the underlying account.
Name
checkouts
Type
object[]
Description
Show moreless
A list of checkouts that have funded the project.
Name
id
Type
string
Description
A unique ID for the checkout.
A string in the format checkout_[0-9a-z].
Name
created_at
Type
string
Description
The date the checkout was created.
Name
updated_at
Type
string
Description
The date the checkout was last updated.
Name
type
Type
enum
Description
card credit open_banking local_bank_transfer international_bank_transfer invoice direct_debit
The type of the checkout.
Name
status
Type
enum
Description
cancelled failed abandoned settling settled
The status of the checkout.
Name
participant
Type
object
Description
Show moreless
The buyer Participant of the checkout.
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.
The buyer Participant of the checkout.
Name
outstanding
Type
integer
Description
The outstanding amount on the checkout to compare against the original amount set by the payment intent.
Signifies if the checkout has been under or overfunded. In the case of overfunding, the value will be negative.
Name
amount
Type
integer
Description
The amount of the checkout.
Name
reference
Type
string
Description
The unique reference for the checkout.
Name
intent_id
Type
string
Description
The unique ID of the intent which caused the checkout to be created. This value will be null if the checkout was created via our Direct mechanism.
Name
project_id
Type
string
Description
The unique ID of the project which this checkout will fund.
Name
transfers
Type
object[]
Description
Show moreless
The transfers key historically used to represent the fees associated with the given checkout, since these fees are "transfered" to the partner revenue accounts.
These fee transfers will now be listed under the fees key.
While transfers going forward, will globally denote within-system fund movements initiated by the API user.
Name
id
Type
string
Description
The unique ID of the transfer.
A string in the format: transfer_[0-9a-z].
Name
created_at
Type
string
Description
The date the transfer was created.
Name
updated_at
Type
string
Description
The date the transfer was last updated.
Name
type
Type
enum
Description
fee
The type of transfer.
Name
subtype
Type
enum
Description
buyer seller
The subtype of transfer.
Name
status
Type
enum
Description
awaiting_funds executing executed failed cancelled scheduled
The status of the transfer.
Name
amount
Type
integer
Description
The amount of the transfer.
Name
from
Type
object
Description
Show moreless
The object describing the settlement or project originatig the funds being transfered.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
The object describing the settlement or project originatig the funds being transfered.
Name
to
Type
object
Description
Show moreless
The object describing the target project of the transfer.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
The object describing the target project of the transfer.
Name
inbound_id
Type
string
Description
The unique ID of the inbound that describes funds entering the target project as a result of this transfer.
Name
outbound_id
Type
string
Description
The unique ID of the outbound that describes funds leaving the source project as a result of this transfer.
Name
release_at
Type
string
Description
The date that describes when the funds will be automatically transfered.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the transfer.
The transfers key historically used to represent the fees associated with the given checkout, since these fees are "transfered" to the partner revenue accounts.
These fee transfers will now be listed under the fees key.
While transfers going forward, will globally denote within-system fund movements initiated by the API user.
Name
fees
Type
object[]
Description
Show moreless
A list of fee transfers associated with the checkout.
Name
created_at
Type
string
Description
The date the fee was created.
Name
updated_at
Type
string
Description
The date the fee was last updated.
Name
type
Type
enum
Description
fee
The type of fee.
Name
subtype
Type
enum
Description
buyer seller
The subtype of fee.
Name
amount
Type
integer
Description
The amount of the fee.
A list of fee transfers associated with the checkout.
Name
settlements
Type
object[]
Description
Show moreless
A list of settlements that were targeted by the checkout.
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.
A list of settlements that were targeted by the checkout.
Name
debits
Type
object[]
Description
Show moreless
A list of direct debit payments that have been scheduled by the checkout.
Name
id
Type
string
Description
A unique ID for the debit.
A string in the format debit_[0-9a-z].
Name
status
Type
enum
Description
scheduled executing settling settled cancelled failed
The status of the debit.
Name
scheduled_at
Type
string
Description
The date trustshare will attempt to take payment from the payer's bank account.
Name
amount
Type
integer
Description
The amount of the debit payment.
Name
checkout_id
Type
string
Description
A unique ID for the checkout this debit has been created for.
Name
project_id
Type
string
Description
The unique ID of the project which this debit will fund.
A list of direct debit payments that have been scheduled by the checkout.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the payment intent that caused this checkout.
A list of checkouts that have funded the project.
Name
settlements
Type
object[]
Description
Show moreless
A list of settlements against the project.
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.
A list of settlements against the project.
Name
inbounds
Type
object[]
Description
Show moreless
A list of inbounds which denote physical receipt of funds into the project account.
Name
id
Type
string
Description
A unique ID for the inbound.
A string in the format inbound_[0-9a-z].
Name
created_at
Type
string
Description
The date the project was created.
Name
updated_at
Type
string
Description
The date the project was last updated.
Name
project_id
Type
string
Description
The unique ID of the project which this inbound funds.
Name
checkout_id
Type
string
Description
The unique ID of the checkout that this inbound has been reconciled against.
If we were unable to reconcile the inbound to a specific checkout this value will be null.
Name
transfer
Type
object
Description
Show moreless
The transfer that initiated the creation of this inbound to denote fund movements.
Name
id
Type
string
Description
A unique ID for the transfer.
A string in the format transfer_[0-9a-z].
Name
from
Type
object
Description
Show moreless
An object describing the source of the transfer that initiated funds entering this project.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
An object describing the source of the transfer that initiated funds entering this project.
Name
inbound_id
Type
string
Description
The unique ID of the inbound that describes funds entering this project as a result of the transfer.
The transfer that initiated the creation of this inbound to denote fund movements.
Name
type
Type
enum
Description
card credit open_banking local_bank_transfer international_bank_transfer manual_bank_transfer transfer
The type of the inbound.
Name
status
Type
enum
Description
settling settled in_review
The status of the inbound.
Name
amount
Type
integer
Description
The amount of the inbound.
Name
reference
Type
string
Description
The reference that was used for the inbound.
This will be null if no reference is provided by the buyer or the inbound is not a bank transfer, ie. manual or Open Banking initiated.
A list of inbounds which denote physical receipt of funds into the project account.
Name
outbounds
Type
object[]
Description
Show moreless
A list of outbounds that have sent funds from the project account.
Name
id
Type
string
Description
A unique ID for the outbound.
A string in the format outbound_[0-9a-z].
Name
created_at
Type
string
Description
The date the outbound was created.
Name
updated_at
Type
string
Description
The date the outbound was last updated.
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
project_id
Type
string
Description
The project ID the outbound was created against.
Name
settlement_id
Type
string
Description
The settlement ID the outbound was created against. In the event funds were released directly from a project, this value will be null.
Name
type
Type
enum
Description
release refund transfer payout
The type of the outbound.
Name
status
Type
enum
Description
scheduled awaiting_funds automated_review paused executing executed failed cancelled in_review processing
The status of the outbound.
Name
amount
Type
integer
Description
The amount of the outbound.
Name
to
Type
object
Description
Show moreless
An object describing the beneficiary Participant for the outbound payment.
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 outbound payment.
Name
transfers
Type
object[]
Description
Show moreless
The transfers key historically used to represent the fees associated with the given outbound, since these fees are "transfered" to the partner revenue accounts.
These fee transfers will now be listed under the fees key.
While transfers going forward, will globally denote within-system fund movements initiated by the API user.
Name
id
Type
string
Description
The unique ID of the transfer.
A string in the format: transfer_[0-9a-z].
Name
created_at
Type
string
Description
The date the transfer was created.
Name
updated_at
Type
string
Description
The date the transfer was last updated.
Name
type
Type
enum
Description
fee
The type of transfer.
Name
subtype
Type
enum
Description
buyer seller
The subtype of transfer.
Name
status
Type
enum
Description
awaiting_funds executing executed failed cancelled scheduled
The status of the transfer.
Name
amount
Type
integer
Description
The amount of the transfer.
Name
from
Type
object
Description
Show moreless
The object describing the settlement or project originatig the funds being transfered.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
The object describing the settlement or project originatig the funds being transfered.
Name
to
Type
object
Description
Show moreless
The object describing the target project of the transfer.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
The object describing the target project of the transfer.
Name
inbound_id
Type
string
Description
The unique ID of the inbound that describes funds entering the target project as a result of this transfer.
Name
outbound_id
Type
string
Description
The unique ID of the outbound that describes funds leaving the source project as a result of this transfer.
Name
release_at
Type
string
Description
The date that describes when the funds will be automatically transfered.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the transfer.
The transfers key historically used to represent the fees associated with the given outbound, since these fees are "transfered" to the partner revenue accounts.
These fee transfers will now be listed under the fees key.
While transfers going forward, will globally denote within-system fund movements initiated by the API user.
Name
fees
Type
object[]
Description
Show moreless
A list of any fees created as the result of the outbound.
Name
created_at
Type
string
Description
The date the fee was created.
Name
updated_at
Type
string
Description
The date the fee was last updated.
Name
type
Type
enum
Description
fee
The type of fee.
Name
subtype
Type
enum
Description
buyer seller
The subtype of fee.
Name
amount
Type
integer
Description
The amount of the fee.
A list of any fees created as the result of the outbound.
Name
transfer
Type
object
Description
Show moreless
The transfer that initiated the creation of this outbound to denote fund movements.
Name
id
Type
string
Description
A unique ID for the transfer.
A string in the format transfer_[0-9a-z].
Name
to
Type
object
Description
Show moreless
An object describing the target of the transfer that initiated funds leaving this project.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
An object describing the target of the transfer that initiated funds leaving this project.
Name
outbound_id
Type
string
Description
The unique ID of the outbound that describes funds leaving this project as a result of the transfer.
The transfer that initiated the creation of this outbound to denote fund movements.
Name
conversion
Type
object
Description
Show moreless
An object describing a potential currency conversion to achieve the outbound.
Name
from
Type
enum
Description
gbp eur usd
The currency being converted.
Name
to
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 target currency of the conversion.
Name
status
Type
enum
Description
pending executing accepted failed
The status of the conversion.
Name
expected_amount
Type
integer
Description
The expected amount of the conversion in the target currency. The amount is always in the lowest denomination of the target currency, so please be aware of the target currencies minor unit.
Name
rate
Type
number
Description
The conversion rate in the form from -> to.
An object describing a potential currency conversion to achieve the outbound.
Name
paused_reason
Type
enum
Description
pending_participant_verification
The reason why the outbound is currently in a paused status.
Name
failure_reason
Type
enum
Description
fx_amount_too_small unable_to_determine_target_account invalid_reference invalid_target_account_credentials missing_participant_information generic_failure_contact_support unsupported_payout_route
The reason why the outbound is currently in a failed status.
Name
reference
Type
string
Description
The reference that will be used for the outbound.
The reference can be up to 18 characters in length and supports a-z, A-Z, 0-9, -, and space characters.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the release or refund.
A list of outbounds that have sent funds from the project account.
Name
transfers
Type
object
Description
Show moreless
An object containing lists of transfers in and out, that have caused funds to enter/leave this project.
Name
in
Type
object[]
Description
Show moreless
A list of transfers that have caused funds to enter this project.
Name
id
Type
string
Description
A unique ID for the transfer.
A string in the format transfer_[0-9a-z].
Name
from
Type
object
Description
Show moreless
An object describing the source of the transfer that initiated funds entering this project.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
An object describing the source of the transfer that initiated funds entering this project.
Name
inbound_id
Type
string
Description
The unique ID of the inbound that describes funds entering this project as a result of the transfer.
A list of transfers that have caused funds to enter this project.
Name
out
Type
object[]
Description
Show moreless
A list of transfers that have caused funds to leave this project.
Name
id
Type
string
Description
A unique ID for the transfer.
A string in the format transfer_[0-9a-z].
Name
to
Type
object
Description
Show moreless
An object describing the target of the transfer that initiated funds leaving this project.
Name
project_id
Type
string
Description
The unique ID of the project originating the funds being transfered.
Name
settlement_id
Type
string
Description
The unique ID of the settlement originating the funds being transfered.
An object describing the target of the transfer that initiated funds leaving this project.
Name
outbound_id
Type
string
Description
The unique ID of the outbound that describes funds leaving this project as a result of the transfer.
A list of transfers that have caused funds to leave this project.
An object containing lists of transfers in and out, that have caused funds to enter/leave this project.
Name
collect
Type
object
Description
Show moreless
Payment details for the underlying account for local and international collection routes.
Name
local_bank_transfer
Type
object
Description
Show moreless
An object describing collection account details for local payments.
Name
iban
Type
string
Description
The IBAN of the collection account.
Name
account_number
Type
string
Description
The account number of the collection account. For EUR accounts, this will be null.
Name
routing_data
Type
object[]
Description
Show moreless
Object array containing account routing information required to make payments to the collection account. The below list describes the types of routing_data you can receive for each collection currency.

usd - the type can be ach, wire, or bic_swift

eur - the type will be bic_swift

gbp - the type can be sort_code, or bic_swift

Name
routing_code_type
Type
enum
Description
sort_code bic_swift ach wire
The routing code type required to make payments to the project account, corresponding to the holding currency.
Name
routing_code
Type
string
Description
The routing code value.
Object array containing account routing information required to make payments to the collection account. The below list describes the types of routing_data you can receive for each collection currency.

usd - the type can be ach, wire, or bic_swift

eur - the type will be bic_swift

gbp - the type can be sort_code, or bic_swift

Name
reference
Type
string
Description
The payment reference must be used if defined, otherwise the payment might not be reconciled correctly.
Name
metadata
Type
object
Description
Collection account metadata associated with sending payments, such as bank name and address.
An object describing collection account details for local payments.
Name
international_bank_transfer
Type
object
Description
Show moreless
An object describing collection account details for international payments.
Name
iban
Type
string
Description
The IBAN of the collection account.
Name
account_number
Type
string
Description
The account number of the collection account. For EUR accounts, this will be null.
Name
routing_data
Type
object[]
Description
Show moreless
Object array containing account routing information required to make payments to the collection account. The below list describes the types of routing_data you can receive for each collection currency.

usd - the type can be ach, wire, or bic_swift

eur - the type will be bic_swift

gbp - the type can be sort_code, or bic_swift

Name
routing_code_type
Type
enum
Description
sort_code bic_swift ach wire
The routing code type required to make payments to the project account, corresponding to the holding currency.
Name
routing_code
Type
string
Description
The routing code value.
Object array containing account routing information required to make payments to the collection account. The below list describes the types of routing_data you can receive for each collection currency.

usd - the type can be ach, wire, or bic_swift

eur - the type will be bic_swift

gbp - the type can be sort_code, or bic_swift

Name
reference
Type
string
Description
The payment reference must be used if defined, otherwise the payment might not be reconciled correctly.
Name
metadata
Type
object
Description
Collection account metadata associated with sending payments, such as bank name and address.
An object describing collection account details for international payments.
Payment details for the underlying account for local and international collection routes.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the project.

Example

{
  "id": "project_rqh1rMNnMs",
  "created_at": "2023-12-19T18:41:23.541Z",
  "updated_at": "2023-12-19T18:41:23.541Z",
  "type": "controlled",
  "currency": "gbp",
  "status": "in_progress",
  "balance": 0,
  "collect": {
    "local_bank_transfer": {
      "iban": null,
      "account_number": "03554465",
      "routing_data": [
        {
          "routing_code_type": "sort_code",
          "routing_code": "000000"
        }
      ],
      "reference": null,
      "metadata": {
        "bank_name": "Modulr FS",
        "bank_address": "Scale Space, 58 Wood Lane, London, United Kingdom, W12 7RZ",
        "payee_name": "trustshare limited",
        "payee_address": "71-75 Shelton Street, London. WC2H 9JQ",
        "payee_tel": "0044 2045199980"
      }
    },
    "international_bank_transfer": {
      "iban": "GB32TRWI230xxxxxxxxxxx",
      "account_number": null,
      "routing_data": [
        {
          "routing_code_type": "bic_swift",
          "routing_code": "TRWIGB2L"
        }
      ],
      "reference": "P9NENBMK2",
      "metadata": {
        "bank_name": "Wise",
        "bank_address": "56 Shoreditch High Street, London. E1 6JJ. United Kingdom",
        "payee_name": "trustshare limited",
        "payee_address": "71-75 Shelton Street, London. WC2H 9JQ",
        "payee_tel": "0044 2045199980"
      }
    }
  },
  "checkouts": [],
  "settlements": [],
  "inbounds": [],
  "outbounds": [],
  "transfers": {
    "in": [],
    "out": []
  },
  "metadata": {
    "foo": "managed to store my own meta"
  }
}

GET/v1/project/{id}

Get a Project

Retrieve an existing project.

Required attributes

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

Request

GET

/v1/project/project_rqh1rMNnMs

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

POST/_sandbox/v1/project/{id}/credit

Credit a Project

For use in sandbox only.

Credit a project with an amount of funds. An optional reference can be provided to target a specific checkout.

Required attributes

Name
id
Type
string
Required
Required
Description
A unique ID of an existing project.
A string in the format: project_[0-9a-z]
Name
amount
Type
integer
Required
Required
Description
The amount to credit to the project in the lowest denomination for the intent's currency. ie, £1,000.00 should be provided as 100000.

Optional attributes

Name
reference
Type
string
Description
The reference to use for the credit. With this value you can target an existing checkout or invoice.
References are in the format C[A-Z0-9].

Request

POST

/_sandbox/v1/project/project_5T3ch0hE49/credit

curl -X POST https://rest.trustshare.io/_sandbox/v1/project/project_5T3ch0hE49/credit \ 
  -H "Authorization: <private_key>" \ 
  -d @- << EOF
  {
    "amount": 5000
  }
  EOF

Response

{
  "success": true
}

POST/v1/projects

Create a Project

Creating a Project allows you to take control of a project account. This account can be used to collect funds from any number of Participants, as well as release funds to any number of Participants.

Required attributes

Name
currency
Type
enum
Required
Required
Description
gbp eur usd
The currency the project account will be held in.

Optional attributes

Name
metadata
Type
object
Description
A free-form metadata object that you can use to store against the project. This is incredibly useful for storing a correlation ID that relates to an entity on your own system.

Request

POST

/v1/projects

curl -X POST https://rest.trustshare.io/v1/projects \ 
  -H "Authorization: <private_key>" \ 
  -d @- << EOF
  {
    "currency": "gbp",
    "metadata": {
      "foo": "managed to store my own meta"
    }
  }
  EOF