Inbounds

Inbounds represent the physical receipt of funds into a Project in the trustshare API.

If the inbound does not include an associated Checkout, it can be considered unreconciled. We do our best to reconcile to Settlements, even if we cannot reconcile to a specific checkout, by taking various factors into account. Including amount and the source of funds.

You can be notified via Webhooks when funds settle into a project account you hold.

The inbound model

The inbound object provides a representation of physical receipt of funds within the trustshare API, including the associated Checkout, if it could be reconciled, and the reference used.

Properties

  • Name
    id
    Type
    string
    Description

    A unique ID for the inbound.

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

  • Name
    created_at
    Type
    string
    Description

    The date the project was created.

  • Name
    updated_at
    Type
    string
    Description

    The date the project was last updated.

  • Name
    project_id
    Type
    string
    Description

    The unique ID of the project which this inbound funds.

  • Name
    checkout_id
    Type
    string
    Description

    The unique ID of the checkout that this inbound has been reconciled against.

    If we were unable to reconcile the inbound to a specific checkout this value will be null.

  • Name
    transfer
    Type
    object
    Description

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

    • Name
      id
      Type
      string
      Description

      A unique ID for the transfer.

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

    • Name
      from
      Type
      object
      Description

      An object describing the source of the transfer that initiated funds entering this project.

      • Name
        project_id
        Type
        string
        Description

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

      • Name
        settlement_id
        Type
        string
        Description

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

      An object describing the source of the transfer that initiated funds entering this project.

    • Name
      inbound_id
      Type
      string
      Description

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

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

  • Name
    type
    Type
    enum
    Description

    card credit open_banking local_bank_transfer international_bank_transfer manual_bank_transfer transfer

    The type of the inbound.

  • Name
    status
    Type
    enum
    Description

    settling settled in_review

    The status of the inbound.

  • Name
    amount
    Type
    integer
    Description

    The amount of the inbound.

  • Name
    reference
    Type
    string
    Description

    The reference that was used for the inbound.

    This will be null if no reference is provided by the buyer or the inbound is not a bank transfer, ie. manual or Open Banking initiated.

Example

{
  "id": "inbound_Z7iHsk97xi",
  "created_at": "2023-12-19T18:40:41.343Z",
  "updated_at": "2023-12-19T18:40:41.970Z",
  "project_id": "project_1JCcWy1zmr",
  "checkout_id": "checkout_VrLS9atLam",
  "type": "local_bank_transfer",
  "status": "settled",
  "amount": 102500,
  "reference": "C6D57WTZ7",
  "transfer": null
}
GET/v1/inbound/{id}

Get an Inbound

Retrieve an inbound payment.

Required attributes

  • Name
    id
    Type
    string
    Required
    Required
    Description

    A unique ID of an existing inbound.

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

Request

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