List income documents

Credentials

No credentials are documented for this endpoint.

Retrieve a list of income documents for a seller

Parameters

Name In Type Required Description
sellerPaymeId query string no Seller PayMe ID
sellerId query string no Seller ID
docNum query string no Document number filter
page query integer no Page number
limit query integer no Items per page

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/partner/api/documents/income'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/documents/income", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/partner/api/documents/income",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/partner/api/documents/income');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Successful response (success)

Field Type Description
payload object
payload.page integer
payload.limit integer
payload.total integer
payload.items array
payload.items[].id string
payload.items[].docType string
payload.items[].docNumber string
payload.items[].valueDate string
payload.items[].totalAmount number
payload.items[].vatAmount number
payload.items[].currency string
payload.items[].status string

400 — Bad Request (error)

Field Type Description
statusCode integer HTTP status code
message string Error message(s)
error string Error type 
{
  "statusCode": 400,
  "message": [
    "Validation failed"
  ],
  "error": "Bad Request"
}

401 — Unauthorized (error)

Field Type Description
error string
error_description string 
{
  "error": "unauthorized_client",
  "error_description": "Client authentication failed"
}