Skip to main content

Request a transfer

POST 
/api/Transfers/Request

Description​

Initiate a transfer request.

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.

    Transfer objectrequiredInformation on the transfer being processed.
    IsCreditTransfer boolean

    Indicates if the transfer is a credit transfer.

    debtorAccountNumberOrIban string

    The account number or IBAN of the debtor.

    creditorName string

    The name of the creditor.

    CountryCode string

    The country code associated with the transfer.

    BIC string

    The Bank Identifier Code for the transfer.

    IsFoc boolean

    Specifies if the transfer is a focus transfer.

    Amount number

    The amount of the transfer.

    CurrencyId integer

    The currency ID, use 1 for EUR.

    reason string

    The reason of the transfer.

    directOrder boolean

    Indicates if there is a default reason set.

    hasDefaultReason boolean

    Indicates if there is a default reason set.

    onlinePayment boolean

    Specifies if the payment is an online transaction.

Responses​

Success
Schema
    httpStatusCode int32required

    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"

    message stringnullablerequired
    requiredVersion int32required
    status int32required

    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"

    transfer object
    amount doublerequired
    bic stringnullablerequired
    bookBalance doublerequired
    chargeBearer int32required

    Possible values: [0, 1]


    Description: 0 = "Shared", 1 = "Debtor"

    commandToken stringnullablerequired
    creditorAccountBeneficiaries string[]nullablerequired
    creditorAccountNumberOrIban stringnullablerequired
    creditorBank stringnullablerequired
    creditorName stringnullablerequired
    currency int32required

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


    Description: 0 = "Undefined", 1 = "EUR", 2 = "USD", 3 = "GBP"

    currencyID int32required
    debtorAccountNumberOrIban stringnullablerequired
    directOrder object
    blockAmount booleanrequired
    channelCreated int32required

    Possible values: [0, 1, 2, 3, 5, 6, 7]


    Description: 0 = "All", 1 = "CSB", 2 = "Web", 3 = "ATM", 5 = "PSD2", 6 = "Mobile", 7 = "MassTransactions"

    endDate date-timenullablerequired
    executionDay int32required

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


    Description: 0 = "SpecificDate", 1 = "MonthFirstDay", 2 = "MonthLastDay", 3 = "MonthFirstWorkingDay", 4 = "MonthLastWorkingDay"

    frequency int32required

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


    Description: 0 = "NotSet", 1 = "Daily", 2 = "Weekly", 3 = "Monthly"

    frequencyInterval int32required
    maxExecutions int32required
    name stringnullablerequired
    settlementOptions int32required

    Possible values: [0, 1, 2]


    Description: 0 = "Today", 1 = "Future", 2 = "Repeat"

    startDate date-timenullablerequired
    hasDefaultReason booleanrequired
    isFoc booleanrequired
    onlinePayment booleanrequired
    reason stringnullablerequired

    Possible values: <= 100 characters

    requires3FA booleanrequired
    settlementDate date-timenullablerequired
    transferCharges object
    charges doublerequired
    clearingSystem stringnullablerequired
    commission doublerequired
    expenses doublerequired
    foreignCurrencyReceiveAmount doublerequired
    fxRate doublerequired
    hasFX booleanrequired
    isFoc booleanrequired
    mustShowCharges booleanrequired
    totalCharges doublerequired
    transferType int32required

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


    Description: 0 = "Unknown", 1 = "ToMyAccount", 2 = "ToBank", 3 = "ToOtherBank", 4 = "ToForeignBank", 5 = "Iris"

    userAgreedToProceedWithout3FA booleanrequired
    userHasActive3FAPassword booleanrequired
    verificationTimeSeconds int32required
    voucherNumber stringnullablerequired
Loading...