New service | **Last updated**: 01 July 2025 # Manage your payment ## Settle the payment Partially or fully settle your payment through our Card Payments API using the next action link received in your original authorization response. Fully settle ## Settle an authorization To settle all the funds from a customer, send us a settle request. You can only do this if you set `"requestAutoSettlement"` to `false` in your payment initial request. `POST` to the `cardPayments:settle` action link, returned in the [authorization response](/products/card-payments/authorize-a-payment#response), to settle an authorization. ### Settle request `POST` `https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9` Note No request body is needed for this request. When you make your settle request, the payment event changes to `sentForSettlement`. ### Settle response In the response you get a 202 HTTP code which confirms we have received your request. The request has not processed at this stage. { "paymentId": "pay7TLP6nGrpumEKxy7NiuOx0", "commandId": "cmdp9D1t-ENYQxVnJkh0YPRC0", "_links": { "cardPayments:refund": { "href": "/payments/settlements/refunds/full/:linkData" }, "cardPayments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "cardPayments:reverse": { "href": "/payments/authorizations/reversals/:linkData" }, "cardPayments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } } Partial settle ## Partially settle an authorization To settle a portion of the funds of a payment, send us a request to partially settle an authorization. You can only do this if you set `"requestAutoSettlement"` to `false` in your initial request. br `POST` to the `cardPayments:partialSettle` action link, returned in your [authorization response](/products/card-payments/authorize-a-payment#response), to partially settle an authorization. Specify the amount and the required settlement currency in the body. Note We do not validate that the currency and amount is the same as the original payment. ### Partial settle request `POST` `https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9` #### Example request ``` { "sequence": { "number": 1, "total": 2 }, "value": { "amount": 10, "currency": "GBP" }, "reference": "partial-settle-reference" } ``` ### Partial settle response In the response you get a 202 HTTP code which confirms we have received your request. The request has not processed at this stage. { "paymentId": "payymIRjUAvh-rWc-7phWocp0", "commandId": "cmdpsIok1vBZ_CDqWplJPl2_0", "_links": { "cardPayments:refund": { "href": "/payments/settlements/refunds/full/:linkData" }, "cardPayments:partialRefund": { "href": "/payments/settlements/refunds/partials/:linkData" }, "cardPayments:partialSettle": { "href": "/payments/settlements/partials/:linkData" }, "cardPayments:reverse": { "href": "/payments/authorizations/reversals/:linkData" }, "cardPayments:cancel": { "href": "/payments/authorizations/cancellations/:linkData" }, "cardPayments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } } ## Confirm your settlement To complete your settlement you **must** confirm it through our Split Payments endpoint. This allows you to independently settle `lineItems`. ### Request Fulfill all or some of the order items of the purchase. Fulfill whole purchase **Typical use case:** The original purchase amount is £30 made up of: * item 1: £10 Socks from retailer 1 * item 2: £20 Sandals from retailer 2 All items are ready to be shipped. You fulfill the whole purchase. * To initiate **full settlement** of the purchase, send us a settle request for the whole basket. `POST` `https://try.access.worldpay-bsh.securedataplatform.com/splitPayments/{splitPaymentId}/fulfillments` #### Example request: ``` { "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "description": "optional description of fulfillment", "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0", "transactionType": "settle" } ``` Fulfill partial purchase **Typical use case:** The original purchase amount is £100, made up of: * item 1: £50 books from retailer 1 and * item 2: £50 jacket from retailer 2 Only item 1 is ready to be shipped today. You partially fulfill the order and might fulfill item 2 later on. * To initiate a **partial settlement** from the purchase, send us a settle request for a single item: `POST` `https://try.access.worldpay-bsh.securedataplatform.com/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments` #### Example request ``` { "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "description": "optional description of fulfillment", "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0", "transactionType": "settle" } ``` ### Response #### Example • 201 Merchant Pay-in accepted ``` { "fulfillments": "Accepted" } ``` ## Refund a payment ## Refund the payment Partially or fully refund your payment through our Card Payments API using the next action link received in your authorization response. Fully refund ## Refund an authorization To refund all the funds to a customer, send us a refund request. `POST` to the `cardPayments:refund` action link, returned in the [authorization response](/products/card-payments/authorize-a-payment#response), to refund an authorization. ### Refund request `POST` `https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/full/eyJrIjoiazNhYjYzMiJ9` Note No request body is needed for this request. The payment event changes to `sentForRefund`. ### Refund response In the response you get a `202` HTTP code which confirms we have received your request. The request has not processed at this stage. { "paymentId": "payqRdrJboocTc1dCVdAu4Vd0", "commandId": "cmddn9j_SEC7N4_ynTDRBWc-0", "_links": { "cardPayments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } } Partial refund ## Partially refund an authorization To refund a portion of the funds of a payment, send us a request to partially refund an authorization. br `POST` to the `cardPayments:partialRefund` action link, returned in your [authorization response](/products/card-payments/authorize-a-payment#response), to partially refund an authorization. Specify the amount and the required settlement currency in the body. Note We do not validate that the currency and amount is the same as the original payment. ### Partial refund request `POST` `https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/partials/eyJrIjoiazNhYjYzMiJ9` #### Example request ``` { "value": { "amount": 10, "currency": "GBP" }, "reference": "partial-refund-reference" } ``` ### Partial refund response In the response you get a 202 HTTP code which confirms we have received your request. The request has not processed at this stage. { "paymentId": "payleHRjF9Ca-mxSJNcJ6V3K0", "commandId": "cmdzEVdGDvH72FI1i2ypIf3B0", "_links": { "cardPayments:events": { "href": "/payments/events/:linkData" }, "curies": [ { "name": "payments", "href": "/rels/payments/{rel}", "templated": true } ] } } ## Confirm your refund You must confirm the refund through our Split Payments API. Full refund confirmation To confirm a **full refund** from a purchase, send us a request for the whole basket. `POST` `https://try.access.worldpay-bsh.securedataplatform.com/splitPayments/{splitPaymentId}/fulfillments` ### Example request ``` { "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "description": "optional description of fulfillment", "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0", "transactionType": "refund" } ``` ### Example response • 201 Merchant Pay-in accepted ``` { "fulfillments": "Accepted" } ``` Partial refund confirmation To confirm a **partial refund** from a purchase, you must send a request for a single item. `POST` `https://try.access.worldpay-bsh.securedataplatform.com/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments` ### Example request ``` { "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "description": "optional description of fulfillment", "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0", "transactionType": "refund" } ``` ### Example response • 201 Merchant Pay-in accepted ``` { "fulfillments": "Accepted" } ```