{"items":[{"type":"link","label":"Card BIN Data","link":"/products/card-bin/openapi","routeSlug":"/products/card-bin/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/@v2/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/card-bin/@v2/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) - use for integration and QA"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live - use for production traffic"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Card BIN Data (2)","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":"Lookup card metadata from a Primary Account Number (PAN), Network Token Number, or Worldpay token href."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns: card brand(s), BIN and BIN length, PAN length, funding type, issuer name, issuer country (ISO alpha-2), default currency (ISO alpha-3), DCC eligibility, anonymous prepaid / AMLD5 compliance status, card category (consumer or commercial), product ID, product subtype, flexible credential participation including the Visa deployment model and account funding transactions support for domestic and cross-border. "},"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":"Set your headers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Authorization: {your_credentials}\n  Content-Type: application/json\n  WP-Api-Version: 2\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Authorization: {your_credentials}\n  Content-Type: application/json\n  WP-Api-Version: 2\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:password given to you by your Worldpay Implementation Manager. "},"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":" We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"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 this header for any request you send to our Card BIN 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":"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":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Whitelist the following URLs:"},"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":"code","inline":true,"attributes":{"content":"https://try.access.worldpay-bsh.securedataplatform.co.uk/"},"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":"code","inline":true,"attributes":{"content":"https://access.worldpay-bsh.securedataplatform.co.uk/"},"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":"Please ensure you use DNS whitelisting, not explicit IP whitelisting."},"children":[]}]}]}]}],"sectionId":"/products/card-bin/openapi"}],"sectionId":"/products/card-bin/openapi"}]}]}},{"type":"group","label":"Card Lookup","link":"/products/card-bin/openapi/card-lookup","routeSlug":"/products/card-bin/openapi/card-lookup","items":[{"label":"Lookup BIN data using a card number or Worldpay token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-bin/openapi/card-lookup/getcardbindata","routeSlug":"/products/card-bin/openapi/card-lookup/getcardbindata","metadata":{"seo":{"title":"Lookup BIN data using a card number or Worldpay token","description":"Returns card metadata for the supplied payment instrument. This is a read-only lookup with no side effects - safe to retry on network errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCardBinData","name":"Lookup BIN data using a card number or Worldpay token","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1cardBin~1panLookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup BIN data using a card number or Worldpay token","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 metadata for the supplied payment instrument. This is a read-only lookup with no side effects - safe to retry on network errors."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encode your username:password (issued by Worldpay) and send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_331","description":"API major version number. Must be 2.","required":true,"example":2}],"pointer":"/paths/~1api~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/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/tokenHref"]}},"schemaId":"components/schemas/request","exampleIds":["paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/tokenHref"],"pointer":"/paths/~1api~1cardBin~1panLookup/post/requestBody","description":"Provide a paymentInstrument with type card (PAN or Network Token Number, 12-19 digits) or type token (Worldpay token href). The merchant.entity field identifies your routing entity; use the value assigned during on-boarding."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/cardBin/panLookup","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try) - use for integration and QA"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live - use for production traffic"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":2,"schemaId":"schema_331","style":"simple"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/tokenHref"]}},"responseCodes":["200","400","401","404","415","500"],"pointer":"/api/cardBin/panLookup","href":"card-lookup/getcardbindata","openApiOperationId":"getCardBinData","summary":"Lookup BIN data using a card number or Worldpay token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try) - use for integration and QA"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live - use for production traffic"}],"schemaId":"components/schemas/request","exampleIds":["paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/tokenHref"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/tokenHref"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"BIN lookup succeeded. Response contains card metadata including brand, BIN and BIN length, PAN length, funding type, issuer details, DCC eligibility, AMLD5 status, card category, scheme product ID and sub-type, flexible credential participation, Visa Direct Account Funding Transaction eligibility and Visa (Direct) and Mastercard (Send) payout support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"]}},"schemaId":"components/schemas/response","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"],"headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Unique request/response correlation ID. Include in support tickets when reporting issues.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}},"headerSchemaId":"schema_332"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request. The request body or a required header is invalid. Inspect "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validationErrors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify the specific problem, fix the request, and retry. Do NOT retry without fixing the issue first."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"]}},"schemaId":"schema_333","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"],"headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Correlation ID for support.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}},"headerSchemaId":"schema_334"},{"code":"401","description":"Unauthorized. The Authorization header is missing or contains invalid credentials. Do not retry automatically. Verify credentials and re-authenticate.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Correlation ID for support.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"}},"headerSchemaId":"schema_336"},{"code":"404","description":"Not found. The supplied card number or token does not match any known BIN range or token record. Do not retry. Surface the error to the caller; the input data may be invalid or unsupported.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"]}},"schemaId":"schema_337","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"],"headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Correlation ID for support.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}},"headerSchemaId":"schema_334"},{"code":"415","description":"Unsupported Media Type. Set Content-Type to application/json and retry immediately.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338","headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Correlation ID for support.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}},"headerSchemaId":"schema_334"},{"code":"500","description":"Internal server error. The problem is on Worldpay's side. Retry with exponential back-off. If errors persist, contact support and provide WP-CorrelationId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339","headers":{"WP-CorrelationId":{"schema":{"type":"string"},"description":"Correlation ID - include in all support tickets.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"schema":{"type":"string"},"description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}},"headerSchemaId":"schema_340"}],"pointer":"/paths/~1api~1cardBin~1panLookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/response","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber","paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"]}}},{"code":"400","schemaId":"schema_333","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error","paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"]}}},{"code":"401","schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}}},{"code":"404","schemaId":"schema_337","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found","paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"]}}},{"code":"415","schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}}},{"code":"500","schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-lookup/getcardbindata"}],"panels":[]}]},"httpPath":"/api/cardBin/panLookup"}],"content":{"contentType":"group","meta":{"name":"Card Lookup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Lookup","showPageActions":true},{"nodeType":"markdoc","content":"Lookup card metadata by PAN, Network Token Number, or Worldpay token."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/cardBin/panLookup","summary":"Lookup BIN data using a card number or Worldpay token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-lookup/getcardbindata","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/paymentInstrument":{"id":"components/schemas/paymentInstrument","kind":"json-schema","title":"paymentInstrument","data":{"type":"object","description":"Use the card variant when you have a raw PAN or Network Token Number. Use the token variant when you have a Worldpay token href.","discriminator":{"propertyName":"type","mapping":{"card":"#/components/schemas/cardInstrument","token":"#/components/schemas/tokenInstrument"}},"oneOf":[{"$ref":"#/components/schemas/cardInstrument"},{"$ref":"#/components/schemas/tokenInstrument"}]}},"components/schemas/cardInstrument":{"id":"components/schemas/cardInstrument","kind":"json-schema","title":"cardInstrument","data":{"type":"object","description":"Worldpay card lookup. Provide a Primary Account Number (PAN) or Network Token Number.","required":["type","number"],"properties":{"type":{"type":"string","description":"Discriminator value identifying this as a card number lookup.","enum":["card"]},"number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Account Number (PAN) or Network Token Number. Must be 12–19 digits. Do not include spaces or dashes."},"children":[]}]}]}],"example":"4444333322221111","minLength":12,"maxLength":19,"pattern":"^\\d+$"}}}},"components/schemas/tokenInstrument":{"id":"components/schemas/tokenInstrument","kind":"json-schema","title":"tokenInstrument","data":{"type":"object","description":"Worldpay token lookup. Provide the token href URL returned when the token was originally created.","required":["type"],"properties":{"type":{"type":"string","description":"Discriminator value identifying this as a token lookup.","enum":["token"]},"href":{"type":"string","format":"uri","description":"Full Worldpay token href URL, as returned when the token was created. Begins with https://.../tokens/.","example":"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"}}}},"components/schemas/request":{"id":"components/schemas/request","kind":"json-schema","title":"request","data":{"type":"object","required":["merchant","paymentInstrument"],"properties":{"merchant":{"type":"object","description":"Identifies the merchant entity for request routing. The entity value is assigned during on-boarding.","required":["entity"],"properties":{"entity":{"type":"string","description":"Merchant routing entity name assigned during on-boarding. Supports alphanumeric characters and the following special characters: space (not leading or trailing), hyphen, underscore, and common punctuation.","example":"default","minLength":1,"maxLength":64,"pattern":"^(?! )[ \\-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`\\/+]*(?<! )$"}}},"paymentInstrument":{"$ref":"#/components/schemas/paymentInstrument"}}}},"components/schemas/brand":{"id":"components/schemas/brand","kind":"json-schema","title":"brand","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card brand(s). Co-branded cards return multiple values."},"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":" This list may grow as new schemes are added. Treat unrecognised values as valid strings and handle them gracefully rather than failing."},"children":[]}]}]}],"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"]}},"components/schemas/fundingType":{"id":"components/schemas/fundingType","kind":"json-schema","title":"fundingType","data":{"type":"string","enum":["credit","debit","prepaid","chargeCard","deferredDebit"],"description":"Funding source of the card. Use to select the correct interchange category, apply surcharging rules, or restrict card acceptance by type.","example":"credit"}},"components/schemas/payouts":{"id":"components/schemas/payouts","kind":"json-schema","title":"payouts","data":{"type":"object","description":"Supported payout capabilities for Visa and Mastercard. This object is omitted when payout information is not applicable to the scheme or when capability data is unavailable.\n","properties":{"standard":{"allOf":[{"$ref":"#/components/schemas/payoutScope"}],"description":"Support status for standard processing where funds are received in 1-3 business days."},"fast":{"allOf":[{"$ref":"#/components/schemas/payoutScope"}],"description":"Support status for fast funding where funds are received within 30 minutes."}}}},"components/schemas/payoutScope":{"id":"components/schemas/payoutScope","kind":"json-schema","title":"payoutScope","data":{"type":"object","description":"Support for domestic and cross-border transactions.","properties":{"domestic":{"allOf":[{"$ref":"#/components/schemas/payoutType"}],"description":"Support status for domestic payouts."},"crossBorder":{"allOf":[{"$ref":"#/components/schemas/payoutType"}],"description":"Support status for cross-border payouts."}}}},"components/schemas/payoutType":{"id":"components/schemas/payoutType","kind":"json-schema","title":"payoutType","data":{"type":"object","description":"Support status for money transfer, non-money transfer, and gambling use cases.","properties":{"moneyTransfer":{"allOf":[{"$ref":"#/components/schemas/payoutSupport"}],"description":"Support for person-to-person and remittance payouts.","example":"supported"},"nonMoneyTransfer":{"allOf":[{"$ref":"#/components/schemas/payoutSupport"}],"description":"Support for commercial and non-remittance payouts.","example":"supported"},"gambling":{"allOf":[{"$ref":"#/components/schemas/payoutSupport"}],"description":"Support for gambling/gaming payouts.","example":"notSupported"}}}},"components/schemas/payoutSupport":{"id":"components/schemas/payoutSupport","kind":"json-schema","title":"payoutSupport","data":{"type":"string","description":"Indicates whether a payout use case is supported.","enum":["supported","notSupported"],"example":"supported"}},"components/schemas/response":{"id":"components/schemas/response","kind":"json-schema","title":"response","data":{"type":"object","description":"Card metadata returned for a successful BIN lookup. Includes brand, BIN and BIN length, PAN length, funding type, issuer details, DCC eligibility, AMLD5 compliance status, card category, scheme product ID and sub-type, flexible credential participation, and Visa Direct Account Funding Transaction eligibility.","properties":{"type":{"type":"string","enum":["pan","networkToken"],"description":"Indicates whether the card belongs to a tokenized issuer range.","example":"pan"},"brand":{"$ref":"#/components/schemas/brand"},"bin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Identification Number extracted from the card. Capped at 8 digits to protect PCI-sensitive data where the BIN length exceeds 8 digits. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"binLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine the full BIN length for this card."},"children":[]}]}]}],"example":"444422","maxLength":8},"binLength":{"type":"integer","description":"Number of digits in the BIN (typically 6 or 8).","example":6},"panLength":{"type":"integer","description":"Expected length of the Primary Account Number. A value of 0 indicates the PAN length is variable for this BIN range.","example":16},"fundingType":{"$ref":"#/components/schemas/fundingType"},"issuerName":{"type":"string","description":"Name of the card-issuing bank or financial institution.","example":"Bank of America"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the card issuer. Use for cross-border fee logic or geographic restrictions.","example":"US"},"currency":{"type":"string","description":"ISO 4217 alpha-3 default currency of the card. Use together with dccAllowed to determine whether to offer Dynamic Currency Conversion.","example":"USD"},"dccAllowed":{"type":"boolean","description":"true if Dynamic Currency Conversion may be offered to the cardholder for this card. Always check this flag before presenting a DCC offer.","example":true},"anonymousPrepaid":{"type":"string","description":"AMLD5 anonymous prepaid status.","enum":["notPrepaidOrNonAnonymous","anonymousNonCompliant","anonymousCompliant","unknown"],"x-enumDescriptions":{"notPrepaidOrNonAnonymous":"No AMLD5 concern.","anonymousCompliant":"Anonymous prepaid but AMLD5-compliant.","anonymousNonCompliant":"Anonymous prepaid and non-compliant; block if your compliance policy requires it.","unknown":"Status could not be determined."},"example":"notPrepaidOrNonAnonymous"},"category":{"type":"string","enum":["commercial","consumer"],"description":"Whether the card is a commercial (business) or consumer card.","example":"consumer"},"productId":{"type":"string","description":"Scheme product identifier assigned by the card scheme. Can be used to determine card product tier and support interchange cost analysis. Values are scheme-defined and subject to change.","example":"A"},"productSubType":{"type":"string","description":"Scheme product sub-type providing further classification within a product, for example agriculture or healthcare segments for Visa. Values are scheme-defined, subject to change, and not consistent across schemes.","example":"HC"},"flexibleCredential":{"type":"object","description":"Visa Flexible Credential and Mastercard One Credential participation.","properties":{"participating":{"type":"boolean","description":"true if the card participates in Visa Flexible Credential or Mastercard One Credential. Use this to determine whether flexible credential routing logic applies.","example":true},"deploymentModel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Flexible Credential deployment model. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"participating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true."},"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":"managed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": cardholder choices held by Visa."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selfServe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": cardholder choices held by the issuer."},"children":[]}]}]}]}],"enum":["selfServe","managed"],"example":"managed"}}},"accountFundingTransactions":{"type":"object","description":"Visa Direct Account Funding Transaction (AFT) eligibility for this BIN. AFTs are used to pull funds from a Visa card account to fund a push payment (OCT) to another account. Check these flags before initiating a Visa Direct pull payment to determine whether the transaction is permitted for this card.","properties":{"domestic":{"type":"string","description":"Whether this card is eligible to be the source of a domestic Visa Direct Account Funding Transaction. A value of supported means the issuer participates in AFT for domestic transactions. notSupported means the issuer does not permit AFTs for domestic transactions.","enum":["supported","notSupported"],"example":"supported"},"crossBorder":{"type":"string","description":"Whether this card is eligible to be the source of a cross-border Visa Direct Account Funding Transaction. A value of supported means the issuer participates in AFT for cross-border transactions. notSupported means the issuer does not permit AFTs for cross-border transactions.","enum":["supported","notSupported"],"example":"supported"}}},"payouts":{"$ref":"#/components/schemas/payouts"}}}},"components/schemas/validationError":{"id":"components/schemas/validationError","kind":"json-schema","title":"validationError","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":"Machine-readable error code identifying the validation failure.","enum":["fieldIsMissing","fieldMustBeString","fieldMustBeNumber","fieldMustBeInteger","fieldMustBeBoolean","fieldMustBeObject","fieldMustBeArray","fieldIsNull","fieldIsEmpty","fieldHasInvalidValue","fieldIsNotAllowed","numberIsTooSmall","integerIsTooLarge","stringIsTooShort","stringIsTooLong","stringFailedRegexCheck"],"example":"fieldIsMissing"},"message":{"type":"string","description":"Human-readable description of the error and corrective action.","example":"Field at path must be present."},"jsonPath":{"type":"string","description":"JSON path of the field that caused the validation error.","example":"$.merchant.entity"}}}},"schema_331":{"kind":"json-schema","data":{"type":"integer","minimum":2,"maximum":2},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"type":"object","properties":{"WP-CorrelationId":{"type":"string","description":"Unique request/response correlation ID. Include in support tickets when reporting issues.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"type":"string","description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}}},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"title":"error400","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code."},"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":"headerIsMissing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headerHasInvalidValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": fix the named header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bodyIsEmpty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bodyIsNotJson"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bodyDoesNotMatchSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": fix the request body."},"children":[]}]}]}]}],"enum":["internalErrorOccurred","headerIsMissing","headerHasInvalidValue","bodyIsEmpty","bodyIsNotJson","bodyDoesNotMatchSchema"],"example":"bodyDoesNotMatchSchema"},"message":{"type":"string","description":"Human-readable corrective action. Not for machine parsing.","example":"A JSON body matching the expected schema must be provided."},"validationErrors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bodyDoesNotMatchSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each entry identifies a specific field error with a jsonPath pointer."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/validationError"}},"headerName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headerIsMissing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headerHasInvalidValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identifies which header needs to be corrected."},"children":[]}]}]}],"example":"Content-Type"}}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"WP-CorrelationId":{"type":"string","description":"Correlation ID for support.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"type":"string","description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"title":"error401","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["accessDenied"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accessDenied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 401 responses."},"children":[]}]}]}],"example":"accessDenied"},"message":{"type":"string","description":"Human-readable corrective action.","example":"Access to the requested resource has been denied"}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"object","properties":{"WP-CorrelationId":{"type":"string","description":"Correlation ID for support.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"title":"error404","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":[{"$$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":"tokenNotFound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the Worldpay token href is not recognized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardNotFound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the PAN is not in any known BIN range."},"children":[]}]}]}]}],"enum":["cardNotFound","tokenNotFound"],"example":"cardNotFound"},"message":{"type":"string","description":"Human-readable corrective action.","example":"The card number cannot be found in any BIN ranges."}}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"title":"error415","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headerHasInvalidValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 415 responses."},"children":[]}]}]}],"enum":["headerHasInvalidValue"],"example":"headerHasInvalidValue"},"message":{"type":"string","description":"Human-readable corrective action.","example":"A valid header must be provided."},"headerName":{"type":"string","description":"Identifies which header is incorrect.","example":"Content-Type"}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"title":"error500","type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internalServerError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 500 responses."},"children":[]}]}]}],"enum":["internalServerError"],"example":"internalServerError"},"message":{"type":"string","description":"Human-readable description of the server error.","example":"An internal server error occurred"}}},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"object","properties":{"WP-CorrelationId":{"type":"string","description":"Correlation ID - include in all support tickets.","example":"4c195ce9-3dbd-4bc8-9c94-3d3393842323"},"WP-Api-Version":{"type":"string","description":"Full API version (major.minor.patch) used to process the request.","example":"2.0.20260327"}}},"id":"schema_340"}},"exampleStore":{"components/examples/cardRequest":{"id":"components/examples/cardRequest","value":{"merchant":{"entity":"default"},"paymentInstrument":{"type":"card","number":"4444333322221111"}},"summary":"Lookup by card number (PAN)"},"components/examples/tokenHrefRequest":{"id":"components/examples/tokenHrefRequest","value":{"merchant":{"entity":"default"},"paymentInstrument":{"type":"token","href":"https://access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"}},"summary":"Lookup by Worldpay token (href)"},"components/examples/cardResponse":{"id":"components/examples/cardResponse","value":{"type":"networkToken","brand":["visa"],"bin":"491183","binLength":6,"panLength":16,"fundingType":"debit","issuerName":"Bank of America","countryCode":"US","currency":"USD","dccAllowed":false,"anonymousPrepaid":"notPrepaidOrNonAnonymous","category":"consumer","productId":"A","productSubType":"HC","flexibleCredential":{"participating":false},"accountFundingTransactions":{"domestic":"supported","crossBorder":"notSupported"}},"summary":"Card response - tokenized issuer range"},"components/examples/tokenResponse":{"id":"components/examples/tokenResponse","value":{"type":"pan","brand":["visa"],"bin":"444433","binLength":6,"panLength":0,"fundingType":"debit","issuerName":"Bank of America","countryCode":"US","currency":"USD","dccAllowed":true,"anonymousPrepaid":"notPrepaidOrNonAnonymous","category":"consumer","productId":"F","productSubType":"MX","flexibleCredential":{"participating":true,"deploymentModel":"managed"},"accountFundingTransactions":{"domestic":"notSupported","crossBorder":"supported"},"payouts":{"standard":{"domestic":{"moneyTransfer":"supported","nonMoneyTransfer":"supported","gambling":"supported"},"crossBorder":{"moneyTransfer":"notSupported","nonMoneyTransfer":"supported","gambling":"notSupported"}},"fast":{"domestic":{"moneyTransfer":"supported","nonMoneyTransfer":"supported","gambling":"supported"},"crossBorder":{"moneyTransfer":"notSupported","nonMoneyTransfer":"supported","gambling":"notSupported"}}}},"summary":"Worldpay token response - Includes payouts data"},"components/examples/validationError":{"id":"components/examples/validationError","value":{"errorName":"bodyDoesNotMatchSchema","message":"A JSON body matching the expected schema must be provided.","validationErrors":[{"errorName":"fieldIsMissing","message":"Field at path must be present.","jsonPath":"$.merchant.entity"}]},"summary":"Request body failed schema validation"},"components/examples/headerError":{"id":"components/examples/headerError","value":{"errorName":"headerIsMissing","message":"A valid header must be provided.","headerName":"Content-Type"},"summary":"Required header missing"},"components/examples/cardNotFound":{"id":"components/examples/cardNotFound","value":{"errorName":"cardNotFound","message":"The card number cannot be found in any BIN ranges."},"summary":"PAN not found in any BIN range"},"components/examples/tokenNotFound":{"id":"components/examples/tokenNotFound","value":{"errorName":"tokenNotFound","message":"Token not found"},"summary":"Worldpay token not found"},"paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber":{"value":{"merchant":{"entity":"default"},"paymentInstrument":{"type":"card","number":"4444333322221111"}},"key":"cardNumber","summary":"Lookup by card number (PAN)","id":"paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/cardNumber"},"paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/tokenHref":{"value":{"merchant":{"entity":"default"},"paymentInstrument":{"type":"token","href":"https://access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"}},"key":"tokenHref","summary":"Lookup by Worldpay token (href)","id":"paths/~1api~1cardBin~1panLookup/post/requestBody/content/application~1json/examples/tokenHref"},"paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber":{"value":{"type":"networkToken","brand":["visa"],"bin":"491183","binLength":6,"panLength":16,"fundingType":"debit","issuerName":"Bank of America","countryCode":"US","currency":"USD","dccAllowed":false,"anonymousPrepaid":"notPrepaidOrNonAnonymous","category":"consumer","productId":"A","productSubType":"HC","flexibleCredential":{"participating":false},"accountFundingTransactions":{"domestic":"supported","crossBorder":"notSupported"}},"key":"cardNumber","summary":"Card response - tokenized issuer range","id":"paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/cardNumber"},"paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token":{"value":{"type":"pan","brand":["visa"],"bin":"444433","binLength":6,"panLength":0,"fundingType":"debit","issuerName":"Bank of America","countryCode":"US","currency":"USD","dccAllowed":true,"anonymousPrepaid":"notPrepaidOrNonAnonymous","category":"consumer","productId":"F","productSubType":"MX","flexibleCredential":{"participating":true,"deploymentModel":"managed"},"accountFundingTransactions":{"domestic":"notSupported","crossBorder":"supported"},"payouts":{"standard":{"domestic":{"moneyTransfer":"supported","nonMoneyTransfer":"supported","gambling":"supported"},"crossBorder":{"moneyTransfer":"notSupported","nonMoneyTransfer":"supported","gambling":"notSupported"}},"fast":{"domestic":{"moneyTransfer":"supported","nonMoneyTransfer":"supported","gambling":"supported"},"crossBorder":{"moneyTransfer":"notSupported","nonMoneyTransfer":"supported","gambling":"notSupported"}}}},"key":"token","summary":"Worldpay token response - Includes payouts data","id":"paths/~1api~1cardBin~1panLookup/post/responses/200/content/application~1json/examples/token"},"paths/~1api~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":"fieldIsMissing","message":"Field at path must be present.","jsonPath":"$.merchant.entity"}]},"key":"Validation Error","summary":"Request body failed schema validation","id":"paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Validation Error"},"paths/~1api~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":"Required header missing","id":"paths/~1api~1cardBin~1panLookup/post/responses/400/content/application~1json/examples/Header Error"},"paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found":{"value":{"errorName":"tokenNotFound","message":"Token not found"},"key":"Token Not Found","summary":"Worldpay token not found","id":"paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Token Not Found"},"paths/~1api~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":"PAN not found in any BIN range","id":"paths/~1api~1cardBin~1panLookup/post/responses/404/content/application~1json/examples/Card Not Found"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encode your username:password (issued by Worldpay) and send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every request."},"children":[]}]}]}]}},"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Test (Try) - use for integration and QA"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live - use for production traffic"}],"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/@v2/openapi.json?download"},{"url":"/access/_bundle/products/card-bin/@v2/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Card BIN Data","description":"Lookup card metadata from a Primary Account Number (PAN), Network Token Number, or Worldpay token href.\n\nReturns: card brand(s), BIN and BIN length, PAN length, funding type, issuer name, issuer country (ISO alpha-2), default currency (ISO alpha-3), DCC eligibility, anonymous prepaid / AMLD5 compliance status, card category (consumer or commercial), product ID, product subtype, flexible credential participation including the Visa deployment model and account funding transactions support for domestic and cross-border. <br><br>\n\n    __Set your headers__\n  ```\n    Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 2\n  ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username:password given to you by your Worldpay Implementation Manager. <br/><br/> We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`. <br/><br/> We use the WP-Api-Version header to identify which version of our API you are using. You must use this header for any request you send to our Card BIN API. <br/><br/>\n__DNS whitelisting__ <br> Whitelist the following URLs:<br> * `https://try.access.worldpay-bsh.securedataplatform.co.uk/`<br> * `https://access.worldpay-bsh.securedataplatform.co.uk/`<br><br>\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting.","category":["Card BIN"],"business":["Enterprise"],"catalog-list":true,"generated":false}},"baseSlug":"/products/card-bin/openapi","routesMapping":{}}