action fire_get_mandate {
  label: "Get direct debit mandate details"
  description: "Retrieve all details for a direct debit mandate.\nThe permision needed to access this endpoint is PERM_BUSINESS_GET_MANDATE\n"
  provider: fire
  method: GET
  path: "/v1/mandates/{mandateUuid}"
  encoding: json
  input: {
    type: "object"
    properties: {
      mandateUuid: {
        type: "string"
        description: "The uuid of the mandate to retrieve."
      }
    }
    required: ["mandateUuid"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      alias: {
        type: "string"
        description: "The name of the alias"
      }
      currency: {
        type: "object"
        description: "The currency."
        properties: {
          code: {
            type: "string"
            description: "The three letter code for the currency - either `EUR` or `GBP`."
            enum: ["EUR", "GBP"]
          }
          description: {
            type: "string"
            description: "The name of the currency"
          }
        }
      }
      dateCancelled: {
        type: "string"
        format: "date-time"
        description: "Date the direct debit was canceled. Milliseconds since the epoch (1970)."
      }
      dateCompleted: {
        type: "string"
        format: "date-time"
        description: "Date the direct debit was completed. Milliseconds since the epoch (1970)."
      }
      dateCreated: {
        type: "string"
        format: "date-time"
        description: "Date the direct debit was created. Milliseconds since the epoch (1970)."
      }
      fireRejectionReason: {
        type: "string"
        description: "Rejection reason if transaction is rejected"
        enum: ["ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS", "DDIC", "ACCOUNT_NOT_FOUND", "ACCOUNT_NOT_LIVE", "CUSTOMER_NOT_FOUND", "BUSINESS_NOT_LIVE", "BUSINESS_NOT_FULL", "PERSONAL_USER_NOT_LIVE", "PERSONAL_USER_NOT_FULL", "MANDATE_ALREADY_EXISTS", "MANDATE_WITH_DIFERENT_ACCOUNT", "NULL_MANDATE_REFERENCE", "INVALID_ACCOUNT_CURRENCY", "INVALID_MANDATE_REFERENCE", "REQUESTED_BY_CUSTOMER_VIA_SUPPORT", "CUSTOMER_ACCOUNT_CLOSED", "CUSTOMER_DECEASED", "ACCOUNT_TRANSFERRED", "MANDATE_NOT_FOUND", "ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT", "INVALID_ACCOUNT_TYPE", "MANDATE_EXPIRED", "MANDATE_CANCELLED", "REQUESTED_BY_CUSTOMER"]
      }
      lastUpdated: {
        type: "string"
        format: "date-time"
        description: "Date the direct debit was last updated. Milliseconds since the epoch (1970)."
      }
      latestDirectDebitAmount: {
        type: "integer"
        format: "int64"
        description: "The value of largest direct debit collected"
      }
      latestDirectDebitDate: {
        type: "string"
        format: "date-time"
        description: "The date of latest direct debit collected"
      }
      mandateReference: {
        type: "string"
        description: "the reference of the mandate"
      }
      mandateUuid: {
        type: "string"
        description: "The UUID for the mandate"
      }
      numberOfDirectDebitCollected: {
        type: "integer"
        format: "int64"
        description: "The number of direct debits collected"
      }
      originatorAlias: {
        type: "string"
        description: "The name of the alias"
      }
      originatorLogoUrlLarge: {
        type: "string"
        description: "Logo url from party who sets up the direct debit."
      }
      originatorLogoUrlSmall: {
        type: "string"
        description: "Logo url from party who sets up the direct debit."
      }
      originatorName: {
        type: "string"
        description: "The creator of the party who sets up the direct debit."
      }
      originatorReference: {
        type: "string"
        description: "Set by party who sets up the direct debit."
      }
      schemeCancelReason: {
        type: "string"
        description: "Reason for cancelation"
      }
      schemeCancelReasonCode: {
        type: "string"
        description: "The cancelation code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason."
      }
      status: {
        type: "string"
        description: "The status of the mandate.\n* 'CREATED'\n* 'LIVE'\n* 'REJECT_REQUESTED'\n* 'REJECT_RECORD_IN_PROGRESS'\n* 'REJECT_RECORDED'\n* 'REJECT_FILE_CREATED'\n* 'REJECT_FILE_SENT'\n* 'CANCEL_REQUESTED'\n* 'CANCEL_RECORD_IN_PROGRESS'\n* 'CANCEL_RECORDED'\n* 'CANCEL_FILE_CREATED'\n* 'CANCEL_FILE_SENT'\n* 'COMPLETE'\n* 'DORMANT'\n"
        enum: ["CREATED", "LIVE", "REJECT_REQUESTED", "REJECT_RECORD_IN_PROGRESS", "REJECT_RECORDED", "REJECT_FILE_CREATED", "REJECT_FILE_SENT", "CANCEL_REQUESTED", "CANCEL_RECORD_IN_PROGRESS", "CANCEL_RECORDED", "CANCEL_FILE_CREATED", "CANCEL_FILE_SENT", "COMPLETE", "DORMANT"]
      }
      targetIcan: {
        type: "integer"
        format: "int64"
        description: "Identifier for the fire.com account (assigned by fire.com)"
      }
      valueOfDirectDebitCollected: {
        type: "integer"
        format: "int64"
        description: "The value of direct debits collected"
      }
    }
  }
}