Skip to main content
Documentation Powered by Redocly

Recardy API (1.6.3)

Recardy offers an easy-to-use REST API to integrate your application with.
If you need support please feel free to contact us at developer@recardy.com.

© Recardy.com

Authentication

To access our API, you need to have a valid JWT token.
This endpoints create the JWT token accepting an api_key and api_secret. Api keys are meant for integration purposes.

The api_key and api_secret will be generated for you.

The JWT token must be sent with every following request in the Authorization header field using the Bearer authentication scheme.

Authenticates with the API

Returns a JWT token to be used with other API-calls and a refresh token which can be used to refresh a token after its expiration.

Authorizations:
Bearer
Request Body schema: application/json
api_key
required
string (API Key)

an api users api key

api_secret
required
string (API Secret)

the matching api secret

Responses

Request samples

Content type
application/json
{
  • "api_key": "live_ade8272e-b272-413f-b348-21a19c4fa8c6",
  • "api_secret": "340ca7cb31232a87450c40555cd00765bce12ab017c4f68399d9a2e2833b5542"
}

Response samples

Content type
application/json
{
  • "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NTYwODUxMDAsImV4cCI6MTY1NjA4ODcwMCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sImFwaV9rZXkiOiJ0c3RfMzE4OTc4NDNjNDFlNmY4NDIxZTkwMDlmYTNkY2QyMDYifQ.O9HRP8MqSHrH9KO8GIixkvxxVcQQU9vhmP6ce0iUIXLNaqdjSeLumlfC2-ZJbfdMLmSfNn5DIiVxRmSP3zgJh1nnzuiMFP81Yq9g0iD6ZKC8ygYKYrN6I71kYPS-q1CPz5Ze4Ethpbh5rsanGdfGCIccpM7Vx5fzxHYWo0Nn0ZAhL9cHiym0CSxc6EbGvHSYESGLidxuI65EGXqxdqXH9B7ZqBBLbPoH6pSUaqCSQ2lbsziALK3wrjgAS6gth3vZvLRiV5oDEU9QagQzpY5hpe_U1CX4SZPqh1PUaSiUUlAOD11hen5h9RtPyZGBPO_AcXucEWjckbTuw0VWgM5gfQ",
  • "service_tokens": {
    },
  • "refresh_token": "50c774fa8345bd577d61f27f2e0a7fd747e785d491889096f77fc9595d9bd2b9433d355af2738ba9ebc24257f3d056ab024e2dcbb85135447e585fc3250372da"
}

Refreshes an expired JWT token

Returns a JWT token to be used with other API-calls and a refresh token which can be used to refresh a token after its expiration.

Authorizations:
Bearer
Request Body schema: application/json
refresh_token
required
string (Refresh token)

a refresh token to refresh an expired token

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "50c774fa8345bd577d61f27f2e0a7fd747e785d491889096f77fc9595d9bd2b9433d355af2738ba9ebc24257f3d056ab024e2dcbb85135447e585fc3250372da"
}

Response samples

Content type
application/json
{
  • "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NTYwODUxMDAsImV4cCI6MTY1NjA4ODcwMCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sImFwaV9rZXkiOiJ0c3RfMzE4OTc4NDNjNDFlNmY4NDIxZTkwMDlmYTNkY2QyMDYifQ.O9HRP8MqSHrH9KO8GIixkvxxVcQQU9vhmP6ce0iUIXLNaqdjSeLumlfC2-ZJbfdMLmSfNn5DIiVxRmSP3zgJh1nnzuiMFP81Yq9g0iD6ZKC8ygYKYrN6I71kYPS-q1CPz5Ze4Ethpbh5rsanGdfGCIccpM7Vx5fzxHYWo0Nn0ZAhL9cHiym0CSxc6EbGvHSYESGLidxuI65EGXqxdqXH9B7ZqBBLbPoH6pSUaqCSQ2lbsziALK3wrjgAS6gth3vZvLRiV5oDEU9QagQzpY5hpe_U1CX4SZPqh1PUaSiUUlAOD11hen5h9RtPyZGBPO_AcXucEWjckbTuw0VWgM5gfQ",
  • "service_tokens": {
    },
  • "refresh_token": "50c774fa8345bd577d61f27f2e0a7fd747e785d491889096f77fc9595d9bd2b9433d355af2738ba9ebc24257f3d056ab024e2dcbb85135447e585fc3250372da"
}

Redemption

Get redemption configurations

Retrieves a list of redemption configurations available.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Initiate redemption

Initiates and returns a redemption.

Authorizations:
Bearer
Request Body schema: application/json
redemption_configuration_id
required
string <uuid> (Redemption configuration id)

The id of the redemption configuration.

code
required
string (Redemption code)

The code of the redemption request.

arguments
object or null (Redemption request arguments)

The arguments of the redemption request.

Responses

Request samples

Content type
application/json
{
  • "redemption_configuration_id": "b3d0a0e0-9f1a-4e1a-8b0a-0e9f1a4e1a8b",
  • "code": "HSCD-UIMA-ROPD-CXMQ",
  • "arguments": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version": 1,
  • "organization_id": "7064c55e-dd59-41e1-847d-6fe265c80293",
  • "organization_scope": "Organization",
  • "code": "XLBV-LDEJ-DXLB",
  • "amount": 10,
  • "currency": "string",
  • "booking_text": "Shopping at www.shop.com",
  • "redemption_state": "Initial",
  • "state": "Initial",
  • "recards": [
    ],
  • "statistically_recorded": true,
  • "created_at": "2021-01-01T00:00:00+00:00",
  • "updated_at": "2021-01-01T00:00:00+00:00",
  • "committed_by": "user@example.net",
  • "committed_at": "2021-01-01T00:00:00+00:00",
  • "cancelled_by": "user@example.net",
  • "cancelled_at": "2021-01-01T00:00:00+00:00"
}

Get redemption

Retrieves a single redemption by it's id.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Redemption id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version": 1,
  • "organization_id": "7064c55e-dd59-41e1-847d-6fe265c80293",
  • "organization_scope": "Organization",
  • "code": "XLBV-LDEJ-DXLB",
  • "amount": 10,
  • "currency": "string",
  • "booking_text": "Shopping at www.shop.com",
  • "redemption_state": "Initial",
  • "state": "Initial",
  • "recards": [
    ],
  • "statistically_recorded": true,
  • "created_at": "2021-01-01T00:00:00+00:00",
  • "updated_at": "2021-01-01T00:00:00+00:00",
  • "committed_by": "user@example.net",
  • "committed_at": "2021-01-01T00:00:00+00:00",
  • "cancelled_by": "user@example.net",
  • "cancelled_at": "2021-01-01T00:00:00+00:00"
}

Commit redemption

Commits a redemption by it's id.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Redemption id

Request Body schema: application/json
arguments
object or null (Redemption request arguments)

The arguments of the redemption request.

Responses

Request samples

Content type
application/json
{
  • "arguments": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version": 1,
  • "organization_id": "7064c55e-dd59-41e1-847d-6fe265c80293",
  • "organization_scope": "Organization",
  • "code": "XLBV-LDEJ-DXLB",
  • "amount": 10,
  • "currency": "string",
  • "booking_text": "Shopping at www.shop.com",
  • "redemption_state": "Initial",
  • "state": "Initial",
  • "recards": [
    ],
  • "statistically_recorded": true,
  • "created_at": "2021-01-01T00:00:00+00:00",
  • "updated_at": "2021-01-01T00:00:00+00:00",
  • "committed_by": "user@example.net",
  • "committed_at": "2021-01-01T00:00:00+00:00",
  • "cancelled_by": "user@example.net",
  • "cancelled_at": "2021-01-01T00:00:00+00:00"
}

Cancel redemption

Cancels a redemption by it's id.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Redemption id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version": 1,
  • "organization_id": "7064c55e-dd59-41e1-847d-6fe265c80293",
  • "organization_scope": "Organization",
  • "code": "XLBV-LDEJ-DXLB",
  • "amount": 10,
  • "currency": "string",
  • "booking_text": "Shopping at www.shop.com",
  • "redemption_state": "Initial",
  • "state": "Initial",
  • "recards": [
    ],
  • "statistically_recorded": true,
  • "created_at": "2021-01-01T00:00:00+00:00",
  • "updated_at": "2021-01-01T00:00:00+00:00",
  • "committed_by": "user@example.net",
  • "committed_at": "2021-01-01T00:00:00+00:00",
  • "cancelled_by": "user@example.net",
  • "cancelled_at": "2021-01-01T00:00:00+00:00"
}

Get redemption history

Returns a list of the last redemptions for today.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]