> ## 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. # List the payments that paid a consumer's rewards out to their bank account. > Returns, page by page, the bank wires that paid the consumer's rewards out, most recent first by default, each with the rewards it settled. They can be filtered on their settlement status. ## OpenAPI ````yaml /program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/rewards/payments openapi: 3.1.0 info: description: | Paylead Program API. You can find complete documentation in https://docs.paylead.fr/ license: name: Proprietary url: https://docs.paylead.fr/ 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/payments: get: tags: - Rewards summary: >- List the payments that paid a consumer's rewards out to their bank account. description: >- Returns, page by page, the bank wires that paid the consumer's rewards out, most recent first by default, each with the rewards it settled. They can be filtered on their settlement status. operationId: perks__consumers__consumer_id__rewards__payments__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 - in: query name: page required: false schema: default: 1 minimum: 1 title: Page type: integer - in: query name: per_page required: false schema: default: 50 maximum: 1000 minimum: 1 title: Per Page type: integer - description: Sort field, prefixed by `-` for descending (e.g. `-created_at`). in: query name: sort required: false schema: default: '-created_at' description: Sort field, prefixed by `-` for descending (e.g. `-created_at`). enum: - created_at - '-created_at' example: '-created_at' examples: - '-created_at' title: Sort type: string - description: Filter on one or several payment statuses. in: query name: status required: false schema: anyOf: - items: $ref: '#/components/schemas/Perks_RewardPaymentStatus' type: array - type: 'null' description: Filter on one or several payment statuses. example: - SUCCEEDED - FAILED examples: - - SUCCEEDED - FAILED title: Status - 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_Page_RewardPaymentSchema_' 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-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_RewardPaymentStatus: enum: - PENDING - SUCCEEDED - FAILED example: PENDING title: RewardPaymentStatus type: string Perks_Page_RewardPaymentSchema_: properties: items: items: $ref: '#/components/schemas/Perks_RewardPaymentSchema' title: Items type: array meta: $ref: '#/components/schemas/Perks_PageMeta' required: - items - meta title: Page[RewardPaymentSchema] 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_RewardPaymentSchema: properties: amount: description: Total amount of the payment. example: '120.50' examples: - '120.50' pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Amount type: string created_at: anyOf: - format: date-time type: string - type: 'null' description: When the payment was created. example: '2026-07-15T10:30:00Z' examples: - '2026-07-15T10:30:00Z' title: Created At end_to_end_id: anyOf: - type: string - type: 'null' description: >- End-to-end identifier of the bank wire, transmitted with the credit to the consumer's bank account: the key to match the credit received with this payment. Null until the PSP provides it, and for payments created before its introduction. example: 9e38fd69efa047169cab09b5dc33dcd5 examples: - 9e38fd69efa047169cab09b5dc33dcd5 title: End To End Id executed_at: anyOf: - format: date-time type: string - type: 'null' description: >- When the PSP executed the bank wire; null until the payment is settled. example: '2026-07-16T08:04:27Z' examples: - '2026-07-16T08:04:27Z' title: Executed At payout_id: description: Identifier of the payout created on PayLead's side. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 examples: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 format: uuid title: Payout Id type: string psp_payout_id: description: >- Identifier of the bank wire payout created on the PSP (Mangopay) side. example: mp-payout-987 examples: - mp-payout-987 title: Psp Payout Id type: string reward_count: description: Number of rewards settled by this payment. example: 1 examples: - 1 title: Reward Count type: integer reward_ids: description: >- Identifiers of the rewards settled by this payment (see the rewards listing). example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 examples: - - 3fa85f64-5717-4562-b3fc-2c963f66afa6 items: format: uuid type: string title: Reward Ids type: array status: $ref: '#/components/schemas/Perks_RewardPaymentStatus' description: >- Settlement status of the bank wire: `PENDING` (initiated, not settled yet by the PSP), `SUCCEEDED` (paid to the consumer's bank account), `FAILED` (rejected or refunded by the bank; its rewards are back in the consumer's pool). example: SUCCEEDED examples: - SUCCEEDED required: - payout_id - psp_payout_id - end_to_end_id - created_at - executed_at - status - amount - reward_ids - reward_count title: RewardPaymentSchema type: object Perks_PageMeta: properties: page: example: 1 examples: - 1 title: Page type: integer per_page: example: 50 examples: - 50 title: Per Page type: integer total: example: 137 examples: - 137 title: Total type: integer required: - page - per_page - total title: PageMeta 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 ````