Skip to main content

Create invoice

POST 
/merchant-api/v1/invoices/create

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

    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

    Ip address of the buyer

    issue_payment_token boolean

    Create payment recurrent token of the card(available for some gates)

    form_language string

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

    Language of the form

    email string

    Payers's email, needed for some gates

    phone string

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

    project_url string

    Url of your project needed for some gates

    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"}

Responses​

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