Skip to main content

Create Apm withdraw

POST 
/merchant-api/v1/withdraw/apm/create

This method is creating Apm 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

    client_ip string

    Payer's ip address

    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

    callback_url string

    URL address to which the transaction status notification will be sent

    bank_name string

    Name of the bank

    bank_id string

    Bank identifier. Please contact us to get available codes

    account_number string

    Account ID

    account string

    Your account

    first_name string

    Receiver name

    last_name string

    Receiver last_name

    middle_name string

    Receiver middle_name

    email string

    Receiver email

    phone string

    Payers's phone number with country code and without '+'

    service_provider string

    Phone service provider needed for EGP and XOF currency. ETISALAT, ORANGE, VODAFONE, WEPAY - for the currency EGP. FREEMONEY, EXPRESSO, ORANGE, MTN - for XOF currency

    doc_number string

    When making a payment in South Africa(ZAR currency), you must additionally pass the user's identification document number in the doc_number parameter. This can be a passport number (1 letter and 8 digits) or a user identification number (13 digits).When performing a purchase in MXN currency you need to add doc_number parameter containing the customer's document number: CURP (contains 18 digits) for Mexico.When performing in COP currency set this parameter to the number of the Citizenship Card (CC—Cédula de Ciudadanía) or to the Colombia Unique Taxpayer Number (NIT—Número de Identificación Tributaria)

    card_number stringrequired

    Card number of the credit card

    country stringrequired

    Country code in ISO 3166-1 alpha-2 format

    date_of_birth string

    Your customer’s date of birth (must be 18+ y.o.).In ISO 8601 format

    city string

    Customer city of residence.Needed for some gates

    address string

    Customer address. Needed for some gates

    country_code string

    Your customer’s billing country code. May be 2 or 3 letters for different gates

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...