SMS Confirmation

Swagger - detailed payment API.

SMS Payment Confirmation Request Body Interface:

{
   "publicKey": "string",
   "hash": "string",
   "paymentId": "string",
   "code": "string"
}

Table Describing All Fields in the Request Body:

Field						Type	Required	Description
publicKey						String	Yes	Public key issued during merchant registration on the FirstPay platform (the key is provided as a file; the entire contents must be included).
hash						String	Yes	Encoded request body string. For instructions on how to generate it, see the "Authorization" section.
paymentId						String	Yes	Payment ID in the FirstPay system.
code						String	Yes	SMS confirmation code received.

Table of returned responses:

code	Response body	Description
200	Success	Upon a successful request, payment data is returned.
400	{"error": "some text here..."}	An error occurs if the request body and query parameters could not be parsed (most likely due to incorrect formatting).
400	{"error": "SMS_NOT_REQUIRED"}	An error occurs if SMS confirmation is not required for the payment.
401	{"error": "NO_LOGIN"}	An error occurs if the publicKey field is missing in the request body.
401	{"error": "NO_TOKEN"}	An error occurs if the hash field is missing in the request body.
401	{"error": "NO_KEY"}	An error occurs if an invalid publicKey is provided.
401	{"error": "UNAUTHORIZED"}	An error occurs if there is a validation error with the publicKey and hash.
403	{"error": "ACCESS_DENIED"}	An error occurs if the merchant does not have access to the payment.
404	{"error": "NOT_FOUND"}	An error occurs if the specified payment does not exist in the system.
500	{"error": "some text here..."}	An error occurs when the server fails to process the request due to an unexpected or non-standard situation.

Description of Response Fields

Response Interface:

{
  "isSucceed": true
}

Table Describing All Fields:

Field						Type	Description
isSucceed						Boolean	Success.