Setup Intents

Sometimes you may want your users to interact with a checkout UI process, or you may want to charge at a later date. Setup Intents allow you to create sessions that can be used to complete processes on the trustshare API, such as confirming an invoice payment intent.

A setup intent must be confirmed by the user's device via our client SDK, however may require no interaction from the user. The intent will be consumed upon confirmation.

Intent types

Currently, Setup Intents only support the session type, which allows you to create a detached session that can be used to confirm invoice payment intents from you backend system by utilising a trade account Payment Instrument. Eventually, we plan to extend the utility of setup intents to include things such as payout bank account management and payment instrument management.

Confirming a session setup intent

Upon confirmation, a session setup intent ties a specific Participant to a re-usable session object that can be provided to endpoints within the API. Unlike the checkout UI, when confirming a session setup intent no UI will be shown to participant. The following example shows how to achieve this with our client SDK.

Confirming a setup intent

import createSDK from '@trustshare/sdk';

const truatshare = createSDK('<public_key>');

const result = await trustshare.sdk.v1.confirmSetupIntent(client_secret);

The result of this confirmation will include a session_id and expires_at value that can be stored in your own database and used at a later date. For products where a participant touch-point is rare, ie. where deals may be handled off-platform, it is advised to create and store a new session on each login. Due to there being no requirement for a UI, this process can happen completely transparently from the perspective of your users.

The setup intent model

The setup intent object provides a comprehensive representation of an intended action to set up a re-usabled off-session payment instrument or method.

Properties

  • Name
    __typename
    Type
    enum
    Description

    SessionIntent

  • Name
    id
    Type
    string
    Description

    The unique identifier of the created intent.

  • Name
    created_at
    Type
    string
    Description

    The date the setup intent was created.

  • Name
    updated_at
    Type
    string
    Description

    The date the setup intent was last updated.

  • Name
    participant
    Type
    object
    Description

    An object describing the Participant for setup.

    • 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

      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

      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

      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

        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

        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

        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

        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

          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

      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

        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

        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

      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

        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

        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

        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

          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 Participant for setup.

  • Name
    client_secret
    Type
    string
    Description

    The client secret for the intent.

  • Name
    status
    Type
    enum
    Description

    unconfirmed confirmed cancelled debug

    The status of the setup intent.

  • Name
    type
    Type
    enum
    Description

    checkout payment_link invoice session

    The type of the intent.

  • Name
    metadata
    Type
    object
    Description

    The metadata that was provided at the creation of the setup intent.

Example

{
  "__typename": "SessionIntent",
  "id": "intent_tTAEyQksYi",
  "created_at": "2023-12-20T13:42:31.440Z",
  "updated_at": "2023-12-20T13:42:31.440Z",
  "participant": {
    "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": {}
  },
  "client_secret": "sandbox_su_i_mf55PLQgDcmFmdedB4wbc7gPhJqS9cQftBZY7hdjWk6XsZOUk1Fhq5Jkwmvb9eg4",
  "status": "unconfirmed",
  "type": "session",
  "metadata": {
    "foo": "managed to store meta on SETUP INTENT"
  }
}

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_tTAEyQksYi
curl https://rest.trustshare.io/v1/intent/intent_tTAEyQksYi \ 
  -H "Authorization: <private_key>"

POST/v1/intents/setup

Create a Setup Intent

A setup intent describes a participants intention to allow you to use one of their payment instruments off-session at a later date.

Required attributes

  • Name
    type
    Type
    enum
    Required
    Required
    Description

    session

    The type of Setup Intent to create.

  • Name
    participant
    Type
    object
    Required
    Required
    Description

    Provide the Participant the setup relates to.

    • 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

      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

      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

      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

        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

        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