Headers

Requests must be sent over HTTPS with any payload formatted in JSON (application/json). Every request must include the headers Accept: application/json and Auhorization.

curl --request GET \
     --url https://api.paygreen.fr/payment/payment-orders/po_fecc27c687b942e6b80170dc769f4dc7 \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer JWT_TOKEN'

Rate limiting

The API allows a maximum of 600 requests per minute.
If your activity requires further limiting please reach out to our customer support.

Responses

All API responses are formatted in JSON (application/json). They are formatted with 2 properties by default.

Name	Type	Description
data	object / array objects	Response content
timestamp	datetime	Datetime of the request
pagination	object	Detail of the pagination information. Only for endpoints with pagination.

Pagination

Depending on the endpoint and on your request, the results returned may be paginated. You can page through the results by using following parameters in the query string.

Name	Type	Description
page	integer	Retrieve a result of specified page
max_per_page	integer	The number of results returned per page (maximum = 100). The default and maximum value may vary per endpoint

curl --request GET \
     --url https://api.paygreen.fr/payment/transactions?requester_shop_id=sh_8ecb6930af424b62966a12576214346f&max_per_page=10&page=2 \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer JWT_TOKEN'

The Api response sends information about the pagination of your request in a json response.

"pagination": {
	"totalResults": 95,
	"totalPages": 5,
	"maxPerPage": 20,
	"prev": "https://api.paygreen.fr/payment/transactions?requester_shop_id=sh_8ecb6930af424b62966a12576214346f&max_per_page=20&page=1",
	"current": "https://api.paygreen.fr/payment/transactions?requester_shop_id=sh_8ecb6930af424b62966a12576214346f&max_per_page=20&page=2",
	"next": "https://api.paygreen.fr/payment/transactions?requester_shop_id=sh_8ecb6930af424b62966a12576214346f&max_per_page=20&page=3",
	"template": "https://api.paygreen.fr/payment/transactions?requester_shop_id=sh_8ecb6930af424b62966a12576214346f&max_per_page=20&page=__page__"
}