Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method for creating an invoice

...

Key

Description

Type

Mandatory

Example

params





sessionId

client session id

string, uuid

yes

"613f7045-03a2-4bbb-8ff8-e2202e71d41f"

systemType

type of payment system

string

yes

"ECOM" or "P2P"

data





externalId

external id (identifier in the partner system)

string

yes

"1500383075"

type

type of operation

string

yes

"PAY", "HOLD", "SUBSCRIBE"

cardTo{}.id

id card

string, uuid

yes (if systemType = "P2P")

"b8220f46-8c28-4068-9488-2e1b37359b06"

reusability

reusable invoice parameter

boolean

no

true/false

description

description of the purpose of the invoice

string

yes

"test payment"

amount

payment amount (in kopecks)

integer

yes (if type = "SUBSCRIBE")

100

recurringInterval

interval of recurrent payments (in days, up to 366)

integer

yes (if type = "SUBSCRIBE")

1

expiresAt

expiration date of recurrent payments

integer

yes (if type = "SUBSCRIBE")

1539345600000

redirectUrl

redirection address; if not passed - the user will not see the button "Go to website"

string

no

"https://uapay.ua"

extraInfo

field for transmitting additional information about the invoice

json

no

"extraInfo":"{\"phoneFrom\":\"380971112233\",\"phoneTo\":\"380631112233\",\"cardToId\":\"216f8390-9abc-428d-89d6-7be50183afb5\"}"

email

email to which the receipt will be automatically sent after successful payment, only for reusability = false

string

no

"test@uapay.ua"

callbackUrl

address to send callback, details тут here

string

no

"https://uapay.ua"

payExpiresAt

the date of validity of the invoice payment

string

no

"2021-07-28 15:00:00"

services

no

serviceId

service id

integer

no

destination

description of the purpose of payment

string

no

"Purpose of payment 1"

destinationName

additional description in whose favor the payment is made

string

no

"Recipient1"

description

the description of the order; is displayed in the receipt

string

no

"Description of the purpose of the order"

amount

amount in kopecks

integer

no

1000

...