> ## Documentation Index > Fetch the complete documentation index at: https://docs.paylead.fr/llms.txt > Use this file to discover all available pages before exploring further. # Get one of the rewards a consumer has received. ## OpenAPI ````yaml /program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/rewards/{reward_id} openapi: 3.1.0 info: description: | Paylead Program API. You can find complete documentation in https://docs.paylead.com/ license: name: Proprietary url: https://docs.paylead.com/ title: Perks version: 2.0.0 servers: - description: Sandbox url: https://api-{programRef}.sandbox.paylead.tech variables: programRef: default: changeme description: Program reference provided by Paylead security: - oauth2: [] tags: - name: Brands x-displayName: Brands - description: Routes used to query consumers resources name: Consumers x-displayName: Consumers - name: UPM x-displayName: UPM - name: KYC x-displayName: KYC - name: Offers x-displayName: Offers - name: Rewards x-displayName: Rewards - name: Segments x-displayName: Segments - name: Universes x-displayName: Universes - name: Voucher Orders x-displayName: Voucher Orders paths: /perks/consumers/{consumer_id}/rewards/{reward_id}: get: tags: - Rewards summary: Get one of the rewards a consumer has received. operationId: perks__consumers__consumer_id__rewards__reward_id__get parameters: - in: path name: consumer_id required: true schema: example: consumer-12345 examples: - consumer-12345 maxLength: 100 minLength: 2 pattern: ^[a-zA-Z0-9_-]+$ title: Consumer Id type: string - description: Identifier of the reward. in: path name: reward_id required: true schema: description: Identifier of the reward. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 examples: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 format: uuid title: Reward Id type: string - examples: default: value: 2.0.0 in: header name: x-api-version required: true schema: default: 2.0.0 title: X-Api-Version type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Perks_RewardSchema' description: Successful Response '400': content: application/json: example: code: PL-400-00 errors: - loc: - body - field msg: Field required type: missing instance: /path/of/the/request status: 400 title: Bad Request schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '401': content: application/json: examples: PL-401-00: summary: Unauthorized value: code: PL-401-00 status: 401 title: Unauthorized schema: $ref: '#/components/schemas/ErrorResponse' description: Unauthorized '404': content: application/json: examples: PL-404-00: summary: Not Found value: code: PL-404-00 status: 404 title: Not Found PL-404-02: summary: Consumer Not Enrolled value: code: PL-404-02 status: 404 title: Consumer Not Enrolled schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found components: schemas: Perks_RewardSchema: properties: amount: description: Amount of the reward. example: '12.34' examples: - '12.34' pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Amount type: string brand: $ref: '#/components/schemas/Perks_RewardBrandSchema' description: Brand display information for the reward. consumer_status: description: >- Consumer-facing status of the reward, derived from its moderation status: `VALIDATION` (will probably be paid, visible to the consumer), `POOLED` (the consumer can ask to be paid), `PAID` (the amount has been paid to the consumer). example: PAID examples: - PAID title: Consumer Status type: string created_at: description: When the reward was created. example: '2026-07-15T10:30:00Z' examples: - '2026-07-15T10:30:00Z' format: date-time title: Created At type: string id: description: Identifier of the reward. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 examples: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 format: uuid title: Id type: string status: description: >- Status of the reward in its moderation workflow (e.g. VALIDATED, PAID_IN, PAID_OUT). example: PAID_IN examples: - PAID_IN title: Status type: string transaction: anyOf: - $ref: '#/components/schemas/Perks_RewardTransactionSchema' - type: 'null' description: Originating transaction; null for rewards without one (e.g. gifts). type: description: Type of the reward (e.g. CASHBACK, GIFT). example: CASHBACK examples: - CASHBACK title: Type type: string required: - id - amount - created_at - type - status - consumer_status - transaction - brand title: RewardSchema type: object ErrorResponse: additionalProperties: false description: >- An error response object (PayLead profile). Extension members (e.g. ``errors`` for validation) are allowed and serialised as top-level keys. properties: code: description: Error code describing the issue example: PL-4XX-YY title: Code type: string errors: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' default: null description: A list of individual error occurrences found example: - loc: - body - field msg: Field required type: missing title: Errors instance: anyOf: - type: string - type: 'null' default: null description: A URI reference to the problematic resource example: api/resource/424242 title: Instance status: description: HTTP code returned by the API example: 400 title: Status type: integer title: description: Description of the issue example: The request was invalid. title: Title type: string required: - code - title - status title: ErrorResponse type: object Perks_RewardBrandSchema: properties: logo: anyOf: - format: uri maxLength: 2083 minLength: 1 type: string - type: 'null' description: >- Absolute CDN URL of the reward's brand logo; null if the brand has no logo. example: https://static.sandbox.paylead.fr/123455.jpeg examples: - https://static.sandbox.paylead.fr/123455.jpeg title: Logo name: anyOf: - type: string - type: 'null' description: Display name of the reward's brand. example: Nike examples: - Nike title: Name required: - name title: RewardBrandSchema type: object Perks_RewardTransactionSchema: properties: executed_at: description: When the originating transaction was executed (purchase date). example: '2026-07-14T09:12:00Z' examples: - '2026-07-14T09:12:00Z' format: date-time title: Executed At type: string external_id: description: External identifier of the originating transaction. example: txn-abc-123 examples: - txn-abc-123 title: External Id type: string required: - external_id - executed_at title: RewardTransactionSchema type: object securitySchemes: oauth2: flows: clientCredentials: scopes: ALL: Full access to all resources (wildcard). LOYALTIES: Access to loyalties features. PERKS: Access to perks features. TX_INJECTION: Access to transaction sharing. tokenUrl: /tokens type: oauth2 ````