{"items":[{"type":"link","label":"Balances","link":"/products/balance/openapi","routeSlug":"/products/balance/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/@20250101/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/balance/@20250101/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.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Balances (2025-01-01)","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":"Get accounts data."},"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":"softbreak","inline":true,"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":"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WP-Api-Version Header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  WP-Api-Version: 2025-01-01\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  WP-Api-Version: 2025-01-01\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 WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send."},"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":"softbreak","inline":true,"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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.com/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay.com/"},"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. When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/balance/openapi"}],"sectionId":"/products/balance/openapi"}]}]}},{"label":"Get account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/balance/openapi/other/receivetransferrequestforaccount","routeSlug":"/products/balance/openapi/other/receivetransferrequestforaccount","metadata":{"seo":{"title":"Get account details","description":"Retrieve the details of one specific account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ReceiveTransferRequestForAccount","name":"Get account details","isWebhook":false,"pointer":"/paths/~1accounts~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_314","description":"The account number.","required":true}],"pointer":"/paths/~1accounts~1{accountNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_314","description":"Represents the version of the API.","required":true,"example":"2025-01-01"},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_314","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"},{"name":"Accept","in":"header","schemaId":"schema_314","example":"application/json"}],"pointer":"/paths/~1accounts~1{accountNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{accountNumber}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"accountNumber","in":"path","required":true,"schemaId":"schema_314"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_314"},{"name":"WP-CorrelationId","in":"header","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_314"},{"name":"Accept","in":"header","example":"application/json","schemaId":"schema_314"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/accounts/{accountNumber}","href":"other/receivetransferrequestforaccount","openApiOperationId":"ReceiveTransferRequestForAccount","summary":"Get account details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","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"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AccountResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"BAD REQUEST response if the request is incorrectly validated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"UNAUTHORIZED response if JWT is not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"FORBIDDEN response if you are not authorized to access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/403/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{accountNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/403/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts~1{accountNumber}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/receivetransferrequestforaccount"}],"panels":[]}]},"httpPath":"/accounts/{accountNumber}"},{"label":"Get details for all your accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/balance/openapi/other/receivetransferrequest","routeSlug":"/products/balance/openapi/other/receivetransferrequest","metadata":{"seo":{"title":"Get details for all your accounts","description":"Retrieve account details for all your accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ReceiveTransferRequest","name":"Get details for all your accounts","isWebhook":false,"pointer":"/paths/~1accounts/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_315","description":"Unique ID given during the on-boarding process.","required":true},{"name":"currency","in":"query","schemaId":"schema_316","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":[]}]}]}]},{"name":"partyReference","in":"query","schemaId":"schema_317","description":"Your reference for this party, must be unique within an entity. Allowed values string 3 to 64 characters a-z, A-Z, 0-9, spaces and hyphens."},{"name":"status","in":"query","schemaId":"schema_318","description":"Get accounts on the bases of account status. "},{"name":"pageNumber","in":"query","schemaId":"schema_319","description":"Positive whole number indicating which page of the account to return."},{"name":"pageSize","in":"query","schemaId":"schema_320","description":"Positive whole number indicating the number of account to return in each page."}],"pointer":"/paths/~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_314","description":"Represents the version of the API.","required":true,"example":"2025-01-01"},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_314","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"},{"name":"Accept","in":"header","schemaId":"schema_314","example":"application/json"}],"pointer":"/paths/~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[{"name":"entity","in":"query","required":true,"schemaId":"schema_315"},{"name":"currency","in":"query","schemaId":"schema_316"},{"name":"partyReference","in":"query","schemaId":"schema_317"},{"name":"status","in":"query","example":"Active/Inactive","schemaId":"schema_318"},{"name":"pageNumber","in":"query","schemaId":"schema_319"},{"name":"pageSize","in":"query","schemaId":"schema_320"}],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_314"},{"name":"WP-CorrelationId","in":"header","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_314"},{"name":"Accept","in":"header","example":"application/json","schemaId":"schema_314"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/accounts","href":"other/receivetransferrequest","openApiOperationId":"ReceiveTransferRequest","summary":"Get details for all your accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","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"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountByEntityResponse","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AccountByEntityResponse","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]},{"code":"400","description":"BAD REQUEST response if the request is incorrectly validated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"]},{"code":"401","description":"UNAUTHORIZED response if JWT is not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"]},{"code":"403","description":"FORBIDDEN response if you are not authorized to access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/403/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountByEntityResponse","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountByEntityResponse","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/403/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseAccessErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/receivetransferrequest"}],"panels":[]}]},"httpPath":"/accounts"}],"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},"accountName":{"type":"string","description":"Name of the account given to you as part of on-boarding.","nullable":true},"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},"clearedBalance":{"type":"number","description":"The cleared balance.","format":"double"},"unclearedBalance":{"type":"number","description":"The uncleared balance.","format":"double"},"balance":{"type":"number","description":"The total balance.","format":"double"},"accountStatus":{"type":"string","description":"The status of the account.","nullable":true}},"additionalProperties":false}},"components/schemas/AccountByEntityResponse":{"id":"components/schemas/AccountByEntityResponse","kind":"json-schema","title":"AccountByEntityResponse","data":{"type":"object","properties":{"entity":{"type":"string","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/Account"},"nullable":true},"pagination":{"$ref":"#/components/schemas/PageInformation"}},"additionalProperties":false}},"components/schemas/AccountResponse":{"id":"components/schemas/AccountResponse","kind":"json-schema","title":"AccountResponse","data":{"type":"object","properties":{"entity":{"type":"string","description":"Unique ID given during the on-boarding process.","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/Account"},"description":"Collection of the account details","nullable":true}},"additionalProperties":false,"description":"The Get Account response"}},"components/schemas/AwQueryParameterErrorModel":{"id":"components/schemas/AwQueryParameterErrorModel","kind":"json-schema","title":"AwQueryParameterErrorModel","data":{"type":"object","properties":{"errorName":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"queryParameter":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/BaseAccessErrorResponse":{"id":"components/schemas/BaseAccessErrorResponse","kind":"json-schema","title":"BaseAccessErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string","description":"Unique response code","nullable":true},"message":{"type":"string","description":"Error message","nullable":true},"headerName":{"type":"string","description":"Header Name","nullable":true}},"additionalProperties":false}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string","description":"Unique response code","nullable":true},"message":{"type":"string","description":"Error message","nullable":true},"headerName":{"type":"string","description":"Header Name","nullable":true},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/AwQueryParameterErrorModel"},"description":"Collection of error details","nullable":true}},"additionalProperties":false}},"components/schemas/PageInformation":{"id":"components/schemas/PageInformation","kind":"json-schema","title":"PageInformation","data":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"recordsPerPage":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"totalNumberOfRecords":{"type":"integer","format":"int32"}},"additionalProperties":false}},"schema_314":{"kind":"json-schema","data":{"type":"string"},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"maxLength":32,"minLength":1,"pattern":"^[a-zA-Z\\s-]{1,32}$","type":"string","description":"Unique ID given during the on-boarding process."},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"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":[]}]}]}]},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"type":"string","description":"Your reference for this party, must be unique within an entity. Allowed values string 3 to 64 characters a-z, A-Z, 0-9, spaces and hyphens."},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"string","description":"Get accounts on the bases of account status. ","example":"Active/Inactive"},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Positive whole number indicating which page of the account to return.","format":"int32"},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"type":"integer","description":"Positive whole number indicating the number of account to return in each page.","format":"int32"},"id":"schema_320"}},"exampleStore":{"paths/~1accounts~1{accountNumber}/get/responses/200/content/application~1json/example":{"value":{"entity":"Test","accounts":[{"accountNumber":"01012145214562214","accountName":"TestDisplayName","currency":"GBP","clearedBalance":36,"unclearedBalance":2,"balance":38,"accountStatus":"Active"}]},"id":"paths/~1accounts~1{accountNumber}/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{accountNumber}/get/responses/400/content/application~1json/example":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"accountNumber must contain 16 characters","queryParameter":"accountNumber"},{"errorName":"fieldIsNull","message":"accountNumber is mandatory","queryParameter":"accountNumber"}]},"id":"paths/~1accounts~1{accountNumber}/get/responses/400/content/application~1json/example"},"paths/~1accounts~1{accountNumber}/get/responses/401/content/application~1json/example":{"value":{"errorName":"unauthorized","message":"Invalid token"},"id":"paths/~1accounts~1{accountNumber}/get/responses/401/content/application~1json/example"},"paths/~1accounts~1{accountNumber}/get/responses/403/content/application~1json/example":{"value":{"errorName":"entityIsNotConfigured","message":"Provided Identity is not valid"},"id":"paths/~1accounts~1{accountNumber}/get/responses/403/content/application~1json/example"},"paths/~1accounts~1{accountNumber}/get/responses/500/content/application~1json/example":{"value":{"errorName":"entityIsNotConfigured","message":"Unexpected issue occured"},"id":"paths/~1accounts~1{accountNumber}/get/responses/500/content/application~1json/example"},"paths/~1accounts/get/responses/200/content/application~1json/example":{"value":{"entity":"Test","accounts":[{"accountNumber":"01012145214562214","accountName":"TestDisplayName","currency":"GBP","clearedBalance":36,"unclearedBalance":2,"balance":38,"accountStatus":"Active"}],"pagination":{"pageNumber":1,"recordsPerPage":10,"totalPages":1,"totalNumberOfRecords":1}},"id":"paths/~1accounts/get/responses/200/content/application~1json/example"},"paths/~1accounts/get/responses/400/content/application~1json/example":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"entity must contain 32 characters","queryParameter":"Entity"},{"errorName":"fieldHasInvalidValue","message":"status is invalid","queryParameter":"Status"}]},"id":"paths/~1accounts/get/responses/400/content/application~1json/example"},"paths/~1accounts/get/responses/401/content/application~1json/example":{"value":{"errorName":"unauthorized","message":"Invalid token"},"id":"paths/~1accounts/get/responses/401/content/application~1json/example"},"paths/~1accounts/get/responses/403/content/application~1json/example":{"value":{"errorName":"entityIsNotConfigured","message":"Provided Identity is not valid"},"id":"paths/~1accounts/get/responses/403/content/application~1json/example"},"paths/~1accounts/get/responses/500/content/application~1json/example":{"value":{"errorName":"entityIsNotConfigured","message":"Unexpected issue occured"},"id":"paths/~1accounts/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","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/@20250101/openapi.json?download"},{"url":"/access/_bundle/products/balance/@20250101/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Balances","description":"Get accounts data. \r\n  \r\n    __Authentication header__\r\n\r\n      ```\r\n        Authorization: {your_credentials}\r\n      ```\r\n      Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\r\n      <br /> <br />\r\n      You **must** use the `Authorization` header for any request you send to our Balances API.\r\n      <br /><br />\r\n      __WP-Api-Version Header__\r\n      ```\r\n        WP-Api-Version: 2025-01-01\r\n      ```\r\n\r\n    We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send.\r\n    <br /><br />\r\n    __DNS whitelisting__\r\n\r\n    Whitelist the following URLs:\r\n    * `https://try.access.worldpay.com/`\r\n    * `https://access.worldpay.com/`\r\n\r\n    Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Accounts"],"generated":true}},"baseSlug":"/products/balance/openapi","routesMapping":{}}