Outbounds

Outbounds represent the movement of funds out of a Project in the trustshare API.

If an outbound is made to an unverified Participant, the outbound will be paused and an automated verification process will be sent to the participants provided email. Once complete, the outbound will automatically continue the process.

API initiated outbounds, ie. release and refund, can be created before any funds are available. When this occurs, the outbound will remain in the awaiting_funds status until funds are received. They can also be scheduled to occur at a specific date in the future, in this case the verification requirements will be eagerly achieved, ie. the verification email would be sent out at the point of creation, rather than the scheduled payment date.

The status of the outbound is updated as the payment progresses through different stages, such as requiring participant verification (paused) or funds have left the system (executed).

You can optionally listen to Webhooks to be notified of changes in status to an outbound object.

Outbound types

An outbound can be of one of the following types:

  • release - A release is made from a Settlement or directly from the project balance. If released from a settlement, it can only target the seller Participant defined in the settlement itself.
  • refund - A refund can only be made from a Settlement and will only target the buyer Participant defined on the settlement.
  • transfer - A transfer outbound is created automatically as part of an inter-project Transfer.
  • payout - A payout outbound is automatically created weekly that will send funds from your revenue account directly to your bank accounts provided during onboarding.

The outbound model

The outbound object provides a comprehensive representation of a payment transaction within the trustshare API, and all relevant details and any associated data that may be useful for tracking and analysis purposes.

Properties

  • Name
    id
    Type
    string
    Description

    A unique ID for the outbound.

    A string in the format outbound_[0-9a-z].

  • Name
    created_at
    Type
    string
    Description

    The date the outbound was created.

  • Name
    updated_at
    Type
    string
    Description

    The date the outbound was last updated.

  • Name
    release_at
    Type
    string
    Description

    The date that describes when the funds will be automatically released.

    Verification will be eagerly attempted if required.

  • Name
    project_id
    Type
    string
    Description

    The project ID the outbound was created against.

  • Name
    settlement_id
    Type
    string
    Description

    The settlement ID the outbound was created against. In the event funds were released directly from a project, this value will be null.

  • Name
    type
    Type
    enum
    Description

    release refund transfer payout

    The type of the outbound.

  • Name
    status
    Type
    enum
    Description

    scheduled awaiting_funds automated_review paused executing executed failed cancelled in_review processing

    The status of the outbound.

  • Name
    amount
    Type
    integer
    Description

    The amount of the outbound.

  • Name
    to
    Type
    object
    Description

    An object describing the beneficiary Participant for the outbound payment.

    • Name
      id
      Type
      string
      Description

      A unique ID of the participant.

      A string in the format: participant_[0-9a-z].

    • Name
      status
      Type
      enum
      Description

      unverified verifying verified

      The participant status.

    • Name
      type
      Type
      enum
      Description

      unknown individual business third_party organisation

      The participant type.

    • Name
      email
      Type
      string
      Description

      The participant's email.

    • Name
      name
      Type
      string
      Description

      The participant's name.

    • Name
      address
      Type
      object
      Description

      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 beneficiary Participant for the outbound payment.

  • Name
    transfers
    Type
    object[]
    Description

    The transfers key historically used to represent the fees associated with the given outbound, since these fees are "transfered" to the partner revenue accounts.

    These fee transfers will now be listed under the fees key.

    While transfers going forward, will globally denote within-system fund movements initiated by the API user.

    • Name
      id
      Type
      string
      Description

      The unique ID of the transfer.

      A string in the format: transfer_[0-9a-z].

    • Name
      created_at
      Type
      string
      Description

      The date the transfer was created.

    • Name
      updated_at
      Type
      string
      Description

      The date the transfer was last updated.

    • Name
      type
      Type
      enum
      Description

      fee

      The type of transfer.

    • Name
      subtype
      Type
      enum
      Description

      buyer seller

      The subtype of transfer.

    • Name
      status
      Type
      enum
      Description

      awaiting_funds executing executed failed cancelled scheduled

      The status of the transfer.

    • Name
      amount
      Type
      integer
      Description

      The amount of the transfer.

    • Name
      from
      Type
      object
      Description

      The object describing the settlement or project originatig the funds being transfered.

      • Name
        project_id
        Type
        string
        Description

        The unique ID of the project originating the funds being transfered.

      • Name
        settlement_id
        Type
        string
        Description

        The unique ID of the settlement originating the funds being transfered.

      The object describing the settlement or project originatig the funds being transfered.

    • Name
      to
      Type
      object
      Description

      The object describing the target project of the transfer.

      • Name
        project_id
        Type
        string
        Description

        The unique ID of the project originating the funds being transfered.

      • Name
        settlement_id
        Type
        string
        Description

        The unique ID of the settlement originating the funds being transfered.

      The object describing the target project of the transfer.

    • Name
      inbound_id
      Type
      string
      Description

      The unique ID of the inbound that describes funds entering the target project as a result of this transfer.

    • Name
      outbound_id
      Type
      string
      Description

      The unique ID of the outbound that describes funds leaving the source project as a result of this transfer.

    • Name
      release_at
      Type
      string
      Description

      The date that describes when the funds will be automatically transfered.

    • Name
      metadata
      Type
      object
      Description

      The metadata that was provided at the creation of the transfer.

    The transfers key historically used to represent the fees associated with the given outbound, since these fees are "transfered" to the partner revenue accounts.

    These fee transfers will now be listed under the fees key.

    While transfers going forward, will globally denote within-system fund movements initiated by the API user.

  • Name
    fees
    Type
    object[]
    Description

    A list of any fees created as the result of the outbound.

    • Name
      created_at
      Type
      string
      Description

      The date the fee was created.

    • Name
      updated_at
      Type
      string
      Description

      The date the fee was last updated.

    • Name
      type
      Type
      enum
      Description

      fee

      The type of fee.

    • Name
      subtype
      Type
      enum
      Description

      buyer seller

      The subtype of fee.

    • Name
      amount
      Type
      integer
      Description

      The amount of the fee.

    A list of any fees created as the result of the outbound.

  • Name
    transfer
    Type
    object
    Description

    The transfer that initiated the creation of this outbound to denote fund movements.

    • Name
      id
      Type
      string
      Description

      A unique ID for the transfer.

      A string in the format transfer_[0-9a-z].

    • Name
      to
      Type
      object
      Description

      An object describing the target of the transfer that initiated funds leaving this project.

      • Name
        project_id
        Type
        string
        Description

        The unique ID of the project originating the funds being transfered.

      • Name
        settlement_id
        Type
        string
        Description

        The unique ID of the settlement originating the funds being transfered.

      An object describing the target of the transfer that initiated funds leaving this project.

    • Name
      outbound_id
      Type
      string
      Description

      The unique ID of the outbound that describes funds leaving this project as a result of the transfer.

    The transfer that initiated the creation of this outbound to denote fund movements.

  • Name
    conversion
    Type
    object
    Description

    An object describing a potential currency conversion to achieve the outbound.

    • Name
      from
      Type
      enum
      Description

      gbp eur usd

      The currency being converted.

    • Name
      to
      Type
      enum
      Description

      aed afn all amd ang aoa ars aud awg azn bam bbd bdt bgn bhd bif bmd bnd bob brl bsd btn bwp byn bzd cad cdf chf clp cny cop crc cup cve czk djf dkk dop dzd egp ern etb eur fjd fkp gbp gel ghs gip gmd gnf gtq gyd hkd hnl hrk htg huf idr ils inr iqd irr isk jmd jod jpy kes kgs khr kmf kpw krw kwd kyd kzt lak lbp lkr lrd lsl ltl lvl lyd mad mdl mga mkd mmk mnt mop mro mur mvr mwk mxn myr mzn nad ngn nio nok npr nzd omr pab pen pgk php pkr pln pyg qar ron rsd rub rwf sar sbd scr sdg sek sgd shp sll sos srd ssp std syp szl thb tjs tmt tnd top try ttd tvd twd tzs uah ugx usd uyu uzs ved vnd vuv wst xaf xcd xof xpf yer zar zmw

      The target currency of the conversion.

    • Name
      status
      Type
      enum
      Description

      pending executing accepted failed

      The status of the conversion.

    • Name
      expected_amount
      Type
      integer
      Description

      The expected amount of the conversion in the target currency. The amount is always in the lowest denomination of the target currency, so please be aware of the target currencies minor unit.

    • Name
      rate
      Type
      number
      Description

      The conversion rate in the form from -> to.

    An object describing a potential currency conversion to achieve the outbound.

  • Name
    paused_reason
    Type
    enum
    Description

    pending_participant_verification

    The reason why the outbound is currently in a paused status.

  • Name
    failure_reason
    Type
    enum
    Description

    fx_amount_too_small unable_to_determine_target_account invalid_reference invalid_target_account_credentials missing_participant_information generic_failure_contact_support unsupported_payout_route

    The reason why the outbound is currently in a failed status.

  • Name
    reference
    Type
    string
    Description

    The reference that will be used for the outbound.

    The reference can be up to 18 characters in length and supports a-z, A-Z, 0-9, -, and space characters.

  • Name
    metadata
    Type
    object
    Description

    The metadata that was provided at the creation of the release or refund.

Example

{
  "id": "outbound_fDZZQ2EYf0",
  "created_at": "2023-12-19T18:41:11.629Z",
  "updated_at": "2023-12-19T18:41:12.075Z",
  "release_at": null,
  "project_id": "project_1Yd1QJnWIX",
  "settlement_id": "settlement_1vX33h20He",
  "type": "release",
  "reference": null,
  "status": "awaiting_funds",
  "paused_reason": null,
  "failure_reason": null,
  "amount": 99750,
  "to": {
    "id": "participant_JevcdLf9Ky",
    "status": "unverified",
    "email": "sink+seller@trustshare.co",
    "type": "business",
    "name": null,
    "address": {
      "type": "unknown",
      "address_line_1": "1 Third Party Way",
      "address_line_2": null,
      "town_city": "Third Party City",
      "region": null,
      "postal_code": "TP1 1PT",
      "country": "GB"
    },
    "bank_account": {
      "id": "bank_account_tUKVDdAItY",
      "country": "GB",
      "currency": "gbp",
      "account_number": "01139097",
      "routing_code": "309455",
      "routing_code_type": "sort_code",
      "routing_data": {}
    },
    "business": null,
    "individual": null,
    "organisation": null,
    "metadata": {}
  },
  "transfers": [
    {
      "created_at": "2023-12-19T18:41:11.629Z",
      "updated_at": "2023-12-19T18:41:11.629Z",
      "type": "fee",
      "subtype": "seller",
      "amount": 250
    }
  ],
  "fees": [
    {
      "created_at": "2023-12-19T18:41:11.629Z",
      "updated_at": "2023-12-19T18:41:11.629Z",
      "type": "fee",
      "subtype": "seller",
      "amount": 250
    }
  ],
  "conversion": null,
  "transfer": null,
  "metadata": {}
}

GET/v1/outbound/{id}

Get an Outbound

Retrieve an outbound release or refund payment.

Required attributes

  • Name
    id
    Type
    string
    Required
    Required
    Description

    A unique ID of an existing outbound.

    A string in the format: outbound_[0-9a-z]

Request

GET
/v1/outbound/outbound_fDZZQ2EYf0
curl https://rest.trustshare.io/v1/outbound/outbound_fDZZQ2EYf0 \ 
  -H "Authorization: <private_key>"

POST/v1/outbounds/releases

Create Releases

Used to create releases from projects and settlements.

Required attributes

  • Name
    releases
    Type
    object[]
    Required
    Required
    Description

    A list of releases to create.

    • Name
      settlement_id
      Type
      string
      Description

      A unique ID of the settlement to release funds from.

      A string in the format: settlement_[0-9a-z].

    • Name
      project_id
      Type
      string
      Description

      A unique ID of the project to release funds from.

      A string in the format: project_[0-9a-z].

    • Name
      amount
      Type
      integer
      Description

      The amount to release in the currency's lowest denomination.

    • Name
      fee_flat
      Type
      integer
      Description

      A flat fee to charge the beneficiary Participant on successfully releasing funds.

    • Name
      fee_percentage
      Type
      number
      Description

      The fee percentage to charge the beneficiary Participant on successfully releasing funds.

    • Name
      to
      Type
      object
      Description

      An object describing the beneficiary participant to release to.

      You can only provide a participant at release when the settlement is of type funded or you are releasing directly from a project.

      • 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