{"items":[{"type":"link","label":"Card BIN Data","link":"/products/card-bin/v1/openapi","routeSlug":"/products/card-bin/v1/openapi","content":{"contentType":"overview","meta":{"name":"Card BIN Data"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/card-bin/@v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/card-bin/@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/api","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/api","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Card BIN Data (1)","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":"Retrieve detailed information about a card."},"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":"Header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 1\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 1\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":"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 Card BIN Data API. "},"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":"text","inline":true,"attributes":{"content":"   "},"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-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":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/card-bin/v1/openapi"}],"sectionId":"/products/card-bin/v1/openapi"}]}]}},{"label":"Get BIN data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-bin/v1/openapi/other/panlookup","routeSlug":"/products/card-bin/v1/openapi/other/panlookup","metadata":{"seo":{"title":"Get BIN data","description":"Returns card BIN data for the card number or Worldpay token supplied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"panlookup","name":"Get BIN data","deprecated":false,"isWebhook":false,"pointer":"/paths/~1cardBin~1panLookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get BIN data","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns card BIN data for the card number or Worldpay token supplied."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_323","description":"The API version.","required":true,"example":1}],"pointer":"/paths/~1cardBin~1panLookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/token"]}},"schemaId":"components/schemas/request","exampleIds":["paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/token"],"pointer":"/paths/~1cardBin~1panLookup/post/requestBody","description":"Lookup details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cardBin/panLookup","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/api","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/api","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":1,"schemaId":"schema_323","style":"simple"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/token"]}},"responseCodes":["200","400","401","404","415","500"],"pointer":"/cardBin/panLookup","href":"other/panlookup","openApiOperationId":"panlookup","summary":"Get BIN data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/api","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/api","description":"Live"}],"schemaId":"components/schemas/request","exampleIds":["paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/token"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/token"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"]}},"schemaId":"components/schemas/response","exampleIds":["paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"],"headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"The complete API Version is returned in the WP-Api-Version HPP Header. It contains the Major, Minor and Patch details of API Version.","example":"1.1.20240411"}},"headerSchemaId":"schema_324"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325","exampleIds":["paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"]}},"schemaId":"schema_325","exampleIds":["paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"],"headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"The complete API Version is returned in the WP-Api-Version HPP Header. It contains the Major, Minor and Patch details of API Version.","example":"1.1.20240411"}},"headerSchemaId":"schema_324"},{"code":"401","description":"Client is not authorized due to missing or invalid Authorization header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}},"schemaId":"schema_326","headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"}},"headerSchemaId":"schema_327"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328","exampleIds":["paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"]}},"schemaId":"schema_328","exampleIds":["paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"],"headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"The complete API Version is returned in the WP-Api-Version HPP Header. It contains the Major, Minor and Patch details of API Version.","example":"1.1.20240411"}},"headerSchemaId":"schema_324"},{"code":"415","description":"Invalid content-type HTTP header","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329","headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"The complete API Version is returned in the WP-Api-Version HPP Header. It contains the Major, Minor and Patch details of API Version.","example":"1.1.20240411"}},"headerSchemaId":"schema_324"},{"code":"500","description":"An error occurred processing the request on our side.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330"}},"schemaId":"schema_330","headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"The complete API Version is returned in the WP-Api-Version HPP Header. It contains the Major, Minor and Patch details of API Version.","example":"1.1.20240411"}},"headerSchemaId":"schema_324"}],"pointer":"/paths/~1cardBin~1panLookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/response","exampleIds":["paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"]}}},{"code":"400","schemaId":"schema_325","exampleIds":["paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325","exampleIds":["paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"]}}},{"code":"401","schemaId":"schema_326","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}}},{"code":"404","schemaId":"schema_328","exampleIds":["paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328","exampleIds":["paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"]}}},{"code":"415","schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}}},{"code":"500","schemaId":"schema_330","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/panlookup"}],"panels":[]}]},"httpPath":"/cardBin/panLookup"}],"store":{"schemaStore":{"components/schemas/cardNumber":{"id":"components/schemas/cardNumber","kind":"json-schema","title":"cardNumber","data":{"type":"object","title":"cardNumber","properties":{"merchant":{"$ref":"#/components/schemas/merchant"},"cardNumber":{"type":"string","description":"Primary Account Number (PAN) and Network Token Number are accepted.","example":"4444333322221111","pattern":"^\\d{12,19}$"}},"required":["merchant","cardNumber"]}},"components/schemas/token":{"id":"components/schemas/token","kind":"json-schema","title":"token","data":{"type":"object","title":"token","properties":{"merchant":{"$ref":"#/components/schemas/merchant"},"token":{"type":"string","description":"Worldpay token href","example":"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"}},"required":["merchant","token"]}},"components/schemas/entity":{"id":"components/schemas/entity","kind":"json-schema","title":"entity","data":{"type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding.","example":"default","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]*$"}},"components/schemas/merchant":{"id":"components/schemas/merchant","kind":"json-schema","title":"merchant","data":{"type":"object","description":"An object that contains information about the merchant.","properties":{"entity":{"$ref":"#/components/schemas/entity"}},"required":["entity"]}},"components/schemas/request":{"id":"components/schemas/request","kind":"json-schema","title":"request","data":{"type":"object","description":"Lookup details.","oneOf":[{"$ref":"#/components/schemas/cardNumber"},{"$ref":"#/components/schemas/token"}]}},"components/schemas/response":{"id":"components/schemas/response","kind":"json-schema","title":"response","data":{"type":"object","description":"Successful response with BIN details.","properties":{"type":{"type":"string","enum":["pan","networkToken"],"description":"The type of account number provided.","example":"pan"},"brand":{"type":"array","items":{"type":"string","enum":["accel","affn","airplus","allstar","amex","argencard","ath","aurore","bc","cabal","carnet","cartesBancaires","cencosud","coopeplus","credimas","culiance","dankort","diners","discover","eftposAU","elo","gecapital","hana","hipercard","hyundai","ikea","interac","interlink","italcred","jaywan","jcb","jeanie","keyfuels","kookmin","lotte","maestro","mastercard","naranja","nativa","ncp","nevada","newday","nexo","nonghyup","nyce","overdrive","pavd","pulse","samsung","sears","shazam","shinhan","sorocred","star","starAccess","supercharge","tarjeta","troy","uatp","unionPay","visa"]},"example":["visa"],"description":"Brand of the card. For co-branded cards multiple brands are returned."},"bin":{"type":"string","description":"Bank Identification Number.","example":"444422"},"binLength":{"type":"integer","description":"Length of the BIN.","example":6},"fundingType":{"type":"string","enum":["credit","debit","prepaid","chargeCard","deferredDebit","unknown"],"description":"Funding source of the card.","example":"credit"},"issuerName":{"type":"string","description":"Card issuer name.","example":"Bank of America"},"countryCode":{"type":"string","description":"Card issuer country in ISO alpha-2 format or unknown.","example":"US"},"currency":{"type":"string","description":"Currency of the card in ISO alpha-3 format.","example":"USD"},"dccAllowed":{"type":"boolean","description":"Sets whether Dynamic Currency Conversion (DCC) is permitted.","example":true},"anonymousPrepaid":{"type":"string","enum":["anonymousNonCompliant","anonymousCompliant","notPrepaidOrNonAnonymous","unknown"],"description":"Anonymous prepaid program and AMLD5 compliance.","example":"notPrepaidOrNonAnonymous"},"category":{"type":"string","enum":["commercial","consumer"],"description":"The card category.","example":"consumer"},"multipleAccountAccess":{"type":"string","enum":["managed","selfServe","notParticipating","notSupported"],"description":"Participation in Visa multiple-account access. Managed cardholder choices are stored with Visa and self-serve with the issuer.","example":"managed"}}}},"components/schemas/validationError":{"id":"components/schemas/validationError","kind":"json-schema","title":"validationError","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":"A machine and human readable error type for clarity and semantic understanding of the error.","enum":["fieldIsMissing","fieldMustBeString","fieldMustBeNumber","fieldMustBeInteger","fieldMustBeBoolean","fieldMustBeObject","fieldMustBeArray","fieldIsNull","fieldIsEmpty","fieldHasInvalidValue","fieldIsNotAllowed","numberIsTooSmall","integerIsTooLarge","stringIsTooShort","stringIsTooLong","stringFailedRegexCheck","panFailedLuhnCheck","dateHasInvalidFormat"],"example":"fieldIsNotAllowed"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Field at path is not allowed."},"jsonPath":{"type":"string","description":"This field represents the JSON path of the element within the request body associated with the error.","example":"$.transactionRef"}}}},"schema_323":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"type":"object","properties":{"WP-CorrelationId":{"type":"string","description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"type":"string","description":"The complete API Version is returned in the WP-Api-Version HPP Header. It contains the Major, Minor and Patch details of API Version.","example":"1.1.20240411"}}},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"title":"error400","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["internalErrorOccurred","headerIsMissing","headerHasInvalidValue","bodyIsEmpty","bodyIsNotJson","bodyDoesNotMatchSchema"],"description":"A machine and human readable error type for clarity and semantic understanding of the error.","example":"bodyDoesNotMatchSchema"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"A JSON body matching the expected schema must be provided."},"validationErrors":{"type":"array","description":"If there were field validation errors, they will be collected in this array.","items":{"$ref":"#/components/schemas/validationError"}},"headerName":{"type":"string","description":"If the header is missing or does not contain an expected value, this field will be populated with the incorrect header name.","example":"Content-Type"}}},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"title":"error401","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":"A machine and human readable error type for clarity and semantic understanding of the error.","example":"accessDenied"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Access to the requested resource has been denied"}}},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"object","properties":{"WP-CorrelationId":{"type":"string","description":"Generated identifier for the request and response. When contacting support please include this.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"title":"error404","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["tokenNotFound","cardNotFound"],"description":"A machine and human readable error type for clarity and semantic understanding of the error.","example":"cardNotFound"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"The card number cannot be found in any BIN ranges."}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"title":"error415","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":"A machine and human readable error type for clarity and semantic understanding of the error.","example":"headerHasInvalidValue"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"A valid header must be provided."},"headerName":{"type":"string","description":"If the header is missing or does not contain an expected value, this field will be populated with the incorrect header name.","example":"Content-Type"}}},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"title":"error500","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["internalServerError"],"description":"A machine and human readable error type for clarity and semantic understanding of the error.","example":"internalServerError"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"An internal server error occurred"}}},"id":"schema_330"}},"exampleStore":{"components/examples/cardRequest":{"id":"components/examples/cardRequest","value":{"merchant":{"entity":"default"},"cardNumber":"4444333322221111"}},"components/examples/tokenRequest":{"id":"components/examples/tokenRequest","value":{"merchant":{"entity":"default"},"token":"https://access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"}},"components/examples/response":{"id":"components/examples/response","value":{"type":"pan","brand":["visa"],"bin":"444433","binLength":6,"fundingType":"debit","issuerName":"Bank of America","countryCode":"US","currency":"USD","dccAllowed":true,"anonymousPrepaid":"notPrepaidOrNonAnonymous","category":"consumer","multipleAccountAccess":"managed"}},"components/examples/validationError":{"id":"components/examples/validationError","value":{"errorName":"bodyDoesNotMatchSchema","message":"A JSON body matching the expected schema must be provided.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"Field at path is not allowed.","jsonPath":"$.transactionRef"}]}},"components/examples/headerError":{"id":"components/examples/headerError","value":{"errorName":"headerIsMissing","message":"A valid header must be provided.","headerName":"Content-Type"}},"components/examples/cardNotFound":{"id":"components/examples/cardNotFound","value":{"errorName":"cardNotFound","message":"The card number cannot be found in any BIN ranges."}},"components/examples/tokenNotFound":{"id":"components/examples/tokenNotFound","value":{"errorName":"tokenNotFound","message":"Token not found"}},"paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber":{"value":{"merchant":{"entity":"default"},"cardNumber":"4444333322221111"},"key":"cardNumber","summary":"cardNumber","id":"paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber"},"paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/token":{"value":{"merchant":{"entity":"default"},"token":"https://access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"},"key":"token","summary":"token","id":"paths/~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/token"},"paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber":{"value":{"type":"pan","brand":["visa"],"bin":"444433","binLength":6,"fundingType":"debit","issuerName":"Bank of America","countryCode":"US","currency":"USD","dccAllowed":true,"anonymousPrepaid":"notPrepaidOrNonAnonymous","category":"consumer","multipleAccountAccess":"managed"},"key":"cardNumber","summary":"cardNumber","id":"paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber"},"paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token":{"value":{"type":"pan","brand":["visa"],"bin":"444433","binLength":6,"fundingType":"debit","issuerName":"Bank of America","countryCode":"US","currency":"USD","dccAllowed":true,"anonymousPrepaid":"notPrepaidOrNonAnonymous","category":"consumer","multipleAccountAccess":"managed"},"key":"token","summary":"token","id":"paths/~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"},"paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"A JSON body matching the expected schema must be provided.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"Field at path is not allowed.","jsonPath":"$.transactionRef"}]},"key":"Validation Error","summary":"Validation Error","id":"paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error"},"paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error":{"value":{"errorName":"headerIsMissing","message":"A valid header must be provided.","headerName":"Content-Type"},"key":"Header Error","summary":"Header Error","id":"paths/~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"},"paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found":{"value":{"errorName":"tokenNotFound","message":"Token not found"},"key":"Token Not Found","summary":"Token Not Found","id":"paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found"},"paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found":{"value":{"errorName":"cardNotFound","message":"The card number cannot be found in any BIN ranges."},"key":"Card Not Found","summary":"Card Not Found","id":"paths/~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/api","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/api","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/card-bin/@v1/openapi.json?download"},{"url":"/access/_bundle/products/card-bin/@v1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Card BIN Data","description":"Retrieve detailed information about a card.\n\n\n  __Header__\n```\n    Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 1\n```\n    Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\n    <br><br>\n  You **must** use the `Authorization` header for any request you send to our Card BIN Data API. <br /><br />   __DNS whitelisting__\n\n    Whitelist the following URLs:\n    * `https://try.access.worldpay-bsh.securedataplatform.co.uk/`\n    * `https://access.worldpay-bsh.securedataplatform.co.uk/`\n\n    Please ensure you use DNS whitelisting, not explicit IP whitelisting.\n    When you make a request within Access Worldpay, you should always cache the response returned.\n ","category":["Card BIN"],"business":["Enterprise"],"catalog-list":true,"generated":false}},"baseSlug":"/products/card-bin/v1/openapi","routesMapping":{}}