Skip to main content

Fetch all user mandates

POST 
/api/DirectDebit/LoadUserMandates

Description​

Load all direct debit mandates associated with a specific user. It provides a way to retrieve a list of all mandates that the user has authorised, allowing for management and review of these mandates within the application.

Request​

Body Parameters

    ActionLog object
    Action string
    Controller string
    Date date-time
    DeviceId string
    Id integer
    IpAddress string
    LanguageCode string
    LoginKey string
    Username string
    ForceLoad boolean
    LogInfo object
    AppVersion string
    IpAddress string
    LanguageCode string
    Validation objectrequiredThe validation parameter, mandatory to all Banking Suite API calls.
    AccessToken string

    The access token for authentication.

    AppKey string

    The key assigned to the application.

    CustomerCode string

    The unique code assigned to the customer.

    DeviceId string

    The unique identifier of the device.

    LoginKey string

    The key used for login.

    RefreshToken string

    The token used to refresh the session.

    Username string

    The username for authentication.

Responses​

Success

Success

Schema
    httpStatusCode int32

    Possible values: [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511]


    Description: 100 = "Continue", 101 = "SwitchingProtocols", 102 = "Processing", 103 = "EarlyHints", 200 = "OK", 201 = "Created", 202 = "Accepted", 203 = "NonAuthoritativeInformation", 204 = "NoContent", 205 = "ResetContent", 206 = "PartialContent", 207 = "MultiStatus", 208 = "AlreadyReported", 226 = "IMUsed", 300 = "Ambiguous", 300 = "Ambiguous", 301 = "Moved", 301 = "Moved", 302 = "Redirect", 302 = "Redirect", 303 = "RedirectMethod", 303 = "RedirectMethod", 304 = "NotModified", 305 = "UseProxy", 306 = "Unused", 307 = "TemporaryRedirect", 307 = "TemporaryRedirect", 308 = "PermanentRedirect", 400 = "BadRequest", 401 = "Unauthorized", 402 = "PaymentRequired", 403 = "Forbidden", 404 = "NotFound", 405 = "MethodNotAllowed", 406 = "NotAcceptable", 407 = "ProxyAuthenticationRequired", 408 = "RequestTimeout", 409 = "Conflict", 410 = "Gone", 411 = "LengthRequired", 412 = "PreconditionFailed", 413 = "RequestEntityTooLarge", 414 = "RequestUriTooLong", 415 = "UnsupportedMediaType", 416 = "RequestedRangeNotSatisfiable", 417 = "ExpectationFailed", 421 = "MisdirectedRequest", 422 = "UnprocessableEntity", 423 = "Locked", 424 = "FailedDependency", 426 = "UpgradeRequired", 428 = "PreconditionRequired", 429 = "TooManyRequests", 431 = "RequestHeaderFieldsTooLarge", 451 = "UnavailableForLegalReasons", 500 = "InternalServerError", 501 = "NotImplemented", 502 = "BadGateway", 503 = "ServiceUnavailable", 504 = "GatewayTimeout", 505 = "HttpVersionNotSupported", 506 = "VariantAlsoNegotiates", 507 = "InsufficientStorage", 508 = "LoopDetected", 510 = "NotExtended", 511 = "NetworkAuthenticationRequired"

    mandate object
    commandToken string
    createNew boolean
    creditorName string
    creditorSchemeIdentificationID int32
    debtorAccount string
    debtorAccountIBAN string
    debtorName string
    id int32
    mandateAction int32

    Possible values: [0, 1, 2, 3, 4]


    Description: 0 = "Unknown", 1 = "ToExport", 2 = "Sent", 3 = "Received", 4 = "Canceled"

    mandateCode string
    mandateType int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "Unknown", 1 = "CMF_New", 2 = "CMF_Update", 3 = "DMF"

    maxDebitAmount double
    productID int32
    requires3FA boolean
    sequenceType int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "Unknown", 1 = "Repeated", 2 = "Once", 3 = "Finalize"

    status int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "Unknown", 1 = "InProcess", 2 = "Accepted", 3 = "Rejected"

    ultimateDebtorName string
    userAgreedToProceedWithout3FA boolean
    userHasActive3FAPassword boolean
    verificationTimeSeconds int32
    mandatesCollectionList object[]
  • Array [
    • collectionAction int32
    creditorName string
    debtorName string
    id int32
    interbankSettlementAmount double
    interbankSettlementAmountCurrency string
    status int32

    Possible values: [0, 1, 2]


    Description: 0 = "Unknown", 1 = "Rejected", 2 = "Approved"

    ultimateDebtorName string
  • ]
    • mandatesList object[]
  • Array [
    • commandToken string
    createNew boolean
    creditorName string
    creditorSchemeIdentificationID int32
    debtorAccount string
    debtorAccountIBAN string
    debtorName string
    id int32
    mandateAction int32

    Possible values: [0, 1, 2, 3, 4]


    Description: 0 = "Unknown", 1 = "ToExport", 2 = "Sent", 3 = "Received", 4 = "Canceled"

    mandateCode string
    mandateType int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "Unknown", 1 = "CMF_New", 2 = "CMF_Update", 3 = "DMF"

    maxDebitAmount double
    productID int32
    requires3FA boolean
    sequenceType int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "Unknown", 1 = "Repeated", 2 = "Once", 3 = "Finalize"

    status int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "Unknown", 1 = "InProcess", 2 = "Accepted", 3 = "Rejected"

    ultimateDebtorName string
    userAgreedToProceedWithout3FA boolean
    userHasActive3FAPassword boolean
    verificationTimeSeconds int32
  • ]
    • maxDebitAmount double
    message string
    requiredVersion int32
    requires3FA boolean
    status int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]


    Description: 0 = "UNKNOWN", 1 = "OK", 2 = "FAIL", 3 = "UNAUTHORIZED", 4 = "PASSWORD_EXPIRED", 5 = "DISABLED", 6 = "BLOCKED", 7 = "TIME_OUT", 8 = "NO_INTERNET", 9 = "INVALID_ACCOUNT", 10 = "REQUIRE_UPDATE", 11 = "SYSTEM_DOWN", 12 = "PENDING_COMMAND", 13 = "PENDING_LOGIN", 14 = "REGISTERED"

    userHasActive3FAPassword boolean
Loading...