Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.
Mock response headers let a Reseller test Entitlement API behavior in DVM Sandbox without sending the request to a Content Provider or downstream mock service.Add the X-Magic-Number header to a Reseller-to-DVM Entitlement API request to make DVM simulate a known Content Provider response.
Mock response headers apply to the Reseller-to-DVM Entitlement API only at this time. They are not a general DVM testing mechanism and are not supported by the Offer Catalog, Consumer Offers, Eligibility, Billing and Charging, Partner Management, or reporting APIs unless separately documented.
When to use mock response headers
Use mock response headers when you need to test how your Entitlement API integration handles a predictable downstream result, including happy paths, asynchronous responses, and errors.They are useful because:
You send the same Entitlement API request body used in a normal integration.
You do not need a live Content Provider or a configured downstream mock.
The requested response is deterministic.
DVM creates the entitlement state needed for subsequent Entitlement API testing where the scenario supports it.
What they do not test
Mock response headers stop the Entitlement API flow before DVM calls the Content Provider.They therefore do not validate:
The Content Provider endpoint.
Outbound authentication from DVM to the Content Provider.
Content Provider-specific API behavior.
A complete three-party integration.
Use Bango Music when you need a Bango-operated test Content Provider and a fuller end-to-end entitlement flow.
Add the header
Add X-Magic-Number to the Entitlement API request with the scenario you want DVM to simulate.
Use the Sandbox Entitlement API base URL, credentials, and identifiers supplied for your integration.
Supported scenarios
Create entitlement
Header value
Simulated behavior
CREATE_REQUEST_RETURNS_ACTIVATED
Simulates a synchronous Content Provider response that activates the entitlement.
CREATE_REQUEST_RETURNS_CREATED
Simulates creation without activation. The entitlement remains pending activation.
CREATE_REQUEST_RETURNS_ACTIVATION_REQUIRED
Simulates an asynchronous activation flow and returns mock activation information.
Activation information
Header value
Simulated behavior
ACTIVATION_INFO_RETURNS_ACTIVATION_URL
Returns mock activation URL information. The URL is not a real Content Provider activation URL.
ACTIVATION_INFO_RETURNS_ACTIVATION_CODE
Returns a mock activation code. The code is not redeemable.
Suspend
Header value
Simulated behavior
SUSPEND_RETURNS_SUSPENDED
Simulates a synchronous suspend response and moves the entitlement to suspended state.
SUSPEND_RETURNS_SUSPEND_ACCEPTED
Simulates an accepted asynchronous suspend request.
Terminate, cancel, or revoke
Header value
Simulated behavior
TERMINATE_RETURNS_TERMINATED
Simulates a synchronous termination response.
TERMINATE_RETURNS_ACCEPTED_FUTURE_DATE
Simulates an accepted termination with a future end date.
TERMINATE_RETURNS_ACCEPTED_NO_DATE
Simulates an accepted asynchronous termination without an end date.
Update
Header value
Simulated behavior
UPDATE_RETURNS_UPDATED
Simulates a synchronous successful update.
UPDATE_RETURNS_ACCEPTED
Simulates an accepted asynchronous update.
Error responses
Header value
Simulated response
ANY_REQUEST_RETURNS_BAD_REQUEST
400 Bad Request
ANY_REQUEST_RETURNS_UNAUTHORIZED
401 Unauthorized
ANY_REQUEST_RETURNS_CONFLICT
409 Conflict
ANY_REQUEST_RETURNS_INTERNAL_SERVER_ERROR
500 Internal Server Error
ANY_REQUEST_RETURNS_SERVICE_UNAVAILABLE
503 Service Unavailable
Mock response headers or Bango Music?
Testing need
Mock response headers
Bango Music
Force a known Entitlement API response
Yes
Depends on Bango Music configuration
Test Entitlement API error handling
Yes
Depends on Bango Music configuration
Test the Content Provider endpoint and authentication
No
Yes
Exercise activation through a test Content Provider
No
Yes
Test other DVM APIs
No
Use the relevant Sandbox flow
For certification, follow the test plan provided by Bango. It will identify when to use mock response headers, Bango Music, or the intended Content Provider.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Bango product documentation","description":"Product and API documentation for Bango Digital Vending Machine® (DVM™) and Direct Carrier Billing (DCB), including integration and operations guides.","colors":{"primary":"#006272","light":"#00b9d5","dark":"#00333d"},"logo":{"light":"https://mintcdn.com/bango/6QC7Ytb7V743Uvvu/logo/bango_logo_dark.png?fit=max\u0026auto=format\u0026n=6QC7Ytb7V743Uvvu\u0026q=85\u0026s=3ef75914dc0e2776bcbbe94129f2130e","dark":"https://mintcdn.com/bango/6QC7Ytb7V743Uvvu/logo/bango_logo_white.png?fit=max\u0026auto=format\u0026n=6QC7Ytb7V743Uvvu\u0026q=85\u0026s=fcc3106ce2bfe8533216f946e31ff2d7"},"favicon":"https://mintcdn.com/bango/-YQLPEjairNlbNNj/images/favicon.png?fit=max\u0026auto=format\u0026n=-YQLPEjairNlbNNj\u0026q=85\u0026s=9c1390956defba1de35137e307237b72","api":{"openapi":["openapi/current/dvm/reseller-to-dvm/offer/openapi.yaml","openapi/current/dvm/reseller-to-dvm/product/openapi.yaml","openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json","openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml","openapi/current/dvm/dvm-to-reseller/notification/openapi.yaml","openapi/current/dvm/dvm-to-reseller/eligibility/openapi.yaml","openapi/current/dvm/dvm-to-reseller/charge/openapi.json","openapi/current/dvm/dvm-to-content-provider/entitlement/openapi.yaml","openapi/current/dvm/content-provider-to-dvm/entitlement/openapi.yaml","openapi/legacy/payments/merchant-to-bango/openapi.yaml","openapi/legacy/payments/payment-provider-to-bango/openapi.yaml","openapi/legacy/resale/bango-to-content-provider/openapi.yaml","openapi/legacy/resale/bango-to-reseller/openapi.yaml","openapi/legacy/resale/content-provider-to-bango/openapi.yaml","openapi/legacy/resale/reseller-to-bango/openapi.yaml","openapi/legacy/subscriptions/bango-to-partner/openapi.yaml","openapi/legacy/subscriptions/partner-to-bango/openapi.yaml","openapi/current/dcb-payments/bango-to-payment-provider/openapi.yaml","openapi/current/dcb-payments/merchant-to-bango/identity-token/openapi.yaml","openapi/current/dcb-payments/merchant-to-bango/identity-verification/openapi.yaml","openapi/current/dcb-payments/merchant-to-bango/payments/openapi.yaml","openapi/current/dcb-payments/payment-provider-to-bango/openapi.yaml"],"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"autogenerate":true},"url":"full","mdx":{"auth":{"method":"basic"}}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#ffffff","dark":"#15181a"}},"navbar":{"links":[{"href":"https://bango.com","label":"Website"},{"href":"https://bango.com/category/blogs/","label":"Blog"},{"href":"mailto:support@bango.com","label":"Support"}],"primary":{"type":"button","label":"Enter DVM","href":"https://dvm.bango.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/bango"}},"fonts":{"family":"Arial"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":["copy","chatgpt","claude","vscode","download-spec"],"display":"header"},"markdown":{"schema":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bango","hasAudioNarration":false,"actualSubdomain":"bango","customDomains":["docs.bango.com"],"gitSource":{"type":"gitlab","owner":"bango/public-documentation","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":78224299,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5e495cf5b122bc79c89c2","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"Legacy","count":140},{"language":"default","tag":"Resale","count":61},{"language":"default","tag":"Docs","count":59},{"language":"default","tag":"Reseller","count":47},{"language":"default","tag":"DCB Payments v5","count":39},{"language":"default","tag":"APIs","count":38},{"language":"default","tag":"Subscriptions","count":27},{"language":"default","tag":"Entitlements","count":23},{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"DCB","count":21}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@bango.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--bango-pink: #CE0058;--bango-pink-light: #F5D6E4;--bango-purple: #470A68;--bango-teal-dark: #006272;--bango-teal-light: #008578;--bango-teal-light-bg: #E9F2F3}.nav-tabs{display:flex!important;justify-content:flex-start!important;width:auto!important;gap:0!important}.nav-tabs-item{flex:none!important;width:6rem!important;min-width:6rem!important;justify-content:center!important}#navbar .nav-tabs-item svg[style*=\"mask-image\"]{display:block;background-color:currentColor!important;mask-repeat:no-repeat;mask-position:center;mask-size:contain;-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;-webkit-mask-size:contain}#navbar{border-bottom:none!important}#navbar .nav-tabs-item.border-primary,#navbar .nav-tabs-item[aria-current=\"page\"]{border-bottom:2px solid var(--bango-teal-dark)!important;margin-bottom:-2px!important}#navbar .nav-logo{height:3.0625rem!important;width:auto!important}#navbar a[href].bg-primary,#navbar button.bg-primary,#navbar .nav-bar-btn-primary,#navbar a.nav-bar-btn-primary{background-color:var(--bango-teal-dark)!important;color:white!important;border-color:var(--bango-teal-dark)}#navbar a[href].bg-primary:hover,#navbar button.bg-primary:hover,#navbar .nav-bar-btn-primary:hover{background-color:var(--bango-teal-light)!important;border-color:var(--bango-teal-light)}#sidebar-title,.sidebar-group-header h5,#sidebar-content .sidebar-group-header h5{color:#111827!important;font-weight:700!important}.nav-tag-pill,#sidebar-content .sidebar-group-header [class*=\"tag\"],.sidebar .sidebar-group-header [class*=\"tag\"],#sidebar-content .sidebar-group-header .badge,.sidebar .sidebar-group-header .badge{background-color:var(--bango-pink-light)!important;color:var(--bango-pink)!important;font-size:0.65rem!important;font-weight:600!important;text-transform:lowercase!important;padding:0.15rem 0.4rem!important;border-radius:9999px!important}.dark .nav-tag-pill,.dark #sidebar-content .sidebar-group-header [class*=\"tag\"],.dark .sidebar .sidebar-group-header [class*=\"tag\"],.dark #sidebar-content .sidebar-group-header .badge,.dark .sidebar .sidebar-group-header .badge{background-color:rgba(206, 0, 88, 0.25)!important;color:#F9A8C4!important}.dark #sidebar-title,.dark .sidebar-group-header h5,.dark #sidebar-content .sidebar-group-header h5{color:#e5e7eb!important}#sidebar-content #sidebar-group a,.sidebar #sidebar-group a{color:#4b5563!important;font-weight:400!important;padding:0.375rem 0.75rem!important;border-radius:9999px!important}#sidebar-content #sidebar-group a:hover,.sidebar #sidebar-group a:hover{color:#111827!important;background-color:#f3f4f6!important}#sidebar-content #sidebar-group a:hover,.sidebar #sidebar-group a:hover,#sidebar-content #sidebar-group a.border-primary,#sidebar-content #sidebar-group a.text-primary.border-primary,.sidebar a.border-primary{box-shadow:none!important}.dark #sidebar-content #sidebar-group a:hover,.dark .sidebar #sidebar-group a:hover,.dark #sidebar-content #sidebar-group a.border-primary,.dark .sidebar a.border-primary{box-shadow:none!important}.dark #sidebar-content #sidebar-group a,.dark .sidebar #sidebar-group a{color:#9ca3af!important}.dark #sidebar-content #sidebar-group a:hover,.dark .sidebar #sidebar-group a:hover{color:#e5e7eb!important;background-color:rgba(255, 255, 255, 0.08)!important}#sidebar-content #sidebar-group a.border-primary,#sidebar-content #sidebar-group a.text-primary.border-primary,.sidebar a.border-primary{background-color:var(--bango-teal-light-bg)!important;color:#111827!important;border-color:transparent!important;font-weight:400!important}#sidebar-content #sidebar-group a.border-primary *,.sidebar a.border-primary *{color:inherit!important;font-weight:inherit!important}#sidebar-content #sidebar-group a [class*=\"tag\"],.sidebar #sidebar-group a [class*=\"tag\"],#sidebar-content #sidebar-group a .badge,.sidebar #sidebar-group a .badge{color:unset!important;font-weight:unset!important;background:unset!important;border:unset!important;box-shadow:unset!important}.dark #sidebar-content #sidebar-group a.border-primary,.dark .sidebar a.border-primary{background-color:rgba(0, 98, 114, 0.2)!important;color:#e5e7eb!important}#content-area a:not(.nav-bar-btn-primary):not([class*=\"btn\"]):not(.capability-tile-link){color:var(--bango-teal-dark)}#content-area a:not(.nav-bar-btn-primary):not([class*=\"btn\"]):not(.capability-tile-link):hover{color:var(--bango-pink)}footer{border-top:2px solid var(--bango-teal-light)}.capabilities-grid{display:grid;grid-template-columns:repeat(auto-fill, minmax(260px, 1fr));gap:1.25rem;margin:1.5rem 0;align-items:stretch}.capability-tile-link{display:block;min-height:200px;height:100%;text-decoration:none!important;color:inherit;border-bottom:none!important;box-shadow:none!important}.capability-tile-link:hover{text-decoration:none!important}.capability-tile-link::after{display:none!important}.capability-tile{background:white;border:1px solid #d1d5db;border-radius:0.75rem;padding:1.5rem;min-height:200px;height:100%;display:flex;flex-direction:column;transition:border-color 0.2s ease, box-shadow 0.2s ease}.capability-tile:hover{border-color:var(--bango-teal-dark);box-shadow:0 4px 12px rgba(0, 98, 114, 0.12)}.capability-icon{display:block;margin-bottom:0.75rem}.capability-title{display:block;font-weight:700;font-size:1rem;color:#111827;margin-bottom:0.5rem}.capability-tile p{color:#4b5563;font-size:0.9375rem;line-height:1.5;margin:0;flex:1}.dark .capability-tile{background:rgba(255, 255, 255, 0.05);border-color:rgba(255, 255, 255, 0.15)}.dark .capability-tile:hover{border-color:var(--bango-teal-light);box-shadow:0 4px 12px rgba(0, 133, 120, 0.2)}.dark .capability-title{color:#e5e7eb}.dark .capability-tile p{color:#9ca3af}"}],"page":{"pagePath":"testing/mock-response-headers","slug":"/testing/mock-response-headers","pageMetadata":{"title":"Mock response headers","description":"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.","href":"/testing/mock-response-headers"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Mock response headers let a Reseller test Entitlement API behavior in DVM Sandbox without sending the request to a Content Provider or downstream mock service.`}),`\n`,_jsxs(_components.p,{children:[`Add the `,_jsx(_components.code,{children:`X-Magic-Number`}),` header to a Reseller-to-DVM Entitlement API request to make DVM simulate a known Content Provider response.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Mock response headers apply to the `,_jsx(_components.strong,{children:`Reseller-to-DVM Entitlement API only at this time`}),`. They are not a general DVM testing mechanism and are not supported by the Offer Catalog, Consumer Offers, Eligibility, Billing and Charging, Partner Management, or reporting APIs unless separately documented.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`when-to-use-mock-response-headers`,children:`When to use mock response headers`}),`\n`,_jsx(_components.p,{children:`Use mock response headers when you need to test how your Entitlement API integration handles a predictable downstream result, including happy paths, asynchronous responses, and errors.`}),`\n`,_jsx(_components.p,{children:`They are useful because:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`You send the same Entitlement API request body used in a normal integration.`}),`\n`,_jsx(_components.li,{children:`You do not need a live Content Provider or a configured downstream mock.`}),`\n`,_jsx(_components.li,{children:`The requested response is deterministic.`}),`\n`,_jsx(_components.li,{children:`DVM creates the entitlement state needed for subsequent Entitlement API testing where the scenario supports it.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`what-they-do-not-test`,children:`What they do not test`}),`\n`,_jsx(_components.p,{children:`Mock response headers stop the Entitlement API flow before DVM calls the Content Provider.`}),`\n`,_jsxs(_components.p,{children:[`They therefore do `,_jsx(_components.strong,{children:`not`}),` validate:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The Content Provider endpoint.`}),`\n`,_jsx(_components.li,{children:`Outbound authentication from DVM to the Content Provider.`}),`\n`,_jsx(_components.li,{children:`Content Provider-specific API behavior.`}),`\n`,_jsx(_components.li,{children:`A complete three-party integration.`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.a,{href:`/testing/bango-music`,children:`Bango Music`}),` when you need a Bango-operated test Content Provider and a fuller end-to-end entitlement flow.`]}),`\n`,_jsx(Heading,{level:`2`,id:`add-the-header`,children:`Add the header`}),`\n`,_jsxs(_components.p,{children:[`Add `,_jsx(_components.code,{children:`X-Magic-Number`}),` to the Entitlement API request with the scenario you want DVM to simulate.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`X-Magic-Number`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` CREATE_REQUEST_RETURNS_ACTIVATED`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`For example, when creating an entitlement:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`10`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`10`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`sandbox-entitlement-api-base-ur`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`l`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/v1/entitlement`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Basic \u003ccredentials>\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Magic-Number: CREATE_REQUEST_RETURNS_ACTIVATED\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"customerIdentifier\": \"\u003ccustomer-identifier>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"merchantAccountKey\": \"\u003ccontent-provider-account-key>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"productKey\": \"\u003cproduct-key>\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Use the Sandbox Entitlement API base URL, credentials, and identifiers supplied for your integration.`}),`\n`,_jsx(Heading,{level:`2`,id:`supported-scenarios`,children:`Supported scenarios`}),`\n`,_jsx(Heading,{level:`3`,id:`create-entitlement`,children:`Create entitlement`}),`\n`,_jsxs(`table`,{children:[_jsxs(`colgroup`,{children:[_jsx(`col`,{width:`344`}),_jsx(`col`,{width:`325`})]}),_jsx(`thead`,{children:_jsxs(`tr`,{children:[_jsx(`th`,{children:`Header value`}),_jsx(`th`,{children:`Simulated behavior`})]})}),_jsxs(`tbody`,{children:[_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`CREATE_REQUEST_RETURNS_ACTIVATED`})}),_jsx(`td`,{children:`Simulates a synchronous Content Provider response that activates the entitlement.`})]}),_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`CREATE_REQUEST_RETURNS_CREATED`})}),_jsx(`td`,{children:`Simulates creation without activation. The entitlement remains pending activation.`})]}),_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`CREATE_REQUEST_RETURNS_ACTIVATION_REQUIRED`})}),_jsx(`td`,{children:`Simulates an asynchronous activation flow and returns mock activation information.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`activation-information`,children:`Activation information`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Header value`}),_jsx(_components.th,{children:`Simulated behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ACTIVATION_INFO_RETURNS_ACTIVATION_URL`})}),_jsx(_components.td,{children:`Returns mock activation URL information. The URL is not a real Content Provider activation URL.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ACTIVATION_INFO_RETURNS_ACTIVATION_CODE`})}),_jsx(_components.td,{children:`Returns a mock activation code. The code is not redeemable.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`suspend`,children:`Suspend`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Header value`}),_jsx(_components.th,{children:`Simulated behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`SUSPEND_RETURNS_SUSPENDED`})}),_jsx(_components.td,{children:`Simulates a synchronous suspend response and moves the entitlement to suspended state.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`SUSPEND_RETURNS_SUSPEND_ACCEPTED`})}),_jsx(_components.td,{children:`Simulates an accepted asynchronous suspend request.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`terminate-cancel-or-revoke`,children:`Terminate, cancel, or revoke`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Header value`}),_jsx(_components.th,{children:`Simulated behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`TERMINATE_RETURNS_TERMINATED`})}),_jsx(_components.td,{children:`Simulates a synchronous termination response.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`TERMINATE_RETURNS_ACCEPTED_FUTURE_DATE`})}),_jsx(_components.td,{children:`Simulates an accepted termination with a future end date.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`TERMINATE_RETURNS_ACCEPTED_NO_DATE`})}),_jsx(_components.td,{children:`Simulates an accepted asynchronous termination without an end date.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`update`,children:`Update`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Header value`}),_jsx(_components.th,{children:`Simulated behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`UPDATE_RETURNS_UPDATED`})}),_jsx(_components.td,{children:`Simulates a synchronous successful update.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`UPDATE_RETURNS_ACCEPTED`})}),_jsx(_components.td,{children:`Simulates an accepted asynchronous update.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`error-responses`,children:`Error responses`}),`\n`,_jsxs(`table`,{children:[_jsxs(`colgroup`,{children:[_jsx(`col`,{width:`335`}),_jsx(`col`,{width:`218`})]}),_jsx(`thead`,{children:_jsxs(`tr`,{children:[_jsx(`th`,{children:`Header value`}),_jsx(`th`,{children:`Simulated response`})]})}),_jsxs(`tbody`,{children:[_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`ANY_REQUEST_RETURNS_BAD_REQUEST`})}),_jsx(`td`,{children:_jsx(_components.code,{children:`400 Bad Request`})})]}),_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`ANY_REQUEST_RETURNS_UNAUTHORIZED`})}),_jsx(`td`,{children:_jsx(_components.code,{children:`401 Unauthorized`})})]}),_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`ANY_REQUEST_RETURNS_CONFLICT`})}),_jsx(`td`,{children:_jsx(_components.code,{children:`409 Conflict`})})]}),_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`ANY_REQUEST_RETURNS_INTERNAL_SERVER_ERROR`})}),_jsx(`td`,{children:_jsx(_components.code,{children:`500 Internal Server Error`})})]}),_jsxs(`tr`,{children:[_jsx(`td`,{children:_jsx(_components.code,{children:`ANY_REQUEST_RETURNS_SERVICE_UNAVAILABLE`})}),_jsx(`td`,{children:_jsx(_components.code,{children:`503 Service Unavailable`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`mock-response-headers-or-bango-music`,children:`Mock response headers or Bango Music?`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Testing need`}),_jsx(_components.th,{children:`Mock response headers`}),_jsx(_components.th,{children:`Bango Music`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Force a known Entitlement API response`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Depends on Bango Music configuration`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Test Entitlement API error handling`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Depends on Bango Music configuration`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Test the Content Provider endpoint and authentication`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Exercise activation through a test Content Provider`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Test other DVM APIs`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Use the relevant Sandbox flow`})]})]})]}),`\n`,_jsx(_components.p,{children:`For certification, follow the test plan provided by Bango. It will identify when to use mock response headers, Bango Music, or the intended Content Provider.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Mock response headers","description":"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.","href":"/testing/mock-response-headers"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"When to use mock response headers","slug":"when-to-use-mock-response-headers","depth":2,"children":[]},{"title":"What they do not test","slug":"what-they-do-not-test","depth":2,"children":[]},{"title":"Add the header","slug":"add-the-header","depth":2,"children":[]},{"title":"Supported scenarios","slug":"supported-scenarios","depth":2,"children":[{"title":"Create entitlement","slug":"create-entitlement","depth":3,"children":[]},{"title":"Activation information","slug":"activation-information","depth":3,"children":[]},{"title":"Suspend","slug":"suspend","depth":3,"children":[]},{"title":"Terminate, cancel, or revoke","slug":"terminate-cancel-or-revoke","depth":3,"children":[]},{"title":"Update","slug":"update","depth":3,"children":[]},{"title":"Error responses","slug":"error-responses","depth":3,"children":[]}]},{"title":"Mock response headers or Bango Music?","slug":"mock-response-headers-or-bango-music","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"bango","siteName":"Bango product documentation","title":"Mock response headers - Bango product documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-02T14:39:24.801Z","originalFileLocation":"testing/mock-response-headers.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=\"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bango product documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Mock response headers - Bango product documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bango product documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bango.com/testing/mock-response-headers\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bango.mintlify.site/_mintlify/api/og/v2?division=Testing\u0026amp;title=Mock+response+headers\u0026amp;description=Use+X-Magic-Number+in+Sandbox+to+simulate+Content+Provider+responses+when+testing+the+Reseller-to-DVM+Entitlement+API.\u0026amp;theme=ac4beb546e71a1132cdf8a4b\u0026amp;signature=2dbfc960f78bfde6ebe72e6a2d9e512c2ec2614bd4285102006ddfdad7f7a8a9\">\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=\"Mock response headers - Bango product documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bango.mintlify.site/_mintlify/api/og/v2?division=Testing\u0026amp;title=Mock+response+headers\u0026amp;description=Use+X-Magic-Number+in+Sandbox+to+simulate+Content+Provider+responses+when+testing+the+Reseller-to-DVM+Entitlement+API.\u0026amp;theme=ac4beb546e71a1132cdf8a4b\u0026amp;signature=2dbfc960f78bfde6ebe72e6a2d9e512c2ec2614bd4285102006ddfdad7f7a8a9\">\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/bango/D4mbEm-MowhRm-F_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bango product documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006272\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bango.com/testing/mock-response-headers\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/testing/mock-response-headers.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bango.com/#organization\",\"name\":\"Bango product documentation\",\"url\":\"https://docs.bango.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bango/6QC7Ytb7V743Uvvu/logo/bango_logo_dark.png?fit=max\u0026auto=format\u0026n=6QC7Ytb7V743Uvvu\u0026q=85\u0026s=3ef75914dc0e2776bcbbe94129f2130e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bango.com#website\",\"name\":\"Bango product documentation\",\"url\":\"https://docs.bango.com\",\"publisher\":{\"@id\":\"https://docs.bango.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bango.com/testing/mock-response-headers#webpage\",\"url\":\"https://docs.bango.com/testing/mock-response-headers\",\"name\":\"Mock response headers\",\"description\":\"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.\",\"dateModified\":\"2026-10-02T14:39:24.801Z\",\"isPartOf\":{\"@id\":\"https://docs.bango.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bango.com/testing/mock-response-headers#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bango.com/testing/mock-response-headers#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Testing\",\"item\":\"https://docs.bango.com/testing/testing-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Mock response headers\",\"item\":\"https://docs.bango.com/testing/mock-response-headers\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.bango.com/testing/mock-response-headers#article\",\"headline\":\"Mock response headers\",\"name\":\"Mock response headers\",\"description\":\"Use X-Magic-Number in Sandbox to simulate Content Provider responses when testing the Reseller-to-DVM Entitlement API.\",\"url\":\"https://docs.bango.com/testing/mock-response-headers\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bango.com/testing/mock-response-headers#webpage\"},\"dateModified\":\"2026-10-02T14:39:24.801Z\",\"publisher\":{\"@id\":\"https://docs.bango.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bango.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bango product documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Bango product documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/testing/mock-response-headers.md","siteName":"Bango product documentation","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/welcome"}]},{"tab":"Guides","icon":"book-open-reader","pages":[{"title":"Guides","href":"/guides/quick-start-bundle"}]},{"tab":"APIs","icon":"rectangle-api","groups":[{"group":"DVM APIs","public":true,"icon":"rectangle-api","pages":[{"title":"DVM API overview","href":"/API/dvm-api-overview"},{"title":"Working with DVM APIs","sidebarTitle":"Working with DVM APIs","href":"/API/working-with-dvm-apis"},{"title":"OAuth 2.0 authentication","sidebarTitle":"OAuth 2.0","href":"/API/oauth2-authentication"},{"title":"API changelog","sidebarTitle":"API changelog","href":"/API/changelog"},{"title":"API resources","href":"/API/api-objects"},{"title":"Manage API keys","href":"/API/manage-api-keys"}]},{"group":"Products","public":true,"icon":"box","pages":[{"title":"Product","href":"/api-reference/products/the-product-object"},{"group":"Product catalog","pages":[{"title":"Get products","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/product/openapi.yaml get /catalogs/products","href":"/api-reference/product-catalog/get-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/product/openapi.yaml get /catalogs/products/{productId}","href":"/api-reference/product-catalog/get-a-product"}]}]},{"group":"Offers","public":true,"icon":"tag","pages":[{"title":"Offer","href":"/api-reference/offers/the-offer-object"},{"title":"Check offer eligibility","hidden":true,"href":"/api-reference/offers/check-offer-eligibility"},{"group":"Offer management","pages":[{"title":"Get offers","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/offer/openapi.yaml get /catalogs/offers","href":"/api-reference/offer-management/get-offers"},{"title":"Get an offer","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/offer/openapi.yaml get /catalogs/offers/{offerId}","href":"/api-reference/offer-management/get-an-offer"}]}]},{"group":"Consumer Offers","public":true,"icon":"users","pages":[{"title":"Consumer Offer","href":"/api-reference/consumer-offers/the-consumer-offer-object"},{"title":"Change log","hidden":true,"href":"/changelog"},{"group":"Consumer Offers","pages":[{"title":"Get Consumer Offer By Id","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json get /consumerOffers/{consumerOfferId}","href":"/api-reference/consumer-offers/get-consumer-offer-by-id"},{"title":"Create Consumer Offer","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers","href":"/api-reference/consumer-offers/create-consumer-offer"},{"title":"Cancel Consumer Offer","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers/{consumerOfferId}/cancellation","href":"/api-reference/consumer-offers/cancel-consumer-offer"},{"title":"Search Consumer Offer","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers/search","href":"/api-reference/consumer-offers/search-consumer-offer"},{"title":"Immedately Cancel A Consumer Offer","deprecated":true,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers/{consumerOfferId}/terminate","href":"/api-reference/consumer-offers/immedately-cancel-a-consumer-offer"}]}]},{"group":"Entitlements","public":true,"icon":"key","pages":[{"title":"Entitlement","href":"/api-reference/entitlements/the-entitlement-object"},{"title":"Retrieve recent top ups","hidden":true,"href":"/api-reference/top-ups/retrieve-recent-top-ups"},{"title":"Create a top up","hidden":true,"href":"/api-reference/top-ups/create-a-top-up"},{"group":"Reseller","pages":[{"group":"Echo","pages":[{"title":"Check connection","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/echo/{echoString}","href":"/api-reference/echo/check-connection"}]},{"group":"Entitlement","pages":[{"title":"Get an entitlement using externalEntitlementId","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml get /v1/entitlement","href":"/api-reference/entitlement/get-an-entitlement-using-externalentitlementid"},{"title":"Create an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement","href":"/api-reference/entitlement/create-an-entitlement"},{"title":"Update an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml patch /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/update-an-entitlement"},{"title":"Get an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml get /v1/entitlement/{entitlementId}","href":"/api-reference/entitlement/get-an-entitlement"},{"title":"Request activation info","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/activationInfo/{entitlementId}","href":"/api-reference/entitlement/request-activation-info"},{"title":"Account recovery","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/accountRecovery/{entitlementId}","href":"/api-reference/entitlement/account-recovery"},{"title":"Search for entitlements","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/report","href":"/api-reference/entitlement/search-for-entitlements"},{"title":"Suspend an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/suspend/{entitlementId}","href":"/api-reference/entitlement/suspend-an-entitlement"},{"title":"Resume an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/resume/{entitlementId}","href":"/api-reference/entitlement/resume-an-entitlement"},{"title":"Cancel an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/cancel/{entitlementId}","href":"/api-reference/entitlement/cancel-an-entitlement"},{"title":"Revoke an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/revoke/{entitlementId}","href":"/api-reference/entitlement/revoke-an-entitlement"}]},{"group":"Top Ups","pages":[{"title":"Get recent top ups","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml get /topups/entitlements/{entitlementId}","href":"/api-reference/top-ups/get-recent-top-ups"},{"title":"Create top ups","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /topups/entitlements/{entitlementId}","href":"/api-reference/top-ups/create-top-ups"}]}]},{"group":"From content provider","pages":[{"group":"Echo","pages":[{"title":"Service echo","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/echo/{echoRequestId}","href":"/api-reference/echo/service-echo"}]},{"group":"Entitlement","pages":[{"title":"Retrieve entitlement by merchant entitlement id","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml get /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/retrieve-entitlement-by-merchant-entitlement-id"},{"title":"Update an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml patch /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/update-an-entitlement"},{"title":"Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/report","href":"/api-reference/entitlement/get-a-list-of-entitlements-for-a-bangouserid-or-sharedcustomerid-matching-specific-criteria"},{"title":"Activate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/activate/{merchantEntitlementId}","href":"/api-reference/entitlement/activate-an-entitlement"},{"title":"Terminate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-an-entitlement"}]}]},{"group":"To content provider","pages":[{"group":"Entitlement","pages":[{"title":"Create Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement","href":"/api-reference/entitlement/create-entitlement"},{"title":"Patch Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml patch /v1/entitlement","href":"/api-reference/entitlement/patch-entitlement"},{"title":"Terminate Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-entitlement"}]},{"group":"Eligibility","pages":[{"title":"Check user eligibility","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/checkeligibility","href":"/api-reference/eligibility/check-user-eligibility"}]}]}]},{"group":"Billing Plans","public":true,"icon":"credit-card","hidden":true,"pages":[{"title":"Retrieve billing history","href":"/api-reference/billing-plans/retrieve-billing-history"},{"title":"Retrieve current \u0026 next bill","href":"/api-reference/billing-plans/retrieve-current-and-next-bill"}]},{"group":"Notifications","public":true,"icon":"message-code","pages":[{"group":"notification","pages":[{"title":"Notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/bango-to-partner/openapi.yaml post /","href":"/api-reference/notification/notification"}]}]},{"group":"Eligibility","public":true,"icon":"user-viewfinder","pages":[{"group":"API Reference","pages":[{"title":"Send an eligibility request to a partner","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/dvm-to-reseller/eligibility/openapi.yaml post /{partnerUrlForEligibilityCheck}","href":"/api-reference/send-an-eligibility-request-to-a-partner"}]}]},{"group":"Charge","public":true,"icon":"file-invoice-dollar","pages":[{"group":"Charge and refund","pages":[{"title":"Charge","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/dvm-to-reseller/charge/openapi.json post /charges","href":"/api-reference/charge-and-refund/charge"},{"title":"Refund","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/dvm-to-reseller/charge/openapi.json post /refunds","href":"/api-reference/charge-and-refund/refund"}]}]},{"group":"Testing","public":true,"icon":"stamp","pages":[{"title":"Testing overview","href":"/testing/testing-overview"},{"title":"Bango Music","description":"Use the Bango Music test Content Provider for Reseller self-certification in DVM Sandbox.","href":"/testing/bango-music"},{"title":"Mock response headers","href":"/testing/mock-response-headers"}]}]},{"tab":"CX","icon":"palette","hidden":true,"pages":[{"title":"CX","href":"/cx/cx-general-settings"}]},{"tab":"DCB","icon":"mobile-screen-button","pages":[{"title":"DCB","href":"/payments"}]},{"tab":"Legacy","icon":"rotate-left","products":[{"product":"Platform","description":"About the Bango Platform","pages":[{"group":"Getting started","public":true,"pages":[{"title":"Integration steps","href":"/legacy/platform/getting-started"},{"title":"What Bango needs from you","href":"/legacy/platform/getting-started/signup-data"},{"title":"Integration steps","hidden":true,"href":"/platform/getting-started/index"},{"title":"What Bango needs from you","hidden":true,"href":"/platform/getting-started/signup-data"}]},{"group":"Architecture","public":true,"pages":[{"title":"Bango Platform architecture","href":"/legacy/platform/architecture/index"},{"title":"Terminology","href":"/legacy/platform/architecture/terminology"},{"title":"Bango Platform architecture","hidden":true,"href":"/platform/architecture/index"},{"title":"Terminology","hidden":true,"href":"/platform/architecture/terminology"}]},{"group":"Connectivity","public":true,"pages":[{"title":"Connectivity overview","href":"/legacy/platform/connectivity/index"},{"title":"Bango API endpoint URLs","href":"/legacy/platform/connectivity/endpoints"},{"title":"Basic authentication","href":"/legacy/platform/connectivity/basic-auth"},{"title":"IP whitelisting","href":"/legacy/platform/connectivity/ip-whitelist"},{"title":"TLS/SSL with X.509 server certificate","href":"/legacy/platform/connectivity/ssl-cert"},{"title":"Signing HTTP messages","href":"/legacy/platform/connectivity/signing-http-messages"},{"title":"Basic authentication","hidden":true,"href":"/platform/connectivity/basic-auth"},{"title":"Bango API endpoint URLs","hidden":true,"href":"/platform/connectivity/endpoints"},{"title":"Connectivity overview","hidden":true,"href":"/platform/connectivity/index"},{"title":"IP whitelisting","hidden":true,"href":"/platform/connectivity/ip-whitelist"},{"title":"Signing HTTP Messages","hidden":true,"href":"/platform/connectivity/signing-http-messages"},{"title":"TLS/SSL with X.509 server certificate","hidden":true,"href":"/platform/connectivity/ssl-cert"}]},{"group":"Help","public":true,"pages":[{"title":"Troubleshooting","href":"/legacy/platform/architecture/index-1"},{"title":"What's new on this site?","href":"/legacy/platform/architecture/updates"},{"title":"Support contact details","href":"/legacy/platform/architecture/support"}]}]},{"product":"Resale","description":"Channel subscription distribution","groups":[{"group":"General","pages":[{"title":"About Bango Resale","href":"/legacy/resale/index"},{"title":"Bango Dashboard","href":"/legacy/resale/dashboard"},{"title":"Developer tools","href":"/legacy/resale/developer-tools"}]},{"group":"Reseller","public":true,"pages":[{"title":"About Bango Resale for resellers ","href":"/legacy/resale/reseller/index"},{"title":"Bundling and reselling with Bango Resale ","href":"/legacy/resale/reseller/getting-started"},{"title":"Bango Reseller API architecture","href":"/legacy/resale/reseller/architecture"},{"group":"Entitlements","public":true,"pages":[{"title":"Entitlements overview ","href":"/legacy/resale/reseller/entitlements/index"},{"title":"Creating an entitlement","href":"/legacy/resale/reseller/entitlements/create"},{"title":"Retrieving a single entitlement","href":"/legacy/resale/reseller/entitlements/read"},{"title":"Retrieving multiple entitlements","href":"/legacy/resale/reseller/entitlements/retrieve"},{"title":"Updating an entitlement","href":"/legacy/resale/reseller/entitlements/update"},{"title":"Suspending an entitlement","href":"/legacy/resale/reseller/entitlements/suspend"},{"title":"Resuming an entitlement","href":"/legacy/resale/reseller/entitlements/resume"},{"title":"Canceling an entitlement","href":"/legacy/resale/reseller/entitlements/cancel"},{"title":"Revoking an entitlement","href":"/legacy/resale/reseller/entitlements/revoke"}]},{"title":"Testing overview","href":"/legacy/resale/reseller/testing"},{"group":"Reseller API reference","public":true,"pages":[{"title":"Reseller API reference overview","href":"/legacy/resale/reseller/api-ref/index"},{"title":"Standard reasons for suspend, cancel, revoke, and terminate","href":"/legacy/resale/reseller/api-ref/reason-codes"},{"title":"Sending requests to Bango ","href":"/legacy/resale/reseller/api-ref/requests"},{"group":"Echo","pages":[{"title":"Service echo. Used to check Bango Resale API availability.","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/echo/{echoRequestId}","href":"/api-reference/echo/service-echo-used-to-check-bango-resale-api-availability"}]},{"group":"Get entitlement","pages":[{"title":"Get entitlement from ExternalEntitlementId","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml get /v1/entitlement","href":"/api-reference/get-entitlement/get-entitlement-from-externalentitlementid"},{"title":"Get entitlement from BangoEntitlementId","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml get /v1/entitlement/{entitlementId}","href":"/api-reference/get-entitlement/get-entitlement-from-bangoentitlementid"}]},{"group":"Create entitlement","pages":[{"title":"Create a new entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement","href":"/api-reference/create-entitlement/create-a-new-entitlement"}]},{"group":"Update entitlement","pages":[{"title":"Update an existing entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml patch /v1/entitlement","href":"/api-reference/update-entitlement/update-an-existing-entitlement"}]},{"group":"Entitlement report","pages":[{"title":"Get a list of entitlements for a customerIdentifier, matching specific criteria","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/report","href":"/api-reference/entitlement-report/get-a-list-of-entitlements-for-a-customeridentifier-matching-specific-criteria"}]},{"group":"Suspend entitlement","pages":[{"title":"Suspend an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/suspend/{entitlementId}","href":"/api-reference/suspend-entitlement/suspend-an-entitlement"}]},{"group":"Resume entitlement","pages":[{"title":"Resume an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/resume/{entitlementId}","href":"/api-reference/resume-entitlement/resume-an-entitlement"}]},{"group":"Cancel entitlement","pages":[{"title":"Cancel an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/cancel/{entitlementId}","href":"/api-reference/cancel-entitlement/cancel-an-entitlement"}]},{"group":"Revoke entitlement","pages":[{"title":"Revoke an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/revoke/{entitlementId}","href":"/api-reference/revoke-entitlement/revoke-an-entitlement"}]},{"group":"Send a notification","pages":[{"title":"Send a notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/notify/{entitlementId}","href":"/api-reference/send-a-notification/send-a-notification"}]}]},{"group":"Reseller notifications","public":true,"pages":[{"title":"Notifications from Bango","href":"/legacy/resale/reseller/api-ref/notifications"},{"group":"notification","pages":[{"title":"Notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/bango-to-partner/openapi.yaml post /","href":"/api-reference/notification/notification"}]}]},{"group":"Reporting","public":true,"pages":[{"title":"Reporting overview","href":"/legacy/resale/reseller/reporting/index"},{"title":"Reseller entitlement reports v2","href":"/legacy/resale/reseller/reporting/entitlement-reports-v2"},{"title":"Reseller Record Correlation Reports","href":"/legacy/resale/reseller/reporting/record-correlation-reports"}]},{"title":"Batch processing","href":"/legacy/resale/reseller/batch-processing"},{"title":"Bango Care","href":"/legacy/resale/reseller/bangocare"},{"title":"Frequently asked questions (FAQ)","href":"/legacy/resale/reseller/faq/index"}]},{"group":"Merchant","public":true,"pages":[{"title":"About Bango Resale for merchants","href":"/legacy/resale/merchant/index"},{"title":"Bundling OTT services with Bango Resale","href":"/legacy/resale/merchant/getting-started"},{"title":"Bango Merchant Interface API architecture","href":"/legacy/resale/merchant/architecture"},{"title":"Testing overview","href":"/legacy/resale/merchant/testing"},{"title":"Merchant Interface Overview","href":"/legacy/resale/merchant-interface/index"},{"group":"Merchant interface - Bango initiated","public":true,"pages":[{"group":"Entitlement","pages":[{"title":"Create Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement","href":"/api-reference/entitlement/create-entitlement"},{"title":"Patch Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml patch /v1/entitlement","href":"/api-reference/entitlement/patch-entitlement"},{"title":"Terminate Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-entitlement"}]},{"group":"Eligibility","pages":[{"title":"Check user eligibility","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/checkeligibility","href":"/api-reference/eligibility/check-user-eligibility"}]}]},{"group":"Merchant interface - merchant initiated","public":true,"pages":[{"group":"Echo","pages":[{"title":"Service echo","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/echo/{echoRequestId}","href":"/api-reference/echo/service-echo"}]},{"group":"Entitlement","pages":[{"title":"Retrieve entitlement by merchant entitlement id","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml get /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/retrieve-entitlement-by-merchant-entitlement-id"},{"title":"Update an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml patch /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/update-an-entitlement"},{"title":"Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/report","href":"/api-reference/entitlement/get-a-list-of-entitlements-for-a-bangouserid-or-sharedcustomerid-matching-specific-criteria"},{"title":"Activate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/activate/{merchantEntitlementId}","href":"/api-reference/entitlement/activate-an-entitlement"},{"title":"Terminate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-an-entitlement"}]}]},{"group":"Reporting","public":true,"pages":[{"title":"Reporting Overview","href":"/legacy/resale/merchant/reporting/index"},{"title":"Merchant Entitlement Reports","href":"/legacy/resale/merchant/reporting/merchant-entitlement-reports"},{"title":"Merchant Record Correlation Reports","href":"/legacy/resale/merchant/reporting/merchant-record-correlation-reports"}]},{"title":"Bango Care","href":"/legacy/resale/merchant/bangocare"}]},{"group":"End of Life","public":true,"pages":[{"title":"End of life","href":"/legacy/resale/eol/index"},{"title":"Reactivating an entitlement","href":"/legacy/resale/eol/reactivating-entitlement"},{"title":"Entitlement reactivation API","href":"/legacy/resale/eol/entitlement-reactivation-api"},{"title":"Entitlement reports","href":"/legacy/resale/eol/entitlement-reports"},{"title":"Reconciliation reports","href":"/legacy/resale/eol/reconciliation-reports"}]}]},{"product":"Subscriptions","description":"Subscriptions management for channels","pages":[{"title":"Bango Subscriptions API","href":"/legacy/subscriptions/index"},{"group":"API Reference","public":true,"pages":[{"title":"API reference","href":"/legacy/subscriptions/api-ref/index"},{"group":"Sending requests to Bango","pages":[{"title":"Sending requests to Bango","href":"/legacy/subscriptions/api-ref/requests"},{"group":"echo","pages":[{"title":"Service availability check","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml post /echo/{echoRequestId}","href":"/api-reference/echo/service-availability-check"}]},{"group":"subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml post /subscription","href":"/api-reference/subscriptions/create-a-subscription"},{"title":"Retrieve a subscription by id","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /subscription/{subscriptionId}","href":"/api-reference/subscriptions/retrieve-a-subscription-by-id"},{"title":"Change a subscription's plan","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml put /subscription/{subscriptionId}","href":"/api-reference/subscriptions/change-a-subscriptions-plan"},{"title":"Cancel a subscription now or at a future date","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml delete /subscription/{subscriptionId}","href":"/api-reference/subscriptions/cancel-a-subscription-now-or-at-a-future-date"},{"title":"Retrieve a subscription by external key","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /subscription/externalKey/{externalKey}","href":"/api-reference/subscriptions/retrieve-a-subscription-by-external-key"},{"title":"Retrieve all subscriptions for a Bango User ID","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /subscription/bangouser/{bangoUserId}","href":"/api-reference/subscriptions/retrieve-all-subscriptions-for-a-bango-user-id"},{"title":"Uncancel a pending cancellation request for a subscription","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml put /subscription/{subscriptionId}/uncancel","href":"/api-reference/subscriptions/uncancel-a-pending-cancellation-request-for-a-subscription"}]},{"group":"plans","pages":[{"title":"Create a plan","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml post /plan","href":"/api-reference/plans/create-a-plan"},{"title":"Retrieve a plan by name","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /plan/name/{planName}","href":"/api-reference/plans/retrieve-a-plan-by-name"},{"title":"Retrieve a plan by id","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /plan/{planId}","href":"/api-reference/plans/retrieve-a-plan-by-id"},{"title":"Retrieve all plans","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /plans","href":"/api-reference/plans/retrieve-all-plans"}]}]},{"group":"Notifications from Bango","pages":[{"title":"Notifications from Bango","href":"/legacy/subscriptions/api-ref/notifications"},{"group":"notification","pages":[{"title":"Notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/bango-to-partner/openapi.yaml post /","href":"/api-reference/notification/notification"}]}]}]},{"group":"Concepts","public":true,"pages":[{"title":"Key concepts","href":"/legacy/subscriptions/concepts/index"},{"title":"Products and plans","href":"/legacy/subscriptions/concepts/products-plans"},{"title":"Subscription lifecycle and timeline","href":"/legacy/subscriptions/concepts/lifecycle"},{"title":"Billing periods","href":"/legacy/subscriptions/concepts/billing-periods"},{"title":"Renewal","href":"/legacy/subscriptions/concepts/renewal"},{"title":"Conversion","href":"/legacy/subscriptions/concepts/conversion"},{"title":"Idempotency","href":"/legacy/subscriptions/concepts/idempotency"},{"title":"FAQ","href":"/legacy/subscriptions/faq/index"}]},{"title":"Changes, deprecations, and end-of-life dates","href":"/legacy/subscriptions/changelog"},{"title":"Testing","href":"/legacy/subscriptions/testing"}]},{"product":"DCB Payments v5","description":"Technology rails for Direct Carrier Billing","pages":[{"title":"About Bango Payments","href":"/legacy/dcb-payments-v5/index"},{"group":"Getting started","public":true,"pages":[{"title":"Selling with Bango Payments","href":"/legacy/dcb-payments-v5/getting-started/selling-with-bango-payments"}]},{"group":"Architecture","public":true,"pages":[{"title":"Bango Payments architecture","href":"/legacy/dcb-payments-v5/architecture/architecture"},{"title":"High-level sequence diagram","href":"/legacy/dcb-payments-v5/architecture/high-level-sequence-diagram"},{"title":"Bango Platform features","href":"/legacy/dcb-payments-v5/architecture/features"}]},{"group":"Identifying users","public":true,"pages":[{"title":"Identification overview","href":"/legacy/dcb-payments-v5/identifying-users/index"},{"title":"Skeleton code","href":"/legacy/dcb-payments-v5/identifying-users/skeleton-code"},{"title":"Common request/response flows","href":"/legacy/dcb-payments-v5/identifying-users/common-request-response-flows"},{"title":"Identity selection and methods","href":"/legacy/dcb-payments-v5/identifying-users/identity-selection-and-methods"}]},{"group":"Transactions","public":true,"pages":[{"title":"Transactions overview","href":"/legacy/dcb-payments-v5/transactions/index"},{"title":"Checking available payment methods","href":"/legacy/dcb-payments-v5/transactions/checking-available-payment-methods"},{"title":"Authorizing a payment","href":"/legacy/dcb-payments-v5/transactions/authorizing-a-payment"},{"title":"Capturing a payment","href":"/legacy/dcb-payments-v5/transactions/capturing-a-payment"},{"title":"Canceling or refunding a payment","href":"/legacy/dcb-payments-v5/transactions/canceling-or-refunding-a-payment"},{"title":"Retrieving transaction details","href":"/legacy/dcb-payments-v5/transactions/retrieving-transaction-details"},{"title":"Subscriptions and recurring transactions","href":"/legacy/dcb-payments-v5/transactions/subscriptions-and-recurring-transactions"}]},{"group":"Testing","public":true,"pages":[{"title":"Testing overview","href":"/legacy/dcb-payments-v5/testing/index"},{"title":"Using the Testing Guide","href":"/legacy/dcb-payments-v5/testing/using-the-testing-guide"},{"title":"The Prefer HTTP header","href":"/legacy/dcb-payments-v5/testing/the-prefer-http-header"},{"title":"Bango TestPay","href":"/legacy/dcb-payments-v5/testing/bango-testpay"},{"title":"Production testing","href":"/legacy/dcb-payments-v5/testing/production-testing"}]},{"group":"Merchant API reference","public":true,"pages":[{"title":"API reference overview","href":"/legacy/dcb-payments-v5/api-reference/index"},{"title":"Callbacks and notifications","href":"/legacy/dcb-payments-v5/api-reference/callbacks-and-notifications"},{"title":"Transaction Payment Items structure","href":"/legacy/dcb-payments-v5/api-reference/transaction-payment-items"},{"group":"Identity","pages":[{"title":"Retrieve data about a user.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /user/{userIdentifier}","href":"/api-reference/identity/retrieve-data-about-a-user"},{"title":"Delete a user.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml delete /v5/identity/{bangoUserId}","href":"/api-reference/identity/delete-a-user"},{"title":"Get a user's Bango ID (initial request)","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml post /v5/identity","href":"/api-reference/identity/get-a-users-bango-id-initial-request"},{"title":"Get a user's Bango ID (subsequent request)","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml post /v5/identity/{sessionId}","href":"/api-reference/identity/get-a-users-bango-id-subsequent-request"}]},{"group":"Transaction","pages":[{"title":"Authorize transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml post /transaction","href":"/api-reference/transaction/authorize-transaction"},{"title":"Check available payment methods","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml options /v5/transaction","href":"/api-reference/transaction/check-available-payment-methods"},{"title":"Retrieve data about a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /transaction/{transactionId}","href":"/api-reference/transaction/retrieve-data-about-a-transaction"},{"title":"Capture transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml put /transaction/{transactionId}","href":"/api-reference/transaction/capture-transaction"},{"title":"Cancel or refund a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml patch /transaction/{transactionId}","href":"/api-reference/transaction/cancel-or-refund-a-transaction"}]}]},{"group":"Payment Provider API reference","public":true,"pages":[{"title":"Payment Provider API reference overview","href":"/legacy/dcb-payments-v5/payment-provider-api-reference/index"},{"group":"Identity","pages":[{"title":"Retrieve data about a user.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /user/{userIdentifier}","href":"/api-reference/identity/retrieve-data-about-a-user"}]},{"group":"Transaction","pages":[{"title":"Authorize transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml post /transaction","href":"/api-reference/transaction/authorize-transaction"},{"title":"Retrieve data about a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /transaction/{transactionId}","href":"/api-reference/transaction/retrieve-data-about-a-transaction"},{"title":"Capture transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml put /transaction/{transactionId}","href":"/api-reference/transaction/capture-transaction"},{"title":"Cancel or refund a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml patch /transaction/{transactionId}","href":"/api-reference/transaction/cancel-or-refund-a-transaction"}]}]},{"group":"Reporting","public":true,"pages":[{"title":"Transaction reports","href":"/legacy/dcb-payments-v5/reporting/transaction-reports"}]},{"group":"Bango care","public":true,"pages":[{"title":"Bango Care","href":"/legacy/dcb-payments-v5/bango-care/index"}]},{"group":"Bango dashboard","public":true,"pages":[{"title":"Bango Dashboard","href":"/legacy/dcb-payments-v5/bango-dashboard/index"}]},{"group":"Developer tools","public":true,"pages":[{"title":"Developer Tools","href":"/legacy/dcb-payments-v5/developer-tools/index"}]},{"title":"Change log","href":"/legacy/dcb-payments-v5/changelog"}]}]}]},"basePath":"","title":"Mock response headers - Bango product documentation","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":[],"chunks":[]}