from gr4vy import Gr4vy
import os
with Gr4vy(
id="example",
server="sandbox",
merchant_account_id="default",
bearer_auth=auth.with_token(open("./private_key.pem").read())
):
res = g_client.payment_service_definitions.list(cursor="ZXhhbXBsZTE", limit=20)
while res is not None:
# Handle items
res = res.next()
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.paymentServiceDefinitions.list();
for await (const page of result) {
console.log(page);
}
}
run();
from gr4vy import Gr4vy
import os
with Gr4vy(
id="example",
server="sandbox",
merchant_account_id="default",
bearer_auth=auth.with_token(open("./private_key.pem").read())
):
res = g_client.payment_service_definitions.list(cursor="ZXhhbXBsZTE", limit=20)
while res is not None:
# Handle items
res = res.next()
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.paymentServiceDefinitions.list();
for await (const page of result) {
console.log(page);
}
}
run();
{
"type": "error",
"code": "server_error",
"status": 500,
"message": "Request could not be processed",
"details": []
}
{
"type": "error",
"code": "bad_gateway",
"status": 502,
"message": "Request could not be processed",
"details": []
}
{
"type": "error",
"code": "gateway_timeout",
"status": 504,
"message": "Request could not be processed",
"details": []
}
This API is different from the list connection definitions because
it only returns definitions for payment services and not anti-fraud and gift card services.This endpoint requires the payment-service-definitions.read scope.
The cursor pointing at the previous page of items.
Required string length: 1 - 1000
Example:
"Xkjss7asS"
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Gr4vy","colors":{"primary":"#0066CC","light":"#0099FF","dark":"#0066CC"},"logo":{"light":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99","dark":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/dark.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=7a09594217c27f95e0d127250c4cc958"},"favicon":"https://mintcdn.com/flexxbuy/39tfKGesfNHyX7HE/assets/favicon.png?fit=max\u0026auto=format\u0026n=39tfKGesfNHyX7HE\u0026q=85\u0026s=fc89afd637da9116e218f41f2c6b1105","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["csharp","go","java","php","python","javascript","curl"]},"mdx":{"auth":{"method":"bearer"},"server":["https://api.sandbox.flexxbuy.gr4vy.app","https://api.flexxbuy.gr4vy.app"]}},"navbar":{"links":[{"icon":"bell","href":"https://status.gr4vy.com","label":"Status"},{"icon":"github","href":"https://github.com/gr4vy","label":"GitHub"}],"primary":{"type":"button","label":"Gr4vy","href":"https://gr4vy.com/#form-contact"}},"footer":{"socials":{"website":"https://gr4vy.com","twitter":"https://twitter.com/Gr4vyInc","github":"https://github.com/gr4vy","linkedin":"https://www.linkedin.com/company/gr4vy-inc"},"links":[{"header":"About","items":[{"label":"Payment orchestration","href":"https://gr4vy.com/payment-orchestration"},{"label":"Gr4vy for merchants","href":"https://gr4vy.com/merchants"},{"label":"Gr4vy for platforms","href":"https://gr4vy.com/platforms"},{"label":"Increasing your revenue","href":"https://gr4vy.com/revenue"}]},{"header":"Developers","items":[{"label":"GitHub","href":"https://github.com/gr4vy"},{"label":"Latest news","href":"https://docs.gr4vy.com/updates"},{"label":"System status","href":"https://status.gr4vy.com"},{"label":"Customer support","href":"https://support.gr4vy.com"}]}]},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"G-9CX4E9QWKQ"}},"contextual":{"options":["chatgpt","claude","copy","view"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexxbuy","hasAudioNarration":false,"actualSubdomain":"flexxbuy","customDomains":["docs.byzly.com"],"gitSource":{"type":"github","owner":"gr4vy","repo":"flexxbuy-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf64bc3d6319f7be041995","collectionId":"bdb65d06-a21b-40ca-800b-8b423f379e82","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf64bc3d6319f7be041995"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf64bc3d6319f7be041995","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Build","count":195},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Connections","count":168},{"language":"default","tag":"Methods","count":141},{"language":"default","tag":"Features","count":95},{"language":"default","tag":"Integration guides","count":91},{"language":"default","tag":"Banking","count":46},{"language":"default","tag":"Dashboard","count":44},{"language":"default","tag":"Other","count":39},{"language":"default","tag":"Embed","count":38}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".payment-service-definition{background-color:#fff!important;border:1px solid #0a0e0d1a;border-radius:16px;padding:2em;vertical-align:middle}.payment-service-definition img{margin:0 1em 0 0;max-width:3em;display:inline-block}.payment-service-definition h2{margin:0;display:inline-block;position:relative;top:.1em}#sidebar-title{text-transform:uppercase}#sidebar-group .group{flex-direction:row-reverse}#footer .max-w-36{max-width:40rem}"}],"page":{"pagePath":"reference/payment-service-definitions/list-payment-service-definitions","slug":"/reference/payment-service-definitions/list-payment-service-definitions","pageMetadata":{"openapi":"openapi.speakeasy.json GET /payment-service-definitions","title":"List payment service definitions","description":"List the definitions of each payment service that can be configured.","href":"/reference/payment-service-definitions/list-payment-service-definitions"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"List the definitions of each payment service that can be configured.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This API is different from the `,_jsx(_components.a,{href:`/reference/connections/list-connection-definitions`,children:`list connection definitions`}),` because\nit only returns definitions for payment services and not anti-fraud and gift card services.`]}),`\n`,_jsxs(_components.p,{children:[`This endpoint requires the `,_jsx(_components.code,{children:`payment-service-definitions.read`}),` scope.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"openapi.speakeasy.json GET /payment-service-definitions","title":"List payment service definitions","description":"List the definitions of each payment service that can be configured.","href":"/reference/payment-service-definitions/list-payment-service-definitions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payment service definitions"],"summary":"List payment service definitions","description":"List the definitions of each payment service that can be configured.","operationId":"list_payment_service_definitions","parameters":["1132b6a0-b643-4d6c-919c-966b33ad12ef","9fe96693-aa76-4b63-8557-8bc03111b7eb"],"responses":{"200":"f82ee443-af91-4b5e-b19b-73c7c1dc6f94","400":"c193b107-9ed7-434e-ac68-56d16a4501c0","401":"83e209de-8c01-41c0-801a-ba58d8cd925a","403":"f5900d1c-7ca7-42f3-beb9-127fad247d99","404":"0cbc621f-f9dc-4d67-957c-e8940e07e2b5","405":"ec0a127a-8bbf-413c-a8ec-1057a4cc7a7d","409":"8fafa896-e8bc-4f1d-9255-3535221919d8","422":"d5002009-a193-411d-b8f3-8c19c9fbe71b","425":"929339f0-744d-41fa-a426-1ebfef13a10a","429":"0129dd0f-cfb7-4cf8-b8c5-9bf3d02456dd","500":"4f148605-9aa6-4a22-93f3-a6edd9b804ae","502":"ef5738e8-f1d0-47cb-9d9e-3b33befdf0d1","504":"5724f34e-0ccd-4d8b-abc1-d8d46ada24ff"},"x-speakeasy-name-override":"list","x-speakeasy-group":"payment-service-definitions","x-speakeasy-pagination":{"type":"cursor","inputs":[{"name":"cursor","in":"parameters","type":"cursor"}],"outputs":{"nextCursor":"$.next_cursor"}},"x-speakeasy-retries":{"strategy":"backoff","backoff":{"initialInterval":200,"maxInterval":200,"maxElapsedTime":1000,"exponent":1},"statusCodes":["5XX"],"retryConnectionErrors":true},"x-codeSamples":[{"lang":"go","label":"Go","source":"package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tgr4vygo \"github.com/gr4vy/gr4vy-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := gr4vy.New(\n\t\tgr4vy.WithID(\"example\"),\n\t\tgr4vy.WithServer(gr4vy.ServerSandbox),\n\t\tgr4vy.WithSecuritySource(withToken),\n\t\tgr4vy.WithMerchantAccountID(\"default\"),\n\t)\n\n res, err := s.PaymentServiceDefinitions.List(ctx, gr4vygo.Pointer(\"ZXhhbXBsZTE\"), gr4vygo.Pointer[int64](20))\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}"},{"lang":"javascript","label":"TypeScript","source":"import { Gr4vy, withToken } from \"@gr4vy/sdk\";\nimport fs from \"fs\";\n\nconst gr4vy = new Gr4vy({\n id: \"example\",\n server: \"sandbox\",\n merchantAccountId: \"default\",\n bearerAuth: withToken({\n privateKey: fs.readFileSync(\"private_key.pem\", \"utf8\"),\n }),\n});\n\nasync function run() {\n const result = await gr4vy.paymentServiceDefinitions.list();\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"},{"lang":"java","label":"Java","source":"package hello.world;\n\nimport com.gr4vy.sdk.Gr4vy;\nimport com.gr4vy.sdk.models.errors.*;\nimport com.gr4vy.sdk.models.operations.ListPaymentServiceDefinitionsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Gr4vy sdk = Gr4vy.builder()\n .id(\"example\")\n .server(AvailableServers.SANDBOX)\n .merchantAccountId(\"default\")\n .securitySource(new BearerSecuritySource.Builder(privateKey).build())\n .build();\n\n\n sdk.paymentServiceDefinitions().list()\n .cursor(\"ZXhhbXBsZTE\")\n .limit(20L)\n .callAsStream()\n .forEach((ListPaymentServiceDefinitionsResponse item) -> {\n // handle page\n });\n\n }\n}"},{"lang":"python","label":"Python","source":"from gr4vy import Gr4vy\nimport os\n\n\nwith Gr4vy(\n id=\"example\",\n server=\"sandbox\",\n merchant_account_id=\"default\",\n bearer_auth=auth.with_token(open(\"./private_key.pem\").read())\n):\n\n res = g_client.payment_service_definitions.list(cursor=\"ZXhhbXBsZTE\", limit=20)\n\n while res is not None:\n # Handle items\n\n res = res.next()"},{"lang":"csharp","label":"C#","source":"using Gr4vy;\nusing Gr4vy.Models.Components;\nusing Gr4vy.Models.Requests;\n\nvar sdk = new Gr4vySDK(\n id: \"example\",\n server: SDKConfig.Server.Sandbox,\n bearerAuthSource: Auth.WithToken(privateKey),\n merchantAccountId: \"default\"\n);\n\nListPaymentServiceDefinitionsResponse? res = await sdk.PaymentServiceDefinitions.ListAsync(\n cursor: \"ZXhhbXBsZTE\",\n limit: 20\n);\n\nwhile(res != null)\n{\n // handle items\n\n res = await res.Next!();\n}"},{"lang":"php","label":"PHP","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Gr4vy;\n\n$sdk = Gr4vy\\SDK::builder()\n ->setId('example')\n ->setServer('sandbox')\n ->setSecuritySource(Auth::withToken($privateKey))\n ->setMerchantAccountId('default')\n ->build();\n\n\n\n$responses = $sdk->paymentServiceDefinitions->list(\n cursor: 'ZXhhbXBsZTE',\n limit: 20\n\n);\n\n\nforeach ($responses as $response) {\n if ($response->statusCode === 200) {\n // handle response\n }\n}"}],"method":"get","type":"path","servers":["0048b136-b0cb-4528-8f3a-95ce1a20d337","b15a1711-bb6b-4cdf-9106-1a445dacccf7"],"security":["1c94c691-caf6-424e-b0d4-912fcc945a19"],"path":"/payment-service-definitions","baseUrlOptions":["https://api.sandbox.{id}.gr4vy.app","https://api.{id}.gr4vy.app"],"title":"List payment service definitions","codeSamples":[{"label":"Go","lang":"go","source":"package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tgr4vygo \"github.com/gr4vy/gr4vy-go\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := gr4vy.New(\n\t\tgr4vy.WithID(\"example\"),\n\t\tgr4vy.WithServer(gr4vy.ServerSandbox),\n\t\tgr4vy.WithSecuritySource(withToken),\n\t\tgr4vy.WithMerchantAccountID(\"default\"),\n\t)\n\n res, err := s.PaymentServiceDefinitions.List(ctx, gr4vygo.Pointer(\"ZXhhbXBsZTE\"), gr4vygo.Pointer[int64](20))\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}"},{"label":"TypeScript","lang":"javascript","source":"import { Gr4vy, withToken } from \"@gr4vy/sdk\";\nimport fs from \"fs\";\n\nconst gr4vy = new Gr4vy({\n id: \"example\",\n server: \"sandbox\",\n merchantAccountId: \"default\",\n bearerAuth: withToken({\n privateKey: fs.readFileSync(\"private_key.pem\", \"utf8\"),\n }),\n});\n\nasync function run() {\n const result = await gr4vy.paymentServiceDefinitions.list();\n\n for await (const page of result) {\n console.log(page);\n }\n}\n\nrun();"},{"label":"Java","lang":"java","source":"package hello.world;\n\nimport com.gr4vy.sdk.Gr4vy;\nimport com.gr4vy.sdk.models.errors.*;\nimport com.gr4vy.sdk.models.operations.ListPaymentServiceDefinitionsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Gr4vy sdk = Gr4vy.builder()\n .id(\"example\")\n .server(AvailableServers.SANDBOX)\n .merchantAccountId(\"default\")\n .securitySource(new BearerSecuritySource.Builder(privateKey).build())\n .build();\n\n\n sdk.paymentServiceDefinitions().list()\n .cursor(\"ZXhhbXBsZTE\")\n .limit(20L)\n .callAsStream()\n .forEach((ListPaymentServiceDefinitionsResponse item) -> {\n // handle page\n });\n\n }\n}"},{"label":"Python","lang":"python","source":"from gr4vy import Gr4vy\nimport os\n\n\nwith Gr4vy(\n id=\"example\",\n server=\"sandbox\",\n merchant_account_id=\"default\",\n bearer_auth=auth.with_token(open(\"./private_key.pem\").read())\n):\n\n res = g_client.payment_service_definitions.list(cursor=\"ZXhhbXBsZTE\", limit=20)\n\n while res is not None:\n # Handle items\n\n res = res.next()"},{"label":"C#","lang":"csharp","source":"using Gr4vy;\nusing Gr4vy.Models.Components;\nusing Gr4vy.Models.Requests;\n\nvar sdk = new Gr4vySDK(\n id: \"example\",\n server: SDKConfig.Server.Sandbox,\n bearerAuthSource: Auth.WithToken(privateKey),\n merchantAccountId: \"default\"\n);\n\nListPaymentServiceDefinitionsResponse? res = await sdk.PaymentServiceDefinitions.ListAsync(\n cursor: \"ZXhhbXBsZTE\",\n limit: 20\n);\n\nwhile(res != null)\n{\n // handle items\n\n res = await res.Next!();\n}"},{"label":"PHP","lang":"php","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Gr4vy;\n\n$sdk = Gr4vy\\SDK::builder()\n ->setId('example')\n ->setServer('sandbox')\n ->setSecuritySource(Auth::withToken($privateKey))\n ->setMerchantAccountId('default')\n ->build();\n\n\n\n$responses = $sdk->paymentServiceDefinitions->list(\n cursor: 'ZXhhbXBsZTE',\n limit: 20\n\n);\n\n\nforeach ($responses as $response) {\n if ($response->statusCode === 200) {\n // handle response\n }\n}"}],"requestExampleLanguages":["csharp","go","java","php","python","javascript","bash"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"1132b6a0-b643-4d6c-919c-966b33ad12ef":{"name":"cursor","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Cursor","description":"A pointer to the page of results to return.","example":"ZXhhbXBsZTE","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Cursor","description":"A pointer to the page of results to return.","example":"ZXhhbXBsZTE","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"A pointer to the page of results to return."},"9fe96693-aa76-4b63-8557-8bc03111b7eb":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of items that are at returned.","examples":[20],"default":20,"title":"Limit","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"The maximum number of items that are at returned."}},"responses":{"f82ee443-af91-4b5e-b19b-73c7c1dc6f94":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"id":{"type":"string","maxLength":50,"minLength":1,"title":"Id","description":"The definition ID of the payment service that can be configured. This is the underlying provider followed by a dash followed by the method.","examples":["adyen-ideal","stripe-card"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"display_name":{"type":"string","maxLength":200,"minLength":1,"title":"Display Name","description":"A human friendly name for this service.","examples":["iDEAL","Stripe"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].display_name","typeLabel":"string"},"method":{"description":"The method of the service","examples":["ideal","card"],"type":"string","enum":["abitab","affirm","afterpay","alipay","alipayhk","applepay","arcuspaynetwork","bacs","bancontact","bank","bcp","becs","bitpay","blik","ach","boleto","boost","breb","capitec","card","cashapp","cashappafterpay","chaseorbital","clearpay","click-to-pay","custom_push","custom_redirect","custom_tokenize","dana","dcb","dlocal","duitnow","ebanx","eckoh","efecty","eps","everydaypay","gcash","gem","gemds","gift-card","giropay","givingblock","gocardless","googlepay","googlepay_pan_only","gopay","grabpay","ideal","interac","kakaopay","kcp","khipu","klarna","konbini","latitude","latitudeds","laybuy","linepay","linkaja","maybankqrpay","mercadopago","multibanco","multipago","nequi","netbanking","network-token","nupay","oney_10x","oney_12x","oney_3x","oney_4x","oney_6x","onlinebankingcz","onelink","ovo","oxxo","p24","pagoefectivo","paybybank","payid","paymaya","paysquad","paypal","paypaldirectorder","paypalpaylater","paypay","payto","payvalida","paze","picpay","pix","plaid","pse","rabbitlinepay","razorpay","rapipago","redpagos","scalapay","sepa","servipag","seveneleven","sezzle","shopeepay","singteldash","smartpay","sofort","spei","stitch","swish","stripe","stripedd","stripetoken","tapi","tapifintechs","thaiqr","touchngo","truemoney","trustly","trustlyeurope","upi","venmo","vipps","waave","webpay","wechat","wero","yape","zippay"],"title":"Method","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"\\items.items.[INDEX].method","typeLabel":"enum\u003cstring>"},"fields":{"items":{"properties":{"key":{"type":"string","maxLength":50,"minLength":1,"title":"Key","description":"The key of a field that can be submitted.","examples":["private_api_key"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].fields.items.[INDEX].key","typeLabel":"string"},"display_name":{"type":"string","maxLength":200,"minLength":1,"title":"Display Name","description":"The human readable name for this field.","examples":["Private API key"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].fields.items.[INDEX].display_name","typeLabel":"string"},"required":{"type":"boolean","title":"Required","description":"Defines if this field is required when the service is created.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].fields.items.[INDEX].required","typeLabel":"boolean"},"format":{"description":"Defines the type of input that needs to be rendered for this field.","examples":["text"],"type":"string","enum":["text","multiline","file","number","timezone","boolean"],"title":"DefinitionFieldFormat","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"\\items.items.[INDEX].fields.items.[INDEX].format","typeLabel":"enum\u003cstring>"},"secret":{"type":"boolean","title":"Secret","description":"Defines if this field is secret. When `true` the field's value is not returned when querying the payment service information.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].fields.items.[INDEX].secret","typeLabel":"boolean"},"verifiable":{"type":"boolean","title":"Verifiable","description":"Defines if this field can be verified through the verify credentials button.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].fields.items.[INDEX].verifiable","typeLabel":"boolean"}},"additionalProperties":false,"type":"object","required":["key","display_name","required","format","secret","verifiable"],"title":"DefinitionField","description":"A single field that needs to be submitted for a payment service when it is created.","uniqueKey":"\\items.items.[INDEX].fields.items.[INDEX]","typeLabel":"DefinitionField · object"},"type":"array","title":"Fields","description":"A list of credentials and related fields which can be configured for this service.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].fields","typeLabel":"DefinitionField · object[]"},"reporting_fields":{"items":{"properties":{"key":{"type":"string","maxLength":50,"minLength":1,"title":"Key","description":"The key of a field that can be submitted.","examples":["private_api_key"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].reporting_fields.items.[INDEX].key","typeLabel":"string"},"display_name":{"type":"string","maxLength":200,"minLength":1,"title":"Display Name","description":"The human readable name for this field.","examples":["Private API key"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].reporting_fields.items.[INDEX].display_name","typeLabel":"string"},"required":{"type":"boolean","title":"Required","description":"Defines if this field is required when the service is created.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].reporting_fields.items.[INDEX].required","typeLabel":"boolean"},"format":{"description":"Defines the type of input that needs to be rendered for this field.","examples":["text"],"type":"string","enum":["text","multiline","file","number","timezone","boolean"],"title":"DefinitionFieldFormat","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"\\items.items.[INDEX].reporting_fields.items.[INDEX].format","typeLabel":"enum\u003cstring>"},"secret":{"type":"boolean","title":"Secret","description":"Defines if this field is secret. When `true` the field's value is not returned when querying the payment service information.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].reporting_fields.items.[INDEX].secret","typeLabel":"boolean"},"verifiable":{"type":"boolean","title":"Verifiable","description":"Defines if this field can be verified through the verify credentials button.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].reporting_fields.items.[INDEX].verifiable","typeLabel":"boolean"}},"additionalProperties":false,"type":"object","required":["key","display_name","required","format","secret","verifiable"],"title":"DefinitionField","description":"A single field that needs to be submitted for a payment service when it is created.","uniqueKey":"\\items.items.[INDEX].reporting_fields.items.[INDEX]","typeLabel":"DefinitionField · object"},"type":"array","title":"Reporting Fields","description":"A list of reporting fields which can be configured for this service.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].reporting_fields","typeLabel":"DefinitionField · object[]"},"supported_currencies":{"items":{"type":"string","pattern":"^[A-Z]{3}$","examples":["EUR","GBP","USD"],"uniqueKey":"\\items.items.[INDEX].supported_currencies.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Supported Currencies","description":"A list of three-letter ISO currency codes that this service supports.","examples":[["USD","GBP","EUR","AUD"]],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].supported_currencies","typeLabel":"string[]"},"supported_countries":{"items":{"type":"string","pattern":"^[A-Z]{2}$","examples":["DE","GB","US"],"uniqueKey":"\\items.items.[INDEX].supported_countries.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Supported Countries","description":"A list of two-letter ISO country codes that this service supports.","examples":["US","GB","DE","AUD"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].supported_countries","typeLabel":"string[]"},"mode":{"description":"The mode that defines the flow this payment service uses to process a payment.","examples":["card","redirect"],"type":"string","enum":["card","redirect","applepay","googlepay","checkout-session","click-to-pay","gift-card","bank","paze"],"title":"Mode","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"\\items.items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"supported_features":{"additionalProperties":{"type":"boolean","uniqueKey":"\\items.items.[INDEX].supported_features.additionalProperties","typeLabel":"boolean"},"type":"object","title":"Supported Features","description":"Features supported by the payment service.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].supported_features","typeLabel":"Supported Features · object"},"required_checkout_fields":{"items":{"properties":{"required_fields":{"items":{"type":"string","uniqueKey":"\\items.items.[INDEX].required_checkout_fields.items.[INDEX].required_fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueItems":true,"title":"Required Fields","description":"A list of transaction fields that are required to process a payment for this service.","examples":[["address.line1","address.country","address.city","address.postal_code"]],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].required_checkout_fields.items.[INDEX].required_fields","typeLabel":"string[]"},"conditions":{"oneOf":[{"type":"object","title":"Conditions","description":"The conditions under which these fields are required","example":{"country":["IN"]},"additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].required_checkout_fields.items.[INDEX].conditions.oneOf.0","typeLabel":"Conditions · object"},{"type":"null","title":"Conditions","description":"The conditions under which these fields are required","example":{"country":["IN"]},"uniqueKey":"\\items.items.[INDEX].required_checkout_fields.items.[INDEX].conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].required_checkout_fields.items.[INDEX].conditions","typeLabel":"Conditions · object | null"}},"additionalProperties":false,"type":"object","required":["required_fields"],"title":"RequiredCheckoutFields","description":"A collection of checkout fields and the conditions under which they are required.","uniqueKey":"\\items.items.[INDEX].required_checkout_fields.items.[INDEX]","typeLabel":"RequiredCheckoutFields · object"},"type":"array","title":"Required Checkout Fields","description":"A list of condition that define when some fields must be provided with a transaction request.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].required_checkout_fields","typeLabel":"RequiredCheckoutFields · object[]"},"configuration":{"properties":{"approval_ui_target":{"description":"The browser target that an approval URL must be opened in. If any or null, then there is no specific requirement.","examples":["any"],"type":"string","enum":["new_window","any"],"title":"ApprovalTarget","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"\\items.items.[INDEX].configuration.approval_ui_target","typeLabel":"enum\u003cstring>"},"approval_ui_height":{"type":"string","pattern":"^\\d+(?:vh|px)$","title":"Approval Ui Height","description":"Height of the approval interface in either pixels or view height (vh).","examples":["100px","50vh"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].configuration.approval_ui_height","typeLabel":"string"},"approval_ui_width":{"type":"string","pattern":"^\\d+(?:vw|px)$","title":"Approval Ui Width","description":"Width of the approval interface in either pixels or view width (vw).","examples":["100px","50vw"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].configuration.approval_ui_width","typeLabel":"string"},"cart_items_limit":{"type":"integer","title":"Cart Items Limit","description":"The maximum number of cart items supported by this connector before we will truncate the list.","examples":[100],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].configuration.cart_items_limit","typeLabel":"integer"},"cart_items_required":{"type":"boolean","title":"Cart Items Required","description":"Defines if cart items are required by this connector.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].configuration.cart_items_required","typeLabel":"boolean"},"cart_items_should_match_amount":{"type":"boolean","title":"Cart Items Should Match Amount","description":"Defines if the cart items sum value should match the transaction amount.","examples":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].configuration.cart_items_should_match_amount","typeLabel":"boolean"}},"additionalProperties":false,"type":"object","required":["approval_ui_target","approval_ui_height","approval_ui_width","cart_items_limit","cart_items_required","cart_items_should_match_amount"],"title":"PaymentServiceConfiguration","description":"Additional configuration on how to present the approval UI.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].configuration","typeLabel":"PaymentServiceConfiguration · object"},"supported_integration_clients":{"oneOf":[{"type":"array","items":{"type":"string","enum":["redirect","web","android","ios"],"title":"IntegrationClient","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","uniqueKey":"\\items.items.[INDEX].supported_integration_clients.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Supported Integration Clients","description":"List of supported integration clients. Defaults to redirect for most redirect connectors.","example":["redirect"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].supported_integration_clients.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Supported Integration Clients","description":"List of supported integration clients. Defaults to redirect for most redirect connectors.","example":["redirect"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].supported_integration_clients.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].supported_integration_clients","typeLabel":"enum\u003cstring>[] | null"},"type":{"type":"string","const":"payment-service-definition","title":"Type","description":"Always `payment-service-definition`.","default":"payment-service-definition","examples":["payment-service-definition"],"uniqueKey":"\\items.items.[INDEX].type","typeLabel":"string"},"icon_url":{"oneOf":[{"type":"string","title":"Icon Url","description":"An icon to display for the payment service.","example":"https://example.com/icons/adyen-ideal.svg","uniqueKey":"\\items.items.[INDEX].icon_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Icon Url","description":"An icon to display for the payment service.","example":"https://example.com/icons/adyen-ideal.svg","uniqueKey":"\\items.items.[INDEX].icon_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].icon_url","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","required":["id","display_name","method","fields","reporting_fields","supported_currencies","supported_countries","mode","supported_features","required_checkout_fields","configuration","supported_integration_clients"],"title":"PaymentServiceDefinition","uniqueKey":"\\items.items.[INDEX]","typeLabel":"PaymentServiceDefinition · object"},"type":"array","title":"Items","description":"A list of items returned for this request.","isRequired":true,"uniqueKey":"\\items","typeLabel":"PaymentServiceDefinition · object[]"},"limit":{"type":"integer","maximum":100,"minimum":1,"title":"Limit","description":"The number of items for this page.","default":20,"examples":[20],"uniqueKey":"limit","typeLabel":"integer"},"next_cursor":{"oneOf":[{"type":"string","title":"Next Cursor","description":"The cursor pointing at the next page of items.","maxLength":1000,"minLength":1,"example":"ZXhhbXBsZTE","uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Cursor","description":"The cursor pointing at the next page of items.","example":"ZXhhbXBsZTE","uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_cursor","typeLabel":"string | null"},"previous_cursor":{"oneOf":[{"type":"string","title":"Previous Cursor","description":"The cursor pointing at the previous page of items.","maxLength":1000,"minLength":1,"example":"Xkjss7asS","uniqueKey":"previous_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Previous Cursor","description":"The cursor pointing at the previous page of items.","example":"Xkjss7asS","uniqueKey":"previous_cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"previous_cursor","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","required":["items"],"title":"PaymentServiceDefinitions","uniqueKey":"","typeLabel":"PaymentServiceDefinitions · object"},"examples":{"Example":{"title":"Example","value":{"items":[{"id":"adyen-ideal","display_name":"iDEAL","method":"ideal","fields":[{"key":"private_api_key","display_name":"Private API key","required":true,"format":"text","secret":true,"verifiable":true}],"reporting_fields":[{"key":"private_api_key","display_name":"Private API key","required":true,"format":"text","secret":true,"verifiable":true}],"supported_currencies":["USD","GBP","EUR","AUD"],"supported_countries":"US","mode":"card","supported_features":{},"required_checkout_fields":[{"required_fields":["address.line1","address.country","address.city","address.postal_code"],"conditions":{"country":["IN"]}}],"configuration":{"approval_ui_target":"any","approval_ui_height":"100px","approval_ui_width":"100px","cart_items_limit":100,"cart_items_required":true,"cart_items_should_match_amount":true},"supported_integration_clients":["redirect"],"type":"payment-service-definition","icon_url":"https://example.com/icons/adyen-ideal.svg"}],"limit":20,"next_cursor":"ZXhhbXBsZTE","previous_cursor":"Xkjss7asS"}}},"exampleType":"generated"}},"exampleType":"generated"},"c193b107-9ed7-434e-ac68-56d16a4501c0":{"description":"The request was invalid.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `bad_request`","default":"bad_request","examples":["bad_request"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `400`.","default":400,"examples":[400],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error400","uniqueKey":"","typeLabel":"Error400 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"bad_request","status":400,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"83e209de-8c01-41c0-801a-ba58d8cd925a":{"description":"The request was unauthorized.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `unauthorized`","default":"unauthorized","examples":["unauthorized"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `401`.","default":401,"examples":[401],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"No valid API authentication found","examples":["No valid API authentication found"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error401","uniqueKey":"","typeLabel":"Error401 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"unauthorized","status":401,"message":"No valid API authentication found","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"f5900d1c-7ca7-42f3-beb9-127fad247d99":{"description":"The credentials were invalid or the caller did not have permission to act on the resource.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `forbidden`","default":"forbidden","examples":["forbidden"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `403`.","default":403,"examples":[403],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error403","uniqueKey":"","typeLabel":"Error403 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"forbidden","status":403,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"0cbc621f-f9dc-4d67-957c-e8940e07e2b5":{"description":"The resource was not found.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `not_found`","default":"not_found","examples":["not_found"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `404`.","default":404,"examples":[404],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"The resource could not be found","examples":["The resource could not be found"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error404","uniqueKey":"","typeLabel":"Error404 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"not_found","status":404,"message":"The resource could not be found","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"ec0a127a-8bbf-413c-a8ec-1057a4cc7a7d":{"description":"The request method was not allowed.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `method_not_allowed`","default":"method_not_allowed","examples":["method_not_allowed"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `405`.","default":405,"examples":[405],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Method Not Allowed","examples":["Method Not Allowed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error405","uniqueKey":"","typeLabel":"Error405 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"method_not_allowed","status":405,"message":"Method Not Allowed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"8fafa896-e8bc-4f1d-9255-3535221919d8":{"description":"A duplicate record was found.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `duplicate_record`","default":"duplicate_record","examples":["duplicate_record"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `409`.","default":409,"examples":[409],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"},"resource_id":{"oneOf":[{"type":"string","title":"Resource Id","description":"The ID of the conflicting resource.","example":"cdc70639-cb9c-4222-a73f-b8ce39f7821b","uniqueKey":"resource_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Resource Id","description":"The ID of the conflicting resource.","example":"cdc70639-cb9c-4222-a73f-b8ce39f7821b","uniqueKey":"resource_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource_id","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","title":"Error409","uniqueKey":"","typeLabel":"Error409 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"duplicate_record","status":409,"message":"Request failed validation","details":[],"resource_id":"cdc70639-cb9c-4222-a73f-b8ce39f7821b"}}},"exampleType":"generated"}},"exampleType":"generated"},"d5002009-a193-411d-b8f3-8c19c9fbe71b":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"929339f0-744d-41fa-a426-1ebfef13a10a":{"description":"The request was too early.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `too_early`","default":"too_early","examples":["too_early"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `425`.","default":425,"examples":[425],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error425","uniqueKey":"","typeLabel":"Error425 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"too_early","status":425,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"0129dd0f-cfb7-4cf8-b8c5-9bf3d02456dd":{"description":"Too many requests were made.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `too_many_requests`","default":"too_many_requests","examples":["too_many_requests"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `429`.","default":429,"examples":[429],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error429","uniqueKey":"","typeLabel":"Error429 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"too_many_requests","status":429,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"4f148605-9aa6-4a22-93f3-a6edd9b804ae":{"description":"The server encountered an error.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `server_error`","default":"server_error","examples":["server_error"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `500`.","default":500,"examples":[500],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Request could not be processed","examples":["Request could not be processed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error500","uniqueKey":"","typeLabel":"Error500 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"server_error","status":500,"message":"Request could not be processed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"ef5738e8-f1d0-47cb-9d9e-3b33befdf0d1":{"description":"The server encountered an error.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `bad_gateway`","default":"bad_gateway","examples":["bad_gateway"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `502`.","default":502,"examples":[502],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Request could not be processed","examples":["Request could not be processed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error502","uniqueKey":"","typeLabel":"Error502 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"bad_gateway","status":502,"message":"Request could not be processed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"5724f34e-0ccd-4d8b-abc1-d8d46ada24ff":{"description":"The server encountered an error.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `gateway_timeout`","default":"gateway_timeout","examples":["gateway_timeout"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","default":504,"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Request could not be processed","examples":["Request could not be processed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error504","uniqueKey":"","typeLabel":"Error504 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"gateway_timeout","status":504,"message":"Request could not be processed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1c94c691-caf6-424e-b0d4-912fcc945a19":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0048b136-b0cb-4528-8f3a-95ce1a20d337":{"url":"https://api.sandbox.{id}.gr4vy.app","x-speakeasy-server-id":"sandbox","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}},"b15a1711-bb6b-4cdf-9106-1a445dacccf7":{"url":"https://api.{id}.gr4vy.app","x-speakeasy-server-id":"production","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.speakeasy.json"},"subdomain":"flexxbuy","siteName":"Gr4vy","title":"List payment service definitions - Gr4vy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-27T10:02:14.792Z","originalFileLocation":"reference/payment-service-definitions/list-payment-service-definitions.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List the definitions of each payment service that can be configured.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List payment service definitions - Gr4vy\">\u003cmeta data-mint-head property=\"og:description\" content=\"List the definitions of each payment service that can be configured.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gr4vy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byzly.com/reference/payment-service-definitions/list-payment-service-definitions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=List+payment+service+definitions\u0026amp;description=List+the+definitions+of+each+payment+service+that+can+be+configured.\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=c61663c9b40072f243bcf5e05fe864938b95a436f1aa555d03f457f690a44c59\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List payment service definitions - Gr4vy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List the definitions of each payment service that can be configured.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=List+payment+service+definitions\u0026amp;description=List+the+definitions+of+each+payment+service+that+can+be+configured.\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=c61663c9b40072f243bcf5e05fe864938b95a436f1aa555d03f457f690a44c59\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066CC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byzly.com/reference/payment-service-definitions/list-payment-service-definitions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/payment-service-definitions/list-payment-service-definitions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gr4vy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gr4vy","nav":{"global":null,"tabs":[{"tab":"Build","icon":"credit-card","groups":[{"group":"Get started","icon":"compass","pages":[{"sidebarTitle":"Overview","title":"Connect, build, and scale payments","mode":"wide","href":"/guides/get-started"},{"title":"Accept payments on the web","sidebarTitle":"Web payments","href":"/guides/payments/web"},{"title":"Accept payments on mobile","sidebarTitle":"Mobile payments","href":"/guides/payments/mobile"}]},{"group":"Integration guides","icon":"code","pages":[{"group":"Embed","pages":[{"group":"Web","pages":[{"title":"Embed","sidebarTitle":"Introduction","href":"/guides/payments/embed/quick-start/overview"},{"title":"Creating an API key for use with Embed","sidebarTitle":"API keys","href":"/guides/payments/embed/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/embed/quick-start/sdks"},{"title":"Adding Embed","sidebarTitle":"Embed checkout","href":"/guides/payments/embed/quick-start/embed"},{"title":"Inspecting transactions","sidebarTitle":"Transaction inspection","href":"/guides/payments/embed/quick-start/inspect"},{"title":"Going live","sidebarTitle":"Going live","href":"/guides/payments/embed/quick-start/live"},{"title":"Digital wallets in Embed","sidebarTitle":"Digital wallets","href":"/guides/payments/embed/digital-wallets"},{"title":"Embed events","sidebarTitle":"Events","href":"/guides/payments/embed/events"},{"title":"Embed localization","sidebarTitle":"Locales","href":"/guides/payments/embed/locale"},{"title":"Embed Theming","sidebarTitle":"Theming","href":"/guides/payments/embed/theming"},{"title":"Embed options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/embed/options"},{"title":"In-app browsers with Embed","sidebarTitle":"In-app browsers","href":"/guides/payments/embed/in-app-browsers"},{"title":"Common issues with Embed","sidebarTitle":"Common issues","href":"/guides/payments/embed/common-issues"}]},{"group":"Android","pages":[{"title":"Android SDK","sidebarTitle":"Introduction","href":"/guides/payments/android/quick-start/overview"},{"title":"Creating an API key for use with Android","sidebarTitle":"API keys","href":"/guides/payments/android/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/android/quick-start/sdks"},{"title":"Installing the Android SDK","sidebarTitle":"SDK installation","href":"/guides/payments/android/quick-start/android"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/android/quick-start/transact"},{"title":"Google Pay on Android","sidebarTitle":"Google Pay","href":"/guides/payments/android/google-pay"},{"title":"Android events","sidebarTitle":"Events","href":"/guides/payments/android/events"},{"title":"Android options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/android/options"}]},{"group":"iOS","pages":[{"title":"iOS SDK","sidebarTitle":"Introduction","href":"/guides/payments/ios/quick-start/overview"},{"title":"Creating an API key for use with iOS","sidebarTitle":"API keys","href":"/guides/payments/ios/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/ios/quick-start/sdks"},{"title":"Installing the iOS SDK","sidebarTitle":"SDK installation","href":"/guides/payments/ios/quick-start/ios"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/ios/quick-start/transact"},{"title":"Apple Pay on iOS","sidebarTitle":"Apple Pay","href":"/guides/payments/ios/apple-pay"},{"title":"iOS events","sidebarTitle":"Events","href":"/guides/payments/ios/events"},{"title":"iOS options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/ios/options"}]},{"group":"React Native","pages":[{"title":"React Native SDK","sidebarTitle":"Introduction","href":"/guides/payments/react-native/quick-start/overview"},{"title":"Creating an API key for use with React Native","sidebarTitle":"API keys","href":"/guides/payments/react-native/quick-start/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/react-native/quick-start/sdks"},{"title":"Installing the React Native SDK","sidebarTitle":"SDK installation","href":"/guides/payments/react-native/quick-start/embed"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/react-native/quick-start/transact"},{"title":"Apple Pay on React Native","sidebarTitle":"Apple Pay","href":"/guides/payments/react-native/apple-pay"},{"title":"Google Pay on React Native","sidebarTitle":"Google Pay","href":"/guides/payments/react-native/google-pay"},{"title":"React Native events","sidebarTitle":"Events","href":"/guides/payments/react-native/events"},{"title":"React Native options","sidebarTitle":"Options","mode":"wide","href":"/guides/payments/react-native/options"}]}]},{"group":"Secure Fields","pages":[{"title":"Secure Fields","sidebarTitle":"Introduction","href":"/guides/payments/secure-fields/quick-start/overview"},{"title":"Creating an API key for use with Secure Fields","sidebarTitle":"API keys","href":"/guides/payments/secure-fields/quick-start/key"},{"title":"Creating checkout sessions","sidebarTitle":"Checkout sessions","href":"/guides/payments/secure-fields/quick-start/sdks"},{"title":"Adding secure fields","sidebarTitle":"Secure fields","href":"/guides/payments/secure-fields/quick-start/embed"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/secure-fields/quick-start/transact"},{"title":"Secure Fields and 3DS","sidebarTitle":"3DS","href":"/guides/payments/secure-fields/three-d-secure"},{"title":"Secure Fields with stored cards","sidebarTitle":"Stored cards","href":"/guides/payments/secure-fields/stored-cards"},{"title":"Secure Fields theming","sidebarTitle":"Theming","href":"/guides/payments/secure-fields/theming"},{"title":"Secure Fields events","sidebarTitle":"Events","href":"/guides/payments/secure-fields/events"},{"title":"Secure Fields UX options","sidebarTitle":"UX options","href":"/guides/payments/secure-fields/ux-options"}]},{"group":"Direct API","pages":[{"title":"Direct API","sidebarTitle":"Introduction","href":"/guides/payments/direct-api/quick-start/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/guides/payments/direct-api/quick-start/key"},{"title":"Listing payment options","sidebarTitle":"Payment options","href":"/guides/payments/direct-api/quick-start/payment-options"},{"title":"Creating transactions","sidebarTitle":"Transactions","href":"/guides/payments/direct-api/quick-start/transaction"},{"title":"Handling redirects","sidebarTitle":"Redirects","href":"/guides/payments/direct-api/quick-start/handle-redirect"},{"title":"Getting transaction results","sidebarTitle":"Transaction results","href":"/guides/payments/direct-api/quick-start/status"},{"title":"PayPal via the API","sidebarTitle":"PayPal","href":"/guides/payments/direct-api/paypal"}]},{"group":"Native SDKs","pages":[{"title":"Native Mobile SDKs","sidebarTitle":"Overview","href":"/guides/payments/native/overview"},{"title":"Create an API key","sidebarTitle":"API keys","href":"/guides/payments/native/key"},{"title":"Generating tokens for authentication","sidebarTitle":"Authentication","href":"/guides/payments/native/sdks"},{"title":"Vaulting card data","sidebarTitle":"Vaulting","href":"/guides/payments/native/vault"},{"title":"Adding 3DS authentication","sidebarTitle":"3DS","href":"/guides/payments/native/3ds"},{"sidebarTitle":"Get card details","title":"Card details","href":"/guides/payments/native/get-card-details"},{"sidebarTitle":"Payment options","title":"List payment options","href":"/guides/payments/native/list-payment-options"},{"sidebarTitle":"Buyer payment methods","title":"List buyer payment methods","href":"/guides/payments/native/list-buyer-payment-methods"},{"title":"SDK Response Reference","sidebarTitle":"Responses","href":"/guides/payments/native/responses"}]},{"group":"Agentic Development Kit","pages":[{"title":"Agentic Development Kit (ADK)","sidebarTitle":"Overview","href":"/guides/payments/adk/overview"},{"group":"ChatGPT","pages":[{"title":"ChatGPT ADK","sidebarTitle":"Introduction","href":"/guides/payments/chatgpt-app/overview"},{"title":"Architecture","sidebarTitle":"Architecture","href":"/guides/payments/chatgpt-app/architecture"},{"title":"Set up the project","sidebarTitle":"Setup","href":"/guides/payments/chatgpt-app/setup"},{"title":"Build the MCP server","sidebarTitle":"MCP server","href":"/guides/payments/chatgpt-app/mcp-server"},{"title":"Build the widgets","sidebarTitle":"Widgets","href":"/guides/payments/chatgpt-app/widgets"},{"title":"Integrate Gr4vy Embed","sidebarTitle":"Gr4vy Embed","href":"/guides/payments/chatgpt-app/gr4vy-embed"},{"title":"Deploy to ChatGPT","sidebarTitle":"Deployment","href":"/guides/payments/chatgpt-app/deployment"}]}]},{"group":"Vaulting","pages":[{"title":"Vaulting","sidebarTitle":"Overview","href":"/guides/features/vault-forwarding/overview"},{"title":"Tokenize a card","sidebarTitle":"Tokenize","href":"/guides/features/vault-forwarding/tokenize"},{"title":"Provision a PSP token","sidebarTitle":"PSP tokens","href":"/guides/features/vault-forwarding/psp-tokens"},{"title":"Vault Forward card data to API endpoint","sidebarTitle":"Forward to endpoint","href":"/guides/features/vault-forwarding/forward"}]},{"group":"E-commerce Plugins","pages":[{"group":"commercetools","pages":[{"title":"commercetools Integration","sidebarTitle":"Overview","href":"/guides/payments/commercetools/overview"},{"title":"commercetools Installation","sidebarTitle":"Installation","href":"/guides/payments/commercetools/installation"},{"title":"commercetools Configuration","sidebarTitle":"Configuration","href":"/guides/payments/commercetools/configuration"},{"title":"commercetools Administration","sidebarTitle":"Administration","href":"/guides/payments/commercetools/backend"},{"title":"commercetools Frontend","sidebarTitle":"Frontend","href":"/guides/payments/commercetools/frontend"}]},{"group":"Magento","pages":[{"title":"Magento Plugin","sidebarTitle":"Overview","href":"/guides/payments/magento/overview"},{"title":"Magento Installation","sidebarTitle":"Installation","href":"/guides/payments/magento/installation"},{"title":"Magento Configuration","sidebarTitle":"Configuration","href":"/guides/payments/magento/configuration"},{"title":"Magento Administration","sidebarTitle":"Administration","href":"/guides/payments/magento/backend"},{"title":"Magento Frontend","sidebarTitle":"Frontend","href":"/guides/payments/magento/frontend"}]},{"group":"Salesforce Commerce Cloud","pages":[{"title":"Salesforce Commerce Cloud Cartridge","sidebarTitle":"Overview","href":"/guides/payments/sfcc/overview"},{"title":"Salesforce Commerce Cloud Installation","sidebarTitle":"Installation","href":"/guides/payments/sfcc/installation"},{"title":"Salesforce Commerce Cloud Configuration","sidebarTitle":"Configuration","href":"/guides/payments/sfcc/configuration"},{"title":"Salesforce Commerce Cloud Administration","sidebarTitle":"Administration","href":"/guides/payments/sfcc/backend"},{"title":"Salesforce Commerce Cloud Frontend","sidebarTitle":"Frontend","href":"/guides/payments/sfcc/frontend"}]}]}]},{"group":"Best Practices","icon":"lightbulb","pages":[{"title":"Best practices","href":"/guides/best-practices/overview"},{"title":"Identifiers \u0026 reconciliation","sidebarTitle":"IDs \u0026 reconciliation","href":"/guides/ids"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"}]},{"group":"Resources","icon":"toolbox","pages":[{"title":"Command Line Interface (CLI)","sidebarTitle":"CLI","href":"/guides/tools/cli"},{"title":"Postman Collection","sidebarTitle":"Postman","href":"/guides/tools/postman"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"}]},{"group":"Features","icon":"sliders","pages":[{"group":"3-D Secure","pages":[{"title":"3-D Secure","sidebarTitle":"Overview","href":"/guides/features/3ds/overview"},{"title":"3-D Secure Setup","sidebarTitle":"Setup","href":"/guides/features/3ds/setup"},{"title":"Setup 3DS card schemes","sidebarTitle":"Schemes","href":"/guides/features/3ds/schemes"},{"title":"3-D Secure with multiple connections","sidebarTitle":"Multiple connections","href":"/guides/features/3ds/multiple-connections"},{"title":"3-D Secure in Embed","sidebarTitle":"Embed","href":"/guides/features/3ds/embed"},{"title":"Hosted 3-D Secure","sidebarTitle":"Hosted","href":"/guides/features/3ds/hosted"},{"title":"Native 3-D Secure","sidebarTitle":"Native","href":"/guides/features/3ds/native"},{"title":"Pass-through External 3-D Secure data","sidebarTitle":"External","href":"/guides/features/3ds/external"},{"title":"3DS authentication results","sidebarTitle":"Results","href":"/guides/features/3ds/statuses"},{"title":"3-D Secure testing","sidebarTitle":"Testing","href":"/guides/features/3ds/testing"},{"title":"3DS Scenarios","sidebarTitle":"Scenarios","href":"/guides/features/3ds/scenarios"}]},{"group":"Account updater","pages":[{"title":"Account Updater","sidebarTitle":"Overview","href":"/guides/features/account-updater/overview"},{"title":"Manual account updates","sidebarTitle":"Manual updates","href":"/guides/features/account-updater/integration"},{"title":"Scheduled account updates","sidebarTitle":"Scheduled updates","href":"/guides/features/account-updater/scheduler"},{"title":"Real time account updates","sidebarTitle":"Real time updates","href":"/guides/features/account-updater/real-time"}]},{"group":"AFTs","pages":[{"title":"Account funding transactions","sidebarTitle":"Overview","href":"/guides/features/account-funding-transactions/overview"}]},{"group":"Anti-fraud","pages":[{"title":"Anti-fraud","sidebarTitle":"Overview","href":"/guides/features/anti-fraud/overview"},{"title":"Anti-fraud setup","sidebarTitle":"Setup","href":"/guides/features/anti-fraud/setup"},{"title":"Silent mode","sidebarTitle":"Silent mode","href":"/guides/features/anti-fraud/silent-mode"},{"title":"Automatic anti-fraud device fingerprinting","sidebarTitle":"Fingerprints","href":"/guides/features/anti-fraud/fingerprint"},{"title":"Anti-fraud reviews","sidebarTitle":"Reviews","href":"/guides/features/anti-fraud/reviews"},{"title":"Anti-fraud simulator","sidebarTitle":"Simulator","href":"/guides/features/anti-fraud/simulator"}]},{"group":"Apple Pay","pages":[{"title":"Apple Pay","sidebarTitle":"Overview","href":"/guides/features/apple-pay/overview"},{"title":"Apple Pay on web with Embed","sidebarTitle":"Web with Embed","href":"/guides/features/apple-pay/web"},{"title":"Apple Pay on web without Embed","sidebarTitle":"Web without Embed","href":"/guides/features/apple-pay/web-without-sdk"},{"title":"Apple Pay on iOS with the SDK","sidebarTitle":"iOS with SDK","href":"/guides/features/apple-pay/ios"},{"title":"Apple Pay on iOS without the SDK","sidebarTitle":"iOS without SDK","href":"/guides/features/apple-pay/ios-without-sdk"},{"title":"Decrypted Apple Pay tokens","sidebarTitle":"Decrypted tokens","href":"/guides/features/apple-pay/decrypted-tokens"}]},{"group":"Click to Pay","pages":[{"title":"Click to Pay","sidebarTitle":"Overview","href":"/guides/features/click-to-pay/overview"},{"title":"Click to Pay Setup","sidebarTitle":"Setup","href":"/guides/features/click-to-pay/setup"},{"title":"Customer Authentication Module (CAM)","sidebarTitle":"Customer Authentication","href":"/guides/features/click-to-pay/cam"},{"title":"Token Authentication Service (TAS)","sidebarTitle":"Token Authentication","href":"/guides/features/click-to-pay/tas"}]},{"group":"Gift Cards","pages":[{"title":"Gift Cards","sidebarTitle":"Overview","href":"/guides/features/gift-cards/overview"},{"title":"Gift card simulator","sidebarTitle":"Simulator","href":"/guides/features/gift-cards/simulator"}]},{"group":"Google Pay","pages":[{"title":"Google Pay","sidebarTitle":"Overview","href":"/guides/features/google-pay/overview"},{"title":"Google Pay on web with Embed","sidebarTitle":"Web with Embed","href":"/guides/features/google-pay/web"},{"title":"Google Pay on web without Embed","sidebarTitle":"Web without Embed","href":"/guides/features/google-pay/web-without-sdk"},{"title":"Google Pay on Android with the SDK","sidebarTitle":"Android with SDK","href":"/guides/features/google-pay/mobile"},{"title":"Google Pay on Android without the SDK","sidebarTitle":"Android without SDK","href":"/guides/features/google-pay/mobile-without-sdk"},{"title":"Decrypted Google Pay tokens","sidebarTitle":"Decrypted tokens","href":"/guides/features/google-pay/decrypted-tokens"}]},{"group":"Guest checkout","pages":[{"title":"Guest checkout","sidebarTitle":"Overview","href":"/guides/features/guest-checkout/overview"},{"title":"Linking guests buyer details","sidebarTitle":"Buyer linking","href":"/guides/features/guest-checkout/linking"}]},{"group":"Import card data","pages":[{"title":"Vault token import","sidebarTitle":"Overview","href":"/guides/features/token-import/overview"},{"title":"Token import file creation","sidebarTitle":"Import file","mode":"wide","href":"/guides/features/token-import/token-import-file"},{"title":"Token import file upload","sidebarTitle":"Upload tokens","href":"/guides/features/token-import/token-file-transmission"},{"title":"Creating buyers \u0026 payment methods on import","sidebarTitle":"Buyers \u0026 payment methods","href":"/guides/features/token-import/buyer-payment-creation"}]},{"group":"Incremental authorization","pages":[{"title":"Incremental authorization","sidebarTitle":"Overview","href":"/guides/features/incremental-authorization/overview"}]},{"group":"Merchant accounts","pages":[{"title":"Merchant accounts","sidebarTitle":"Overview","href":"/guides/features/merchant-accounts/overview"},{"title":"Managing merchant accounts","sidebarTitle":"Accounts","href":"/guides/features/merchant-accounts/accounts"},{"title":"Users \u0026 merchant accounts","sidebarTitle":"Users","href":"/guides/features/merchant-accounts/users"},{"title":"API \u0026 merchant accounts","sidebarTitle":"API","href":"/guides/features/merchant-accounts/api"},{"title":"Embed \u0026 merchant accounts","sidebarTitle":"Embed","href":"/guides/features/merchant-accounts/embed"}]},{"group":"Multi captures","pages":[{"title":"Multi captures","sidebarTitle":"Overview","href":"/guides/features/multi-captures/overview"}]},{"group":"Network tokens","pages":[{"title":"Network tokens","sidebarTitle":"Overview","href":"/guides/features/network-tokens/overview"},{"title":"Network token implementation","sidebarTitle":"Implementation","href":"/guides/features/network-tokens/implementation"},{"title":"Network token lifecycle management","sidebarTitle":"Lifecycle","href":"/guides/features/network-tokens/lifecycle"},{"title":"Network Token Testing","sidebarTitle":"Testing","href":"/guides/features/network-tokens/testing"},{"title":"Network token pass through","sidebarTitle":"Pass through","href":"/guides/features/network-tokens/passthrough"}]},{"group":"Partial auth","pages":[{"title":"Partial authorization","sidebarTitle":"Overview","href":"/guides/features/partial-authentication/overview"}]},{"group":"Bank payments","pages":[{"title":"Bank payments","sidebarTitle":"Overview","href":"/guides/features/pay-by-bank/overview"}]},{"group":"Payment facilitators","pages":[{"title":"Payment facilitators","sidebarTitle":"Overview","href":"/guides/features/payment-facilitators/overview"}]},{"group":"Payment links","pages":[{"title":"Payment links","sidebarTitle":"Overview","href":"/guides/features/payment-links/overview"},{"title":"Sharing the payment link","sidebarTitle":"Sharing","href":"/guides/features/payment-links/sharing"},{"title":"Payment link expiration and statuses","sidebarTitle":"Expiration \u0026 Status","href":"/guides/features/payment-links/statuses"}]},{"group":"Payouts","pages":[{"title":"Payouts","sidebarTitle":"Introduction","href":"/guides/features/payouts/overview"}]},{"group":"Paze","pages":[{"title":"Paze","sidebarTitle":"Overview","href":"/guides/features/paze/overview"},{"title":"Set up Paze","sidebarTitle":"Set up","href":"/guides/features/paze/setup"},{"title":"Paze on web","sidebarTitle":"Web setup","href":"/guides/features/paze/web"},{"title":"Paze on mobile","sidebarTitle":"Mobile setup","href":"/guides/features/paze/mobile"}]},{"group":"PSP Tokenization","pages":[{"title":"PSP Tokenization","sidebarTitle":"Overview","href":"/guides/features/psp-tokenization/overview"}]},{"group":"Push payments","pages":[{"title":"Push payments","sidebarTitle":"Overview","href":"/guides/features/push-payments/overview"},{"title":"Push payments and Embed","sidebarTitle":"Embed","href":"/guides/features/push-payments/embed"}]},{"group":"Reauthorization","pages":[{"title":"Reauthorization","sidebarTitle":"Overview","href":"/guides/features/reauthorization/overview"}]},{"group":"Recurring payments","pages":[{"title":"Recurring payments","sidebarTitle":"Overview","href":"/guides/features/recurring-payments/overview"},{"title":"Common scenarios","href":"/guides/features/recurring-payments/scenarios"},{"title":"Recurring transactions with Embed","sidebarTitle":"In Embed","href":"/guides/features/recurring-payments/embed"},{"title":"Open-loop versus closed-loop","sidebarTitle":"Open or Closed-loop","href":"/guides/features/recurring-payments/open-loop"},{"title":"Recurring payments with network tokens","sidebarTitle":"Network tokens","href":"/guides/features/recurring-payments/network-tokens"},{"title":"Mastercard Transaction Link Identifier (TLID)","sidebarTitle":"Mastercard TLID","href":"/guides/features/recurring-payments/mastercard-tlid"}]},{"group":"Scheme Cards","pages":[{"title":"Card fingerprints","sidebarTitle":"Card fingerprints","href":"/guides/features/cards/fingerprints"},{"title":"Payment account references","sidebarTitle":"Payment account references","href":"/guides/features/cards/payment-account-reference"}]},{"group":"Shipment tracking","pages":[{"title":"Shipment tracking","sidebarTitle":"Overview","href":"/guides/features/shipment-tracking/overview"}]},{"group":"Simulators","pages":[{"title":"Transaction simulators","sidebarTitle":"Overview","href":"/guides/features/simulators/overview"},{"title":"Transaction simulator webhooks","sidebarTitle":"Webhooks","href":"/guides/features/simulators/webhooks"}]},{"group":"Vault Forwarding","pages":[{"title":"Enable a Vault Forward endpoint","sidebarTitle":"Enable endpoint","href":"/guides/features/vault-forwarding/enable"},{"title":"Vault Forward card data from a checkout session","sidebarTitle":"CVV \u0026 Secure Fields","href":"/guides/features/vault-forwarding/checkout-sessions"},{"title":"Forward 3DS authentication data via Vault Forward","sidebarTitle":"3DS forwarding","href":"/guides/features/vault-forwarding/3ds"},{"title":"Forward network tokens via Vault Forward","sidebarTitle":"Network tokens","href":"/guides/features/vault-forwarding/network-tokens"},{"group":"Advanced authentication","pages":[{"title":"Advanced authentication for Vault Forward","sidebarTitle":"Overview","href":"/guides/features/vault-forwarding/authentication"},{"title":"Advanced authentication for Visa","sidebarTitle":"Visa","href":"/guides/features/vault-forwarding/visa"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Introduction","href":"/guides/features/webhooks/overview"},{"title":"Webhook payload","sidebarTitle":"Payload","href":"/guides/features/webhooks/payload"},{"title":"Webhook events","sidebarTitle":"Events","mode":"wide","href":"/guides/features/webhooks/events"},{"title":"Technical webhook considerations","sidebarTitle":"Technical considerations","href":"/guides/features/webhooks/technical-considerations"},{"title":"Webhook signatures","sidebarTitle":"Signatures","href":"/guides/features/webhooks/signatures"}]}]},{"group":"Other","pages":[{"group":"Statuses","pages":[{"title":"Transaction statuses","sidebarTitle":"Transactions","href":"/guides/api/statuses/transactions"},{"title":"Payment method statuses","sidebarTitle":"Payment methods","href":"/guides/api/statuses/payment-methods"}]}]}]},{"tab":"Dashboard","icon":"circle-user","pages":[{"group":"Overview","icon":"compass","pages":[{"title":"Dashboard overview","sidebarTitle":"Overview","href":"/guides/dashboard/overview"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"API keys","sidebarTitle":"API keys","href":"/guides/dashboard/integrations/api-keys"}]},{"group":"Insights","icon":"eye","pages":[{"title":"Insights","sidebarTitle":"Overview","href":"/guides/dashboard/insights/homepage"},{"title":"Authentication Insights","sidebarTitle":"Authentications","mode":"wide","href":"/guides/dashboard/insights/authentications"},{"title":"Authorization Insights","sidebarTitle":"Authorizations","href":"/guides/dashboard/insights/authorizations"}]},{"group":"Monitoring \u0026 Alerting","icon":"chart-line","pages":[{"title":"Monitoring \u0026 Alerting","sidebarTitle":"Overview","href":"/guides/dashboard/monitoring-and-alerting/overview"},{"title":"Set Up a Monitor","sidebarTitle":"Setup","href":"/guides/dashboard/monitoring-and-alerting/setup"},{"title":"Alerts","sidebarTitle":"Alerts","href":"/guides/dashboard/monitoring-and-alerting/alerts"}]},{"group":"Flow","icon":"diagram-project","pages":[{"title":"Flow","sidebarTitle":"Overview","href":"/guides/dashboard/flow/overview"},{"title":"Checkout Flow","href":"/guides/dashboard/flow/checkout"},{"title":"Card Transactions Flow","href":"/guides/dashboard/flow/card-transactions"},{"title":"Other Transactions Flow","href":"/guides/dashboard/flow/other-transactions"}]},{"group":"Roles \u0026 Permissions","icon":"users","pages":[{"sidebarTitle":"Overview","title":"Roles \u0026 Permissions","href":"/guides/dashboard/roles-and-permissions/overview"},{"sidebarTitle":"Roles","title":"User roles","href":"/guides/dashboard/roles-and-permissions/roles"},{"sidebarTitle":"Additional permissions","title":"Additional user permissions","href":"/guides/dashboard/roles-and-permissions/additional-permissions"}]},{"group":"Reports","icon":"file-lines","pages":[{"title":"Reports","sidebarTitle":"Overview","href":"/guides/dashboard/reports/overview"},{"title":"Report specification","sidebarTitle":"Specification","href":"/guides/dashboard/reports/spec"},{"title":"Setup a report","sidebarTitle":"Setup","href":"/guides/dashboard/reports/how-to"},{"group":"Models","pages":[{"title":"Available report models","sidebarTitle":"Available models","href":"/guides/dashboard/reports/models"},{"title":"Receivable transactions","href":"/guides/dashboard/reports/models-accounts-receivables"},{"title":"Transactions","href":"/guides/dashboard/reports/models-transactions"},{"title":"Transactions retries","href":"/guides/dashboard/reports/models-transaction-retries"}]}]},{"group":"Settlement reports","icon":"money-bill-transfer","pages":[{"title":"Settlement reports","sidebarTitle":"Overview","href":"/guides/dashboard/reports/settlement/overview"},{"title":"Settlement report ingestion","sidebarTitle":"Ingestion","href":"/guides/dashboard/reports/settlement/ingestion"},{"title":"Settlement report scheduling","sidebarTitle":"Schedule \u0026 Retrieve","href":"/guides/dashboard/reports/settlement/scheduling"},{"title":"Settlement reconciliation","sidebarTitle":"Reconciliation","href":"/guides/dashboard/reports/settlement/reconciliation"},{"title":"Reconciling settlement records","sidebarTitle":"Settlement records","href":"/guides/dashboard/reports/settlement/settlement-records"},{"title":"Settlement report specification","sidebarTitle":"Specification","mode":"wide","href":"/guides/dashboard/reports/settlement/specification"},{"group":"Payment services","pages":[{"title":"Settlement report Adyen mapping","sidebarTitle":"Adyen","mode":"wide","href":"/guides/dashboard/reports/settlement/adyen"},{"title":"Settlement report BlueSnap mapping","sidebarTitle":"BlueSnap","mode":"wide","href":"/guides/dashboard/reports/settlement/bluesnap"},{"title":"Settlement report Braintree mapping","sidebarTitle":"Braintree","mode":"wide","href":"/guides/dashboard/reports/settlement/braintree"},{"title":"Settlement report Chase Orbital mapping","sidebarTitle":"Chase Orbital","mode":"wide","href":"/guides/dashboard/reports/settlement/chaseorbital"},{"title":"Settlement report Cybersource mapping","sidebarTitle":"Cybersource","mode":"wide","href":"/guides/dashboard/reports/settlement/cybersource"},{"title":"Settlement report dLocal mapping","sidebarTitle":"dLocal","mode":"wide","href":"/guides/dashboard/reports/settlement/dlocal"},{"title":"Settlement report Nuvei mapping","sidebarTitle":"Nuvei","mode":"wide","href":"/guides/dashboard/reports/settlement/nuvei"},{"title":"Settlement report PayPal mapping","sidebarTitle":"PayPal","mode":"wide","href":"/guides/dashboard/reports/settlement/paypal"},{"title":"Settlement report Stripe mapping","sidebarTitle":"Stripe","mode":"wide","href":"/guides/dashboard/reports/settlement/stripe"},{"title":"Settlement report Trustly (US) mapping","sidebarTitle":"Trustly (US)","mode":"wide","href":"/guides/dashboard/reports/settlement/trustly"}]}]},{"group":"SSO","icon":"shield","pages":[{"title":"Single Sign-On","sidebarTitle":"Overview","href":"/guides/dashboard/sso/overview"},{"title":"Single Sign-On with Okta","sidebarTitle":"Okta","href":"/guides/dashboard/sso/okta"},{"title":"Single Sign-On with Azure AD","sidebarTitle":"Azure AD","href":"/guides/dashboard/sso/azure"},{"title":"Single Sign-On with OneLogin","sidebarTitle":"OneLogin","href":"/guides/dashboard/sso/onelogin"},{"title":"Single Sign-On with Google Workspace","sidebarTitle":"Google Workspace","href":"/guides/dashboard/sso/google-workspace"},{"title":"Common SSO issues","sidebarTitle":"Common issues","href":"/guides/dashboard/sso/common-issues"}]}]},{"tab":"Connections","icon":{"style":"light","name":"circle-nodes"},"groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Connections","sidebarTitle":"Overview","mode":"wide","href":"/connections/payments/overview"},{"title":"Connection catalog","sidebarTitle":"Catalog","mode":"wide","href":"/connections/catalog"}]},{"group":"Aggregators","icon":"link","pages":[{"title":"Adyen","sidebarTitle":"Adyen","href":"/connections/payments/adyen"},{"title":"Braintree","sidebarTitle":"Braintree","href":"/connections/payments/braintree"},{"title":"Buckaroo","sidebarTitle":"Buckaroo","href":"/connections/payments/buckaroo"},{"title":"Chase","sidebarTitle":"Chase","href":"/connections/payments/chase"},{"title":"Checkout.com","sidebarTitle":"Checkout.com","href":"/connections/payments/checkout"},{"title":"Cybersource","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource"},{"title":"dLocal","sidebarTitle":"dLocal","href":"/connections/payments/dlocal"},{"title":"Fiserv","sidebarTitle":"Fiserv","href":"/connections/payments/fiserv"},{"title":"Nuvei","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei"},{"title":"PayPal","sidebarTitle":"PayPal","href":"/connections/payments/paypal"},{"title":"Stripe","sidebarTitle":"Stripe","href":"/connections/payments/stripe"},{"title":"Worldline","sidebarTitle":"Worldline","href":"/connections/payments/worldline"},{"title":"Worldpay","sidebarTitle":"Worldpay","href":"/connections/payments/worldpay"}]},{"group":"Methods","icon":"coins","tag":"400+","pages":[{"group":"Banking","pages":[{"group":"ACH Direct Debit","pages":[{"title":"Adyen - ACH Direct Debit","sidebarTitle":"Adyen","href":"/connections/payments/adyen-ach"},{"title":"BlueSnap - ACH Direct Debit","sidebarTitle":"BlueSnap","href":"/connections/payments/bluesnap-ach"}]},{"group":"Bank accounts","pages":[{"title":"Bank accounts","sidebarTitle":"Overview","href":"/connections/payments/bank"},{"title":"Adyen - Bank account (ACH, SEPA, BACS)","sidebarTitle":"Adyen","href":"/connections/payments/adyen-bank"},{"title":"Chase Orbital - Bank account (ACH)","sidebarTitle":"Chase Orbital","href":"/connections/payments/chaseorbital-bank"},{"title":"Nuvei - Bank account (ACH)","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-bank"},{"group":"Pay by Bank with Plaid","pages":[{"title":"Plaid","sidebarTitle":"Overview","href":"/connections/payments/plaid-bank"},{"title":"Plaid Integration","sidebarTitle":"Integration","href":"/connections/payments/plaid-bank-integration"},{"title":"Plaid Recurring Payments","sidebarTitle":"Recurring payments","href":"/connections/payments/plaid-bank-recurring"},{"title":"Plaid Signal setup","sidebarTitle":"Signal setup","href":"/connections/payments/plaid-bank-signal"}]}]},{"group":"BCP","pages":[{"title":"dLocal - BCP","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-bcp"}]},{"group":"BLIK","pages":[{"title":"Adyen - BLIK","sidebarTitle":"Adyen","href":"/connections/payments/adyen-blik"}]},{"group":"Bre-B","pages":[{"title":"dLocal - Bre-B","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-breb"}]},{"group":"Capitec","pages":[{"title":"dLocal - Capitec","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-capitec"}]},{"title":"GoCardless","sidebarTitle":"GoCardless","href":"/connections/payments/gocardless-gocardless"},{"group":"iDEAL | Wero","pages":[{"title":"Adyen - iDEAL | Wero","sidebarTitle":"Adyen","href":"/connections/payments/adyen-ideal"},{"title":"Buckaroo - iDEAL | Wero","sidebarTitle":"Buckaroo","href":"/connections/payments/buckaroo-ideal"},{"title":"Cybersource - iDEAL | Wero","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource-ideal"},{"title":"Nuvei - iDEAL | Wero","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-ideal"},{"title":"Worldline TravelHub - iDEAL | Wero","sidebarTitle":"Worldline TravelHub","href":"/connections/payments/travelhub-ideal"}]},{"group":"Interac","pages":[{"title":"Nuvei - Interac","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-interac"}]},{"group":"KCP","pages":[{"title":"Cybersource - KCP","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource-kcp"}]},{"group":"Khipu","pages":[{"title":"dLocal - Khipu","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-khipu"}]},{"group":"NetBanking","pages":[{"title":"dLocal - NetBanking","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-netbanking"}]},{"group":"NuPay","pages":[{"title":"dLocal - NuPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-nupay"}]},{"group":"Online Banking Czech Republic","pages":[{"title":"Adyen - Online Banking Czech Republic","sidebarTitle":"Adyen","href":"/connections/payments/adyen-onlinebankingcz"}]},{"group":"Pay by Bank (redirect)","pages":[{"title":"Adyen - Pay by Bank (redirect)","sidebarTitle":"Adyen","href":"/connections/payments/adyen-paybybank"}]},{"group":"PayID","pages":[{"title":"Azupay - PayID","sidebarTitle":"Azupay","href":"/connections/payments/azupay-payid"}]},{"group":"PayTo","pages":[{"title":"Azupay - PayTo","sidebarTitle":"Azupay","href":"/connections/payments/azupay-payto"}]},{"group":"Pix","pages":[{"title":"Adyen - Pix","sidebarTitle":"Adyen","href":"/connections/payments/adyen-pix"},{"title":"dLocal - Pix","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-pix"}]},{"group":"Przelewy24","pages":[{"title":"Nuvei - Przelewy24","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-p24"}]},{"group":"PSE","pages":[{"title":"dLocal - PSE","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-pse"},{"title":"Nuvei - PSE","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-pse"}]},{"group":"SEPA","pages":[{"title":"Adyen - SEPA","sidebarTitle":"Adyen","href":"/connections/payments/adyen-sepa"}]},{"group":"Sofort","pages":[{"title":"Adyen - Sofort","sidebarTitle":"Adyen","href":"/connections/payments/adyen-sofort"},{"title":"Worldline TravelHub - Sofort","sidebarTitle":"Worldline TravelHub","href":"/connections/payments/travelhub-sofort"}]},{"group":"SPEI","pages":[{"title":"Arcus - SPEI","sidebarTitle":"Arcus","href":"/connections/payments/arcusfi-spei"},{"title":"dLocal - SPEI","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-spei"},{"title":"Monato - SPEI","sidebarTitle":"Monato","href":"/connections/payments/monato-spei"},{"title":"Stripe - SPEI","sidebarTitle":"Stripe","href":"/connections/payments/stripe-spei"}]},{"group":"Stitch","pages":[{"title":"dLocal - Stitch","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-stitch"}]},{"title":"Trustly (Europe)","href":"/connections/payments/trustlyeurope-trustlyeurope"},{"title":"Trustly (United States)","href":"/connections/payments/trustly-trustly"},{"group":"UPI","pages":[{"title":"dLocal - UPI","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-upi"}]},{"group":"Webpay","pages":[{"title":"dLocal - Webpay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-webpay"}]}]},{"group":"BNPL","pages":[{"group":"Affirm","pages":[{"title":"Affirm","sidebarTitle":"Affirm","href":"/connections/payments/affirm-affirm"},{"title":"Stripe - Affirm","sidebarTitle":"Stripe","href":"/connections/payments/stripe-affirm"}]},{"title":"Afterpay","sidebarTitle":"Afterpay","href":"/connections/payments/afterpay-afterpay"},{"group":"Cash App Afterpay","pages":[{"title":"Adyen - Cash App Afterpay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-cashappafterpay"}]},{"group":"Klarna","pages":[{"title":"Klarna","sidebarTitle":"Klarna","href":"/connections/payments/klarna-klarna"},{"title":"Nuvei - Klarna","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-klarna"},{"title":"Stripe - Klarna","sidebarTitle":"Stripe","href":"/connections/payments/stripe-klarna"}]},{"title":"Latitude / Gem","sidebarTitle":"Latitude / Gem","href":"/connections/payments/latitude"},{"group":"PayPal Pay Later","pages":[{"title":"PayPal Pay Later","sidebarTitle":"PayPal","href":"/connections/payments/paypal-paypalpaylater"}]},{"title":"Sezzle","sidebarTitle":"Sezzle","href":"/connections/payments/sezzle-sezzle"},{"title":"Zip","sidebarTitle":"Zip","href":"/connections/payments/zippay-zippay"}]},{"group":"Cards","pages":[{"title":"ACI Worldwide - Card","sidebarTitle":"ACI Worldwide","href":"/connections/payments/aci-card"},{"title":"Adyen - Card","sidebarTitle":"Adyen","href":"/connections/payments/adyen-card"},{"title":"Airwallex - Card","sidebarTitle":"Airwallex","href":"/connections/payments/airwallex-card"},{"title":"Authorize.net - Card","sidebarTitle":"Authorize.net","href":"/connections/payments/authorizenet-card"},{"title":"BlueSnap - Card","sidebarTitle":"BlueSnap","href":"/connections/payments/bluesnap-card"},{"title":"Braintree - Card","sidebarTitle":"Braintree","href":"/connections/payments/braintree-card"},{"title":"Buckaroo - Card","sidebarTitle":"Buckaroo","href":"/connections/payments/buckaroo-card"},{"title":"CardPointe - Card","sidebarTitle":"CardPointe","href":"/connections/payments/cardpointe-card"},{"title":"Chase Orbital - Card","sidebarTitle":"Chase Orbital","href":"/connections/payments/chaseorbital-card"},{"title":"Checkout.com - Card","sidebarTitle":"Checkout.com","href":"/connections/payments/checkoutcom-card"},{"title":"Cybersource - Card","sidebarTitle":"Cybersource","href":"/connections/payments/cybersource-card"},{"title":"dLocal - Card","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-card"},{"title":"Ecommpay - Card","sidebarTitle":"Ecommpay","href":"/connections/payments/ecommpay-card"},{"title":"Finix - Card","sidebarTitle":"Finix","href":"/connections/payments/finix-card"},{"title":"Fiserv IPG - Card","sidebarTitle":"Fiserv IPG","href":"/connections/payments/fiserv-card"},{"title":"Mastercard Gateway - Card","sidebarTitle":"Mastercard Gateway","href":"/connections/payments/mastercard-card"},{"title":"Merchant Warrior - Card","sidebarTitle":"Merchant Warrior","href":"/connections/payments/merchantwarrior-card"},{"title":"Moneris - Card","sidebarTitle":"Moneris","href":"/connections/payments/moneris-card"},{"title":"NMI - Card","sidebarTitle":"NMI","href":"/connections/payments/nmi-card"},{"title":"Nuvei - Card","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-card"},{"title":"PayPal - Card","sidebarTitle":"PayPal","href":"/connections/payments/paypal-card"},{"title":"Planet - Card","sidebarTitle":"Planet","href":"/connections/payments/planet-card"},{"title":"Repay - Card","sidebarTitle":"Repay","href":"/connections/payments/repay-card"},{"title":"Ryft - Card","sidebarTitle":"Ryft","href":"/connections/payments/ryft-card"},{"title":"Shift4 - Card","sidebarTitle":"Shift4","href":"/connections/payments/shift4-card"},{"title":"Stripe - Card","sidebarTitle":"Stripe","href":"/connections/payments/stripe-card"},{"title":"Trust Payments - Card","sidebarTitle":"Trust Payments","href":"/connections/payments/trustpayments-card"},{"title":"Unlimit - Card","sidebarTitle":"Unlimit","href":"/connections/payments/unlimit-card"},{"title":"USAePay - Card","sidebarTitle":"USAePay","href":"/connections/payments/usaepay-card"},{"title":"Windcave - Card","sidebarTitle":"Windcave","href":"/connections/payments/windcave-card"},{"title":"Worldline Connect - Card","sidebarTitle":"Worldline Connect","href":"/connections/payments/worldlineconnect-card"},{"title":"Worldline TravelHub - Card","sidebarTitle":"Worldline TravelHub","href":"/connections/payments/travelhub-card"},{"title":"Worldpay (VAP) - Card","sidebarTitle":"Worldpay (VAP)","href":"/connections/payments/worldpayvap-card"},{"title":"Worldpay (WPG) - Card","sidebarTitle":"Worldpay (WPG)","href":"/connections/payments/worldpaywpg-card"}]},{"group":"Cash vouchers","pages":[{"group":"Abitab","pages":[{"title":"dLocal - Abitab","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-abitab"}]},{"group":"Boleto","pages":[{"title":"dLocal - Boleto","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-boleto"}]},{"group":"Efecty","pages":[{"title":"dLocal - Efecty","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-efecty"}]},{"group":"Konbini","pages":[{"title":"Adyen - Konbini","sidebarTitle":"Adyen","href":"/connections/payments/adyen-konbini"}]},{"group":"Konbini (7-Eleven)","pages":[{"title":"Adyen - Konbini (7-Eleven)","sidebarTitle":"Adyen","href":"/connections/payments/adyen-seveneleven"}]},{"title":"Multipago","sidebarTitle":"Multipago","href":"/connections/payments/multipago-multipago"},{"group":"OXXO","pages":[{"title":"OXXO","href":"/connections/payments/oxxo-oxxo"},{"title":"dLocal - OXXO","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-oxxo"},{"title":"Stripe - OXXO","sidebarTitle":"Stripe","href":"/connections/payments/stripe-oxxo"}]},{"group":"Pago Efectivo","pages":[{"title":"dLocal - Pago Efectivo","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-pagoefectivo"}]},{"group":"Payvalida","pages":[{"title":"dLocal - Payvalida","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-payvalida"}]},{"group":"Rapipago","pages":[{"title":"dLocal - Rapipago","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-rapipago"}]},{"group":"Redpagos","pages":[{"title":"dLocal - Redpagos","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-redpagos"}]},{"group":"Servipag","pages":[{"title":"dLocal - Servipag","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-servipag"}]}]},{"group":"Crypto","pages":[{"title":"The Giving Block","href":"/connections/payments/givingblock-givingblock"}]},{"group":"Gift cards","pages":[{"title":"Qwikcilver (Gift Cards)","sidebarTitle":"Qwikcilver","href":"/connections/payments/qwikcilver-gift-card"},{"title":"Value Link (Gift Cards)","sidebarTitle":"Value Link","href":"/connections/payments/valuelink-gift-card"}]},{"group":"Wallets","pages":[{"group":"Alipay","pages":[{"title":"Adyen - Alipay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-alipay"},{"title":"dLocal - Alipay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-alipay"}]},{"group":"Boost","pages":[{"title":"dLocal - Boost","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-boost"}]},{"group":"Cash App Pay","pages":[{"title":"Adyen - Cash App Pay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-cashapp"}]},{"group":"DANA","pages":[{"title":"dLocal - DANA","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-dana"}]},{"group":"DuitNow","pages":[{"title":"Adyen - DuitNow","sidebarTitle":"Adyen","href":"/connections/payments/adyen-duitnow"}]},{"group":"GCash","pages":[{"title":"Adyen - GCash","sidebarTitle":"Adyen","href":"/connections/payments/adyen-gcash"},{"title":"dLocal - GCash","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-gcash"}]},{"group":"GrabPay","pages":[{"title":"dLocal - GrabPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-grabpay"}]},{"group":"Link","pages":[{"title":"Stripe - Onelink","sidebarTitle":"Stripe","href":"/connections/payments/stripe-onelink"}]},{"group":"LinkAja","pages":[{"title":"dLocal - LinkAja","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-linkaja"}]},{"group":"Maya","pages":[{"title":"dLocal - Maya","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-paymaya"}]},{"group":"Maybank QRPay","pages":[{"title":"dLocal - Maybank QRPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-maybankqrpay"}]},{"group":"Mercado Pago","pages":[{"title":"dLocal - Mercado Pago","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-mercadopago"}]},{"group":"Nequi","pages":[{"title":"dLocal - Nequi","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-nequi"}]},{"group":"OVO","pages":[{"title":"dLocal - OVO","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-ovo"}]},{"title":"PayPal","sidebarTitle":"PayPal","href":"/connections/payments/paypal-paypal"},{"group":"PayPay","pages":[{"title":"Adyen - PayPay","sidebarTitle":"Adyen","href":"/connections/payments/adyen-paypay"}]},{"title":"Paysquad","sidebarTitle":"Paysquad","href":"/connections/payments/paysquad-paysquad"},{"group":"PicPay","pages":[{"title":"dLocal - PicPay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-picpay"}]},{"group":"Rabbit LINE Pay","pages":[{"title":"dLocal - Rabbit LINE Pay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-rabbitlinepay"}]},{"group":"ShopeePay","pages":[{"title":"dLocal - ShopeePay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-shopeepay"}]},{"title":"Smartpay","sidebarTitle":"Smartpay","href":"/connections/payments/smartpay-smartpay"},{"group":"Swish","pages":[{"title":"Adyen - Swish","sidebarTitle":"Adyen","href":"/connections/payments/adyen-swish"}]},{"group":"Thai QR","pages":[{"title":"dLocal - Thai QR Payment","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-thaiqr"}]},{"group":"Touch 'n Go","pages":[{"title":"dLocal - Touch 'n Go","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-touchngo"}]},{"group":"TrueMoney","pages":[{"title":"dLocal - TrueMoney","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-truemoney"}]},{"group":"Venmo","pages":[{"title":"Braintree - Venmo","sidebarTitle":"Braintree","href":"/connections/payments/braintree-venmo"},{"title":"PayPal - Venmo","sidebarTitle":"PayPal","href":"/connections/payments/paypal-venmo"}]},{"group":"Vipps","pages":[{"title":"Adyen - Vipps","sidebarTitle":"Adyen","href":"/connections/payments/adyen-vipps"}]},{"group":"WeChat Pay","pages":[{"title":"dLocal - WeChat Pay","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-wechat"}]},{"group":"Wero","pages":[{"title":"Nuvei - Wero","sidebarTitle":"Nuvei","href":"/connections/payments/nuvei-wero"}]},{"group":"Yape","pages":[{"title":"dLocal - Yape","sidebarTitle":"dLocal","href":"/connections/payments/dlocal-yape"}]}]}]},{"group":"Digital wallets","icon":"wallet","pages":[{"title":"Apple Pay","sidebarTitle":"Apple Pay","href":"/connections/digital-wallets/apple-pay"},{"title":"Click to Pay","sidebarTitle":"Click to Pay","href":"/connections/digital-wallets/click-to-pay"},{"title":"Google Pay","sidebarTitle":"Google Pay","href":"/connections/digital-wallets/google-pay"},{"title":"Paze","sidebarTitle":"Paze","href":"/connections/digital-wallets/paze"}]},{"group":"Anti-fraud","icon":"shield","pages":[{"title":"Cybersource Decision Manager","sidebarTitle":"Cybersource","href":"/connections/anti-fraud/cybersource"},{"title":"Forter","sidebarTitle":"Forter","href":"/connections/anti-fraud/forter"},{"title":"Riskified","sidebarTitle":"Riskified","href":"/connections/anti-fraud/riskified"},{"title":"Sardine","sidebarTitle":"Sardine","href":"/connections/anti-fraud/sardine"},{"title":"Sift","sidebarTitle":"Sift","href":"/connections/anti-fraud/sift"}]},{"group":"Browse","icon":"magnifying-glass","pages":[{"title":"Connectors by country","href":"/connections/payments/by-country"},{"title":"Connectors by currency","href":"/connections/payments/by-currency"},{"title":"Card schemes","href":"/connections/payments/card-schemes"}]}]},{"tab":"Custom Connectors","icon":"plug","hidden":true,"pages":[{"title":"Custom Connectors","sidebarTitle":"Overview","href":"/guides/features/custom-connectors/overview"},{"group":"Integration","expanded":true,"pages":[{"title":"Configure the connector","sidebarTitle":"Step 1: Configure","href":"/guides/features/custom-connectors/integration/configure"},{"title":"Implement your adapter","sidebarTitle":"Step 2: Implement","href":"/guides/features/custom-connectors/integration/implement-adapter"},{"title":"Handle commands","sidebarTitle":"Step 3: Handle commands","href":"/guides/features/custom-connectors/integration/handle-commands"},{"title":"Return responses and operate","sidebarTitle":"Step 4: Operate","href":"/guides/features/custom-connectors/integration/return-and-operate"}]},{"group":"API reference","expanded":true,"pages":[{"sidebarTitle":"Verify credentials","title":"Verify credentials","openapi":"openapi.custom-connectors.json GET /verify-credentials","href":"/guides/features/custom-connectors/api/verify-credentials"},{"sidebarTitle":"Create transaction","title":"Create transaction","openapi":"openapi.custom-connectors.json POST /create-transaction","href":"/guides/features/custom-connectors/api/create-transaction"},{"sidebarTitle":"Approve transaction","title":"Approve transaction","openapi":"openapi.custom-connectors.json POST /approve-transaction","href":"/guides/features/custom-connectors/api/approve-transaction"},{"sidebarTitle":"Capture transaction","title":"Capture transaction","openapi":"openapi.custom-connectors.json POST /capture-transaction","href":"/guides/features/custom-connectors/api/capture-transaction"},{"sidebarTitle":"Create refund","title":"Create refund","openapi":"openapi.custom-connectors.json POST /create-refund","href":"/guides/features/custom-connectors/api/create-refund"},{"sidebarTitle":"Sync transaction","title":"Sync transaction","openapi":"openapi.custom-connectors.json POST /sync","href":"/guides/features/custom-connectors/api/sync-transaction"},{"sidebarTitle":"Webhook","title":"Webhook","openapi":"openapi.custom-connectors.json POST /webhook","href":"/guides/features/custom-connectors/api/webhook"}]},{"group":"Tokenization API reference","pages":[{"sidebarTitle":"Create token","title":"Create token","openapi":"openapi.custom-connectors.json POST /create-token","href":"/guides/features/custom-connectors/api/create-token"},{"sidebarTitle":"Approve token","title":"Approve token","openapi":"openapi.custom-connectors.json POST /approve-token","href":"/guides/features/custom-connectors/api/approve-token"},{"sidebarTitle":"Delete token","title":"Delete token","openapi":"openapi.custom-connectors.json POST /delete-token","href":"/guides/features/custom-connectors/api/delete-token"}]}]},{"tab":"Connector Requirements","icon":"clipboard-check","hidden":true,"pages":[{"title":"Connector requirements","sidebarTitle":"Overview","href":"/partners/connector-requirements/overview"},{"title":"Platform requirements","sidebarTitle":"Platform requirements","href":"/partners/connector-requirements/platform"},{"group":"Card connectors","expanded":true,"pages":[{"title":"Card connector requirements","sidebarTitle":"Cards overview","href":"/partners/connector-requirements/cards/overview"},{"title":"Card processing, routing, and failover","sidebarTitle":"Processing and failover","href":"/partners/connector-requirements/cards/processing"},{"title":"3-D Secure for card connectors","sidebarTitle":"3-D Secure","href":"/partners/connector-requirements/cards/three-d-secure"},{"title":"Digital wallets for card connectors","sidebarTitle":"Digital wallets","href":"/partners/connector-requirements/cards/wallets"},{"title":"Vault, network tokens, and recurring for cards","sidebarTitle":"Cards recurring","href":"/partners/connector-requirements/cards/recurring"},{"title":"Card summary checklist","sidebarTitle":"Cards checklist","href":"/partners/connector-requirements/cards/checklist"}]},{"group":"APM connectors","expanded":true,"pages":[{"title":"APM connector requirements","sidebarTitle":"APM overview","href":"/partners/connector-requirements/apm/overview"},{"title":"Redirect mode","sidebarTitle":"Redirect","href":"/partners/connector-requirements/apm/redirect"},{"title":"Direct mode","sidebarTitle":"Direct","href":"/partners/connector-requirements/apm/direct"},{"title":"Push payments","sidebarTitle":"Push","href":"/partners/connector-requirements/apm/push"},{"title":"Stored payment methods and recurring","sidebarTitle":"APM recurring","href":"/partners/connector-requirements/apm/recurring"},{"title":"APM summary checklist","sidebarTitle":"APM checklist","href":"/partners/connector-requirements/apm/checklist"}]},{"group":"Gift card connectors","expanded":true,"pages":[{"title":"Gift card connectors","sidebarTitle":"Overview","href":"/partners/connector-requirements/gift-cards/overview"},{"title":"Split tender and rollback","sidebarTitle":"Split tender","href":"/partners/connector-requirements/gift-cards/transactions"},{"title":"Operations and errors","sidebarTitle":"Operations and errors","href":"/partners/connector-requirements/gift-cards/operations"},{"title":"Stored cards, issuance, and activation","sidebarTitle":"Stored cards and issuance","href":"/partners/connector-requirements/gift-cards/lifecycle"},{"title":"Gift card summary checklist","sidebarTitle":"Gift cards checklist","href":"/partners/connector-requirements/gift-cards/checklist"}]},{"group":"Anti-fraud connectors","expanded":true,"pages":[{"title":"Anti-fraud connector requirements","sidebarTitle":"Anti-fraud overview","href":"/partners/connector-requirements/anti-fraud/overview"},{"title":"The anti-fraud decision","sidebarTitle":"Decisions","href":"/partners/connector-requirements/anti-fraud/decisions"},{"title":"Reviews and asynchronous outcomes","sidebarTitle":"Reviews","href":"/partners/connector-requirements/anti-fraud/reviews"},{"title":"Device fingerprinting","sidebarTitle":"Fingerprinting","href":"/partners/connector-requirements/anti-fraud/fingerprinting"},{"title":"Post-transaction feedback","sidebarTitle":"Feedback","href":"/partners/connector-requirements/anti-fraud/feedback"},{"title":"Anti-fraud summary checklist","sidebarTitle":"Anti-fraud checklist","href":"/partners/connector-requirements/anti-fraud/checklist"}]},{"title":"Glossary","sidebarTitle":"Glossary","href":"/partners/connector-requirements/glossary"}]},{"tab":"External Apps","icon":"puzzle-piece","hidden":true,"pages":[{"title":"External apps","sidebarTitle":"External apps","href":"/partners/external-apps"}]},{"tab":"API Reference","icon":{"style":"light","name":"square-terminal"},"groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Authentication","mode":"wide","href":"/guides/api/authentication"},{"title":"Managing API keys","sidebarTitle":"API keys","mode":"wide","href":"/guides/api/api-keys"},{"title":"API Compatibility","sidebarTitle":"Compatibility","href":"/guides/api/compatibility"},{"title":"Connectivity and TLS","sidebarTitle":"Connectivity","href":"/guides/api/connectivity"},{"sidebarTitle":"JWTs","title":"Authentication with JWTs","href":"/guides/api/jwts"},{"title":"Environments","href":"/guides/api/environments"},{"title":"Error handling","sidebarTitle":"Errors","mode":"wide","href":"/guides/api/errors"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"title":"IP address forwarding","href":"/guides/api/ip-address-forwarding"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"},{"title":"Pagination","href":"/guides/api/pagination"},{"sidebarTitle":"Prefer header","title":"Prefer header","href":"/guides/api/prefer-header"},{"title":"Rate limiting","href":"/guides/api/rate-limiting"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"},{"title":"Transaction error codes","sidebarTitle":"Error Codes","mode":"wide","href":"/guides/api/error-codes"}]},{"group":"Transactions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions","title":"List transactions","href":"/reference/transactions/list-transactions"},{"openapi":"openapi.speakeasy.json POST /transactions","title":"Create transaction","href":"/reference/transactions/new-transaction"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}","title":"Get transaction","href":"/reference/transactions/get-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/capture","title":"Capture transaction","href":"/reference/transactions/capture-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/void","title":"Void transaction","href":"/reference/transactions/void-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/authorization/increment","title":"Increment transaction authorization","href":"/reference/transactions/increment-transaction-authorization"},{"group":"Captures","pages":[{"sidebarTitle":"List captures","title":"List transaction captures","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures","href":"/reference/transactions/list-transaction-captures"},{"sidebarTitle":"Get capture","title":"Get capture","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures/{capture_id}","href":"/reference/transactions/get-transaction-capture"}]},{"group":"More actions","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/events","title":"List transaction events","href":"/reference/transactions/list-transaction-events"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/actions","title":"List transaction Flow rules","href":"/reference/transactions/list-transaction-actions"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/sync","title":"Sync transaction","href":"/reference/transactions/sync-transaction"},{"title":"Update a transaction","openapi":"openapi.speakeasy.json PUT /transactions/{transaction_id}","href":"/reference/transactions/update-transaction"},{"title":"Cancel a transaction","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/cancel","href":"/reference/transactions/cancel-transaction"},{"title":"Get or update transaction session","sidebarTitle":"Get session","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/session","href":"/reference/transactions/get-transaction-session"}]}]},{"group":"Buyers","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /buyers","title":"List all buyers","href":"/reference/buyers/list-buyers"},{"openapi":"openapi.speakeasy.json POST /buyers","title":"Add a buyer","href":"/reference/buyers/new-buyer"},{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}","title":"Get a buyer","href":"/reference/buyers/get-buyer"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}","title":"Update a buyer","href":"/reference/buyers/update-buyer"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}","title":"Delete a buyer","href":"/reference/buyers/delete-buyer"},{"group":"Shipping details","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}/shipping-details","title":"List a buyer's shipping details","href":"/reference/buyers/get-buyer-shipping-details"},{"openapi":"openapi.speakeasy.json POST /buyers/{buyer_id}/shipping-details","title":"Add buyer shipping details","href":"/reference/buyers/new-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Update a buyer's shipping details","href":"/reference/buyers/update-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Delete a buyer's shipping details","href":"/reference/buyers/delete-buyer-shipping-detail"}]}]},{"group":"Checkout Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /checkout/sessions","title":"Create checkout session","href":"/reference/checkout-sessions/new-checkout-session"},{"openapi":"openapi.speakeasy.json GET /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/get-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/update-checkout-session"},{"openapi":"openapi.speakeasy.json DELETE /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/delete-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}/fields","sidebarTitle":"Update session fields","title":null,"href":"/reference/checkout-sessions/update-checkout-session-fields"}]},{"group":"Payment links","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payment-links","title":"List all payment links","href":"/reference/payment-links/list-payment-links"},{"openapi":"openapi.speakeasy.json POST /payment-links","title":"Add a payment link","href":"/reference/payment-links/new-payment-link"},{"openapi":"openapi.speakeasy.json GET /payment-links/{payment_link_id}","title":"Get payment link","href":"/reference/payment-links/get-payment-link"},{"openapi":"openapi.speakeasy.json POST /payment-links/{payment_link_id}/expire","title":"Expire a payment link","href":"/reference/payment-links/expire-payment-link"}]},{"group":"Payment options","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-options","title":"List payment options","href":"/reference/payment-options/list-payment-options"}]},{"group":"Payouts","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payouts","title":"List payouts created","href":"/reference/payouts/list-payouts"},{"openapi":"openapi.speakeasy.json POST /payouts","title":"Create a payout","href":"/reference/payouts/new-payout"},{"openapi":"openapi.speakeasy.json GET /payouts/{payout_id}","title":"Get a payout","href":"/reference/payouts/get-payout"}]},{"group":"Refunds","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refunds","title":"List transaction refunds","href":"/reference/transactions/list-transaction-refunds"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds","title":"Create transaction refund","href":"/reference/transactions/refund-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds/all","sidebarTitle":"Refund all instruments","title":"Create batch transaction refund","href":"/reference/transactions/refund-all"},{"sidebarTitle":"Get refund","title":"Get refund","openapi":"openapi.speakeasy.json GET /refunds/{refund_id}","href":"/reference/transactions/get-refund"}]},{"group":"Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-service-definitions/{payment_service_definition_id}/sessions","sidebarTitle":"Get session","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session"},{"openapi":"openapi.speakeasy.json POST /payment-services/{payment_service_id}/sessions","sidebarTitle":"Get session by ID","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session-by-id"}]},{"group":"Settlement records","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements","sidebarTitle":"List settlement records","title":"List transaction settlements","href":"/reference/settlements/list-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements/{settlement_id}","sidebarTitle":"Get settlement record","title":"Get transaction settlement","href":"/reference/settlements/get-settlement"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements","sidebarTitle":"List refund settlement records","title":"List transaction refund settlements","href":"/reference/settlements/list-refund-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements/{settlement_id}","sidebarTitle":"Get refund settlement record","title":"Get transaction refund settlement","href":"/reference/settlements/get-refund-settlement"}]},{"group":"Disputes","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargebacks","sidebarTitle":"List chargeback records","title":"List transaction chargebacks","href":"/reference/disputes/list-chargebacks"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargeback-reversals","sidebarTitle":"List chargeback reversal records","title":"List transaction chargeback reversals","href":"/reference/disputes/list-chargeback-reversals"}]},{"group":"Instruments","icon":"code","pages":[{"group":"Card schemes","pages":[{"openapi":"openapi.speakeasy.json GET /card-scheme-definitions","title":"List card scheme definitions","href":"/reference/card-schemes/list-card-scheme-definitions"}]},{"group":"Card details","pages":[{"openapi":"openapi.speakeasy.json GET /card-details","title":"Get card details","href":"/reference/card-details/get-card-details"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/apple/session","title":"Create a Apple Pay session","href":"/reference/digital-wallets/get-apple-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/google/session","title":"Create a Google Pay session","href":"/reference/digital-wallets/get-google-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/click-to-pay/session","title":"Create a Click to Pay session","href":"/reference/digital-wallets/get-click-to-pay-session"}]},{"group":"Gift cards","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/gift-cards","title":"List gift cards for a buyer","href":"/reference/gift-cards/list-buyer-gift-cards"},{"openapi":"openapi.speakeasy.json GET /gift-cards","title":"List gift cards","href":"/reference/gift-cards/list-gift-cards"},{"openapi":"openapi.speakeasy.json POST /gift-cards/balances","title":"Verify and get gift card balances","sidebarTitle":"Verify \u0026 get balance","href":"/reference/gift-cards/list-gift-card-balances"},{"openapi":"openapi.speakeasy.json POST /gift-cards","title":"Create gift card","href":"/reference/gift-cards/new-gift-card"},{"openapi":"openapi.speakeasy.json GET /gift-cards/{gift_card_id}","title":"Get gift card","href":"/reference/gift-cards/get-gift-card"},{"openapi":"openapi.speakeasy.json DELETE /gift-cards/{gift_card_id}","title":"Delete a gift card","href":"/reference/gift-cards/delete-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/issuances","title":"Issue a gift card","href":"/reference/gift-cards/issue-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/activations","title":"Activate a gift card","href":"/reference/gift-cards/activate-gift-card"}]},{"group":"Payment methods","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/payment-methods","title":"List payment methods for a buyer","href":"/reference/payment-methods/list-buyer-payment-methods"},{"openapi":"openapi.speakeasy.json GET /payment-methods","title":"List all payment methods","href":"/reference/payment-methods/list-payment-methods"},{"openapi":"openapi.speakeasy.json POST /payment-methods","title":"Create payment method","href":"/reference/payment-methods/new-payment-method"},{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}","title":"Get payment method","href":"/reference/payment-methods/get-payment-method"},{"openapi":"openapi.speakeasy.json PUT /payment-methods/{payment_method_id}","title":"Update payment method","href":"/reference/payment-methods/update-payment-method"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}","title":"Delete payment method","href":"/reference/payment-methods/delete-payment-method"}]},{"group":"Payment method definitions","pages":[{"openapi":"openapi.speakeasy.json GET /payment-method-definitions","title":"List payment method definitions","href":"/reference/payment-method-definitions/list-payment-method-definitions"}]}]},{"group":"Vault","icon":"code","pages":[{"group":"Account updater","pages":[{"openapi":"openapi.speakeasy.json POST /account-updater/jobs","sidebarTitle":"Create a job","title":"Create account updater job","href":"/reference/account-updater/new-account-updater-job"}]},{"group":"Network tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/network-tokens","title":"List network tokens","href":"/reference/network-tokens/list-network-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens","title":"Provision network token","href":"/reference/network-tokens/provision-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram","title":"Provision network token cryptogram","href":"/reference/network-tokens/get-network-token-cryptogram"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend","title":"Suspend network token","href":"/reference/network-tokens/suspend-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume","title":"Resume network token","href":"/reference/network-tokens/resume-network-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/network-tokens/{network_token_id}","title":"Delete network token","href":"/reference/network-tokens/delete-network-token"}]},{"group":"Payment service tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/payment-service-tokens","title":"List payment service tokens","href":"/reference/payment-service-tokens/list-payment-service-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/payment-service-tokens","title":"Create payment service token","href":"/reference/payment-service-tokens/provision-payment-service-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/payment-service-tokens/{payment_service_token_id}","title":"Delete payment service token","href":"/reference/payment-service-tokens/delete-payment-service-token"}]},{"group":"Vault Forward","pages":[{"openapi":"openapi.v1.json POST /vault-forward","title":"Forward PCI data","href":"/reference/vault-forwarding/make-vault-forward"}]},{"group":"Vault Forward endpoints","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs","sidebarTitle":"List endpoints","title":"List configured Vault Forward endpoints","href":"/reference/vault-forwarding/list-vault-forward-configs"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}","sidebarTitle":"Get endpoint","title":"Get configured Vault Forward endpoints","href":"/reference/vault-forwarding/get-vault-forward-config"}]},{"group":"Vault Forward authentication","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Get authentications","title":"List configured Vault Forward authentication methods","href":"/reference/vault-forwarding/list-vault-forward-authentications"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Get authentication","title":"Get Vault Forward authentication method","href":"/reference/vault-forwarding/get-vault-forward-authentication"},{"openapi":"openapi.v1.json POST /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Add authentication","title":"Adds new Vault Forward authentication method","href":"/reference/vault-forwarding/add-vault-forward-authentication"},{"openapi":"openapi.v1.json PUT /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Update authentication","title":"Update Vault Forward authentication method","href":"/reference/vault-forwarding/update-vault-forward-authentication"},{"openapi":"openapi.v1.json DELETE /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Remove authentication","title":"Remove a Vault Forward authentication method","href":"/reference/vault-forwarding/delete-vault-forward-authentication"}]}]},{"group":"PSPs \u0026 Gateways","icon":"code","pages":[{"group":"All services","pages":[{"openapi":"openapi.v1.json GET /connections","title":"List connections","href":"/reference/connections/list-connections"},{"openapi":"openapi.speakeasy.json GET /connection-definitions","title":null,"href":"/reference/connections/list-connection-definitions"}]},{"group":"Payment services","pages":[{"openapi":"openapi.speakeasy.json GET /payment-service-definitions/{payment_service_definition_id}","sidebarTitle":"Get service definition","title":"Get a payment service definition","href":"/reference/payment-service-definitions/get-payment-service-definition"},{"openapi":"openapi.speakeasy.json GET /payment-services","title":"List payment services","href":"/reference/payment-services/list-payment-services"},{"openapi":"openapi.speakeasy.json POST /payment-services","title":"Configure a payment service","href":"/reference/payment-services/new-payment-service"},{"openapi":"openapi.speakeasy.json GET /payment-services/{payment_service_id}","title":"Get payment service","href":"/reference/payment-services/get-payment-service"},{"openapi":"openapi.speakeasy.json PUT /payment-services/{payment_service_id}","title":"Update a configured payment service","href":"/reference/payment-services/update-payment-service"},{"openapi":"openapi.speakeasy.json DELETE /payment-services/{payment_service_id}","title":"Delete a configured payment service","href":"/reference/payment-services/delete-payment-service"},{"openapi":"openapi.speakeasy.json POST /payment-services/verify","sidebarTitle":"Verify credentials","title":"Verify payment service credentials","href":"/reference/payment-services/verify-payment-service"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json GET /digital-wallets","title":"List digital wallets","href":"/reference/digital-wallets/list-digital-wallets"},{"openapi":"openapi.speakeasy.json GET /digital-wallets/{digital_wallet_id}","title":"Get digital wallet","href":"/reference/digital-wallets/get-digital-wallet"},{"openapi":"openapi.speakeasy.json POST /digital-wallets","title":"Register digital wallet","href":"/reference/digital-wallets/register-digital-wallet"},{"openapi":"openapi.speakeasy.json PUT /digital-wallets/{digital_wallet_id}","title":"Update digital wallet","href":"/reference/digital-wallets/update-digital-wallet"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}","title":"Delete digital wallet","href":"/reference/digital-wallets/deregister-digital-wallet"},{"group":"Domain registration","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/{digital_wallet_id}/domains","title":"Register a digital wallet domain","href":"/reference/digital-wallets/new-digital-wallet-domain"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}/domains","title":"Remove a digital wallet domain","href":"/reference/digital-wallets/delete-digital-wallet-domain"}]},{"group":"Mobile Certificates (Apple Pay)","pages":[{"openapi":"openapi.v1.json GET /apple-pay-certificates","sidebarTitle":"List certificates","title":"List Apple Pay certificates","href":"/reference/digital-wallets/list-apple-pay-certificates"},{"openapi":"openapi.v1.json POST /apple-pay-certificates","sidebarTitle":"Create certificate","title":"New Apple Pay certificate","href":"/reference/digital-wallets/create-apple-pay-certificate"},{"openapi":"openapi.v1.json PUT /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Update certificate","title":"Update Apple Pay certificate","href":"/reference/digital-wallets/update-apple-pay-certificate"},{"openapi":"openapi.v1.json DELETE /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Delete certificate","title":"Remove Apple Pay certificate","href":"/reference/digital-wallets/delete-apple-pay-certificate"}]}]},{"group":"Anti-fraud services","pages":[{"openapi":"openapi.v1.json GET /anti-fraud-service-definitions/{anti_fraud_service_definition_id}","sidebarTitle":"Get service definition","title":"Get anti fraud service definition","href":"/reference/anti-fraud-services/get-anti-fraud-service-definition"},{"openapi":"openapi.v1.json POST /anti-fraud-services","title":"New anti-fraud service","href":"/reference/anti-fraud-services/new-anti-fraud-service"},{"openapi":"openapi.v1.json GET /anti-fraud-services/{anti_fraud_service_id}","title":"Get anti-fraud service","href":"/reference/anti-fraud-services/get-anti-fraud-service"},{"openapi":"openapi.v1.json PUT /anti-fraud-services/{anti_fraud_service_id}","title":"Update anti-fraud service","href":"/reference/anti-fraud-services/update-anti-fraud-service"},{"openapi":"openapi.v1.json DELETE /anti-fraud-services/{anti_fraud_service_id}","title":"Delete anti-fraud service","href":"/reference/anti-fraud-services/delete-anti-fraud-service"}]},{"group":"Gift-card services","pages":[{"openapi":"openapi.v1.json GET /gift-card-service-definitions/{gift_card_service_definition_id}","sidebarTitle":"Get service definition","title":"Get gift card service definition","href":"/reference/gift-card-services/get-gift-card-service-definition"},{"openapi":"openapi.v1.json POST /gift-card-services","title":"New gift card service","href":"/reference/gift-card-services/new-gift-card-service"},{"openapi":"openapi.v1.json GET /gift-card-services/{gift_card_service_id}","title":"Get gift card service","href":"/reference/gift-card-services/get-gift-card-service"},{"openapi":"openapi.v1.json PUT /gift-card-services/{gift_card_service_id}","title":"Update gift card service","href":"/reference/gift-card-services/update-gift-card-service"},{"openapi":"openapi.v1.json DELETE /gift-card-services/{gift_card_service_id}","title":"Delete gift card service","href":"/reference/gift-card-services/delete-gift-card-service"}]}]},{"group":"Errors","icon":"code","pages":[{"title":"Client-side errors (4XX)","sidebarTitle":"Client errors","href":"/reference/errors/client-errors"},{"title":"Server-side errors (5XX)","sidebarTitle":"Server errors","href":"/reference/errors/server-errors"},{"openapi":"openapi.v1.json GET /api-logs","title":"List 4XX errors","href":"/reference/logs/list-api-error-logs"}]},{"group":"Other","icon":"code","pages":[{"group":"API keys","pages":[{"openapi":"openapi.speakeasy.json GET /api-key-pairs","sidebarTitle":"List API keys","title":"List all API key pairs","href":"/reference/api-key-pairs/list-api-key-pairs"},{"openapi":"openapi.speakeasy.json POST /api-key-pairs","sidebarTitle":"Create API key","title":"Create an API key pair","href":"/reference/api-key-pairs/new-api-key-pair"},{"openapi":"openapi.speakeasy.json GET /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Get API key","title":"Get an API key pair","href":"/reference/api-key-pairs/get-api-key-pair"},{"openapi":"openapi.speakeasy.json PUT /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Update API key","title":"Update an API key pair","href":"/reference/api-key-pairs/update-api-key-pair"},{"openapi":"openapi.speakeasy.json DELETE /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Delete API key","title":"Delete an API key pair","href":"/reference/api-key-pairs/delete-api-key-pair"}]},{"group":"3DS Configuration","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"List 3DS configuration","sidebarTitle":"List 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/list-three-ds-configurations"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"Add 3DS configuration","sidebarTitle":"Add 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/new-three-ds-configuration"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Update 3DS configuration","sidebarTitle":"Update 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/update-three-ds-configuration"},{"openapi":"openapi.speakeasy.json DELETE /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Delete 3DS configuration","sidebarTitle":"Delete 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/delete-three-ds-configuration"}]},{"group":"3DS Scenarios","pages":[{"openapi":"openapi.speakeasy.json GET /three-ds-scenarios","title":"List 3DS scenario","href":"/reference/three-ds-scenarios/list-three-ds-scenarios"},{"openapi":"openapi.speakeasy.json POST /three-ds-scenarios","title":"Create a 3DS scenario","href":"/reference/three-ds-scenarios/new-three-ds-scenario"},{"openapi":"openapi.speakeasy.json PUT /three-ds-scenarios/{three_ds_scenario_id}","title":"Update a 3DS scenario","href":"/reference/three-ds-scenarios/update-three-ds-scenario"},{"openapi":"openapi.speakeasy.json DELETE /three-ds-scenarios/{three_ds_scenario_id}","title":"Delete a 3DS scenario","href":"/reference/three-ds-scenarios/delete-three-ds-scenario"}]},{"group":"Flow","pages":[{"openapi":"openapi.v1.json GET /flows/{flow}","title":"List flow rules","href":"/reference/flow/list-rules"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Get rule","href":"/reference/flow/get-rule"},{"openapi":"openapi.v1.json POST /flows/{flow}/actions/{action}/rules","title":"Create flow rule","href":"/reference/flow/new-rule"},{"openapi":"openapi.v1.json PUT /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Update flow rule","href":"/reference/flow/update-rule"},{"openapi":"openapi.v1.json DELETE /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Delete flow rule","href":"/reference/flow/delete-rule"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/outcomes","title":"List flow outcomes","href":"/reference/flow/list-outcomes"}]},{"group":"Merchant accounts","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts","title":"List all merchant accounts","href":"/reference/merchant-accounts/list-merchant-accounts"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts","title":"Create a merchant account","href":"/reference/merchant-accounts/new-merchant-account"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}","title":"Update a merchant account","href":"/reference/merchant-accounts/update-merchant-account"}]},{"group":"Reports","pages":[{"openapi":"openapi.speakeasy.json GET /reports","title":"List configured reports","href":"/reference/reports/list-reports"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}","title":"Get a report","href":"/reference/reports/get-report"},{"openapi":"openapi.speakeasy.json POST /reports","title":"Add a report","href":"/reference/reports/new-report"},{"openapi":"openapi.speakeasy.json PUT /reports/{report_id}","title":"Update a report","href":"/reference/reports/update-report"}]},{"group":"Report executions","pages":[{"openapi":"openapi.speakeasy.json GET /report-executions","title":"List executed reports","href":"/reference/reports/list-all-report-executions"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}/executions","title":"List executions for report","href":"/reference/reports/list-executions-for-report"},{"openapi":"openapi.speakeasy.json GET /report-executions/{report_execution_id}","title":"Get executed report","href":"/reference/reports/get-report-execution"},{"openapi":"openapi.speakeasy.json POST /reports/{report_id}/executions/{report_execution_id}/url","title":"Create URL for executed report","href":"/reference/reports/generate-download-url"}]},{"group":"Roles","pages":[{"openapi":"openapi.speakeasy.json GET /roles","sidebarTitle":"List roles","title":"List all roles","href":"/reference/roles/list-roles"}]},{"group":"Users","pages":[{"openapi":"openapi.speakeasy.json GET /audit-logs","title":"List audit log entries","href":"/reference/audit-logs/list-audit-logs"}]},{"group":"Webhook subscriptions","pages":[{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions","sidebarTitle":"List subscriptions","title":"List webhook subscriptions","href":"/reference/webhook-subscriptions/list-webhook-subscriptions"},{"openapi":"openapi.speakeasy.json POST /webhook-subscriptions","sidebarTitle":"New subscription","title":"Create webhook subscription","href":"/reference/webhook-subscriptions/new-webhook-subscription"},{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions/{subscription_id}","sidebarTitle":"Get subscription","title":"Get webhook subscription","href":"/reference/webhook-subscriptions/get-webhook-subscription"},{"openapi":"openapi.speakeasy.json PUT /webhook-subscriptions/{subscription_id}","sidebarTitle":"Update subscription","title":"Update webhook subscription","href":"/reference/webhook-subscriptions/update-webhook-subscription"},{"openapi":"openapi.speakeasy.json DELETE /webhook-subscriptions/{subscription_id}","sidebarTitle":"Delete subscription","title":"Delete webhook subscription","href":"/reference/webhook-subscriptions/delete-webhook-subscription"}]}]}]},{"tab":"Updates","icon":"bullhorn","groups":[{"group":"Updates","icon":"bell","pages":[{"title":"The Changelog","sidebarTitle":"Latest","href":"/updates"},{"title":null,"href":"/updates/2025"}]},{"group":"SDKs","icon":"toolbox","pages":[{"title":"C#","url":"https://github.com/gr4vy/gr4vy-csharp/releases","href":"/updates/csharp"},{"title":"Go","url":"https://github.com/gr4vy/gr4vy-go/releases","href":"/updates/go"},{"title":"Java","url":"https://github.com/gr4vy/gr4vy-java/releases","href":"/updates/java"},{"title":"PHP","url":"https://github.com/gr4vy/gr4vy-php/releases","href":"/updates/php"},{"title":"Python","url":"https://github.com/gr4vy/gr4vy-python/releases","href":"/updates/python"},{"title":"TypeScript","url":"https://github.com/gr4vy/gr4vy-typescript/releases","href":"/updates/typescript"},{"title":"Swift","url":"https://github.com/gr4vy/gr4vy-swift/releases","href":"/updates/swift"},{"title":"Kotlin","url":"https://github.com/gr4vy/gr4vy-kotlin/releases","href":"/updates/kotlin"},{"title":"iOS","url":"https://github.com/gr4vy/gr4vy-ios/releases","href":"/updates/ios"},{"title":"Android","url":"https://github.com/gr4vy/gr4vy-android/releases","href":"/updates/android"}]}]}]},"title":"List payment service definitions - Gr4vy","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}