{"items":[{"type":"link","label":"Shift4 Gateway API","link":"/docs/api/shift4-gateway","routeSlug":"/docs/api/shift4-gateway","content":{"contentType":"overview","meta":{"name":"Shift4 Gateway API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"shift4-gateway.json","url":"/_bundle/docs/api/shift4-gateway.json?download"},{"kind":"download","label":"shift4-gateway.yaml","url":"/_bundle/docs/api/shift4-gateway.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://dev.shift4.com","url":"https://dev.shift4.com"},{"kind":"email","title":"Shift4 Developer Support","email":"devsupport@shift4.com","label":"devsupport@shift4.com","withCopyButton":true,"copyContent":"devsupport@shift4.com"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://shift4.com/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"java","title":"Java","lang":"Java"},{"key":"php","title":"PHP","lang":"PHP"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Shift4 Gateway API (1.0.0)","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":"The Shift4 API is organized around REST. Our API has predictable resource-oriented URLs,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP response codes, authentication, and verbs."},"children":[]}]}]}]}],"sectionId":"/docs/api/shift4-gateway"}],"sectionId":"/docs/api/shift4-gateway"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/base-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests should be made to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"https://api.shift4.com\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://api.shift4.com\n"},"children":[]}]}]}],"sectionId":"/docs/api/shift4-gateway/section/base-url"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Shift4 API uses HTTP Basic Authentication. Provide your API secret key as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"username and leave the password empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl https://api.shift4.com/charges -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl https://api.shift4.com/charges -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},"children":[]}]}]}],"sectionId":"/docs/api/shift4-gateway/section/authentication"}]}]}},{"type":"link","label":"Base URL","link":"/docs/api/shift4-gateway/section/base-url","routeSlug":"/docs/api/shift4-gateway/section/base-url","content":null},{"type":"link","label":"Authentication","link":"/docs/api/shift4-gateway/section/authentication","routeSlug":"/docs/api/shift4-gateway/section/authentication","content":null},{"type":"group","label":"Charges","link":"/docs/api/shift4-gateway/charges","routeSlug":"/docs/api/shift4-gateway/charges","items":[{"label":"Create a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/createcharge","routeSlug":"/docs/api/shift4-gateway/charges/createcharge","metadata":{"seo":{"title":"Create a charge","description":"Creates a new charge. To charge a credit card, you create a charge object. If your API key is in test mode, the supplied payment source (e.g., card token) won't actually be charged, although everything else will occur as if in live mode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCharge","name":"Create a charge","isWebhook":false,"pointer":"/paths/~1charges/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new charge. To charge a credit card, you create a charge object.\nIf your API key is in test mode, the supplied payment source (e.g., card token)\nwon't actually be charged, although everything else will occur as if in live mode.\n"},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_56","exampleIds":["paths/~1charges/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_56","exampleIds":["paths/~1charges/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1charges/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/charges","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_56","exampleIds":["paths/~1charges/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","402"],"pointer":"/charges","href":"charges/createcharge","openApiOperationId":"createCharge","summary":"Create a charge"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/charges \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"amount=499\" \\\n  -d \"currency=USD\" \\\n  -d \"card=tok_NGsyDoJQXop5Pqqi6HizbJTe\" \\\n  -d \"description=Example charge\"\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$charge = $gateway->createCharge(array(\n    'amount' => 499,\n    'currency' => 'USD',\n    'card' => 'tok_NGsyDoJQXop5Pqqi6HizbJTe',\n    'description' => 'Example charge'\n));\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nChargeRequest request = new ChargeRequest()\n    .amount(499)\n    .currency(\"USD\")\n    .card(new CardRequest(\"tok_NGsyDoJQXop5Pqqi6HizbJTe\"))\n    .description(\"Example charge\");\n\nCharge charge = gateway.createCharge(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_56","exampleIds":["paths/~1charges/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_56","exampleIds":["paths/~1charges/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Charge created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}},"schemaId":"components/schemas/Charge"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Card error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1charges/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1charges/post/responses/402/content/application~1json/example"]}],"pointer":"/paths/~1charges/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Charge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1charges/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1charges/post/responses/402/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/charges/createcharge"}],"panels":[]}]},"httpPath":"/charges"},{"label":"List charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/listcharges","routeSlug":"/docs/api/shift4-gateway/charges/listcharges","metadata":{"seo":{"title":"List charges","description":"Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCharges","name":"List charges","isWebhook":false,"pointer":"/paths/~1charges/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"},{"name":"customerId","in":"query","schemaId":"schema_58","description":"Filter by customer ID"}],"pointer":"/paths/~1charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/charges","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"},{"name":"customerId","in":"query","schemaId":"schema_58"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/charges","href":"charges/listcharges","openApiOperationId":"listCharges","summary":"List charges"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/charges?limit=10 \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$charges = $gateway->listCharges(array('limit' => 10));\n"},{"lang":"java","label":"Java","source":"ChargeListRequest request = new ChargeListRequest().limit(10);\nListResponse<Charge> charges = gateway.listCharges(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of charges","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60"}],"pointer":"/paths/~1charges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/charges/listcharges"}],"panels":[]}]},"httpPath":"/charges"},{"label":"Retrieve a charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/getcharge","routeSlug":"/docs/api/shift4-gateway/charges/getcharge","metadata":{"seo":{"title":"Retrieve a charge","description":"Retrieves the details of a charge that has previously been created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCharge","name":"Retrieve a charge","isWebhook":false,"pointer":"/paths/~1charges~1{chargeId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a charge that has previously been created."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chargeId","in":"path","schemaId":"schema_58","description":"The ID of the charge to retrieve","required":true}],"pointer":"/paths/~1charges~1{chargeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/charges/{chargeId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"chargeId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/charges/{chargeId}","href":"charges/getcharge","openApiOperationId":"getCharge","summary":"Retrieve a charge"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/charges/char_ORVCrwOrTkGsDwM3H50OIW7Q \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$charge = $gateway->retrieveCharge('char_ORVCrwOrTkGsDwM3H50OIW7Q');\n"},{"lang":"java","label":"Java","source":"Charge charge = gateway.retrieveCharge(\"char_ORVCrwOrTkGsDwM3H50OIW7Q\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Charge details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}},"schemaId":"components/schemas/Charge"},{"code":"404","description":"Charge not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1charges~1{chargeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Charge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/charges/getcharge"}],"panels":[]}]},"httpPath":"/charges/{chargeId}"},{"label":"Update a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/updatecharge","routeSlug":"/docs/api/shift4-gateway/charges/updatecharge","metadata":{"seo":{"title":"Update a charge","description":"Updates the specified charge by setting the values of the parameters passed. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCharge","name":"Update a charge","isWebhook":false,"pointer":"/paths/~1charges~1{chargeId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the specified charge by setting the values of the parameters passed. Any parameters not provided are left unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To resolve a pending payment-method charge in test mode, address the charge by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientObjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead — see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/testing/resolvechargestatus"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolve status of a pending charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chargeId","in":"path","schemaId":"schema_58","description":"The ID of the charge to update","required":true}],"pointer":"/paths/~1charges~1{chargeId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_61","exampleIds":["paths/~1charges~1{chargeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_61","exampleIds":["paths/~1charges~1{chargeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1charges~1{chargeId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/charges/{chargeId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"chargeId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_61","exampleIds":["paths/~1charges~1{chargeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","404"],"pointer":"/charges/{chargeId}","href":"charges/updatecharge","openApiOperationId":"updateCharge","summary":"Update a charge"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/charges/char_ORVCrwOrTkGsDwM3H50OIW7Q \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"description=New description\"\n"},{"lang":"php","label":"PHP","source":"$charge = $gateway->updateCharge(array(\n    'chargeId' => 'char_ORVCrwOrTkGsDwM3H50OIW7Q',\n    'description' => 'New description'\n));\n"},{"lang":"java","label":"Java","source":"ChargeUpdateRequest request = new ChargeUpdateRequest(\"char_ORVCrwOrTkGsDwM3H50OIW7Q\")\n    .description(\"New description\");\n\nCharge charge = gateway.updateCharge(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_61","exampleIds":["paths/~1charges~1{chargeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_61","exampleIds":["paths/~1charges~1{chargeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Charge updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}},"schemaId":"components/schemas/Charge"},{"code":"404","description":"Charge not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1charges~1{chargeId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Charge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/charges/updatecharge"}],"panels":[]}]},"httpPath":"/charges/{chargeId}"},{"label":"Capture a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/capturecharge","routeSlug":"/docs/api/shift4-gateway/charges/capturecharge","metadata":{"seo":{"title":"Capture a charge","description":"Captures a previously uncaptured charge. This is the second step of a two-step payment flow (authorize then capture). Charges must be captured within 5 days of authorization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"captureCharge","name":"Capture a charge","isWebhook":false,"pointer":"/paths/~1charges~1{chargeId}~1capture/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capture a charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Captures a previously uncaptured charge. This is the second step of a two-step payment flow (authorize then capture). Charges must be captured within 5 days of authorization."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chargeId","in":"path","schemaId":"schema_58","description":"The ID of the charge to capture","required":true}],"pointer":"/paths/~1charges~1{chargeId}~1capture/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_62"}},"schemaId":"schema_62","pointer":"/paths/~1charges~1{chargeId}~1capture/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/charges/{chargeId}/capture","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"chargeId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_62"}},"responseCodes":["200","404"],"pointer":"/charges/{chargeId}/capture","href":"charges/capturecharge","openApiOperationId":"captureCharge","summary":"Capture a charge"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST https://api.shift4.com/charges/char_ORVCrwOrTkGsDwM3H50OIW7Q/capture \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$charge = $gateway->captureCharge(array(\n    'chargeId' => 'char_ORVCrwOrTkGsDwM3H50OIW7Q'\n));\n"},{"lang":"java","label":"Java","source":"Charge charge = gateway.captureCharge(new CaptureRequest(\"char_ORVCrwOrTkGsDwM3H50OIW7Q\"));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_62","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_62"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Charge captured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}},"schemaId":"components/schemas/Charge"},{"code":"404","description":"Charge not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1charges~1{chargeId}~1capture/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Charge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/charges/capturecharge"}],"panels":[]}]},"httpPath":"/charges/{chargeId}/capture"},{"label":"Increment an authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/charges/incrementalauthorization","routeSlug":"/docs/api/shift4-gateway/charges/incrementalauthorization","metadata":{"seo":{"title":"Increment an authorization","description":"Increments the amount of a pre-authorized charge. To be able to increment an authorization, the charge must be created with captured=false and options.authorizationType=pre."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"incrementalAuthorization","name":"Increment an authorization","isWebhook":false,"pointer":"/paths/~1charges~1{chargeId}~1incremental-authorization/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Increment an authorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Increments the amount of a pre-authorized charge. To be able to increment an authorization, the charge must be created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captured=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options.authorizationType=pre"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chargeId","in":"path","schemaId":"schema_58","description":"Identifier of the charge whose amount should be incremented.","required":true}],"pointer":"/paths/~1charges~1{chargeId}~1incremental-authorization/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_63"}},"schemaId":"schema_63","pointer":"/paths/~1charges~1{chargeId}~1incremental-authorization/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/charges/{chargeId}/incremental-authorization","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"chargeId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_63"}},"responseCodes":["200","400","404"],"pointer":"/charges/{chargeId}/incremental-authorization","href":"charges/incrementalauthorization","openApiOperationId":"incrementalAuthorization","summary":"Increment an authorization"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/charges/char_ORVCrwOrTkGsDwM3H50OIW7Q/incremental-authorization \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"amount=500\"\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_63","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_63"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authorization incremented","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}},"schemaId":"components/schemas/Charge"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Charge not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1charges~1{chargeId}~1incremental-authorization/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Charge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Charge"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/charges/incrementalauthorization"}],"panels":[]}]},"httpPath":"/charges/{chargeId}/incremental-authorization"}],"content":{"contentType":"group","meta":{"name":"Charges"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charges","showPageActions":true},{"nodeType":"markdoc","content":"Create and manage payment charges. A charge represents a credit or debit card payment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/charges","summary":"Create a charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/charges/createcharge","deprecated":false},{"title":"/charges","summary":"List charges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/charges/listcharges","deprecated":false},{"title":"/charges/{chargeId}","summary":"Retrieve a charge","prefix":{"name":"get","color":"get"},"badges":[],"link":"/charges/getcharge","deprecated":false},{"title":"/charges/{chargeId}","summary":"Update a charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/charges/updatecharge","deprecated":false},{"title":"/charges/{chargeId}/capture","summary":"Capture a charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/charges/capturecharge","deprecated":false},{"title":"/charges/{chargeId}/incremental-authorization","summary":"Increment an authorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/charges/incrementalauthorization","deprecated":false}]}]}]}]}},{"type":"group","label":"Refunds","link":"/docs/api/shift4-gateway/refunds","routeSlug":"/docs/api/shift4-gateway/refunds","items":[{"label":"Refund a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/createrefund","routeSlug":"/docs/api/shift4-gateway/refunds/createrefund","metadata":{"seo":{"title":"Refund a charge","description":"Refund an existing charge, which will result in funds being returned to the previously charged credit or debit card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRefund","name":"Refund a charge","isWebhook":false,"pointer":"/paths/~1refunds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund a charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Refund an existing charge, which will result in funds being returned to the previously charged credit or debit card.\n\nPartial refunds are only possible for a captured charge. Partial refunds can be repeated for as long as the charge is not fully refunded.\n\nNote that if there is an active subscription related to this charge, it won't be affected by this operation. If you want to cancel a subscription, you must do so in a separate request."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_64","exampleIds":["paths/~1refunds/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_64","exampleIds":["paths/~1refunds/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1refunds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_64","exampleIds":["paths/~1refunds/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","402"],"pointer":"/refunds","href":"refunds/createrefund","openApiOperationId":"createRefund","summary":"Refund a charge"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/refunds \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"chargeId=char_bYBGkBSsSfcalm1DLqm8KBUQ\" \\\n  -d \"amount=1000\"\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$refund = $gateway->createRefund(array(\n    'chargeId' => 'char_bYBGkBSsSfcalm1DLqm8KBUQ',\n    'amount' => 1000\n));\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nRefundRequest request = new RefundRequest()\n    .chargeId(\"char_bYBGkBSsSfcalm1DLqm8KBUQ\")\n    .amount(1000);\n\nRefund refund = gateway.createRefund(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_64","exampleIds":["paths/~1refunds/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_64","exampleIds":["paths/~1refunds/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Card error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1refunds/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1refunds/post/responses/402/content/application~1json/example"]}],"pointer":"/paths/~1refunds/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1refunds/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1refunds/post/responses/402/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/createrefund"}],"panels":[]}]},"httpPath":"/refunds"},{"label":"List refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/listrefunds","routeSlug":"/docs/api/shift4-gateway/refunds/listrefunds","metadata":{"seo":{"title":"List refunds","description":"List refund objects for a given charge. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRefunds","name":"List refunds","isWebhook":false,"pointer":"/paths/~1refunds/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List refunds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List refund objects for a given charge. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"chargeId","in":"query","schemaId":"schema_65","description":"Identifier of the charge object for which refunds should be listed.","required":true},{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1refunds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"chargeId","in":"query","required":true,"example":"char_bYBGkBSsSfcalm1DLqm8KBUQ","schemaId":"schema_65"},{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/refunds","href":"refunds/listrefunds","openApiOperationId":"listRefunds","summary":"List refunds"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/refunds?chargeId=char_bYBGkBSsSfcalm1DLqm8KBUQ\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$refunds = $gateway->listRefunds(array(\n    'chargeId' => 'char_bYBGkBSsSfcalm1DLqm8KBUQ'\n));\n"},{"lang":"java","label":"Java","source":"RefundListRequest request = new RefundListRequest()\n    .chargeId(\"char_bYBGkBSsSfcalm1DLqm8KBUQ\")\n    .limit(10);\nListResponse<Refund> refunds = gateway.listRefunds(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of refunds","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"}],"pointer":"/paths/~1refunds/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/listrefunds"}],"panels":[]}]},"httpPath":"/refunds"},{"label":"Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/getrefund","routeSlug":"/docs/api/shift4-gateway/refunds/getrefund","metadata":{"seo":{"title":"Retrieve a refund","description":"Retrieves an existing refund object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRefund","name":"Retrieve a refund","isWebhook":false,"pointer":"/paths/~1refunds~1{refundId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing refund object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundId","in":"path","schemaId":"schema_58","description":"Identifier of the refund object that should be retrieved.","required":true}],"pointer":"/paths/~1refunds~1{refundId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds/{refundId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"refundId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/refunds/{refundId}","href":"refunds/getrefund","openApiOperationId":"getRefund","summary":"Retrieve a refund"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/refunds/re_bYBGkBSsSfcalm1DLqm8KBUQ \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$refund = $gateway->retrieveRefund('re_bYBGkBSsSfcalm1DLqm8KBUQ');\n"},{"lang":"java","label":"Java","source":"Refund refund = gateway.retrieveRefund(\"re_bYBGkBSsSfcalm1DLqm8KBUQ\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds~1{refundId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds~1{refundId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Refund not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1refunds~1{refundId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds~1{refundId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund","exampleIds":["paths/~1refunds~1{refundId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/getrefund"}],"panels":[]}]},"httpPath":"/refunds/{refundId}"},{"label":"Update a refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/refunds/updaterefund","routeSlug":"/docs/api/shift4-gateway/refunds/updaterefund","metadata":{"seo":{"title":"Update a refund","description":"Updates an existing refund object. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRefund","name":"Update a refund","isWebhook":false,"pointer":"/paths/~1refunds~1{refundId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing refund object. Any parameters not provided are left unchanged."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundId","in":"path","schemaId":"schema_58","description":"Identifier of the refund object that should be updated.","required":true}],"pointer":"/paths/~1refunds~1{refundId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_67","exampleIds":["paths/~1refunds~1{refundId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_67","exampleIds":["paths/~1refunds~1{refundId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1refunds~1{refundId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/{refundId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"refundId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_67","exampleIds":["paths/~1refunds~1{refundId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","404"],"pointer":"/refunds/{refundId}","href":"refunds/updaterefund","openApiOperationId":"updateRefund","summary":"Update a refund"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/refunds/re_bYBGkBSsSfcalm1DLqm8KBUQ \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"metadata[orderId]=12345\"\n"},{"lang":"java","label":"Java","source":"RefundUpdateRequest request = new RefundUpdateRequest()\n    .refundId(\"re_bYBGkBSsSfcalm1DLqm8KBUQ\")\n    .metadata(Map.of(\"orderId\", \"12345\"));\n\nRefund refund = gateway.updateRefund(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_67","exampleIds":["paths/~1refunds~1{refundId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_67","exampleIds":["paths/~1refunds~1{refundId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}},"schemaId":"components/schemas/Refund"},{"code":"404","description":"Refund not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1refunds~1{refundId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/updaterefund"}],"panels":[]}]},"httpPath":"/refunds/{refundId}"}],"content":{"contentType":"group","meta":{"name":"Refunds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refunds","showPageActions":true},{"nodeType":"markdoc","content":"Refund charges partially or fully."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/refunds","summary":"Refund a charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/createrefund","deprecated":false},{"title":"/refunds","summary":"List refunds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/listrefunds","deprecated":false},{"title":"/refunds/{refundId}","summary":"Retrieve a refund","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/getrefund","deprecated":false},{"title":"/refunds/{refundId}","summary":"Update a refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/updaterefund","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/docs/api/shift4-gateway/customers","routeSlug":"/docs/api/shift4-gateway/customers","items":[{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/createcustomer","routeSlug":"/docs/api/shift4-gateway/customers/createcustomer","metadata":{"seo":{"title":"Create a customer","description":"Creates a new customer object. You can attach a card to the customer so it can be reused for recurring charges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomer","name":"Create a customer","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new customer object. You can attach a card to the customer so it can be reused for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/createcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recurring charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_68","exampleIds":["paths/~1customers/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_68","exampleIds":["paths/~1customers/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_68","exampleIds":["paths/~1customers/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","402"],"pointer":"/customers","href":"customers/createcustomer","openApiOperationId":"createCustomer","summary":"Create a customer"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/customers \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"email=john.doe@example.com\" \\\n  -d \"card=tok_NGsyDoJQXop5Pqqi6HizbJTe\"\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$customer = $gateway->createCustomer(array(\n    'email' => 'john.doe@example.com',\n    'card' => 'tok_NGsyDoJQXop5Pqqi6HizbJTe'\n));\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nCustomerRequest request = new CustomerRequest()\n    .email(\"john.doe@example.com\")\n    .card(new CardRequest(\"tok_NGsyDoJQXop5Pqqi6HizbJTe\"));\n\nCustomer customer = gateway.createCustomer(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_68","exampleIds":["paths/~1customers/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_68","exampleIds":["paths/~1customers/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Request failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1customers/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1customers/post/responses/402/content/application~1json/example"]}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1customers/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1customers/post/responses/402/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomer"}],"panels":[]}]},"httpPath":"/customers"},{"label":"List customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/listcustomers","routeSlug":"/docs/api/shift4-gateway/customers/listcustomers","metadata":{"seo":{"title":"List customers","description":"Returns a list of customers. The customers are returned in sorted order, with the most recently created appearing first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomers","name":"List customers","isWebhook":false,"pointer":"/paths/~1customers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of customers. The customers are returned in sorted order, with the most recently created appearing first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"},{"name":"deleted","in":"query","schemaId":"schema_69","description":"Whether to include deleted customers in the response."},{"name":"email","in":"query","schemaId":"schema_58","description":"Filter by email address"}],"pointer":"/paths/~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"},{"name":"deleted","in":"query","schemaId":"schema_69"},{"name":"email","in":"query","schemaId":"schema_58"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/customers","href":"customers/listcustomers","openApiOperationId":"listCustomers","summary":"List customers"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -G https://api.shift4.com/customers \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d limit=10\n"},{"lang":"php","label":"PHP","source":"$customers = $gateway->listCustomers(array(\n    'limit' => 10\n));\n"},{"lang":"java","label":"Java","source":"CustomerListRequest request = new CustomerListRequest().limit(10);\n\nListResponse<Customer> customers = gateway.listCustomers(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of customers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_70"}},"schemaId":"schema_70"}],"pointer":"/paths/~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_70","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_70"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomers"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Retrieve a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/getcustomer","routeSlug":"/docs/api/shift4-gateway/customers/getcustomer","metadata":{"seo":{"title":"Retrieve a customer","description":"Retrieves the details of an existing customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomer","name":"Retrieve a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of an existing customer."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer to retrieve.","required":true}],"pointer":"/paths/~1customers~1{customerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{customerId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/customers/{customerId}","href":"customers/getcustomer","openApiOperationId":"getCustomer","summary":"Retrieve a customer"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$customer = $gateway->retrieveCustomer('cust_AoR0wvgntQWRUYMdZNLYMz5R');\n"},{"lang":"java","label":"Java","source":"Customer customer = gateway.retrieveCustomer(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Customer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customers~1{customerId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomer"}],"panels":[]}]},"httpPath":"/customers/{customerId}"},{"label":"Update a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/updatecustomer","routeSlug":"/docs/api/shift4-gateway/customers/updatecustomer","metadata":{"seo":{"title":"Update a customer","description":"Updates the specified customer by setting the values of the parameters passed. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomer","name":"Update a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the specified customer by setting the values of the parameters passed. Any parameters not provided are left unchanged."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer to update.","required":true}],"pointer":"/paths/~1customers~1{customerId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_71","exampleIds":["paths/~1customers~1{customerId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_71","exampleIds":["paths/~1customers~1{customerId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1customers~1{customerId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{customerId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_71","exampleIds":["paths/~1customers~1{customerId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","404"],"pointer":"/customers/{customerId}","href":"customers/updatecustomer","openApiOperationId":"updateCustomer","summary":"Update a customer"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"description=Premium customer\"\n"},{"lang":"php","label":"PHP","source":"$customer = $gateway->updateCustomer(array(\n    'customerId' => 'cust_AoR0wvgntQWRUYMdZNLYMz5R',\n    'description' => 'Premium customer'\n));\n"},{"lang":"java","label":"Java","source":"CustomerUpdateRequest request = new CustomerUpdateRequest(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\")\n    .description(\"Premium customer\");\n\nCustomer customer = gateway.updateCustomer(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_71","exampleIds":["paths/~1customers~1{customerId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_71","exampleIds":["paths/~1customers~1{customerId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Customer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customers~1{customerId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1customers~1{customerId}/post/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/updatecustomer"}],"panels":[]}]},"httpPath":"/customers/{customerId}"},{"label":"Delete a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/customers/deletecustomer","routeSlug":"/docs/api/shift4-gateway/customers/deletecustomer","metadata":{"seo":{"title":"Delete a customer","description":"Deletes an existing customer object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomer","name":"Delete a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an existing customer object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer to delete.","required":true}],"pointer":"/paths/~1customers~1{customerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{customerId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/customers/{customerId}","href":"customers/deletecustomer","openApiOperationId":"deleteCustomer","summary":"Delete a customer"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -X DELETE https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$gateway->deleteCustomer('cust_AoR0wvgntQWRUYMdZNLYMz5R');\n"},{"lang":"java","label":"Java","source":"DeleteResponse response = gateway.deleteCustomer(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72","exampleIds":["paths/~1customers~1{customerId}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_72","exampleIds":["paths/~1customers~1{customerId}/delete/responses/200/content/application~1json/example"]},{"code":"404","description":"Customer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customers~1{customerId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_72","exampleIds":["paths/~1customers~1{customerId}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72","exampleIds":["paths/~1customers~1{customerId}/delete/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/deletecustomer"}],"panels":[]}]},"httpPath":"/customers/{customerId}"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"Store customer payment information for recurring charges."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers","summary":"Create a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/createcustomer","deprecated":false},{"title":"/customers","summary":"List customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/listcustomers","deprecated":false},{"title":"/customers/{customerId}","summary":"Retrieve a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomer","deprecated":false},{"title":"/customers/{customerId}","summary":"Update a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/updatecustomer","deprecated":false},{"title":"/customers/{customerId}","summary":"Delete a customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/deletecustomer","deprecated":false}]}]}]}]}},{"type":"group","label":"Cards","link":"/docs/api/shift4-gateway/cards","routeSlug":"/docs/api/shift4-gateway/cards","items":[{"label":"Create a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/createcard","routeSlug":"/docs/api/shift4-gateway/cards/createcard","metadata":{"seo":{"title":"Create a card","description":"Adds a new card to an existing customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCard","name":"Create a card","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1cards/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new card to an existing customer.\n\nThere are three ways to create a new card object: use a card token (for example obtained from Components), use a charge identifier (saves the card that was used to create a successful charge not assigned to any other customer, and assigns that charge to this customer), or specify all card details."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer the card should be added to.","required":true}],"pointer":"/paths/~1customers~1{customerId}~1cards/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_73"}},"schemaId":"schema_73","pointer":"/paths/~1customers~1{customerId}~1cards/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{customerId}/cards","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_73"}},"responseCodes":["200","400","402"],"pointer":"/customers/{customerId}/cards","href":"cards/createcard","openApiOperationId":"createCard","summary":"Create a card"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R/cards \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"number=4242424242424242\" \\\n  -d \"expMonth=12\" \\\n  -d \"expYear=2030\" \\\n  -d \"cvc=123\"\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$card = $gateway->createCard(array(\n    'customerId' => 'cust_AoR0wvgntQWRUYMdZNLYMz5R',\n    'number' => '4242424242424242',\n    'expMonth' => '12',\n    'expYear' => '2030',\n    'cvc' => '123'\n));\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nCardRequest request = new CardRequest(\"4242424242424242\", \"12\", \"2030\", \"123\")\n    .customerId(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\");\n\nCard card = gateway.createCard(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_73","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_73"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}},"schemaId":"components/schemas/Card"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Request failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1customers~1{customerId}~1cards/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1customers~1{customerId}~1cards/post/responses/402/content/application~1json/example"]}],"pointer":"/paths/~1customers~1{customerId}~1cards/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Card","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1customers~1{customerId}~1cards/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1customers~1{customerId}~1cards/post/responses/402/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/createcard"}],"panels":[]}]},"httpPath":"/customers/{customerId}/cards"},{"label":"List cards for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/listcards","routeSlug":"/docs/api/shift4-gateway/cards/listcards","metadata":{"seo":{"title":"List cards for a customer","description":"Returns a list of cards belonging to a customer. The cards are returned in sorted order, with the most recently created appearing first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCards","name":"List cards for a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1cards/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cards for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of cards belonging to a customer. The cards are returned in sorted order, with the most recently created appearing first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer whose cards should be listed.","required":true}],"pointer":"/paths/~1customers~1{customerId}~1cards/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"},{"name":"deleted","in":"query","schemaId":"schema_69","description":"Whether to include deleted cards in the response."}],"pointer":"/paths/~1customers~1{customerId}~1cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{customerId}/cards","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"}],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"},{"name":"deleted","in":"query","schemaId":"schema_69"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/customers/{customerId}/cards","href":"cards/listcards","openApiOperationId":"listCards","summary":"List cards for a customer"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -G https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R/cards \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d limit=10\n"},{"lang":"php","label":"PHP","source":"$cards = $gateway->listCards(array(\n    'customerId' => 'cust_AoR0wvgntQWRUYMdZNLYMz5R',\n    'limit' => 10\n));\n"},{"lang":"java","label":"Java","source":"CardListRequest request = new CardListRequest(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\")\n    .limit(10);\n\nListResponse<Card> cards = gateway.listCards(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of cards","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}},"schemaId":"schema_74"}],"pointer":"/paths/~1customers~1{customerId}~1cards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_74","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/listcards"}],"panels":[]}]},"httpPath":"/customers/{customerId}/cards"},{"label":"Retrieve a card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/getcard","routeSlug":"/docs/api/shift4-gateway/cards/getcard","metadata":{"seo":{"title":"Retrieve a card","description":"Retrieves the details of a card that belongs to a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCard","name":"Retrieve a card","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a card that belongs to a customer."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer the card belongs to.","required":true},{"name":"cardId","in":"path","schemaId":"schema_58","description":"Identifier of the card to retrieve.","required":true}],"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{customerId}/cards/{cardId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"},{"name":"cardId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/customers/{customerId}/cards/{cardId}","href":"cards/getcard","openApiOperationId":"getCard","summary":"Retrieve a card"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R/cards/card_8P7OWXA5xiTS1ISnyZcum1KV \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$card = $gateway->retrieveCard('cust_AoR0wvgntQWRUYMdZNLYMz5R', 'card_8P7OWXA5xiTS1ISnyZcum1KV');\n"},{"lang":"java","label":"Java","source":"Card card = gateway.retrieveCard(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\", \"card_8P7OWXA5xiTS1ISnyZcum1KV\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}},"schemaId":"components/schemas/Card"},{"code":"404","description":"Card not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Card","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/getcard"}],"panels":[]}]},"httpPath":"/customers/{customerId}/cards/{cardId}"},{"label":"Update a card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/updatecard","routeSlug":"/docs/api/shift4-gateway/cards/updatecard","metadata":{"seo":{"title":"Update a card","description":"Updates the specified card. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCard","name":"Update a card","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the specified card. Any parameters not provided are left unchanged."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer the card belongs to.","required":true},{"name":"cardId","in":"path","schemaId":"schema_58","description":"Identifier of the card to update.","required":true}],"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_75"}},"schemaId":"schema_75","pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{customerId}/cards/{cardId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"},{"name":"cardId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_75"}},"responseCodes":["200","404"],"pointer":"/customers/{customerId}/cards/{cardId}","href":"cards/updatecard","openApiOperationId":"updateCard","summary":"Update a card"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R/cards/card_8P7OWXA5xiTS1ISnyZcum1KV \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"expYear=2032\"\n"},{"lang":"php","label":"PHP","source":"$card = $gateway->updateCard(array(\n    'customerId' => 'cust_AoR0wvgntQWRUYMdZNLYMz5R',\n    'cardId' => 'card_8P7OWXA5xiTS1ISnyZcum1KV',\n    'expYear' => '2032'\n));\n"},{"lang":"java","label":"Java","source":"CardUpdateRequest request = new CardUpdateRequest(\"card_8P7OWXA5xiTS1ISnyZcum1KV\", \"cust_AoR0wvgntQWRUYMdZNLYMz5R\")\n    .expYear(\"2032\");\n\nCard card = gateway.updateCard(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_75","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_75"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}},"schemaId":"components/schemas/Card"},{"code":"404","description":"Card not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Card","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/updatecard"}],"panels":[]}]},"httpPath":"/customers/{customerId}/cards/{cardId}"},{"label":"Delete a card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/cards/deletecard","routeSlug":"/docs/api/shift4-gateway/cards/deletecard","metadata":{"seo":{"title":"Delete a card","description":"Deletes an existing card object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCard","name":"Delete a card","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an existing card object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you delete the card that is the current default card, the most recently added card is used as the new default card. If you delete the last card, the default card is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_58","description":"Identifier of the customer the card belongs to.","required":true},{"name":"cardId","in":"path","schemaId":"schema_58","description":"Identifier of the card to delete.","required":true}],"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{customerId}/cards/{cardId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_58"},{"name":"cardId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/customers/{customerId}/cards/{cardId}","href":"cards/deletecard","openApiOperationId":"deleteCard","summary":"Delete a card"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -X DELETE https://api.shift4.com/customers/cust_AoR0wvgntQWRUYMdZNLYMz5R/cards/card_8P7OWXA5xiTS1ISnyZcum1KV \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$gateway->deleteCard('cust_AoR0wvgntQWRUYMdZNLYMz5R', 'card_8P7OWXA5xiTS1ISnyZcum1KV');\n"},{"lang":"java","label":"Java","source":"DeleteResponse response = gateway.deleteCard(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\", \"card_8P7OWXA5xiTS1ISnyZcum1KV\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1customers~1{customerId}~1cards~1{cardId}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_76","exampleIds":["paths/~1customers~1{customerId}~1cards~1{cardId}/delete/responses/200/content/application~1json/example"]},{"code":"404","description":"Card not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1customers~1{customerId}~1cards~1{cardId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_76","exampleIds":["paths/~1customers~1{customerId}~1cards~1{cardId}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1customers~1{customerId}~1cards~1{cardId}/delete/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cards/deletecard"}],"panels":[]}]},"httpPath":"/customers/{customerId}/cards/{cardId}"}],"content":{"contentType":"group","meta":{"name":"Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cards","showPageActions":true},{"nodeType":"markdoc","content":"Manage cards stored on customer objects."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers/{customerId}/cards","summary":"Create a card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cards/createcard","deprecated":false},{"title":"/customers/{customerId}/cards","summary":"List cards for a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cards/listcards","deprecated":false},{"title":"/customers/{customerId}/cards/{cardId}","summary":"Retrieve a card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cards/getcard","deprecated":false},{"title":"/customers/{customerId}/cards/{cardId}","summary":"Update a card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cards/updatecard","deprecated":false},{"title":"/customers/{customerId}/cards/{cardId}","summary":"Delete a card","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cards/deletecard","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Methods","link":"/docs/api/shift4-gateway/payment-methods","routeSlug":"/docs/api/shift4-gateway/payment-methods","items":[{"label":"Create a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/createpaymentmethod","routeSlug":"/docs/api/shift4-gateway/payment-methods/createpaymentmethod","metadata":{"seo":{"title":"Create a payment method","description":"Creates a new payment method for alternative payment types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentMethod","name":"Create a payment method","isWebhook":false,"pointer":"/paths/~1payment-methods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new payment method for alternative payment types."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PaymentMethodCreate","exampleIds":["paths/~1payment-methods/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"components/schemas/PaymentMethodCreate","exampleIds":["paths/~1payment-methods/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1payment-methods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-methods","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PaymentMethodCreate","exampleIds":["paths/~1payment-methods/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200"],"pointer":"/payment-methods","href":"payment-methods/createpaymentmethod","openApiOperationId":"createPaymentMethod","summary":"Create a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"components/schemas/PaymentMethodCreate","exampleIds":["paths/~1payment-methods/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PaymentMethodCreate","exampleIds":["paths/~1payment-methods/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment method created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethod"}},"schemaId":"components/schemas/PaymentMethod"}],"pointer":"/paths/~1payment-methods/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethod"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/createpaymentmethod"}],"panels":[]}]},"httpPath":"/payment-methods"},{"label":"List payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/listpaymentmethods","routeSlug":"/docs/api/shift4-gateway/payment-methods/listpaymentmethods","metadata":{"seo":{"title":"List payment methods","description":"List payment methods"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentMethods","name":"List payment methods","isWebhook":false,"pointer":"/paths/~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"customerId","in":"query","schemaId":"schema_58","required":true}],"pointer":"/paths/~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-methods","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"customerId","in":"query","required":true,"schemaId":"schema_58"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payment-methods","href":"payment-methods/listpaymentmethods","openApiOperationId":"listPaymentMethods","summary":"List payment methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payment methods","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"}],"pointer":"/paths/~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/listpaymentmethods"}],"panels":[]}]},"httpPath":"/payment-methods"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/getpaymentmethod","routeSlug":"/docs/api/shift4-gateway/payment-methods/getpaymentmethod","metadata":{"seo":{"title":"Retrieve a payment method","description":"Retrieve a payment method"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentMethod","name":"Retrieve a payment method","isWebhook":false,"pointer":"/paths/~1payment-methods~1{paymentMethodId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodId","in":"path","schemaId":"schema_58","required":true}],"pointer":"/paths/~1payment-methods~1{paymentMethodId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-methods/{paymentMethodId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"paymentMethodId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payment-methods/{paymentMethodId}","href":"payment-methods/getpaymentmethod","openApiOperationId":"getPaymentMethod","summary":"Retrieve a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment method details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethod"}},"schemaId":"components/schemas/PaymentMethod"}],"pointer":"/paths/~1payment-methods~1{paymentMethodId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethod"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/getpaymentmethod"}],"panels":[]}]},"httpPath":"/payment-methods/{paymentMethodId}"},{"label":"Delete a payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-methods/deletepaymentmethod","routeSlug":"/docs/api/shift4-gateway/payment-methods/deletepaymentmethod","metadata":{"seo":{"title":"Delete a payment method","description":"Delete a payment method"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentMethod","name":"Delete a payment method","isWebhook":false,"pointer":"/paths/~1payment-methods~1{paymentMethodId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodId","in":"path","schemaId":"schema_58","required":true}],"pointer":"/paths/~1payment-methods~1{paymentMethodId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payment-methods/{paymentMethodId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"paymentMethodId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payment-methods/{paymentMethodId}","href":"payment-methods/deletepaymentmethod","openApiOperationId":"deletePaymentMethod","summary":"Delete a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment method deleted"}],"pointer":"/paths/~1payment-methods~1{paymentMethodId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/deletepaymentmethod"}],"panels":[]}]},"httpPath":"/payment-methods/{paymentMethodId}"}],"content":{"contentType":"group","meta":{"name":"Payment Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Methods","showPageActions":true},{"nodeType":"markdoc","content":"Manage stored payment methods."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-methods","summary":"Create a payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/createpaymentmethod","deprecated":false},{"title":"/payment-methods","summary":"List payment methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/listpaymentmethods","deprecated":false},{"title":"/payment-methods/{paymentMethodId}","summary":"Retrieve a payment method","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/getpaymentmethod","deprecated":false},{"title":"/payment-methods/{paymentMethodId}","summary":"Delete a payment method","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-methods/deletepaymentmethod","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/docs/api/shift4-gateway/subscriptions","routeSlug":"/docs/api/shift4-gateway/subscriptions","items":[{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/createsubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/createsubscription","metadata":{"seo":{"title":"Create a subscription","description":"Creates a new subscription object. The subscription is billed to the customer's current default card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscription","name":"Create a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new subscription object. The subscription is billed to the customer's current default card."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_78","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_78","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_78","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","402"],"pointer":"/subscriptions","href":"subscriptions/createsubscription","openApiOperationId":"createSubscription","summary":"Create a subscription"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/subscriptions \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"planId=plan_bLu3vzO8yhAFhbxFEadm6HUV\" \\\n  -d \"customerId=cust_AoR0wvgntQWRUYMdZNLYMz5R\"\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$subscription = $gateway->createSubscription(array(\n    'planId' => 'plan_bLu3vzO8yhAFhbxFEadm6HUV',\n    'customerId' => 'cust_AoR0wvgntQWRUYMdZNLYMz5R'\n));\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nSubscriptionRequest request = new SubscriptionRequest()\n    .planId(\"plan_bLu3vzO8yhAFhbxFEadm6HUV\")\n    .customerId(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\");\n\nSubscription subscription = gateway.createSubscription(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_78","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_78","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Card error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1subscriptions/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1subscriptions/post/responses/402/content/application~1json/example"]}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1subscriptions/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1subscriptions/post/responses/402/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/createsubscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/listsubscriptions","routeSlug":"/docs/api/shift4-gateway/subscriptions/listsubscriptions","metadata":{"seo":{"title":"List subscriptions","description":"Lists subscription objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptions","name":"List subscriptions","isWebhook":false,"pointer":"/paths/~1subscriptions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists subscription objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"},{"name":"deleted","in":"query","schemaId":"schema_69","description":"Whether to include deleted subscriptions in the response."},{"name":"customerId","in":"query","schemaId":"schema_58","description":"Identifier of the customer object whose subscriptions should be listed."},{"name":"planId","in":"query","schemaId":"schema_58","description":"Identifier of the plan object whose subscriptions should be listed."}],"pointer":"/paths/~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"},{"name":"deleted","in":"query","schemaId":"schema_69"},{"name":"customerId","in":"query","schemaId":"schema_58"},{"name":"planId","in":"query","schemaId":"schema_58"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscriptions","href":"subscriptions/listsubscriptions","openApiOperationId":"listSubscriptions","summary":"List subscriptions"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -G https://api.shift4.com/subscriptions \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d customerId=cust_AoR0wvgntQWRUYMdZNLYMz5R\n"},{"lang":"php","label":"PHP","source":"$subscriptions = $gateway->listSubscriptions(array(\n    'customerId' => 'cust_AoR0wvgntQWRUYMdZNLYMz5R'\n));\n"},{"lang":"java","label":"Java","source":"SubscriptionListRequest request = new SubscriptionListRequest()\n    .customerId(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\")\n    .limit(10);\n\nListResponse<Subscription> subscriptions = gateway.listSubscriptions(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of subscriptions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"}],"pointer":"/paths/~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/listsubscriptions"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/getsubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/getsubscription","metadata":{"seo":{"title":"Retrieve a subscription","description":"Retrieves an existing subscription object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscription","name":"Retrieve a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscriptionId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing subscription object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionId","in":"path","schemaId":"schema_58","description":"Identifier of the subscription object that should be retrieved.","required":true}],"pointer":"/paths/~1subscriptions~1{subscriptionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{subscriptionId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/subscriptions/{subscriptionId}","href":"subscriptions/getsubscription","openApiOperationId":"getSubscription","summary":"Retrieve a subscription"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/subscriptions/sub_vrEaVmRDW0oKz8ycyy8Yc4l5 \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$subscription = $gateway->retrieveSubscription('sub_vrEaVmRDW0oKz8ycyy8Yc4l5');\n"},{"lang":"java","label":"Java","source":"Subscription subscription = gateway.retrieveSubscription(\"sub_vrEaVmRDW0oKz8ycyy8Yc4l5\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscriptions~1{subscriptionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/getsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"Update a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/updatesubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/updatesubscription","metadata":{"seo":{"title":"Update a subscription","description":"Updates an existing subscription object. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscription","name":"Update a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscriptionId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing subscription object. Any parameters not provided are left unchanged."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionId","in":"path","schemaId":"schema_58","description":"Identifier of the subscription object that should be updated.","required":true}],"pointer":"/paths/~1subscriptions~1{subscriptionId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_80","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_80","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1subscriptions~1{subscriptionId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{subscriptionId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_80","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","404"],"pointer":"/subscriptions/{subscriptionId}","href":"subscriptions/updatesubscription","openApiOperationId":"updateSubscription","summary":"Update a subscription"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/subscriptions/sub_vrEaVmRDW0oKz8ycyy8Yc4l5 \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"quantity=5\"\n"},{"lang":"php","label":"PHP","source":"$subscription = $gateway->updateSubscription(array(\n    'subscriptionId' => 'sub_vrEaVmRDW0oKz8ycyy8Yc4l5',\n    'quantity' => 5\n));\n"},{"lang":"java","label":"Java","source":"SubscriptionUpdateRequest request = new SubscriptionUpdateRequest()\n    .subscriptionId(\"sub_vrEaVmRDW0oKz8ycyy8Yc4l5\")\n    .quantity(5);\n\nSubscription subscription = gateway.updateSubscription(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_80","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_80","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscriptions~1{subscriptionId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/post/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/updatesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/cancelsubscription","routeSlug":"/docs/api/shift4-gateway/subscriptions/cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"Cancels an existing subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelSubscription","name":"Cancel a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscriptionId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing subscription."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionId","in":"path","schemaId":"schema_58","description":"Identifier of the subscription object that should be canceled.","required":true}],"pointer":"/paths/~1subscriptions~1{subscriptionId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"atPeriodEnd","in":"query","schemaId":"schema_69","description":"Whether or not to delay cancellation of the subscription until the end of the current period. By default the subscription is canceled immediately."}],"pointer":"/paths/~1subscriptions~1{subscriptionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{subscriptionId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_58"}],"query":[{"name":"atPeriodEnd","in":"query","schemaId":"schema_69"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/subscriptions/{subscriptionId}","href":"subscriptions/cancelsubscription","openApiOperationId":"cancelSubscription","summary":"Cancel a subscription"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -X DELETE \"https://api.shift4.com/subscriptions/sub_vrEaVmRDW0oKz8ycyy8Yc4l5?atPeriodEnd=true\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$subscription = $gateway->cancelSubscription(array(\n    'subscriptionId' => 'sub_vrEaVmRDW0oKz8ycyy8Yc4l5'\n));\n"},{"lang":"java","label":"Java","source":"SubscriptionCancelRequest request = new SubscriptionCancelRequest()\n    .subscriptionId(\"sub_vrEaVmRDW0oKz8ycyy8Yc4l5\");\n\nSubscription subscription = gateway.cancelSubscription(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/delete/responses/200/content/application~1json/example"]},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscriptions~1{subscriptionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1subscriptions~1{subscriptionId}/delete/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/cancelsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscriptionId}"},{"label":"List subscription charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/subscriptions/listsubscriptioncharges","routeSlug":"/docs/api/shift4-gateway/subscriptions/listsubscriptioncharges","metadata":{"seo":{"title":"List subscription charges","description":"Lists the charge attempts made by a subscription, including automatic renewals (rebills) and failed attempts. Results are sorted with the most recent records first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptionCharges","name":"List subscription charges","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscriptionId}~1charges/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscription charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the charge attempts made by a subscription, including automatic renewals (rebills) and failed attempts. Results are sorted with the most recent records first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that unlike other list endpoints, this endpoint uses page-based pagination ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters) instead of cursors."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionId","in":"path","schemaId":"schema_58","description":"Identifier of the subscription object whose charges should be listed.","required":true}],"pointer":"/paths/~1subscriptions~1{subscriptionId}~1charges/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_81","description":"Zero-based page number to return."},{"name":"size","in":"query","schemaId":"schema_82","description":"Number of results per page."}],"pointer":"/paths/~1subscriptions~1{subscriptionId}~1charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{subscriptionId}/charges","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_58"}],"query":[{"name":"page","in":"query","schemaId":"schema_81"},{"name":"size","in":"query","schemaId":"schema_82"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscriptions/{subscriptionId}/charges","href":"subscriptions/listsubscriptioncharges","openApiOperationId":"listSubscriptionCharges","summary":"List subscription charges"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -G https://api.shift4.com/subscriptions/sub_vrEaVmRDW0oKz8ycyy8Yc4l5/charges \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d size=20\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of subscription charges","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1subscriptions~1{subscriptionId}~1charges/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_83","exampleIds":["paths/~1subscriptions~1{subscriptionId}~1charges/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1subscriptions~1{subscriptionId}~1charges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_83","exampleIds":["paths/~1subscriptions~1{subscriptionId}~1charges/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1subscriptions~1{subscriptionId}~1charges/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/listsubscriptioncharges"}],"panels":[]}]},"httpPath":"/subscriptions/{subscriptionId}/charges"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Create recurring payments that result in charges being automatically created for a customer. The frequency and amount of these automatic charges are defined by a plan. Subscriptions are always billed to the customer's current default card."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions","summary":"Create a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/createsubscription","deprecated":false},{"title":"/subscriptions","summary":"List subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/listsubscriptions","deprecated":false},{"title":"/subscriptions/{subscriptionId}","summary":"Retrieve a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/getsubscription","deprecated":false},{"title":"/subscriptions/{subscriptionId}","summary":"Update a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/updatesubscription","deprecated":false},{"title":"/subscriptions/{subscriptionId}","summary":"Cancel a subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/cancelsubscription","deprecated":false},{"title":"/subscriptions/{subscriptionId}/charges","summary":"List subscription charges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/listsubscriptioncharges","deprecated":false}]}]}]}]}},{"type":"group","label":"Plans","link":"/docs/api/shift4-gateway/plans","routeSlug":"/docs/api/shift4-gateway/plans","items":[{"label":"Create a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/createplan","routeSlug":"/docs/api/shift4-gateway/plans/createplan","metadata":{"seo":{"title":"Create a plan","description":"Creates a new plan object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPlan","name":"Create a plan","isWebhook":false,"pointer":"/paths/~1plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new plan object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_84","exampleIds":["paths/~1plans/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_84","exampleIds":["paths/~1plans/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/plans","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_84","exampleIds":["paths/~1plans/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400"],"pointer":"/plans","href":"plans/createplan","openApiOperationId":"createPlan","summary":"Create a plan"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/plans \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"amount=499\" \\\n  -d \"currency=USD\" \\\n  -d \"interval=day\" \\\n  -d \"intervalCount=10\" \\\n  -d \"name=Example plan\"\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$plan = $gateway->createPlan(array(\n    'amount' => 499,\n    'currency' => 'USD',\n    'interval' => 'day',\n    'intervalCount' => 10,\n    'name' => 'Example plan'\n));\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nPlanRequest request = new PlanRequest()\n    .amount(499)\n    .currency(\"USD\")\n    .interval(Interval.DAY)\n    .intervalCount(10)\n    .name(\"Example plan\");\n\nPlan plan = gateway.createPlan(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_84","exampleIds":["paths/~1plans/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_84","exampleIds":["paths/~1plans/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1plans/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/createplan"}],"panels":[]}]},"httpPath":"/plans"},{"label":"List plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/listplans","routeSlug":"/docs/api/shift4-gateway/plans/listplans","metadata":{"seo":{"title":"List plans","description":"Lists plan objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPlans","name":"List plans","isWebhook":false,"pointer":"/paths/~1plans/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists plan objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"},{"name":"deleted","in":"query","schemaId":"schema_69","description":"Whether to include deleted plans in the response."}],"pointer":"/paths/~1plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plans","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"},{"name":"deleted","in":"query","schemaId":"schema_69"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/plans","href":"plans/listplans","openApiOperationId":"listPlans","summary":"List plans"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -G https://api.shift4.com/plans \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d limit=10\n"},{"lang":"php","label":"PHP","source":"$plans = $gateway->listPlans(array(\n    'limit' => 10\n));\n"},{"lang":"java","label":"Java","source":"PlanListRequest request = new PlanListRequest().limit(10);\n\nListResponse<Plan> plans = gateway.listPlans(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of plans","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85"}},"schemaId":"schema_85"}],"pointer":"/paths/~1plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_85","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/listplans"}],"panels":[]}]},"httpPath":"/plans"},{"label":"Retrieve a plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/getplan","routeSlug":"/docs/api/shift4-gateway/plans/getplan","metadata":{"seo":{"title":"Retrieve a plan","description":"Retrieves an existing plan object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlan","name":"Retrieve a plan","isWebhook":false,"pointer":"/paths/~1plans~1{planId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing plan object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"planId","in":"path","schemaId":"schema_58","description":"Identifier of the plan object that should be retrieved.","required":true}],"pointer":"/paths/~1plans~1{planId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plans/{planId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"planId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/plans/{planId}","href":"plans/getplan","openApiOperationId":"getPlan","summary":"Retrieve a plan"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/plans/plan_bLu3vzO8yhAFhbxFEadm6HUV \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$plan = $gateway->retrievePlan('plan_bLu3vzO8yhAFhbxFEadm6HUV');\n"},{"lang":"java","label":"Java","source":"Plan plan = gateway.retrievePlan(\"plan_bLu3vzO8yhAFhbxFEadm6HUV\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Plan not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1plans~1{planId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/getplan"}],"panels":[]}]},"httpPath":"/plans/{planId}"},{"label":"Update a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/updateplan","routeSlug":"/docs/api/shift4-gateway/plans/updateplan","metadata":{"seo":{"title":"Update a plan","description":"Updates an existing plan object. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePlan","name":"Update a plan","isWebhook":false,"pointer":"/paths/~1plans~1{planId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing plan object. Any parameters not provided are left unchanged.\n\nChanging the amount or currency of a plan will only affect future rebills of all subscriptions that are using this plan."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"planId","in":"path","schemaId":"schema_58","description":"Identifier of the plan object that should be updated.","required":true}],"pointer":"/paths/~1plans~1{planId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_86","exampleIds":["paths/~1plans~1{planId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_86","exampleIds":["paths/~1plans~1{planId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1plans~1{planId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/plans/{planId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"planId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_86","exampleIds":["paths/~1plans~1{planId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","404"],"pointer":"/plans/{planId}","href":"plans/updateplan","openApiOperationId":"updatePlan","summary":"Update a plan"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/plans/plan_bLu3vzO8yhAFhbxFEadm6HUV \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"name=New plan\"\n"},{"lang":"php","label":"PHP","source":"$plan = $gateway->updatePlan(array(\n    'planId' => 'plan_bLu3vzO8yhAFhbxFEadm6HUV',\n    'name' => 'New plan'\n));\n"},{"lang":"java","label":"Java","source":"PlanUpdateRequest request = new PlanUpdateRequest(\"plan_bLu3vzO8yhAFhbxFEadm6HUV\")\n    .name(\"New plan\");\n\nPlan plan = gateway.updatePlan(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_86","exampleIds":["paths/~1plans~1{planId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_86","exampleIds":["paths/~1plans~1{planId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Plan not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1plans~1{planId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan","exampleIds":["paths/~1plans~1{planId}/post/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/updateplan"}],"panels":[]}]},"httpPath":"/plans/{planId}"},{"label":"Delete a plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/plans/deleteplan","routeSlug":"/docs/api/shift4-gateway/plans/deleteplan","metadata":{"seo":{"title":"Delete a plan","description":"Deletes an existing plan object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePlan","name":"Delete a plan","isWebhook":false,"pointer":"/paths/~1plans~1{planId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an existing plan object.\n\nNote that when you delete a plan, the existing subscriptions will continue to be charged until they are canceled."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"planId","in":"path","schemaId":"schema_58","description":"Identifier of the plan object that should be deleted.","required":true}],"pointer":"/paths/~1plans~1{planId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/plans/{planId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"planId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/plans/{planId}","href":"plans/deleteplan","openApiOperationId":"deletePlan","summary":"Delete a plan"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -X DELETE https://api.shift4.com/plans/plan_bLu3vzO8yhAFhbxFEadm6HUV \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$gateway->deletePlan('plan_bLu3vzO8yhAFhbxFEadm6HUV');\n"},{"lang":"java","label":"Java","source":"DeleteResponse response = gateway.deletePlan(\"plan_bLu3vzO8yhAFhbxFEadm6HUV\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_87","exampleIds":["paths/~1plans~1{planId}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_87","exampleIds":["paths/~1plans~1{planId}/delete/responses/200/content/application~1json/example"]},{"code":"404","description":"Plan not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1plans~1{planId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_87","exampleIds":["paths/~1plans~1{planId}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_87","exampleIds":["paths/~1plans~1{planId}/delete/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/deleteplan"}],"panels":[]}]},"httpPath":"/plans/{planId}"}],"content":{"contentType":"group","meta":{"name":"Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Plans","showPageActions":true},{"nodeType":"markdoc","content":"A plan represents an automatically recurring charge. Plans define how often and how much a customer will be charged when a subscription is created."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/plans","summary":"Create a plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plans/createplan","deprecated":false},{"title":"/plans","summary":"List plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plans/listplans","deprecated":false},{"title":"/plans/{planId}","summary":"Retrieve a plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plans/getplan","deprecated":false},{"title":"/plans/{planId}","summary":"Update a plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plans/updateplan","deprecated":false},{"title":"/plans/{planId}","summary":"Delete a plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/plans/deleteplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/docs/api/shift4-gateway/events","routeSlug":"/docs/api/shift4-gateway/events","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/events/listevents","routeSlug":"/docs/api/shift4-gateway/events/listevents","metadata":{"seo":{"title":"List events","description":"List event objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEvents","name":"List events","isWebhook":false,"pointer":"/paths/~1events/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List event objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/events","href":"events/listevents","openApiOperationId":"listEvents","summary":"List events"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/events?limit=3\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$events = $gateway->listEvents(array(\n    'limit' => 3\n));\n"},{"lang":"java","label":"Java","source":"EventListRequest request = new EventListRequest()\n    .limit(3);\nListResponse<Event> events = gateway.listEvents(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of events","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88"}},"schemaId":"schema_88"}],"pointer":"/paths/~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_88","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/listevents"}],"panels":[]}]},"httpPath":"/events"},{"label":"Retrieve an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/events/getevent","routeSlug":"/docs/api/shift4-gateway/events/getevent","metadata":{"seo":{"title":"Retrieve an event","description":"Retrieves an existing event object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEvent","name":"Retrieve an event","isWebhook":false,"pointer":"/paths/~1events~1{eventId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing event object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_58","description":"Identifier of the event object that should be retrieved.","required":true}],"pointer":"/paths/~1events~1{eventId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{eventId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/events/{eventId}","href":"events/getevent","openApiOperationId":"getEvent","summary":"Retrieve an event"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/events/event_EY7CzyQiffJykW8rC5wSRnAj \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$event = $gateway->retrieveEvent('event_EY7CzyQiffJykW8rC5wSRnAj');\n"},{"lang":"java","label":"Java","source":"Event event = gateway.retrieveEvent(\"event_EY7CzyQiffJykW8rC5wSRnAj\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Event","exampleIds":["paths/~1events~1{eventId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Event","exampleIds":["paths/~1events~1{eventId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Event not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1events~1{eventId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Event","exampleIds":["paths/~1events~1{eventId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Event","exampleIds":["paths/~1events~1{eventId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/getevent"}],"panels":[]}]},"httpPath":"/events/{eventId}"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events can be used to get notifications when something interesting has happened. For example, the creation of a new successful charge will result in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGE_SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event. We provide API methods to retrieve a single event and to list events. It is also possible to get notifications about new events by using webhooks."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events","summary":"List events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/listevents","deprecated":false},{"title":"/events/{eventId}","summary":"Retrieve an event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/getevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Tokens","link":"/docs/api/shift4-gateway/tokens","routeSlug":"/docs/api/shift4-gateway/tokens","items":[{"label":"Create a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/tokens/createtoken","routeSlug":"/docs/api/shift4-gateway/tokens/createtoken","metadata":{"seo":{"title":"Create a token","description":"Creates a new token object. This method can be called with either your API public key or your API secret key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createToken","name":"Create a token","isWebhook":false,"pointer":"/paths/~1tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new token object. This method can be called with either your API public key or your API secret key."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenCreate","exampleIds":["paths/~1tokens/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"components/schemas/TokenCreate","exampleIds":["paths/~1tokens/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenCreate","exampleIds":["paths/~1tokens/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","402"],"pointer":"/tokens","href":"tokens/createtoken","openApiOperationId":"createToken","summary":"Create a token"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/tokens \\\n  -u pu_test_WVMFC9GFuvm54b0uorifKkCh: \\\n  -d \"number=4242424242424242\" \\\n  -d \"expMonth=12\" \\\n  -d \"expYear=2030\" \\\n  -d \"cvc=123\" \\\n  -d \"cardholderName=John Doe\"\n"},{"lang":"php","label":"PHP","source":"$token = $gateway->createToken(array(\n    'number' => '4242424242424242',\n    'expMonth' => '12',\n    'expYear' => '2030',\n    'cvc' => '123',\n    'cardholderName' => 'John Doe'\n));\n"},{"lang":"java","label":"Java","source":"TokenRequest request = new TokenRequest()\n    .number(\"4242424242424242\")\n    .expMonth(\"12\")\n    .expYear(\"2030\")\n    .cvc(\"123\")\n    .cardholderName(\"John Doe\");\n\nToken token = gateway.createToken(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"components/schemas/TokenCreate","exampleIds":["paths/~1tokens/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenCreate","exampleIds":["paths/~1tokens/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Card error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1tokens/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1tokens/post/responses/402/content/application~1json/example"]}],"pointer":"/paths/~1tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1tokens/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1tokens/post/responses/402/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/createtoken"}],"panels":[]}]},"httpPath":"/tokens"},{"label":"Retrieve a token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/tokens/gettoken","routeSlug":"/docs/api/shift4-gateway/tokens/gettoken","metadata":{"seo":{"title":"Retrieve a token","description":"Retrieves an existing token object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getToken","name":"Retrieve a token","isWebhook":false,"pointer":"/paths/~1tokens~1{tokenId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing token object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tokenId","in":"path","schemaId":"schema_58","description":"Identifier of the token object that should be retrieved.","required":true}],"pointer":"/paths/~1tokens~1{tokenId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tokens/{tokenId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"tokenId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/tokens/{tokenId}","href":"tokens/gettoken","openApiOperationId":"getToken","summary":"Retrieve a token"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/tokens/tok_NGsyDoJQXop5Pqqi6HizbJTe \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$token = $gateway->retrieveToken('tok_NGsyDoJQXop5Pqqi6HizbJTe');\n"},{"lang":"java","label":"Java","source":"Token token = gateway.retrieveToken(\"tok_NGsyDoJQXop5Pqqi6HizbJTe\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens~1{tokenId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens~1{tokenId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Token not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1tokens~1{tokenId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens~1{tokenId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token","exampleIds":["paths/~1tokens~1{tokenId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/gettoken"}],"panels":[]}]},"httpPath":"/tokens/{tokenId}"},{"label":"Initialize 3D Secure process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/tokens/initializethreedsecure","routeSlug":"/docs/api/shift4-gateway/tokens/initializethreedsecure","metadata":{"seo":{"title":"Initialize 3D Secure process","description":"Initializes a new 3D Secure authentication process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initializeThreeDSecure","name":"Initialize 3D Secure process","isWebhook":false,"pointer":"/paths/~13d-secure/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initialize 3D Secure process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initializes a new 3D Secure authentication process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generally (apart from a few specialized use cases) it is not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recommended to initialize 3D Secure from the API. You should use our"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Components or Checkout integration, which already support 3D Secure"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To complete the 3D Secure process initiated using this API call, you must:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure that the card supports 3D Secure by checking that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enrolled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the response is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redirect the user to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or display that URL in an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<iframe>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tag."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wait for the user to return to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a charge."},"children":[]}]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_89","exampleIds":["paths/~13d-secure/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_89","exampleIds":["paths/~13d-secure/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~13d-secure/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/3d-secure","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_89","exampleIds":["paths/~13d-secure/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","402"],"pointer":"/3d-secure","href":"tokens/initializethreedsecure","openApiOperationId":"initializeThreeDSecure","summary":"Initialize 3D Secure process"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/3d-secure \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"amount=1000\" \\\n  -d \"currency=USD\" \\\n  -d \"card[number]=4012001800000016\" \\\n  -d \"card[expMonth]=12\" \\\n  -d \"card[expYear]=2030\" \\\n  -d \"card[cvc]=123\" \\\n  -d \"returnUrl=https://example.com/\"\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_89","exampleIds":["paths/~13d-secure/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_89","exampleIds":["paths/~13d-secure/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"3D Secure process initialized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_90","exampleIds":["paths/~13d-secure/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_90","exampleIds":["paths/~13d-secure/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Card error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~13d-secure/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~13d-secure/post/responses/402/content/application~1json/example"]}],"pointer":"/paths/~13d-secure/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_90","exampleIds":["paths/~13d-secure/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_90","exampleIds":["paths/~13d-secure/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~13d-secure/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~13d-secure/post/responses/402/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/initializethreedsecure"}],"panels":[]}]},"httpPath":"/3d-secure"}],"content":{"contentType":"group","meta":{"name":"Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tokens","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens are used to represent a card in a situation where you don't want to process or store card-sensitive data on your servers. Tokens can be easily created directly in a browser with the use of Components, but you can also create tokens in other environments (for example, in mobile applications)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens can be created with the use of either your API public key or your API secret key. You can safely embed your API public key in JavaScript or in downloadable applications (like iPhone or Android apps), so you can easily create tokens directly from these applications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that tokens are meant to be used as a temporary representation of card data, and each token can be used only once. You should not store tokens for long periods of time — if you want to store a card for later use, you should use the token to either create a new customer or add a new card to an existing customer."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tokens","summary":"Create a token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/createtoken","deprecated":false},{"title":"/tokens/{tokenId}","summary":"Retrieve a token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tokens/gettoken","deprecated":false},{"title":"/3d-secure","summary":"Initialize 3D Secure process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/initializethreedsecure","deprecated":false}]}]}]}]}},{"type":"group","label":"Blacklist","link":"/docs/api/shift4-gateway/blacklist","routeSlug":"/docs/api/shift4-gateway/blacklist","items":[{"label":"Create a blacklist rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/createblacklistrule","routeSlug":"/docs/api/shift4-gateway/blacklist/createblacklistrule","metadata":{"seo":{"title":"Create a blacklist rule","description":"Creates a new blacklist rule object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBlacklistRule","name":"Create a blacklist rule","isWebhook":false,"pointer":"/paths/~1blacklist/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a blacklist rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new blacklist rule object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/BlacklistRuleCreate","exampleIds":["paths/~1blacklist/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"components/schemas/BlacklistRuleCreate","exampleIds":["paths/~1blacklist/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1blacklist/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/blacklist","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/BlacklistRuleCreate","exampleIds":["paths/~1blacklist/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400"],"pointer":"/blacklist","href":"blacklist/createblacklistrule","openApiOperationId":"createBlacklistRule","summary":"Create a blacklist rule"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/blacklist \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"ruleType=fingerprint\" \\\n  -d \"fingerprint=e3d8suyIDgFg3pE7\"\n"},{"lang":"php","label":"PHP","source":"$rule = $gateway->createBlacklistRule(array(\n    'ruleType' => 'fingerprint',\n    'fingerprint' => 'e3d8suyIDgFg3pE7'\n));\n"},{"lang":"java","label":"Java","source":"BlacklistRuleRequest request = new BlacklistRuleRequest()\n    .ruleType(BlacklistRuleType.FINGERPRINT)\n    .fingerprint(\"e3d8suyIDgFg3pE7\");\n\nBlacklistRule rule = gateway.createBlacklistRule(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"components/schemas/BlacklistRuleCreate","exampleIds":["paths/~1blacklist/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/BlacklistRuleCreate","exampleIds":["paths/~1blacklist/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blacklist rule created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1blacklist/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blacklist/createblacklistrule"}],"panels":[]}]},"httpPath":"/blacklist"},{"label":"List blacklist rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/listblacklistrules","routeSlug":"/docs/api/shift4-gateway/blacklist/listblacklistrules","metadata":{"seo":{"title":"List blacklist rules","description":"Lists blacklist rule objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBlacklistRules","name":"List blacklist rules","isWebhook":false,"pointer":"/paths/~1blacklist/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List blacklist rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists blacklist rule objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"},{"name":"deleted","in":"query","schemaId":"schema_69","description":"Whether to include deleted blacklist rules in the response."}],"pointer":"/paths/~1blacklist/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/blacklist","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"},{"name":"deleted","in":"query","schemaId":"schema_69"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/blacklist","href":"blacklist/listblacklistrules","openApiOperationId":"listBlacklistRules","summary":"List blacklist rules"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/blacklist?limit=10\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$rules = $gateway->listBlacklistRules(array(\n    'limit' => 10\n));\n"},{"lang":"java","label":"Java","source":"BlacklistRuleListRequest request = new BlacklistRuleListRequest()\n    .limit(10);\nListResponse<BlacklistRule> rules = gateway.listBlacklistRules(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of blacklist rules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91"}},"schemaId":"schema_91"}],"pointer":"/paths/~1blacklist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_91","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blacklist/listblacklistrules"}],"panels":[]}]},"httpPath":"/blacklist"},{"label":"Retrieve a blacklist rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/getblacklistrule","routeSlug":"/docs/api/shift4-gateway/blacklist/getblacklistrule","metadata":{"seo":{"title":"Retrieve a blacklist rule","description":"Retrieves an existing blacklist rule object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBlacklistRule","name":"Retrieve a blacklist rule","isWebhook":false,"pointer":"/paths/~1blacklist~1{blacklistRuleId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a blacklist rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing blacklist rule object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blacklistRuleId","in":"path","schemaId":"schema_58","description":"Identifier of the blacklist rule object that should be retrieved.","required":true}],"pointer":"/paths/~1blacklist~1{blacklistRuleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/blacklist/{blacklistRuleId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"blacklistRuleId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/blacklist/{blacklistRuleId}","href":"blacklist/getblacklistrule","openApiOperationId":"getBlacklistRule","summary":"Retrieve a blacklist rule"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/blacklist/blr_O3y7VyxbszuezuDNjuBsExUf \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$rule = $gateway->retrieveBlacklistRule('blr_O3y7VyxbszuezuDNjuBsExUf');\n"},{"lang":"java","label":"Java","source":"BlacklistRule rule = gateway.retrieveBlacklistRule(\"blr_O3y7VyxbszuezuDNjuBsExUf\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blacklist rule details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Blacklist rule not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1blacklist~1{blacklistRuleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlacklistRule","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blacklist/getblacklistrule"}],"panels":[]}]},"httpPath":"/blacklist/{blacklistRuleId}"},{"label":"Delete a blacklist rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/blacklist/deleteblacklistrule","routeSlug":"/docs/api/shift4-gateway/blacklist/deleteblacklistrule","metadata":{"seo":{"title":"Delete a blacklist rule","description":"Deletes an existing blacklist rule object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBlacklistRule","name":"Delete a blacklist rule","isWebhook":false,"pointer":"/paths/~1blacklist~1{blacklistRuleId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a blacklist rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an existing blacklist rule object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blacklistRuleId","in":"path","schemaId":"schema_58","description":"Identifier of the blacklist rule object that should be deleted.","required":true}],"pointer":"/paths/~1blacklist~1{blacklistRuleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/blacklist/{blacklistRuleId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"blacklistRuleId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/blacklist/{blacklistRuleId}","href":"blacklist/deleteblacklistrule","openApiOperationId":"deleteBlacklistRule","summary":"Delete a blacklist rule"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -X DELETE https://api.shift4.com/blacklist/blr_O3y7VyxbszuezuDNjuBsExUf \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$gateway->deleteBlacklistRule('blr_O3y7VyxbszuezuDNjuBsExUf');\n"},{"lang":"java","label":"Java","source":"DeleteResponse response = gateway.deleteBlacklistRule(\"blr_O3y7VyxbszuezuDNjuBsExUf\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blacklist rule deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_92","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/delete/responses/200/content/application~1json/example"]},{"code":"404","description":"Blacklist rule not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1blacklist~1{blacklistRuleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_92","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92","exampleIds":["paths/~1blacklist~1{blacklistRuleId}/delete/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blacklist/deleteblacklistrule"}],"panels":[]}]},"httpPath":"/blacklist/{blacklistRuleId}"}],"content":{"contentType":"group","meta":{"name":"Blacklist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blacklist","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklist can be used to block unwanted charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklist contains blacklist rule objects. Each such object represents a single condition — if a request to create a new charge matches this condition, then it will fail, resulting in an error response with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code=blacklisted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklist has been superseded by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/fraud-prevention/rules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fraud Rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which cover the same cases and add preapproval as well as blocking. These endpoints continue to work for accounts that have not moved over, but new integrations should use Fraud Rules."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/blacklist","summary":"Create a blacklist rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blacklist/createblacklistrule","deprecated":false},{"title":"/blacklist","summary":"List blacklist rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blacklist/listblacklistrules","deprecated":false},{"title":"/blacklist/{blacklistRuleId}","summary":"Retrieve a blacklist rule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blacklist/getblacklistrule","deprecated":false},{"title":"/blacklist/{blacklistRuleId}","summary":"Delete a blacklist rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/blacklist/deleteblacklistrule","deprecated":false}]}]}]}]}},{"type":"group","label":"Credits","link":"/docs/api/shift4-gateway/credits","routeSlug":"/docs/api/shift4-gateway/credits","items":[{"label":"Create a credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/createcredit","routeSlug":"/docs/api/shift4-gateway/credits/createcredit","metadata":{"seo":{"title":"Create a credit","description":"Creates a new credit object. A credit represents funds transferred to a card. Either customerId or card must be provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCredit","name":"Create a credit","isWebhook":false,"pointer":"/paths/~1credits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new credit object. A credit represents funds transferred to a card. Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are in test mode, then the provided card won't receive any funds, although everything else will work the same as in live mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is available for selected business models only. Please contact devsupport@shift4.com to find out more."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_93","exampleIds":["paths/~1credits/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_93","exampleIds":["paths/~1credits/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1credits/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_93","exampleIds":["paths/~1credits/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","402","403"],"pointer":"/credits","href":"credits/createcredit","openApiOperationId":"createCredit","summary":"Create a credit"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/credits \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"amount=499\" \\\n  -d \"currency=USD\" \\\n  -d \"customerId=cust_AoR0wvgntQWRUYMdZNLYMz5R\" \\\n  -d \"card=tok_NGsyDoJQXop5Pqqi6HizbJTe\" \\\n  -d \"description=Example credit\"\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$credit = $gateway->createCredit(array(\n    'amount' => 499,\n    'currency' => 'USD',\n    'customerId' => 'cust_AoR0wvgntQWRUYMdZNLYMz5R',\n    'card' => 'tok_NGsyDoJQXop5Pqqi6HizbJTe',\n    'description' => 'Example credit'\n));\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nCreditRequest request = new CreditRequest()\n    .amount(499)\n    .currency(\"USD\")\n    .customerId(\"cust_AoR0wvgntQWRUYMdZNLYMz5R\")\n    .card(new CardRequest(\"tok_NGsyDoJQXop5Pqqi6HizbJTe\"))\n    .description(\"Example credit\");\n\nCredit credit = gateway.createCredit(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_93","exampleIds":["paths/~1credits/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_93","exampleIds":["paths/~1credits/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"402","description":"Card error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Credit API not enabled for this account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1credits/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"402","schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/createcredit"}],"panels":[]}]},"httpPath":"/credits"},{"label":"List credits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/listcredits","routeSlug":"/docs/api/shift4-gateway/credits/listcredits","metadata":{"seo":{"title":"List credits","description":"List credit objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCredits","name":"List credits","isWebhook":false,"pointer":"/paths/~1credits/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List credit objects. Results are sorted by creation date, with the most recent objects first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is available for selected business models only. Please contact devsupport@shift4.com to find out more."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customerId","in":"query","schemaId":"schema_58","description":"Returns only credits associated with the given customer."},{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1credits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"customerId","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/credits","href":"credits/listcredits","openApiOperationId":"listCredits","summary":"List credits"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/credits?limit=3\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$credits = $gateway->listCredits(array(\n    'limit' => 3\n));\n"},{"lang":"java","label":"Java","source":"CreditListRequest request = new CreditListRequest()\n    .limit(3);\nListResponse<Credit> credits = gateway.listCredits(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of credits","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"403","description":"Credit API not enabled for this account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1credits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcredits"}],"panels":[]}]},"httpPath":"/credits"},{"label":"Retrieve a credit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/getcredit","routeSlug":"/docs/api/shift4-gateway/credits/getcredit","metadata":{"seo":{"title":"Retrieve a credit","description":"Retrieves an existing credit object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCredit","name":"Retrieve a credit","isWebhook":false,"pointer":"/paths/~1credits~1{creditId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an existing credit object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is available for selected business models only. Please contact devsupport@shift4.com to find out more."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditId","in":"path","schemaId":"schema_58","description":"Identifier of the credit object that should be retrieved.","required":true}],"pointer":"/paths/~1credits~1{creditId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{creditId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"creditId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/credits/{creditId}","href":"credits/getcredit","openApiOperationId":"getCredit","summary":"Retrieve a credit"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/credits/cr_OwM7B3WWha5SIfjNSw2eUqVb \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$credit = $gateway->retrieveCredit('cr_OwM7B3WWha5SIfjNSw2eUqVb');\n"},{"lang":"java","label":"Java","source":"Credit credit = gateway.retrieveCredit(\"cr_OwM7B3WWha5SIfjNSw2eUqVb\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits~1{creditId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits~1{creditId}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Credit API not enabled for this account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Credit not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1credits~1{creditId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits~1{creditId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit","exampleIds":["paths/~1credits~1{creditId}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/getcredit"}],"panels":[]}]},"httpPath":"/credits/{creditId}"},{"label":"Update a credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/credits/updatecredit","routeSlug":"/docs/api/shift4-gateway/credits/updatecredit","metadata":{"seo":{"title":"Update a credit","description":"Updates an existing credit object. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCredit","name":"Update a credit","isWebhook":false,"pointer":"/paths/~1credits~1{creditId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing credit object. Any parameters not provided are left unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is available for selected business models only. Please contact devsupport@shift4.com to find out more."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditId","in":"path","schemaId":"schema_58","description":"Identifier of the credit object that should be updated.","required":true}],"pointer":"/paths/~1credits~1{creditId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_95","exampleIds":["paths/~1credits~1{creditId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_95","exampleIds":["paths/~1credits~1{creditId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1credits~1{creditId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{creditId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"creditId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_95","exampleIds":["paths/~1credits~1{creditId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","403","404"],"pointer":"/credits/{creditId}","href":"credits/updatecredit","openApiOperationId":"updateCredit","summary":"Update a credit"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/credits/cr_OwM7B3WWha5SIfjNSw2eUqVb \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"description=New description\"\n"},{"lang":"php","label":"PHP","source":"$credit = $gateway->updateCredit(array(\n    'creditId' => 'cr_OwM7B3WWha5SIfjNSw2eUqVb',\n    'description' => 'New description'\n));\n"},{"lang":"java","label":"Java","source":"CreditUpdateRequest request = new CreditUpdateRequest()\n    .creditId(\"cr_OwM7B3WWha5SIfjNSw2eUqVb\")\n    .description(\"New description\");\n\nCredit credit = gateway.updateCredit(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_95","exampleIds":["paths/~1credits~1{creditId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_95","exampleIds":["paths/~1credits~1{creditId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit"},{"code":"403","description":"Credit API not enabled for this account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Credit not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1credits~1{creditId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1credits~1{creditId}/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/updatecredit"}],"panels":[]}]},"httpPath":"/credits/{creditId}"}],"content":{"contentType":"group","meta":{"name":"Credits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credits","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A credit represents funds transferred to a card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is available for selected business models only. Please contact devsupport@shift4.com to find out more."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/credits","summary":"Create a credit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/createcredit","deprecated":false},{"title":"/credits","summary":"List credits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcredits","deprecated":false},{"title":"/credits/{creditId}","summary":"Retrieve a credit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/getcredit","deprecated":false},{"title":"/credits/{creditId}","summary":"Update a credit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/updatecredit","deprecated":false}]}]}]}]}},{"type":"group","label":"Disputes","link":"/docs/api/shift4-gateway/disputes","routeSlug":"/docs/api/shift4-gateway/disputes","items":[{"label":"List disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/listdisputes","routeSlug":"/docs/api/shift4-gateway/disputes/listdisputes","metadata":{"seo":{"title":"List disputes","description":"Lists dispute objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDisputes","name":"List disputes","isWebhook":false,"pointer":"/paths/~1disputes/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List disputes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists dispute objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1disputes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/disputes","href":"disputes/listdisputes","openApiOperationId":"listDisputes","summary":"List disputes"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/disputes?limit=3\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$disputes = $gateway->listDisputes(array(\n    'limit' => 3\n));\n"},{"lang":"java","label":"Java","source":"DisputeListRequest request = new DisputeListRequest()\n    .limit(3);\nListResponse<Dispute> disputes = gateway.listDisputes(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of disputes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96"}],"pointer":"/paths/~1disputes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/listdisputes"}],"panels":[]}]},"httpPath":"/disputes"},{"label":"Retrieve a dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/getdispute","routeSlug":"/docs/api/shift4-gateway/disputes/getdispute","metadata":{"seo":{"title":"Retrieve a dispute","description":"Retrieves an existing dispute object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDispute","name":"Retrieve a dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{disputeId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing dispute object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"disputeId","in":"path","schemaId":"schema_58","description":"Identifier of the dispute object that should be retrieved.","required":true}],"pointer":"/paths/~1disputes~1{disputeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes/{disputeId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"disputeId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/disputes/{disputeId}","href":"disputes/getdispute","openApiOperationId":"getDispute","summary":"Retrieve a dispute"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/disputes/disp_GOqyiOF9575FUYMZ73gjNrcY \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$gateway = new Shift4\\Shift4Gateway('pr_test_tXHm9qV9qV9bjIRHcQr9PLPa');\n\n$dispute = $gateway->retrieveDispute('disp_GOqyiOF9575FUYMZ73gjNrcY');\n"},{"lang":"java","label":"Java","source":"Shift4Gateway gateway = new Shift4Gateway(\"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa\");\n\nDispute dispute = gateway.retrieveDispute(\"disp_GOqyiOF9575FUYMZ73gjNrcY\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dispute details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Dispute not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1disputes~1{disputeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/getdispute"}],"panels":[]}]},"httpPath":"/disputes/{disputeId}"},{"label":"Update a dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/updatedispute","routeSlug":"/docs/api/shift4-gateway/disputes/updatedispute","metadata":{"seo":{"title":"Update a dispute","description":"Updates an existing dispute object. Any parameters not provided are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDispute","name":"Update a dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{disputeId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing dispute object. Any parameters not provided are left unchanged."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"disputeId","in":"path","schemaId":"schema_58","description":"Identifier of the dispute object that should be updated.","required":true}],"pointer":"/paths/~1disputes~1{disputeId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_97","exampleIds":["paths/~1disputes~1{disputeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"schemaId":"schema_97","exampleIds":["paths/~1disputes~1{disputeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"pointer":"/paths/~1disputes~1{disputeId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/disputes/{disputeId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"disputeId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_97","exampleIds":["paths/~1disputes~1{disputeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"responseCodes":["200","400","404"],"pointer":"/disputes/{disputeId}","href":"disputes/updatedispute","openApiOperationId":"updateDispute","summary":"Update a dispute"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/disputes/disp_GOqyiOF9575FUYMZ73gjNrcY \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -d \"evidence[productDescription]=Exclusive black shoes\" \\\n  -d \"evidence[customerCommunication]=file_2nayTQXBBjaVEPVtCwGCbqOj\"\n"},{"lang":"php","label":"PHP","source":"$dispute = $gateway->updateDispute(array(\n    'disputeId' => 'disp_GOqyiOF9575FUYMZ73gjNrcY',\n    'evidence' => array(\n        'productDescription' => 'Exclusive black shoes',\n        'customerCommunication' => 'file_2nayTQXBBjaVEPVtCwGCbqOj'\n    )\n));\n"},{"lang":"java","label":"Java","source":"DisputeUpdateRequest request = new DisputeUpdateRequest()\n    .disputeId(\"disp_GOqyiOF9575FUYMZ73gjNrcY\")\n    .evidence(new DisputeEvidenceRequest()\n        .productDescription(\"Exclusive black shoes\")\n        .customerCommunication(\"file_2nayTQXBBjaVEPVtCwGCbqOj\"));\n\nDispute dispute = gateway.updateDispute(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_97","exampleIds":["paths/~1disputes~1{disputeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_97","exampleIds":["paths/~1disputes~1{disputeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dispute updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Dispute not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1disputes~1{disputeId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/updatedispute"}],"panels":[]}]},"httpPath":"/disputes/{disputeId}"},{"label":"Close a dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/disputes/closedispute","routeSlug":"/docs/api/shift4-gateway/disputes/closedispute","metadata":{"seo":{"title":"Close a dispute","description":"Closing the dispute indicates that you do not want to submit any further evidence and acknowledge it as lost."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"closeDispute","name":"Close a dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{disputeId}~1close/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close a dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Closing the dispute indicates that you do not want to submit any further evidence and acknowledge it as lost."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"disputeId","in":"path","schemaId":"schema_58","description":"Identifier of the dispute object that should be closed.","required":true}],"pointer":"/paths/~1disputes~1{disputeId}~1close/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/disputes/{disputeId}/close","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"disputeId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/disputes/{disputeId}/close","href":"disputes/closedispute","openApiOperationId":"closeDispute","summary":"Close a dispute"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/disputes/disp_GOqyiOF9575FUYMZ73gjNrcY/close \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -X POST\n"},{"lang":"php","label":"PHP","source":"$dispute = $gateway->closeDispute('disp_GOqyiOF9575FUYMZ73gjNrcY');\n"},{"lang":"java","label":"Java","source":"Dispute dispute = gateway.closeDispute(\"disp_GOqyiOF9575FUYMZ73gjNrcY\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dispute closed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}~1close/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}~1close/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Dispute not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1disputes~1{disputeId}~1close/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}~1close/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1disputes~1{disputeId}~1close/post/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/closedispute"}],"panels":[]}]},"httpPath":"/disputes/{disputeId}/close"}],"content":{"contentType":"group","meta":{"name":"Disputes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disputes","showPageActions":true},{"nodeType":"markdoc","content":"A dispute is created when a customer questions your charge with their bank or the credit card company. When this happens, you have an opportunity to respond by providing evidence that the charge is legitimate."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/disputes","summary":"List disputes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/listdisputes","deprecated":false},{"title":"/disputes/{disputeId}","summary":"Retrieve a dispute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/getdispute","deprecated":false},{"title":"/disputes/{disputeId}","summary":"Update a dispute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/updatedispute","deprecated":false},{"title":"/disputes/{disputeId}/close","summary":"Close a dispute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/closedispute","deprecated":false}]}]}]}]}},{"type":"group","label":"File Uploads","link":"/docs/api/shift4-gateway/file-uploads","routeSlug":"/docs/api/shift4-gateway/file-uploads","items":[{"label":"Create a file upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/file-uploads/createfileupload","routeSlug":"/docs/api/shift4-gateway/file-uploads/createfileupload","metadata":{"seo":{"title":"Create a file upload","description":"Creates a new file upload object. A successful request returns a file upload object that represents the uploaded file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFileUpload","name":"Create a file upload","isWebhook":false,"pointer":"/paths/~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a file upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new file upload object. A successful request returns a file upload object that represents the uploaded file."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_98"}},"schemaId":"schema_98","pointer":"/paths/~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files","servers":[{"url":"https://uploads.api.shift4.com","description":"Uploads API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_98"}},"responseCodes":["200","400","413"],"pointer":"/files","href":"file-uploads/createfileupload","openApiOperationId":"createFileUpload","summary":"Create a file upload"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://uploads.api.shift4.com/files \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -F \"purpose=dispute_evidence\" \\\n  -F \"file=@evidence.jpg\"\n"},{"lang":"php","label":"PHP","source":"$fileUpload = $gateway->createFileUpload('evidence.jpg', 'dispute_evidence');\n"},{"lang":"java","label":"Java","source":"FileUpload fileUpload = gateway.createFileUpload(\n    new File(\"evidence.jpg\"), FileUploadPurpose.DISPUTE_EVIDENCE);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://uploads.api.shift4.com","description":"Uploads API"}],"schemaId":"schema_98","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_98"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File upload created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters (for example a file that is not a PDF, JPG or PNG)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"]},{"code":"413","description":"Uploaded file exceeds the maximum allowed file size","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/413/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/413/content/application~1json/example"]}],"pointer":"/paths/~1files/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/400/content/application~1json/example"]}}},{"code":"413","schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/413/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1files/post/responses/413/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-uploads/createfileupload"}],"panels":[]}]},"httpPath":"/files"},{"label":"List file uploads","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/file-uploads/listfileuploads","routeSlug":"/docs/api/shift4-gateway/file-uploads/listfileuploads","metadata":{"seo":{"title":"List file uploads","description":"Lists file upload objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFileUploads","name":"List file uploads","isWebhook":false,"pointer":"/paths/~1files/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List file uploads","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists file upload objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"},{"name":"purpose","in":"query","schemaId":"schema_99","description":"Returns only file uploads with a given purpose."}],"pointer":"/paths/~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files","servers":[{"url":"https://uploads.api.shift4.com","description":"Uploads API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"},{"name":"purpose","in":"query","schemaId":"schema_99"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/files","href":"file-uploads/listfileuploads","openApiOperationId":"listFileUploads","summary":"List file uploads"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://uploads.api.shift4.com/files?limit=10\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$fileUploads = $gateway->listFileUploads(array(\n    'limit' => 10\n));\n"},{"lang":"java","label":"Java","source":"FileUploadListRequest request = new FileUploadListRequest()\n    .limit(10);\nListResponse<FileUpload> fileUploads = gateway.listFileUploads(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://uploads.api.shift4.com","description":"Uploads API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of file uploads","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100"}],"pointer":"/paths/~1files/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-uploads/listfileuploads"}],"panels":[]}]},"httpPath":"/files"},{"label":"Retrieve a file upload","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/file-uploads/getfileupload","routeSlug":"/docs/api/shift4-gateway/file-uploads/getfileupload","metadata":{"seo":{"title":"Retrieve a file upload","description":"Retrieves an existing file upload object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFileUpload","name":"Retrieve a file upload","isWebhook":false,"pointer":"/paths/~1files~1{fileUploadId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a file upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing file upload object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fileUploadId","in":"path","schemaId":"schema_58","description":"Identifier of the file upload object that should be retrieved.","required":true}],"pointer":"/paths/~1files~1{fileUploadId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{fileUploadId}","servers":[{"url":"https://uploads.api.shift4.com","description":"Uploads API"}],"parameters":{"path":[{"name":"fileUploadId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/files/{fileUploadId}","href":"file-uploads/getfileupload","openApiOperationId":"getFileUpload","summary":"Retrieve a file upload"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://uploads.api.shift4.com/files/file_2nayTQXBBjaVEPVtCwGCbqOj \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$fileUpload = $gateway->retrieveFileUpload('file_2nayTQXBBjaVEPVtCwGCbqOj');\n"},{"lang":"java","label":"Java","source":"FileUpload fileUpload = gateway.retrieveFileUpload(\"file_2nayTQXBBjaVEPVtCwGCbqOj\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://uploads.api.shift4.com","description":"Uploads API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File upload details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files~1{fileUploadId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files~1{fileUploadId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"File upload not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1files~1{fileUploadId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files~1{fileUploadId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUpload","exampleIds":["paths/~1files~1{fileUploadId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-uploads/getfileupload"}],"panels":[]}]},"httpPath":"/files/{fileUploadId}"}],"content":{"contentType":"group","meta":{"name":"File Uploads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Uploads","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Upload objects are created by uploading a binary file (like an image or PDF document) to Shift4. Such an uploaded file can then be used in other API requests by providing its identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for the file upload API a different API endpoint must be used: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://uploads.api.shift4.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/files","summary":"Create a file upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-uploads/createfileupload","deprecated":false},{"title":"/files","summary":"List file uploads","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-uploads/listfileuploads","deprecated":false},{"title":"/files/{fileUploadId}","summary":"Retrieve a file upload","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-uploads/getfileupload","deprecated":false}]}]}]}]}},{"type":"group","label":"Fraud Warnings","link":"/docs/api/shift4-gateway/fraud-warnings","routeSlug":"/docs/api/shift4-gateway/fraud-warnings","items":[{"label":"List fraud warnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/fraud-warnings/listfraudwarnings","routeSlug":"/docs/api/shift4-gateway/fraud-warnings/listfraudwarnings","metadata":{"seo":{"title":"List fraud warnings","description":"Lists fraud warning objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFraudWarnings","name":"List fraud warnings","isWebhook":false,"pointer":"/paths/~1fraud-warnings/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List fraud warnings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists fraud warning objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"chargeId","in":"query","schemaId":"schema_58","description":"Identifier of the charge object for which fraud warnings should be listed."},{"name":"actionable","in":"query","schemaId":"schema_101","description":"Can be used to list only actionable fraud warnings."},{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1fraud-warnings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fraud-warnings","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"chargeId","in":"query","schemaId":"schema_58"},{"name":"actionable","in":"query","schemaId":"schema_101"},{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/fraud-warnings","href":"fraud-warnings/listfraudwarnings","openApiOperationId":"listFraudWarnings","summary":"List fraud warnings"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/fraud-warnings?limit=3\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$fraudWarnings = $gateway->listFraudWarnings(array(\n    'limit' => 3\n));\n"},{"lang":"java","label":"Java","source":"FraudWarningListRequest request = new FraudWarningListRequest()\n    .limit(3);\nListResponse<FraudWarning> fraudWarnings = gateway.listFraudWarnings(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of fraud warnings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102","exampleIds":["paths/~1fraud-warnings/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_102","exampleIds":["paths/~1fraud-warnings/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1fraud-warnings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_102","exampleIds":["paths/~1fraud-warnings/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102","exampleIds":["paths/~1fraud-warnings/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fraud-warnings/listfraudwarnings"}],"panels":[]}]},"httpPath":"/fraud-warnings"},{"label":"Retrieve a fraud warning","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/fraud-warnings/getfraudwarning","routeSlug":"/docs/api/shift4-gateway/fraud-warnings/getfraudwarning","metadata":{"seo":{"title":"Retrieve a fraud warning","description":"Retrieves an existing fraud warning object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFraudWarning","name":"Retrieve a fraud warning","isWebhook":false,"pointer":"/paths/~1fraud-warnings~1{fraudWarningId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a fraud warning","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing fraud warning object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fraudWarningId","in":"path","schemaId":"schema_58","description":"Identifier of the fraud warning object that should be retrieved.","required":true}],"pointer":"/paths/~1fraud-warnings~1{fraudWarningId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fraud-warnings/{fraudWarningId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"fraudWarningId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/fraud-warnings/{fraudWarningId}","href":"fraud-warnings/getfraudwarning","openApiOperationId":"getFraudWarning","summary":"Retrieve a fraud warning"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/fraud-warnings/fw_O7FRMgfC5g9BFqjEFepcB07J \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$fraudWarning = $gateway->retrieveFraudWarning('fw_O7FRMgfC5g9BFqjEFepcB07J');\n"},{"lang":"java","label":"Java","source":"FraudWarning fraudWarning = gateway.retrieveFraudWarning(\"fw_O7FRMgfC5g9BFqjEFepcB07J\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Fraud warning details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FraudWarning","exampleIds":["paths/~1fraud-warnings~1{fraudWarningId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/FraudWarning","exampleIds":["paths/~1fraud-warnings~1{fraudWarningId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Fraud warning not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1fraud-warnings~1{fraudWarningId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FraudWarning","exampleIds":["paths/~1fraud-warnings~1{fraudWarningId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FraudWarning","exampleIds":["paths/~1fraud-warnings~1{fraudWarningId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fraud-warnings/getfraudwarning"}],"panels":[]}]},"httpPath":"/fraud-warnings/{fraudWarningId}"}],"content":{"contentType":"group","meta":{"name":"Fraud Warnings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fraud Warnings","showPageActions":true},{"nodeType":"markdoc","content":"A fraud warning represents information received from the card issuer regarding a charge. A fraud warning is actionable if its associated charge is not fully refunded or disputed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fraud-warnings","summary":"List fraud warnings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fraud-warnings/listfraudwarnings","deprecated":false},{"title":"/fraud-warnings/{fraudWarningId}","summary":"Retrieve a fraud warning","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fraud-warnings/getfraudwarning","deprecated":false}]}]}]}]}},{"type":"group","label":"Payouts","link":"/docs/api/shift4-gateway/payouts","routeSlug":"/docs/api/shift4-gateway/payouts","items":[{"label":"List payouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/listpayouts","routeSlug":"/docs/api/shift4-gateway/payouts/listpayouts","metadata":{"seo":{"title":"List payouts","description":"Lists payout objects. Results are sorted by payout date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPayouts","name":"List payouts","isWebhook":false,"pointer":"/paths/~1payouts/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payouts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists payout objects. Results are sorted by payout date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1payouts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payouts","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payouts","href":"payouts/listpayouts","openApiOperationId":"listPayouts","summary":"List payouts"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/payouts?limit=3\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$payouts = $gateway->listPayouts(array(\n    'limit' => 3\n));\n"},{"lang":"java","label":"Java","source":"PayoutListRequest request = new PayoutListRequest()\n    .limit(3);\nListResponse<Payout> payouts = gateway.listPayouts(request);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payouts","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103","exampleIds":["paths/~1payouts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_103","exampleIds":["paths/~1payouts/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1payouts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_103","exampleIds":["paths/~1payouts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103","exampleIds":["paths/~1payouts/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payouts/listpayouts"}],"panels":[]}]},"httpPath":"/payouts"},{"label":"Create a test payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/createtestpayout","routeSlug":"/docs/api/shift4-gateway/payouts/createtestpayout","metadata":{"seo":{"title":"Create a test payout","description":"Creates a test payout based on test mode charges, refunds, chargebacks and credits. This endpoint takes no parameters and is only available when using a test API key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTestPayout","name":"Create a test payout","isWebhook":false,"pointer":"/paths/~1payouts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a test payout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a test payout based on test mode charges, refunds, chargebacks and credits. This endpoint takes no parameters and is only available when using a test API key."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payouts","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/payouts","href":"payouts/createtestpayout","openApiOperationId":"createTestPayout","summary":"Create a test payout"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST \"https://api.shift4.com/payouts\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$payout = $gateway->createPayout();\n"},{"lang":"java","label":"Java","source":"Payout payout = gateway.createPayout();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts/post/responses/200/content/application~1json/example"]},{"code":"400","description":"A live mode API key was used","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payouts/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1payouts/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1payouts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1payouts/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1payouts/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payouts/createtestpayout"}],"panels":[]}]},"httpPath":"/payouts"},{"label":"Retrieve a payout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/getpayout","routeSlug":"/docs/api/shift4-gateway/payouts/getpayout","metadata":{"seo":{"title":"Retrieve a payout","description":"Retrieves an existing payout object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayout","name":"Retrieve a payout","isWebhook":false,"pointer":"/paths/~1payouts~1{payoutId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing payout object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payoutId","in":"path","schemaId":"schema_58","description":"Identifier of the payout object that should be retrieved.","required":true}],"pointer":"/paths/~1payouts~1{payoutId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payouts/{payoutId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"payoutId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/payouts/{payoutId}","href":"payouts/getpayout","openApiOperationId":"getPayout","summary":"Retrieve a payout"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/payouts/po_bLu3vzO8yhAFhbxFEadm6HUV \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$payout = $gateway->retrievePayout('po_bLu3vzO8yhAFhbxFEadm6HUV');\n"},{"lang":"java","label":"Java","source":"Payout payout = gateway.retrievePayout(\"po_bLu3vzO8yhAFhbxFEadm6HUV\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts~1{payoutId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts~1{payoutId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Payout not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payouts~1{payoutId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts~1{payoutId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payout","exampleIds":["paths/~1payouts~1{payoutId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payouts/getpayout"}],"panels":[]}]},"httpPath":"/payouts/{payoutId}"},{"label":"List payout transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payouts/listpayouttransactions","routeSlug":"/docs/api/shift4-gateway/payouts/listpayouttransactions","metadata":{"seo":{"title":"List payout transactions","description":"Lists payout transaction objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPayoutTransactions","name":"List payout transactions","isWebhook":false,"pointer":"/paths/~1payout-transactions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payout transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists payout transaction objects. Results are sorted by creation date, with the most recent objects first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter must be provided."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"payout","in":"query","schemaId":"schema_104","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the payout. Only transactions included in this payout will be returned. Optional if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is present."},"children":[]}]}]}]},{"name":"source","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the related object. Only transactions related to this source will be returned. Optional if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is present."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1payout-transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-transactions","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"payout","in":"query","example":"po_bLu3vzO8yhAFhbxFEadm6HUV","schemaId":"schema_104"},{"name":"source","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/payout-transactions","href":"payouts/listpayouttransactions","openApiOperationId":"listPayoutTransactions","summary":"List payout transactions"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/payout-transactions?payout=po_gb48tN1UdWznKQHexcAAlbkK\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"},{"lang":"php","label":"PHP","source":"$payoutTransactions = $gateway->listPayoutTransactions(array(\n    'payout' => 'po_gb48tN1UdWznKQHexcAAlbkK'\n));\n"},{"lang":"java","label":"Java","source":"ListResponse<PayoutTransaction> payoutTransactions =\n    gateway.listPayoutTransactions(\"po_gb48tN1UdWznKQHexcAAlbkK\");\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payout transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105","exampleIds":["paths/~1payout-transactions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_105","exampleIds":["paths/~1payout-transactions/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Neither the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter was provided"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payout-transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_105","exampleIds":["paths/~1payout-transactions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105","exampleIds":["paths/~1payout-transactions/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payouts/listpayouttransactions"}],"panels":[]}]},"httpPath":"/payout-transactions"}],"content":{"contentType":"group","meta":{"name":"Payouts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payouts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payout represents details of funds received from the acquirer. Payouts are made on varying schedules, depending on your acquirer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each payout groups the individual transactions it settles — charges, refunds, chargebacks, reserve movements and fees. These are represented as payout transaction objects and can be listed for a given payout."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payouts","summary":"List payouts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payouts/listpayouts","deprecated":false},{"title":"/payouts","summary":"Create a test payout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payouts/createtestpayout","deprecated":false},{"title":"/payouts/{payoutId}","summary":"Retrieve a payout","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payouts/getpayout","deprecated":false},{"title":"/payout-transactions","summary":"List payout transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payouts/listpayouttransactions","deprecated":false}]}]}]}]}},{"type":"group","label":"Checkout","link":"/docs/api/shift4-gateway/checkout","routeSlug":"/docs/api/shift4-gateway/checkout","items":[{"label":"Create a checkout session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/checkout/createcheckoutsession","routeSlug":"/docs/api/shift4-gateway/checkout/createcheckoutsession","metadata":{"seo":{"title":"Create a checkout session","description":"Creates a new checkout session. Sessions must be created using a secret API key. Pass the returned clientSecret to the checkout.js script to render the payment form, or use the returned url for the Checkout redirect flow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCheckoutSession","name":"Create a checkout session","isWebhook":false,"pointer":"/paths/~1checkout-sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a checkout session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new checkout session. Sessions must be created using a secret API key. Pass the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout.js"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" script to render the payment form, or use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the Checkout redirect flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once created, a session is immutable and cannot be modified. If changes are required, create a new session."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckoutSessionCreate","exampleIds":["paths/~1checkout-sessions/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CheckoutSessionCreate","exampleIds":["paths/~1checkout-sessions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1checkout-sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkout-sessions","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckoutSessionCreate","exampleIds":["paths/~1checkout-sessions/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400"],"pointer":"/checkout-sessions","href":"checkout/createcheckoutsession","openApiOperationId":"createCheckoutSession","summary":"Create a checkout session"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/checkout-sessions \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"locale\": \"en\",\n    \"lineItems\": [\n      {\n        \"product\": {\n          \"name\": \"Premium subscription\",\n          \"amount\": 9900,\n          \"currency\": \"USD\"\n        },\n        \"quantity\": 1\n      }\n    ],\n    \"redirectUrl\": \"https://merchant-page.com/payment-success\"\n  }'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"components/schemas/CheckoutSessionCreate","exampleIds":["paths/~1checkout-sessions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckoutSessionCreate","exampleIds":["paths/~1checkout-sessions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Checkout session details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1checkout-sessions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout/createcheckoutsession"}],"panels":[]}]},"httpPath":"/checkout-sessions"},{"label":"List checkout sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/checkout/listcheckoutsessions","routeSlug":"/docs/api/shift4-gateway/checkout/listcheckoutsessions","metadata":{"seo":{"title":"List checkout sessions","description":"Lists checkout session objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCheckoutSessions","name":"List checkout sessions","isWebhook":false,"pointer":"/paths/~1checkout-sessions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List checkout sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists checkout session objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"charge","in":"query","schemaId":"schema_58","description":"Return only the checkout session related to the given charge identifier."},{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1checkout-sessions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkout-sessions","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"charge","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/checkout-sessions","href":"checkout/listcheckoutsessions","openApiOperationId":"listCheckoutSessions","summary":"List checkout sessions"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/checkout-sessions?limit=3\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of checkout sessions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106","exampleIds":["paths/~1checkout-sessions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_106","exampleIds":["paths/~1checkout-sessions/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1checkout-sessions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","exampleIds":["paths/~1checkout-sessions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106","exampleIds":["paths/~1checkout-sessions/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout/listcheckoutsessions"}],"panels":[]}]},"httpPath":"/checkout-sessions"},{"label":"Retrieve a checkout session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/checkout/getcheckoutsession","routeSlug":"/docs/api/shift4-gateway/checkout/getcheckoutsession","metadata":{"seo":{"title":"Retrieve a checkout session","description":"Retrieves an existing checkout session object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCheckoutSession","name":"Retrieve a checkout session","isWebhook":false,"pointer":"/paths/~1checkout-sessions~1{checkoutSessionId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a checkout session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing checkout session object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"checkoutSessionId","in":"path","schemaId":"schema_58","description":"Identifier of the checkout session object that should be retrieved.","required":true}],"pointer":"/paths/~1checkout-sessions~1{checkoutSessionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkout-sessions/{checkoutSessionId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"checkoutSessionId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/checkout-sessions/{checkoutSessionId}","href":"checkout/getcheckoutsession","openApiOperationId":"getCheckoutSession","summary":"Retrieve a checkout session"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/checkout-sessions/chse_LqM4nJ8vTyRbHwKpZdFcXaS2 \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Checkout session details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions~1{checkoutSessionId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions~1{checkoutSessionId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Checkout session not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1checkout-sessions~1{checkoutSessionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions~1{checkoutSessionId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckoutSession","exampleIds":["paths/~1checkout-sessions~1{checkoutSessionId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkout/getcheckoutsession"}],"panels":[]}]},"httpPath":"/checkout-sessions/{checkoutSessionId}"}],"content":{"contentType":"group","meta":{"name":"Checkout"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checkout","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift4 Checkout allows you to securely collect payments using a hosted payment form."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A checkout session is used to initialize Shift4 Checkout. It represents a server-created configuration that defines what the customer is paying for and how the Checkout form behaves."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sessions must be created using a secret API key and then passed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout.js"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to render the payment form. This server-side creation model allows Shift4 to enforce rate limiting and prevent abuse scenarios such as automated card testing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each session contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute which needs to be passed to the client side to open the Checkout. Once created, a session is immutable and cannot be modified. If changes are required, a new session must be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is also a legacy integration model based on signed checkout requests. Checkout requests are deprecated and will be removed in the future — all new integrations should use checkout sessions. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/checkout/checkout-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkout Request guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/checkout-sessions","summary":"Create a checkout session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/checkout/createcheckoutsession","deprecated":false},{"title":"/checkout-sessions","summary":"List checkout sessions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checkout/listcheckoutsessions","deprecated":false},{"title":"/checkout-sessions/{checkoutSessionId}","summary":"Retrieve a checkout session","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checkout/getcheckoutsession","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Links","link":"/docs/api/shift4-gateway/payment-links","routeSlug":"/docs/api/shift4-gateway/payment-links","items":[{"label":"Create a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/createpaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/createpaymentlink","metadata":{"seo":{"title":"Create a payment link","description":"Creates a new payment link. Every new payment link is active by default. An optional failed-payment limit can be set only at creation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentLink","name":"Create a payment link","isWebhook":false,"pointer":"/paths/~1payment-links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new payment link. Every new payment link is active by default. An optional failed-payment limit can be set only at creation."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentLinkCreate","exampleIds":["paths/~1payment-links/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentLinkCreate","exampleIds":["paths/~1payment-links/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1payment-links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-links","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentLinkCreate","exampleIds":["paths/~1payment-links/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400"],"pointer":"/payment-links","href":"payment-links/createpaymentlink","openApiOperationId":"createPaymentLink","summary":"Create a payment link"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/payment-links \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"returnUrl\": \"https://merchant.example.com/payment/return\",\n    \"lineItems\": [\n      {\n        \"product\": {\n          \"name\": \"Example charge\",\n          \"amount\": 1000,\n          \"currency\": \"USD\"\n        }\n      }\n    ],\n    \"vendorReference\": \"custom_vendor_reference\",\n    \"restrictions\": {\n      \"errors\": {\"limit\": 3}\n    }\n  }'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"components/schemas/PaymentLinkCreate","exampleIds":["paths/~1payment-links/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentLinkCreate","exampleIds":["paths/~1payment-links/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment link details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payment-links/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/createpaymentlink"}],"panels":[]}]},"httpPath":"/payment-links"},{"label":"List payment links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/listpaymentlinks","routeSlug":"/docs/api/shift4-gateway/payment-links/listpaymentlinks","metadata":{"seo":{"title":"List payment links","description":"Lists payment link objects. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentLinks","name":"List payment links","isWebhook":false,"pointer":"/paths/~1payment-links/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists payment link objects. Results are sorted by creation date, with the most recent objects first."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_107","description":"Return only payment links with the given status."},{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1payment-links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-links","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","schemaId":"schema_107"},{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payment-links","href":"payment-links/listpaymentlinks","openApiOperationId":"listPaymentLinks","summary":"List payment links"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl \"https://api.shift4.com/payment-links?limit=3\" \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payment links","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108","exampleIds":["paths/~1payment-links/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_108","exampleIds":["paths/~1payment-links/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1payment-links/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_108","exampleIds":["paths/~1payment-links/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108","exampleIds":["paths/~1payment-links/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/listpaymentlinks"}],"panels":[]}]},"httpPath":"/payment-links"},{"label":"Retrieve a payment link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/getpaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/getpaymentlink","metadata":{"seo":{"title":"Retrieve a payment link","description":"Retrieves an existing payment link object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentLink","name":"Retrieve a payment link","isWebhook":false,"pointer":"/paths/~1payment-links~1{paymentLinkId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing payment link object."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentLinkId","in":"path","schemaId":"schema_58","description":"Identifier of the payment link object.","required":true}],"pointer":"/paths/~1payment-links~1{paymentLinkId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-links/{paymentLinkId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"paymentLinkId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/payment-links/{paymentLinkId}","href":"payment-links/getpaymentlink","openApiOperationId":"getPaymentLink","summary":"Retrieve a payment link"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/payment-links/link_odedW8aombcWuu6VIZulYKny \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment link details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Payment link not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payment-links~1{paymentLinkId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/getpaymentlink"}],"panels":[]}]},"httpPath":"/payment-links/{paymentLinkId}"},{"label":"Update a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/updatepaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/updatepaymentlink","metadata":{"seo":{"title":"Update a payment link","description":"Updates an existing payment link. Attributes not provided in the request are left unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentLink","name":"Update a payment link","isWebhook":false,"pointer":"/paths/~1payment-links~1{paymentLinkId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing payment link. Attributes not provided in the request are left unchanged."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentLinkId","in":"path","schemaId":"schema_58","description":"Identifier of the payment link object.","required":true}],"pointer":"/paths/~1payment-links~1{paymentLinkId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentLinkUpdate","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentLinkUpdate","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1payment-links~1{paymentLinkId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-links/{paymentLinkId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"paymentLinkId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentLinkUpdate","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400"],"pointer":"/payment-links/{paymentLinkId}","href":"payment-links/updatepaymentlink","openApiOperationId":"updatePaymentLink","summary":"Update a payment link"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/payment-links/link_8v6pz2FEOvlDA80wOGhUhP8N \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"lineItems\": [\n      {\n        \"product\": {\n          \"name\": \"Another example charge\",\n          \"amount\": 1000,\n          \"currency\": \"USD\"\n        }\n      }\n    ],\n    \"collectBillingAddress\": true\n  }'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"components/schemas/PaymentLinkUpdate","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentLinkUpdate","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment link details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payment-links~1{paymentLinkId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/updatepaymentlink"}],"panels":[]}]},"httpPath":"/payment-links/{paymentLinkId}"},{"label":"Deactivate a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/deactivatepaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/deactivatepaymentlink","metadata":{"seo":{"title":"Deactivate a payment link","description":"Deactivates an existing payment link. Every new payment link is active by default. Payment links with a limited number of charges are deactivated automatically the moment the limit is reached."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivatePaymentLink","name":"Deactivate a payment link","isWebhook":false,"pointer":"/paths/~1payment-links~1{paymentLinkId}~1deactivate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a payment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivates an existing payment link. Every new payment link is active by default. Payment links with a limited number of charges are deactivated automatically the moment the limit is reached."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentLinkId","in":"path","schemaId":"schema_58","description":"Identifier of the payment link object.","required":true}],"pointer":"/paths/~1payment-links~1{paymentLinkId}~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-links/{paymentLinkId}/deactivate","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"paymentLinkId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/payment-links/{paymentLinkId}/deactivate","href":"payment-links/deactivatepaymentlink","openApiOperationId":"deactivatePaymentLink","summary":"Deactivate a payment link"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/payment-links/link_8v6pz2FEOvlDA80wOGhUhP8N/deactivate \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -X POST\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment link details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1deactivate/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1deactivate/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Payment link not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payment-links~1{paymentLinkId}~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1deactivate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1deactivate/post/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/deactivatepaymentlink"}],"panels":[]}]},"httpPath":"/payment-links/{paymentLinkId}/deactivate"},{"label":"Reactivate a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/reactivatepaymentlink","routeSlug":"/docs/api/shift4-gateway/payment-links/reactivatepaymentlink","metadata":{"seo":{"title":"Reactivate a payment link","description":"Reactivates a deactivated payment link. A payment link cannot be reactivated once its limit of successful charges or failed payment attempts has been reached."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reactivatePaymentLink","name":"Reactivate a payment link","isWebhook":false,"pointer":"/paths/~1payment-links~1{paymentLinkId}~1reactivate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reactivate a payment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reactivates a deactivated payment link. A payment link cannot be reactivated once its limit of successful charges or failed payment attempts has been reached."},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentLinkId","in":"path","schemaId":"schema_58","description":"Identifier of the payment link object.","required":true}],"pointer":"/paths/~1payment-links~1{paymentLinkId}~1reactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-links/{paymentLinkId}/reactivate","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"paymentLinkId","in":"path","required":true,"schemaId":"schema_58"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/payment-links/{paymentLinkId}/reactivate","href":"payment-links/reactivatepaymentlink","openApiOperationId":"reactivatePaymentLink","summary":"Reactivate a payment link"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/payment-links/link_8v6pz2FEOvlDA80wOGhUhP8N/reactivate \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: \\\n  -X POST\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment link details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1reactivate/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1reactivate/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Payment link not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payment-links~1{paymentLinkId}~1reactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1reactivate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentLink","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1reactivate/post/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/reactivatepaymentlink"}],"panels":[]}]},"httpPath":"/payment-links/{paymentLinkId}/reactivate"},{"label":"List charges related to a payment link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/payment-links/listpaymentlinkcharges","routeSlug":"/docs/api/shift4-gateway/payment-links/listpaymentlinkcharges","metadata":{"seo":{"title":"List charges related to a payment link","description":"Lists the charges made through a given payment link. Results are sorted by creation date, with the most recent objects first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentLinkCharges","name":"List charges related to a payment link","isWebhook":false,"pointer":"/paths/~1payment-links~1{paymentLinkId}~1charges/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List charges related to a payment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the charges made through a given payment link. Results are sorted by creation date, with the most recent objects first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To read the custom field values a customer submitted for a given payment, take the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from an entry in this list and pass it to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/checkout/listcheckoutsessions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List checkout sessions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentLinkId","in":"path","schemaId":"schema_58","description":"Identifier of the payment link object.","required":true}],"pointer":"/paths/~1payment-links~1{paymentLinkId}~1charges/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_57","description":"Number of results per page (1-100)"},{"name":"startingAfterId","in":"query","schemaId":"schema_58","description":"Return results starting after the object with this ID"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58","description":"Return results ending before the object with this ID"},{"name":"created[gt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly after this Unix timestamp"},{"name":"created[gte]","in":"query","schemaId":"schema_59","description":"Filter results created at or after this timestamp"},{"name":"created[lt]","in":"query","schemaId":"schema_59","description":"Filter results created strictly before this Unix timestamp"},{"name":"created[lte]","in":"query","schemaId":"schema_59","description":"Filter results created at or before this timestamp"}],"pointer":"/paths/~1payment-links~1{paymentLinkId}~1charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-links/{paymentLinkId}/charges","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"paymentLinkId","in":"path","required":true,"schemaId":"schema_58"}],"query":[{"name":"limit","in":"query","schemaId":"schema_57"},{"name":"startingAfterId","in":"query","schemaId":"schema_58"},{"name":"endingBeforeId","in":"query","schemaId":"schema_58"},{"name":"created[gt]","in":"query","schemaId":"schema_59"},{"name":"created[gte]","in":"query","schemaId":"schema_59"},{"name":"created[lt]","in":"query","schemaId":"schema_59"},{"name":"created[lte]","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/payment-links/{paymentLinkId}/charges","href":"payment-links/listpaymentlinkcharges","openApiOperationId":"listPaymentLinkCharges","summary":"List charges related to a payment link"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/payment-links/link_8v6pz2FEOvlDA80wOGhUhP8N/charges \\\n  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of charges related to the payment link","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1charges/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_109","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1charges/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Payment link not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1payment-links~1{paymentLinkId}~1charges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_109","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1charges/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109","exampleIds":["paths/~1payment-links~1{paymentLinkId}~1charges/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-links/listpaymentlinkcharges"}],"panels":[]}]},"httpPath":"/payment-links/{paymentLinkId}/charges"}],"content":{"contentType":"group","meta":{"name":"Payment Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Links","showPageActions":true},{"nodeType":"markdoc","content":"Payment links allow you to create a URL with a simple checkout. Customers who open the link can either make a single payment or start a subscription, without visiting your website.\n\nA payment link can be reused until it expires or reaches its configured limit of successful charges. Every payment attempt made through a payment link opens a checkout session, which records the values the customer entered into any custom fields."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-links","summary":"Create a payment link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-links/createpaymentlink","deprecated":false},{"title":"/payment-links","summary":"List payment links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-links/listpaymentlinks","deprecated":false},{"title":"/payment-links/{paymentLinkId}","summary":"Retrieve a payment link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-links/getpaymentlink","deprecated":false},{"title":"/payment-links/{paymentLinkId}","summary":"Update a payment link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-links/updatepaymentlink","deprecated":false},{"title":"/payment-links/{paymentLinkId}/deactivate","summary":"Deactivate a payment link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-links/deactivatepaymentlink","deprecated":false},{"title":"/payment-links/{paymentLinkId}/reactivate","summary":"Reactivate a payment link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-links/reactivatepaymentlink","deprecated":false},{"title":"/payment-links/{paymentLinkId}/charges","summary":"List charges related to a payment link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-links/listpaymentlinkcharges","deprecated":false}]}]}]}]}},{"type":"group","label":"Testing","link":"/docs/api/shift4-gateway/testing","routeSlug":"/docs/api/shift4-gateway/testing","items":[{"label":"Resolve status of a pending charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api/shift4-gateway/testing/resolvechargestatus","routeSlug":"/docs/api/shift4-gateway/testing/resolvechargestatus","metadata":{"seo":{"title":"Resolve status of a pending charge","description":"Resolves the status of a pending charge programmatically."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resolveChargeStatus","name":"Resolve status of a pending charge","isWebhook":false,"pointer":"/paths/~1charges~1{clientChargeId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resolve status of a pending charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolves the status of a pending charge programmatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is useful when the payment process is asynchronous and you need to settle its status without performing the real payment flow — for example a confirmation in an external banking application, which is hard to perform in automated tests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge is addressed by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientObjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_char_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rather than its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so the request can be executed with either a secret or a public test API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only pending charges created with a payment method that requires customer confirmation can be resolved this way — for example Blik with code, Swish, MB WAY, and redirect-based payment methods. Charges paid with a card are not supported."},"children":[]}]}]}]},{"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientChargeId","in":"path","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientObjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the charge to resolve. Must be prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_char_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1charges~1{clientChargeId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_111"}},"schemaId":"schema_111","pointer":"/paths/~1charges~1{clientChargeId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/charges/{clientChargeId}","servers":[{"url":"https://api.shift4.com","description":"Production API"}],"parameters":{"path":[{"name":"clientChargeId","in":"path","required":true,"example":"client_char_ORFRrwOrGkGsDwM3H50OICSD","schemaId":"schema_110"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_111"}},"responseCodes":["200","400","404"],"pointer":"/charges/{clientChargeId}","href":"testing/resolvechargestatus","openApiOperationId":"resolveChargeStatus","summary":"Resolve status of a pending charge"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl https://api.shift4.com/charges/client_char_ORFRrwOrGkGsDwM3H50OICSD \\\n  -u pu_test_WVMFC9GFuvm54b0uorifKkCh: \\\n  -d \"status=successful\"\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shift4.com","description":"Production API"}],"schemaId":"schema_111","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_111"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Charge status resolved. Returns a limited view of the charge object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargeClientView","exampleIds":["paths/~1charges~1{clientChargeId}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ChargeClientView","exampleIds":["paths/~1charges~1{clientChargeId}/post/responses/200/content/application~1json/example"]},{"code":"400","description":"The charge cannot be transitioned to the requested status, its payment method does not support confirmation, or the request was made in live mode.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No charge with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientObjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists on this merchant account, or the charge was not created with a payment method (for example a card charge)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1charges~1{clientChargeId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChargeClientView","exampleIds":["paths/~1charges~1{clientChargeId}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargeClientView","exampleIds":["paths/~1charges~1{clientChargeId}/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing/resolvechargestatus"}],"panels":[]}]},"httpPath":"/charges/{clientChargeId}"}],"content":{"contentType":"group","meta":{"name":"Testing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Testing","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some API functionality exists only for testing purposes and is described in this section."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints work in test mode only. They let you drive states that would otherwise depend on an external system — for example confirming a payment in a banking application — which is hard to automate in tests."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/charges/{clientChargeId}","summary":"Resolve status of a pending charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/testing/resolvechargestatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","example":{"error":{"type":"invalid_request","message":"Requested object does not exist"}},"properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error type","enum":["invalid_request","card_error","gateway_error"],"example":"invalid_request"},"code":{"type":"string","description":"Machine-readable error code","example":"invalid_number"},"message":{"type":"string","description":"Human-readable error message","example":"Requested object does not exist"},"chargeId":{"type":"string","description":"ID of the charge associated with this error (if applicable)","example":"char_ORVCrwOrTkGsDwM3H50OIW7Q"}}}}}},"components/schemas/ChargeBase":{"id":"components/schemas/ChargeBase","kind":"json-schema","title":"ChargeBase","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the charge","example":"char_ORVCrwOrTkGsDwM3H50OIW7Q"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the charge was created","example":1701432000},"objectType":{"type":"string","description":"Object type identifier","example":"charge","enum":["charge"]},"amount":{"type":"integer","description":"Charge amount in the smallest currency unit (e.g., cents)","example":499},"amountRefunded":{"type":"integer","description":"Amount refunded so far, in the smallest currency unit","example":0},"currency":{"type":"string","description":"Three-letter ISO 4217 currency code","example":"USD"},"description":{"type":"string","description":"Optional description of the charge","example":"Example charge"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The stored-credential (credential-on-file) indicator sent to the card network, describing how the charge was initiated. This affects how the transaction is flagged for card-scheme stored-credential rules:"},"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":"customer_initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - cardholder-initiated, unscheduled (a customer-initiated payment using a stored credential)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - merchant-initiated, unscheduled (an MIT the merchant triggers without the customer present)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the first charge of a recurring/subscription series (cardholder-initiated, recurring)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subsequent_recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a follow-up charge in a recurring series."},"children":[]}]}]}]}],"enum":["first_recurring","subsequent_recurring","merchant_initiated","customer_initiated"],"example":"customer_initiated"},"status":{"type":"string","description":"Current status of the charge","enum":["successful","pending","failed"],"example":"successful"},"captured":{"type":"boolean","description":"Whether the charge has been captured","example":true},"refunded":{"type":"boolean","description":"Whether the charge has been fully refunded","example":false},"refunds":{"type":"array","description":"List of refunds issued against this charge.","items":{"$ref":"#/components/schemas/Refund"}},"disputed":{"type":"boolean","description":"Whether the charge is currently disputed","example":false},"dispute":{"allOf":[{"$ref":"#/components/schemas/Dispute"}],"description":"The dispute object, present when the charge has been disputed."},"flow":{"allOf":[{"$ref":"#/components/schemas/ChargeFlow"}],"description":"Details of the payment process for payment methods that require additional customer action (redirect, QR code, mobile app, etc.)."},"customerId":{"type":"string","description":"ID of the customer associated with this charge","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"subscriptionId":{"type":"string","description":"ID of the subscription that generated this charge, if any.","example":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5"},"clientObjectId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client-facing identifier that can be used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shift4.js"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the charge status from the browser."},"children":[]}]}]}],"example":"client_char_JeKrBOWDvtRa7KSVuDQ1IBzW"},"options":{"type":"object","description":"Authorization options for the charge.","properties":{"authorizationType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a pre-authorization that can be incremented, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"final"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a standard authorization."},"children":[]}]}]}],"enum":["pre","final"],"example":"final"}}},"metadata":{"type":"object","description":"Set of key-value pairs for storing additional information","additionalProperties":{"type":"string"}},"fraudDetails":{"type":"object","description":"Fraud detection details","properties":{"status":{"type":"string","description":"Overall fraud assessment for the charge.","enum":["safe","suspicious","fraudulent"],"example":"safe"},"score":{"type":"integer","description":"Percentage chance (0-100) that the charge is fraudulent.","example":0}}},"arn":{"type":"string","description":"Acquirer Reference Number assigned to the settled transaction.","example":"1087908829370718"},"schemeTransactionId":{"type":"string","description":"Identifier of the transaction in the card scheme's network.","example":"MCC123456789012"},"paymentAccountReference":{"type":"string","description":"Payment Account Reference (PAR) - a unique, 29-character non-sensitive identifier that links a credit or debit card's Primary Account Number (PAN) to its associated payment tokens.","example":"V0010013819982170748000000001"},"aft":{"allOf":[{"$ref":"#/components/schemas/Aft"}],"description":"Account Funding Transaction details, for charges that move funds to another account."},"authCode":{"type":"string","description":"Authorization code returned by the issuer.","example":"123456"},"threeDSecureInfo":{"type":"object","description":"3D Secure verification details","properties":{"amount":{"type":"integer","description":"Amount (minor units) used in 3D Secure.","example":499},"currency":{"type":"string","description":"Currency used in 3D Secure.","example":"USD"},"enrolled":{"type":"boolean","description":"Whether the card used supports 3D Secure.","example":false},"liabilityShift":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the liability shift: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not started/in progress), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successful"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supported but not completed), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_possible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not supported)."},"children":[]}]}]}],"enum":["successful","failed","not_possible"],"example":"not_possible"},"resultReason":{"type":"string","description":"Reason for a liability shift error.","enum":["rejected","abandoned"],"example":"rejected"},"authenticationFlow":{"type":"string","description":"How the issuer authenticated the customer.","enum":["frictionless","challenge"],"example":"frictionless"},"version":{"type":"string","description":"3D Secure protocol version.","example":"2.2.0"}}},"avsCheck":{"type":"object","description":"Address Verification Service result, present if the address was verified.","properties":{"result":{"type":"string","enum":["full_match","partial_match","no_match","not_provided","unavailable"],"example":"unavailable"}}},"aniCheck":{"type":"object","description":"Account Name Inquiry result (Visa). Returned only with zero authentication requests.","properties":{"result":{"type":"string","enum":["full_match","partial_match","no_match","not_verified","not_supported"],"example":"full_match"}}},"cvvCheck":{"type":"object","description":"CVV/CVC verification result.","properties":{"result":{"type":"string","enum":["match","no_match","not_verified","not_provided","not_supported"],"example":"match"}}},"failureCode":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code describing why the charge failed. Only present in failed charges; see the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute of the error object for possible values."},"children":[]}]}]}],"example":null},"failureMessage":{"type":"string","nullable":true,"description":"Human-readable message describing why the charge failed. Only present in failed charges.","example":null},"failureIssuerDeclineCode":{"type":"string","description":"Decline code supplied by the card issuer. Only present in failed charges."},"adviceCode":{"type":"string","nullable":true,"description":"Advice on how to proceed with a declined charge. Only present for declined charges.","enum":["do_not_try_again"],"example":null},"networkAdviceCode":{"type":"string","description":"Raw advice code received from the issuer or card network. Only present for declined charges."},"collectionMode":{"type":"string","description":"How the order was collected for this charge.","enum":["online_order","telephone_order","mail_order"],"example":"online_order"},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"},"external":{"type":"object","description":"External references attached to the charge.","properties":{"vendorReference":{"type":"string","description":"Additional transaction identifier used throughout Shift4's systems.","example":"custom_vendor_reference"},"transactionLinkId":{"type":"string","description":"Identifier linking this charge to an earlier transaction in the card scheme's network. Returned whenever one is available, whether Shift4 established the link itself or it was supplied on the request. Worth retaining if this series of payments may later be continued with another provider.","example":"rO4mY9DvTGmchQ7hnSoKNg"}}},"multibanco":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information for Multibanco payments. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multibanco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"reference":{"type":"string","description":"The reference of the Multibanco transaction.","example":"123456789"},"entity":{"type":"string","description":"Identifies the receiving entity of the transaction.","example":"12345"}}},"splits":{"type":"array","description":"List of charge splits, present when the charge amount was split across multiple recipients (platforms). Charge splits require a platform account, so this attribute is absent for merchants that are not part of a platform.","items":{"$ref":"#/components/schemas/ChargeSplit"}},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account used to process this charge.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"}}}},"components/schemas/Charge":{"id":"components/schemas/Charge","kind":"json-schema","title":"Charge","data":{"title":"Charge","oneOf":[{"$ref":"#/components/schemas/ChargeWithCard"},{"$ref":"#/components/schemas/ChargeWithAch"},{"$ref":"#/components/schemas/ChargeWithAlipay"},{"$ref":"#/components/schemas/ChargeWithApplePay"},{"$ref":"#/components/schemas/ChargeWithBancontact"},{"$ref":"#/components/schemas/ChargeWithBitpay"},{"$ref":"#/components/schemas/ChargeWithBlikCode"},{"$ref":"#/components/schemas/ChargeWithBlikRedirect"},{"$ref":"#/components/schemas/ChargeWithBoleto"},{"$ref":"#/components/schemas/ChargeWithEps"},{"$ref":"#/components/schemas/ChargeWithEstonianbanks"},{"$ref":"#/components/schemas/ChargeWithGooglePay"},{"$ref":"#/components/schemas/ChargeWithIdeal"},{"$ref":"#/components/schemas/ChargeWithLatvianbanks"},{"$ref":"#/components/schemas/ChargeWithLithuanianbanks"},{"$ref":"#/components/schemas/ChargeWithMaxima"},{"$ref":"#/components/schemas/ChargeWithMbWayPhoneNumber"},{"$ref":"#/components/schemas/ChargeWithMbWayRedirect"},{"$ref":"#/components/schemas/ChargeWithMultibanco"},{"$ref":"#/components/schemas/ChargeWithMybank"},{"$ref":"#/components/schemas/ChargeWithPrzelewy24"},{"$ref":"#/components/schemas/ChargeWithPaypost"},{"$ref":"#/components/schemas/ChargeWithPaysafecash"},{"$ref":"#/components/schemas/ChargeWithPaysafecard"},{"$ref":"#/components/schemas/ChargeWithPaysera"},{"$ref":"#/components/schemas/ChargeWithPayu"},{"$ref":"#/components/schemas/ChargeWithPerlas"},{"$ref":"#/components/schemas/ChargeWithSkrill"},{"$ref":"#/components/schemas/ChargeWithSwishQrCode"},{"$ref":"#/components/schemas/ChargeWithSwishMobileAppRedirect"},{"$ref":"#/components/schemas/ChargeWithSwishPhoneNumber"},{"$ref":"#/components/schemas/ChargeWith3dSecure"},{"$ref":"#/components/schemas/ChargeWithTrustly"},{"$ref":"#/components/schemas/ChargeWithUnionpay"},{"$ref":"#/components/schemas/ChargeWithVerkkopankki"},{"$ref":"#/components/schemas/ChargeWithWechatpay"}]}},"components/schemas/ChargeWithCard":{"id":"components/schemas/ChargeWithCard","kind":"json-schema","title":"Card","data":{"title":"Card","example":{"id":"char_ORVCrwOrTkGsDwM3H50OIW7Q","created":1701432000,"objectType":"charge","amount":499,"amountRefunded":0,"currency":"USD","description":"Example charge","type":"customer_initiated","status":"successful","captured":true,"refunded":false,"disputed":false,"card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","brand":"Visa","type":"Credit Card","country":"US","issuer":"Card Issuer Name","merchantAccountId":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","fraudDetails":{"status":"safe","score":0},"arn":"1087908829370718","paymentAccountReference":"V0010013819982170748000000001","billing":{"name":"John Doe"},"threeDSecureInfo":{"amount":499,"currency":"USD","enrolled":false,"liabilityShift":"not_possible","version":"2.2.0"},"avsCheck":{"result":"unavailable"},"cvvCheck":{"result":"match"},"clientObjectId":"client_char_JeKrBOWDvtRa7KSVuDQ1IBzW","merchantAccountId":"ma_RHCN1yhubdBpSCgKcYAGb0xH","aft":{"funding":"supported","sender":{"firstName":"Jane","lastName":"Roe","dateOfBirth":"1990-09-30","referenceNumber":"ref_5647382910","sourceOfFunds":"deposit_account","address":{"line1":"1234 Market St","zip":"94103","city":"San Francisco","state":"CA","country":"US"}},"recipient":{"firstName":"John","lastName":"Doe","dateOfBirth":"1985-04-12","accountNumberMasked":"**********1234","cardId":"card_j2mzocqk3zsdcmxpszkqm3l7","address":{"line1":"456 Oak Ave","zip":"90001","city":"Los Angeles","state":"CA","country":"US"}}},"metadata":{}},"allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["card"],"properties":{"card":{"allOf":[{"$ref":"#/components/schemas/Card"}],"description":"The card used for this charge."}}}]}},"components/schemas/ChargeWithAch":{"id":"components/schemas/ChargeWithAch","kind":"json-schema","title":"ACH","data":{"title":"ACH","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodAch"},{"type":"object","required":["type"],"properties":{"type":{"enum":["ach"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithAlipay":{"id":"components/schemas/ChargeWithAlipay","kind":"json-schema","title":"Alipay","data":{"title":"Alipay","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodAlipay"},{"type":"object","required":["type"],"properties":{"type":{"enum":["alipay"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithApplePay":{"id":"components/schemas/ChargeWithApplePay","kind":"json-schema","title":"Apple pay","data":{"title":"Apple pay","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodApplePay"},{"type":"object","required":["type"],"properties":{"type":{"enum":["apple_pay"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithBancontact":{"id":"components/schemas/ChargeWithBancontact","kind":"json-schema","title":"Bancontact","data":{"title":"Bancontact","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodBancontact"},{"type":"object","required":["type"],"properties":{"type":{"enum":["bancontact"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithBitpay":{"id":"components/schemas/ChargeWithBitpay","kind":"json-schema","title":"Bitpay","data":{"title":"Bitpay","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodBitpay"},{"type":"object","required":["type"],"properties":{"type":{"enum":["bitpay"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithBlikCode":{"id":"components/schemas/ChargeWithBlikCode","kind":"json-schema","title":"Blik (Code)","data":{"title":"Blik (Code)","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodBlikCode"},{"type":"object","required":["type"],"properties":{"type":{"enum":["blik"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithBlikRedirect":{"id":"components/schemas/ChargeWithBlikRedirect","kind":"json-schema","title":"Blik (Redirect)","data":{"title":"Blik (Redirect)","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodBlikRedirect"},{"type":"object","required":["type"],"properties":{"type":{"enum":["blik"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithBoleto":{"id":"components/schemas/ChargeWithBoleto","kind":"json-schema","title":"Boleto","data":{"title":"Boleto","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodBoleto"},{"type":"object","required":["type"],"properties":{"type":{"enum":["boleto"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithEps":{"id":"components/schemas/ChargeWithEps","kind":"json-schema","title":"Eps","data":{"title":"Eps","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodEps"},{"type":"object","required":["type"],"properties":{"type":{"enum":["eps"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithEstonianbanks":{"id":"components/schemas/ChargeWithEstonianbanks","kind":"json-schema","title":"Estonianbanks","data":{"title":"Estonianbanks","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodEstonianbanks"},{"type":"object","required":["type"],"properties":{"type":{"enum":["estonianbanks"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithGooglePay":{"id":"components/schemas/ChargeWithGooglePay","kind":"json-schema","title":"Google Pay","data":{"title":"Google Pay","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodGooglePay"},{"type":"object","required":["type"],"properties":{"type":{"enum":["google_pay"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithIdeal":{"id":"components/schemas/ChargeWithIdeal","kind":"json-schema","title":"Ideal","data":{"title":"Ideal","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodIdeal"},{"type":"object","required":["type"],"properties":{"type":{"enum":["ideal"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithLatvianbanks":{"id":"components/schemas/ChargeWithLatvianbanks","kind":"json-schema","title":"Latvianbanks","data":{"title":"Latvianbanks","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodLatvianbanks"},{"type":"object","required":["type"],"properties":{"type":{"enum":["latvianbanks"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithLithuanianbanks":{"id":"components/schemas/ChargeWithLithuanianbanks","kind":"json-schema","title":"Lithuanianbanks","data":{"title":"Lithuanianbanks","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodLithuanianbanks"},{"type":"object","required":["type"],"properties":{"type":{"enum":["lithuanianbanks"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithMaxima":{"id":"components/schemas/ChargeWithMaxima","kind":"json-schema","title":"Maxima","data":{"title":"Maxima","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodMaxima"},{"type":"object","required":["type"],"properties":{"type":{"enum":["maxima"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithMbWayPhoneNumber":{"id":"components/schemas/ChargeWithMbWayPhoneNumber","kind":"json-schema","title":"MB Way (phone number)","data":{"title":"MB Way (phone number)","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodMbWayPhoneNumber"},{"type":"object","required":["type"],"properties":{"type":{"enum":["mbway"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithMbWayRedirect":{"id":"components/schemas/ChargeWithMbWayRedirect","kind":"json-schema","title":"MB Way (redirect)","data":{"title":"MB Way (redirect)","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodMbWayRedirect"},{"type":"object","required":["type"],"properties":{"type":{"enum":["mbway"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithMultibanco":{"id":"components/schemas/ChargeWithMultibanco","kind":"json-schema","title":"Multibanco","data":{"title":"Multibanco","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodMultibanco"},{"type":"object","required":["type"],"properties":{"type":{"enum":["multibanco"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithMybank":{"id":"components/schemas/ChargeWithMybank","kind":"json-schema","title":"Mybank","data":{"title":"Mybank","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodMybank"},{"type":"object","required":["type"],"properties":{"type":{"enum":["mybank"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithPrzelewy24":{"id":"components/schemas/ChargeWithPrzelewy24","kind":"json-schema","title":"Przelewy24","data":{"title":"Przelewy24","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodPrzelewy24"},{"type":"object","required":["type"],"properties":{"type":{"enum":["p24"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithPaypost":{"id":"components/schemas/ChargeWithPaypost","kind":"json-schema","title":"Paypost","data":{"title":"Paypost","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodPaypost"},{"type":"object","required":["type"],"properties":{"type":{"enum":["paypost"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithPaysafecash":{"id":"components/schemas/ChargeWithPaysafecash","kind":"json-schema","title":"Paysafecash","data":{"title":"Paysafecash","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodPaysafecash"},{"type":"object","required":["type"],"properties":{"type":{"enum":["paysafecash"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithPaysafecard":{"id":"components/schemas/ChargeWithPaysafecard","kind":"json-schema","title":"Paysafecard","data":{"title":"Paysafecard","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodPaysafecard"},{"type":"object","required":["type"],"properties":{"type":{"enum":["paysafecard"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithPaysera":{"id":"components/schemas/ChargeWithPaysera","kind":"json-schema","title":"Paysera","data":{"title":"Paysera","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodPaysera"},{"type":"object","required":["type"],"properties":{"type":{"enum":["paysera"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithPayu":{"id":"components/schemas/ChargeWithPayu","kind":"json-schema","title":"Payu","data":{"title":"Payu","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodPayu"},{"type":"object","required":["type"],"properties":{"type":{"enum":["payu"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithPerlas":{"id":"components/schemas/ChargeWithPerlas","kind":"json-schema","title":"Perlas","data":{"title":"Perlas","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodPerlas"},{"type":"object","required":["type"],"properties":{"type":{"enum":["perlas"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithSkrill":{"id":"components/schemas/ChargeWithSkrill","kind":"json-schema","title":"Skrill","data":{"title":"Skrill","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodSkrill"},{"type":"object","required":["type"],"properties":{"type":{"enum":["skrill"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithSwishQrCode":{"id":"components/schemas/ChargeWithSwishQrCode","kind":"json-schema","title":"Swish (QR code)","data":{"title":"Swish (QR code)","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodSwishQrCode"},{"type":"object","required":["type"],"properties":{"type":{"enum":["swish"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithSwishMobileAppRedirect":{"id":"components/schemas/ChargeWithSwishMobileAppRedirect","kind":"json-schema","title":"Swish (mobile app redirect)","data":{"title":"Swish (mobile app redirect)","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodSwishMobileAppRedirect"},{"type":"object","required":["type"],"properties":{"type":{"enum":["swish"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithSwishPhoneNumber":{"id":"components/schemas/ChargeWithSwishPhoneNumber","kind":"json-schema","title":"Swish (phone number)","data":{"title":"Swish (phone number)","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodSwishPhoneNumber"},{"type":"object","required":["type"],"properties":{"type":{"enum":["swish"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWith3dSecure":{"id":"components/schemas/ChargeWith3dSecure","kind":"json-schema","title":"3D Secure","data":{"title":"3D Secure","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethod3dSecure"},{"type":"object","required":["type"],"properties":{"type":{"enum":["three_d_secure"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithTrustly":{"id":"components/schemas/ChargeWithTrustly","kind":"json-schema","title":"Trustly","data":{"title":"Trustly","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodTrustly"},{"type":"object","required":["type"],"properties":{"type":{"enum":["trustly"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithUnionpay":{"id":"components/schemas/ChargeWithUnionpay","kind":"json-schema","title":"Unionpay","data":{"title":"Unionpay","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodUnionpay"},{"type":"object","required":["type"],"properties":{"type":{"enum":["unionpay"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithVerkkopankki":{"id":"components/schemas/ChargeWithVerkkopankki","kind":"json-schema","title":"Verkkopankki","data":{"title":"Verkkopankki","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodVerkkopankki"},{"type":"object","required":["type"],"properties":{"type":{"enum":["verkkopankki"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeWithWechatpay":{"id":"components/schemas/ChargeWithWechatpay","kind":"json-schema","title":"Wechatpay","data":{"title":"Wechatpay","allOf":[{"$ref":"#/components/schemas/ChargeBase"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodWechatpay"},{"type":"object","required":["type"],"properties":{"type":{"enum":["wechatpay"]}}}],"description":"The payment method used for this charge."}}}]}},"components/schemas/ChargeFlow":{"id":"components/schemas/ChargeFlow","kind":"json-schema","title":"ChargeFlow","data":{"type":"object","description":"Payment-process details for charges that need additional customer action before completion (redirect, QR code, or mobile app confirmation).","properties":{"nextAction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the client must do next. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (send the customer to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow.redirect.redirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wait"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (payment processing, poll for change), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qr_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow.qrCode.imgSrc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobile_app_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (customer confirms in the Swish app)."},"children":[]}]}]}],"enum":["redirect","wait","qr_code","app_redirect","mobile_app_confirmation","none"],"example":"redirect"},"returnUrl":{"type":"string","description":"URL the customer is redirected to after completing the payment.","example":"https://example.com/return"},"qrCode":{"type":"object","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":"nextAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qr_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"imgSrc":{"type":"string","description":"Base64-encoded QR code image to display to the customer. The QR code encodes the URL that opens the Swish mobile application.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."}}},"redirect":{"type":"object","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":"nextAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app_redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"redirectUrl":{"type":"string","description":"URL the customer should be redirected to in order to complete the payment.","example":"https://external-bank.example.com/authorize/abc123"}}}}}},"components/schemas/ChargeClientView":{"id":"components/schemas/ChargeClientView","kind":"json-schema","title":"ChargeClientView","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A limited view of a charge object, returned when a charge is addressed by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientObjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Because this representation can be requested with a public API key, it exposes only the attributes needed to follow the payment process — it never includes the charge "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", customer or card details, or metadata."},"children":[]}]}]}],"properties":{"objectType":{"type":"string","description":"Type of the object","enum":["charge"],"example":"charge"},"clientObjectId":{"type":"string","description":"Client-side identifier of the charge.","example":"client_char_ORFRrwOrGkGsDwM3H50OICSD"},"amount":{"type":"integer","description":"Amount of the charge in minor units of the charge currency.","example":100},"currency":{"type":"string","description":"Three-letter ISO currency code representing the currency of the charge.","example":"USD"},"status":{"type":"string","description":"Status of the payment process.","enum":["successful","pending","failed"],"example":"successful"},"description":{"type":"string","description":"Description of the charge.","example":"Order #1234"},"paymentMethod":{"type":"object","description":"Limited view of the payment method used to create the charge. Present for payment-method charges only.","properties":{"objectType":{"type":"string","enum":["payment_method"],"example":"payment_method"},"clientObjectId":{"type":"string","description":"Client-side identifier of the payment method.","example":"client_pm_SdwbMm2nBFmAldpgJWBuqAeF"},"type":{"type":"string","description":"Type of the payment method.","example":"blik"},"status":{"type":"string","description":"Status of the payment method.","example":"chargeable"},"flow":{"type":"object","description":"Describes the next action required to progress the payment method setup.","properties":{"nextAction":{"type":"string","example":"none"}}}}},"flow":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment-process details for charges that need additional customer action before completion. Unlike the full charge object, this view never includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow.returnUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"nextAction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the client must do next. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (send the customer to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow.redirect.redirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wait"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (payment processing, poll for change), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qr_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow.qrCode.imgSrc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobile_app_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (customer confirms in the Swish app)."},"children":[]}]}]}],"enum":["redirect","wait","qr_code","app_redirect","mobile_app_confirmation","none"],"example":"none"},"qrCode":{"type":"object","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":"nextAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qr_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"imgSrc":{"type":"string","description":"Base64-encoded QR code image to display to the customer. The QR code encodes the URL that opens the Swish mobile application.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."}}},"redirect":{"type":"object","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":"nextAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app_redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"redirectUrl":{"type":"string","description":"URL the customer should be redirected to in order to complete the payment.","example":"https://external-bank.example.com/authorize/abc123"}}}}}}}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the customer","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"created":{"type":"integer","description":"Unix timestamp when the customer was created","example":1711929600},"objectType":{"type":"string","description":"Object type identifier","example":"customer","enum":["customer"]},"email":{"type":"string","description":"Customer email address","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"Customer phone number","example":"+14155550132"},"description":{"type":"string","description":"Optional description","example":"Premium customer"},"defaultCardId":{"type":"string","description":"ID of the default card used for charges created for this customer","example":"card_8P7OWXA5xiTS1ISnyZcum1KV"},"defaultPaymentMethodId":{"type":"string","description":"ID of the default payment method used for charges created for this customer","example":"pm_ORVCP4nH7Lk2QkYp"},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":"Billing details associated with the customer."},"cards":{"type":"array","description":"List of cards associated with this customer","items":{"$ref":"#/components/schemas/Card"}},"metadata":{"type":"object","description":"Set of key-value pairs","additionalProperties":{"type":"string"}}}}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the card","example":"card_8P7OWXA5xiTS1ISnyZcum1KV"},"created":{"type":"integer","description":"Unix timestamp","example":1711929600},"objectType":{"type":"string","example":"card","enum":["card"]},"first6":{"type":"string","description":"First six digits of the card number","example":"424242"},"last4":{"type":"string","description":"Last four digits of the card number","example":"4242"},"fingerprint":{"type":"string","description":"Unique fingerprint for this card number","example":"e3d8suyIDgFg3pE7"},"expMonth":{"type":"string","description":"Two-digit expiration month","example":"12"},"expYear":{"type":"string","description":"Four-digit expiration year","example":"2027"},"cardholderName":{"type":"string","description":"Name of the cardholder","example":"John Doe"},"brand":{"type":"string","description":"Card brand","enum":["Visa","MasterCard","American Express","Discover","JCB","Diners Club","Unknown"],"example":"Visa"},"type":{"type":"string","description":"Card type","enum":["Credit Card","Debit Card","Prepaid Card","Unknown"],"example":"Credit Card"},"country":{"type":"string","description":"Two-letter ISO 3166-1 country code of the card's issuing country","example":"US"},"issuer":{"type":"string","description":"Name of the bank that issued the card","example":"Card Issuer Name"},"customerId":{"type":"string","description":"ID of the customer this card belongs to, if any","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"fraudCheckData":{"allOf":[{"$ref":"#/components/schemas/FraudCheckData"}],"description":"Fraud-protection data captured when the card was created."},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account used to create this card.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"addressLine1":{"type":"string","description":"First line of the billing address associated with the card.","example":"1234 Market St"},"addressLine2":{"type":"string","description":"Second line of the billing address associated with the card.","example":"Suite 500"},"addressCity":{"type":"string","description":"City of the billing address associated with the card.","example":"San Francisco"},"addressState":{"type":"string","description":"State of the billing address associated with the card.","example":"CA"},"addressZip":{"type":"string","description":"ZIP or postal code of the billing address associated with the card.","example":"94103"},"addressCountry":{"type":"string","description":"Country of the billing address associated with the card, represented as a three-letter ISO country code.","example":"USA"},"fastCredit":{"allOf":[{"$ref":"#/components/schemas/FastCredit"}],"description":"Fast credit (fast payout) support status for this card."}}}},"components/schemas/FastCredit":{"id":"components/schemas/FastCredit","kind":"json-schema","title":"FastCredit","data":{"type":"object","description":"Indicates whether a card supports fast credit (fast payouts).","properties":{"supported":{"type":"boolean","description":"Indicates whether the card supports fast credit.","example":true},"updated":{"type":"integer","description":"Unix timestamp of the last time the fast credit status was refreshed.","example":1701432000}}}},"components/schemas/CardCreate":{"id":"components/schemas/CardCreate","kind":"json-schema","title":"CardCreate","data":{"type":"object","description":"Raw card details used to create a card.","required":["number","expMonth","expYear","cvc"],"properties":{"number":{"type":"string","description":"The card number.","example":"4242424242424242"},"expMonth":{"type":"string","description":"Two-digit expiration month.","example":"12"},"expYear":{"type":"string","description":"Four-digit expiration year.","example":"2030"},"cvc":{"type":"string","description":"Card verification code.","example":"123"},"cardholderName":{"type":"string","description":"Name of the cardholder.","example":"John Doe"},"addressLine1":{"type":"string","example":"1234 Market St"},"addressLine2":{"type":"string","example":"Suite 500"},"addressCity":{"type":"string","example":"San Francisco"},"addressState":{"type":"string","example":"CA"},"addressZip":{"type":"string","example":"94103"},"addressCountry":{"type":"string","description":"Country represented as a three-letter ISO country code.","example":"USA"},"fraudCheckData":{"$ref":"#/components/schemas/FraudCheckData"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","description":"A postal address.","properties":{"line1":{"type":"string","example":"1234 Market St"},"line2":{"type":"string","example":"Suite 500"},"zip":{"type":"string","example":"94103"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"CA"},"country":{"type":"string","description":"Two-letter ISO 3166-1 country code","example":"US"}}}},"components/schemas/Billing":{"id":"components/schemas/Billing","kind":"json-schema","title":"Billing","data":{"type":"object","description":"Billing details for the payer.","properties":{"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@example.com"},"phone":{"type":"string","example":"+14155550132"},"vat":{"type":"string","description":"Tax identification number","example":"US123456789"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/Shipping":{"id":"components/schemas/Shipping","kind":"json-schema","title":"Shipping","data":{"type":"object","description":"Shipping details for the order.","properties":{"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"+14155550132"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/FraudCheckData":{"id":"components/schemas/FraudCheckData","kind":"json-schema","title":"FraudCheckData","data":{"type":"object","description":"Additional data used for fraud protection.","properties":{"ipAddress":{"type":"string","description":"IP address of the user.","example":"203.0.113.42"},"ipCountry":{"type":"string","description":"Country derived from the user's IP address (two-letter ISO country code).","example":"US"},"email":{"type":"string","description":"E-mail address of the user.","example":"john.doe@example.com"},"phone":{"type":"string","description":"Phone number of the user.","example":"+14155550132"},"userAgent":{"type":"string","description":"Value of the \"User-Agent\" HTTP header sent by the user.","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"},"acceptLanguage":{"type":"string","description":"Value of the \"Accept-Language\" HTTP header sent by the user.","example":"en-US,en;q=0.9"},"browserFingerprint":{"type":"string","description":"Hashed device identifier, available if Shift4.js was used to create the token.","example":"35a05229011ab99930545a2e1b2edc4e"}}}},"components/schemas/Recipient":{"id":"components/schemas/Recipient","kind":"json-schema","title":"Recipient","data":{"type":"object","description":"Details of the recipient of the funds. Required for account-funding / top-up (OCT) transactions.","required":["firstName","lastName","accountNumber","address"],"properties":{"firstName":{"type":"string","description":"Recipient's first name.","example":"John"},"lastName":{"type":"string","description":"Recipient's last name.","example":"Doe"},"accountNumber":{"type":"string","description":"Identifier of the account being topped up in the merchant's system.","example":"acct_1029384756"},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's date of birth in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"1985-04-12"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/Sender":{"id":"components/schemas/Sender","kind":"json-schema","title":"Sender","data":{"type":"object","description":"Details of the sender of the funds. Required only when the sender differs from the recipient (account-funding / top-up transactions).","required":["firstName","lastName","dateOfBirth","referenceNumber","source","address"],"properties":{"firstName":{"type":"string","description":"Sender's first name.","example":"Jane"},"lastName":{"type":"string","description":"Sender's last name.","example":"Roe"},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's date of birth in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"1990-09-30"},"referenceNumber":{"type":"string","description":"Identifier of the sender's account in the merchant's system.","example":"ref_5647382910"},"source":{"$ref":"#/components/schemas/SourceOfFunds"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/Aft":{"id":"components/schemas/Aft","kind":"json-schema","title":"Aft","data":{"type":"object","description":"Account Funding Transaction (AFT) details. An AFT is a transaction that moves funds from a card account to another account - for example funding a wallet, a crypto purchase, a forex account, or a money transfer. It is processed as a standard purchase with additional scheme-required information about who is sending and who is receiving the funds.\n\nReturned only for charges processed through Credorax, and only when sender or recipient details were supplied on the charge. Charges routed to other processors never include this object, even when they are account-funding transactions.","properties":{"funding":{"type":"string","description":"Whether the card scheme processed this charge as an Account Funding Transaction.","enum":["supported","not_supported"],"example":"supported","x-enumDescriptions":{"supported":"The transaction was processed as an AFT.","not_supported":"The transaction was not processed as an AFT."}},"sender":{"allOf":[{"$ref":"#/components/schemas/AftSender"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The party sending the funds. Echoes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details supplied on the charge request."},"children":[]}]}]}]},"recipient":{"allOf":[{"$ref":"#/components/schemas/AftRecipient"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The party receiving the funds. Echoes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details supplied on the charge request."},"children":[]}]}]}]}}}},"components/schemas/AftSender":{"id":"components/schemas/AftSender","kind":"json-schema","title":"AftSender","data":{"type":"object","description":"The party sending the funds in an account-funding transaction.","properties":{"firstName":{"type":"string","description":"Sender's first name.","example":"Jane"},"lastName":{"type":"string","description":"Sender's last name.","example":"Roe"},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's date of birth in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"1990-09-30"},"referenceNumber":{"type":"string","description":"The merchant's own identifier for the sender. Required for AFTs related to South Africa.","example":"ref_5647382910"},"sourceOfFunds":{"$ref":"#/components/schemas/SourceOfFunds"},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Sender's address. State is required in the US and Canada; ZIP is required when the country is the US or Canada."}}}},"components/schemas/AftRecipient":{"id":"components/schemas/AftRecipient","kind":"json-schema","title":"AftRecipient","data":{"type":"object","description":"The party receiving the funds in an account-funding transaction.","properties":{"firstName":{"type":"string","description":"Recipient's first name.","example":"John"},"lastName":{"type":"string","description":"Recipient's last name.","example":"Doe"},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's date of birth in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"1985-04-12"},"accountNumberMasked":{"type":"string","description":"The account being funded, masked to the last four characters. When a card number was supplied, it cannot be the card being charged.","example":"**********1234"},"cardId":{"type":"string","description":"Identifier of the card the funds were sent to, when the recipient account was supplied as a card.","example":"card_j2mzocqk3zsdcmxpszkqm3l7"},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Recipient's address. Street and city are required in Canada, the US, Colombia and Nicaragua, and whenever the recipient is also the sender; state is required in those same four countries; ZIP is required when the country is the US or Canada."}}}},"components/schemas/SourceOfFunds":{"id":"components/schemas/SourceOfFunds","kind":"json-schema","title":"SourceOfFunds","data":{"type":"string","description":"Where the money being transferred came from. Required for AFTs in the US.","enum":["credit_card","debit_card","prepaid_card","cash","deposit_account","credit_account","mobile_money_account"],"example":"deposit_account","x-enumDescriptions":{"deposit_account":"A debit or deposit account."}}},"components/schemas/ChargeSplitCreate":{"id":"components/schemas/ChargeSplitCreate","kind":"json-schema","title":"ChargeSplitCreate","data":{"type":"object","description":"A single split of the charge amount to another (platform) merchant.","required":["type","merchant","amount"],"properties":{"type":{"type":"string","description":"Split type.","enum":["tip"],"example":"tip"},"merchant":{"type":"string","description":"Identifier of the platform merchant the money is transferred to.","example":"mrc_gTDpVZkFqOqSqD3MWRQkGYI7"},"amount":{"type":"integer","description":"Amount to transfer, in the smallest currency unit. Must be positive.","example":100}}}},"components/schemas/Refund":{"id":"components/schemas/Refund","kind":"json-schema","title":"Refund","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the refund","example":"re_bYBGkBSsSfcalm1DLqm8KBUQ"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the refund was created","example":1711929600},"objectType":{"type":"string","description":"Object type identifier","example":"refund","enum":["refund"]},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund amount in minor units of a given currency. For example 10€ is represented as 1000 and 10¥ is represented as 10."},"children":[]}]}]}],"example":1000},"currency":{"type":"string","description":"Refund currency represented as a three-letter ISO currency code.","example":"USD"},"charge":{"type":"string","description":"ID of the charge associated with this refund.","example":"char_bYBGkBSsSfcalm1DLqm8KBUQ"},"reason":{"type":"string","description":"Reason for the refund.","enum":["fraudulent","expired"],"example":"fraudulent"},"status":{"type":"string","description":"Current status of the refund.","enum":["successful","pending","failed"],"example":"successful"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the refund.","additionalProperties":{"type":"string"}}}}},"components/schemas/Dispute":{"id":"components/schemas/Dispute","kind":"json-schema","title":"Dispute","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the dispute","example":"disp_GOqyiOF9575FUYMZ73gjNrcY"},"created":{"type":"integer","description":"Unix timestamp when the dispute was created","example":1701432000},"objectType":{"type":"string","description":"Object type identifier","example":"dispute","enum":["dispute"]},"updated":{"type":"integer","description":"Unix timestamp when the dispute was last updated","example":1701432000},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute amount in minor units of a given currency. For example, 10€ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10¥ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1000},"currency":{"type":"string","description":"Dispute currency represented as a three-letter ISO currency code.","example":"USD"},"status":{"type":"string","description":"Current status of this dispute.","enum":["RETRIEVAL_REQUEST_NEW","RETRIEVAL_REQUEST_RESPONSE_UNDER_REVIEW","RETRIEVAL_REQUEST_REPRESENTED","CHARGEBACK_NEW","CHARGEBACK_RESPONSE_UNDER_REVIEW","CHARGEBACK_REPRESENTED_SUCCESSFULLY","CHARGEBACK_REPRESENTED_UNSUCCESSFULLY","CHARGEBACK_PREVENTED"],"x-enumDescriptions":{"RETRIEVAL_REQUEST_NEW":"Retrieval request, response needed.","RETRIEVAL_REQUEST_RESPONSE_UNDER_REVIEW":"Retrieval request, response under review.","RETRIEVAL_REQUEST_REPRESENTED":"Retrieval request, successfully represented.","CHARGEBACK_NEW":"Chargeback, response needed.","CHARGEBACK_RESPONSE_UNDER_REVIEW":"Chargeback, response under review.","CHARGEBACK_REPRESENTED_SUCCESSFULLY":"Chargeback, dispute won.","CHARGEBACK_REPRESENTED_UNSUCCESSFULLY":"Chargeback, dispute lost.","CHARGEBACK_PREVENTED":"Automatic refund made in connection with Visa RDR mechanisms."},"example":"CHARGEBACK_NEW"},"reason":{"type":"string","description":"Reason why the customer created this dispute.","enum":["FRAUDULENT","UNRECOGNIZED","DUPLICATE","SUBSCRIPTION_CANCELED","PRODUCT_NOT_RECEIVED","PRODUCT_UNACCEPTABLE","CREDIT_NOT_PROCESSED","GENERAL"],"example":"GENERAL"},"acceptedAsLost":{"type":"boolean","description":"Information on whether this dispute is closed and, as a result of it, automatically lost.","example":false},"charge":{"allOf":[{"$ref":"#/components/schemas/Charge"}],"description":"Charge associated with this dispute."},"evidence":{"allOf":[{"$ref":"#/components/schemas/DisputeEvidence"}],"description":"Evidence object that was created for this dispute."},"evidenceDetails":{"type":"object","description":"Details about the evidence submitted for this dispute.","properties":{"hasEvidence":{"type":"boolean","description":"Whether any evidence was provided for this dispute.","example":true},"submissionCount":{"type":"integer","description":"Number of times the evidence was submitted for review.","example":1},"dueBy":{"type":"integer","description":"Unix timestamp of the deadline for submitting evidence.","example":1702432000}}}}}},"components/schemas/DisputeEvidence":{"id":"components/schemas/DisputeEvidence","kind":"json-schema","title":"DisputeEvidence","data":{"type":"object","properties":{"productDescription":{"type":"string","description":"A description of a product or service purchased by the customer including any details provided to the customer at the time of purchase.","example":"Exclusive black shoes"},"customerName":{"type":"string","description":"The name of the customer.","example":"John Doe"},"customerEmail":{"type":"string","description":"Customer's email address provided during the purchasing process.","example":"john.doe@example.com"},"customerPurchaseIp":{"type":"string","description":"The IP address used by the customer while purchasing.","example":"203.0.113.10"},"customerSignature":{"type":"string","description":"A scanned image or a photo of a document showing the customer's signature (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"billingAddress":{"type":"string","description":"The billing address provided by the customer in the purchasing process.","example":"1234 Market St, San Francisco, CA 94103, US"},"receipt":{"type":"string","description":"Receipts and messages sent to the customer with the charge notification (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"customerCommunication":{"type":"string","description":"Any communication with a customer that can help you win the dispute. These could be emails with proof of receiving the product or confirmation that the service was provided to the customer on the specified date (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"serviceDate":{"type":"string","description":"The date on which a customer received the purchased service, displayed in a human-readable format.","example":"2023-12-01"},"serviceDocumentation":{"type":"string","description":"The documentation proving that the service was provided to the customer. It could be a copy of a signed contract, etc. (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"duplicateChargeId":{"type":"string","description":"The ID of the duplicated charge.","example":"char_ORVCrwOrTkGsDwM3H50OIW7Q"},"duplicateChargeDocumentation":{"type":"string","description":"Any documents with proof that there were two or more separated transactions. Include shipping details, receipt, packing list, etc. (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"duplicateChargeExplanation":{"type":"string","description":"Any information indicating that transactions were separated to prove that the prior charge wasn't duplicated.","example":"The two charges are for different orders."},"refundPolicy":{"type":"string","description":"Your refund policy, as shown to the customer (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"refundPolicyDisclosure":{"type":"string","description":"An explanation showing how and when the customer agreed to your refund policy.","example":"The refund policy was presented at checkout."},"refundRefusalExplanation":{"type":"string","description":"An explanation of why the customer is not entitled to a refund.","example":"The product was delivered as described."},"cancellationPolicy":{"type":"string","description":"Your subscription cancellation policy, as shown to the customer (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"cancellationPolicyDisclosure":{"type":"string","description":"An explanation of how and when the customer agreed to your cancellation policy.","example":"The cancellation policy was accepted during sign-up."},"cancellationRefusalExplanation":{"type":"string","description":"An explanation showing that the customer continued using the product after the date they claimed to have stopped using it.","example":"The customer kept using the service after cancellation date."},"accessActivityLogs":{"type":"string","description":"Any evidence of the customer's activity after the date they claim to have cancelled the subscription, such as server or activity logs, IP addresses, etc. (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"shippingAddress":{"type":"string","description":"The shipping address to which a physical product was delivered. To maximize your chances of winning the dispute, the address should match a verified billing address.","example":"1234 Market St, San Francisco, CA 94103, US"},"shippingDate":{"type":"string","description":"The date on which a physical product began its route to the shipping address, displayed in a human-readable format and prior to the date of the dispute.","example":"2023-12-01"},"shippingCarrier":{"type":"string","description":"The name of the delivery service that shipped a physical product, eg. UPS, FedEx. If there are multiple carriers for the purchase, separate them with commas.","example":"UPS"},"shippingTrackingNumber":{"type":"string","description":"The number given by the delivery service for a physical product. If there are multiple tracking numbers for one purchase, separate them with commas.","example":"1Z999AA10123456784"},"shippingDocumentation":{"type":"string","description":"Documentation with proof that cardholder received a product at the address provided in the purchasing process. This could be a document with the full shipping address, such as the shipment receipt, etc. (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"uncategorizedText":{"type":"string","description":"An explanation with further evidence that doesn't fit into any of the fields provided above.","example":"Additional context about the purchase."},"uncategorizedFile":{"type":"string","description":"Any files or documents with further evidence that doesn't fit into any of the fields provided above (ID of a file upload).","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"}}}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the subscription","example":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5"},"created":{"type":"integer","description":"Unix timestamp when the subscription was created","example":1711929600},"objectType":{"type":"string","description":"Object type identifier","example":"subscription","enum":["subscription"]},"planId":{"type":"string","description":"Identifier of the plan assigned to this subscription.","example":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"customerId":{"type":"string","description":"Identifier of the customer who is the owner of this subscription.","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiplier applied to the amount defined in the plan. For example, a plan with amount=100 used in a subscription with quantity=5 will result in charges with amount=500."},"children":[]}]}]}],"example":1},"captureCharges":{"type":"boolean","description":"Whether charges created by this subscription are captured immediately (see the captured attribute in the charge request). If set to false, you need to manually capture each charge created by this subscription.","example":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of this subscription:"},"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":"trialing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - subscription was created from a plan with trial days and is still in the trial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - subscription is active and will be renewed after the end of the current billing cycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past_due"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - renewing of the subscription has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - subscription was manually canceled, or all retry renewal attempts have failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - all retry renewal attempts have failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incomplete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the first charge has failed on subscription creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the resulting status when all renewal retry attempts have failed depends on your account settings."},"children":[]}]}]}]}],"enum":["trialing","active","past_due","canceled","unpaid","incomplete"],"example":"active"},"remainingBillingCycles":{"type":"integer","nullable":true,"description":"Defines how many billing cycles remain before this subscription is automatically canceled. Value of null means no limit on the number of charges.","example":12},"start":{"type":"integer","description":"Date the subscription started using the current plan. Will have a different value than created if the subscription plan was changed.","example":1711929600},"currentPeriodStart":{"type":"integer","description":"Start of the current billing period. For an active subscription this should match the time of the last rebill, but can be different if there was a problem creating the rebill charge (for example, because of a declined charge).","example":1711929600},"currentPeriodEnd":{"type":"integer","description":"End of the current billing period. For an active subscription this is the time when the next rebill will be attempted.","example":1714521600},"canceledAt":{"type":"integer","nullable":true,"description":"The date when the subscription was requested to be canceled.","example":1712534400},"endedAt":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription was canceled. Will have a different value than canceledAt if the subscription was canceled with atPeriodEnd=true."},"children":[]}]}]}],"example":1714521600},"trialStart":{"type":"integer","nullable":true,"description":"Start of the trial period.","example":1711929600},"trialEnd":{"type":"integer","nullable":true,"description":"End of the trial period.","example":1714521600},"cancelAtPeriodEnd":{"type":"boolean","description":"If set to true, then the subscription will be canceled at the end of the current billing period.","example":false},"shipping":{"allOf":[{"$ref":"#/components/schemas/Shipping"}],"description":"Shipping details for this subscription."},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":"Billing details for this subscription."},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that will be used to create charges for this subscription.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"metadata":{"type":"object","description":"Set of key-value pairs","additionalProperties":{"type":"string"}}}}},"components/schemas/SubscriptionCharge":{"id":"components/schemas/SubscriptionCharge","kind":"json-schema","title":"SubscriptionCharge","data":{"type":"object","description":"A record of a single charge attempt made by a subscription.","properties":{"id":{"type":"integer","format":"int64","description":"Unique numeric identifier for the subscription charge record.","example":123456},"created":{"type":"integer","description":"Unix timestamp when the charge attempt was made","example":1711929600},"subscription":{"type":"string","description":"Identifier of the subscription that created this charge.","example":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5"},"plan":{"type":"string","nullable":true,"description":"Identifier of the plan the subscription was using when this charge was made.","example":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"charge":{"type":"string","description":"Identifier of the charge object that was created.","example":"char_ORVCrwOrTkGsDwM3H50OIW7Q"},"status":{"type":"string","description":"Whether the charge attempt succeeded.","enum":["success","failure"],"example":"success"},"cycle":{"type":"integer","description":"Billing cycle of the subscription in which this charge was made.","example":2},"rebill":{"type":"boolean","description":"Whether this charge was an automatic renewal (rebill) of the subscription. The first charge of a subscription is never counted as a rebill.","example":true}}}},"components/schemas/Plan":{"id":"components/schemas/Plan","kind":"json-schema","title":"Plan","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the plan","example":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"created":{"type":"integer","description":"Unix timestamp when the plan was created","example":1711929600},"objectType":{"type":"string","description":"Object type identifier","example":"plan","enum":["plan"]},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription charge amount in minor units of the given currency. For example, 10€ is represented as \"1000\" and 10¥ is represented as \"10\"."},"children":[]}]}]}],"example":499},"currency":{"type":"string","description":"Subscription charge currency represented as a three-letter ISO currency code.","example":"USD"},"interval":{"type":"string","description":"Frequency of subscription charges.","enum":["hour","day","week","month","year"],"example":"day"},"intervalCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of intervals between subscription charges. For example, interval=day and intervalCount=10 will result in a charge every 10 days."},"children":[]}]}]}],"example":10},"billingCycles":{"type":"integer","nullable":true,"description":"Number of charges after which the subscription will be automatically canceled. Value of null means no limit on the number of charges.","example":12},"name":{"type":"string","description":"Display name of this plan","example":"Example plan"},"trialPeriodDays":{"type":"integer","description":"Number of days between the creation of the subscription and the first charge.","example":0},"recursTo":{"type":"string","nullable":true,"description":"When the subscription is automatically canceled (due to reaching the limit of billingCycles), it will move to the plan defined by this attribute.","example":"plan_kFvuXpO2yhAFhbxTEaqm4HDW"},"splits":{"type":"array","description":"Information about split requests defined when creating the plan. Charge splits require a platform account.","items":{"$ref":"#/components/schemas/ChargeSplitCreate"}},"metadata":{"type":"object","description":"Set of key-value pairs","additionalProperties":{"type":"string"}}}}},"components/schemas/PaymentMethodBase":{"id":"components/schemas/PaymentMethodBase","kind":"json-schema","title":"Payment Method","data":{"type":"object","title":"Payment Method","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment method object. The fields below are common to every payment method type; type-specific details (for example the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blik"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects) are documented on the create and retrieve endpoints."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Unique payment method identifier","example":"pm_BokS87jDShjASDkjhdsak4kl"},"created":{"type":"integer","description":"Creation date as a UNIX timestamp","example":1415810511},"objectType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_method"},"children":[]}]}]}],"example":"payment_method","enum":["payment_method"]},"clientObjectId":{"type":"string","description":"Public identifier of the Payment Method that allows to securely access the object from client frontend code without exposing any sensitive data.","example":"client_pm_kjdS8DSj73DSkjhKJHDKSAna"},"customerId":{"type":"string","description":"Identifier of the customer that is the owner of this payment method.","example":"cust_BokS87jDShjASDkjhdsak4kl"},"type":{"type":"string","description":"The type of the payment method. Determines which type-specific object (if any) is present."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of payment method. Possible values are:"},"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":"chargeable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Payment Method is ready to be used to create a charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Payment Method setup process is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - setup process of the Payment Method failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"used"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payment method was already charged and cannot be reused."},"children":[]}]}]}]}],"enum":["pending","chargeable","used","failed","canceled"],"example":"chargeable"},"billing":{"type":"object","description":"Billing details.","properties":{"name":{"type":"string","description":"name of billed person or company"},"email":{"type":"string","description":"email of billed person or company"},"address":{"type":"object","description":"address object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string","description":"country represented as a two-letter ISO country code"}}},"phone":{"type":"string","description":"phone of billed person or company"},"vat":{"type":"string","description":"tax identification number"}}},"fraudCheckData":{"type":"object","description":"Additional data used for fraud protection.","properties":{"ipAddress":{"type":"string","description":"IP address of the user"},"ipCountry":{"type":"string","description":"country derived from the user's IP address (two-letter ISO country code)"},"email":{"type":"string","description":"e-mail address of the user"},"phone":{"type":"string","description":"phone number of the user"},"userAgent":{"type":"string","description":"value of \"User-Agent\" HTTP header that was sent by the user"},"acceptLanguage":{"type":"string","description":"value of \"Accept-Language\" HTTP header that was sent by the user"},"browserFingerprint":{"type":"string","description":"hashed device identifier, available if Shift4.js was used to create Token"}}},"flow":{"type":"object","description":"Describes the next action required to progress the payment method setup.","properties":{"nextAction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The next action to take (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wait"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"three_d_secure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that was used to create this payment method."},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}}},"components/schemas/PaymentMethodAch":{"id":"components/schemas/PaymentMethodAch","kind":"json-schema","title":"ACH","data":{"title":"ACH","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["ach"],"example":"ach"},"ach":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details specific to payment method of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"verificationProvider":{"type":"string","description":"Specifies what provider was used for account data verification.","enum":["plaid","shift4"]},"last4":{"type":"string"},"routingNumber":{"type":"string"},"accountType":{"type":"string"}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"ach","status":"pending","billing":{"name":"Werner Heisenberg","address":{"country":"US"}},"ach":{"verificationProvider":"shift4","last4":"4242","routingNumber":"021000021","accountType":"personal_savings"},"flow":{"nextAction":"wait"}}}},"components/schemas/PaymentMethodAlipay":{"id":"components/schemas/PaymentMethodAlipay","kind":"json-schema","title":"Alipay","data":{"title":"Alipay","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["alipay"],"example":"alipay"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"alipay","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"CN"}}}}},"components/schemas/PaymentMethodApplePay":{"id":"components/schemas/PaymentMethodApplePay","kind":"json-schema","title":"Apple pay","data":{"title":"Apple pay","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["apple_pay"],"example":"apple_pay"},"applePay":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details specific to payment method of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apple_pay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"type":"integer","description":"amount for which Apple Pay token was created"},"currency":{"type":"string","description":"currency for which Apple Pay token was created"},"expMonth":{"type":"string","description":"month of device-specific expiration of the card used in Apple Pay"},"expYear":{"type":"string","description":"year of device-specific expiration of the card used in Apple Pay"},"merchantTokenIdentifier":{"type":"string","description":"external merchant token identifier from the Apple Pay payment network"},"first6":{"type":"string","description":"first 6 numbers of device-specific account number of the card used in Apple Pay"},"last4":{"type":"string","description":"last 4 numbers of device-specific account number of the card used in Apple Pay"},"cardBrand":{"type":"string","description":"brand of the card used in Apple Pay","enum":["Visa","American Express","MasterCard","Discover","JCB","Diners Club","Unknown"]},"cardType":{"type":"string","description":"type of the card used in Apple Pay","enum":["Credit Card","Debit Card","Unknown"]}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"apple_pay","status":"chargeable","billing":{"address":{"country":"US"}},"applePay":{"first6":"424242","last4":"4242","amount":1000,"currency":"USD","cardBrand":"Visa","cardType":"Debit Card","expMonth":"12","expYear":"26","merchantTokenIdentifier":"IaAAM7ecerOTYpPpCiQ2POfaarf12WRO"}}}},"components/schemas/PaymentMethodBancontact":{"id":"components/schemas/PaymentMethodBancontact","kind":"json-schema","title":"Bancontact","data":{"title":"Bancontact","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["bancontact"],"example":"bancontact"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"bancontact","status":"chargeable","billing":{"address":{"country":"BE"}}}}},"components/schemas/PaymentMethodBitpay":{"id":"components/schemas/PaymentMethodBitpay","kind":"json-schema","title":"Bitpay","data":{"title":"Bitpay","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["bitpay"],"example":"bitpay"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"bitpay","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"US"}}}}},"components/schemas/PaymentMethodBlikCode":{"id":"components/schemas/PaymentMethodBlikCode","kind":"json-schema","title":"Blik (Code)","data":{"title":"Blik (Code)","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["blik"],"example":"blik"},"blik":{"type":"object","description":"Blik payment method details.","properties":{"code":{"type":"string","description":"the code obtained by the customer from the banking application."}}}}}]}},"components/schemas/PaymentMethodBlikRedirect":{"id":"components/schemas/PaymentMethodBlikRedirect","kind":"json-schema","title":"Blik (Redirect)","data":{"title":"Blik (Redirect)","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["blik"],"example":"blik"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"blik","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"PL"}}}}},"components/schemas/PaymentMethodBoleto":{"id":"components/schemas/PaymentMethodBoleto","kind":"json-schema","title":"Boleto","data":{"title":"Boleto","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["boleto"],"example":"boleto"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"boleto","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"BR"},"vat":"999.999.999-99","email":"werner.heisenberg@example.com"}}}},"components/schemas/PaymentMethodEps":{"id":"components/schemas/PaymentMethodEps","kind":"json-schema","title":"Eps","data":{"title":"Eps","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["eps"],"example":"eps"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"eps","status":"chargeable","billing":{"address":{"country":"AT"}}}}},"components/schemas/PaymentMethodEstonianbanks":{"id":"components/schemas/PaymentMethodEstonianbanks","kind":"json-schema","title":"Estonianbanks","data":{"title":"Estonianbanks","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["estonianbanks"],"example":"estonianbanks"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"estonianbanks","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"EE"}}}}},"components/schemas/PaymentMethodGooglePay":{"id":"components/schemas/PaymentMethodGooglePay","kind":"json-schema","title":"Google Pay","data":{"title":"Google Pay","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["google_pay"],"example":"google_pay"},"googlePay":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details specific to payment method of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"google_pay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"first6":{"type":"string","description":"first 6 numbers of device-specific account number of the card used in Google Pay"},"last4":{"type":"string","description":"last 4 numbers of device-specific account number of the card used in Google Pay"},"expMonth":{"type":"string","description":"month of device-specific expiration of the card used in Google Pay"},"expYear":{"type":"string","description":"year of device-specific expiration of the card used in Google Pay"},"authMethod":{"type":"string","description":"authorization method used by Google Pay when generating token","enum":["pan_only","cryptogram_3ds"]},"cardBrand":{"type":"string","description":"brand of the card used in Google Pay","enum":["Visa","American Express","MasterCard","Discover","JCB","Diners Club","Unknown"]},"cardType":{"type":"string","description":"type of the card used in Google Pay","enum":["Credit Card","Debit Card","Unknown"]}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"google_pay","status":"chargeable","billing":{"address":{"country":"US"}},"googlePay":{"cardBrand":"Visa","cardType":"Debit Card","first6":"424242","last4":"4242","expMonth":"12","expYear":"26","authMethod":"pan_only"},"flow":{"nextAction":"none"}}}},"components/schemas/PaymentMethodIdeal":{"id":"components/schemas/PaymentMethodIdeal","kind":"json-schema","title":"Ideal","data":{"title":"Ideal","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["ideal"],"example":"ideal"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"ideal","status":"chargeable","billing":{"address":{"country":"NL"}}}}},"components/schemas/PaymentMethodLatvianbanks":{"id":"components/schemas/PaymentMethodLatvianbanks","kind":"json-schema","title":"Latvianbanks","data":{"title":"Latvianbanks","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["latvianbanks"],"example":"latvianbanks"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"latvianbanks","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"LV"}}}}},"components/schemas/PaymentMethodLithuanianbanks":{"id":"components/schemas/PaymentMethodLithuanianbanks","kind":"json-schema","title":"Lithuanianbanks","data":{"title":"Lithuanianbanks","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["lithuanianbanks"],"example":"lithuanianbanks"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"lithuanianbanks","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"LT"}}}}},"components/schemas/PaymentMethodMaxima":{"id":"components/schemas/PaymentMethodMaxima","kind":"json-schema","title":"Maxima","data":{"title":"Maxima","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["maxima"],"example":"maxima"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"maxima","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"LT"}}}}},"components/schemas/PaymentMethodMbWayPhoneNumber":{"id":"components/schemas/PaymentMethodMbWayPhoneNumber","kind":"json-schema","title":"MB Way (phone number)","data":{"title":"MB Way (phone number)","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["mbway"],"example":"mbway"},"mbway":{"type":"object","description":"MB Way payment method details.","properties":{"linkMethod":{"type":"string","description":"The method used for MB Way integration.","enum":["phone_number","redirect"]}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"mbway","status":"chargeable","mbway":{"linkMethod":"phone_number"},"billing":{"name":"Werner Heisenberg","address":{"country":"PT"},"phone":"+351 912 345 678"}}}},"components/schemas/PaymentMethodMbWayRedirect":{"id":"components/schemas/PaymentMethodMbWayRedirect","kind":"json-schema","title":"MB Way (redirect)","data":{"title":"MB Way (redirect)","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["mbway"],"example":"mbway"},"mbway":{"type":"object","description":"MB Way payment method details.","properties":{"linkMethod":{"type":"string","description":"The method used for MB Way integration.","enum":["phone_number","redirect"]}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"mbway","status":"chargeable","mbway":{"linkMethod":"redirect"},"billing":{"name":"Werner Heisenberg","address":{"country":"PT"}}}}},"components/schemas/PaymentMethodMultibanco":{"id":"components/schemas/PaymentMethodMultibanco","kind":"json-schema","title":"Multibanco","data":{"title":"Multibanco","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["multibanco"],"example":"multibanco"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"multibanco","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"PT"}}}}},"components/schemas/PaymentMethodMybank":{"id":"components/schemas/PaymentMethodMybank","kind":"json-schema","title":"Mybank","data":{"title":"Mybank","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["mybank"],"example":"mybank"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"mybank","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"IT"}}}}},"components/schemas/PaymentMethodPrzelewy24":{"id":"components/schemas/PaymentMethodPrzelewy24","kind":"json-schema","title":"Przelewy24","data":{"title":"Przelewy24","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["p24"],"example":"p24"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"p24","status":"chargeable","billing":{"address":{"country":"PL"},"email":"werner.heisenberg@example.com"}}}},"components/schemas/PaymentMethodPaypost":{"id":"components/schemas/PaymentMethodPaypost","kind":"json-schema","title":"Paypost","data":{"title":"Paypost","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paypost"],"example":"paypost"}}}]}},"components/schemas/PaymentMethodPaysafecash":{"id":"components/schemas/PaymentMethodPaysafecash","kind":"json-schema","title":"Paysafecash","data":{"title":"Paysafecash","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paysafecash"],"example":"paysafecash"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"paysafecash","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"AT"}}}}},"components/schemas/PaymentMethodPaysafecard":{"id":"components/schemas/PaymentMethodPaysafecard","kind":"json-schema","title":"Paysafecard","data":{"title":"Paysafecard","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paysafecard"],"example":"paysafecard"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"paysafecard","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"AT"}}}}},"components/schemas/PaymentMethodPaysera":{"id":"components/schemas/PaymentMethodPaysera","kind":"json-schema","title":"Paysera","data":{"title":"Paysera","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paysera"],"example":"paysera"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"paysera","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"EE"}}}}},"components/schemas/PaymentMethodPayu":{"id":"components/schemas/PaymentMethodPayu","kind":"json-schema","title":"Payu","data":{"title":"Payu","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["payu"],"example":"payu"}}}]}},"components/schemas/PaymentMethodPerlas":{"id":"components/schemas/PaymentMethodPerlas","kind":"json-schema","title":"Perlas","data":{"title":"Perlas","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["perlas"],"example":"perlas"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"perlas","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"LT"}}}}},"components/schemas/PaymentMethodSkrill":{"id":"components/schemas/PaymentMethodSkrill","kind":"json-schema","title":"Skrill","data":{"title":"Skrill","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["skrill"],"example":"skrill"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"skrill","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"US"}}}}},"components/schemas/PaymentMethodSwishQrCode":{"id":"components/schemas/PaymentMethodSwishQrCode","kind":"json-schema","title":"Swish (QR code)","data":{"title":"Swish (QR code)","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["swish"],"example":"swish"},"swish":{"type":"object","description":"Swish payment method details.","properties":{"linkMethod":{"type":"string","description":"The method used for Swish integration.","enum":["qr_code","app_redirect","phone_number"]}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"swish","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"US"}},"swish":{"linkMethod":"qr_code"}}}},"components/schemas/PaymentMethodSwishMobileAppRedirect":{"id":"components/schemas/PaymentMethodSwishMobileAppRedirect","kind":"json-schema","title":"Swish (mobile app redirect)","data":{"title":"Swish (mobile app redirect)","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["swish"],"example":"swish"},"swish":{"type":"object","description":"Swish payment method details.","properties":{"linkMethod":{"type":"string","description":"The method used for Swish integration.","enum":["qr_code","app_redirect","phone_number"]}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"swish","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"US"}},"swish":{"linkMethod":"app_redirect"}}}},"components/schemas/PaymentMethodSwishPhoneNumber":{"id":"components/schemas/PaymentMethodSwishPhoneNumber","kind":"json-schema","title":"Swish (phone number)","data":{"title":"Swish (phone number)","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["swish"],"example":"swish"},"swish":{"type":"object","description":"Swish payment method details.","properties":{"linkMethod":{"type":"string","description":"The method used for Swish integration.","enum":["qr_code","app_redirect","phone_number"]}}}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"swish","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"US"},"phone":"48123456789"},"swish":{"linkMethod":"phone_number"}}}},"components/schemas/PaymentMethod3dSecure":{"id":"components/schemas/PaymentMethod3dSecure","kind":"json-schema","title":"3D Secure","data":{"title":"3D Secure","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["three_d_secure"],"example":"three_d_secure"},"threeDSecure":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details specific to payment method of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"three_d_secure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"type":"integer","description":"amount for which ThreeDSecure was created"},"currency":{"type":"string","description":"currency for which ThreeDSecure was created"}}},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full Payment Method object that was used as source for the three_d_secure payment method. Currently the only supported source is a payment method of type google_pay."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PaymentMethodGooglePay"},{"type":"object","required":["type"],"properties":{"type":{"enum":["google_pay"]}}}]}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"three_d_secure","status":"pending","billing":{"address":{"country":"US"}},"threeDSecure":{"amount":1000,"currency":"USD"},"source":{"id":"pm_source_9x2Kd8bViQ0rLmNpQ4Ts","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"google_pay","status":"chargeable","billing":{"address":{"country":"US"}},"googlePay":{"cardBrand":"Visa","cardType":"Debit Card","first6":"424242","last4":"4242"},"flow":{"nextAction":"none"}},"flow":{"nextAction":"three_d_secure"}}}},"components/schemas/PaymentMethodTrustly":{"id":"components/schemas/PaymentMethodTrustly","kind":"json-schema","title":"Trustly","data":{"title":"Trustly","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["trustly"],"example":"trustly"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"trustly","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"AT"},"email":"werner.heisenberg@example.com"}}}},"components/schemas/PaymentMethodUnionpay":{"id":"components/schemas/PaymentMethodUnionpay","kind":"json-schema","title":"Unionpay","data":{"title":"Unionpay","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["unionpay"],"example":"unionpay"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"unionpay","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"US"},"email":"werner.heisenberg@example.com"}}}},"components/schemas/PaymentMethodVerkkopankki":{"id":"components/schemas/PaymentMethodVerkkopankki","kind":"json-schema","title":"Verkkopankki","data":{"title":"Verkkopankki","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["verkkopankki"],"example":"verkkopankki"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"verkkopankki","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"FI"}}}}},"components/schemas/PaymentMethodWechatpay":{"id":"components/schemas/PaymentMethodWechatpay","kind":"json-schema","title":"Wechatpay","data":{"title":"Wechatpay","allOf":[{"$ref":"#/components/schemas/PaymentMethodBase"},{"type":"object","properties":{"type":{"type":"string","enum":["wechatpay"],"example":"wechatpay"}}}],"example":{"id":"pm_BokS87jDShjASDkjhdsak4kl","created":1415810511,"objectType":"payment_method","clientObjectId":"client_pm_kjdS8DSj73DSkjhKJHDKSAna","customerId":"cust_BokS87jDShjASDkjhdsak4kl","type":"wechatpay","status":"chargeable","billing":{"name":"Werner Heisenberg","address":{"country":"CN"}}}}},"components/schemas/PaymentMethod":{"id":"components/schemas/PaymentMethod","kind":"json-schema","title":"Payment Method","data":{"title":"Payment Method","oneOf":[{"$ref":"#/components/schemas/PaymentMethodAch"},{"$ref":"#/components/schemas/PaymentMethodAlipay"},{"$ref":"#/components/schemas/PaymentMethodApplePay"},{"$ref":"#/components/schemas/PaymentMethodBancontact"},{"$ref":"#/components/schemas/PaymentMethodBitpay"},{"$ref":"#/components/schemas/PaymentMethodBlikCode"},{"$ref":"#/components/schemas/PaymentMethodBlikRedirect"},{"$ref":"#/components/schemas/PaymentMethodBoleto"},{"$ref":"#/components/schemas/PaymentMethodEps"},{"$ref":"#/components/schemas/PaymentMethodEstonianbanks"},{"$ref":"#/components/schemas/PaymentMethodGooglePay"},{"$ref":"#/components/schemas/PaymentMethodIdeal"},{"$ref":"#/components/schemas/PaymentMethodLatvianbanks"},{"$ref":"#/components/schemas/PaymentMethodLithuanianbanks"},{"$ref":"#/components/schemas/PaymentMethodMaxima"},{"$ref":"#/components/schemas/PaymentMethodMbWayPhoneNumber"},{"$ref":"#/components/schemas/PaymentMethodMbWayRedirect"},{"$ref":"#/components/schemas/PaymentMethodMultibanco"},{"$ref":"#/components/schemas/PaymentMethodMybank"},{"$ref":"#/components/schemas/PaymentMethodPrzelewy24"},{"$ref":"#/components/schemas/PaymentMethodPaypost"},{"$ref":"#/components/schemas/PaymentMethodPaysafecash"},{"$ref":"#/components/schemas/PaymentMethodPaysafecard"},{"$ref":"#/components/schemas/PaymentMethodPaysera"},{"$ref":"#/components/schemas/PaymentMethodPayu"},{"$ref":"#/components/schemas/PaymentMethodPerlas"},{"$ref":"#/components/schemas/PaymentMethodSkrill"},{"$ref":"#/components/schemas/PaymentMethodSwishQrCode"},{"$ref":"#/components/schemas/PaymentMethodSwishMobileAppRedirect"},{"$ref":"#/components/schemas/PaymentMethodSwishPhoneNumber"},{"$ref":"#/components/schemas/PaymentMethod3dSecure"},{"$ref":"#/components/schemas/PaymentMethodTrustly"},{"$ref":"#/components/schemas/PaymentMethodUnionpay"},{"$ref":"#/components/schemas/PaymentMethodVerkkopankki"},{"$ref":"#/components/schemas/PaymentMethodWechatpay"}]}},"components/schemas/PaymentMethodCreateBase":{"id":"components/schemas/PaymentMethodCreateBase","kind":"json-schema","title":"PaymentMethodCreateBase","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the payment method to create."},"customerId":{"type":"string","description":"Identifier of the customer that will be associated with this payment method."},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that will be used to create this payment method."},"billing":{"type":"object","description":"Billing details.","properties":{"name":{"type":"string","description":"name of billed person or company"},"email":{"type":"string","description":"email of billed person or company"},"address":{"type":"object","description":"address object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string","description":"country represented as a two-letter ISO country code"}}},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone number, eg. +12345678901"},"children":[]}]}]}]},"vat":{"type":"string","description":"tax identification number"}}},"fraudCheckData":{"type":"object","description":"Additional data used for fraud protection.","properties":{"ipAddress":{"type":"string","description":"IP address of the user"},"ipCountry":{"type":"string","description":"country derived from the user's IP address (two-letter ISO country code)"},"email":{"type":"string","description":"e-mail address of the user"},"phone":{"type":"string","description":"phone number of the user"},"userAgent":{"type":"string","description":"value of \"User-Agent\" HTTP header that was sent by the user"},"acceptLanguage":{"type":"string","description":"value of \"Accept-Language\" HTTP header that was sent by the user"},"browserFingerprint":{"type":"string","description":"hashed device identifier, available if Shift4.js was used to create Token"}}},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}}},"components/schemas/PaymentMethodCreateAch":{"id":"components/schemas/PaymentMethodCreateAch","kind":"json-schema","title":"ACH","data":{"title":"ACH","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["ach"],"example":"ach"},"ach":{"type":"object","description":"Details required to create an ACH payment method.","additionalProperties":true}}}],"example":{"type":"ach","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"US"},"name":"Werner Heisenberg"},"fraudCheckData":{"ipAddress":"17.189.255.21"},"ach":{"account":{"routingNumber":21000021,"accountNumber":4242424242424242,"accountType":"personal_savings"}}}}},"components/schemas/PaymentMethodCreateAlipay":{"id":"components/schemas/PaymentMethodCreateAlipay","kind":"json-schema","title":"Alipay","data":{"title":"Alipay","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["alipay"],"example":"alipay"}}}],"example":{"type":"alipay","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"CN"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateApplePay":{"id":"components/schemas/PaymentMethodCreateApplePay","kind":"json-schema","title":"Apple pay","data":{"title":"Apple pay","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["apple_pay"],"example":"apple_pay"},"applePay":{"type":"object","description":"Apple Pay token payload used to create the payment method.","additionalProperties":true}}}],"example":{"type":"apple_pay","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"US"}},"applePay":{"token":"{ \"data\": \"TEST_TOKEN:1000USD\" }"}}}},"components/schemas/PaymentMethodCreateBancontact":{"id":"components/schemas/PaymentMethodCreateBancontact","kind":"json-schema","title":"Bancontact","data":{"title":"Bancontact","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["bancontact"],"example":"bancontact"}}}],"example":{"type":"bancontact","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"BE"}}}}},"components/schemas/PaymentMethodCreateBitpay":{"id":"components/schemas/PaymentMethodCreateBitpay","kind":"json-schema","title":"Bitpay","data":{"title":"Bitpay","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["bitpay"],"example":"bitpay"}}}],"example":{"type":"bitpay","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"US"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateBlikCode":{"id":"components/schemas/PaymentMethodCreateBlikCode","kind":"json-schema","title":"Blik (Code)","data":{"title":"Blik (Code)","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["blik"],"example":"blik"},"blik":{"type":"object","description":"Blik payment method details.","required":["code"],"properties":{"code":{"type":"string","description":"The code obtained by the customer from the banking application (Blik Code flow)."}}}}}],"example":{"type":"blik","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"PL"},"name":"Werner Heisenberg"},"blik":{"code":"123"},"fraudCheckData":{"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 12_3_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36","ipAddress":"123.456.789.01"}}}},"components/schemas/PaymentMethodCreateBlikRedirect":{"id":"components/schemas/PaymentMethodCreateBlikRedirect","kind":"json-schema","title":"Blik (Redirect)","data":{"title":"Blik (Redirect)","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["blik"],"example":"blik"}}}],"example":{"type":"blik","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"PL"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateBoleto":{"id":"components/schemas/PaymentMethodCreateBoleto","kind":"json-schema","title":"Boleto","data":{"title":"Boleto","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["boleto"],"example":"boleto"}}}],"example":{"type":"boleto","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"BR"},"name":"Werner Heisenberg","email":"werner.heisenberg@example.com","vat":"999.999.999-99"}}}},"components/schemas/PaymentMethodCreateEps":{"id":"components/schemas/PaymentMethodCreateEps","kind":"json-schema","title":"Eps","data":{"title":"Eps","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["eps"],"example":"eps"}}}],"example":{"type":"eps","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"AT"}}}}},"components/schemas/PaymentMethodCreateEstonianbanks":{"id":"components/schemas/PaymentMethodCreateEstonianbanks","kind":"json-schema","title":"Estonianbanks","data":{"title":"Estonianbanks","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["estonianbanks"],"example":"estonianbanks"}}}],"example":{"type":"estonianbanks","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"EE"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateGooglePay":{"id":"components/schemas/PaymentMethodCreateGooglePay","kind":"json-schema","title":"Google Pay","data":{"title":"Google Pay","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["google_pay"],"example":"google_pay"},"googlePay":{"type":"object","description":"Google Pay token payload used to create the payment method.","additionalProperties":true}}}],"example":{"type":"google_pay","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"US"}},"googlePay":{"token":"PAN_ONLY"}}}},"components/schemas/PaymentMethodCreateIdeal":{"id":"components/schemas/PaymentMethodCreateIdeal","kind":"json-schema","title":"Ideal","data":{"title":"Ideal","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["ideal"],"example":"ideal"}}}],"example":{"type":"ideal","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"NL"}}}}},"components/schemas/PaymentMethodCreateLatvianbanks":{"id":"components/schemas/PaymentMethodCreateLatvianbanks","kind":"json-schema","title":"Latvianbanks","data":{"title":"Latvianbanks","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["latvianbanks"],"example":"latvianbanks"}}}],"example":{"type":"latvianbanks","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"LV"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateLithuanianbanks":{"id":"components/schemas/PaymentMethodCreateLithuanianbanks","kind":"json-schema","title":"Lithuanianbanks","data":{"title":"Lithuanianbanks","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["lithuanianbanks"],"example":"lithuanianbanks"}}}],"example":{"type":"lithuanianbanks","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"LT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateMaxima":{"id":"components/schemas/PaymentMethodCreateMaxima","kind":"json-schema","title":"Maxima","data":{"title":"Maxima","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["maxima"],"example":"maxima"}}}],"example":{"type":"maxima","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"LT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateMbWayPhoneNumber":{"id":"components/schemas/PaymentMethodCreateMbWayPhoneNumber","kind":"json-schema","title":"MB Way (phone number)","data":{"title":"MB Way (phone number)","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["mbway"],"example":"mbway"},"mbway":{"type":"object","description":"MB Way payment method details.","required":["linkMethod"],"properties":{"linkMethod":{"type":"string","description":"The method used for MB Way integration.","enum":["phone_number","redirect"]}}}}}],"example":{"type":"mbway","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"PT"},"name":"Werner Heisenberg","phone":"+351 912 345 678"},"mbway":{"linkMethod":"phone_number"}}}},"components/schemas/PaymentMethodCreateMbWayRedirect":{"id":"components/schemas/PaymentMethodCreateMbWayRedirect","kind":"json-schema","title":"MB Way (redirect)","data":{"title":"MB Way (redirect)","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["mbway"],"example":"mbway"}}}],"example":{"type":"mbway","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"PT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateMultibanco":{"id":"components/schemas/PaymentMethodCreateMultibanco","kind":"json-schema","title":"Multibanco","data":{"title":"Multibanco","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["multibanco"],"example":"multibanco"}}}],"example":{"type":"multibanco","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"PT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateMybank":{"id":"components/schemas/PaymentMethodCreateMybank","kind":"json-schema","title":"Mybank","data":{"title":"Mybank","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["mybank"],"example":"mybank"}}}],"example":{"type":"mybank","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"IT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreatePrzelewy24":{"id":"components/schemas/PaymentMethodCreatePrzelewy24","kind":"json-schema","title":"Przelewy24","data":{"title":"Przelewy24","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["p24"],"example":"p24"}}}],"example":{"type":"p24","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"PL"},"email":"werner.heisenberg@example.com"}}}},"components/schemas/PaymentMethodCreatePaypost":{"id":"components/schemas/PaymentMethodCreatePaypost","kind":"json-schema","title":"Paypost","data":{"title":"Paypost","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paypost"],"example":"paypost"}}}],"example":{"type":"paypost","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"LT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreatePaysafecash":{"id":"components/schemas/PaymentMethodCreatePaysafecash","kind":"json-schema","title":"Paysafecash","data":{"title":"Paysafecash","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paysafecash"],"example":"paysafecash"}}}],"example":{"type":"paysafecash","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"AT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreatePaysafecard":{"id":"components/schemas/PaymentMethodCreatePaysafecard","kind":"json-schema","title":"Paysafecard","data":{"title":"Paysafecard","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paysafecard"],"example":"paysafecard"}}}],"example":{"type":"paysafecard","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"AT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreatePaysera":{"id":"components/schemas/PaymentMethodCreatePaysera","kind":"json-schema","title":"Paysera","data":{"title":"Paysera","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["paysera"],"example":"paysera"}}}],"example":{"type":"paysera","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"EE"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreatePayu":{"id":"components/schemas/PaymentMethodCreatePayu","kind":"json-schema","title":"Payu","data":{"title":"Payu","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["payu"],"example":"payu"}}}],"example":{"type":"payu","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"CZ"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreatePerlas":{"id":"components/schemas/PaymentMethodCreatePerlas","kind":"json-schema","title":"Perlas","data":{"title":"Perlas","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["perlas"],"example":"perlas"}}}],"example":{"type":"perlas","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"LT"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateSkrill":{"id":"components/schemas/PaymentMethodCreateSkrill","kind":"json-schema","title":"Skrill","data":{"title":"Skrill","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["skrill"],"example":"skrill"}}}],"example":{"type":"skrill","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"US"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateSwishQrCode":{"id":"components/schemas/PaymentMethodCreateSwishQrCode","kind":"json-schema","title":"Swish (QR code)","data":{"title":"Swish (QR code)","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["swish"],"example":"swish"},"swish":{"type":"object","description":"Swish payment method details.","required":["linkMethod"],"properties":{"linkMethod":{"type":"string","description":"The method used for Swish integration.","enum":["qr_code","app_redirect","phone_number"]}}}}}],"example":{"type":"swish","billing":{"name":"Werner Heisenberg","address":{"country":"US"}},"customerId":"cust_BokS87jDShjASDkjhdsak4kl","swish":{"linkMethod":"qr_code"}}}},"components/schemas/PaymentMethodCreateSwishMobileAppRedirect":{"id":"components/schemas/PaymentMethodCreateSwishMobileAppRedirect","kind":"json-schema","title":"Swish (mobile app redirect)","data":{"title":"Swish (mobile app redirect)","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["swish"],"example":"swish"},"swish":{"type":"object","description":"Swish payment method details.","required":["linkMethod"],"properties":{"linkMethod":{"type":"string","description":"The method used for Swish integration.","enum":["qr_code","app_redirect","phone_number"]}}}}}],"example":{"type":"swish","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"name":"Werner Heisenberg","address":{"country":"US"}},"swish":{"linkMethod":"app_redirect"}}}},"components/schemas/PaymentMethodCreateSwishPhoneNumber":{"id":"components/schemas/PaymentMethodCreateSwishPhoneNumber","kind":"json-schema","title":"Swish (phone number)","data":{"title":"Swish (phone number)","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["swish"],"example":"swish"},"swish":{"type":"object","description":"Swish payment method details.","required":["linkMethod"],"properties":{"linkMethod":{"type":"string","description":"The method used for Swish integration.","enum":["qr_code","app_redirect","phone_number"]}}}}}],"example":{"type":"swish","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"name":"Werner Heisenberg","address":{"country":"US"},"phone":"+1234567890"},"swish":{"linkMethod":"phone_number"}}}},"components/schemas/PaymentMethodCreate3dSecure":{"id":"components/schemas/PaymentMethodCreate3dSecure","kind":"json-schema","title":"3D Secure","data":{"title":"3D Secure","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["three_d_secure"],"example":"three_d_secure"}}}],"example":{"type":"three_d_secure","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"US"}},"source":"pm_aokF87jdbkjCADkihesRk1kX","threeDSecure":{"amount":1000,"currency":"USD"}}}},"components/schemas/PaymentMethodCreateTrustly":{"id":"components/schemas/PaymentMethodCreateTrustly","kind":"json-schema","title":"Trustly","data":{"title":"Trustly","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["trustly"],"example":"trustly"}}}],"example":{"type":"trustly","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"AT"},"name":"Werner Heisenberg","email":"werner.heisenberg@example.com"}}}},"components/schemas/PaymentMethodCreateUnionpay":{"id":"components/schemas/PaymentMethodCreateUnionpay","kind":"json-schema","title":"Unionpay","data":{"title":"Unionpay","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["unionpay"],"example":"unionpay"}}}],"example":{"type":"unionpay","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"US"},"name":"Werner Heisenberg","email":"werner.heisenberg@example.com"}}}},"components/schemas/PaymentMethodCreateVerkkopankki":{"id":"components/schemas/PaymentMethodCreateVerkkopankki","kind":"json-schema","title":"Verkkopankki","data":{"title":"Verkkopankki","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["verkkopankki"],"example":"verkkopankki"}}}],"example":{"type":"verkkopankki","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"FI"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateWechatpay":{"id":"components/schemas/PaymentMethodCreateWechatpay","kind":"json-schema","title":"Wechatpay","data":{"title":"Wechatpay","allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateBase"},{"type":"object","properties":{"type":{"type":"string","enum":["wechatpay"],"example":"wechatpay"}}}],"example":{"type":"wechatpay","customerId":"cust_BokS87jDShjASDkjhdsak4kl","billing":{"address":{"country":"CN"},"name":"Werner Heisenberg"}}}},"components/schemas/PaymentMethodCreateSummary":{"id":"components/schemas/PaymentMethodCreateSummary","kind":"json-schema","title":"Payment Method","data":{"type":"object","title":"Payment Method","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inline payment-method details. The exact fields depend on the payment method "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-methods/createpaymentmethod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create a payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint for the full per-method request shapes."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the payment method (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blik"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ideal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"ideal"}}}},"components/schemas/PaymentMethodCreate":{"id":"components/schemas/PaymentMethodCreate","kind":"json-schema","title":"Payment Method","data":{"title":"Payment Method","oneOf":[{"$ref":"#/components/schemas/PaymentMethodCreateAch"},{"$ref":"#/components/schemas/PaymentMethodCreateAlipay"},{"$ref":"#/components/schemas/PaymentMethodCreateApplePay"},{"$ref":"#/components/schemas/PaymentMethodCreateBancontact"},{"$ref":"#/components/schemas/PaymentMethodCreateBitpay"},{"$ref":"#/components/schemas/PaymentMethodCreateBlikCode"},{"$ref":"#/components/schemas/PaymentMethodCreateBlikRedirect"},{"$ref":"#/components/schemas/PaymentMethodCreateBoleto"},{"$ref":"#/components/schemas/PaymentMethodCreateEps"},{"$ref":"#/components/schemas/PaymentMethodCreateEstonianbanks"},{"$ref":"#/components/schemas/PaymentMethodCreateGooglePay"},{"$ref":"#/components/schemas/PaymentMethodCreateIdeal"},{"$ref":"#/components/schemas/PaymentMethodCreateLatvianbanks"},{"$ref":"#/components/schemas/PaymentMethodCreateLithuanianbanks"},{"$ref":"#/components/schemas/PaymentMethodCreateMaxima"},{"$ref":"#/components/schemas/PaymentMethodCreateMbWayPhoneNumber"},{"$ref":"#/components/schemas/PaymentMethodCreateMbWayRedirect"},{"$ref":"#/components/schemas/PaymentMethodCreateMultibanco"},{"$ref":"#/components/schemas/PaymentMethodCreateMybank"},{"$ref":"#/components/schemas/PaymentMethodCreatePrzelewy24"},{"$ref":"#/components/schemas/PaymentMethodCreatePaypost"},{"$ref":"#/components/schemas/PaymentMethodCreatePaysafecash"},{"$ref":"#/components/schemas/PaymentMethodCreatePaysafecard"},{"$ref":"#/components/schemas/PaymentMethodCreatePaysera"},{"$ref":"#/components/schemas/PaymentMethodCreatePayu"},{"$ref":"#/components/schemas/PaymentMethodCreatePerlas"},{"$ref":"#/components/schemas/PaymentMethodCreateSkrill"},{"$ref":"#/components/schemas/PaymentMethodCreateSwishQrCode"},{"$ref":"#/components/schemas/PaymentMethodCreateSwishMobileAppRedirect"},{"$ref":"#/components/schemas/PaymentMethodCreateSwishPhoneNumber"},{"$ref":"#/components/schemas/PaymentMethodCreate3dSecure"},{"$ref":"#/components/schemas/PaymentMethodCreateTrustly"},{"$ref":"#/components/schemas/PaymentMethodCreateUnionpay"},{"$ref":"#/components/schemas/PaymentMethodCreateVerkkopankki"},{"$ref":"#/components/schemas/PaymentMethodCreateWechatpay"}]}},"components/schemas/ChargeSplit":{"id":"components/schemas/ChargeSplit","kind":"json-schema","title":"ChargeSplit","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the split.","example":"spl_ORVCrwOrTkGsDwM3H50OIW7Q"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the split was created.","example":1701432000},"objectType":{"type":"string","description":"Object type identifier.","example":"charge_split","enum":["charge_split"]},"charge":{"type":"string","description":"The identifier of the charge within which the split was created.","example":"char_ORVCrwOrTkGsDwM3H50OIW7Q"},"type":{"type":"string","description":"Type of split.","enum":["tip"],"example":"tip"},"amount":{"type":"integer","description":"Split amount in the smallest currency unit (e.g., cents).","example":200},"currency":{"type":"string","description":"Three-letter ISO 4217 currency code.","example":"USD"},"merchant":{"type":"string","description":"The merchant identifier to whom the money was transferred (always the platform).","example":"acct_ORVCrwOrTkGsDwM3H50OIW7Q"}}}},"components/schemas/Event":{"id":"components/schemas/Event","kind":"json-schema","title":"Event","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the event","example":"event_EY7CzyQiffJykW8rC5wSRnAj"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the event was created","example":1701432000},"objectType":{"type":"string","example":"event","enum":["event"]},"type":{"type":"string","description":"Type of event.","example":"CHARGE_SUCCEEDED","enum":["CHARGE_SUCCEEDED","CHARGE_PENDING","CHARGE_FAILED","CHARGE_UPDATED","CHARGE_CAPTURED","CHARGE_REFUNDED","CHARGE_DISPUTE_CREATED","CHARGE_DISPUTE_UPDATED","CHARGE_DISPUTE_WON","CHARGE_DISPUTE_LOST","CHARGE_DISPUTE_FUNDS_WITHDRAWN","CHARGE_DISPUTE_FUNDS_RESTORED","REFUND_UPDATED","CUSTOMER_CREATED","CUSTOMER_UPDATED","CUSTOMER_DELETED","CUSTOMER_CARD_CREATED","CUSTOMER_CARD_UPDATED","CUSTOMER_CARD_DELETED","CUSTOMER_SUBSCRIPTION_CREATED","CUSTOMER_SUBSCRIPTION_UPDATED","CUSTOMER_SUBSCRIPTION_DELETED","PLAN_CREATED","PLAN_UPDATED","PLAN_DELETED","CREDIT_SUCCEEDED","CREDIT_FAILED","CREDIT_UPDATED","FRAUD_WARNING_CREATED","FRAUD_WARNING_UPDATED","PAYOUT_CREATED","PAYOUT_UPDATED","PAYMENT_METHOD_CREATED","PAYMENT_METHOD_UPDATED","PAYMENT_METHOD_DELETED","PAYMENT_LINK_CREATED","PAYMENT_LINK_UPDATED","PAYMENT_LINK_DELETED","CHARGE_SPLIT_CREATED","CHARGE_SPLIT_REFUND_CREATED"],"x-enumDescriptions":{"CHARGE_SUCCEEDED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new charge is successfully created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_PENDING":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new charge processing is pending. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_FAILED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the creation of a new charge fails. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a charge object is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_CAPTURED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a charge is captured. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_REFUNDED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a charge is refunded. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_DISPUTE_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a customer disputes a charge (either the chargeback or the retrieval request). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_DISPUTE_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when an existing dispute is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_DISPUTE_WON":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a dispute is resolved as won. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_DISPUTE_LOST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a dispute is resolved as lost. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_DISPUTE_FUNDS_WITHDRAWN":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when funds are removed from your account as a result of a dispute (a chargeback). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_DISPUTE_FUNDS_RESTORED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when previously withdrawn funds are restored as a result of a winning dispute. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"REFUND_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a refund is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/refunds/getrefund"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new customer is created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/customers/getcustomer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a customer is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/customers/getcustomer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_DELETED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a customer is deleted. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/customers/getcustomer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_CARD_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new card is created for a customer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_CARD_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a customer's card is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_CARD_DELETED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a customer's card is deleted. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_SUBSCRIPTION_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new subscription is created for a customer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/subscriptions/getsubscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_SUBSCRIPTION_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a customer's subscription is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/subscriptions/getsubscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CUSTOMER_SUBSCRIPTION_DELETED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a customer's subscription is cancelled. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/subscriptions/getsubscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PLAN_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new plan is created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/plans/getplan"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PLAN_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a plan is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/plans/getplan"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PLAN_DELETED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a plan is deleted. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/plans/getplan"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CREDIT_SUCCEEDED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new credit is successfully created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/credits/getcredit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CREDIT_FAILED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when the creation of a new credit fails. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/credits/getcredit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CREDIT_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a credit object is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/credits/getcredit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"FRAUD_WARNING_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a fraud warning is created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/fraud-warnings/getfraudwarning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fraud warning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"FRAUD_WARNING_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a fraud warning is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/fraud-warnings/getfraudwarning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fraud warning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYOUT_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a payout is created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payouts/getpayout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYOUT_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a payout is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payouts/getpayout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYMENT_METHOD_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a new payment method is successfully created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-methods/getpaymentmethod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYMENT_METHOD_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a payment method object is updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-methods/getpaymentmethod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYMENT_METHOD_DELETED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a payment method object is deleted. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-methods/getpaymentmethod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYMENT_LINK_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a payment link object is created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-links/getpaymentlink"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYMENT_LINK_UPDATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a payment link object is updated, deactivated or reactivated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-links/getpaymentlink"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"PAYMENT_LINK_DELETED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a payment link object is deleted. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-links/getpaymentlink"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"CHARGE_SPLIT_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a charge split is created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a charge split object."},"children":[]}]}]}],"CHARGE_SPLIT_REFUND_CREATED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occurs when a charge split refund is created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a charge split refund object."},"children":[]}]}]}]}},"data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object that is a subject of this event. For example, an event with type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGE_SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object as the value of this attribute."},"children":[]}]}]}]},"log":{"type":"string","description":"Identifier of request log associated with this event.","example":"log_2KzhaJZBmylL40iGiHfZsKRm"}}}},"components/schemas/Token":{"id":"components/schemas/Token","kind":"json-schema","title":"Token","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the token","example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},"created":{"type":"integer","description":"Unix timestamp","example":1701432000},"objectType":{"type":"string","example":"token","enum":["token"]},"first6":{"type":"string","description":"First six digits of the card number","example":"424242"},"last4":{"type":"string","description":"Last four digits of the card number","example":"4242"},"fingerprint":{"type":"string","description":"Unique identifier of the card number. Can be used to check if two different charges were done using the same card number.","example":"e3d8suyIDgFg3pE7"},"expMonth":{"type":"string","description":"Two-digit expiration month","example":"12"},"expYear":{"type":"string","description":"Four-digit expiration year","example":"2030"},"brand":{"type":"string","description":"Card brand","enum":["Visa","MasterCard","American Express","Discover","JCB","Diners Club","Unknown"],"example":"Visa"},"type":{"type":"string","description":"Card type","enum":["Credit Card","Debit Card","Prepaid Card","Unknown"],"example":"Credit Card"},"country":{"type":"string","description":"Two-letter ISO 3166-1 country code of the card's issuing country","example":"US"},"cardholderName":{"type":"string","description":"Name of the cardholder","example":"John Doe"},"addressLine1":{"type":"string","description":"First line of the billing address associated with the card.","example":"1234 Market St"},"addressLine2":{"type":"string","description":"Second line of the billing address associated with the card.","example":"Suite 500"},"addressCity":{"type":"string","description":"City of the billing address associated with the card.","example":"San Francisco"},"addressState":{"type":"string","description":"State of the billing address associated with the card.","example":"CA"},"addressZip":{"type":"string","description":"ZIP or postal code of the billing address associated with the card.","example":"94103"},"addressCountry":{"type":"string","description":"Country of the billing address associated with the card, represented as a three-letter ISO country code.","example":"USA"},"used":{"type":"boolean","description":"Whether this token has already been used. Each token can be used only once.","example":false},"card":{"allOf":[{"$ref":"#/components/schemas/Card"}],"description":"Card that was created from this token."},"fraudCheckData":{"allOf":[{"$ref":"#/components/schemas/FraudCheckData"}],"description":"Additional data used for fraud protection."},"threeDSecureInfo":{"type":"object","description":"Additional data present if the card represented by this token was verified with 3D Secure.","properties":{"amount":{"type":"integer","description":"Amount (minor units) used in 3D Secure.","example":1000},"currency":{"type":"string","description":"Currency used in 3D Secure (three-letter ISO currency code).","example":"USD"},"enrolled":{"type":"boolean","description":"Whether the card used supports 3D Secure.","example":true},"liabilityShift":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the liability shift: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not started/in progress), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successful"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supported but not completed), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_possible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not supported)."},"children":[]}]}]}],"enum":["successful","failed","not_possible"],"example":"successful"},"resultReason":{"type":"string","description":"Reason for a liability shift error.","enum":["rejected","abandoned"],"example":"rejected"},"authenticationFlow":{"type":"string","description":"How the issuer authenticated the customer.","enum":["frictionless","challenge"],"example":"frictionless"},"version":{"type":"string","description":"3D Secure protocol version.","example":"2.2.0"}}}}}},"components/schemas/TokenCreate":{"id":"components/schemas/TokenCreate","kind":"json-schema","title":"TokenCreate","data":{"type":"object","description":"Card details used to create a token.","required":["number","expMonth","expYear","cvc"],"properties":{"number":{"type":"string","description":"Card number without any separators.","example":"4242424242424242"},"expMonth":{"type":"string","description":"Card expiration month.","example":"12"},"expYear":{"type":"string","description":"Card expiration year.","example":"2030"},"cvc":{"type":"string","description":"Card security code.","example":"123"},"cardholderName":{"type":"string","description":"Name of the cardholder.","example":"John Doe"},"addressLine1":{"type":"string","example":"1234 Market St"},"addressLine2":{"type":"string","example":"Suite 500"},"addressCity":{"type":"string","example":"San Francisco"},"addressState":{"type":"string","example":"CA"},"addressZip":{"type":"string","example":"94103"},"addressCountry":{"type":"string","description":"Country represented as a three-letter ISO country code.","example":"USA"},"fraudCheckData":{"allOf":[{"$ref":"#/components/schemas/FraudCheckData"}],"description":"Additional data used for fraud protection. This attribute is only supported for requests made with your API secret key. For requests made with your API public key, the value of this attribute is ignored and the data is automatically collected from the request."},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that this token should be associated with.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"}}}},"components/schemas/BlacklistRule":{"id":"components/schemas/BlacklistRule","kind":"json-schema","title":"BlacklistRule","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the blacklist rule","example":"blr_O3y7VyxbszuezuDNjuBsExUf"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the blacklist rule was created","example":1701432000},"objectType":{"type":"string","example":"blacklistRule","enum":["blacklistRule"]},"ruleType":{"type":"string","description":"Type of this blacklist rule.","example":"fingerprint","enum":["fingerprint","ip_address","ip_country","metadata","email","user_agent","accept_language","card_country","card_bin","card_issuer"],"x-enumDescriptions":{"fingerprint":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the card's fingerprint (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fingerprint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"ip_address":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the user's IP address (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.ipAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"ip_country":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the country derived from the user's IP address (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.ipCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"metadata":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on a metadata entry from the charge (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"email":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the user's email (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/customers/getcustomer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"user_agent":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the \"User-Agent\" HTTP header (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.userAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"accept_language":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the \"Accept-Language\" HTTP header (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.acceptLanguage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"card_country":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the country of the card's issuing bank (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"card_bin":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the card's BIN (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"card_issuer":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the name of the card's issuing bank (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}]}},"fingerprint":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=fingerprint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"e3d8suyIDgFg3pE7"},"ipAddress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=ip_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"203.0.113.42"},"ipCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=ip_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"metadataKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"userId"},"metadataValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"usr_1234"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"john.doe@example.com"},"userAgent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=user_agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"},"acceptLanguage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=accept_language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"en-US,en;q=0.9"},"cardCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=card_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"cardBin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=card_bin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"424242"},"cardIssuer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=card_issuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Card Issuer Name"}}}},"components/schemas/BlacklistRuleCreate":{"id":"components/schemas/BlacklistRuleCreate","kind":"json-schema","title":"BlacklistRuleCreate","data":{"type":"object","required":["ruleType"],"properties":{"ruleType":{"type":"string","description":"Type of a blacklist rule.","example":"fingerprint","enum":["fingerprint","ip_address","ip_country","metadata","email","user_agent","accept_language","card_country","card_bin","card_issuer"],"x-enumDescriptions":{"fingerprint":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the card's fingerprint (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fingerprint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"ip_address":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the user's IP address (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.ipAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"ip_country":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the country derived from the user's IP address (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.ipCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"metadata":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on a metadata entry from the charge (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/charges/getcharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"email":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the user's email (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/customers/getcustomer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"user_agent":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the \"User-Agent\" HTTP header (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.userAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"accept_language":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the \"Accept-Language\" HTTP header (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudCheckData.acceptLanguage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"card_country":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the country of the card's issuing bank (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"card_bin":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the card's BIN (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}],"card_issuer":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will blacklist based on the name of the card's issuing bank (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/cards/getcard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)."},"children":[]}]}]}]}},"fingerprint":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=fingerprint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"e3d8suyIDgFg3pE7"},"cardNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=fingerprint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If a card number is provided, it will be automatically converted to a fingerprint. When creating a fingerprint rule, you must provide either a fingerprint or a card number, but not both."},"children":[]}]}]}],"example":"4242424242424242"},"ipAddress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=ip_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"203.0.113.42"},"ipCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=ip_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"metadataKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"userId"},"metadataValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"usr_1234"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"john.doe@example.com"},"userAgent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=user_agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"},"acceptLanguage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=accept_language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"en-US,en;q=0.9"},"cardCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=card_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"cardBin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=card_bin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"424242"},"cardIssuer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType=card_issuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Card Issuer Name"}}}},"components/schemas/Credit":{"id":"components/schemas/Credit","kind":"json-schema","title":"Credit","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the credit","example":"cr_OwM7B3WWha5SIfjNSw2eUqVb"},"created":{"type":"integer","description":"Unix timestamp","example":1701432000},"objectType":{"type":"string","example":"credit","enum":["credit"]},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit amount in minor units of a given currency. For example, 10€ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10¥ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":499},"currency":{"type":"string","description":"Credit currency represented as a three-letter ISO currency code.","example":"USD"},"description":{"type":"string","description":"Credit description.","example":"Example credit"},"card":{"allOf":[{"$ref":"#/components/schemas/Card"}],"description":"Card that was used to create this credit."},"customerId":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the customer who is the owner of this credit, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this credit is not associated with any customer."},"children":[]}]}]}],"example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"threeDSecureInfo":{"type":"object","description":"3D Secure verification details, present if the card used to create this credit was verified with 3D Secure.","properties":{"amount":{"type":"integer","description":"Amount (minor units) used in 3D Secure.","example":499},"currency":{"type":"string","description":"Currency used in 3D Secure.","example":"USD"},"enrolled":{"type":"boolean","description":"Whether the card used supports 3D Secure.","example":false},"liabilityShift":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the liability shift: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not started/in progress), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successful"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supported but not completed), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_possible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not supported)."},"children":[]}]}]}],"enum":["successful","failed","not_possible"],"example":"not_possible"},"authenticationFlow":{"type":"string","description":"How the issuer authenticated the customer.","enum":["frictionless","challenge"],"example":"frictionless"}}},"receiver":{"type":"object","description":"Details of the receiver of the funds.","properties":{"firstName":{"type":"string","description":"Receiver's first name.","example":"John"},"lastName":{"type":"string","description":"Receiver's last name.","example":"Doe"},"address":{"type":"object","description":"Receiver's address.","properties":{"line1":{"type":"string","example":"1234 Market St"},"line2":{"type":"string","example":"Suite 500"},"zip":{"type":"string","example":"94103"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","description":"State or province. Required for the following countries: AU, CA, DE, US.","example":"CA"},"country":{"type":"string","description":"Two-letter ISO 3166-1 country code","example":"US"}}}}},"sender":{"type":"object","description":"Details of the sender of the funds, present if they were provided when creating the credit.","properties":{"source":{"type":"string","description":"Source of the funds.","enum":["debit_card","credit_card","prepaid_card","cash","deposit_account","credit_account","mobile_money_account"],"example":"debit_card"},"accountNumber":{"type":"string","description":"Masked number of the account the funds were sent from."},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's date of birth in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"1990-09-30"},"card":{"allOf":[{"$ref":"#/components/schemas/Card"}],"description":"Card the funds were sent from."}}},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that was used to create this credit.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the credit.","additionalProperties":{"type":"string"}},"failureCode":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code describing why the credit failed. Only present in failed credits; see the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute of the error object for possible values."},"children":[]}]}]}],"example":null},"failureMessage":{"type":"string","nullable":true,"description":"Human-readable message that describes why the credit has failed. Only present in failed credits.","example":null},"failureIssuerDeclineCode":{"type":"string","nullable":true,"description":"Code supplied by the issuer describing why the credit has failed.","example":null},"disputed":{"type":"boolean","description":"Whether the credit has been disputed.","example":false},"fast":{"type":"boolean","description":"Indicates whether the credit has been made using the fast method (fast payout).","example":true}}}},"components/schemas/FileUpload":{"id":"components/schemas/FileUpload","kind":"json-schema","title":"FileUpload","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the file upload","example":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the file upload was created","example":1701432000},"objectType":{"type":"string","example":"file_upload","enum":["file_upload"]},"purpose":{"type":"string","description":"Purpose of this file object.","example":"dispute_evidence","enum":["dispute_evidence"]},"size":{"type":"integer","description":"Size of uploaded file in bytes.","example":28461},"type":{"type":"string","description":"Type of this file object.","example":"jpg","enum":["pdf","jpg","png"]},"url":{"type":"string","description":"Read-only URL from which this file can be downloaded. Returned only when the request is authenticated with your secret key. The download link expires after 7 days."}}}},"components/schemas/FraudWarning":{"id":"components/schemas/FraudWarning","kind":"json-schema","title":"FraudWarning","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the fraud warning.","example":"fw_O7FRMgfC5g9BFqjEFepcB07J"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the fraud warning was created.","example":1609325894},"objectType":{"type":"string","example":"fraud_warning","enum":["fraud_warning"]},"charge":{"allOf":[{"$ref":"#/components/schemas/Charge"}],"description":"Charge associated with this fraud warning. By default only the charge identifier is returned."},"actionable":{"type":"boolean","description":"A fraud warning is actionable if the associated charge is not fully refunded or disputed.","example":true}}}},"components/schemas/CheckoutSessionCustomField":{"id":"components/schemas/CheckoutSessionCustomField","kind":"json-schema","title":"CheckoutSessionCustomField","data":{"type":"object","properties":{"key":{"type":"string","description":"Identifier of the custom field.","example":"engraving"},"label":{"type":"string","description":"Label of the field shown on the Checkout form.","example":"Engraving text"},"value":{"type":"string","description":"Value provided by the customer. Only present once the customer has filled in the field.","example":"Happy Birthday"},"optional":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer does not have to provide a value for this custom field."},"children":[]}]}]}],"example":true},"labelTranslations":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs with translations of the field label, keyed by language code.","example":{"es":"Texto grabado","de":"Gravurtext"}}}}},"components/schemas/CheckoutSessionStaticField":{"id":"components/schemas/CheckoutSessionStaticField","kind":"json-schema","title":"CheckoutSessionStaticField","data":{"type":"object","description":"Additional read-only information (for example, hotel reservation details) displayed in the Checkout form as a key-value pair. Static fields are informational only and cannot be edited by the customer.","properties":{"key":{"type":"string","description":"Title of the custom information.","example":"Order no."},"value":{"type":"string","description":"Text of the custom information, shown under the specified key.","example":"#21378"}}}},"components/schemas/CheckoutSessionTax":{"id":"components/schemas/CheckoutSessionTax","kind":"json-schema","title":"CheckoutSessionTax","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax applied to a product. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reuse an existing tax entry, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a new one."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Identifier of an existing tax entry.","example":"tax_kPzT0OjFR9AwGiWtSvKMcHzP"},"name":{"type":"string","description":"Tax name.","example":"VAT"},"value":{"type":"number","description":"Tax percentage.","example":23}}}},"components/schemas/CheckoutDonationAmount":{"id":"components/schemas/CheckoutDonationAmount","kind":"json-schema","title":"Customer-chosen amount","data":{"type":"object","title":"Customer-chosen amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lets the customer decide how much to pay. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both."},"children":[]}]}]}],"properties":{"options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available pre-defined payment amounts, in minor units of a given currency. Allows the customer to select from a list of options for how much they want to pay. Useful whenever you want to suggest a few selectable amounts — for example pay-what-you-want pricing, tips, or donations."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1000,2500,5000]},"custom":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible range of a custom payment amount, letting the customer enter any value between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"min":{"type":"integer","description":"Minimum value of the custom payment amount, in minor units of a given currency.","example":500},"max":{"type":"integer","description":"Maximum value of the custom payment amount, in minor units of a given currency.","example":100000}}}}}},"components/schemas/CheckoutProduct":{"id":"components/schemas/CheckoutProduct","kind":"json-schema","title":"CheckoutProduct","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item being paid for. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference an existing product, otherwise the details given here are used to create a new product, which also becomes available via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. For a subscription item, provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"Identifier of an existing product.","example":"product_kV8XmQzR3TfBnLpAyHcDe2Wj"},"name":{"type":"string","description":"Product name.","example":"Premium subscription"},"description":{"type":"string","description":"Description of the product, shown to the customer on the hosted payment page directly under the product name.","example":"Annual access to all premium features"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment amount definition. Provide an integer for a fixed-amount item, or an object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to let the customer choose the amount. A fixed amount is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a customer-chosen amount may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both together."},"children":[]}]}]}],"oneOf":[{"type":"integer","title":"Fixed amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment amount in minor units of a given currency, with the number of allowed decimal places depending on the currency. For example, €10.00 is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and ¥10 as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":9900},{"$ref":"#/components/schemas/CheckoutDonationAmount"}]},"currency":{"type":"string","description":"Three-letter ISO currency code.","example":"USD"},"plan":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the plan that should be charged. Set on subscription items instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"taxes":{"type":"array","description":"List of taxes applied to the product.","items":{"$ref":"#/components/schemas/CheckoutSessionTax"}}}}},"components/schemas/CheckoutSessionLineItem":{"id":"components/schemas/CheckoutSessionLineItem","kind":"json-schema","title":"CheckoutSessionLineItem","data":{"type":"object","description":"Product, subscription, or donation to be paid for in the checkout session.","properties":{"product":{"$ref":"#/components/schemas/CheckoutProduct"},"quantity":{"type":"number","description":"Quantity of the defined product.","example":1}}}},"components/schemas/CheckoutSession":{"id":"components/schemas/CheckoutSession","kind":"json-schema","title":"CheckoutSession","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the session.","example":"chse_LqM4nJ8vTyRbHwKpZdFcXaS2"},"clientSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token which should be passed to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout.js"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" script to open the Checkout form."},"children":[]}]}]}],"example":"chcs_Rd7WkTnPqLmYbFhJxVzCgA4N"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the session was created.","example":1715810511},"objectType":{"type":"string","example":"checkoutSession","enum":["checkoutSession"]},"status":{"type":"string","description":"Current status of the checkout session.","enum":["active","paid","expired","failed"],"example":"paid"},"lastCharge":{"type":"string","description":"Identifier of the most recent charge created by this session.","example":"char_Xy9TqMfL2VnRbKdWzHcJpA7S"},"locale":{"type":"string","description":"Two-letter abbreviation of the language in which the Checkout form is presented. If not provided, the customer's browser language is used.","enum":["en","bg","cs","da","de","el","es","et","fi","fr","hr","hu","it","lt","lv","nl","no","pl","pt","ro","ru","sk","sl","be"],"example":"en"},"lastOpened":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp (seconds) of the last time the Checkout page was opened. If it has not been opened yet, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1715810525},"lineItems":{"type":"array","description":"Products or subscriptions that require payment.","items":{"$ref":"#/components/schemas/CheckoutSessionLineItem"}},"collectBillingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the billing address.","example":true},"collectShippingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the shipping address.","example":false},"customer":{"type":"string","description":"If provided, the payment form will be linked to that customer. Saved cards may appear and the payment will be associated with the customer.","example":"cust_QmR8kZvTnJyLbWpHdXcFgA3S"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of key-value pairs attached to the session for storing additional custom data. This is never displayed to the customer on the payment page. Each key must be unique, and keys and values can be up to 255 characters long.","example":{"orderId":"order_123","campaign":"spring_sale"}},"customFieldsTitle":{"type":"string","description":"Title of the custom fields section.","example":"Additional information"},"customFieldsTitleTranslations":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs with translations of the custom fields section title, keyed by language code.","example":{"es":"Información adicional","de":"Weitere Informationen"}},"customFields":{"type":"array","description":"List of custom fields used to request additional information from the customer. Each custom field is displayed in the form as a new text field to fill out.","items":{"$ref":"#/components/schemas/CheckoutSessionCustomField"}},"staticFields":{"type":"array","description":"List of static fields shown as additional information in the Checkout form. Static fields are informational only and cannot be edited by the customer.","items":{"$ref":"#/components/schemas/CheckoutSessionStaticField"}},"capture":{"type":"boolean","description":"Whether the charge should be captured. Useful for flows such as 0-auth checkouts.","example":true},"allowSavedCards":{"type":"boolean","description":"Whether the payment form should display the option to save the customer's card details for future transactions. A customer must be assigned to use this option.","example":true},"action":{"type":"string","description":"Action performed by the Checkout form.","enum":["payment","card_verification"],"example":"payment","x-enumDescriptions":{"payment":"Charge the customer. This is the default.","card_verification":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform a $0 auth card verification. Requires both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be set."},"children":[]}]}]}]}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter ISO currency code. Used only for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action — for a regular payment, the currency from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"example":"USD"},"url":{"type":"string","description":"Link to the payment form that can be used in the Checkout redirect flow.","example":"https://pay.shift4.com/chse_LqM4nJ8vTyRbHwKpZdFcXaS2"},"redirectUrl":{"type":"string","description":"URL to which the customer will be redirected upon successful payment.","example":"https://merchant-page.com/payment-success"},"vendorReference":{"type":"string","description":"Merchant-defined descriptor related to the payment link (for example, an invoice number). This field is reportable on the merchant portal and settlement extract.","example":"custom_vendor_reference"}}}},"components/schemas/CheckoutSessionCreate":{"id":"components/schemas/CheckoutSessionCreate","kind":"json-schema","title":"CheckoutSessionCreate","data":{"type":"object","properties":{"locale":{"type":"string","description":"Two-letter abbreviation of the language in which the Checkout form is presented. If not provided, the customer's browser language is used.","enum":["en","bg","cs","da","de","el","es","et","fi","fr","hr","hu","it","lt","lv","nl","no","pl","pt","ro","ru","sk","sl","be"],"example":"en"},"lineItems":{"type":"array","description":"List of products, subscriptions, or donations to be paid for in the checkout session.","items":{"$ref":"#/components/schemas/CheckoutSessionLineItem"}},"collectBillingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the billing address.","example":true},"collectShippingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the shipping address.","example":false},"customer":{"type":"string","description":"If provided, the payment form will be linked to that customer. Saved cards may appear and the payment will be associated with the customer.","example":"cust_QmR8kZvTnJyLbWpHdXcFgA3S"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of key-value pairs attached to the session for storing additional custom data. This is never displayed to the customer on the payment page. Each key must be unique, and keys and values can be up to 255 characters long.","example":{"orderId":"order_123","campaign":"spring_sale"}},"customFieldsTitle":{"type":"string","description":"Title of the custom fields section.","example":"Additional information"},"customFieldsTitleTranslations":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs with translations of the custom fields section title, keyed by language code.","example":{"es":"Información adicional","de":"Weitere Informationen"}},"customFields":{"type":"array","description":"List of custom fields used to request additional information from the customer. Each custom field is displayed in the form as a new text field to fill out.","items":{"$ref":"#/components/schemas/CheckoutSessionCustomField"}},"staticFields":{"type":"array","description":"Allows additional key/value information to be displayed in the Checkout form.","items":{"$ref":"#/components/schemas/CheckoutSessionStaticField"}},"capture":{"type":"boolean","description":"Whether the charge should be captured. Useful for flows such as 0-auth checkouts.","example":true},"allowSavedCards":{"type":"boolean","description":"Whether the payment form should display the option to save the customer's card details for future transactions. A customer must be assigned to use this option.","example":true},"action":{"type":"string","description":"Action performed by the Checkout form.","enum":["payment","card_verification"],"example":"payment","x-enumDescriptions":{"payment":"Charge the customer. This is the default.","card_verification":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform a $0 auth card verification. Requires both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be set."},"children":[]}]}]}]}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter ISO currency code. Used only for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action — for a regular payment, the currency from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"example":"USD"},"redirectUrl":{"type":"string","description":"URL to which the customer will be redirected upon successful payment.","example":"https://merchant-page.com/payment-success"},"vendorReference":{"type":"string","description":"Merchant-defined descriptor related to the payment link (for example, an invoice number). This field is reportable on the merchant portal and settlement extract.","example":"custom_vendor_reference"}}}},"components/schemas/PaymentLinkLineItem":{"id":"components/schemas/PaymentLinkLineItem","kind":"json-schema","title":"PaymentLinkLineItem","data":{"type":"object","description":"Product, subscription, or donation to be paid for through the payment link.","properties":{"product":{"$ref":"#/components/schemas/CheckoutProduct"}}}},"components/schemas/PaymentLinkDates":{"id":"components/schemas/PaymentLinkDates","kind":"json-schema","title":"PaymentLinkDates","data":{"type":"object","description":"Activation and expiration dates.","properties":{"activatesAt":{"type":"integer","description":"Unix timestamp (seconds) at which the payment link becomes active. By default, payment links are active from the moment of creation.","example":1746021690},"expiresAt":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp (seconds) at which the payment link expires. Must be in the future and no more than 5 years from now, and must be later than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activatesAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, payment links do not expire."},"children":[]}]}]}],"example":1777557690}}}},"components/schemas/PaymentLinkRestrictions":{"id":"components/schemas/PaymentLinkRestrictions","kind":"json-schema","title":"PaymentLinkRestrictions","data":{"type":"object","description":"Time boundaries and limits on successful charges and failed payment attempts for the payment link.","properties":{"charges":{"type":"object","description":"Limits the number of successful attempts to use the payment link, and reports how many successful attempts there were.","properties":{"limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of successful charges allowed to be made using this payment link. When not set, the number of charges is not limited. For a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link this field is required and must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as such a link can only be used once."},"children":[]}]}]}],"minimum":1,"maximum":999,"example":20},"count":{"type":"integer","description":"Number of successful charges already made with the payment link. Not writable.","example":0}}},"errors":{"type":"object","description":"Limits failed payment attempts and reports how many have occurred. Present only when an error limit was set at creation.","properties":{"limit":{"type":"integer","description":"Maximum number of failed payment attempts allowed for this payment link. This limit cannot be changed after creation.","minimum":1,"maximum":999,"example":3},"count":{"type":"integer","description":"Number of failed payment attempts made with the payment link. Not writable.","example":0}}},"dates":{"$ref":"#/components/schemas/PaymentLinkDates"}}}},"components/schemas/PaymentLinkRestrictionsWrite":{"id":"components/schemas/PaymentLinkRestrictionsWrite","kind":"json-schema","title":"PaymentLinkRestrictionsWrite","data":{"type":"object","description":"Time boundaries and the optional successful-charge limit. A failed-payment limit can be set only when creating the payment link; it cannot be changed on update.","properties":{"charges":{"type":"object","description":"Limits the number of successful attempts to use the payment link.","properties":{"limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of successful charges allowed to be made using this payment link. When not set, the number of charges is not limited. For a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link this field is required and must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as such a link can only be used once."},"children":[]}]}]}],"minimum":1,"maximum":999,"example":20}}},"dates":{"$ref":"#/components/schemas/PaymentLinkDates"}}}},"components/schemas/PaymentLinkRestrictionsCreate":{"id":"components/schemas/PaymentLinkRestrictionsCreate","kind":"json-schema","title":"PaymentLinkRestrictionsCreate","data":{"allOf":[{"$ref":"#/components/schemas/PaymentLinkRestrictionsWrite"},{"type":"object","properties":{"errors":{"type":"object","description":"Optional limit on failed payment attempts. The limit can be set only when creating the payment link.","properties":{"limit":{"type":"integer","description":"Maximum number of failed payment attempts allowed for this payment link. When omitted, failed attempts are not limited.","minimum":1,"maximum":999,"example":3}}}}}]}},"components/schemas/PaymentLinkNotifications":{"id":"components/schemas/PaymentLinkNotifications","kind":"json-schema","title":"PaymentLinkNotifications","data":{"type":"object","description":"Payment link notifications.","properties":{"share":{"type":"object","description":"Controls automatically sending the payment link to the customer.","properties":{"sms":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the payment link should be sent automatically as an SMS to the assigned customer. The customer must have a phone number defined. SMS notifications are available for selected business models only — contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:devsupport@shift4.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"devsupport@shift4.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find out more."},"children":[]}]}]}],"example":true},"email":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment link is automatically sent by email to the customer. The email address is read from the customer record referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must therefore be set and must have an email address defined."},"children":[]}]}]}],"example":true}}}}}},"components/schemas/PaymentLink":{"id":"components/schemas/PaymentLink","kind":"json-schema","title":"PaymentLink","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the payment link.","example":"link_8v6pz2FEOvlDA80wOGhUhP8N"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the payment link was created.","example":1746021690},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the payment link. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-links/deactivatepaymentlink"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deactivate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-links/reactivatepaymentlink"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reactivate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints to manually change an eligible link's status. A link becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" automatically when the corresponding limit is reached."},"children":[]}]}]}],"enum":["active","scheduled","expired","deactivated","completed","failed"],"example":"active","x-enumDescriptions":{"active":"The payment link is active and functional.","scheduled":"The payment link is yet to become active.","expired":"The payment link expired and is no longer functional.","deactivated":"The payment link has been deactivated by the merchant.","completed":"The preset number of successful charges made with this payment link has been reached, so it is no longer functional.","failed":"The preset number of failed payment attempts has been reached, so the link is no longer functional and cannot be reactivated."}},"url":{"type":"string","description":"URL that can be used to process the payment defined by this payment link.","example":"https://pay.shift4.com/link_8v6pz2FEOvlDA80wOGhUhP8N"},"lastOpened":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp (seconds) when the payment link was last opened. If it has not been opened yet, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1746025976},"lineItems":{"type":"array","description":"List of items to be paid for through the payment link.","items":{"$ref":"#/components/schemas/PaymentLinkLineItem"}},"staticFields":{"type":"array","description":"List of static fields shown as additional information on the payment page. Static fields are informational only and cannot be edited by the customer.","items":{"$ref":"#/components/schemas/CheckoutSessionStaticField"}},"collectBillingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the billing address.","example":true},"collectShippingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the shipping address.","example":false},"locale":{"type":"string","description":"Two-letter abbreviation of the language that will be used on the payment page. If not provided, the customer's browser language is used.","enum":["en","bg","cs","da","de","el","es","et","fi","fr","hr","hu","it","lt","lv","nl","no","pl","pt","ro","ru","sk","sl","be"],"example":"en"},"returnUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to which the customer is redirected after completing the payment using the payment link. Must be an HTTP or HTTPS URL of up to 2048 characters. If not provided, the return URL configured in Checkout Settings is used; a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set on the payment link overrides that default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the checkout flow is completed, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkout_session_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters are appended to the redirect URL."},"children":[]}]}]}],"maxLength":2048,"example":"https://merchant.example.com/payment/return"},"restrictions":{"$ref":"#/components/schemas/PaymentLinkRestrictions"},"customer":{"type":"string","description":"Identifier of the customer associated with the charge or subscription created through the payment link.","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"allowSavedCards":{"type":"boolean","description":"Whether the payment form should display the option to save the customer's card details for future transactions. A customer must be assigned to use this option.","default":true,"example":true},"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of flow the payment link performs. When omitted, the link defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["payment","card_verification"],"example":"payment","x-enumDescriptions":{"payment":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A standard payment flow. The customer pays for the products defined in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is the default."},"children":[]}]}]}],"card_verification":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performs a $0 authorization to confirm the card is valid — a security check that a real card and cardholder are behind it — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charging it. The validated card is also saved to the customer. These links take "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"require"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be set."},"children":[]}]}]}]}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency for the authorization, represented as a three-letter ISO currency code."},"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":"Required only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" links."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" links the currency is taken from the line items and this field may be omitted."},"children":[]}]}]}],"example":"USD"},"notifications":{"$ref":"#/components/schemas/PaymentLinkNotifications"},"customFieldsTitle":{"type":"string","description":"Title of the custom fields section.","example":"Additional information"},"customFields":{"type":"array","description":"List of custom fields used to request additional information from the customer. Each custom field is displayed in the form as a new text field to fill out. Values entered by the customer are available on the checkout session associated with the charge.","items":{"$ref":"#/components/schemas/CheckoutSessionCustomField"}},"metadata":{"type":"object","description":"Set of key-value pairs attached to the payment link for storing additional custom data. This is never displayed to the customer on the payment page. Each key must be unique, and keys and values can be up to 255 characters long.","additionalProperties":{"type":"string"},"example":{"invoiceNumber":"INV_1206"}},"vendorReference":{"type":"string","description":"Merchant-defined descriptor related to the payment link (for example, an invoice number). This field is reportable on the merchant portal and settlement extract.","example":"custom_vendor_reference"}}}},"components/schemas/PaymentLinkWriteBase":{"id":"components/schemas/PaymentLinkWriteBase","kind":"json-schema","title":"PaymentLinkWriteBase","data":{"type":"object","required":["lineItems"],"properties":{"lineItems":{"type":"array","description":"List of items to be paid for through the payment link.","items":{"$ref":"#/components/schemas/PaymentLinkLineItem"}},"staticFields":{"type":"array","description":"List of static fields shown as additional information on the payment page. Static fields are informational only and cannot be edited by the customer.","items":{"$ref":"#/components/schemas/CheckoutSessionStaticField"}},"collectBillingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the billing address.","default":false,"example":true},"collectShippingAddress":{"type":"boolean","description":"Whether the customer will be asked to provide the shipping address.","default":false,"example":false},"locale":{"type":"string","description":"Two-letter abbreviation of the language that will be used on the payment page. If not provided, the customer's browser language is used.","enum":["en","bg","cs","da","de","el","es","et","fi","fr","hr","hu","it","lt","lv","nl","no","pl","pt","ro","ru","sk","sl","be"],"example":"en"},"returnUrl":{"type":"string","description":"URL to which the customer is redirected after completing the payment using the payment link. Must be an HTTP or HTTPS URL of up to 2048 characters. If not provided, the return URL configured in Checkout Settings is used.","maxLength":2048,"example":"https://merchant.example.com/payment/return"},"customer":{"type":"string","description":"Identifier of the customer that will be associated with the charge or subscription created through the payment link.","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"allowSavedCards":{"type":"boolean","description":"Whether the payment form should display the option to save the customer's card details for future transactions. A customer must be assigned to use this option.","default":true,"example":true},"notifications":{"$ref":"#/components/schemas/PaymentLinkNotifications"},"customFieldsTitle":{"type":"string","description":"Title of the custom fields section.","example":"Additional information"},"customFields":{"type":"array","description":"List of custom fields used to request additional information from the customer. Each custom field is displayed in the form as a new text field to fill out.","items":{"$ref":"#/components/schemas/CheckoutSessionCustomField"}},"metadata":{"type":"object","description":"Set of key-value pairs attached to the payment link for storing additional custom data. This is never displayed to the customer on the payment page. Each key must be unique, and keys and values can be up to 255 characters long.","additionalProperties":{"type":"string"},"example":{"invoiceNumber":"INV_1206"}}}}},"components/schemas/PaymentLinkUpdate":{"id":"components/schemas/PaymentLinkUpdate","kind":"json-schema","title":"PaymentLinkUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PaymentLinkWriteBase"},{"type":"object","properties":{"restrictions":{"$ref":"#/components/schemas/PaymentLinkRestrictionsWrite"}}}]}},"components/schemas/PaymentLinkCreate":{"id":"components/schemas/PaymentLinkCreate","kind":"json-schema","title":"PaymentLinkCreate","data":{"allOf":[{"$ref":"#/components/schemas/PaymentLinkWriteBase"},{"type":"object","properties":{"restrictions":{"$ref":"#/components/schemas/PaymentLinkRestrictionsCreate"},"action":{"type":"string","description":"Action performed when the customer opens the payment link.","enum":["payment","card_verification"],"example":"payment","x-enumDescriptions":{"payment":"Charge the customer. This is the default.","card_verification":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform a $0 auth card verification. Requires both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be set."},"children":[]}]}]}]}},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three-letter ISO currency code. Required for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action — for a regular payment, the currency from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"example":"USD"},"vendorReference":{"type":"string","description":"Merchant-side reference (for example, an invoice number).","example":"custom_vendor_reference"}}}]}},"components/schemas/PaymentLinkCharge":{"id":"components/schemas/PaymentLinkCharge","kind":"json-schema","title":"PaymentLinkCharge","data":{"type":"object","description":"Record of a charge made through a payment link.","properties":{"id":{"type":"string","description":"Unique identifier of the payment link charge.","example":"plch_GD3wYiTI2z2VybsUign6IxYx"},"chargeId":{"type":"string","description":"Identifier of the related charge.","example":"char_qTTjFTmM6uBFHrHts9gga8Ri"},"success":{"type":"boolean","description":"Whether the charge was successful.","example":true},"charge":{"$ref":"#/components/schemas/Charge"},"paymentLinkId":{"type":"string","description":"Identifier of the payment link the charge was made through.","example":"link_8v6pz2FEOvlDA80wOGhUhP8N"}}}},"components/schemas/Payout":{"id":"components/schemas/Payout","kind":"json-schema","title":"Payout","data":{"type":"object","description":"Details of funds received from the acquirer.","properties":{"id":{"type":"string","description":"Unique identifier for the payout.","example":"po_bLu3vzO8yhAFhbxFEadm6HUV"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the payout was created.","example":1413561422},"objectType":{"type":"string","example":"payout","enum":["payout"]},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout transfer amount in minor units of a given currency. For example, 10€ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10¥ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":499},"currency":{"type":"string","description":"Payout transfer currency represented as a three-letter ISO currency code.","example":"USD"},"periodStart":{"type":"integer","description":"Unix timestamp (seconds) of the payout period start.","example":1413012367},"periodEnd":{"type":"integer","description":"Unix timestamp (seconds) of the payout period end.","example":1413325441},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that was used to create this payout.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"}}}},"components/schemas/PayoutTransaction":{"id":"components/schemas/PayoutTransaction","kind":"json-schema","title":"PayoutTransaction","data":{"type":"object","description":"A single entry included in a payout, such as a charge, refund or fee.","properties":{"id":{"type":"string","description":"Unique identifier for the payout transaction.","example":"pot_Y8x0X5d5zoRj6uI26vibFwkz"},"created":{"type":"integer","description":"Unix timestamp (seconds) when the payout transaction was created.","example":1604620800},"objectType":{"type":"string","example":"payout_transaction","enum":["payout_transaction"]},"type":{"type":"string","description":"Type of this transaction.","enum":["charge","refund","credit","chargeback","chargeback_represented","reserve_withhold","reserve_release","acquirer_fee","adjustment","charge_split","charge_split_refund","received_charge_split","received_charge_split_refund"],"example":"charge","x-enumDescriptions":{"chargeback":"Disputed amount. The exact definition may vary depending on the processor.","chargeback_represented":"Disputed amount. The exact definition may vary depending on the processor.","reserve_withhold":"Amount withheld to a rolling reserve.","reserve_release":"Amount released from a rolling reserve.","acquirer_fee":"Acquirer's commission.","adjustment":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees not related to a rolling reserve, disputes or acquirer related fees — for example, custom contractual fees or card scheme related fees."},"children":[]}]}]}],"charge_split":"Amount split off a charge and sent to another account. Only returned to platforms using charge splits.","charge_split_refund":"Amount returned when a charge split is refunded. Only returned to platforms using charge splits.","received_charge_split":"Amount received from a charge split made by another account. Only returned to platforms using charge splits.","received_charge_split_refund":"Amount returned when a received charge split is refunded. Only returned to platforms using charge splits."}},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout transaction amount in minor units of a given currency. For example, 10€ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10¥ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":413},"fee":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout transaction related fee sum in minor units of a given currency. For example, 10€ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10¥ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":39},"currency":{"type":"string","description":"Payout transaction currency represented as a three-letter ISO currency code.","example":"USD"},"source":{"type":"string","description":"Identifier of the related object.","example":"char_1jmzPboimq0IDwz8zLXdX9qw"},"payout":{"type":"string","description":"Identifier of the payout this transaction is included in. Not returned for transactions belonging to a balance payout.","example":"po_gb48tN1UdWznKQHexcAAlbkK"},"description":{"type":"string","description":"Additional info from the acquirer about the transaction.","example":"Monthly service fee"},"exchangeRate":{"type":"number","description":"Exchange rate used when converting from the transaction currency to the payout currency.","example":1.0842}}}},"components/schemas/ListResponse":{"id":"components/schemas/ListResponse","kind":"json-schema","title":"ListResponse","data":{"type":"object","properties":{"list":{"type":"array","items":{}},"hasMore":{"type":"boolean","description":"Whether more results exist beyond this page","example":true}}}},"schema_56":{"kind":"json-schema","data":{"type":"object","required":["amount","currency"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required to identify what to charge. If none is provided, the customer's default payment source is used."},"children":[]}]}]}],"properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge amount in the minor units of the given currency. For example, 10 EUR is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10 JPY is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":499},"currency":{"type":"string","description":"Charge currency as a three-letter ISO 4217 code.","example":"USD"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stored-credential (credential-on-file) indicator describing how the charge is initiated: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (cardholder, unscheduled), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (merchant, unscheduled), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (first charge of a recurring series), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subsequent_recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a follow-up recurring charge). Set this for stored-credential and MIT transactions so they are flagged correctly to the card network."},"children":[]}]}]}],"enum":["first_recurring","subsequent_recurring","merchant_initiated","customer_initiated"],"example":"customer_initiated"},"description":{"type":"string","description":"Optional description shown on the charge.","example":"Example charge"},"customerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the customer to associate with this charge. Required when charging a customer's existing card. If new card data is provided together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the card is added to the customer on a successful charge."},"children":[]}]}]}],"example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"card":{"oneOf":[{"type":"string","title":"Card token or ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card to charge as a card token (e.g. from Components) or the ID of an existing card belonging to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},{"$ref":"#/components/schemas/CardCreate"}]},"paymentMethod":{"oneOf":[{"type":"string","title":"Payment method ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method to charge (for methods other than a raw card), given as the ID of an existing payment method belonging to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Inline payment-method details are also accepted — the same shape as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api/shift4-gateway/payment-methods/createpaymentmethod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create a payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request; see that endpoint for the per-method fields."},"children":[]}]}]}],"example":"pm_ORVCP4nH7Lk2QkYp"},{"$ref":"#/components/schemas/PaymentMethodCreateSummary"}]},"flow":{"type":"object","description":"Payment-process details specific to the payment method.","properties":{"returnUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL the customer is redirected to after completing payment on an external site (required for redirect payment methods). A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientObjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is appended so the charge status can be checked with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shift4.js"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://example.com/return"}}},"captured":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to immediately capture the charge. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the charge is only authorized (or pre-authorized) and must be captured within 5 days."},"children":[]}]}]}],"default":true,"example":true},"options":{"type":"object","description":"Authorization options.","properties":{"authorizationType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (pre-authorization, can be incremented) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"final"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captured=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable incremental authorization."},"children":[]}]}]}],"enum":["pre","final"],"example":"final"}}},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing details. Cannot be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"shipping":{"$ref":"#/components/schemas/Shipping"},"threeDSecure":{"type":"object","description":"3D Secure options.","properties":{"requireAttempt":{"type":"boolean","description":"Fail the charge when 3D Secure verification was not attempted.","default":false},"requireEnrolledCard":{"type":"boolean","description":"Fail the charge if the card is not enrolled for 3D Secure.","default":false},"requireSuccessfulLiabilityShiftForEnrolledCard":{"type":"boolean","description":"Fail the charge when the card supports 3D Secure but verification was not completed successfully.","default":true},"external":{"type":"object","description":"Used when authenticating with an external 3DS service.","properties":{"version":{"type":"string","description":"3DS protocol version.","enum":["2.1.0","2.2.0"],"example":"2.2.0"},"eci":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Commerce Indicator, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"05"},"authenticationValue":{"type":"string","description":"Also known as CAVV, AAV, or UCAF."},"dsTransactionId":{"type":"string","description":"dsTransID received in the ARes (required for 3DS 2)."},"acsTransactionId":{"type":"string","description":"acsTransID received in the ARes (required for 3DS 2)."},"status":{"type":"string","description":"3DS authentication status.","enum":["Y","N","A","U","R","E"],"example":"Y"}}}}},"splits":{"type":"array","description":"Split part of the charge amount to other (platform) merchants, for example to record a tip. Requires a platform account; the merchant the money is transferred to must be a platform.","items":{"$ref":"#/components/schemas/ChargeSplitCreate"}},"recipient":{"allOf":[{"$ref":"#/components/schemas/Recipient"}],"description":"Recipient details, required for account-funding / top-up transactions."},"sender":{"allOf":[{"$ref":"#/components/schemas/Sender"}],"description":"Sender details, required for top-up transactions when the sender differs from the recipient."},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account to use to process this charge.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"external":{"type":"object","description":"External references to attach to the charge.","properties":{"vendorReference":{"type":"string","description":"Additional transaction identifier used throughout Shift4's systems.","example":"custom_vendor_reference"},"schemeTransactionId":{"type":"string","description":"External, unique reference of the transaction within a payment card network.","example":"MCC123456789012"},"transactionLinkId":{"type":"string","description":"Mastercard-specific identifier linking this charge to an earlier transaction in the card scheme's network. Also known as \"TLID\".\nDoes not need to be set. Shift4 links related transactions automatically, carrying the transaction link ID from the initial charge over to subsequent ones.\nSet it only when the initial transaction was processed outside Shift4 and that series is being continued here - for example a recurring payment whose first charge was taken by another provider. Pass the transaction link ID returned by that provider.","example":"rO4mY9DvTGmchQ7hnSoKNg"}}},"collectionMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how the order was collected for this charge: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via browser), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"telephone_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via phone), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mail_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via email or postal mail)."},"children":[]}]}]}],"enum":["online_order","telephone_order","mail_order"],"example":"online_order"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}}}}]},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"object","properties":{"description":{"type":"string","description":"Updated description for the charge.","example":"New description"},"customerId":{"type":"string","description":"Associate the charge with an existing customer. Updating this field is only possible for a charge that is not assigned to any customer. Assigning a successful charge to a customer adds the card used to create that charge to the customer's cards and sets it as the customer's default card.","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"shipping":{"$ref":"#/components/schemas/Shipping"},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing details. Cannot be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fraudDetails":{"type":"object","description":"Fraud details.","properties":{"status":{"type":"string","description":"Fraud assessment to set on the charge.","enum":["safe","suspicious","fraudulent","in_progress","unknown"],"example":"safe"}}},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount to capture, in the smallest currency unit. Defaults to the full authorized amount. Must not exceed the authorized amount.","example":499}}},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount (in minor units of a given currency) by which the pre-authorized amount should be incremented. For example, 10 EUR is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10 JPY is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":500}}},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"object","required":["chargeId"],"properties":{"chargeId":{"type":"string","description":"Identifier of the charge object that should be refunded.","example":"char_bYBGkBSsSfcalm1DLqm8KBUQ"},"amount":{"type":"integer","description":"Amount (in minor units) to refund. This must be less than or equal to the current amount of the charge that is being refunded. Defaults to the current amount of the charge.","example":1000},"reason":{"type":"string","description":"Reason for the refund.","enum":["fraudulent","expired"],"example":"fraudulent"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the refund.","additionalProperties":{"type":"string"}}}},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"string","example":"char_bYBGkBSsSfcalm1DLqm8KBUQ"},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}}}]},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"object","properties":{"metadata":{"type":"object","description":"A set of key-value pairs attached to the refund.","additionalProperties":{"type":"string"}}}},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Customer email address.","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"Customer phone number.","example":"+14155550132"},"description":{"type":"string","description":"An arbitrary description for the customer.","example":"Premium customer"},"card":{"oneOf":[{"type":"string","title":"Card token or charge ID","description":"A card token (for example obtained from Components), or the identifier of a successful charge whose card should be saved to this customer. Using a charge identifier is only possible for a successful charge not already assigned to another customer, and assigns that charge to this customer.","example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},{"$ref":"#/components/schemas/CardCreate"}]},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":"Billing details to store on the customer."},"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodCreateSummary"}],"description":"A payment method to attach to the customer."},"metadata":{"type":"object","description":"A set of key-value pairs that you can attach to the customer.","additionalProperties":{"type":"string"}}}},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}}}]},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","description":"Customer email address.","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"Customer phone number.","example":"+14155550132"},"description":{"type":"string","description":"An arbitrary description for the customer.","example":"Premium customer"},"defaultCardId":{"type":"string","description":"Identifier of the card to use as the customer's default card.","example":"card_8P7OWXA5xiTS1ISnyZcum1KV"},"defaultPaymentMethodId":{"type":"string","description":"Identifier of the payment method to use as the customer's default payment method.","example":"pm_ORVCP4nH7Lk2QkYp"},"card":{"oneOf":[{"type":"string","title":"Card token or charge ID","description":"A card token (for example obtained from Components), or the identifier of a successful charge whose card should be saved to this customer. Using a charge identifier is only possible for a successful charge not already assigned to another customer, and assigns that charge to this customer.","example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},{"$ref":"#/components/schemas/CardCreate"}]},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":"Billing details to store on the customer."},"metadata":{"type":"object","description":"A set of key-value pairs that you can attach to the customer.","additionalProperties":{"type":"string"}}}},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"object","description":"Identifier of the deleted customer object.","properties":{"id":{"type":"string","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"}}},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"Card token or charge ID","required":["id"],"properties":{"id":{"type":"string","description":"A card token (for example obtained from Components), or the identifier of a successful charge whose card should be saved to this customer.","example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"}}},{"$ref":"#/components/schemas/CardCreate"}]},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Card"}}}}]},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"object","properties":{"expMonth":{"type":"string","description":"Two-digit expiration month.","example":"12"},"expYear":{"type":"string","description":"Four-digit expiration year.","example":"2030"},"cardholderName":{"type":"string","description":"Name of the cardholder.","example":"John Doe"},"addressLine1":{"type":"string","example":"1234 Market St"},"addressLine2":{"type":"string","example":"Suite 500"},"addressCity":{"type":"string","example":"San Francisco"},"addressState":{"type":"string","example":"CA"},"addressZip":{"type":"string","example":"94103"},"addressCountry":{"type":"string","description":"Country represented as a three-letter ISO country code.","example":"USA"},"checkFastCredit":{"type":"boolean","description":"Whether to refresh the card's fast credit support status.","example":true}}},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"object","description":"Identifier of the deleted card object.","properties":{"id":{"type":"string","example":"card_8P7OWXA5xiTS1ISnyZcum1KV"}}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodBase"}}}}]},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"object","required":["customerId","planId"],"properties":{"customerId":{"type":"string","description":"Identifier of the customer who will be the owner of this subscription.","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"planId":{"type":"string","description":"Identifier of the plan that will be assigned to this subscription.","example":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"card":{"oneOf":[{"type":"string","title":"Card token or charge ID","description":"A card token (for example obtained from Components), or the identifier of a successful charge whose card should be saved to this customer. Using a charge identifier is only possible for a successful charge not already assigned to another customer, and assigns that charge to this customer.","example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},{"$ref":"#/components/schemas/CardCreate"}]},"quantity":{"type":"integer","default":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiplier applied to the amount defined in the plan. For example, a plan with amount=100 used in a subscription with quantity=5 will result in charges with amount=500."},"children":[]}]}]}],"example":1},"captureCharges":{"type":"boolean","default":true,"description":"Whether charges created by this subscription are captured immediately (see the captured attribute in the charge request). If set to false, you need to manually capture each charge created by this subscription."},"trialEnd":{"type":"integer","description":"Unix timestamp defining the end of the trial period for this subscription. If provided, it overrides the trial setting defined in the plan.","example":1714521600},"shipping":{"allOf":[{"$ref":"#/components/schemas/Shipping"}],"description":"Shipping details for this subscription."},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":"Billing details for this subscription."},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that will be used to create charges for this subscription.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the subscription.","additionalProperties":{"type":"string"}}}},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}}]},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"object","properties":{"planId":{"type":"string","description":"Identifier of the plan that will be assigned to this subscription.","example":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"card":{"oneOf":[{"type":"string","title":"Card token or charge ID","description":"A card token (for example obtained from Components), or the identifier of a successful charge whose card should be saved to this customer. Using a charge identifier is only possible for a successful charge not already assigned to another customer, and assigns that charge to this customer.","example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},{"$ref":"#/components/schemas/CardCreate"}]},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiplier applied to the amount defined in the plan. For example, a plan with amount=100 used in a subscription with quantity=5 will result in charges with amount=500."},"children":[]}]}]}],"example":5},"captureCharges":{"type":"boolean","description":"Whether charges created by this subscription are captured immediately (see the captured attribute in the charge request). If set to false, you need to manually capture each charge created by this subscription."},"currentPeriodEnd":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the end of the current cycle for this subscription and a billing date for the next one. Should be sent as a Unix timestamp. The special value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"now"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to end the cycle and start a new one immediately. If the subscription is currently in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trialing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, it affects the trial period."},"children":[]}]}]}],"example":"1714521600"},"shipping":{"allOf":[{"$ref":"#/components/schemas/Shipping"}],"description":"Shipping details for this subscription."},"billing":{"allOf":[{"$ref":"#/components/schemas/Billing"}],"description":"Billing details for this subscription."},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that will be used to create charges for this subscription.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the subscription.","additionalProperties":{"type":"string"}}}},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":1000},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionCharge"}},"totalCount":{"type":"integer","description":"Total number of subscription charge records.","example":2}}}]},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"object","required":["amount","currency","interval","name"],"properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription charge amount in minor units of the given currency. For example, 10€ is represented as \"1000\" and 10¥ is represented as \"10\"."},"children":[]}]}]}],"example":499},"currency":{"type":"string","description":"Subscription charge currency represented as a three-letter ISO currency code.","example":"USD"},"interval":{"type":"string","description":"Frequency of the subscription charges.","enum":["hour","day","week","month","year"],"example":"day"},"name":{"type":"string","description":"Display name of this plan.","example":"Example plan"},"intervalCount":{"type":"integer","default":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of intervals between the subscription charges. For example, interval=day and intervalCount=10 will result in a charge every 10 days."},"children":[]}]}]}],"example":10},"billingCycles":{"type":"integer","description":"Number of charges after which the subscription will be automatically canceled. Value of null means no limit on the number of charges. Required for a plan that recurs to another plan.","example":12},"trialPeriodDays":{"type":"integer","default":0,"description":"Number of days between the creation of the subscription and the first charge.","example":0},"recursTo":{"type":"string","description":"When the subscription is automatically canceled (due to reaching the limit of billingCycles), it will move to the plan defined by this attribute.","example":"plan_kFvuXpO2yhAFhbxTEaqm4HDW"},"splits":{"type":"array","maxItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows to transfer part of a charge amount to the given merchant. Applied to every charge made within this plan. The amount of splits cannot be greater than 75% of that charge amount. Only one split is allowed. The merchant the money is transferred to must be a platform."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeSplitCreate"}},"metadata":{"type":"object","description":"A set of key-value pairs attached to the plan.","additionalProperties":{"type":"string"}}}},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Plan"}}}}]},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"object","properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription charge amount in minor units of the given currency. For example, 10€ is represented as \"1000\" and 10¥ is represented as \"10\"."},"children":[]}]}]}],"example":499},"currency":{"type":"string","description":"Subscription charge currency represented as a three-letter ISO currency code.","example":"USD"},"name":{"type":"string","description":"Display name of this plan.","example":"New plan"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the plan.","additionalProperties":{"type":"string"}}}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"object","description":"Identifier of the deleted plan object.","properties":{"id":{"type":"string","example":"plan_bLu3vzO8yhAFhbxFEadm6HUV"}}},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}}]},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"object","required":["amount","currency","returnUrl","card"],"properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount used in the 3D Secure process (in minor units of the given currency). For example, 10 EUR is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10 JPY is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must match the amount that will be used later to create a charge."},"children":[]}]}]}],"example":1000},"currency":{"type":"string","description":"Currency used in the 3D Secure process (three-letter ISO currency code). Must match the currency that will be used later to create a charge.","example":"USD"},"returnUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL that will be displayed to the user after the 3D Secure process is completed. The following parameters are appended to this URL: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (identifier of the token that was used for this 3D Secure process) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"liabilityShift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successful"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"https://example.com/"},"card":{"oneOf":[{"type":"string","title":"Card token or ID","description":"A card token (for example obtained from Components), or the identifier of an existing card that is associated with a customer.","example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},{"$ref":"#/components/schemas/CardCreate"}]}}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"object","properties":{"enrolled":{"type":"boolean","description":"Whether the card used to start this 3D Secure process supports 3D Secure.","example":true},"version":{"type":"string","description":"Version of 3D Secure which will be used for this 3D Secure process.","example":"2.2.0"},"redirectUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL that must be used to complete the 3D Secure process by the user. The user must either be redirected to this URL, or this URL must be displayed to the user in an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<iframe>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tag."},"children":[]}]}]}],"example":"https://api.shift4.com/3d-secure/start/35WSIRL2Qm1JKsDXMohFVhGVj5AFptAhuN7Sa0oQ"},"token":{"allOf":[{"$ref":"#/components/schemas/Token"}],"description":"Token that is being used for this 3D Secure process. This token must be used to create a charge after this 3D Secure process is completed."}}},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/BlacklistRule"}}}}]},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object","description":"Identifier of the deleted blacklist rule object.","properties":{"id":{"type":"string","example":"blr_O3y7VyxbszuezuDNjuBsExUf"}}},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit amount in minor units of a given currency. For example, 10€ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 10¥ is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":499},"currency":{"type":"string","description":"Credit currency represented as a three-letter ISO currency code.","example":"USD"},"description":{"type":"string","description":"Optional description of the credit.","example":"Example credit"},"customerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the customer that will be associated with this credit. Required when creating the credit with the customer's existing card. If new card data is provided together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a successful credit adds that card to the customer's cards and sets it as the default one."},"children":[]}]}]}],"example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"card":{"oneOf":[{"type":"string","title":"Card token or ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card to credit as a card token (e.g. from Components) or the ID of an existing card belonging to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the card is not provided, the customer's default card is used."},"children":[]}]}]}],"example":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},{"$ref":"#/components/schemas/CardCreate"}]},"receiver":{"type":"object","description":"Details of the receiver of the funds.","properties":{"firstName":{"type":"string","description":"Receiver's first name.","example":"John"},"lastName":{"type":"string","description":"Receiver's last name.","example":"Doe"},"address":{"type":"object","description":"Receiver's address.","properties":{"line1":{"type":"string","example":"1234 Market St"},"line2":{"type":"string","example":"Suite 500"},"zip":{"type":"string","example":"94103"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","description":"State or province. Required for the following countries: AU, CA, DE, US.","example":"CA"},"country":{"type":"string","description":"Two-letter ISO 3166-1 country code","example":"US"}}}}},"sender":{"type":"object","description":"Details of the sender of the funds.","properties":{"firstName":{"type":"string","description":"Sender's first name.","example":"Jane"},"lastName":{"type":"string","description":"Sender's last name.","example":"Roe"},"address":{"type":"object","description":"Sender's address.","properties":{"line1":{"type":"string","example":"1234 Market St"},"line2":{"type":"string","example":"Suite 500"},"zip":{"type":"string","example":"94103"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","description":"State or province. Required for the following countries: AU, CA, DE, US.","example":"CA"},"country":{"type":"string","description":"Two-letter ISO 3166-1 country code","example":"US"}}}}},"merchantAccountId":{"type":"string","description":"Identifier of the merchant account that will be used to create this credit.","example":"ma_RHCN1yhubdBpSCgKcYAGb0xH"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the credit.","additionalProperties":{"type":"string"}}}},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Credit"}}}}]},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"object","properties":{"customerId":{"type":"string","description":"Identifier of the customer that will be associated with this credit. Updating this field is only possible for a credit that is not assigned to any other customer. Assigning a successful credit to a customer adds the card used to create that credit to the customer's cards and sets it as the customer's default one.","example":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"description":{"type":"string","description":"Description of the credit.","example":"New description"},"metadata":{"type":"object","description":"A set of key-value pairs attached to the credit.","additionalProperties":{"type":"string"}}}},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Dispute"}}}}]},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"object","properties":{"submit":{"type":"boolean","default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", evidence would be submitted for review."},"children":[]}]}]}]},"evidence":{"allOf":[{"$ref":"#/components/schemas/DisputeEvidence"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating any attribute in evidence will submit all fields for review, unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submit=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total size of all file uploads in evidence cannot exceed 8.2 MB."},"children":[]}]}]}]}}},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"object","required":["file","purpose"],"properties":{"file":{"type":"string","format":"binary","description":"File that should be uploaded. File size should not exceed 8MB (8388608 bytes)."},"purpose":{"type":"string","description":"Purpose of this file object.","enum":["dispute_evidence"]}}},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"string","enum":["dispute_evidence"]},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/FileUpload"}}}}]},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/FraudWarning"}}}}]},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Payout"}}}}]},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"string","example":"po_bLu3vzO8yhAFhbxFEadm6HUV"},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PayoutTransaction"}}}}]},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutSession"}}}}]},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"string","enum":["active","scheduled","expired","deactivated","completed","failed"]},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PaymentLink"}}}}]},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ListResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PaymentLinkCharge"}}}}]},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"string","example":"client_char_ORFRrwOrGkGsDwM3H50OICSD"},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status to transition the payment process to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successful"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" marks the payment as completed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" marks it as failed."},"children":[]}]}]}],"enum":["successful","failed"],"example":"successful"}}},"id":"schema_111"}},"exampleStore":{"paths/~1charges/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"amount":499,"currency":"USD","card":"tok_NGsyDoJQXop5Pqqi6HizbJTe","description":"Example charge"},"id":"paths/~1charges/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1charges/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~1charges/post/responses/402/content/application~1json/example"},"paths/~1charges~1{chargeId}/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"description":"New description"},"id":"paths/~1charges~1{chargeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1refunds/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"chargeId":"char_bYBGkBSsSfcalm1DLqm8KBUQ","amount":1000},"id":"paths/~1refunds/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1refunds/post/responses/200/content/application~1json/example":{"value":{"id":"re_bYBGkBSsSfcalm1DLqm8KBUQ","created":1711929600,"objectType":"refund","amount":1000,"currency":"USD","charge":"char_bYBGkBSsSfcalm1DLqm8KBUQ","reason":"fraudulent","status":"successful","metadata":{}},"id":"paths/~1refunds/post/responses/200/content/application~1json/example"},"paths/~1refunds/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~1refunds/post/responses/402/content/application~1json/example"},"paths/~1refunds~1{refundId}/get/responses/200/content/application~1json/example":{"value":{"id":"re_bYBGkBSsSfcalm1DLqm8KBUQ","created":1711929600,"objectType":"refund","amount":1000,"currency":"USD","charge":"char_bYBGkBSsSfcalm1DLqm8KBUQ","reason":"fraudulent","status":"successful","metadata":{}},"id":"paths/~1refunds~1{refundId}/get/responses/200/content/application~1json/example"},"paths/~1refunds~1{refundId}/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"metadata[orderId]":"12345"},"id":"paths/~1refunds~1{refundId}/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1customers/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"email":"john.doe@example.com","description":"Premium customer"},"id":"paths/~1customers/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1customers/post/responses/200/content/application~1json/example":{"value":{"id":"cust_AoR0wvgntQWRUYMdZNLYMz5R","created":1701432000,"objectType":"customer","email":"john.doe@example.com","phoneNumber":"+14155550132","description":"Premium customer","defaultCardId":"card_8P7OWXA5xiTS1ISnyZcum1KV","cards":[{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","expMonth":"12","expYear":"2030","brand":"Visa","type":"Credit Card","country":"US","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R"}],"metadata":{}},"id":"paths/~1customers/post/responses/200/content/application~1json/example"},"paths/~1customers/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~1customers/post/responses/402/content/application~1json/example"},"paths/~1customers~1{customerId}/get/responses/200/content/application~1json/example":{"value":{"id":"cust_AoR0wvgntQWRUYMdZNLYMz5R","created":1701432000,"objectType":"customer","email":"john.doe@example.com","phoneNumber":"+14155550132","description":"Premium customer","defaultCardId":"card_8P7OWXA5xiTS1ISnyZcum1KV","cards":[{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","expMonth":"12","expYear":"2030","brand":"Visa","type":"Credit Card","country":"US","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R"}],"metadata":{}},"id":"paths/~1customers~1{customerId}/get/responses/200/content/application~1json/example"},"paths/~1customers~1{customerId}/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"email":"john.doe@example.com","description":"Premium customer"},"id":"paths/~1customers~1{customerId}/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1customers~1{customerId}/post/responses/200/content/application~1json/example":{"value":{"id":"cust_AoR0wvgntQWRUYMdZNLYMz5R","created":1701432000,"objectType":"customer","email":"john.doe@example.com","phoneNumber":"+14155550132","description":"Premium customer","defaultCardId":"card_8P7OWXA5xiTS1ISnyZcum1KV","cards":[{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","expMonth":"12","expYear":"2030","brand":"Visa","type":"Credit Card","country":"US","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R"}],"metadata":{}},"id":"paths/~1customers~1{customerId}/post/responses/200/content/application~1json/example"},"paths/~1customers~1{customerId}/delete/responses/200/content/application~1json/example":{"value":{"id":"cust_AoR0wvgntQWRUYMdZNLYMz5R"},"id":"paths/~1customers~1{customerId}/delete/responses/200/content/application~1json/example"},"paths/~1customers~1{customerId}~1cards/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~1customers~1{customerId}~1cards/post/responses/402/content/application~1json/example"},"paths/~1customers~1{customerId}~1cards~1{cardId}/delete/responses/200/content/application~1json/example":{"value":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV"},"id":"paths/~1customers~1{customerId}~1cards~1{cardId}/delete/responses/200/content/application~1json/example"},"paths/~1payment-methods/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"type":"ideal","billing[address][country]":"NL"},"id":"paths/~1payment-methods/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1subscriptions/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","planId":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"id":"paths/~1subscriptions/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1subscriptions/post/responses/200/content/application~1json/example":{"value":{"id":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5","created":1711929600,"objectType":"subscription","planId":"plan_bLu3vzO8yhAFhbxFEadm6HUV","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","quantity":1,"captureCharges":true,"status":"active","start":1711929600,"currentPeriodStart":1711929600,"currentPeriodEnd":1712793600,"cancelAtPeriodEnd":false,"metadata":{}},"id":"paths/~1subscriptions/post/responses/200/content/application~1json/example"},"paths/~1subscriptions/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~1subscriptions/post/responses/402/content/application~1json/example"},"paths/~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example":{"value":{"id":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5","created":1711929600,"objectType":"subscription","planId":"plan_bLu3vzO8yhAFhbxFEadm6HUV","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","quantity":1,"captureCharges":true,"status":"active","start":1711929600,"currentPeriodStart":1711929600,"currentPeriodEnd":1712793600,"cancelAtPeriodEnd":false,"metadata":{}},"id":"paths/~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"},"paths/~1subscriptions~1{subscriptionId}/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"planId":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"id":"paths/~1subscriptions~1{subscriptionId}/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1subscriptions~1{subscriptionId}/post/responses/200/content/application~1json/example":{"value":{"id":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5","created":1711929600,"objectType":"subscription","planId":"plan_bLu3vzO8yhAFhbxFEadm6HUV","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","quantity":5,"captureCharges":true,"status":"active","start":1711929600,"currentPeriodStart":1711929600,"currentPeriodEnd":1712793600,"cancelAtPeriodEnd":false,"metadata":{}},"id":"paths/~1subscriptions~1{subscriptionId}/post/responses/200/content/application~1json/example"},"paths/~1subscriptions~1{subscriptionId}/delete/responses/200/content/application~1json/example":{"value":{"id":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5","created":1711929600,"objectType":"subscription","planId":"plan_bLu3vzO8yhAFhbxFEadm6HUV","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","quantity":1,"captureCharges":true,"status":"canceled","start":1711929600,"currentPeriodStart":1711929600,"currentPeriodEnd":1712793600,"canceledAt":1712016000,"endedAt":1712016000,"cancelAtPeriodEnd":false,"metadata":{}},"id":"paths/~1subscriptions~1{subscriptionId}/delete/responses/200/content/application~1json/example"},"paths/~1subscriptions~1{subscriptionId}~1charges/get/responses/200/content/application~1json/example":{"value":{"list":[{"id":123457,"created":1712793600,"subscription":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5","plan":"plan_bLu3vzO8yhAFhbxFEadm6HUV","charge":"char_ORVCrwOrTkGsDwM3H50OIW7Q","status":"success","cycle":2,"rebill":true},{"id":123456,"created":1711929600,"subscription":"sub_vrEaVmRDW0oKz8ycyy8Yc4l5","plan":"plan_bLu3vzO8yhAFhbxFEadm6HUV","charge":"char_bYBGkBSsSfcalm1DLqm8KBUQ","status":"success","cycle":1,"rebill":false}],"hasMore":false,"totalCount":2},"id":"paths/~1subscriptions~1{subscriptionId}~1charges/get/responses/200/content/application~1json/example"},"paths/~1plans/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"amount":499,"currency":"USD","interval":"day","intervalCount":10,"name":"Example plan"},"id":"paths/~1plans/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1plans/post/responses/200/content/application~1json/example":{"value":{"id":"plan_bLu3vzO8yhAFhbxFEadm6HUV","created":1711929600,"objectType":"plan","amount":499,"currency":"USD","interval":"day","intervalCount":10,"billingCycles":null,"name":"Example plan","trialPeriodDays":0,"recursTo":null,"metadata":{}},"id":"paths/~1plans/post/responses/200/content/application~1json/example"},"paths/~1plans~1{planId}/get/responses/200/content/application~1json/example":{"value":{"id":"plan_bLu3vzO8yhAFhbxFEadm6HUV","created":1711929600,"objectType":"plan","amount":499,"currency":"USD","interval":"day","intervalCount":10,"name":"Example plan","trialPeriodDays":0},"id":"paths/~1plans~1{planId}/get/responses/200/content/application~1json/example"},"paths/~1plans~1{planId}/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"name":"New plan"},"id":"paths/~1plans~1{planId}/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1plans~1{planId}/post/responses/200/content/application~1json/example":{"value":{"id":"plan_bLu3vzO8yhAFhbxFEadm6HUV","created":1711929600,"objectType":"plan","amount":499,"currency":"USD","interval":"day","intervalCount":10,"name":"New plan","trialPeriodDays":0},"id":"paths/~1plans~1{planId}/post/responses/200/content/application~1json/example"},"paths/~1plans~1{planId}/delete/responses/200/content/application~1json/example":{"value":{"id":"plan_bLu3vzO8yhAFhbxFEadm6HUV"},"id":"paths/~1plans~1{planId}/delete/responses/200/content/application~1json/example"},"paths/~1events~1{eventId}/get/responses/200/content/application~1json/example":{"value":{"id":"event_EY7CzyQiffJykW8rC5wSRnAj","created":1701432000,"objectType":"event","type":"CHARGE_SUCCEEDED","data":{"id":"char_ORVCrwOrTkGsDwM3H50OIW7Q","created":1701432000,"objectType":"charge","amount":1000,"currency":"USD","description":"Example charge","card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","brand":"Visa","type":"Credit Card","issuer":"Card Issuer Name","country":"US"},"captured":true,"refunded":false,"disputed":false},"log":"log_2KzhaJZBmylL40iGiHfZsKRm"},"id":"paths/~1events~1{eventId}/get/responses/200/content/application~1json/example"},"paths/~1tokens/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"number":"4242424242424242","expMonth":"12","expYear":"2030","cvc":"123","cardholderName":"John Doe"},"id":"paths/~1tokens/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1tokens/post/responses/200/content/application~1json/example":{"value":{"id":"tok_NGsyDoJQXop5Pqqi6HizbJTe","created":1701432000,"objectType":"token","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","brand":"Visa","type":"Credit Card","country":"US","used":false},"id":"paths/~1tokens/post/responses/200/content/application~1json/example"},"paths/~1tokens/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~1tokens/post/responses/402/content/application~1json/example"},"paths/~1tokens~1{tokenId}/get/responses/200/content/application~1json/example":{"value":{"id":"tok_NGsyDoJQXop5Pqqi6HizbJTe","created":1701432000,"objectType":"token","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","brand":"Visa","type":"Credit Card","country":"US","used":false},"id":"paths/~1tokens~1{tokenId}/get/responses/200/content/application~1json/example"},"paths/~13d-secure/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"amount":1000,"currency":"USD","returnUrl":"https://example.com/","card":"tok_NGsyDoJQXop5Pqqi6HizbJTe"},"id":"paths/~13d-secure/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~13d-secure/post/responses/200/content/application~1json/example":{"value":{"enrolled":true,"version":"2.2.0","redirectUrl":"https://api.shift4.com/3d-secure/start/35WSIRL2Qm1JKsDXMohFVhGVj5AFptAhuN7Sa0oQ","token":{"id":"tok_RBZVaNlPj70nNIQ2cIB2lYMI","created":1701432000,"objectType":"token","first6":"401200","last4":"0016","fingerprint":"8bTF2cbb2ccGr7ws","expMonth":"12","expYear":"2030","brand":"Visa","type":"Credit Card","country":"US","used":false,"threeDSecureInfo":{"amount":1000,"currency":"USD","enrolled":true,"liabilityShift":"failed","version":"2.2.0"}}},"id":"paths/~13d-secure/post/responses/200/content/application~1json/example"},"paths/~13d-secure/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~13d-secure/post/responses/402/content/application~1json/example"},"paths/~1blacklist/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"ruleType":"fingerprint","fingerprint":"e3d8suyIDgFg3pE7"},"id":"paths/~1blacklist/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1blacklist/post/responses/200/content/application~1json/example":{"value":{"id":"blr_O3y7VyxbszuezuDNjuBsExUf","created":1701432000,"objectType":"blacklistRule","ruleType":"fingerprint","fingerprint":"e3d8suyIDgFg3pE7"},"id":"paths/~1blacklist/post/responses/200/content/application~1json/example"},"paths/~1blacklist~1{blacklistRuleId}/get/responses/200/content/application~1json/example":{"value":{"id":"blr_O3y7VyxbszuezuDNjuBsExUf","created":1701432000,"objectType":"blacklistRule","ruleType":"fingerprint","fingerprint":"e3d8suyIDgFg3pE7"},"id":"paths/~1blacklist~1{blacklistRuleId}/get/responses/200/content/application~1json/example"},"paths/~1blacklist~1{blacklistRuleId}/delete/responses/200/content/application~1json/example":{"value":{"id":"blr_O3y7VyxbszuezuDNjuBsExUf"},"id":"paths/~1blacklist~1{blacklistRuleId}/delete/responses/200/content/application~1json/example"},"paths/~1credits/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"amount":499,"currency":"USD","card":"tok_NGsyDoJQXop5Pqqi6HizbJTe","description":"Example credit"},"id":"paths/~1credits/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1credits/post/responses/200/content/application~1json/example":{"value":{"id":"cr_OwM7B3WWha5SIfjNSw2eUqVb","created":1701432000,"objectType":"credit","amount":499,"currency":"USD","description":"Example credit","card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","brand":"Visa","type":"Credit Card","country":"US","issuer":"Card Issuer Name","merchantAccountId":"ma_RHCN1yhubdBpSCgKcYAGb0xH","fastCredit":{"supported":true,"updated":1701432000}},"customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","fast":true,"disputed":false,"metadata":{}},"id":"paths/~1credits/post/responses/200/content/application~1json/example"},"paths/~1credits/post/responses/402/content/application~1json/example":{"value":{"error":{"type":"card_error","code":"invalid_number","message":"The card number is not a valid credit card number."}},"id":"paths/~1credits/post/responses/402/content/application~1json/example"},"paths/~1credits/post/responses/403/content/application~1json/example":{"value":{"error":{"type":"invalid_request","message":"You have no access to Credit API. Please contact our Support for details."}},"id":"paths/~1credits/post/responses/403/content/application~1json/example"},"paths/~1credits/get/responses/403/content/application~1json/example":{"value":{"error":{"type":"invalid_request","message":"You have no access to Credit API. Please contact our Support for details."}},"id":"paths/~1credits/get/responses/403/content/application~1json/example"},"paths/~1credits~1{creditId}/get/responses/200/content/application~1json/example":{"value":{"id":"cr_OwM7B3WWha5SIfjNSw2eUqVb","created":1701432000,"objectType":"credit","amount":499,"currency":"USD","description":"Example credit","card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","brand":"Visa","type":"Credit Card","country":"US","issuer":"Card Issuer Name","merchantAccountId":"ma_RHCN1yhubdBpSCgKcYAGb0xH","fastCredit":{"supported":true,"updated":1701432000}},"customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","fast":true,"disputed":false,"metadata":{}},"id":"paths/~1credits~1{creditId}/get/responses/200/content/application~1json/example"},"paths/~1credits~1{creditId}/get/responses/403/content/application~1json/example":{"value":{"error":{"type":"invalid_request","message":"You have no access to Credit API. Please contact our Support for details."}},"id":"paths/~1credits~1{creditId}/get/responses/403/content/application~1json/example"},"paths/~1credits~1{creditId}/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"description":"New description"},"id":"paths/~1credits~1{creditId}/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1credits~1{creditId}/post/responses/403/content/application~1json/example":{"value":{"error":{"type":"invalid_request","message":"You have no access to Credit API. Please contact our Support for details."}},"id":"paths/~1credits~1{creditId}/post/responses/403/content/application~1json/example"},"paths/~1disputes~1{disputeId}/get/responses/200/content/application~1json/example":{"value":{"id":"disp_GOqyiOF9575FUYMZ73gjNrcY","created":1701432000,"objectType":"dispute","updated":1701432000,"amount":1000,"currency":"USD","status":"CHARGEBACK_NEW","reason":"GENERAL","acceptedAsLost":false,"charge":{"id":"char_ORVCrwOrTkGsDwM3H50OIW7Q","created":1701432000,"objectType":"charge","amount":1000,"currency":"USD","card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","brand":"Visa","type":"Credit Card","country":"US","issuer":"Card Issuer Name"},"customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","captured":true,"refunded":false,"disputed":true},"evidence":{"productDescription":"Exclusive black shoes","customerCommunication":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"evidenceDetails":{"hasEvidence":true,"submissionCount":1,"dueBy":1702432000}},"id":"paths/~1disputes~1{disputeId}/get/responses/200/content/application~1json/example"},"paths/~1disputes~1{disputeId}/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"submit":false},"id":"paths/~1disputes~1{disputeId}/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1disputes~1{disputeId}/post/responses/200/content/application~1json/example":{"value":{"id":"disp_GOqyiOF9575FUYMZ73gjNrcY","created":1701432000,"objectType":"dispute","updated":1701432000,"amount":1000,"currency":"USD","status":"CHARGEBACK_NEW","reason":"GENERAL","acceptedAsLost":false,"charge":{"id":"char_ORVCrwOrTkGsDwM3H50OIW7Q","created":1701432000,"objectType":"charge","amount":1000,"currency":"USD","card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","brand":"Visa","type":"Credit Card","country":"US","issuer":"Card Issuer Name"},"customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","captured":true,"refunded":false,"disputed":true},"evidence":{"productDescription":"Exclusive black shoes","customerCommunication":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"evidenceDetails":{"hasEvidence":true,"submissionCount":1,"dueBy":1702432000}},"id":"paths/~1disputes~1{disputeId}/post/responses/200/content/application~1json/example"},"paths/~1disputes~1{disputeId}~1close/post/responses/200/content/application~1json/example":{"value":{"id":"disp_GOqyiOF9575FUYMZ73gjNrcY","created":1701432000,"objectType":"dispute","updated":1701432000,"amount":1000,"currency":"USD","status":"CHARGEBACK_NEW","reason":"GENERAL","acceptedAsLost":true,"charge":{"id":"char_ORVCrwOrTkGsDwM3H50OIW7Q","created":1701432000,"objectType":"charge","amount":1000,"currency":"USD","card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1701432000,"objectType":"card","first6":"424242","last4":"4242","fingerprint":"e3d8suyIDgFg3pE7","expMonth":"12","expYear":"2030","cardholderName":"John Doe","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","brand":"Visa","type":"Credit Card","country":"US","issuer":"Card Issuer Name"},"customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","captured":true,"refunded":false,"disputed":true},"evidence":{"productDescription":"Exclusive black shoes","customerCommunication":"file_2nayTQXBBjaVEPVtCwGCbqOj"},"evidenceDetails":{"hasEvidence":true,"submissionCount":1,"dueBy":1702432000}},"id":"paths/~1disputes~1{disputeId}~1close/post/responses/200/content/application~1json/example"},"paths/~1files/post/responses/200/content/application~1json/example":{"value":{"id":"file_2nayTQXBBjaVEPVtCwGCbqOj","created":1701432000,"objectType":"file_upload","purpose":"dispute_evidence","size":28461,"type":"jpg"},"id":"paths/~1files/post/responses/200/content/application~1json/example"},"paths/~1files/post/responses/400/content/application~1json/example":{"value":{"error":{"type":"invalid_request","message":"Not supported extension gif"}},"id":"paths/~1files/post/responses/400/content/application~1json/example"},"paths/~1files/post/responses/413/content/application~1json/example":{"value":{"error":{"type":"invalid_request","message":"Maximum file size of 26214400B exceeded."}},"id":"paths/~1files/post/responses/413/content/application~1json/example"},"paths/~1files~1{fileUploadId}/get/responses/200/content/application~1json/example":{"value":{"id":"file_2nayTQXBBjaVEPVtCwGCbqOj","created":1701432000,"objectType":"file_upload","purpose":"dispute_evidence","size":28461,"type":"jpg"},"id":"paths/~1files~1{fileUploadId}/get/responses/200/content/application~1json/example"},"paths/~1fraud-warnings/get/responses/200/content/application~1json/example":{"value":{"list":[{"id":"fw_O7FRMgfC5g9BFqjEFepcB07J","created":1609325894,"objectType":"fraud_warning","charge":"char_ZNmWK4pUECfFQTY0N4WMKeh3","actionable":true}],"hasMore":true},"id":"paths/~1fraud-warnings/get/responses/200/content/application~1json/example"},"paths/~1fraud-warnings~1{fraudWarningId}/get/responses/200/content/application~1json/example":{"value":{"id":"fw_O7FRMgfC5g9BFqjEFepcB07J","created":1609325894,"objectType":"fraud_warning","charge":"char_ZNmWK4pUECfFQTY0N4WMKeh3","actionable":true},"id":"paths/~1fraud-warnings~1{fraudWarningId}/get/responses/200/content/application~1json/example"},"paths/~1payouts/get/responses/200/content/application~1json/example":{"value":{"list":[{"id":"po_bLu3vzO8yhAFhbxFEadm6HUV","created":1413561422,"objectType":"payout","periodEnd":1413325441,"periodStart":1413012367,"amount":499,"currency":"USD"}],"hasMore":true},"id":"paths/~1payouts/get/responses/200/content/application~1json/example"},"paths/~1payouts/post/responses/200/content/application~1json/example":{"value":{"id":"po_bLu3vzO8yhAFhbxFEadm6HUV","created":1413561422,"objectType":"payout","periodEnd":1413325441,"periodStart":1413012367,"amount":499,"currency":"USD"},"id":"paths/~1payouts/post/responses/200/content/application~1json/example"},"paths/~1payouts/post/responses/400/content/application~1json/example":{"value":{"error":{"type":"invalid_request","message":"Cannot create test payout for live account. Use test mode apikey."}},"id":"paths/~1payouts/post/responses/400/content/application~1json/example"},"paths/~1payouts~1{payoutId}/get/responses/200/content/application~1json/example":{"value":{"id":"po_bLu3vzO8yhAFhbxFEadm6HUV","created":1413561422,"objectType":"payout","periodEnd":1413325441,"periodStart":1413012367,"amount":499,"currency":"USD"},"id":"paths/~1payouts~1{payoutId}/get/responses/200/content/application~1json/example"},"paths/~1payout-transactions/get/responses/200/content/application~1json/example":{"value":{"list":[{"id":"pot_Y8x0X5d5zoRj6uI26vibFwkz","created":1604620800,"objectType":"payout_transaction","type":"charge","amount":413,"currency":"USD","fee":39,"source":"char_1jmzPboimq0IDwz8zLXdX9qw","payout":"po_gb48tN1UdWznKQHexcAAlbkK"}],"hasMore":true},"id":"paths/~1payout-transactions/get/responses/200/content/application~1json/example"},"paths/~1checkout-sessions/post/requestBody/content/application~1json/example":{"value":{"locale":"en","lineItems":[{"product":{"name":"Premium subscription","amount":9900,"currency":"USD"},"quantity":1}],"collectBillingAddress":true,"collectShippingAddress":false,"metadata":{"orderId":"order_123","campaign":"spring_sale"},"customFieldsTitle":"Additional information","customFields":[{"key":"engraving","label":"Engraving text","optional":true}],"staticFields":[{"key":"Order no.","value":"#21378"}],"action":"payment","capture":true,"redirectUrl":"https://merchant-page.com/payment-success","vendorReference":"custom_vendor_reference"},"id":"paths/~1checkout-sessions/post/requestBody/content/application~1json/example"},"paths/~1checkout-sessions/post/responses/200/content/application~1json/example":{"value":{"id":"chse_LqM4nJ8vTyRbHwKpZdFcXaS2","clientSecret":"chcs_Rd7WkTnPqLmYbFhJxVzCgA4N","created":1715810511,"objectType":"checkoutSession","status":"active","locale":"en","lastOpened":null,"lineItems":[{"product":{"id":"product_kV8XmQzR3TfBnLpAyHcDe2Wj","name":"Premium subscription","amount":9900,"currency":"USD"},"quantity":1}],"collectBillingAddress":true,"collectShippingAddress":false,"customer":"cust_QmR8kZvTnJyLbWpHdXcFgA3S","metadata":{"orderId":"order_123","campaign":"spring_sale"},"customFieldsTitle":"Additional information","customFields":[{"key":"engraving","label":"Engraving text","optional":true}],"staticFields":[{"key":"Order no.","value":"#21378"}],"action":"payment","capture":true,"allowSavedCards":true,"url":"https://pay.shift4.com/chse_LqM4nJ8vTyRbHwKpZdFcXaS2","redirectUrl":"https://merchant-page.com/payment-success","vendorReference":"custom_vendor_reference"},"id":"paths/~1checkout-sessions/post/responses/200/content/application~1json/example"},"paths/~1checkout-sessions/get/responses/200/content/application~1json/example":{"value":{"list":[{"id":"chse_LqM4nJ8vTyRbHwKpZdFcXaS2","created":1715810511,"objectType":"checkoutSession","status":"paid","lastCharge":"char_Xy9TqMfL2VnRbKdWzHcJpA7S","locale":"en","lineItems":[{"product":{"name":"Example charge","amount":1000,"currency":"USD"}}],"customFieldsTitle":"Additional information","customFields":[{"key":"vatNumber","label":"VAT number","value":"PL1234567890","optional":false}],"collectBillingAddress":false,"collectShippingAddress":false}],"hasMore":true},"id":"paths/~1checkout-sessions/get/responses/200/content/application~1json/example"},"paths/~1checkout-sessions~1{checkoutSessionId}/get/responses/200/content/application~1json/example":{"value":{"id":"chse_LqM4nJ8vTyRbHwKpZdFcXaS2","created":1715810511,"objectType":"checkoutSession","status":"paid","lastCharge":"char_Xy9TqMfL2VnRbKdWzHcJpA7S","locale":"en","lineItems":[{"product":{"name":"Example charge","amount":1000,"currency":"USD"}}],"customFieldsTitle":"Additional information","customFields":[{"key":"vatNumber","label":"VAT number","value":"PL1234567890","optional":false}],"collectBillingAddress":false,"collectShippingAddress":false},"id":"paths/~1checkout-sessions~1{checkoutSessionId}/get/responses/200/content/application~1json/example"},"paths/~1payment-links/post/requestBody/content/application~1json/example":{"value":{"returnUrl":"https://merchant.example.com/payment/return","lineItems":[{"product":{"name":"Example charge","amount":1000,"currency":"USD"}}],"staticFields":[{"key":"Order no.","value":"#21378"}],"customFieldsTitle":"Additional information","customFields":[{"key":"special_wishes","label":"Special wishes","optional":true}],"vendorReference":"custom_vendor_reference","restrictions":{"errors":{"limit":3}}},"id":"paths/~1payment-links/post/requestBody/content/application~1json/example"},"paths/~1payment-links/post/responses/200/content/application~1json/example":{"value":{"id":"link_8v6pz2FEOvlDA80wOGhUhP8N","created":1746021690,"status":"active","url":"https://pay.shift4.com/link_8v6pz2FEOvlDA80wOGhUhP8N","returnUrl":"https://merchant.example.com/payment/return","lineItems":[{"product":{"name":"Example charge","amount":1000,"currency":"USD"}}],"staticFields":[{"key":"Order no.","value":"#21378"}],"collectBillingAddress":false,"collectShippingAddress":false,"allowSavedCards":true,"customFieldsTitle":"Additional information","customFields":[{"key":"special_wishes","label":"Special wishes","optional":true}],"metadata":{},"vendorReference":"custom_vendor_reference","restrictions":{"errors":{"limit":3,"count":0}}},"id":"paths/~1payment-links/post/responses/200/content/application~1json/example"},"paths/~1payment-links/get/responses/200/content/application~1json/example":{"value":{"list":[{"id":"link_8v6pz2FEOvlDA80wOGhUhP8N","created":1746021690,"status":"active","url":"https://pay.shift4.com/link_8v6pz2FEOvlDA80wOGhUhP8N","lineItems":[{"product":{"name":"Example charge","amount":1000,"currency":"USD"}}],"collectBillingAddress":false,"collectShippingAddress":false,"customFields":[],"metadata":{}},{"id":"link_odedW8aombcWuu6VIZulYKny","created":1746025976,"status":"active","url":"https://pay.shift4.com/link_odedW8aombcWuu6VIZulYKny","lineItems":[{"product":{"plan":"plan_bLu3vzO8yhAFhbxFEadm6HUV"}}],"collectBillingAddress":true,"collectShippingAddress":false,"customer":"cust_AoR0wvgntQWRUYMdZNLYMz5R","customFields":[],"metadata":{}}],"hasMore":true},"id":"paths/~1payment-links/get/responses/200/content/application~1json/example"},"paths/~1payment-links~1{paymentLinkId}/get/responses/200/content/application~1json/example":{"value":{"id":"link_odedW8aombcWuu6VIZulYKny","created":1746025976,"status":"active","url":"https://pay.shift4.com/link_odedW8aombcWuu6VIZulYKny","lineItems":[{"product":{"plan":"plan_bLu3vzO8yhAFhbxFEadm6HUV"}}],"collectBillingAddress":true,"collectShippingAddress":false,"customer":"cust_AoR0wvgntQWRUYMdZNLYMz5R","metadata":{}},"id":"paths/~1payment-links~1{paymentLinkId}/get/responses/200/content/application~1json/example"},"paths/~1payment-links~1{paymentLinkId}/post/requestBody/content/application~1json/example":{"value":{"lineItems":[{"product":{"name":"Another example charge","amount":1000,"currency":"USD"}}],"collectBillingAddress":true},"id":"paths/~1payment-links~1{paymentLinkId}/post/requestBody/content/application~1json/example"},"paths/~1payment-links~1{paymentLinkId}/post/responses/200/content/application~1json/example":{"value":{"id":"link_8v6pz2FEOvlDA80wOGhUhP8N","created":1746021690,"status":"active","url":"https://pay.shift4.com/link_8v6pz2FEOvlDA80wOGhUhP8N","returnUrl":"https://merchant.example.com/payment/return","lineItems":[{"product":{"name":"Another example charge","amount":1000,"currency":"USD"}}],"collectBillingAddress":true,"collectShippingAddress":false,"customFields":[],"customer":"cust_AoR0wvgntQWRUYMdZNLYMz5R","allowSavedCards":true,"metadata":{}},"id":"paths/~1payment-links~1{paymentLinkId}/post/responses/200/content/application~1json/example"},"paths/~1payment-links~1{paymentLinkId}~1deactivate/post/responses/200/content/application~1json/example":{"value":{"id":"link_8v6pz2FEOvlDA80wOGhUhP8N","created":1746021690,"status":"deactivated","url":"https://pay.shift4.com/link_8v6pz2FEOvlDA80wOGhUhP8N","lineItems":[{"product":{"name":"Example charge","amount":1000,"currency":"USD"}}],"collectBillingAddress":true,"collectShippingAddress":false,"metadata":{}},"id":"paths/~1payment-links~1{paymentLinkId}~1deactivate/post/responses/200/content/application~1json/example"},"paths/~1payment-links~1{paymentLinkId}~1reactivate/post/responses/200/content/application~1json/example":{"value":{"id":"link_8v6pz2FEOvlDA80wOGhUhP8N","created":1746021690,"status":"active","url":"https://pay.shift4.com/link_8v6pz2FEOvlDA80wOGhUhP8N","lineItems":[{"product":{"name":"Example charge","amount":1000,"currency":"USD"}}],"collectBillingAddress":true,"collectShippingAddress":false,"metadata":{}},"id":"paths/~1payment-links~1{paymentLinkId}~1reactivate/post/responses/200/content/application~1json/example"},"paths/~1payment-links~1{paymentLinkId}~1charges/get/responses/200/content/application~1json/example":{"value":{"list":[{"id":"plch_GD3wYiTI2z2VybsUign6IxYx","chargeId":"char_Xy9TqMfL2VnRbKdWzHcJpA7S","success":true,"charge":{"id":"char_Xy9TqMfL2VnRbKdWzHcJpA7S","created":1746021700,"objectType":"charge","amount":1000,"currency":"USD","customerId":"cust_AoR0wvgntQWRUYMdZNLYMz5R","captured":true,"refunded":false,"disputed":false,"status":"successful","card":{"id":"card_8P7OWXA5xiTS1ISnyZcum1KV","created":1746021700,"objectType":"card","first6":"424242","last4":"4242","expMonth":"12","expYear":"2030","brand":"Visa","type":"Credit Card","country":"US"}},"paymentLinkId":"link_8v6pz2FEOvlDA80wOGhUhP8N"}],"hasMore":false},"id":"paths/~1payment-links~1{paymentLinkId}~1charges/get/responses/200/content/application~1json/example"},"paths/~1charges~1{clientChargeId}/post/responses/200/content/application~1json/example":{"value":{"objectType":"charge","amount":100,"currency":"USD","status":"successful","clientObjectId":"client_char_ORFRrwOrGkGsDwM3H50OICSD","paymentMethod":{"objectType":"payment_method","clientObjectId":"client_pm_SdwbMm2nBFmAldpgJWBuqAeF","type":"blik","status":"chargeable","flow":{"nextAction":"none"}},"flow":{"nextAction":"none"}},"id":"paths/~1charges~1{clientChargeId}/post/responses/200/content/application~1json/example"}},"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":"The Shift4 API uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your API secret key is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the username and the password is empty, so the header is the base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encoding of your key followed by a colon:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic base64(\"<your_secret_key>:\")\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the trailing colon — it is the empty password, and the request fails"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without it. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic c2tfdGVzdF9hYmMxMjM6\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most HTTP clients do this for you when given a username and an empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -u sk_test_abc123:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", live keys start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sk_live_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-defaultUsername":"pr_test_tXHm9qV9qV9bjIRHcQr9PLPa"}},"servers":[{"url":"https://api.shift4.com","description":"Production API"}]},"options":{"codeSamples":{"languages":[{"lang":"curl","label":"cURL"},{"lang":"Java"},{"lang":"PHP"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/api/shift4-gateway.json?download"},{"url":"/_bundle/docs/api/shift4-gateway.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Shift4 Gateway API","description":"The Shift4 API is organized around REST. Our API has predictable resource-oriented URLs,\naccepts form-encoded request bodies, returns JSON-encoded responses, and uses standard\nHTTP response codes, authentication, and verbs.\n\n## Base URL\n\nAll API requests should be made to:\n\n```\nhttps://api.shift4.com\n```\n\n## Authentication\n\nThe Shift4 API uses HTTP Basic Authentication. Provide your API secret key as the\nusername and leave the password empty.\n\n```bash\ncurl https://api.shift4.com/charges -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:\n```\n"}},"baseSlug":"/docs/api/shift4-gateway","routesMapping":{}}