Skip to main content

Create s2p invoice

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

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

    type_document stringrequired
    Payer's document type(lenght of the document field):

    for currency PEN:

    type_document: DNI - Identity Document:  (8 characters)
    type_document: CE - Foreign resident Card: (from 8 to 10 characters)
    type_document: PAS - Passport: (from  9 to 10 characters)
    type_document: RUC - Tax Id Number: (from  9 to 10 characters)

    for currency CLP:

    type_document: RUT - Tax Id Number: (from  7 to 9 characters)
    type_document: PP - Passport: (from  9 to 10 characters)

    for currency USD

    type_document: CI - Identity Document: (from  8 to 10 characters)
    type_document: PP - Passport(only for Cash): (from  9 to 10 characters)
    type_document: RUC - Tax Id Number: (from  9 to 10 characters)
    type_document: PAS - Passport(only for BankTransfer): (from  9 to 10 characters)
    document stringrequired

    Payer's document number the number of characters depends on the type_document

    payer_name stringrequired

    Payer's name

    payer_lastname stringrequired

    Payer's lastname

    client_ip string

    Ip address of the buyer

Responses​

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