Overview - Freedom Pay

Description

Invoice Service provides an option for billing clients through invoicing and it contains all the necessary payment details.

Request Header:

Response Header:

Name	Value	Description
X-Request-Id	uuid v7	Unique request Id
X-Datetime	datetime	Date and time of request processing
X-Request-Status	stirng	Request body format

Generating the X-JWS-Signature

To send any request, a request signature must be generated using JWS technology.

The JWS format must include the mandatory blocks header and signature and should be passed in the request header X-JWS-Signature.

Header structure

Header description:

Field	Description	Field requirement
uri	The path to the API endpoint being called	Required
auth_id	User ID for signature verification	Required
method	Request method	Required
params	Reserved field	Required
alg	Encryption algorithm	Required

Payload structure

The payload for generating JWS includes the HTTP request body.

The supported signature encryption algorithm is HS256, and the merchant's secret_key should be used as the signing key.

Generated JWS: