This is the reference documentation and schemas for the Forward Payments Core API API. For tutorials and other documentation please refer to the documentation.

Forward uses API Keys to manage access to the API. You can pass the API key in the x-api-key header to the request. Talk you your sales rep about acquiring these API keys. Authorization is done via headers. You should pass the api key as the value to the x-api-key header. For example, x-api-key: ${API_KEY}. For more information on authentication, please refer to the authentication token docs. Please note that you will be given 2 API keys, one public key and one private key. Use the private key for all server to server communication. The public key is used for interfacing wih the Forward JS SDK.

Forward provides support for idempotency, a feature that allows requests to be safely retried without the risk of duplicate operations. This becomes particularly useful when an API call is interrupted during transmission, resulting in the absence of a response.

To execute an idempotent request, include the idempotency key in the x-idempotency-key header of the request. This key, which should be a unique value of at least 10 characters, is generated by the client. The method of creating this key is up to you, but we recommend using UUID v4 or any other string that has sufficient entropy to prevent overlaps.

Forward's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result for a period of up to 1 hour.

Idempotency is only supported for POST and PUT requests.