{"items":[{"type":"link","label":"Payouts","link":"/products/card-payouts/v3/openapi","routeSlug":"/products/card-payouts/v3/openapi","content":{"contentType":"overview","meta":{"name":"Payouts"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/card-payouts/@v3/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/card-payouts/@v3/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Payouts (3)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set your headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Authorization: {your_credentials}\n  Content-Type: application/vnd.worldpay.payouts-v3+json\n  Accept: application/vnd.worldpay.payouts-v3+json\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Authorization: {your_credentials}\n  Content-Type: application/vnd.worldpay.payouts-v3+json\n  Accept: application/vnd.worldpay.payouts-v3+json\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS whitelisting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist the following URLs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay.com/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay.com/"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/card-payouts/v3/openapi"}],"sectionId":"/products/card-payouts/v3/openapi"}]}]}},{"label":"Retrieve payout details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/v3/openapi/other/getpayoutsdetails","routeSlug":"/products/card-payouts/v3/openapi/other/getpayoutsdetails","metadata":{"seo":{"title":"Retrieve payout details","description":"Retrieve the details of an existing basic disbursement or Fast Access payout."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayoutsDetails","name":"Retrieve payout details","isWebhook":false,"pointer":"/paths/~1payouts~1{resource}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payout details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of an existing basic disbursement or Fast Access payout.\n\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource","in":"path","schemaId":"schema_363","description":"original resource","required":true}],"pointer":"/paths/~1payouts~1{resource}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payouts/{resource}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"resource","in":"path","required":true,"schemaId":"schema_363"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payouts/{resource}","href":"other/getpayoutsdetails","openApiOperationId":"getPayoutsDetails","summary":"Retrieve payout details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout resource.","mediaType":"application/vnd.worldpay.payouts-v3+json","mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome requestReceived","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome queryRequired","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome requested","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome pending","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome approved","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome disbursed","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome queryRequired"]}},"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome requestReceived","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome queryRequired","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome requested","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome pending","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome approved","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome disbursed","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome queryRequired"]}],"pointer":"/paths/~1payouts~1{resource}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome requestReceived","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome queryRequired","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome requested","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome pending","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome approved","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome disbursed","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome queryRequired"],"mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome requestReceived","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome queryRequired","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome requested","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome pending","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome approved","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome disbursed","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome refused","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome error","paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome queryRequired"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getpayoutsdetails"}],"panels":[]}]},"httpPath":"/payouts/{resource}"},{"label":"Retrieve the payout details of a historic resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/v3/openapi/other/querypayouts","routeSlug":"/products/card-payouts/v3/openapi/other/querypayouts","metadata":{"seo":{"title":"Retrieve the payout details of a historic resource","description":"Query by transaction reference and entity to retrieve a Payout."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPayouts","name":"Retrieve the payout details of a historic resource","isWebhook":false,"pointer":"/paths/~1payouts~1query/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the payout details of a historic resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query by transaction reference and entity to retrieve a Payout.\n\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"transactionReference","in":"query","schemaId":"schema_364","description":"A unique reference generated by you, used to identify a payout throughout its lifecycle","required":true},{"name":"entity","in":"query","schemaId":"schema_365","description":"merchant entity","required":true}],"pointer":"/paths/~1payouts~1query/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payouts/query","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[{"name":"transactionReference","in":"query","required":true,"example":"12345","schemaId":"schema_364"},{"name":"entity","in":"query","required":true,"example":"default","schemaId":"schema_365"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payouts/query","href":"other/querypayouts","openApiOperationId":"queryPayouts","summary":"Retrieve the payout details of a historic resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a payout resource, provided one matches the transaction and entity references.","mediaType":"application/vnd.worldpay.payouts-v3+json","mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_query_200_response","exampleIds":["paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'error'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'requested'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'pending'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'approved'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'disbursed'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'error'"]}},"schemaId":"components/schemas/payouts_query_200_response","exampleIds":["paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'error'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'requested'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'pending'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'approved'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'disbursed'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'error'"]}],"pointer":"/paths/~1payouts~1query/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payouts_query_200_response","exampleIds":["paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'error'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'requested'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'pending'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'approved'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'disbursed'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'error'"],"mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_query_200_response","exampleIds":["paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'error'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'requested'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'pending'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'approved'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'disbursed'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'refused'","paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'error'"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/querypayouts"}],"panels":[]}]},"httpPath":"/payouts/query"},{"label":"Disburses funds to the payout instrument specified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/v3/openapi/other/basicdisbursement","routeSlug":"/products/card-payouts/v3/openapi/other/basicdisbursement","metadata":{"seo":{"title":"Disburses funds to the payout instrument specified","description":"Disburse funds to a payout instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"basicDisbursement","name":"Disburses funds to the payout instrument specified","isWebhook":false,"pointer":"/paths/~1payouts~1basicDisbursement/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disburses funds to the payout instrument specified","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Disburse funds to a payout instrument.\n\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeSchemas":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_basicDisbursement","exampleIds":["paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"]}},"schemaId":"components/schemas/payouts_basicDisbursement","exampleIds":["paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"],"pointer":"/paths/~1payouts~1basicDisbursement/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payouts/basicDisbursement","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_basicDisbursement","exampleIds":["paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"]}},"responseCodes":["201"],"pointer":"/payouts/basicDisbursement","href":"other/basicdisbursement","openApiOperationId":"basicDisbursement","summary":"Disburses funds to the payout instrument specified"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/payouts_basicDisbursement","exampleIds":["paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"],"mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeSchemas":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_basicDisbursement","exampleIds":["paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Funds have been disbursed or queued for disbursal successfully.","mediaType":"application/vnd.worldpay.payouts-v3+json","mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"]}},"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"]}],"pointer":"/paths/~1payouts~1basicDisbursement/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"],"mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken","paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/basicdisbursement"}],"panels":[]}]},"httpPath":"/payouts/basicDisbursement"},{"label":"Disburses funds to the payout instrument specified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/v3/openapi/other/fastaccess","routeSlug":"/products/card-payouts/v3/openapi/other/fastaccess","metadata":{"seo":{"title":"Disburses funds to the payout instrument specified","description":"Disburse funds to a payout instrument using fastAccess."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fastAccess","name":"Disburses funds to the payout instrument specified","isWebhook":false,"pointer":"/paths/~1payouts~1fastAccess/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disburses funds to the payout instrument specified","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Disburse funds to a payout instrument using fastAccess.\n\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeSchemas":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_fastAccess","exampleIds":["paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"]}},"schemaId":"components/schemas/payouts_fastAccess","exampleIds":["paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"],"pointer":"/paths/~1payouts~1fastAccess/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payouts/fastAccess","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_fastAccess","exampleIds":["paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"]}},"responseCodes":["201"],"pointer":"/payouts/fastAccess","href":"other/fastaccess","openApiOperationId":"fastAccess","summary":"Disburses funds to the payout instrument specified"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/payouts_fastAccess","exampleIds":["paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"],"mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeSchemas":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_fastAccess","exampleIds":["paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Funds have been disbursed or queued for disbursal successfully.","mediaType":"application/vnd.worldpay.payouts-v3+json","mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"]}},"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"]}],"pointer":"/paths/~1payouts~1fastAccess/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"],"mediaTypes":["application/vnd.worldpay.payouts-v3+json"],"mediaTypeContent":{"application/vnd.worldpay.payouts-v3+json":{"schemaId":"components/schemas/payouts_payouts_200_response","exampleIds":["paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken","paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/fastaccess"}],"panels":[]}]},"httpPath":"/payouts/fastAccess"}],"store":{"schemaStore":{"components/schemas/payouts_payouts_200_response":{"id":"components/schemas/payouts_payouts_200_response","kind":"json-schema","title":"payouts_payouts_200_response","data":{"required":["_links","outcome","receivedAt"],"type":"object","properties":{"outcome":{"type":"string","description":"outcome of payouts request"},"receivedAt":{"type":"string","description":"A timestamp of receivedAt"}}}},"components/schemas/payouts_query_200_response":{"id":"components/schemas/payouts_query_200_response","kind":"json-schema","title":"payouts_query_200_response","data":{"required":["_links","outcome","receivedAt"],"type":"object","properties":{"outcome":{"type":"string","description":"outcome of payouts query request"},"receivedAt":{"type":"string","description":"A timestamp of receivedAt"}}}},"components/schemas/card_plain":{"id":"components/schemas/card_plain","kind":"json-schema","title":"card_plain","data":{"required":["cardExpiryDate","cardNumber","type"],"type":"object","description":"Plain card details.","properties":{"cardExpiryDate":{"required":["month","year"],"type":"object","description":"An object that contains your customer's payout card expiry date. Must be a date in the future.","properties":{"month":{"type":"integer"},"year":{"type":"integer"}}},"cardNumber":{"type":"string","description":"An object that contains your customer's payout card number."},"type":{"type":"string"},"billingAddress":{"required":["countryCode","postalCode"],"type":"object","description":"An object containing the billing address information.","properties":{"countryCode":{"type":"string"},"postalCode":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"}}},"cardHolderName":{"type":"string","description":"An object that contains your customer's payout card name."}}}},"components/schemas/card_tokenized":{"id":"components/schemas/card_tokenized","kind":"json-schema","title":"card_tokenized","data":{"required":["href","type"],"type":"object","description":"Tokenized card details.","properties":{"href":{"type":"string","description":"An object that contains your link to an Access Token."},"type":{"type":"string"}}}},"components/schemas/card_networkToken":{"id":"components/schemas/card_networkToken","kind":"json-schema","title":"card_networkToken","data":{"required":["tokenNumber","expiryDate","type"],"type":"object","description":"Network Payment Token details.","properties":{"tokenNumber":{"type":"string","description":"An object that contains your network payment token number."},"expiryDate":{"required":["month","year"],"type":"object","description":"An object that contains your customer's token expiry date. Must be a date in the future.","properties":{"month":{"type":"integer"},"year":{"type":"integer"}}},"type":{"type":"string","description":"An object that contains your customer's payout type."}}}},"components/schemas/applepay_decrypted":{"id":"components/schemas/applepay_decrypted","kind":"json-schema","title":"applepay_decrypted","data":{"required":["cardExpiryDate","dpan","type"],"type":"object","description":"Wallet details.","properties":{"cardExpiryDate":{"required":["month","year"],"type":"object","description":"An object that contains your customer's payout card expiry date. Must be a date in the future.","properties":{"month":{"type":"integer"},"year":{"type":"integer"}}},"dpan":{"type":"string","description":"An object that contains the device primary account number."},"type":{"type":"string","description":"An object that contains your customer's payout type."},"billingAddress":{"required":["countryCode","postalCode"],"type":"object","description":"An object containing the billing address information.","properties":{"countryCode":{"type":"string"},"postalCode":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"}}},"cardHolderName":{"type":"string","description":"An object that contains your customer's payout card name."}}}},"components/schemas/payouts_basicDisbursement":{"id":"components/schemas/payouts_basicDisbursement","kind":"json-schema","title":"payouts_basicDisbursement","data":{"required":["instruction","merchant","transactionReference"],"type":"object","description":"Basic disbursement input.","properties":{"instruction":{"required":["narrative","payoutInstrument","value"],"type":"object","description":"An object that contains all the information related to your payout request.","properties":{"narrative":{"required":["line1"],"type":"object","description":"An object that contains identification and further details of the merchant.","properties":{"line1":{"type":"string","description":"First line of text that appears on your customer's statement."},"line2":{"type":"string","description":"Second line of text that appears on your customer's statement."}}},"payoutInstrument":{"description":"An object that contains your customer's payout type.","oneOf":[{"$ref":"#/components/schemas/card_plain"},{"$ref":"#/components/schemas/card_tokenized"},{"$ref":"#/components/schemas/card_networkToken"},{"$ref":"#/components/schemas/applepay_decrypted"}],"discriminator":{"mapping":{"card/plain":"#/components/schemas/card_plain","card/tokenized":"#/components/schemas/card_tokenized","card/networkToken":"#/components/schemas/card_networkToken","card/networkToken+applepay":"#/components/schemas/applepay_decrypted"},"propertyName":"type"}},"value":{"required":["amount","currency"],"type":"object","description":"An object that contains payout amount and currency.","properties":{"amount":{"type":"integer","description":"The payout amount."},"currency":{"type":"string","description":"The 3 digit currency code."}}}}},"merchant":{"required":["entity"],"type":"object","description":"An object that contains information about the merchant.","properties":{"entity":{"type":"string","description":"This is mandatory for authentication and queries. Contact your Worldpay Implementation Manager for more information."}}},"transactionReference":{"type":"string","description":"A unique reference generated by you, used to identify a payout throughout its lifecycle."}}}},"components/schemas/payouts_basicDisbursement_201_response":{"id":"components/schemas/payouts_basicDisbursement_201_response","kind":"json-schema","title":"payouts_basicDisbursement_201_response","data":{"required":["_links","outcome","receivedAt"],"type":"object","properties":{"outcome":{"type":"string","description":"outcome of payouts request"},"receivedAt":{"type":"string","description":"A timestamp of receivedAt"}}}},"components/schemas/payouts_fastAccess":{"id":"components/schemas/payouts_fastAccess","kind":"json-schema","title":"payouts_fastAccess","data":{"required":["instruction","merchant","transactionReference"],"type":"object","description":"Fast access input.","properties":{"instruction":{"required":["narrative","payoutInstrument","value"],"type":"object","description":"An object that contains all the information related to your payout request.","properties":{"narrative":{"required":["line1"],"type":"object","description":"An object that contains identification and further details of the merchant.","properties":{"line1":{"type":"string","description":"First line of text that appears on your customer's statement."},"line2":{"type":"string","description":"Second line of text that appears on your customer's statement."}}},"payoutInstrument":{"description":"An object that contains your customer's payout type.","oneOf":[{"$ref":"#/components/schemas/card_plain"},{"$ref":"#/components/schemas/card_tokenized"},{"$ref":"#/components/schemas/card_networkToken"},{"$ref":"#/components/schemas/applepay_decrypted"}],"discriminator":{"mapping":{"card/plain":"#/components/schemas/card_plain","card/tokenized":"#/components/schemas/card_tokenized","card/networkToken":"#/components/schemas/card_networkToken","card/networkToken+applepay":"#/components/schemas/applepay_decrypted"},"propertyName":"type"}},"value":{"required":["amount","currency"],"type":"object","description":"An object that contains payout amount and currency.","properties":{"amount":{"type":"integer","description":"The payout amount."},"currency":{"type":"string","description":"The 3 digit currency code."}}}}},"merchant":{"required":["entity"],"type":"object","description":"An object that contains information about the merchant.","properties":{"entity":{"type":"string","description":"This is mandatory for authentication and queries. Contact your Worldpay Implementation Manager for more information."}}},"transactionReference":{"type":"string","description":"A unique reference generated by you, used to identify a payout throughout its lifecycle."}}}},"components/schemas/payouts_fastAccess_201_response":{"id":"components/schemas/payouts_fastAccess_201_response","kind":"json-schema","title":"payouts_fastAccess_201_response","data":{"required":["_links","outcome","receivedAt"],"type":"object","properties":{"outcome":{"type":"string","description":"outcome of payouts request"},"receivedAt":{"type":"string","description":"A timestamp of receivedAt"}}}},"schema_363":{"kind":"json-schema","data":{"type":"string"},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"string","example":"12345"},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"string","example":"default"},"id":"schema_365"}},"exampleStore":{"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome requestReceived":{"value":{"outcome":"requestReceived","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Basic Disbursement: Successful resource retrieval with outcome requestReceived","summary":"Basic Disbursement: Successful resource retrieval with outcome requestReceived","description":"Basic Disbursement: Successful resource retrieval with outcome requestReceived","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome requestReceived"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome refused":{"value":{"outcome":"refused","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Basic Disbursement: Successful resource retrieval with outcome refused","summary":"Basic Disbursement: Successful resource retrieval with outcome refused","description":"Basic Disbursement: Successful resource retrieval with outcome refused","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome refused"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome error":{"value":{"outcome":"error","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Basic Disbursement: Successful resource retrieval with outcome error","summary":"Basic Disbursement: Successful resource retrieval with outcome error","description":"Basic Disbursement: Successful resource retrieval with outcome error","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome error"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome queryRequired":{"value":{"outcome":"queryRequired","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"payouts:update":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Basic Disbursement: Successful resource retrieval with outcome queryRequired","summary":"Basic Disbursement: Successful resource retrieval with outcome queryRequired","description":"Basic Disbursement: Successful resource retrieval with outcome queryRequired","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: Successful resource retrieval with outcome queryRequired"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome requested":{"value":{"outcome":"requested","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"payouts:update":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access Payout: Successful resource retrieval with outcome requested","summary":"Fast Access Payout: Successful resource retrieval with outcome requested","description":"Fast Access Payout: Successful resource retrieval with outcome requested","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome requested"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome pending":{"value":{"outcome":"pending","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"payouts:update":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access Payout: Successful resource retrieval with outcome pending","summary":"Fast Access Payout: Successful resource retrieval with outcome pending","description":"Fast Access Payout: Successful resource retrieval with outcome pending","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome pending"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome approved":{"value":{"outcome":"approved","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"payouts:update":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access Payout: Successful resource retrieval with outcome approved","summary":"Fast Access Payout: Successful resource retrieval with outcome approved","description":"Fast Access Payout: Successful resource retrieval with outcome approved","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome approved"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome disbursed":{"value":{"outcome":"disbursed","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access Payout: Successful resource retrieval with outcome disbursed","summary":"Fast Access Payout: Successful resource retrieval with outcome disbursed","description":"Fast Access Payout: Successful resource retrieval with outcome disbursed","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome disbursed"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome refused":{"value":{"outcome":"refused","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access Payout: Successful resource retrieval with outcome refused","summary":"Fast Access Payout: Successful resource retrieval with outcome refused","description":"Fast Access Payout: Successful resource retrieval with outcome refused","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome refused"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome error":{"value":{"outcome":"error","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access Payout: Successful resource retrieval with outcome error","summary":"Fast Access Payout: Successful resource retrieval with outcome error","description":"Fast Access Payout: Successful resource retrieval with outcome error","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome error"},"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome queryRequired":{"value":{"outcome":"queryRequired","receivedAt":"2023-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"payouts:update":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access Payout: Successful resource retrieval with outcome queryRequired","summary":"Fast Access Payout: Successful resource retrieval with outcome queryRequired","description":"Fast Access Payout: Successful resource retrieval with outcome queryRequired","id":"paths/~1payouts~1{resource}/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access Payout: Successful resource retrieval with outcome queryRequired"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'":{"value":{"outcome":"requestReceived","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'","summary":"Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'","description":"Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'refused'":{"value":{"outcome":"refused","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Basic Disbursement: An existing resource is retrieved with outcome 'refused'","summary":"Basic Disbursement: An existing resource is retrieved with outcome 'refused'","description":"Basic Disbursement: An existing resource is retrieved with outcome 'refused'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'refused'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'error'":{"value":{"outcome":"error","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Basic Disbursement: An existing resource is retrieved with outcome 'error'","summary":"Basic Disbursement: An existing resource is retrieved with outcome 'error'","description":"Basic Disbursement: An existing resource is retrieved with outcome 'error'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Basic Disbursement: An existing resource is retrieved with outcome 'error'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'requested'":{"value":{"outcome":"requested","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access: An existing resource is retrieved with outcome 'requested'","summary":"Fast Access: An existing resource is retrieved with outcome 'requested'","description":"Fast Access: An existing resource is retrieved with outcome 'requested'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'requested'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'pending'":{"value":{"outcome":"pending","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access: An existing resource is retrieved with outcome 'pending'","summary":"Fast Access: An existing resource is retrieved with outcome 'pending'","description":"Fast Access: An existing resource is retrieved with outcome 'pending'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'pending'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'approved'":{"value":{"outcome":"approved","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access: An existing resource is retrieved with outcome 'approved'","summary":"Fast Access: An existing resource is retrieved with outcome 'approved'","description":"Fast Access: An existing resource is retrieved with outcome 'approved'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'approved'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'disbursed'":{"value":{"outcome":"disbursed","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access: An existing resource is retrieved with outcome 'disbursed'","summary":"Fast Access: An existing resource is retrieved with outcome 'disbursed'","description":"Fast Access: An existing resource is retrieved with outcome 'disbursed'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'disbursed'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'refused'":{"value":{"outcome":"refused","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access: An existing resource is retrieved with outcome 'refused'","summary":"Fast Access: An existing resource is retrieved with outcome 'refused'","description":"Fast Access: An existing resource is retrieved with outcome 'refused'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'refused'"},"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'error'":{"value":{"outcome":"error","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Fast Access: An existing resource is retrieved with outcome 'error'","summary":"Fast Access: An existing resource is retrieved with outcome 'error'","description":"Fast Access: An existing resource is retrieved with outcome 'error'","id":"paths/~1payouts~1query/get/responses/200/content/application~1vnd.worldpay.payouts-v3+json/examples/Fast Access: An existing resource is retrieved with outcome 'error'"},"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/plain","cardHolderName":"Sherlock Holmes","cardExpiryDate":{"month":1,"year":2025},"cardNumber":"4444333322221111","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"postalCode","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful Basic Disbursement","summary":"Successful Basic Disbursement","description":"Successful Basic Disbursement","id":"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement"},"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/plain","cardHolderName":"Sherlock Holmes","cardExpiryDate":{"month":1,"year":2025},"cardNumber":"4444333322221111","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"postalCode","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Unsuccessful Payout request","summary":"Unsuccessful Payout request","description":"Unsuccessful Payout request","id":"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request"},"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/tokenized","href":"https://tokens/token"},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful Basic Disbursement to a token","summary":"Successful Basic Disbursement to a token","description":"Successful Basic Disbursement to a token","id":"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token"},"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/networkToken","cardHolderName":"Sherlock Holmes","expiryDate":{"month":12,"year":2029},"tokenNumber":"5555555555554444","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"AB1 2CD","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful Basic Disbursement to a networkToken","summary":"Successful Basic Disbursement to a networkToken","description":"Successful Basic Disbursement to a networkToken","id":"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken"},"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/networkToken+applepay","cardHolderName":"Sherlock Holmes","cardExpiryDate":{"month":1,"year":2025},"dpan":"4444333322221111","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"postalCode","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful Basic Disbursement to a decrypted applepay","summary":"Successful Basic Disbursement to a decrypted applepay","description":"Successful Basic Disbursement to a decrypted applepay","id":"paths/~1payouts~1basicDisbursement/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"},"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement":{"value":{"outcome":"requestReceived","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful Basic Disbursement","summary":"Successful Basic Disbursement","description":"Successful Basic Disbursement","id":"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement"},"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request":{"value":{"outcome":"refused","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Unsuccessful Payout request","summary":"Unsuccessful Payout request","description":"Unsuccessful Payout request","id":"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Unsuccessful Payout request"},"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token":{"value":{"outcome":"requestReceived","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful Basic Disbursement to a token","summary":"Successful Basic Disbursement to a token","description":"Successful Basic Disbursement to a token","id":"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a token"},"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken":{"value":{"outcome":"requestReceived","receivedAt":"2024-08-28T13:49:36.956145Z","_links":{"payouts:payout":{"href":"https://npe.access.worldpay.com/payouts/MjpkSzMxRnRQT0tqaUplUk1rSG5sWXFRPT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6b0d5RWhlMVNKVUJadWdzeEtBUW9xR1ozTWVZNGcwbUFPMDFpL1F4V1c5cGxOQ0hiVXNnWHZRb0pBZUhhUFg4QjY0dndoNHVpM1NGSjZTcWEvMDhQTVE9PQ=="},"curies":[{"name":"payouts","href":"https://npe.access.worldpay.com/rels/payouts/{rel}","templated":true}]},"curies":[{"name":"payouts","href":"https://npe.access.worldpay.com/rels/payouts/{rel}","templated":true}]},"key":"Successful Basic Disbursement to a networkToken","summary":"Successful Basic Disbursement to a networkToken","description":"Successful Basic Disbursement to a networkToken","id":"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a networkToken"},"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay":{"value":{"outcome":"requestReceived","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful Basic Disbursement to a decrypted applepay","summary":"Successful Basic Disbursement to a decrypted applepay","description":"Successful Basic Disbursement to a decrypted applepay","id":"paths/~1payouts~1basicDisbursement/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful Basic Disbursement to a decrypted applepay"},"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/plain","cardHolderName":"Sherlock Holmes","cardExpiryDate":{"month":1,"year":2025},"cardNumber":"4444333322221111","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"postalCode","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful issuing of a disbursal request","summary":"Successful issuing of a disbursal request","description":"Successful issuing of a disbursal request","id":"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request"},"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/plain","cardHolderName":"Sherlock Holmes","cardExpiryDate":{"month":1,"year":2025},"cardNumber":"4444333322221111","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"postalCode","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful disbursal of funds","summary":"Successful disbursal of funds","description":"Successful disbursal of funds","id":"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds"},"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/tokenized","href":"https://tokens/token"},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful disbursal of funds to a token","summary":"Successful disbursal of funds to a token","description":"Successful disbursal of funds to a token","id":"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token"},"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/networkToken","cardHolderName":"Sherlock Holmes","expiryDate":{"month":12,"year":2029},"tokenNumber":"5555555555554444","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"AB1 2CD","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful disbursal of funds to a networkToken","summary":"Successful disbursal of funds to a networkToken","description":"Successful disbursal of funds to a networkToken","id":"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken"},"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay":{"value":{"merchant":{"entity":"default"},"instruction":{"value":{"amount":300,"currency":"GBP"},"payoutInstrument":{"type":"card/networkToken+applepay","cardHolderName":"Sherlock Holmes","cardExpiryDate":{"month":1,"year":2025},"dpan":"4444333322221111","billingAddress":{"address1":"address1","address2":"address2","address3":"address3","postalCode":"postalCode","city":"city","state":"state","countryCode":"GB"}},"narrative":{"line1":"STATEMENT","line2":"OPTIONAL"}},"transactionReference":"transaction-ref"},"key":"Successful disbursal of funds to a decrypted applepay","summary":"Successful disbursal of funds to a decrypted applepay","description":"Successful disbursal of funds to a decrypted applepay","id":"paths/~1payouts~1fastAccess/post/requestBody/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"},"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request":{"value":{"outcome":"pending","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful issuing of a disbursal request","summary":"Successful issuing of a disbursal request","description":"Successful issuing of a disbursal request","id":"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful issuing of a disbursal request"},"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds":{"value":{"outcome":"approved","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful disbursal of funds","summary":"Successful disbursal of funds","description":"Successful disbursal of funds","id":"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds"},"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token":{"value":{"outcome":"approved","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful disbursal of funds to a token","summary":"Successful disbursal of funds to a token","description":"Successful disbursal of funds to a token","id":"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a token"},"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken":{"value":{"outcome":"approved","receivedAt":"2024-08-28T13:35:04.823402Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/Mjovc1NvemlnSFhVdUVIc0xjSitSWmhnPT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6YzNiamVrSDMxNThTcDJ5WnJteWRoRjlTSzhXV2RxdUNCaG1TcG9SS21SY1l5WVczZEVWNWlnZTBMWUdHTWtEWEtqTkJVRXBYMGxRYjNVYU1veGdvbGlhcnRPYy8zNnNFWGNDeGErWHhmZ289"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful disbursal of funds to a networkToken","summary":"Successful disbursal of funds to a networkToken","description":"Successful disbursal of funds to a networkToken","id":"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a networkToken"},"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay":{"value":{"outcome":"approved","receivedAt":"2018-09-01T10:37:36.923Z","_links":{"payouts:payout":{"href":"https://try.access.worldpay.com/payouts/{resource}"},"curies":[{"name":"payouts","href":"https://try.access.worldpay.com/rels/payouts/{rel}","templated":true}]}},"key":"Successful disbursal of funds to a decrypted applepay","summary":"Successful disbursal of funds to a decrypted applepay","description":"Successful disbursal of funds to a decrypted applepay","id":"paths/~1payouts~1fastAccess/post/responses/201/content/application~1vnd.worldpay.payouts-v3+json/examples/Successful disbursal of funds to a decrypted applepay"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/card-payouts/@v3/openapi.json?download"},{"url":"/access/_bundle/products/card-payouts/@v3/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Payouts","description":"\n__Authentication__\n\n  Set your headers\n  ```\n    Authorization: {your_credentials}\n    Content-Type: application/vnd.worldpay.payouts-v3+json\n    Accept: application/vnd.worldpay.payouts-v3+json\n  ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password.\n\n<br>\n\n__DNS whitelisting__\n\nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned."}},"baseSlug":"/products/card-payouts/v3/openapi","routesMapping":{}}