README.md

API reference

Looking for our payment popup? Check out the web SDK.

The API described here complements and works together with that described by the "API docs", though most functionality will eventually be available here.

Subscribe to our mailing list for deprecation notices and watch this repository for new features.

Clients:

• JavaScript
  • https://www.npmjs.com/package/@paylike/client (high-level)
  • https://www.npmjs.com/package/@paylike/request (low-level)

Table of contents:

• Basics
  • Versioning
  • Request (data)
  • Response
• Services
  • Payments
  • Vault
  • Apple Pay
• Status codes

Basics

Versioning

The Accept-Version header is used to specify the desired API version.

Accept-Version: 1

Because the version is specified for each request, it is possible to upgrade one request at a time, or mix different versions, in an application.

curl --header 'Accept-Version: 1'

Request (data)

Any request with a body must carry a header of Content-Type: application/json.

curl --header 'Content-Type: application/json' --data '{"key": "value"}'
curl --header 'Content-Type: application/json' --data @data-file.json

Response

Refer to the list below or the HTTP standard meanings for HTTP status codes.

• 429 Too Many Requests (see 429 (rate limiting) on MDN)
• 503 Service Unavailable (see 503 on MDN)

For HTTP status codes not in the 200-299 range, the response might carry an X-Status-Code header or include a code property in a JSON body referencing a more specific status code. Possible values are listed under each endpoint, and there is a complete list here.

Data returned in the body is formatted as one of:

• JSON designated by the header Content-Type: application/json
• JSON separated by newlines designated by the header Content-Type: application/x-ndjson