Skip to main content

Create mass iban withdraw

POST 
/merchant-api/v1/withdraw/iban-mass-create

This method is creating mass iban withdraw

Request​

Body

required

The description for the Post Body.

    amount numberrequired

    Amount of money to withdraw

    gate_id string

    Id of the gate used for transaction

    comment stringrequired

    Comment for withdraw

    external_id stringrequired

    Client order number, must be unique for the merchant`

    currency_id stringrequired

    Possible values: [USD, EGP, RUB, KZT, EUR, UAH, MXN, INR, TRY, UZS, AZN, MDL, VND, KRW, AED, IDR, PKR, PEN, CLP, MAD, BYN, COP, NGN, ZAR, SAR, XOF, CAD, AUD, GBP, PLN, NZD, NOK, DKK, SEK, HUF, PHP, TJS, RSD]

    Currency of the withdraw

    card_number string

    Number of the card to which money will be sended

    callback_url string

    URL address to which the transaction status notification will be sent

    iban string
    bank_name string
    personal_data object

    Additional parameters are needed for some gates, for example, when personal data needs to be provided to the API, not through a form. Example:{"first_name": "Alex"}

    client_ip string

    Payer's ip address

Responses​

The withdraw has been successfully created.

Schema

    transaction_uid stringrequired

    Unique id of the withdraw

    amount stringrequired

    Amount of money to withdraw

    status stringrequired

    Possible values: [Created, Pending, Failed, Succeed]

    Current status of the withdraw

    currency_id stringrequired

    Currency of the withdraw

    comment stringrequired

    the description of the withdraw

    external_id stringrequired

    Client order number, must be unique for the merchant`

    created_at stringrequired

    Time stamp of the withdraw creation

Loading...