{"items":[{"type":"link","label":"Split Payments","link":"/products/split-payments/openapi","routeSlug":"/products/split-payments/openapi","content":{"contentType":"overview","meta":{"name":"Split Payments"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/split-payments/@20250625/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/split-payments/@20250625/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":"Split Payments (2025-06-25)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Divide funds from a single payment amongst yourself and your parties/sellers."},"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":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set your headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    Authorization: {your_credentials}\n    WP-Api-Version: 2025-06-25\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    Authorization: {your_credentials}\n    WP-Api-Version: 2025-06-25\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/split-payments/openapi"}],"sectionId":"/products/split-payments/openapi"}]}]}},{"label":"Create split payments request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/split-payments/openapi/other/splitpayments","routeSlug":"/products/split-payments/openapi/other/splitpayments","metadata":{"seo":{"title":"Create split payments request","description":"Create a request allowing you to split your payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"splitPayments","name":"Create split payments request","isWebhook":false,"pointer":"/paths/~1splitPayments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create split payments request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a request allowing you to split your payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_442","description":"The Content-Type.","required":true,"example":"application/json"},{"name":"WP-Api-Version","in":"header","schemaId":"schema_443","description":"The API version.","required":true,"example":"2025-06-25"}],"pointer":"/paths/~1splitPayments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplitRequest","exampleIds":["paths/~1splitPayments/post/requestBody/content/application~1json/examples/SplitPayment"]}},"schemaId":"components/schemas/SplitRequest","exampleIds":["paths/~1splitPayments/post/requestBody/content/application~1json/examples/SplitPayment"],"pointer":"/paths/~1splitPayments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/splitPayments","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_442"},{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-06-25","schemaId":"schema_443"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SplitRequest","exampleIds":["paths/~1splitPayments/post/requestBody/content/application~1json/examples/SplitPayment"]}},"responseCodes":["201","400","401","406","415","422","500"],"pointer":"/splitPayments","href":"other/splitpayments","openApiOperationId":"splitPayments","summary":"Create split payments request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/SplitRequest","exampleIds":["paths/~1splitPayments/post/requestBody/content/application~1json/examples/SplitPayment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplitRequest","exampleIds":["paths/~1splitPayments/post/requestBody/content/application~1json/examples/SplitPayment"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Merchant Pay-in accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplitResponse","exampleIds":["paths/~1splitPayments/post/responses/201/content/application~1json/examples/Purchase"]}},"schemaId":"components/schemas/SplitResponse","exampleIds":["paths/~1splitPayments/post/responses/201/content/application~1json/examples/Purchase"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"400","description":"Bad request format or data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWithSplitValidationErrors","exampleIds":["paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema"]}},"schemaId":"components/schemas/ErrorResponseWithSplitValidationErrors","exampleIds":["paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"401","description":"Un-authorized access, Insufficient permissions to fulfil request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments/post/responses/401/content/application~1json/examples/unauthorizedAccess"]}},"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments/post/responses/401/content/application~1json/examples/unauthorizedAccess"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"406","description":"A request header or API version value is invalid or unsupported.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"]}},"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"415","description":"Media type not supported","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"]}},"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"422","description":"Wrong party info, or no balanceAccount","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse422","exampleIds":["paths/~1splitPayments/post/responses/422/content/application~1json/examples/invalidPartyState"]}},"schemaId":"components/schemas/ErrorResponse422","exampleIds":["paths/~1splitPayments/post/responses/422/content/application~1json/examples/invalidPartyState"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"500","description":"internalErrorOccurred","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments/post/responses/500/content/application~1json/examples/Internal server error"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"}],"pointer":"/paths/~1splitPayments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SplitResponse","exampleIds":["paths/~1splitPayments/post/responses/201/content/application~1json/examples/Purchase"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplitResponse","exampleIds":["paths/~1splitPayments/post/responses/201/content/application~1json/examples/Purchase"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWithSplitValidationErrors","exampleIds":["paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWithSplitValidationErrors","exampleIds":["paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments/post/responses/401/content/application~1json/examples/unauthorizedAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments/post/responses/401/content/application~1json/examples/unauthorizedAccess"]}}},{"code":"406","schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse422","exampleIds":["paths/~1splitPayments/post/responses/422/content/application~1json/examples/invalidPartyState"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse422","exampleIds":["paths/~1splitPayments/post/responses/422/content/application~1json/examples/invalidPartyState"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments/post/responses/500/content/application~1json/examples/Internal server error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/splitpayments"}],"panels":[]}]},"httpPath":"/splitPayments"},{"label":"Fully settle/refund a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/split-payments/openapi/other/fullcapturefulfillments","routeSlug":"/products/split-payments/openapi/other/fullcapturefulfillments","metadata":{"seo":{"title":"Fully settle/refund a payment","description":"Confirm a settlement/refund of all line items within a split payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fullCaptureFulfillments","name":"Fully settle/refund a payment","isWebhook":false,"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fully settle/refund a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Confirm a settlement/refund of all line items within a split payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"splitPaymentId","in":"path","schemaId":"schema_445","description":"ID of the split payment.","required":true}],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_446","description":"The Content-Type.","required":true,"example":"application/json"},{"name":"WP-Api-Version","in":"header","schemaId":"schema_443","description":"The API version.","required":true,"example":"2025-06-25"}],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Settlement","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Refund"]}},"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Settlement","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Refund"],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/splitPayments/{splitPaymentId}/fulfillments","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"splitPaymentId","in":"path","required":true,"example":"spld1dcd2dee333cae1bfdea0","schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_446"},{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-06-25","schemaId":"schema_443"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Settlement","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Refund"]}},"responseCodes":["201","400","401","406","415","500"],"pointer":"/splitPayments/{splitPaymentId}/fulfillments","href":"other/fullcapturefulfillments","openApiOperationId":"fullCaptureFulfillments","summary":"Fully settle/refund a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Settlement","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Refund"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Settlement","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Refund"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Merchant Pay-in accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/201/content/application~1json/examples/Full Settlement"]}},"schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/201/content/application~1json/examples/Full Settlement"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"400","description":"Bad request format or data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"]}},"schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"401","description":"Un-authorized access, insufficient permissions to fulfil request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"]}},"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"406","description":"A request header or API version value is invalid or unsupported.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"]}},"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"415","description":"Media type not supported","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"]}},"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"500","description":"internalErrorOccurred","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"}],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/201/content/application~1json/examples/Full Settlement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/201/content/application~1json/examples/Full Settlement"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"]}}},{"code":"406","schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/fullcapturefulfillments"}],"panels":[]}]},"httpPath":"/splitPayments/{splitPaymentId}/fulfillments"},{"label":"Partially settle/refund a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/split-payments/openapi/other/singitemcapturefulfillments","routeSlug":"/products/split-payments/openapi/other/singitemcapturefulfillments","metadata":{"seo":{"title":"Partially settle/refund a payment","description":"Confirm a settlement/refund of individual line items within a payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"singItemCaptureFulfillments","name":"Partially settle/refund a payment","isWebhook":false,"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially settle/refund a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Confirm a settlement/refund of individual line items within a payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"splitPaymentId","in":"path","schemaId":"schema_445","description":"ID of the split payment.","required":true},{"name":"itemId","in":"path","schemaId":"schema_447","description":"ID of the line item listed in a split payment request.","required":true}],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_448","description":"The Content-Type.","required":true,"example":"application/json"},{"name":"WP-Api-Version","in":"header","schemaId":"schema_443","required":true,"example":"2025-06-25"}],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Settlement","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Refund"]}},"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Settlement","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Refund"],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"splitPaymentId","in":"path","required":true,"example":"spld1dcd2dee333cae1bfdea0","schemaId":"schema_445"},{"name":"itemId","in":"path","required":true,"schemaId":"components/schemas/ItemID"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_448"},{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-06-25","schemaId":"schema_443"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Settlement","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Refund"]}},"responseCodes":["201","400","401","406","415","500"],"pointer":"/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments","href":"other/singitemcapturefulfillments","openApiOperationId":"singItemCaptureFulfillments","summary":"Partially settle/refund a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Settlement","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Refund"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FulfillmentsRequest","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Settlement","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Refund"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Merchant Pay-in accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/201/content/application~1json/examples/Single Item Settlement"]}},"schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/201/content/application~1json/examples/Single Item Settlement"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"400","description":"Bad request format or data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"]}},"schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"401","description":"Un-authorized access, insufficient permissions to fulfil request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"]}},"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"406","description":"A request header or API version value is invalid or unsupported.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"]}},"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"415","description":"Media type not supported","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"]}},"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"},{"code":"500","description":"internalErrorOccurred","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"],"headers":{"WP-CorrelationId":{"example":"c85762a8-93af-47e7-beae-345d3dddbe94","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_444"}],"pointer":"/paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/201/content/application~1json/examples/Single Item Settlement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FulfillmentsResponse","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/201/content/application~1json/examples/Single Item Settlement"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWithValidationErrors","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"]}}},{"code":"406","schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader","paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse406","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse500","exampleIds":["paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/singitemcapturefulfillments"}],"panels":[]}]},"httpPath":"/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments"}],"store":{"schemaStore":{"components/schemas/SplitRequest":{"id":"components/schemas/SplitRequest","kind":"json-schema","title":"SplitRequest","data":{"required":["reference","fulfillment","merchant","value","lineItems"],"properties":{"reference":{"maxLength":64,"minLength":1,"type":"string","pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","description":"A reference generated by you to identify the split payments."},"description":{"maxLength":50,"pattern":"^[a-zA-Z0-9 ,./-]*$","type":"string","description":"Used to identify a split payment of an order to help with reconciliation purposes. When used, the values appear in the Payouts Portal."},"fulfillment":{"$ref":"#/components/schemas/AutoFulfillment"},"merchant":{"$ref":"#/components/schemas/Merchant"},"value":{"$ref":"#/components/schemas/Value"},"lineItems":{"$ref":"#/components/schemas/LineItems"}}}},"components/schemas/SplitResponse":{"id":"components/schemas/SplitResponse","kind":"json-schema","title":"SplitResponse","data":{"type":"object","required":["splitPaymentId","lineItems"],"properties":{"splitPaymentId":{"$ref":"#/components/schemas/SplitPaymentID"},"lineItems":{"$ref":"#/components/schemas/SplitResp"}}}},"components/schemas/FulfillmentsRequest":{"id":"components/schemas/FulfillmentsRequest","kind":"json-schema","title":"FulfillmentsRequest","data":{"required":["reference","paymentCommandId","transactionType"],"type":"object","properties":{"reference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"A reference generated by you to identify the split payments."},"description":{"type":"string","maxLength":50,"description":"Description of the fulfillment","example":"optional description of fulfillment"},"paymentCommandId":{"$ref":"#/components/schemas/PaymentCommandID"},"transactionType":{"$ref":"#/components/schemas/TransactionType"}}}},"components/schemas/FulfillmentsResponse":{"id":"components/schemas/FulfillmentsResponse","kind":"json-schema","title":"FulfillmentsResponse","data":{"type":"object","properties":{"fulfillment":{"type":"string","description":"Update status to fulfilled"}}}},"components/schemas/ItemFulfillmentsRequest":{"id":"components/schemas/ItemFulfillmentsRequest","kind":"json-schema","title":"ItemFulfillmentsRequest","data":{"required":["reference","paymentCommandId","transactionType"],"type":"object","properties":{"reference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"A reference generated by you to identify the split payments."},"description":{"type":"string","maxLength":50,"description":"Description of the fulfillment","example":"optional description of fulfillment"},"paymentCommandId":{"$ref":"#/components/schemas/PaymentCommandID"},"transactionType":{"$ref":"#/components/schemas/TransactionType"}}}},"components/schemas/ItemFulfillmentsResponse":{"id":"components/schemas/ItemFulfillmentsResponse","kind":"json-schema","title":"ItemFulfillmentsResponse","data":{"type":"object","properties":{"fulfillment":{"type":"string","description":"Update status to fulfilled"}}}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"required":["entity"],"type":"object","properties":{"entity":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding.","example":"default"}}}},"components/schemas/SplitResp":{"id":"components/schemas/SplitResp","kind":"json-schema","title":"SplitResp","data":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/LineItemsResp"}}}},"components/schemas/AutoFulfillment":{"id":"components/schemas/AutoFulfillment","kind":"json-schema","title":"AutoFulfillment","data":{"required":["auto","paymentCommandId"],"type":"object","properties":{"auto":{"type":"boolean","description":"Set to 'true' for auto fulfillment, otherwise to 'false'"},"paymentCommandId":{"$ref":"#/components/schemas/PaymentCommandID"}}}},"components/schemas/Value":{"id":"components/schemas/Value","kind":"json-schema","title":"Value","data":{"required":["currency","totalAmount"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"totalAmount":{"$ref":"#/components/schemas/TotalAmount"}}}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 letter ISO-4217 currency code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GBP","pattern":"^[A-Z]{3}$"}},"components/schemas/TotalAmount":{"id":"components/schemas/TotalAmount","kind":"json-schema","title":"TotalAmount","data":{"type":"integer","example":250,"minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be positive integer greater than 0. Implied decimal. For example, 250 GBP = £2.50."},"children":[]}]}]}]}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"type":"integer","example":250,"minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be positive integer greater than 0. Implied decimal. For example, 250 GBP = £2.50"},"children":[]}]}]}]}},"components/schemas/ItemID":{"id":"components/schemas/ItemID","kind":"json-schema","title":"ItemID","data":{"type":"string","description":"Unique reference generated by us to identify a line item.","minLength":25,"maxLength":25,"pattern":"^itm[A-Za-z0-9_-]{21}0$"}},"components/schemas/SplitPaymentID":{"id":"components/schemas/SplitPaymentID","kind":"json-schema","title":"SplitPaymentID","data":{"type":"string","description":"Unique reference generated by us to identify a split payment.","minLength":25,"maxLength":25,"pattern":"^spl[A-Za-z0-9_-]{21}0$"}},"components/schemas/PaymentCommandID":{"id":"components/schemas/PaymentCommandID","kind":"json-schema","title":"PaymentCommandID","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique ID generated by us for each lifecycle event on a payment. You have received this in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/card-payments/openapi/other/authorize#other/authorize/t=response&c=201&path=&d=0/commandid"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response of your payment authorization request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in our Card Payments API."},"children":[]}]}]}],"minLength":25,"maxLength":25,"pattern":"^cmd[A-Za-z0-9_-]{21}0$"}},"components/schemas/TransactionType":{"id":"components/schemas/TransactionType","kind":"json-schema","title":"TransactionType","data":{"type":"string","description":"Defines the type of payment lifecycle action.","enum":["settle","refund"],"example":"settle"}},"components/schemas/Deductions":{"id":"components/schemas/Deductions","kind":"json-schema","title":"Deductions","data":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of deduction.","enum":["commission","fee"],"example":"commission"},"value":{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","description":"Type of value.","enum":["percentage","flat"],"example":"percentage"},"amount":{"type":"number","exclusiveMinimum":0,"examples":[7.5,250]}},"oneOf":[{"title":"percentage","type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["percentage"]},"amount":{"type":"number","exclusiveMinimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deduction amount. Must be greater than 0."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When type is percentage, decimal values are permitted, and the value must not exceed 100. For example, 7.5 represents 7.5%."},"children":[]}]}]}]}}},{"title":"flat","type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["flat"]},"amount":{"type":"integer","exclusiveMinimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deduction amount. Must be greater than 0."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When type is flat, the value must be a whole number and represents a monetary amount with an implied decimal. For example, 250 GBP = £2.50."},"children":[]}]}]}]}}}]},"description":{"pattern":"^[a-zA-Z0-9 ,./-]*$","type":"string","maxLength":50,"description":"Used to identify a split payment of an order to help with reconciliation purposes. When used, the values appear in the Payouts Portal.","example":"Deduction description"}}}}},"components/schemas/LineItems":{"id":"components/schemas/LineItems","kind":"json-schema","title":"LineItems","data":{"type":"array","items":{"required":["itemReference","partyReference","amount"],"type":"object","properties":{"itemReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Unique reference generated by you to identify a line item."},"partyReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Unique reference generated by you to identify a party."},"amount":{"$ref":"#/components/schemas/Amount"},"description":{"maxLength":50,"pattern":"^[a-zA-Z0-9 ,./-]*$","type":"string","description":"Used to identify a split payment of an order to help with reconciliation purposes. When used, the values appear in the Payouts Portal."},"deductions":{"$ref":"#/components/schemas/Deductions"}}}}},"components/schemas/LineItemsResp":{"id":"components/schemas/LineItemsResp","kind":"json-schema","title":"LineItemsResp","data":{"type":"array","items":{"required":["itemId","itemReference"],"type":"object","properties":{"itemId":{"$ref":"#/components/schemas/ItemID"},"itemReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Unique reference generated by you to identify a line item."}}}}},"components/schemas/ErrorResponse401":{"id":"components/schemas/ErrorResponse401","kind":"json-schema","title":"ErrorResponse401","data":{"required":["errorName","message"],"type":"object","properties":{"errorName":{"type":"string","enum":["unauthorizedAccess"],"description":"Un-authorized access, Insufficient permissions to fulfil request."},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/ErrorResponse406":{"id":"components/schemas/ErrorResponse406","kind":"json-schema","title":"ErrorResponse406","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["headerHasInvalidValue"],"description":"A machine and human readable error type for clarity and semantic understanding of the error."},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/ErrorResponse415":{"id":"components/schemas/ErrorResponse415","kind":"json-schema","title":"ErrorResponse415","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["headerHasInvalidValue"],"description":"A machine and human readable error type for clarity and semantic understanding of the error."},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/ErrorResponse422":{"id":"components/schemas/ErrorResponse422","kind":"json-schema","title":"ErrorResponse422","data":{"type":"object","required":["errorName","message","stateErrors"],"properties":{"errorName":{"type":"string","enum":["invalidPartyState"],"description":"A machine and human readable error type for clarity and semantic understanding of the error."},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"stateErrors":{"type":"array","description":"Details of each invalid party state found in the request.","items":{"$ref":"#/components/schemas/StateError"}}}}},"components/schemas/StateError":{"id":"components/schemas/StateError","kind":"json-schema","title":"StateError","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","example":"referenceNotFound","description":"A machine-readable error code for the specific party state validation failure."},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"path":{"type":"string","description":"JSON path to the party reference or party ID that failed validation."},"url":{"type":"string","description":"URL containing additional context about the failure."}}}},"components/schemas/ErrorResponse500":{"id":"components/schemas/ErrorResponse500","kind":"json-schema","title":"ErrorResponse500","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["internalErrorOccurred"],"description":"An error occurred within the service."},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/ErrorResponseWithSplitValidationErrors":{"id":"components/schemas/ErrorResponseWithSplitValidationErrors","kind":"json-schema","title":"ErrorResponseWithSplitValidationErrors","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["bodyIsEmpty","bodyIsNotJson","bodyDoesNotMatchSchema"]},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"validationErrors":{"type":"array","description":"If there were field validation errors, they will be collected in this array.","items":{"$ref":"#/components/schemas/SplitValidationError"}}}}},"components/schemas/ErrorResponseWithValidationErrors":{"id":"components/schemas/ErrorResponseWithValidationErrors","kind":"json-schema","title":"ErrorResponseWithValidationErrors","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"type":"string","enum":["bodyIsEmpty","bodyIsNotJson","bodyDoesNotMatchSchema","urlContainsInvalidValue"]},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"validationErrors":{"type":"array","description":"If there were field validation errors, they will be collected in this array.","items":{"$ref":"#/components/schemas/ValidationError"}}}}},"components/schemas/SplitValidationError":{"id":"components/schemas/SplitValidationError","kind":"json-schema","title":"SplitValidationError","data":{"required":["errorName","message","jsonPath"],"type":"object","properties":{"errorName":{"type":"string","description":"A machine and human readable error type for clarity and semantic understanding of the error.","enum":["fieldIsNull","fieldIsEmpty","numberIsTooLarge","numberIsTooSmall","stringFailedRegexCheck"]},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"jsonPath":{"type":"string","description":"The field presents the JSONPath of the element within the request body associated with the error."}}}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"required":["errorName","message"],"type":"object","properties":{"errorName":{"type":"string","description":"A machine and human readable error type for clarity and semantic understanding of the error.","enum":["fieldIsNull","fieldIsEmpty","numberIsTooLarge","numberIsTooSmall","stringFailedRegexCheck"]},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable message giving a corrective action for the error.  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not for machine consumption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"jsonPath":{"type":"string","description":"The field presents the JSONPath of the element within the request body associated with the error."},"queryParameter":{"type":"string","description":"The query parameter associated with the validation error."},"pathParameter":{"type":"string","description":"The path parameter associated with the validation error."}}}},"schema_442":{"kind":"json-schema","data":{"type":"string","description":"The Content-Type.","example":"application/json"},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"string","description":"The API version.","example":"2025-06-25"},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"type":"object","properties":{"WP-CorrelationId":{"type":"string","format":"uuid","example":"c85762a8-93af-47e7-beae-345d3dddbe94"}}},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"string","minLength":25,"maxLength":25,"pattern":"^spl[A-Za-z0-9_-]{21}0$","example":"spld1dcd2dee333cae1bfdea0"},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"string","description":"The Content-Type","example":"application/json"},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ItemID"},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"string","example":"application/json"},"id":"schema_448"}},"exampleStore":{"components/examples/415":{"id":"components/examples/415","value":{"errorName":"headerHasInvalidValue","message":"A header 'Content-Type' in the request does not contain an expected value. Content-type must be application/json"}},"components/examples/500":{"id":"components/examples/500","value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service."}},"components/examples/split":{"id":"components/examples/split","value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284277","description":"optional split payment description","fulfillment":{"auto":false,"paymentCommandId":"cmdJxsTja3Daad6dig338w2R0"},"merchant":{"entity":"default"},"value":{"currency":"GBP","totalAmount":10000},"lineItems":[{"itemReference":"aaa1","partyReference":"The Baker Street Café","amount":9000,"description":"Item description","deductions":[{"type":"commission","value":{"type":"percentage","amount":1},"description":"Deduction description"}]},{"itemReference":"bbb1","partyReference":"John Watson","amount":1000,"description":"Item description","deductions":[{"type":"fee","value":{"type":"flat","amount":200},"description":"Deduction description"}]}]},"description":"Example request for creating a split payment"},"components/examples/split-201":{"id":"components/examples/split-201","value":{"splitPaymentId":"spl9wdyDYROy6-boa2mSFfn20","lineItems":[{"itemId":"itmZRsCU4vjopY6q9HH9znXQ0","itemReference":"aaa1"},{"itemId":"itmO9IHhLjjamTh9oHcR1wH-0","itemReference":"bbb1"}]}},"components/examples/400-bodyIsEmpty":{"id":"components/examples/400-bodyIsEmpty","value":{"errorName":"bodyIsEmpty","message":"The body within the request is empty. A body is required to be non-empty."}},"components/examples/400-bodyIsNotJson":{"id":"components/examples/400-bodyIsNotJson","value":{"errorName":"bodyIsNotJson","message":"The body within the request is not a valid JSON. This body is required to be a valid JSON."}},"components/examples/400-bodyDoesNotMatchSchema":{"id":"components/examples/400-bodyDoesNotMatchSchema","value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.reference"},{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.paymentCommandId"}]}},"components/examples/401-unauthorizedAccess":{"id":"components/examples/401-unauthorizedAccess","value":{"errorName":"unauthorizedAccess","message":"The provided secret does not contain valid authentication."}},"components/examples/406_accept":{"id":"components/examples/406_accept","value":{"errorName":"headerHasInvalidValue","message":"A header 'Accept' in the request does not contain an expected pattern. It must be application/json, or not set."}},"components/examples/406_api_version":{"id":"components/examples/406_api_version","value":{"errorName":"headerHasInvalidValue","message":"A header 'WP-Api-Version' or URL path in the request is misconfigured."}},"components/examples/422-invalidPartyState":{"id":"components/examples/422-invalidPartyState","value":{"errorName":"invalidPartyState","message":"One or more parties are in an invalid state.","stateErrors":[{"errorName":"referenceNotFound","message":"Reference badBeneficiary was not found","path":"$.parties.refs[1]","url":"https://url.com"},{"errorName":"partyIdNotFound","message":"PartyId par_V1StGXR8_Z5jdHi6B-myF was not found","path":"$.parties.ids[3]","url":"https://url.com"}]}},"components/examples/FulfillmentsRequest":{"id":"components/examples/FulfillmentsRequest","value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284276","description":"optional description of fulfillment","paymentCommandId":"cmdJxsTja3Daad6dig338w2R0","transactionType":"settle"}},"components/examples/RefundRequest":{"id":"components/examples/RefundRequest","value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284276","description":"optional description of fulfillment","paymentCommandId":"cmdJxsTja3Daad6dig338w2R0","transactionType":"refund"}},"components/examples/fulfillments-201":{"id":"components/examples/fulfillments-201","value":{"fulfillment":"accepted"}},"components/examples/400-urlContainsInvalidValue_splitId":{"id":"components/examples/400-urlContainsInvalidValue_splitId","value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"invalidUrlPathParameter","message":"The URL field 'splitPaymentId' has an invalid value: 'spld1dcd2dee333cae1bfdea0'.","pathParameter":"splitPaymentId"}]}},"components/examples/FulfillmentRequestSingle":{"id":"components/examples/FulfillmentRequestSingle","value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284276","description":"optional description of fulfillment","paymentCommandId":"cmdJxsTja3Daad6dig338w2R0","transactionType":"settle"}},"components/examples/400-urlContainsInvalidValue_splitId_and_itemId":{"id":"components/examples/400-urlContainsInvalidValue_splitId_and_itemId","value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"invalidUrlPathParameter","message":"The URL field 'splitPaymentId' has an invalid value: 'spld1dcd2dee333cae1bfdea0'.","pathParameter":"splitPaymentId"},{"errorName":"invalidUrlPathParameter","message":"The URL field 'itemId' has an invalid value: 'itmZRsCU4vjopY6q9HH9znXQ0'.","pathParameter":"itemId"}]}},"paths/~1splitPayments/post/requestBody/content/application~1json/examples/SplitPayment":{"value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284277","description":"optional split payment description","fulfillment":{"auto":false,"paymentCommandId":"cmdJxsTja3Daad6dig338w2R0"},"merchant":{"entity":"default"},"value":{"currency":"GBP","totalAmount":10000},"lineItems":[{"itemReference":"aaa1","partyReference":"The Baker Street Café","amount":9000,"description":"Item description","deductions":[{"type":"commission","value":{"type":"percentage","amount":1},"description":"Deduction description"}]},{"itemReference":"bbb1","partyReference":"John Watson","amount":1000,"description":"Item description","deductions":[{"type":"fee","value":{"type":"flat","amount":200},"description":"Deduction description"}]}]},"key":"SplitPayment","summary":"SplitPayment","description":"Example request for creating a split payment","id":"paths/~1splitPayments/post/requestBody/content/application~1json/examples/SplitPayment"},"paths/~1splitPayments/post/responses/201/content/application~1json/examples/Purchase":{"value":{"splitPaymentId":"spl9wdyDYROy6-boa2mSFfn20","lineItems":[{"itemId":"itmZRsCU4vjopY6q9HH9znXQ0","itemReference":"aaa1"},{"itemId":"itmO9IHhLjjamTh9oHcR1wH-0","itemReference":"bbb1"}]},"key":"Purchase","summary":"Purchase","id":"paths/~1splitPayments/post/responses/201/content/application~1json/examples/Purchase"},"paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsEmpty":{"value":{"errorName":"bodyIsEmpty","message":"The body within the request is empty. A body is required to be non-empty."},"key":"bodyIsEmpty","summary":"bodyIsEmpty","id":"paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsEmpty"},"paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsNotJson":{"value":{"errorName":"bodyIsNotJson","message":"The body within the request is not a valid JSON. This body is required to be a valid JSON."},"key":"bodyIsNotJson","summary":"bodyIsNotJson","id":"paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyIsNotJson"},"paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.reference"},{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.paymentCommandId"}]},"key":"bodyDoesNotMatchSchema","summary":"bodyDoesNotMatchSchema","id":"paths/~1splitPayments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema"},"paths/~1splitPayments/post/responses/401/content/application~1json/examples/unauthorizedAccess":{"value":{"errorName":"unauthorizedAccess","message":"The provided secret does not contain valid authentication."},"key":"unauthorizedAccess","summary":"unauthorizedAccess","id":"paths/~1splitPayments/post/responses/401/content/application~1json/examples/unauthorizedAccess"},"paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidAcceptHeader":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'Accept' in the request does not contain an expected pattern. It must be application/json, or not set."},"key":"invalidAcceptHeader","summary":"invalidAcceptHeader","id":"paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidAcceptHeader"},"paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'WP-Api-Version' or URL path in the request is misconfigured."},"key":"invalidApiVersionHeader","summary":"invalidApiVersionHeader","id":"paths/~1splitPayments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"},"paths/~1splitPayments/post/responses/415/content/application~1json/examples/headerHasInvalidValue":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'Content-Type' in the request does not contain an expected value. Content-type must be application/json"},"key":"headerHasInvalidValue","summary":"headerHasInvalidValue","id":"paths/~1splitPayments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"},"paths/~1splitPayments/post/responses/422/content/application~1json/examples/invalidPartyState":{"value":{"errorName":"invalidPartyState","message":"One or more parties are in an invalid state.","stateErrors":[{"errorName":"referenceNotFound","message":"Reference badBeneficiary was not found","path":"$.parties.refs[1]","url":"https://url.com"},{"errorName":"partyIdNotFound","message":"PartyId par_V1StGXR8_Z5jdHi6B-myF was not found","path":"$.parties.ids[3]","url":"https://url.com"}]},"key":"invalidPartyState","summary":"invalidPartyState","id":"paths/~1splitPayments/post/responses/422/content/application~1json/examples/invalidPartyState"},"paths/~1splitPayments/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service."},"key":"Internal server error","summary":"Internal server error","id":"paths/~1splitPayments/post/responses/500/content/application~1json/examples/Internal server error"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Settlement":{"value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284276","description":"optional description of fulfillment","paymentCommandId":"cmdJxsTja3Daad6dig338w2R0","transactionType":"settle"},"key":"Full Settlement","summary":"Full Settlement","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Settlement"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Refund":{"value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284276","description":"optional description of fulfillment","paymentCommandId":"cmdJxsTja3Daad6dig338w2R0","transactionType":"refund"},"key":"Full Refund","summary":"Full Refund","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/requestBody/content/application~1json/examples/Full Refund"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/201/content/application~1json/examples/Full Settlement":{"value":{"fulfillment":"accepted"},"key":"Full Settlement","summary":"Full Settlement","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/201/content/application~1json/examples/Full Settlement"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty":{"value":{"errorName":"bodyIsEmpty","message":"The body within the request is empty. A body is required to be non-empty."},"key":"bodyIsEmpty","summary":"bodyIsEmpty","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson":{"value":{"errorName":"bodyIsNotJson","message":"The body within the request is not a valid JSON. This body is required to be a valid JSON."},"key":"bodyIsNotJson","summary":"bodyIsNotJson","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.reference"},{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.paymentCommandId"}]},"key":"bodyDoesNotMatchSchema","summary":"bodyDoesNotMatchSchema","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"invalidUrlPathParameter","message":"The URL field 'splitPaymentId' has an invalid value: 'spld1dcd2dee333cae1bfdea0'.","pathParameter":"splitPaymentId"}]},"key":"urlContainsInvalidValue","summary":"urlContainsInvalidValue","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess":{"value":{"errorName":"unauthorizedAccess","message":"The provided secret does not contain valid authentication."},"key":"unauthorizedAccess","summary":"unauthorizedAccess","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'Accept' in the request does not contain an expected pattern. It must be application/json, or not set."},"key":"invalidAcceptHeader","summary":"invalidAcceptHeader","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'WP-Api-Version' or URL path in the request is misconfigured."},"key":"invalidApiVersionHeader","summary":"invalidApiVersionHeader","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'Content-Type' in the request does not contain an expected value. Content-type must be application/json"},"key":"headerHasInvalidValue","summary":"headerHasInvalidValue","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"},"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service."},"key":"Internal server error","summary":"Internal server error","id":"paths/~1splitPayments~1{splitPaymentId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Settlement":{"value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284276","description":"optional description of fulfillment","paymentCommandId":"cmdJxsTja3Daad6dig338w2R0","transactionType":"settle"},"key":"Single Item Settlement","summary":"Single Item Settlement","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Settlement"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Refund":{"value":{"reference":"5D262CB9-57F2-4176-AA7C-B76A79284276","description":"optional description of fulfillment","paymentCommandId":"cmdJxsTja3Daad6dig338w2R0","transactionType":"refund"},"key":"Single Item Refund","summary":"Single Item Refund","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/requestBody/content/application~1json/examples/Single Item Refund"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/201/content/application~1json/examples/Single Item Settlement":{"value":{"fulfillment":"accepted"},"key":"Single Item Settlement","summary":"Single Item Settlement","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/201/content/application~1json/examples/Single Item Settlement"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty":{"value":{"errorName":"bodyIsEmpty","message":"The body within the request is empty. A body is required to be non-empty."},"key":"bodyIsEmpty","summary":"bodyIsEmpty","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsEmpty"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson":{"value":{"errorName":"bodyIsNotJson","message":"The body within the request is not a valid JSON. This body is required to be a valid JSON."},"key":"bodyIsNotJson","summary":"bodyIsNotJson","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyIsNotJson"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.reference"},{"errorName":"fieldIsEmpty","message":"must not be blank","jsonPath":"$.paymentCommandId"}]},"key":"bodyDoesNotMatchSchema","summary":"bodyDoesNotMatchSchema","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/bodyDoesNotMatchSchema"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"invalidUrlPathParameter","message":"The URL field 'splitPaymentId' has an invalid value: 'spld1dcd2dee333cae1bfdea0'.","pathParameter":"splitPaymentId"},{"errorName":"invalidUrlPathParameter","message":"The URL field 'itemId' has an invalid value: 'itmZRsCU4vjopY6q9HH9znXQ0'.","pathParameter":"itemId"}]},"key":"urlContainsInvalidValue","summary":"urlContainsInvalidValue","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/400/content/application~1json/examples/urlContainsInvalidValue"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess":{"value":{"errorName":"unauthorizedAccess","message":"The provided secret does not contain valid authentication."},"key":"unauthorizedAccess","summary":"unauthorizedAccess","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/401/content/application~1json/examples/unauthorizedAccess"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'Accept' in the request does not contain an expected pattern. It must be application/json, or not set."},"key":"invalidAcceptHeader","summary":"invalidAcceptHeader","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidAcceptHeader"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'WP-Api-Version' or URL path in the request is misconfigured."},"key":"invalidApiVersionHeader","summary":"invalidApiVersionHeader","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/406/content/application~1json/examples/invalidApiVersionHeader"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue":{"value":{"errorName":"headerHasInvalidValue","message":"A header 'Content-Type' in the request does not contain an expected value. Content-type must be application/json"},"key":"headerHasInvalidValue","summary":"headerHasInvalidValue","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/415/content/application~1json/examples/headerHasInvalidValue"},"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service."},"key":"Internal server error","summary":"Internal server error","id":"paths/~1splitPayments~1{splitPaymentId}~1items~1{itemId}~1fulfillments/post/responses/500/content/application~1json/examples/Internal server error"}},"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/split-payments/@20250625/openapi.json?download"},{"url":"/access/_bundle/products/split-payments/@20250625/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Split Payments","description":"Divide funds from a single payment amongst yourself and your parties/sellers.\n\n\n __Authentication__\n    Set your headers\n```\n    Authorization: {your_credentials}\n    WP-Api-Version: 2025-06-25\n```\n    Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.\n    <br><br>\n    __DNS whitelisting__\n\n    Whitelist the following URLs:\n    * `https://try.access.worldpay.com/`\n    * `https://access.worldpay.com/`\n\n    Please ensure you use DNS whitelisting, not explicit IP whitelisting.\n    When you make a request within Access Worldpay, you should always cache the response returned.\n ","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Card Payments"],"generated":true}},"baseSlug":"/products/split-payments/openapi","routesMapping":{}}