WireBloomDevelopers

    Mandate

    Schema #/components/schemas/Mandate of contract 1.0.0-draft.14.

    • id Uuidrequiredread-only

      Fields of id

      Uuid

    • customerId Uuidrequiredread-only

      Fields of customerId

      Uuid

    • direction MandateDirectionrequired

    • scheme MandateSchemerequired

    • reference stringrequired

      max length 35

    • balanceId Uuidrequired

    • counterparty objectrequired

      Fields of counterparty

      • name stringrequired

      • iban string | null

      • accountNumber string | null

      • sortCode string | null

      • bic string | null

      • creditorId string | null

      • address Address | null

    • status MandateStatusrequiredread-only

      Fields of status

      MandateStatus

    • signedAt Timestamp | null

    • cancelledAt Timestamp | null

    • providerRef string | nullread-only

    • createdAt Timestamprequiredread-only

      Fields of createdAt

      Timestamp

    • management stringread-only

      client: WireBloom generates collection files / status reports are entered by staff; provider: the partner manages the mandate.

      One of: "client", "provider"

    • statusReason string | nullread-only

    • lastCollectionAt Timestamp | null