Skip to main content

Get non-fiscal return document

GET https://pos.paysera.com/eapi/v1/cash-registers/{number}/return/{id}

Retrieve detailed information about a non-fiscal return document.

Return documents are issued when products are returned by customers.

Authorization​

This endpoint requires a Personal Access Token, sent as a Bearer token.

To obtain one, your account needs API permission. Once granted, go to /user/settings in your POS account and create a personal access token.

Authorization Header Format:

Authorization: Bearer YOUR_ACCESS_TOKEN

Example:

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

For more details, see the Authentication section.

Parameters​

Path Parameters​

NameTypeRequiredDescription
numberstring✓The number of the cash register
idinteger✓The ID of the financial document

Errors​

This endpoint may return the following errors:

400 - Bad Request​

The request was invalid or cannot be served.

401 - Unauthorized​

Unauthorized

This error was produced by providing incorrect credentials.

403 - Forbidden​

Forbidden

This error indicates you don't have permission to access this resource.

404 - Not Found​

Return document not found

This error indicates the requested resource was not found.

429 - Too Many Requests​

You have exceeded the rate limit. Please try again in a minute.

500 - Internal Server Error​

Internal server error

Example​

Request​

GET https://pos.paysera.com/eapi/v1/cash-registers/{number}/return/{id}
Authorization: Bearer YOUR_ACCESS_TOKEN

Response​

{
  "id": 100,
  "type": "receipt",
  "documentNumber": 123,
  "receiptNumber": "41/2",
  "receiptTime": "2024-11-04T10:15:30Z",
  "receiptSignature": "95A7-037B-4F8D-5D69",
  "status": "unsynced",
  "cashRegisterNumber": "CR-000000001",
  "order": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "number": "123456"
  },
  "payouts": [
    {
      "title": "Cash",
      "type": "cash",
      "amount": "10.00",
      "currency": "EUR"
    }
  ],
  "totalAmount": "18.98"
}

AUTHORIZATION: HTTP

REQUEST

Base URL
https://pos.paysera.com

RESPONSE

Successful response
{
  "id": 100,
  "type": "receipt",
  "documentNumber": 123,
  "receiptNumber": "41/2",
  "receiptTime": "2024-11-04T10:15:30Z",
  "receiptSignature": "95A7-037B-4F8D-5D69",
  "status": "unsynced",
  "cashRegisterNumber": "CR-000000001",
  "order": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "number": "123456"
  },
  "payouts": [
    {
      "title": "Cash",
      "type": "cash",
      "amount": "10.00",
      "currency": "EUR"
    }
  ],
  "totalAmount": "18.98"
}