Introduction

PayCross has a REST-ful API. To accept payments you need to send requests of a format specified for each transaction type and endpoint. However, regardless the type, each request to PayCross API must meet the following requirements:

• Use HTTP Basic authentication with Shop ID and Secret Key as a username and a password respectively;
• Add the Content-Type: application/json and Accept: application/json headers;
• Make a JSON-serialized body;
• Use the UTF-8 encoding.

Mandatory request parameters are labeled as * required. Non-labeled parameters are considered optional.

Info

If the response with 429 HTTP code is received (Too Many Requests), it is recommended to continue sending requests, increasing the interval between each attempt, until you receive a response with an HTTP code 200.

Info

As of September 15, 2022, the API v.3 is already configured for all https://gateway.pay-cross.com/ - endpoints. To submit requests to this API version, just add the X-API-Version: 3 header to the request. For response parameters and their description, please use the API version 3 guide.

Info

Pay attention that in PayCross system, the permission for host-to-host transaction requests containing the credit card number (credit_card.number) is activated on a shop level. If the permission is not activated, the requests of the following types: payment, authorization, payout, P2P-transfer, check-up containing the card number will return an error (the error code for API v.3 requests is E.1065).

This permission is not required for sending the requests with credit_card.token and for specifying the credit card number in the recipient_credit_card.number parameter for the P2P transfer.