> ## 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. # Gets Pooled Cashback (Cagnotte). > Gets the sum of all "Paid In" cashbacks of a given consumer. "Paid In" cashbacks are cashbacks that are already paid by the merchants. They form what we call the consumer Pool (Cagnotte). Returns also the Program Threshold configuration: Manual & Automatic Threshold 0 =< C < Manual Threshold Trigger Cashback is locked in the PAID IN status, no action possible. Manual Threshold Trigger =< C < Automatic Threshold Trigger Cashback can be manually transfered by the consumer. C >= Automatic Threshold Trigger Cashback is automatically transfered by the consumer ## OpenAPI ````yaml /program/api/openapi/legacy/1.1.8/connector.json get /connectors/consumers/{consumer_id}/pools/me openapi: 3.0.2 info: description: > ## Welcome to PayLead API Documentation ! With this documentation, we will help you go through the phases of basic implementation, and help you understand the basic steps to let you reach your objectives through our API. ## Versioning Our API supports versioning, so be sure to set the right version in the header, using the Client-Api-Version field : ex : X-Api-Version = 1.0.0 ## Response code Our API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. |Code|Title|Description |------|------|------| |200|OK|Request successful |201|Created|Resource successfully created |204|No Content|Request successful with no content returned |400|Bad Request|Request was unacceptable |401|Unauthorised|API key provided is invalid |402|Request Failed|Valid parameters but the request failed |403|Forbidden|Access is forbidden. |404|Not Found|Resource does not exist |409|Conflict|The request could not be completed due to a conflict with the current state of the target resource |429|Too Many Requests|The user has sent too many requests in a given amount of time ("rate limiting"). |500, 502, 503, 504|Server Errors|Something went wrong with the PayLead API ## Error handling In case of error our API returns errors based on JSON API principles, especially for 4xx errors. An error response contains an unique id which can be used for investigation. In addition, you will find a message explaining the error, a readable code and a meta object containing more details. You can see an example below. >> ~~~~ >> { >> 'errors': { >> 'target_account': [ >> { >> 'code': 'FORMAT_ERROR', >> 'message': 'Invalid IBAN; it should be 4-34 characters, only upper-case letters and digits.', >> 'meta': { >> 'value': 'SOME-INVALID-IBAN' >> } >> } >> ] >> }, >> 'id': '784db0c2-0e87-40d4-aa62-3e801135ccf7' >> } >> ~~~~ ## Language — Content Negotiation If your program has been configured to support multiple languages, the API will respect the `Accept-Language` header as defined in [RFC7231](https://tools.ietf.org/html/rfc7231#section-5.3.5). For each incoming request, the best language will be selected by matching the list of languages accepted by the client with the list of languages supported by the program. For example, with a header of `Accept-Language: fr-FR,en-GB;q=0.8,en;q=0.3`: * If supported languages are `fr-FR, en-GB`, the best match is `fr-FR`; * If supported languages are `en-GB, fr-FR`, the best match is `fr-FR`; * If supported languages are `fr-BE, nl-BE`, the best match is `fr-BE`; * If supported languages are `it-IT, en-US`, the best match is `en-US`; * If supported languages are `de-CH, it-CH`, the best match is `de-CH`. The selected language will be exposed through the `Content-Language` header. *Note:* If some fields haven't been translated yet, they will be returned in the program's primary language. title: PayLead API version: 1.1.8 servers: - url: https://api.sandbox.paylead.tech security: - ApiKeyAuth: [] paths: /connectors/consumers/{consumer_id}/pools/me: get: tags: - Pools summary: Gets Pooled Cashback (Cagnotte). description: > Gets the sum of all "Paid In" cashbacks of a given consumer. "Paid In" cashbacks are cashbacks that are already paid by the merchants. They form what we call the consumer Pool (Cagnotte). Returns also the Program Threshold configuration: Manual & Automatic Threshold 0 =< C < Manual Threshold Trigger Cashback is locked in the PAID IN status, no action possible. Manual Threshold Trigger =< C < Automatic Threshold Trigger Cashback can be manually transfered by the consumer. C >= Automatic Threshold Trigger Cashback is automatically transfered by the consumer operationId: get.PoolResource.impersonate parameters: - description: The id you used to create the given consumer in: path name: consumer_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Pool' description: OK '400': description: Bad request '401': description: Unauthorized '403': description: Not allowed to access the resource '404': description: Not found '405': description: Method not allowed '422': description: Unprocessable Entity components: schemas: Pool: properties: configuration: $ref: '#/components/schemas/Configuration' total_amount: description: Sum of transaction amounts example: 4682.67 readOnly: true type: number type: object Configuration: properties: automatic_threshold: description: >- Pool's minimum amount to be reached to trigger automatic payout. Ex: If "automatic_threshold" is set at "10", each time the consumer's pool reaches 10€, the payout will be automatically triggered to the consumer account example: 30 type: number manual_threshold: description: >- Pool's minimum amount to be reached for the consumer to be able to manually trigger payout. Ex: if "manual_threshold" is set at "10", consumer will be able to manually trigger the payout to his account only when he reaches 10€ in his pool example: 10 type: number type: object securitySchemes: ApiKeyAuth: bearerFormat: JWT scheme: bearer type: http ````