Returns the customer's paginated points and tier history
This endpoint includes tier changes. If ‘IsTierHistory’ is true, disregard the use of ‘PointType’ and use ‘TierUpdate’ instead.
On success, returns HTTP 200 with hasError: false, items and pagination metadata.
An existing customer with no history returns an empty items array.
If the customer is not found, returns HTTP 400 (Bad Request) with hasError: true
and errorMessages: ["Customer not found"], rather than HTTP 404 or a successful empty list.
This list response does not expose errorCode or customerId as an error field;
callers should check the HTTP status and hasError, and read errorMessages for details.
Pagination metadata in an error response does not represent a successful query.
POST
/
v1
/
pvt
/
Customer
/
{id}
/
history
Returns the customer's paginated points and tier history
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BonifiQ Developers","colors":{"primary":"#8849f9","light":"#4DCCF8","dark":"#291D5C"},"logo":{"light":"https://mintcdn.com/bonifiq/GKwMiRtr4XYxzOf1/logo/logobonifiq.svg?fit=max\u0026auto=format\u0026n=GKwMiRtr4XYxzOf1\u0026q=85\u0026s=37aa2bf1ee2234bd01c4e9a3c1000de8","dark":"https://mintcdn.com/bonifiq/GKwMiRtr4XYxzOf1/logo/logobonifiq.svg?fit=max\u0026auto=format\u0026n=GKwMiRtr4XYxzOf1\u0026q=85\u0026s=37aa2bf1ee2234bd01c4e9a3c1000de8"},"favicon":"https://mintcdn.com/bonifiq/PGe7x4hEVfeKAenM/favicon2.png?fit=max\u0026auto=format\u0026n=PGe7x4hEVfeKAenM\u0026q=85\u0026s=5280058f655795a8d99791fd8e446790","navbar":{"links":[{"href":"https://suporte.bonifiq.com.br","label":"Suporte"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.bonifiq.com.br"}},"footer":{"socials":{"github":"https://github.com/bonifiq","linkedin":"https://linkedin.com/company/bonifiq"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bonifiq","hasAudioNarration":false,"actualSubdomain":"bonifiq","customDomains":["developers.bonifiq.com.br"],"gitSource":{"type":"github","owner":"bonifiq","repo":"developers-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada8972a27a20d4c0abff82","collectionId":"be6eff0e-8981-444d-a810-c438302eae57","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada8972a27a20d4c0abff82"},"feedback":{"issues":false,"edits":false,"thumbs":true},"entitlements":{},"buildId":"6ada8972a27a20d4c0abff82","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Backend (Privada)","count":170},{"language":"default","tag":"Customer","count":25},{"language":"default","tag":"API Frontend (Pública)","count":22},{"language":"default","tag":"Reports","count":11},{"language":"default","tag":"API Widget","count":10},{"language":"default","tag":"POS","count":9},{"language":"default","tag":"Tiers","count":9},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Tópicos","count":6},{"language":"default","tag":"Checkout","count":5}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/private/customer/returns-the-customers-paginated-points-and-tier-history","slug":"/api/private/customer/returns-the-customers-paginated-points-and-tier-history","pageMetadata":{"title":"Returns the customer's paginated points and tier history","description":"This endpoint includes tier changes. If 'IsTierHistory' is true, disregard the use of 'PointType' and use 'TierUpdate' instead.\n \nOn success, returns HTTP 200 with `hasError: false`, `items` and pagination metadata.\nAn existing customer with no history returns an empty `items` array.\nIf the customer is not found, returns HTTP 400 (Bad Request) with `hasError: true`\nand `errorMessages: [\"Customer not found\"]`, rather than HTTP 404 or a successful empty list.\nThis list response does not expose `errorCode` or `customerId` as an error field;\ncallers should check the HTTP status and `hasError`, and read `errorMessages` for details.\nPagination metadata in an error response does not represent a successful query.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/history","href":"/api/private/customer/returns-the-customers-paginated-points-and-tier-history","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"This endpoint includes tier changes. If ‘IsTierHistory’ is true, disregard the use of ‘PointType’ and use ‘TierUpdate’ instead.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"On success, returns HTTP 200 with \", _jsx(_components.code, {\n children: \"hasError: false\"\n }), \", \", _jsx(_components.code, {\n children: \"items\"\n }), \" and pagination metadata.\\nAn existing customer with no history returns an empty \", _jsx(_components.code, {\n children: \"items\"\n }), \" array.\\nIf the customer is not found, returns HTTP 400 (Bad Request) with \", _jsx(_components.code, {\n children: \"hasError: true\"\n }), \"\\nand \", _jsx(_components.code, {\n children: \"errorMessages: [\\\"Customer not found\\\"]\"\n }), \", rather than HTTP 404 or a successful empty list.\\nThis list response does not expose \", _jsx(_components.code, {\n children: \"errorCode\"\n }), \" or \", _jsx(_components.code, {\n children: \"customerId\"\n }), \" as an error field;\\ncallers should check the HTTP status and \", _jsx(_components.code, {\n children: \"hasError\"\n }), \", and read \", _jsx(_components.code, {\n children: \"errorMessages\"\n }), \" for details.\\nPagination metadata in an error response does not represent a successful query.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Returns the customer's paginated points and tier history","description":"This endpoint includes tier changes. If 'IsTierHistory' is true, disregard the use of 'PointType' and use 'TierUpdate' instead.\n \nOn success, returns HTTP 200 with `hasError: false`, `items` and pagination metadata.\nAn existing customer with no history returns an empty `items` array.\nIf the customer is not found, returns HTTP 400 (Bad Request) with `hasError: true`\nand `errorMessages: [\"Customer not found\"]`, rather than HTTP 404 or a successful empty list.\nThis list response does not expose `errorCode` or `customerId` as an error field;\ncallers should check the HTTP status and `hasError`, and read `errorMessages` for details.\nPagination metadata in an error response does not represent a successful query.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/history","href":"/api/private/customer/returns-the-customers-paginated-points-and-tier-history","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customer"],"summary":"Returns the customer's paginated points and tier history","description":"This endpoint includes tier changes. If 'IsTierHistory' is true, disregard the use of 'PointType' and use 'TierUpdate' instead.\n \nOn success, returns HTTP 200 with `hasError: false`, `items` and pagination metadata.\nAn existing customer with no history returns an empty `items` array.\nIf the customer is not found, returns HTTP 400 (Bad Request) with `hasError: true`\nand `errorMessages: [\"Customer not found\"]`, rather than HTTP 404 or a successful empty list.\nThis list response does not expose `errorCode` or `customerId` as an error field;\ncallers should check the HTTP status and `hasError`, and read `errorMessages` for details.\nPagination metadata in an error response does not represent a successful query.","operationId":"Customer_History","parameters":["0ad26939-5b1b-4a46-954b-bd34e4a3102d","cdd2583d-48e4-40bc-99f5-6486cb53a77e","4973d6c8-2127-4f9f-b57f-9b5ff7f55f59"],"responses":{"200":"96def5c9-9b22-414b-8fe2-153292bb352d"},"security":["3b74b7d0-f54f-47c9-9b6f-b0db743bd82d"],"method":"post","type":"path","servers":["467c46cb-f3b5-4d0f-b65a-4d2ba2ce57b0","3128d300-144b-4eea-8c34-3a4f0f0fc6ff"],"path":"/v1/pvt/Customer/{id}/history","baseUrlOptions":["https://api.bonifiq.com.br","https://backend--homolog.previewqa.bonifique.com.br"],"title":"Returns the customer's paginated points and tier history","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0ad26939-5b1b-4a46-954b-bd34e4a3102d":{"name":"id","in":"path","required":true,"description":"Id from the client`s store, usually email address","schema":{"type":"string","isRequired":true,"description":"Id from the client`s store, usually email address","uniqueKey":"","typeLabel":"string"},"x-position":1},"cdd2583d-48e4-40bc-99f5-6486cb53a77e":{"name":"PageNumber","in":"query","description":"Pagenation number","schema":{"type":"integer","format":"int32","description":"Pagenation number","uniqueKey":"","typeLabel":"integer\u003cint32>"},"x-position":2},"4973d6c8-2127-4f9f-b57f-9b5ff7f55f59":{"name":"PageSize","in":"query","description":"Amount of items per page, Max size is 50 items per page.","schema":{"type":"integer","format":"int32","description":"Amount of items per page, Max size is 50 items per page.","uniqueKey":"","typeLabel":"integer\u003cint32>"},"x-position":3}},"responses":{"96def5c9-9b22-414b-8fe2-153292bb352d":{"description":"Customer found; returns the requested history page, which may be empty.","content":{"application/json":{"schema":{"type":"object","description":"Base List response model methods","additionalProperties":false,"properties":{"Items":{"oneOf":[{"type":"array","description":"Collection with the found entities on the bonifiq DB.","xml":{"wrapped":true},"items":{"type":"object","properties":{"Date":{"type":"string","description":"Date when the point was given or taken","format":"date-time","uniqueKey":"Items.oneOf.0.items.[INDEX].Date","typeLabel":"string\u003cdate-time>"},"Points":{"type":"integer","description":"Amount of points received or used. For points received (such as points for purchase) it will be positive. For points taken (such as points used in purchases) it will be negative","format":"int32","uniqueKey":"Items.oneOf.0.items.[INDEX].Points","typeLabel":"integer\u003cint32>"},"Title":{"type":"string","description":"Quick description of the event","uniqueKey":"Items.oneOf.0.items.[INDEX].Title","typeLabel":"string"},"PointType":{"type":"integer","description":"0 - Purchase points\n1 - Account creation points\n2 - Birthday points\n3 - Admin-generated points. Can be either positive or negative\n4 - Points used in a reward\n5 - Review points\n6 - Points refunded (for cancelled purchases)\n7 - Points expired\n8 - Points for referral ","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],"x-enumNames":["Purchase","Signup","Birthday","Ordinary","Reward","Review","Refund","Expire","Referral","SocialMediaFollowFacebook","SocialMediaFollowInstagram","PartialOrderRefund","Quiz","CustomObjective","ReferralAffiliate","SocialMediaFollowLinkedin","SocialMediaFollowTikTok","Campaign","Participation","Fitness"],"uniqueKey":"Items.oneOf.0.items.[INDEX].PointType","typeLabel":"enum\u003cinteger>"},"IsCanceled":{"type":"boolean","description":"If true this points was used and canceled afterwards","uniqueKey":"Items.oneOf.0.items.[INDEX].IsCanceled","typeLabel":"boolean"},"CouponCode":{"oneOf":[{"type":"string","description":"If this reward contains a coupon this field represents it","uniqueKey":"Items.oneOf.0.items.[INDEX].CouponCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"If this reward contains a coupon this field represents it","uniqueKey":"Items.oneOf.0.items.[INDEX].CouponCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"Items.oneOf.0.items.[INDEX].CouponCode","typeLabel":"string | null"},"CouponRefunded":{"type":"boolean","description":"true if the coupon was refunded and cannot be used","uniqueKey":"Items.oneOf.0.items.[INDEX].CouponRefunded","typeLabel":"boolean"},"CouponIsUsed":{"type":"boolean","description":"True if the coupon was used in a purchase and cannot be used again","uniqueKey":"Items.oneOf.0.items.[INDEX].CouponIsUsed","typeLabel":"boolean"},"CouponIsAvailable":{"type":"boolean","description":"If true the Coupon in the field `CouponCode` can be used in a purchase","uniqueKey":"Items.oneOf.0.items.[INDEX].CouponIsAvailable","typeLabel":"boolean"},"CashbackDescription":{"oneOf":[{"type":"string","uniqueKey":"Items.oneOf.0.items.[INDEX].CashbackDescription.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Items.oneOf.0.items.[INDEX].CashbackDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"Items.oneOf.0.items.[INDEX].CashbackDescription","typeLabel":"string | null"},"CashbackValue":{"type":"number","description":"If cashback is enabled this field will contain the value of the cashback otherwise it will be zero","format":"decimal","uniqueKey":"Items.oneOf.0.items.[INDEX].CashbackValue","typeLabel":"number\u003cdecimal>"},"IsTierHistory":{"type":"boolean","description":"If true the fields is about tier change","uniqueKey":"Items.oneOf.0.items.[INDEX].IsTierHistory","typeLabel":"boolean"},"TierUpdate":{"type":"integer","description":"0 - Upgrade\n1 - Downgrade\n ","enum":[0,1],"x-enumNames":["Upgrade","Downgrade"],"uniqueKey":"Items.oneOf.0.items.[INDEX].TierUpdate","typeLabel":"enum\u003cinteger>"},"TierName":{"oneOf":[{"type":"string","description":"Tier name that was applied","uniqueKey":"Items.oneOf.0.items.[INDEX].TierName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tier name that was applied","uniqueKey":"Items.oneOf.0.items.[INDEX].TierName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Items.oneOf.0.items.[INDEX].TierName","typeLabel":"string | null"},"Metadatas":{"type":"array","description":"List of metadata associated with this point. A metadata can came from when inserting an order or redeeming a reward","xml":{"wrapped":true},"items":{"type":"object","properties":{"Name":{"type":"string","uniqueKey":"Items.oneOf.0.items.[INDEX].Metadatas.items.[INDEX].Name","typeLabel":"string"},"Value":{"type":"string","uniqueKey":"Items.oneOf.0.items.[INDEX].Metadatas.items.[INDEX].Value","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"Items.oneOf.0.items.[INDEX].Metadatas.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Items.oneOf.0.items.[INDEX].Metadatas","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"Items.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Items.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Collection with the found entities on the bonifiq DB.","xml":{"wrapped":true},"items":{"type":"object","properties":{"Date":{"type":"string","description":"Date when the point was given or taken","format":"date-time"},"Points":{"type":"integer","description":"Amount of points received or used. For points received (such as points for purchase) it will be positive. For points taken (such as points used in purchases) it will be negative","format":"int32"},"Title":{"type":"string","description":"Quick description of the event"},"PointType":{"type":"integer","description":"0 - Purchase points\n1 - Account creation points\n2 - Birthday points\n3 - Admin-generated points. Can be either positive or negative\n4 - Points used in a reward\n5 - Review points\n6 - Points refunded (for cancelled purchases)\n7 - Points expired\n8 - Points for referral ","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],"x-enumNames":["Purchase","Signup","Birthday","Ordinary","Reward","Review","Refund","Expire","Referral","SocialMediaFollowFacebook","SocialMediaFollowInstagram","PartialOrderRefund","Quiz","CustomObjective","ReferralAffiliate","SocialMediaFollowLinkedin","SocialMediaFollowTikTok","Campaign","Participation","Fitness"]},"IsCanceled":{"type":"boolean","description":"If true this points was used and canceled afterwards"},"CouponCode":{"oneOf":[{"type":"string","description":"If this reward contains a coupon this field represents it"},{"type":"null","description":"If this reward contains a coupon this field represents it"}]},"CouponRefunded":{"type":"boolean","description":"true if the coupon was refunded and cannot be used"},"CouponIsUsed":{"type":"boolean","description":"True if the coupon was used in a purchase and cannot be used again"},"CouponIsAvailable":{"type":"boolean","description":"If true the Coupon in the field `CouponCode` can be used in a purchase"},"CashbackDescription":{"oneOf":[{"type":"string"},{"type":"null"}]},"CashbackValue":{"type":"number","description":"If cashback is enabled this field will contain the value of the cashback otherwise it will be zero","format":"decimal"},"IsTierHistory":{"type":"boolean","description":"If true the fields is about tier change"},"TierUpdate":{"type":"integer","description":"0 - Upgrade\n1 - Downgrade\n ","enum":[0,1],"x-enumNames":["Upgrade","Downgrade"]},"TierName":{"oneOf":[{"type":"string","description":"Tier name that was applied"},{"type":"null","description":"Tier name that was applied"}]},"Metadatas":{"type":"array","description":"List of metadata associated with this point. A metadata can came from when inserting an order or redeeming a reward","xml":{"wrapped":true},"items":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"uniqueKey":"Items.oneOf.1","typeLabel":"null"}],"uniqueKey":"Items","typeLabel":"object[] | null"},"TotalItemCount":{"type":"integer","description":"Total of rewards Configurations founds.","format":"int32","uniqueKey":"TotalItemCount","typeLabel":"integer\u003cint32>"},"PageSize":{"type":"integer","description":"Pagination size","format":"int32","uniqueKey":"PageSize","typeLabel":"integer\u003cint32>"},"PageNumber":{"type":"integer","description":"Actual Page Number","format":"int32","uniqueKey":"PageNumber","typeLabel":"integer\u003cint32>"},"HasNextPage":{"type":"boolean","description":"true if there is another page to be load.","uniqueKey":"HasNextPage","typeLabel":"boolean"},"HasError":{"type":"boolean","description":"If true the request had an error.","uniqueKey":"HasError","typeLabel":"boolean"},"ErrorMessages":{"type":"array","description":"List with the error messages","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"string"},"uniqueKey":"ErrorMessages.items.[INDEX]","typeLabel":"string"},"uniqueKey":"ErrorMessages","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Items":[{"Date":"2023-11-07T05:31:56Z","Points":123,"Title":"\u003cstring>","PointType":0,"IsCanceled":true,"CouponCode":"\u003cstring>","CouponRefunded":true,"CouponIsUsed":true,"CouponIsAvailable":true,"CashbackDescription":"\u003cstring>","CashbackValue":123,"IsTierHistory":true,"TierUpdate":0,"TierName":"\u003cstring>","Metadatas":[{"Name":"\u003cstring>","Value":"\u003cstring>"}]}],"TotalItemCount":123,"PageSize":123,"PageNumber":123,"HasNextPage":true,"HasError":true,"ErrorMessages":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3b74b7d0-f54f-47c9-9b6f-b0db743bd82d":{"Basic Authentication":{"type":"http","description":"Use API Basic Auth Keys","scheme":"basic","scopes":[],"schemeName":"Basic Authentication"}}},"servers":{"467c46cb-f3b5-4d0f-b65a-4d2ba2ce57b0":{"url":"https://api.bonifiq.com.br","description":"Production"},"3128d300-144b-4eea-8c34-3a4f0f0fc6ff":{"url":"https://backend--homolog.previewqa.bonifique.com.br","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Use API Basic Auth Keys","scheme":"basic","scopes":[],"schemeName":"Basic Authentication"},"schema":{"title":"Basic Auth","type":"object","description":"Use API Basic Auth Keys","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"Basic Authentication","name":"Authorization"}],"title":"Basic Authentication"}]},"originalFileLocation":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json"},"subdomain":"bonifiq","siteName":"BonifiQ Developers","title":"Returns the customer's paginated points and tier history - BonifiQ Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T22:09:01.231Z","originalFileLocation":"api/private/customer/returns-the-customers-paginated-points-and-tier-history.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint includes tier changes. If \u0026#x27;IsTierHistory\u0026#x27; is true, disregard the use of \u0026#x27;PointType\u0026#x27; and use \u0026#x27;TierUpdate\u0026#x27; instead. On success, returns HTTP 200 with hasError: false, items and pagination metadata. An existing customer with no history returns an empty items array. If the customer is not found, returns HTTP 400 (Bad Request) with hasError: true and errorMessages: [\u0026quot;Customer not found\u0026quot;], rather than HTTP 404 or a successful empty list. This list response does not expose errorCode or customerId as an error field; callers should check the HTTP status and hasError, and read errorMessages for details. Pagination metadata in an error response does not represent a successful query.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BonifiQ Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Returns the customer\u0026#x27;s paginated points and tier history - BonifiQ Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint includes tier changes. If \u0026#x27;IsTierHistory\u0026#x27; is true, disregard the use of \u0026#x27;PointType\u0026#x27; and use \u0026#x27;TierUpdate\u0026#x27; instead. On success, returns HTTP 200 with hasError: false, items and pagination metadata. An existing customer with no history returns an empty items array. If the customer is not found, returns HTTP 400 (Bad Request) with hasError: true and errorMessages: [\u0026quot;Customer not found\u0026quot;], rather than HTTP 404 or a successful empty list. This list response does not expose errorCode or customerId as an error field; callers should check the HTTP status and hasError, and read errorMessages for details. Pagination metadata in an error response does not represent a successful query.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BonifiQ Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bonifiq.mintlify.app/_mintlify/api/og/v2?division=Customer\u0026amp;title=Returns+the+customer%27s+paginated+points+and+tier+history\u0026amp;description=This+endpoint+includes+tier+changes.+If+%27IsTierHistory%27+is+true%2C+disregard+the+use+of+%27PointType%27+and+use+%27TierUpdate%27+instead.%0A++++++++++++%0AOn+success%2C+returns\u0026amp;theme=05fe9e23d3a57822bc54615e\u0026amp;signature=d9c16ef6a10151020f5832456b9a5d1bb40673b93284fd75073e4d11f4e81b98\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Returns the customer\u0026#x27;s paginated points and tier history - BonifiQ Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint includes tier changes. If \u0026#x27;IsTierHistory\u0026#x27; is true, disregard the use of \u0026#x27;PointType\u0026#x27; and use \u0026#x27;TierUpdate\u0026#x27; instead. On success, returns HTTP 200 with hasError: false, items and pagination metadata. An existing customer with no history returns an empty items array. If the customer is not found, returns HTTP 400 (Bad Request) with hasError: true and errorMessages: [\u0026quot;Customer not found\u0026quot;], rather than HTTP 404 or a successful empty list. This list response does not expose errorCode or customerId as an error field; callers should check the HTTP status and hasError, and read errorMessages for details. Pagination metadata in an error response does not represent a successful query.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bonifiq.mintlify.app/_mintlify/api/og/v2?division=Customer\u0026amp;title=Returns+the+customer%27s+paginated+points+and+tier+history\u0026amp;description=This+endpoint+includes+tier+changes.+If+%27IsTierHistory%27+is+true%2C+disregard+the+use+of+%27PointType%27+and+use+%27TierUpdate%27+instead.%0A++++++++++++%0AOn+success%2C+returns\u0026amp;theme=05fe9e23d3a57822bc54615e\u0026amp;signature=d9c16ef6a10151020f5832456b9a5d1bb40673b93284fd75073e4d11f4e81b98\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/bonifiq/xvI3adUtu7NmJ0Yq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BonifiQ Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8849f9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/private/customer/returns-the-customers-paginated-points-and-tier-history.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.bonifiq.com.br/#organization\",\"name\":\"BonifiQ Developers\",\"url\":\"https://developers.bonifiq.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bonifiq/GKwMiRtr4XYxzOf1/logo/logobonifiq.svg?fit=max\u0026auto=format\u0026n=GKwMiRtr4XYxzOf1\u0026q=85\u0026s=37aa2bf1ee2234bd01c4e9a3c1000de8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.bonifiq.com.br#website\",\"name\":\"BonifiQ Developers\",\"url\":\"https://developers.bonifiq.com.br\",\"publisher\":{\"@id\":\"https://developers.bonifiq.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history#webpage\",\"url\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history\",\"name\":\"Returns the customer's paginated points and tier history\",\"description\":\"This endpoint includes tier changes. If 'IsTierHistory' is true, disregard the use of 'PointType' and use 'TierUpdate' instead. On success, returns HTTP 200 with hasError: false, items and pagination metadata. An existing customer with no history returns an empty items array. If the customer is not found, returns HTTP 400 (Bad Request) with hasError: true and errorMessages: [\\\"Customer not found\\\"], rather than HTTP 404 or a successful empty list. This list response does not expose errorCode or customerId as an error field; callers should check the HTTP status and hasError, and read errorMessages for details. Pagination metadata in an error response does not represent a successful query.\",\"dateModified\":\"2026-10-22T22:09:01.231Z\",\"isPartOf\":{\"@id\":\"https://developers.bonifiq.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Backend (Privada)\",\"item\":\"https://developers.bonifiq.com.br/api-private/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer\",\"item\":\"https://developers.bonifiq.com.br/api/private/customer/retrieve-the-amount-of-points-of-a-given-customer\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Returns the customer's paginated points and tier history\",\"item\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history#apireference\",\"headline\":\"Returns the customer's paginated points and tier history\",\"name\":\"Returns the customer's paginated points and tier history\",\"description\":\"This endpoint includes tier changes. If 'IsTierHistory' is true, disregard the use of 'PointType' and use 'TierUpdate' instead. On success, returns HTTP 200 with hasError: false, items and pagination metadata. An existing customer with no history returns an empty items array. If the customer is not found, returns HTTP 400 (Bad Request) with hasError: true and errorMessages: [\\\"Customer not found\\\"], rather than HTTP 404 or a successful empty list. This list response does not expose errorCode or customerId as an error field; callers should check the HTTP status and hasError, and read errorMessages for details. Pagination metadata in an error response does not represent a successful query.\",\"url\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history\",\"mainEntityOfPage\":{\"@id\":\"https://developers.bonifiq.com.br/api/private/customer/returns-the-customers-paginated-points-and-tier-history#webpage\"},\"dateModified\":\"2026-10-22T22:09:01.231Z\",\"publisher\":{\"@id\":\"https://developers.bonifiq.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.bonifiq.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BonifiQ Developers\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BonifiQ Developers","nav":{"global":null,"tabs":[{"tab":"Bem-vindo!","pages":[{"title":"Bem-vindo!","href":""}]},{"tab":"API Backend (Privada)","groups":[{"group":"API Backend (Privada)","pages":[{"title":"APIs Privadas","href":"/api-private/introduction"},{"group":"Customer","pages":[{"title":"Retrieve the amount of points of a given customer","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Customer/{id}/points","href":"/api/private/customer/retrieve-the-amount-of-points-of-a-given-customer"},{"title":"Add or remove points from a customer","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/points","href":"/api/private/customer/add-or-remove-points-from-a-customer"},{"title":"Retrieve the amount of points of a given customer using a body-based customer identifier.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/points","href":"/api/private/customer/retrieve-the-amount-of-points-of-a-given-customer-using-a-body-based-customer-identifier"},{"title":"Retrieve pending purchase points and cashback for a given customer.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Customer/{id}/pendingpoints","href":"/api/private/customer/retrieve-pending-purchase-points-and-cashback-for-a-given-customer"},{"title":"Creates a new customer","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer","href":"/api/private/customer/creates-a-new-customer"},{"title":"Get a customer information from its ID","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Customer/{id}","href":"/api/private/customer/get-a-customer-information-from-its-id"},{"title":"Update a customer based on the Id from the client store","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json put /v1/pvt/Customer/{id}","href":"/api/private/customer/update-a-customer-based-on-the-id-from-the-client-store"},{"title":"Creates or updates a customer using the OriginalId provided in the request body.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/upsert","href":"/api/private/customer/creates-or-updates-a-customer-using-the-originalid-provided-in-the-request-body"},{"title":"Allows a customer to refer (recommend) the store to a friend by using the Referral Objective","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/referfriend/{email}","href":"/api/private/customer/allows-a-customer-to-refer-recommend-the-store-to-a-friend-by-using-the-referral-objective"},{"title":"Add or remove cashback from a customer","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/cashback","href":"/api/private/customer/add-or-remove-cashback-from-a-customer"},{"title":"Redeem points for a cashback value","description":null,"deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/redeemcashback","href":"/api/private/customer/redeem-points-for-a-cashback-value"},{"title":"Returns the customer's paginated points and tier history","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/history","href":"/api/private/customer/returns-the-customers-paginated-points-and-tier-history"},{"title":"Get the progress toward the next tier for a customer.","description":null,"deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Customer/{id}/tier/next","href":"/api/private/customer/get-the-progress-toward-the-next-tier-for-a-customer"},{"title":"Returns the advanced rules currently available to a customer because of the customer segments they belong to.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Customer/{id}/segmentrules","href":"/api/private/customer/returns-the-advanced-rules-currently-available-to-a-customer-because-of-the-customer-segments-they-belong-to"},{"title":"Checks whether a customer exists and returns only its basic identification data.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Customer/{id}/exists","href":"/api/private/customer/checks-whether-a-customer-exists-and-returns-only-its-basic-identification-data"},{"title":"Set the birthday date of the given customer","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/setbirthday","href":"/api/private/customer/set-the-birthday-date-of-the-given-customer"},{"title":"Returns a list of unused coupons that the customer have redeemed in the past","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{id}/availablecoupons","href":"/api/private/customer/returns-a-list-of-unused-coupons-that-the-customer-have-redeemed-in-the-past"},{"title":"Returns a list of unused coupons that the customer have redeemed in the past using a body-based customer identifier.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/availablecoupons","href":"/api/private/customer/returns-a-list-of-unused-coupons-that-the-customer-have-redeemed-in-the-past-using-a-body-based-customer-identifier"},{"title":"Filter a list of customers based on the filter parameters. The return can be paginated.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/list","href":"/api/private/customer/filter-a-list-of-customers-based-on-the-filter-parameters-the-return-can-be-paginated"},{"title":"Change the tier of a customer in BonifiQ","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{originalId}/changetier","href":"/api/private/customer/change-the-tier-of-a-customer-in-bonifiq"},{"title":"Remove the current tier from a customer","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json delete /v1/pvt/Customer/{originalId}/removetier","href":"/api/private/customer/remove-the-current-tier-from-a-customer"},{"title":"Change the Status of the customer in BonifiQ","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Customer/{originalId}/changestatus","href":"/api/private/customer/change-the-status-of-the-customer-in-bonifiq"}]},{"group":"Order","pages":[{"title":"Add an order or purchase","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Order","href":"/api/private/order/add-an-order-or-purchase"},{"title":"request for cancelling a purchase order","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Order/{orderId}/cancel","href":"/api/private/order/request-for-cancelling-a-purchase-order"},{"title":"request for setting a purchase order completed.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Order/{orderId}/complete","href":"/api/private/order/request-for-setting-a-purchase-order-completed"},{"title":"Get v1pvtorder","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Order/{orderId}","href":"/api/private/order/get-v1pvtorder"},{"title":"Partially cancel an order","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Order/{orderId}/partialcancel","href":"/api/private/order/partially-cancel-an-order"}]},{"group":"POS","pages":[{"title":"Returns a list of available rewards for a given customer and purchase.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/POS/rewards/available","href":"/api/private/pos/returns-a-list-of-available-rewards-for-a-given-customer-and-purchase"},{"title":"This method can be used to redeem a reward in behalf of a customer.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/POS/rewards/{id}/redeem","href":"/api/private/pos/this-method-can-be-used-to-redeem-a-reward-in-behalf-of-a-customer"},{"title":"Cancel an existing reward using the OriginalKey","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json delete /v1/pvt/POS/rewards","href":"/api/private/pos/cancel-an-existing-reward-using-the-originalkey"},{"title":"Cancel an existing reward. By canceling the customer will have their points back. The reward will be in the canceled state.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json delete /v1/pvt/POS/rewards/{id}","href":"/api/private/pos/cancel-an-existing-reward-by-canceling-the-customer-will-have-their-points-back-the-reward-will-be-in-the-canceled-state"},{"title":"This is shortcut for the original /orders endpoint to add orders into BonifiQ","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/POS/orders","href":"/api/private/pos/this-is-shortcut-for-the-original-orders-endpoint-to-add-orders-into-bonifiq"},{"title":"This is shortcut for the original /orders/cancel endpoint for canceling orders.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/POS/orders/{orderId}/cancel","href":"/api/private/pos/this-is-shortcut-for-the-original-orderscancel-endpoint-for-canceling-orders"},{"title":"Partially cancel an order","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/POS/{orderId}/partialcancel","href":"/api/private/pos/partially-cancel-an-order"},{"title":"Creates a challenge (OTP) to confirm that the customer is the owner of the points","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/POS/customers/{id}/challenge","href":"/api/private/pos/creates-a-challenge-otp-to-confirm-that-the-customer-is-the-owner-of-the-points"},{"title":"After sending the challenge request the app must ask the user for the PIN Code.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/POS/customers/{id}/challengevalidate","href":"/api/private/pos/after-sending-the-challenge-request-the-app-must-ask-the-user-for-the-pin-code"}]},{"group":"Reports","pages":[{"title":"Returns the latest known forecast and granted purchase points for each order.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListPurchasePoints","href":"/api/private/reports/returns-the-latest-known-forecast-and-granted-purchase-points-for-each-order"},{"title":"Returns a list of points that will expire soon and can be sent a notification to the customer warning about the expiration.\nThe date range is based on the days before expiration configured in the BonifiQ Admin Panel","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListExpirePointsNotification","href":"/api/private/reports/returns-a-list-of-points-that-will-expire-soon-and-can-be-sent-a-notification-to-the-customer-warning-about-the-expirationthe-date-range-is-based-on-the-days-before-expiration-configured-in-the-bonifiq-admin-panel"},{"title":"Get v1pvtreportslistpointsavailablenotification","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListPointsAvailableNotification","href":"/api/private/reports/get-v1pvtreportslistpointsavailablenotification"},{"title":"Returns earned points that can be used to track received-point events and customer notification flows.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListReceivedPoints","href":"/api/private/reports/returns-earned-points-that-can-be-used-to-track-received-point-events-and-customer-notification-flows"},{"title":"Returns a list of sales (orders that used an BonifiQ reward) filtered by date.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListSalesReport","href":"/api/private/reports/returns-a-list-of-sales-orders-that-used-an-bonifiq-reward-filtered-by-date"},{"title":"Returns a list of orders filtered by date.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListOrdersReport","href":"/api/private/reports/returns-a-list-of-orders-filtered-by-date"},{"title":"Returns the general points ledger report filtered by point event date.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListPointsReport","href":"/api/private/reports/returns-the-general-points-ledger-report-filtered-by-point-event-date"},{"title":"Returns a list of cashback transactions filtered by redeem date.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListCashbackReport","href":"/api/private/reports/returns-a-list-of-cashback-transactions-filtered-by-redeem-date"},{"title":"Returns a list of canceled cashback redemptions filtered by cancellation date.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListCanceledCashbackReport","href":"/api/private/reports/returns-a-list-of-canceled-cashback-redemptions-filtered-by-cancellation-date"},{"title":"Returns a list of generated coupons filtered by creation date.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListGeneratedCouponList","href":"/api/private/reports/returns-a-list-of-generated-coupons-filtered-by-creation-date"},{"title":"Returns a list of customers with their points balance, points to expire and point history.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Reports/ListCustomersReport","href":"/api/private/reports/returns-a-list-of-customers-with-their-points-balance-points-to-expire-and-point-history"}]},{"group":"Tiers","pages":[{"title":"Get v1pvttiers","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Tiers","href":"/api/private/tiers/get-v1pvttiers"},{"title":"Post v1pvttiersavailable","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Tiers/available","href":"/api/private/tiers/post-v1pvttiersavailable"},{"title":"Get v1pvttiers 1","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Tiers/{tierId}","href":"/api/private/tiers/get-v1pvttiers-1"},{"title":"Get v1pvttiers targets","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Tiers/{tierId}/targets","href":"/api/private/tiers/get-v1pvttiers-targets"},{"title":"Get v1pvttiers benefits","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Tiers/{tierId}/benefits","href":"/api/private/tiers/get-v1pvttiers-benefits"}]},{"group":"Affiliate","pages":[{"title":"To create and update an affiliate, it's possible to create a customer for the same.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Affiliate","href":"/api/private/affiliate/to-create-and-update-an-affiliate-its-possible-to-create-a-customer-for-the-same"},{"title":"Disables an affiliate by email or document.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json delete /v1/pvt/Affiliate/disable/{originalId}","href":"/api/private/affiliate/disables-an-affiliate-by-email-or-document"},{"title":"Reactivates an affiliate by originalId.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Affiliate/reactivate/{originalId}","href":"/api/private/affiliate/reactivates-an-affiliate-by-originalid"}]},{"group":"Checkout","pages":[{"title":"Redeems cashback for a checkout","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Checkout/redeem","href":"/api/private/checkout/redeems-cashback-for-a-checkout"},{"title":"Simulates purchase points for the current checkout/cart state.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Checkout/simulate","href":"/api/private/checkout/simulates-purchase-points-for-the-current-checkoutcart-state"},{"title":"Revalidates a previously redeemed checkout cashback against the current cart state.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Checkout/refresh","href":"/api/private/checkout/revalidates-a-previously-redeemed-checkout-cashback-against-the-current-cart-state"},{"title":"Removes an already applied cashback from a checkout.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Checkout/redeem/remove","href":"/api/private/checkout/removes-an-already-applied-cashback-from-a-checkout"},{"title":"Returns a list of available rewards for a given customer and purchase.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Checkout/rewards/available","href":"/api/private/checkout/returns-a-list-of-available-rewards-for-a-given-customer-and-purchase"}]},{"group":"Coupons","pages":[{"title":"Returns if found a coupon based on the given coupon code.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Coupons/{code}","href":"/api/private/coupons/returns-if-found-a-coupon-based-on-the-given-coupon-code"},{"title":"Creates a coupon for the given customer.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Coupons","href":"/api/private/coupons/creates-a-coupon-for-the-given-customer"},{"title":"Inactives the given coupon on the bonifiq system.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Coupons/{code}/inactive","href":"/api/private/coupons/inactives-the-given-coupon-on-the-bonifiq-system"},{"title":"Retrieves the promotion rules and details associated with a specific coupon code.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Coupons/{couponCode}/rules","href":"/api/private/coupons/retrieves-the-promotion-rules-and-details-associated-with-a-specific-coupon-code"}]},{"group":"Customization","pages":[{"title":"Returns the customizations as configured in the BonifiQ admin panel","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Customization","href":"/api/private/customization/returns-the-customizations-as-configured-in-the-bonifiq-admin-panel"}]},{"group":"Objectives","pages":[{"title":"Returns all active objectives for the client.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Objectives/active","href":"/api/private/objectives/returns-all-active-objectives-for-the-client"},{"title":"Returns all objectives for the client, including active and inactive objectives.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Objectives/all","href":"/api/private/objectives/returns-all-objectives-for-the-client-including-active-and-inactive-objectives"},{"title":"Returns a specific active objective by type.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Objectives/{type}","href":"/api/private/objectives/returns-a-specific-active-objective-by-type"},{"title":"Import a customer to be rewarded by a custom objective","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Objectives/{id}/importpoints","href":"/api/private/objectives/import-a-customer-to-be-rewarded-by-a-custom-objective"}]},{"group":"Points","pages":[{"title":"Lists points set to expire within the specified date range (paginated).","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Points/toexpire","href":"/api/private/points/lists-points-set-to-expire-within-the-specified-date-range-paginated"},{"title":"Retrieves a paginated list of customer points generated on or after a specified date.\nThis endpoint allows for filtering points by a start date and supports pagination.\nEach item in the list includes detailed point information along with associated customer data.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Points/list","href":"/api/private/points/retrieves-a-paginated-list-of-customer-points-generated-on-or-after-a-specified-datethis-endpoint-allows-for-filtering-points-by-a-start-date-and-supports-paginationeach-item-in-the-list-includes-detailed-point-information-along-with-associated-customer-data"}]},{"group":"Product","pages":[{"title":"creates a new product register.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Product","href":"/api/private/product/creates-a-new-product-register"},{"title":"Updates a given product based on a given Id from the client store.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json put /v1/pvt/Product/{id}","href":"/api/private/product/updates-a-given-product-based-on-a-given-id-from-the-client-store"},{"title":"Estimates points, cashback earned and cashback usage limits per product.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Product/points","href":"/api/private/product/estimates-points-cashback-earned-and-cashback-usage-limits-per-product"}]},{"group":"Quiz","pages":[{"title":"Retrieves a list of available quizzes.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Quiz/list","href":"/api/private/quiz/retrieves-a-list-of-available-quizzes"},{"title":"Submits answers for a specific quiz by a customer.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Quiz/answer","href":"/api/private/quiz/submits-answers-for-a-specific-quiz-by-a-customer"}]},{"group":"RewardConfigurations","pages":[{"title":"Returns a list of available rewards for a given customer and purchase.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/RewardConfigurations/rewards/available","href":"/api/private/rewardconfigurations/returns-a-list-of-available-rewards-for-a-given-customer-and-purchase"},{"title":"Returns all rewards configuration - either available or not","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/RewardConfigurations","href":"/api/private/rewardconfigurations/returns-all-rewards-configuration--either-available-or-not"},{"title":"on a Given ID, returns the Rewards configuration if found.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/RewardConfigurations/{id}","href":"/api/private/rewardconfigurations/on-a-given-id-returns-the-rewards-configuration-if-found"},{"title":"Redeem a reward for the customer given on the request body","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/RewardConfigurations/{id}/redeem","href":"/api/private/rewardconfigurations/redeem-a-reward-for-the-customer-given-on-the-request-body"}]},{"group":"Rewards","pages":[{"title":"Return an existant reward already redeemed","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Rewards/{id}","href":"/api/private/rewards/return-an-existant-reward-already-redeemed"},{"title":"Cancel an existing reward. By canceling the customer will have their points back. The reward will be in the canceled state.","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json delete /v1/pvt/Rewards/{id}","href":"/api/private/rewards/cancel-an-existing-reward-by-canceling-the-customer-will-have-their-points-back-the-reward-will-be-in-the-canceled-state"},{"title":"Post v1pvtrewardsupdatemetadata","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json post /v1/pvt/Rewards/updatemetadata","href":"/api/private/rewards/post-v1pvtrewardsupdatemetadata"}]},{"group":"Terms","pages":[{"title":"Returns the terms for the program points. Terms can be changed in the BonifiQ admin panel.\nTerms can contains HTML tags that must be rendered to the user when showing it","deprecated":null,"version":null,"openapi":"https://api.bonifiq.com.br/swagger/Private%20APIs/swagger.json get /v1/pvt/Terms","href":"/api/private/terms/returns-the-terms-for-the-program-points-terms-can-be-changed-in-the-bonifiq-admin-panelterms-can-contains-html-tags-that-must-be-rendered-to-the-user-when-showing-it"}]}]}]},{"tab":"API Frontend (Pública)","pages":[{"title":"API Frontend (Pública)","href":"/api-public/introduction"}]},{"tab":"API Widget","pages":[{"title":"API Widget","href":"/api-widget/00-introduction"}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/01-introducao"}]},{"tab":"Guias","pages":[{"title":"Guias","href":"/guias"}]}]},"title":"Returns the customer's paginated points and tier history - BonifiQ Developers","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}