{"items":[{"type":"link","label":"Balances","link":"/products/balance/v1/openapi","routeSlug":"/products/balance/v1/openapi","content":{"contentType":"overview","meta":{"name":"Balances"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/balance/@v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/balance/@v1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Balances (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request your account details for a single account or all accounts under an entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for any request you send to our Balances API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Accept: application/vnd.worldpay.accounts.balance-v1+json\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Accept: application/vnd.worldpay.accounts.balance-v1+json\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Balances API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS whitelisting"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist the following URLs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting."},"children":[]}]}]}]}],"sectionId":"/products/balance/v1/openapi"}],"sectionId":"/products/balance/v1/openapi"}]}]}},{"label":"Get account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/balance/v1/openapi/other/getaccount","routeSlug":"/products/balance/v1/openapi/other/getaccount","metadata":{"seo":{"title":"Get account details","description":"Retrieve the details of one specific account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccount","name":"Get account details","isWebhook":false,"pointer":"/paths/~1accounts~1balance~1{accountNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of one specific account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountNumber","in":"path","schemaId":"schema_321","description":"The account number","required":true}],"pointer":"/paths/~1accounts~1balance~1{accountNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-CorrelationId","in":"header","schemaId":"schema_321","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1accounts~1balance~1{accountNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/balance/{accountNumber}","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"parameters":{"path":[{"name":"accountNumber","in":"path","required":true,"schemaId":"schema_321"}],"query":[],"querystring":[],"header":[{"name":"WP-CorrelationId","in":"header","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_321"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/accounts/balance/{accountNumber}","href":"other/getaccount","openApiOperationId":"getAccount","summary":"Get account details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/AccountResponse"}},"schemaId":"components/schemas/AccountResponse"},{"code":"400","description":"BAD REQUEST response if the request is incorrectly validated","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1json/examples/Bad request"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1json/examples/Bad request"]},{"code":"401","description":"UNAUTHORIZED response if JWT is not valid","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1json/examples/UNAUTHORIZED"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1json/examples/UNAUTHORIZED"]},{"code":"403","description":"FORBIDDEN response if you are not authorized to access","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1json/examples/FORBIDDEN"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1json/examples/FORBIDDEN"]},{"code":"404","description":"NOT FOUND response if the AccountNumber or Page was not found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1json/examples/NOT FOUND"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND"]}},"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1json/examples/NOT FOUND"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1json/examples/Internal server error"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error"]}},"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1json/examples/Internal server error"]}],"pointer":"/paths/~1accounts~1balance~1{accountNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountResponse","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/AccountResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1json/examples/Bad request"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1json/examples/Bad request"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1json/examples/UNAUTHORIZED"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1json/examples/UNAUTHORIZED"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1json/examples/FORBIDDEN"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1json/examples/FORBIDDEN"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN"]}}},{"code":"404","schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1json/examples/NOT FOUND"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1json/examples/NOT FOUND"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND"]}}},{"code":"500","schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1json/examples/Internal server error"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getaccount"}],"panels":[]}]},"httpPath":"/accounts/balance/{accountNumber}"},{"label":"Get details for all your accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/balance/v1/openapi/other/getentity","routeSlug":"/products/balance/v1/openapi/other/getentity","metadata":{"seo":{"title":"Get details for all your accounts","description":"Retrieve account details for all your accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntity","name":"Get details for all your accounts","isWebhook":false,"pointer":"/paths/~1accounts~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details for all your accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve account details for all your accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entity","in":"query","schemaId":"schema_322","description":"Your unique 6-digit ID given during the onboarding process."}],"pointer":"/paths/~1accounts~1balance/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-CorrelationId","in":"header","schemaId":"schema_321","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1accounts~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/balance","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"parameters":{"path":[],"query":[{"name":"entity","in":"query","example":"11155","schemaId":"schema_322"}],"querystring":[],"header":[{"name":"WP-CorrelationId","in":"header","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_321"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/accounts/balance","href":"other/getentity","openApiOperationId":"getEntity","summary":"Get details for all your accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/AccountResponse"}},"schemaId":"components/schemas/AccountResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/400/content/application~1json/examples/Bad request"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/400/content/application~1json/examples/Bad request"]},{"code":"401","description":"UNAUTHORIZED response if JWT is not valid","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/401/content/application~1json/examples/UNAUTHORIZED"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/401/content/application~1json/examples/UNAUTHORIZED"]},{"code":"403","description":"FORBIDDEN response if you are not authorized to access","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/403/content/application~1json/examples/FORBIDDEN"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/403/content/application~1json/examples/FORBIDDEN"]},{"code":"404","description":"NOT FOUND response if the AccountNumber or Page was not found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/404/content/application~1json/examples/NOT FOUND"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND"]}},"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/404/content/application~1json/examples/NOT FOUND"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/500/content/application~1json/examples/Internal server error"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error"]}},"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/500/content/application~1json/examples/Internal server error"]}],"pointer":"/paths/~1accounts~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountResponse","mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/AccountResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/400/content/application~1json/examples/Bad request"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/400/content/application~1json/examples/Bad request"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/401/content/application~1json/examples/UNAUTHORIZED"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/401/content/application~1json/examples/UNAUTHORIZED"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/403/content/application~1json/examples/FORBIDDEN"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/403/content/application~1json/examples/FORBIDDEN"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN"]}}},{"code":"404","schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/404/content/application~1json/examples/NOT FOUND"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/404/content/application~1json/examples/NOT FOUND"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND"]}}},{"code":"500","schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json","application/vnd.worldpay.accounts.balance-v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/500/content/application~1json/examples/Internal server error"]},"application/vnd.worldpay.accounts.balance-v1+json":{"schemaId":"components/schemas/BaseErrorResponse","exampleIds":["paths/~1accounts~1balance/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getentity"}],"panels":[]}]},"httpPath":"/accounts/balance"}],"store":{"schemaStore":{"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","properties":{"accountNumber":{"type":"string","description":"The account number.","nullable":true,"example":"1111557890987654"},"accountName":{"type":"string","description":"The name of the account. (This is given to you during onboarding and typically consists of your merchant name followed by the currency code.)","nullable":true,"example":"Etsy GBP"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the account."},"children":[]}]}]}],"nullable":true,"example":"GBP"},"clearedBalance":{"type":"number","description":"The cleared balance.","format":"double","example":142.5},"unclearedBalance":{"type":"number","description":"The uncleared balance.","format":"double","example":100.8},"balance":{"type":"number","description":"The total balance.","format":"double","example":243.5},"accountStatus":{"type":"string","description":"The status of the account.","nullable":true,"example":"ACTIVE"}},"additionalProperties":false}},"components/schemas/AccountResponse":{"id":"components/schemas/AccountResponse","kind":"json-schema","title":"AccountResponse","data":{"type":"object","properties":{"entity":{"type":"string","description":"Your unique 6-digit ID given to you during the onboarding process.","nullable":true,"example":"111155"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/Account"},"description":"Collection of account details.","nullable":true}},"additionalProperties":false,"description":"The GET account response."}},"components/schemas/BaseErrorResponse":{"id":"components/schemas/BaseErrorResponse","kind":"json-schema","title":"BaseErrorResponse","data":{"type":"object","properties":{"httpStatusCode":{"type":"integer","description":"The HTTP status","format":"int32"},"customCode":{"type":"string","description":"The unique response code for this endpoint.","nullable":true},"message":{"type":"string","description":"The error message.","nullable":true}},"additionalProperties":false,"description":"The error response."}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"httpStatusCode":{"type":"integer","description":"The HTTP status.","format":"int32"},"customCode":{"type":"string","description":"The unique response code for this endpoint.","nullable":true},"message":{"type":"string","description":"The error message.","nullable":true},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"},"nullable":true},"description":"Collection of error details.","nullable":true}},"additionalProperties":false}},"schema_321":{"kind":"json-schema","data":{"type":"string"},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"type":"string","example":"11155"},"id":"schema_322"}},"exampleStore":{"components/examples/400":{"id":"components/examples/400","value":{"httpStatusCode":400,"customCode":"ACCB05","message":"Schema validation failed","errors":{"AccountNumber":["AccountNumber should be 16 digits"]}}},"components/examples/401":{"id":"components/examples/401","value":{"httpStatusCode":401,"customCode":"ACCU06","message":"Unauthorized request"}},"components/examples/403":{"id":"components/examples/403","value":{"httpStatusCode":403,"customCode":"ACCF18","message":"Forbidden","errors":{"Domain":["Authorisation Failed for this Domain"]}}},"components/examples/404":{"id":"components/examples/404","value":{"httpStatusCode":404,"customCode":"ACCN15","message":"Could not find details for accountNumber"}},"components/examples/500":{"id":"components/examples/500","value":{"httpStatusCode":500,"customCode":"ACCE11","message":"Unexpected Issue. Please try again"}},"paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1json/examples/Bad request":{"value":{"httpStatusCode":400,"customCode":"ACCB05","message":"Schema validation failed","errors":{"AccountNumber":["AccountNumber should be 16 digits"]}},"key":"Bad request","summary":"Bad request","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1json/examples/Bad request"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request":{"value":{"httpStatusCode":400,"customCode":"ACCB05","message":"Schema validation failed","errors":{"AccountNumber":["AccountNumber should be 16 digits"]}},"key":"Bad request","summary":"Bad request","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1json/examples/UNAUTHORIZED":{"value":{"httpStatusCode":401,"customCode":"ACCU06","message":"Unauthorized request"},"key":"UNAUTHORIZED","summary":"UNAUTHORIZED","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1json/examples/UNAUTHORIZED"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED":{"value":{"httpStatusCode":401,"customCode":"ACCU06","message":"Unauthorized request"},"key":"UNAUTHORIZED","summary":"UNAUTHORIZED","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1json/examples/FORBIDDEN":{"value":{"httpStatusCode":403,"customCode":"ACCF18","message":"Forbidden","errors":{"Domain":["Authorisation Failed for this Domain"]}},"key":"FORBIDDEN","summary":"FORBIDDEN","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1json/examples/FORBIDDEN"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN":{"value":{"httpStatusCode":403,"customCode":"ACCF18","message":"Forbidden","errors":{"Domain":["Authorisation Failed for this Domain"]}},"key":"FORBIDDEN","summary":"FORBIDDEN","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1json/examples/NOT FOUND":{"value":{"httpStatusCode":404,"customCode":"ACCN15","message":"Could not find details for accountNumber"},"key":"NOT FOUND","summary":"NOT FOUND","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1json/examples/NOT FOUND"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND":{"value":{"httpStatusCode":404,"customCode":"ACCN15","message":"Could not find details for accountNumber"},"key":"NOT FOUND","summary":"NOT FOUND","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1json/examples/Internal server error":{"value":{"httpStatusCode":500,"customCode":"ACCE11","message":"Unexpected Issue. Please try again"},"key":"Internal server error","summary":"Internal server error","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1json/examples/Internal server error"},"paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error":{"value":{"httpStatusCode":500,"customCode":"ACCE11","message":"Unexpected Issue. Please try again"},"key":"Internal server error","summary":"Internal server error","id":"paths/~1accounts~1balance~1{accountNumber}/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error"},"paths/~1accounts~1balance/get/responses/400/content/application~1json/examples/Bad request":{"value":{"httpStatusCode":400,"customCode":"ACCB05","message":"Schema validation failed","errors":{"AccountNumber":["AccountNumber should be 16 digits"]}},"key":"Bad request","summary":"Bad request","id":"paths/~1accounts~1balance/get/responses/400/content/application~1json/examples/Bad request"},"paths/~1accounts~1balance/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request":{"value":{"httpStatusCode":400,"customCode":"ACCB05","message":"Schema validation failed","errors":{"AccountNumber":["AccountNumber should be 16 digits"]}},"key":"Bad request","summary":"Bad request","id":"paths/~1accounts~1balance/get/responses/400/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Bad request"},"paths/~1accounts~1balance/get/responses/401/content/application~1json/examples/UNAUTHORIZED":{"value":{"httpStatusCode":401,"customCode":"ACCU06","message":"Unauthorized request"},"key":"UNAUTHORIZED","summary":"UNAUTHORIZED","id":"paths/~1accounts~1balance/get/responses/401/content/application~1json/examples/UNAUTHORIZED"},"paths/~1accounts~1balance/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED":{"value":{"httpStatusCode":401,"customCode":"ACCU06","message":"Unauthorized request"},"key":"UNAUTHORIZED","summary":"UNAUTHORIZED","id":"paths/~1accounts~1balance/get/responses/401/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/UNAUTHORIZED"},"paths/~1accounts~1balance/get/responses/403/content/application~1json/examples/FORBIDDEN":{"value":{"httpStatusCode":403,"customCode":"ACCF18","message":"Forbidden","errors":{"Domain":["Authorisation Failed for this Domain"]}},"key":"FORBIDDEN","summary":"FORBIDDEN","id":"paths/~1accounts~1balance/get/responses/403/content/application~1json/examples/FORBIDDEN"},"paths/~1accounts~1balance/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN":{"value":{"httpStatusCode":403,"customCode":"ACCF18","message":"Forbidden","errors":{"Domain":["Authorisation Failed for this Domain"]}},"key":"FORBIDDEN","summary":"FORBIDDEN","id":"paths/~1accounts~1balance/get/responses/403/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/FORBIDDEN"},"paths/~1accounts~1balance/get/responses/404/content/application~1json/examples/NOT FOUND":{"value":{"httpStatusCode":404,"customCode":"ACCN15","message":"Could not find details for accountNumber"},"key":"NOT FOUND","summary":"NOT FOUND","id":"paths/~1accounts~1balance/get/responses/404/content/application~1json/examples/NOT FOUND"},"paths/~1accounts~1balance/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND":{"value":{"httpStatusCode":404,"customCode":"ACCN15","message":"Could not find details for accountNumber"},"key":"NOT FOUND","summary":"NOT FOUND","id":"paths/~1accounts~1balance/get/responses/404/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/NOT FOUND"},"paths/~1accounts~1balance/get/responses/500/content/application~1json/examples/Internal server error":{"value":{"httpStatusCode":500,"customCode":"ACCE11","message":"Unexpected Issue. Please try again"},"key":"Internal server error","summary":"Internal server error","id":"paths/~1accounts~1balance/get/responses/500/content/application~1json/examples/Internal server error"},"paths/~1accounts~1balance/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error":{"value":{"httpStatusCode":500,"customCode":"ACCE11","message":"Unexpected Issue. Please try again"},"key":"Internal server error","summary":"Internal server error","id":"paths/~1accounts~1balance/get/responses/500/content/application~1vnd.worldpay.accounts.balance-v1+json/examples/Internal server error"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/balance/@v1/openapi.json?download"},{"url":"/access/_bundle/products/balance/@v1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Balances","description":"Request your account details for a single account or all accounts under an entity.\n\n__Authentication header__\n  ```\n    Authorization: {your_credentials}\n  ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\n<br /> <br />\n\nYou **must** use the `Authorization` header for any request you send to our Balances API.\n\n__Accept header__\n  ```\n    Accept: application/vnd.worldpay.accounts.balance-v1+json\n  ```\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Balances API.\n<br /><br />\n\n\n__DNS whitelisting__  \nWhitelist the following URLs:\n* `https://try.access.worldpay-bsh.securedataplatform.co.uk/`\n* `https://access.worldpay-bsh.securedataplatform.co.uk/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting."}},"baseSlug":"/products/balance/v1/openapi","routesMapping":{}}