Skip to main content

Initiate a payment

POST 
/api/Payments/Request

Description​

Start the payment process. Provide necessary payment details, such as the payment amount, currency, payer information and payment product details.

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.

    Payment objectrequiredThe details of the payment being processed.
    debtorAccountNumberOrIban string

    The account number or IBAN of the debtor.

    debtorName string

    The name of the debtor.

    creditorName string

    The name of the creditor.

    amount decimal

    The amount to be paid.

    ProductCode string

    The code representing the product.

    paymentCode string

    The code representing the payment.

    notes string

    Additional notes or comments.

    extraFields object

    Additional or extra fields.

    settlementDate date-time

    The date of the settlement.

    commandToken string

    The token for the command.

    verificationTimeSeconds integer

    The time required for verification in seconds.

    paymentType integer

    The time required for verification in seconds.

    LoanType integerrequired

    The type of payment being executed.
    Available options: 0 = "Bill", 1 = "CreditCard"

    isNotValidCreditCard boolean

    Indicates if the credit card is not valid.

    isNotValidCreditCard boolean

    Indicates if the credit card is not valid.

    directOrder object

    Direct order details.

    remittanceInformationType string

    The type of remittance information.

    onlinePayment boolean

    Indicates if the payment is made online.

    requires3FA boolean

    Indicates if 3FA is required.

    userHasActive3FAPassword boolean

    Indicates if the user has an active 3FA password.

    userAgreedToProceedWithout3FA boolean

    Indicates whether the user agreed to proceed without 3FA.

Responses​

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"

    message string
    payment object
    amount double
    charges double
    commandToken string
    creditorName string
    debtorAccountNumberOrIban string
    debtorName string
    directOrder object
    blockAmount boolean
    channelCreated int32

    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-time
    executionDay int32

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


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

    frequency int32

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


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

    frequencyInterval int32
    maxExecutions int32
    name string
    settlementOptions int32

    Possible values: [0, 1, 2]


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

    startDate date-time
    extraFields object
    property name* string
    isNotValidCreditCard boolean
    notes string
    onlinePayment boolean
    paymentCode string
    paymentType int32

    Possible values: [0, 1]


    Description: 0 = "Bill", 1 = "CreditCard"

    productCode string
    remittanceInformationType string
    requires3FA boolean
    settlementDate date-time
    userAgreedToProceedWithout3FA boolean
    userHasActive3FAPassword boolean
    verificationTimeSeconds int32
    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...