Collection

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

  • id Uuidrequiredread-only

    Fields of id
  • mandateId Uuidrequired

  • amount Moneyrequired

  • dueDate Daterequired

  • status CollectionStatusrequiredread-only

    Fields of status
  • providerRef string | nullread-only

  • transactionId Uuid | null

  • failureReason string | nullread-only

  • createdAt Timestamprequiredread-only

    Fields of createdAt
  • reference string | null

  • sequenceType stringread-only

    One of: "FRST", "RCUR", "OOFF", "FNAL"

  • submitOn Date | null

  • collectedAt Timestamp | null

  • returnReasonCode string | nullread-only

    R-transaction reason code (SEPA / Bacs ARUDD).

  • returnedAt Timestamp | null

  • scheduledPaymentId Uuid | null