Skip to main content

Create apm invoice

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

This method is creating apm invoice

Request​

Body

required

The description for the Post Body.

    amount numberrequired

    Amount of money for invoice

    gate_id string

    Id of the gate used for transaction

    comment stringrequired

    Comment for invoice

    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 invoice

    external_id stringrequired

    Client information must be unique

    succeed_url string

    The URL to which the payer will be redirected after successful payment of the invoice

    failed_url string

    The URL to which the payer will be redirected after an unsuccessful invoice payment

    callback_url string

    URL address to which the transaction status notification will be sent

    client_ip string

    Payer's ip address

    account string

    User's account that is associated with the wallet(E-mail for example)

    email string

    Payers's email

    first_name string

    Payers's first name

    last_name string

    Payers's last name

    country_code string

    Your customer’s billing country code in ISO 3166-1 alpha-3 format

    country_name string

    Your customer's country name

    city string

    Customer city of residence.Needed for some gates

    state string

    Customer state of residence.Needed for some gates

    zip string

    Payers's postal zip

    address string

    Customer address. Needed for some gates

    doc_number string

    When making a payment in South Africa, 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. In COP currency you need to add doc_number parameter, only digits without spaces and punctuation. 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)

    doc_type string

    Type of the document, needed for some COP currency gates possible values: CC, NIT

    phone string

    Payers's phone number with country code, '+' - is optional

    service_provider string

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

    date_of_birth string

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

    code string

    Payers's phone country code

    card_cvv string

    Cvv of the credit card

    card_month string

    Expiration month of the credit card

    card_year string

    Expiration year of the credit card

    card_number string

    Card number of the credit card

    cardholder string

    Cardholder of the credit card

    form_language string

    Possible values: [ru, en, ua, es, it, de, pt, bg, pl, fr]

    Language of the form

    init_payment_token boolean

    Possibility to create a payment token

    project_url string

    Url of your project needed for some gates

Responses​

The apm invoice has been successfully created.

Schema

    transaction_uid stringrequired

    Unique id of the invoice

    amount stringrequired

    Amount of money to pay for the invoice

    status stringrequired

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

    Current status of the invoice

    remark stringrequired

    Current remark of the invoice

    currency_id stringrequired

    Currency of the invoice

    invoice_url stringrequired

    Url for invoice payment

    external_id numberrequired

    the information about the client

    comment stringrequired

    the description of the invoice

    created_at stringrequired

    Time stamp of the invoice creation

Loading...