Method for creating an invoice payment

URI

POST api/invoicer/payments/create


Request:

Key

Description

Type

Mandatory

Example

params





sessionId

client session id 

string, uuid

yes

"00684a7f-3d5c-43f4-b4d1-ea994226be9c"

locale

language parameter

string

no

"uk"/"ru"/"en"

device

object with information about the payer's browser / device

object

yes

{"acceptHeader":"*/*","ip":"91.137.205.117","colorDepth":24,"javaEnabled":false,"language":"en-US","screenHeight":864,"screenWidth":1536,
"windowHeight":734,"windowWidth":1479,"time":"2021-10-07T14:55:52.832Z","timezoneOffset":-180,"userAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36"}

data





invoiceId

invoice id

string, uuid

yes

"48cae638-2f4b-434c-aafa-a4b9ced4b486"

cardFrom


object

yes


cardFrom{}.id

card id

string, uuid

yes

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

cardFrom{}.securityCode

CVV card

integer

yes

530

email

the email address to send the check

string

no

"invoice_test@uapay.ua"

amount

payment amount (in kopecks)

integer

yes

100

currency

payment currency code

integer

yes

980


Example of a query
{
	"params": {
		"sessionId": "000ab70b-ef76-4385-a0f5-a98693c716f1",
        "device": {
  			"acceptHeader": "*/*",
  			"ip": "91.137.205.117",
  			"colorDepth": 24,
  			"javaEnabled": false,
  			"language": "en-US",
  			"screenHeight": 864,
  			"screenWidth": 1536,
  			"windowHeight": 734,
  			"windowWidth": 1479,
  			"time": "2021-10-07T14:55:52.832Z",
  			"timezoneOffset": -180,
  			"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36"
		}
	},
	"data": {
		"invoiceId": "48cae638-2f4b-434c-aafa-a4b9ced4b486",
		"amount": 100,
		"currency": 980,
		"cardFrom": {
			"id": "b8220f46-8c28-4068-9488-2e1b37359b06",
			"securityCode": "530"
		},
		"email": "invoice_test@uapay.ua"
	}
} 


Reply:

Key

Description

Тип

Приклад

status

Status. 0 - error, 1 - success

integer

1

data




id

payment id

string, uuid

"3daa9c03-dbea-4cc0-a3eb-cf7344b93d85"

key

CVV key

string

"A1K4sf15zMKvjcVEe7g3dq7HPDXwm92x3F1MECezPMa8.jldu9xq6912027188977"

redirectUrl

forwarding address

string

"https://uapay.ua?id=29f35985-6c24-4ecd-97fb-db9e6308b65f"
Example of an answer
{
    "status": 1,
    "data": {
        "id": "3daa9c03-dbea-4cc0-a3eb-cf7344b93d85",
        "key": "A1K4sf15zMKvjcVEe7g3dq7HPDXwm92x3F1MECezPMa8.jldu9xq6912027188977",
        "redirectUrl": "https://uapay.ua?id=3daa9c03-dbea-4cc0-a3eb-cf7344b93d85"
    }
}