Skip to main content

Method pay

URL: POST - /ps/api/v1/pvpay/partner/pay

The method allows you to make a payment for the merchant's services using a bank card token.

Header parameters

ParameterTypeDescription
client-id *authorizationUnique Partner ID
client-secret *authorizationUnique authentication key for VIA API

Request parameters

ParameterTypeDescription
merchantId *stringVIA Merchant ID
localToken *stringBank card Token
externalId *stringUnique Partner Request ID
amount *integerTransfer amount in cents (1/100 part of the base currency unit)
currency *stringCurrency:
«UZS» - Uzbek sum
notestringNotes, remarks, etc.
metadatastringMerchant's data for information

Request sample

curl POST '/ps/api/v1/pvpay/partner/pay' \
--header 'client-id: system' \
--header 'client-secret: system123' \
--data '{
"merchantId": "mrt_qwegFC1lHGaAzJIRphv4LdU10zX",
"localToken": "SDKPT6OBAWWTD3TKZVVSNIENUPUQVOQO",
"externalId": "test_1"
"amount": 10000,
"currency": "UZS",
"note": "",
"metadata": {
"account": "123123"
},
}'

Response parameters

ParameterTypeDescription
transactionIdstringTransaction ID
payedAtintegerPayment date and time in Unix Timestamp format
amountintegerTransfer amount in cents (1/100 part of the base currency unit)

Example response if successful

{
"transactionId": "string",
"payedAt": 0,
"amount": 0
}

Example response in case of error

{
"status": {
"code": "1234",
"message": "Error while executing the request"
},
"error": {
"path": "URL Path",
"message": {
"uz": "Error message in Uzbek",
"ru": "Error message in Russian",
"en": "Error message in English"
}
}
}