StatusTransitionDTO

One entry in the append-only audit history of a mandate or payment instruction.

  • actor
    Type: string enum

    Who triggered the transition

    values
    • USER
    • SYSTEM
    • COUNTERPARTY
    • BACEN
  • correlationId
    Type: string

    Correlation id of the originating event (bizMsgIdr, mandateId or endToEndId)

  • eventType
    Type: string

    Event that triggered the transition. Internal domain vocabulary. Known values: PAIN009_RECEIVED, PAIN011_RECEIVED, PAIN012_RECEIVED, PAIN013_RECEIVED, PAIN013_REJECTED_VALIDATION, PAIN014_RECEIVED, CAMT055_RECEIVED, MANDATE_APPROVAL, MANDATE_AUTO_APPROVAL, MANDATE_CANCELLATION, MANDATE_REJECTION, MANDATE_EXPIRED, MANDATE_REQUEST_CREATED, INSTRUCTION_APPROVAL, INSTRUCTION_APPROVAL_COMPENSATION, INSTRUCTION_CANCELLATION, INSTRUCTION_CANCELLATION_COMPENSATION, INSTRUCTION_REJECTION, INSTRUCTION_SCHEDULED, AUTHORIZATION_RULE_MATCH, PAYMENT_INSTRUCTION_EXPIRED, SCHEDULE_EXPIRED, PIX_REQUEST_OUT_FAILED, ADMIN_FORCED_EXPIRATION. In addition, camt.029 handling emits a dynamic code CAMT029_RECEIVED_ (e.g. CAMT029_RECEIVED_ACSC, CAMT029_RECEIVED_RJCT), so the set is open and not documented as a strict enum.

  • fromStatus
    Type: string enum

    Status before the transition (null on first entry). Union of mandate and payment-instruction statuses.

    values
    • PENDING_USER_APPROVAL
    • PENDING_COUNTERPARTY_APPROVAL
    • APPROVAL_SENT
    • ACTIVE
    • ACCEPTED
  • occurredAt
    Type: string Format: date-time

    When the transition occurred

  • reason
    Type: string

    Optional reason for the transition. Open set: either an internal domain code (AMOUNT_EXCEEDS_MANDATE, CDTR_MISMATCH, DBTR_MISMATCH, MAND_NOT_FOUND, EXPIRY_DATE_REACHED, FINAL_COLLECTION_DATE_REACHED, PENDING_APPROVAL_SLA_EXCEEDED, NULL_ACCEPTED, UNKNOWN) or a BACEN reject/cancellation code passed through from the incoming message (pain.012/pain.014/camt.029). Not documented as an enum because BACEN codes are an open, externally-defined set.

  • toStatus
    Type: string enum

    Status after the transition. Union of mandate and payment-instruction statuses.

    values
    • PENDING_USER_APPROVAL
    • PENDING_COUNTERPARTY_APPROVAL
    • APPROVAL_SENT
    • ACTIVE
    • ACCEPTED