Recipient verification

POST /v2/recipient · API status: stable · Signature: required

Checks whether a recipient exists before creating a payment. It is recommended to call it before POST /v2/payment so you can show the user the recipient’s name and avoid sending money “into the void”.

Request body

Parameter	Type	Required	Description
`fields`	Object	Required	Recipient details as `key: value` pairs, for example `"phone": "+996502502502"`. The set of fields depends on the service — see `requiredFields` in `POST /v2/services`.
`service`	String	Required	Service ID in the Finik domain.

Example request

POST /v2/recipient

POST /v2/recipient HTTP/1.1
Host: api.paymentsgateway.averspay.kg
Content-Type: application/json
signature: <signature>
x-api-key: <apiKey>
x-api-timestamp: 1719900000000  // Use Date.now() for the current timestamp.

{
  "fields": {
    "amount": 100,
    "phone": "+996502502502"
  },
  "service": "averspay"
}

Response

Parameter	Type	Required	Description
`statusCode`	Number	Required	Response status.
`name`	String	Optional	Recipient’s full name, if the service provider returns such data. For the Finik service — initials, e.g. А. У.
`phone`	String	Optional	Recipient’s requisite. Present for the Finik service.

Example responses

200 OK — recipient found

{ "statusCode": 200, "name": "А. У.", "phone": "+996502502502" }

404 Not Found — recipient does not exist

{ "statusCode": 404, "errorMessage": "User does not exist." }

400 Bad Request — recipient is blocked

{ "statusCode": 400, "errorMessage": "User is disabled." }