Payment Intents

Payment Intents are a fundamental feature of the trustshare API that enable buyers to make payments to sellers with confidence and ease. The mechanism provides a secure and reliable way for you to initiate transactions between buyer and seller Participants, and can be customized to support a range of use cases.

A payment intent requires confirmation from the buyer and, in most cases, the intent will be consumed upon confirmation. If no Project is provided as the target of the intent, we will automatically provision a new account for the transaction.

Intent types

Payment Intents support multiple types, such as checkout, payment_link, and invoice, and can be used for both simple and complex transactions. Each type has its own specific properties and confirmation process. An intent is made up of a collection of Settlements.

Learn more about settlement types

Customised UI with the `checkout` and `payment_link` types

Both the checkout and payment_link types allow you to show your user a customised checkout UI that describes one or many line-items that define a transaction between a buyer and one or many seller Participants.

Buyers can use payment methods configured for your account, including Cards, Open Banking, Bank transfer, and Trade Account credit. The UI will automatically infer the supported payment methods from the contents of the intent.

The checkout intent will return a client_secret that requires confirmation via the SDK on the buyer's device. Alternatively, the payment_link type will return a url property which contains a shareable link.

See how to create a UI-based intent

Headless transactions with the `invoice` type

An invoice type payment intent describes a buyer participant's intent to fulfill an invoice, now or in the future. It offers the same mechanism to describe settlements to multiple sellers from a single buyer.

An invoice type intent will, in most cases, require confirmation from the users device via the SDK, however no UI will be displayed to the user. It is up to your implementation how you intend to show the required information for the user to fulfill the invoice.

Alternatively, you can confirm an invoice type intent via the API where certain criteria are met. Confirming a payment intent, requires a session_id that can be retrieved via a Setup Intent.

The creation of an invoice intent requires the pre-creation of a "controlled" project.

See how to create an invoice intent

The payment intent model

The payment intent object provides a comprehensive representation of an intended payment transaction within the trustshare API, including the buyer Participant, and Settlements.

Properties

Name
__typename
Type
enum
Description
PaymentIntent LinkIntent
Name
id
Type
string
Description
The unique identifier of the created intent.
Name
created_at
Type
string
Description
The date the payment intent was created.
Name
updated_at
Type
string
Description
The date the payment intent was last updated.
Name
project_id
Type
string
Description
The unique ID of the project which this intent targets.
Name
from
Type
object
Description
Show moreless
An object describing the buying Participant for the payment. Will be null when created without a defined buyer.
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 buying Participant for the payment. Will be null when created without a defined buyer.
Name
client_secret
Type
string
Description
The client secret for the intent.
This secret should never be stored on a backend system and should always be directly passed down to the expected participant's device.
Name
status
Type
enum
Description
unconfirmed confirmed cancelled debug
The status of the payment intent.
Name
currency
Type
enum
Description
gbp eur usd
The currency of the payment intent. If this payment intent is not against an existing Project, the currency here will dictate the currency that the transactional account should be provisioned for.
Name
type
Type
enum
Description
checkout payment_link invoice session
The type of the payment intent.
Name
fee_flat
Type
integer
Description
A flat fee to charge the buyer Participant on successfully completing the intent.
Fees are calculated in the following way: (total * (1 + fee_percentage)) + fee_flat.
Name
fee_percentage
Type
number
Description
A fee percentage to charge the buyer Participant on successfully completing the intent. Fee percentages must be provided as a fraction, ie. 1.5% as 0.015.
Fees are calculated in the following way: (total * (1 + fee_percentage)) + fee_flat.
Name
settlements
Type
object[]
Description
Show moreless
A list of settlement intents. These describe the line items that will be displayed on the Checkout UI.
Name
created_at
Type
string
Description
The date the settlement intent was created.
Name
updated_at
Type
string
Description
The date the settlement intent was last updated.
Name
to
Type
object
Description
Show moreless
The beneficiary Participant of the settlement intent. Where the type is funding this will 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.
The beneficiary Participant of the settlement intent. Where the type is funding this will be null.
Name
type
Type
enum
Description
funding immediate escrow transfer
The settlement intent type.
Name
amount
Type
integer
Description
The amount of the settlement intent.
Name
description
Type
string
Description
A description of the reason for the settlement.
Name
summary
Type
string
Description
An optional summary of the settlement.
Name
fee_flat
Type
integer
Description
The flat fee the beneficiary Participant will be pay on each release from the settlement.
Name
fee_percentage
Type
number
Description
The percentage fee the beneficiary Participant will pay on each release 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
A date that describes when the funds are required. If the funds are required at a future date, the amount will not be included in the total on the Checkout UI.
You can collect funds against this settlement at a later date by creating a new payment intent that targets the settlement ID when the buyer Participant agrees to the Checkout.
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 settlement intent.
A list of settlement intents. These describe the line items that will be displayed on the Checkout UI.
Name
redirect_url
Type
string
Description
The redirect URL supplied at the creation of the intent.
Name
metadata
Type
object
Description
The metadata that was provided at the creation of the payment intent.
Name
url
Type
string
Description
The URL that can be shared to complete this payment.

Example

{
  "__typename": "PaymentIntent",
  "id": "intent_yUp8bMPp0S",
  "created_at": "2023-12-20T14:14:19.500Z",
  "updated_at": "2023-12-20T14:14:19.500Z",
  "client_secret": "sandbox_i_HAehWCcHPVAbqAEDxKkS3LrvWLmLEU1RGNFRKLJI26gmLzIeSZVNlpCJTr6kjyqm",
  "project_id": null,
  "from": {
    "id": "participant_UJfvRzo3Xk",
    "status": "unverified",
    "email": "sink+buyer@trustshare.co",
    "type": "individual",
    "name": "Rufus McGuire",
    "address": {
      "type": "unknown",
      "address_line_1": "23 The Road",
      "address_line_2": null,
      "town_city": "London",
      "region": "Greater London",
      "postal_code": "N22 6TY",
      "country": "GB"
    },
    "bank_account": null,
    "business": null,
    "individual": null,
    "organisation": null,
    "metadata": {}
  },
  "fee_flat": 1000,
  "fee_percentage": 0.015,
  "status": "unconfirmed",
  "currency": "gbp",
  "type": "checkout",
  "metadata": {
    "foo": "managed to store meta on PAYMENT INTENT"
  },
  "redirect_url": null,
  "settlements": [
    {
      "created_at": "2023-12-20T14:14:19.500Z",
      "updated_at": "2023-12-20T14:14:19.500Z",
      "to": null,
      "type": "funding",
      "amount": 1000,
      "description": "Some funding",
      "summary": null,
      "fee_flat": 0,
      "fee_percentage": 0,
      "tax_flat": 0,
      "tax_percentage": 0,
      "required_by": "2023-12-20T14:14:19.500Z",
      "release_at": null,
      "reference": null,
      "metadata": {
        "foo": "managed to store meta on SETTLEMENT INTENT"
      }
    },
    {
      "created_at": "2023-12-20T14:14:19.500Z",
      "updated_at": "2023-12-20T14:14:19.500Z",
      "to": {
        "id": "participant_7kjauDtnjW",
        "status": "unverified",
        "email": "sink+seller@trustshare.co",
        "type": "unknown",
        "name": null,
        "address": null,
        "bank_account": null,
        "business": null,
        "individual": null,
        "organisation": null,
        "metadata": {}
      },
      "type": "escrow",
      "amount": 1000,
      "description": "Funds held in escrow",
      "summary": null,
      "fee_flat": 0,
      "fee_percentage": 0,
      "tax_flat": 0,
      "tax_percentage": 0,
      "required_by": "2023-12-20T14:14:19.500Z",
      "release_at": null,
      "reference": null,
      "metadata": {
        "foo": "managed to store meta on SETTLEMENT INTENT"
      }
    },
    {
      "created_at": "2023-12-20T14:14:19.500Z",
      "updated_at": "2023-12-20T14:14:19.500Z",
      "to": {
        "id": "participant_wbGGky93H5",
        "status": "unverified",
        "email": "sink+seller@trustshare.co",
        "type": "business",
        "name": null,
        "address": null,
        "bank_account": {
          "id": "bank_account_tUKVDdAItY",
          "country": "GB",
          "currency": "gbp",
          "account_number": "01139097",
          "routing_code": "309455",
          "routing_code_type": "sort_code",
          "routing_data": {}
        },
        "business": null,
        "individual": null,
        "organisation": null,
        "metadata": {}
      },
      "type": "immediate",
      "amount": 100000,
      "description": "Funds for immediate release",
      "summary": null,
      "fee_flat": 250,
      "fee_percentage": 0,
      "tax_flat": 0,
      "tax_percentage": 0,
      "required_by": "2023-12-20T14:14:19.500Z",
      "release_at": null,
      "reference": null,
      "metadata": {}
    }
  ]
}

GET/v1/intent/{id}

Get an Intent

Retrieve an existing intent.

This endpoint is polymorphic and will return any intent type, including both Payment Intents and Setup Intents.

Required attributes

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

Request

GET

/v1/intent/intent_yUp8bMPp0S

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

POST/v1/intents/payment

Create a Payment Intent

A payment intent describes a participants intention to fund a project account. We currently support 3 different types of Payment Intent:

A checkout Payment Intent is consumed as soon as a Participant clicks "Pay Now" on the Checkout UI. It therefore, can not be re-used.
A payment_link Payment Intent is consumed and can be re-used if it does not include a from Participant.
An invoice Payment Intent, although still requiring confirmation of a user, will not take them through a UI driven process. On confirmation of an invoice Payment Intent, a new invoice will be provisioned.

See the available attributes

With or without a defined buyer

A buyer can optionally be provided at the creation of an intent. If no buyer is provided, the user confirming the intent will be asked to provide their email address and a new participant will be created in the system.

At a minimum, when a buyer participant is provided, we require just the email address. However, you can also provide a name and an address which will be used in the UI to further personalise the buyer's experience.

Include inline fees

Fees can be applied to a payment intent to charge a buyer at successful completion of a checkout. Fees can also be applied to a settlement to charge a seller at each successful release from a settlement. You can provide both an optional flat fee and an optional percentage fee to charge. The percentage fee must be provided to the API as a fraction, ie. a fee of 1.5% is provided to the API as 0.015.

Fees are always calculated as: (total * fee_percentage) + fee_flat

Targeting an existing project

At creation, an intent can optionally be targeted at an existing project. This is useful if you wish to provision a project account up front, or if you need to collect more funds in the event of a discrepancy. You can find more information about how projects relate to the rest of the system by referencing our Projects page.

You may not need projects for your use-case. However, every checkout is backed by an under-lying project account.

Required attributes

Name
type
Type
enum
Required
Required
Description
checkout payment_link invoice
The type of Payment Intent to create.
Name
settlements
Type
object[]
Required
Required
Description
Show moreless
A list of settlements that the buyer Participant must fulfill.
Name
id
Type
string
Description
An ID of an existing settlement to target, allowing a user to Checkout against a settlement with a discrepancy or a settlement required at a future date.
A string in the format settlement_[0-9a-z].
Name
type
Type
enum
Description
funding immediate escrow transfer
The type of settlement to be created.
Name
to
Type
object
Description
Show moreless
An object describing the beneficiary Participant for this settlement.
Name
id
Type
string
Description
A unique ID of a participant to use for this intent.
A string in the format: participant_[0-9a-z].
Name
email
Type
string
Description
The email address of the participant in this intent.
Name
type
Type
enum
Description
unknown individual business third_party organisation
The type of participant.
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 of a bank account to target for this intent.
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
iban
Type
string
Description
The IBAN of the bank account.
Name
aba
Type
string
Description
The ABA routing code of the bank account (US only).
Name
bank_code
Type
string
Description
The Bank Code of the bank account.
Name
bic_swift
Type
string
Description
The Bank Identifier Code of the bank account on the SWIFT network.
Name
branch_code
Type
string
Description
The Branch Code of the bank account.
Name
bsb_code
Type
string
Description
The BSB code of the bank account (AU only).
Name
clabe
Type
string
Description
The CLABE of the bank account (MX only).
Name
cnaps
Type
string
Description
The CNAPS of the bank account (CN only).
Name
ifsc
Type
string
Description
The IFSC of the bank account (IN only).
Name
sort_code
Type
string
Description
The Sort Code of the bank account (UK only).
Name
bank_name
Type
string
Description
The Bank Name of the bank account.
Name
bank_address
Type
string
Description
The Bank Address of the bank account.
Name
identification
Type
string
Description
The identification type of the bank account (MX only).
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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
website
Type
string
Description
The business' website.
Name
phone_number
Type
string
Description
The business' phone number.
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 dsescribing 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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 dsescribing 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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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
project_id
Type
string
Description
A unique ID of a project to use as the target for this settlement.
A string in the format: project_[0-9a-z].
Name
metadata
Type
object
Description
A free-form metadata object that you can use to store against the participant. This is incredibly useful for storing a correlation ID that relates to an entity on your own system.
An object describing the beneficiary Participant for this settlement.
Name
amount
Type
integer
Description
The amount of the settlement described in the lowest denomination for the intent's currency. ie, £1,000.00 should be provided as 100000.
Name
description
Type
string
Description
A description of the settlement that will be displayed as a line item in the Checkout UI.
Name
summary
Type
string
Description
A further summary of the settlement that will be displayed under the line item in the Checkout UI.
Name
fee_flat
Type
integer
Description
A flat fee to charge the beneficiary Participant on successfully releasing funds from the settlement.
Fees are calculated in the following way: (total * (1 + fee_percentage)) + fee_flat.
Name
fee_percentage
Type
number
Description
A fee percentage to charge the beneficiary Participant on successfully releasing funds from the settlement. Fee percentages must be provided as a fraction, ie. 1.5% as 0.015.
Fees are calculated in the following way: (total * (1 + fee_percentage)) + fee_flat.
Name
tax_flat
Type
integer
Description
A pre-computed flat tax charge that has been added to the value of the settlement. The settlement amount should be inclusive of this value.
Flat tax amount must be described in the lowest denomination for the intent's currency. ie, £20.00 should be provided as 2000.
Assuming a 20% tax rate and a line item for a value of £100, amount and tax_flat should be:
{ ... "amount": 12000, "tax_flat": 2000, ... }
tax_flat and tax_percentage are mutually exlusive for the same settlement.
Name
tax_percentage
Type
number
Description
A pre-computed tax charge that has been added to the value of the settlement, expressed as a percentage. The settlement amount should be inclusive of the computed percentage amount.
Tax percentages must be provided as a fraction, ie. 20% as 0.2.
Assuming a 20% tax rate and a line item for a value of £100, amount and tax_percentage should be:
{ ... "amount": 12000, "tax_percentage": 0.2, ... }
tax_flat and tax_percentage are mutually exlusive for the same settlement.
Name
required_by
Type
string
Description
A date that describes when the funds are required. If the funds are required at a future date, the amount will not be included in the total on the Checkout UI.
You can collect funds against this settlement at a later date by creating a new payment intent that targets the settlement ID when the buyer Participant agrees to the Checkout.
Name
release_at
Type
string
Description
A date that describes when the funds should be automatically released.
Verification will be eagerly attempted if required.
Name
reference
Type
string
Description
A reference that will be used for releases from this settlement and will appear on a beneficiary's bank statement.
Name
metadata
Type
object
Description
A free-form metadata object that you can use to store against the settlement. This is incredibly useful for storing a correlation ID that relates to an entity on your own system.
A list of settlements that the buyer Participant must fulfill.

Optional attributes

Name
currency
Type
enum
Description
gbp eur usd
The currency to collect for the payment. If a project_id is provided, this currency must equate to the currency of the project account.
Name
from
Type
object
Description
Show moreless
Optionally provide the buyer Participant to prefill information in the checkout UI. If no buyer is provided, then the UI will include a field to collect their email address.
By not providing a buyer, the intent will not be consumed. Allowing it to be used for multiple buyers of the same transaction.
Name
id
Type
string
Description
A unique ID of a participant that already exists on the system.
A string in the format: participant_[0-9a-z].
Name
email
Type
string
Description
The email address of the participant.
Name
type
Type
enum
Description
unknown individual business third_party organisation
The type of participant.
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 of a bank account to target for this intent.
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
iban
Type
string
Description
The IBAN of the bank account.
Name
aba
Type
string
Description
The ABA routing code of the bank account (US only).
Name
bank_code
Type
string
Description
The Bank Code of the bank account.
Name
bic_swift
Type
string
Description
The Bank Identifier Code of the bank account on the SWIFT network.
Name
branch_code
Type
string
Description
The Branch Code of the bank account.
Name
bsb_code
Type
string
Description
The BSB code of the bank account (AU only).
Name
clabe
Type
string
Description
The CLABE of the bank account (MX only).
Name
cnaps
Type
string
Description
The CNAPS of the bank account (CN only).
Name
ifsc
Type
string
Description
The IFSC of the bank account (IN only).
Name
sort_code
Type
string
Description
The Sort Code of the bank account (UK only).
Name
bank_name
Type
string
Description
The Bank Name of the bank account.
Name
bank_address
Type
string
Description
The Bank Address of the bank account.
Name
identification
Type
string
Description
The identification type of the bank account (MX only).
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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
website
Type
string
Description
The business' website.
Name
phone_number
Type
string
Description
The business' phone number.
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 dsescribing 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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 dsescribing 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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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 type of the address, defaults to unknown.
Name
address_line_1
Type
string
Required
Required
Description
First line of the address.
Name
address_line_2
Type
string
Description
Second line of the address.
Name
town_city
Type
string
Required
Required
Description
The town/city of the address.
Name
region
Type
string
Description
The region of the address.
Name
postal_code
Type
string
Required
Required
Description
The postal code of the address.
Name
country
Type
enum
Required
Required
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
A free-form metadata object that you can use to store against the participant. This is incredibly useful for storing a correlation ID that relates to an entity on your own system.
Optionally provide the buyer Participant to prefill information in the checkout UI. If no buyer is provided, then the UI will include a field to collect their email address.
By not providing a buyer, the intent will not be consumed. Allowing it to be used for multiple buyers of the same transaction.
Name
project_id
Type
string
Description
Optionally provide a project_id to target the payemnt at an existing project account. If no project_id is provided, a new Project will be automatically provisioned for you.
Name
fee_flat
Type
integer
Description
A flat fee to charge the buyer Participant on successfully completing a Checkout.
Name
fee_percentage
Type
number
Description
A fee percentage to charge the buyer Participant on successfully completing a Checkout. Fee percentages must be provided as a fraction, ie. 1.5% as 0.015.
Name
redirect_url
Type
string
Description
For both checkout and payment_link intent types you can provide a redirect URL that the user will be directed to at the end of the checkout process.
The URL will have the project_id and checkout_id appended to the query string. For example, given the redirect URL https://example.com/complete, your users will be redirected to https://example.com/complete?checkout_id={checkout_id}&project_id={project_id}.
When using the SDK to confirm a checkout type payment intent, the parent page — ie. the page opening the modal — will be redirected to this URL.
Name
metadata
Type
object
Description
A free-form metadata object that you can use to store against the intent. This is incredibly useful for storing a correlation ID that relates to an entity on your own system.

Request

POST

/v1/intents/payment

curl -X POST https://rest.trustshare.io/v1/intents/payment \ 
  -H "Authorization: <private_key>" \ 
  -d @- << EOF
  {
    "type": "checkout",
    "currency": "gbp",
    "fee_flat": 1000,
    "fee_percentage": 0.015,
    "metadata": {
      "foo": "managed to store meta on PAYMENT INTENT"
    },
    "from": {
      "email": "sink+buyer@trustshare.co",
      "type": "individual",
      "name": "Rufus McGuire",
      "address": {
        "address_line_1": "23 The Road",
        "town_city": "London",
        "region": "Greater London",
        "postal_code": "N22 6TY",
        "country": "GB"
      }
    },
    "settlements": [
      {
        "type": "funding",
        "amount": 1000,
        "description": "Some funding",
        "metadata": {
          "foo": "managed to store meta on SETTLEMENT INTENT"
        }
      },
      {
        "type": "escrow",
        "amount": 1000,
        "description": "Funds held in escrow",
        "to": {
          "email": "sink+seller@trustshare.co"
        },
        "metadata": {
          "foo": "managed to store meta on SETTLEMENT INTENT"
        }
      },
      {
        "type": "immediate",
        "amount": 100000,
        "description": "Funds for immediate release",
        "fee_flat": 250,
        "to": {
          "type": "business",
          "email": "sink+seller@trustshare.co",
          "bank_account": {
            "country": "GB",
            "currency": "gbp",
            "account_number": "01139097",
            "sort_code": "309455"
          }
        }
      }
    ]
  }
  EOF

POST/v1/intent/{id}/confirm

Confirm a Payment Intent

In certain cases you may be able to confirm a payment intent from your backend system and not require a user to go through a checkout UI process.

Confirming a payment intent from the API requires a session_id to be provided which refers to a session from a Setup Intent, that has not already expired.

You can only confirm invoice payment intents via the API.

Required attributes

Name
id
Type
string
Required
Required
Description
A unique ID of an existing intent that needs to be confirmed.
A string in the format: intent_[0-9a-z]
Name
session_id
Type
string
Required
Required
Description
A unique ID of an existing session created by a setup intent.
A string in the format: session_[0-9a-z]
Name
type
Type
enum
Required
Required
Description
credit
The type of payment method to be used for fulfilling the intent.

Optional attributes

Name
credit
Type
object
Description
Show moreless
An object containing metadata associated with a credit payment. Required if the payment type is credit.
Name
payment_instrument_id
Type
string
Required
Required
Description
A unique ID of an existing payment instrument.
A string in the format: payment_instrument_[0-9a-z]
Name
terms
Type
enum
Required
Required
Description
thirty_days sixty_days ninety_days end_of_month_plus_thirty_days
The preferred terms of the credit payment.
An object containing metadata associated with a credit payment. Required if the payment type is credit.

Request

POST

/v1/intent/undefined/confirm

curl -X POST https://rest.trustshare.io/v1/intent/undefined/confirm \ 
  -H "Authorization: <private_key>" \ 
  -d @- << EOF
  {
    "session_id": "session_qbaoFDZaAD",
    "type": "credit",
    "credit": {
      "payment_instrument_id": "payment_instrument_vUztfj1NCB",
      "terms": "thirty_days"
    }
  }
  EOF

Response

{
  "checkout_id": "checkout_huHrkOn9gJ",
  "project_id": "project_9xa0MXfCYo",
  "invoice_id": "invoice_d8SLo2WMmM"
}

POST/v1/intent/{id}/cancel

Cancel an Intent

Used to cancel an intent that has not yet finalised, i.e. it has an unconfirmed status.

Required attributes

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

Request

POST

/v1/intent/intent_yUp8bMPp0S/cancel

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

Payment Intents

Intent types

Customised UI with the checkout and payment_link types

Headless transactions with the invoice type

The payment intent model

Properties

Example

Get an Intent

Required attributes

Request

Create a Payment Intent

With or without a defined buyer

Include inline fees

Targeting an existing project

Required attributes

Optional attributes

Request

Confirm a Payment Intent

Required attributes

Optional attributes

Request

Response

Cancel an Intent

Required attributes

Request

Customised UI with the `checkout` and `payment_link` types

Headless transactions with the `invoice` type