Payments list

Swagger - detailed payment API.

Payments List Request Body Interface:

{
   "publicKey": "string",
   "hash": "string",
   "fromId": "string", // optional
   "take": "number", // optional
   "type": "string", // optional: PAY_IN, PAY_OUT
   "status": "string", // optional: PENDING, NEED_CHECK, FAILED, SUCCESS
   "currencyCode": "string", // optional
   "createdAtFrom": "number",
   "createdAtTo": "number"
}

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.
fromId						UUID	No	Keyset pagination id.
take						Number	No	Pagination take.
type						Enum: PAY_IN, PAY_OUT	No	Payment type.
status						Enum: PENDING, NEED_CHECK, FAILED, SUCCESS	No	Payment status.
currencyCode						String	No	Currency code.
createdAtFrom						Number	Yes	Timestamp of the creation date interval from.
createdAtTo						Number	Yes	Timestamp of the creation date interval to.

Table of returned responses:

code	Response body	Description
200	Payments	Upon a successful request, payments 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).
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.
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.

Payments list Fields Description

The interface of the payments array element is similar to the payment interface.

Payments Interface:

{
  "payments": [],
  "total": "number",
  "totalSucceed": "number",
  "totalFailed": "number",
  "amounts": [{
    "total": "bigint",
    "currencyCode": "string"
  }],
  "nextId": "string"
}

Table Describing All Fields:

Field						Type	Description
payments						Array	Payments array.
total						Number	Payments total count.
totalSucceed						Number	Succeed payments total count.
totalFailed						Number	Failed payments total count.
amounts						Array	An array of amount sums by currency.
	total					BigInt	Amount sum.
	currencyCode					String	Currency code.
nextId						String	Id for fromId keyset pagination.