Fully settle/refund a payment

Request

Confirm a settlement/refund of all line items within a split payment.

Security

BasicAuth

Path

splitPaymentIdstring, = 25 characters^spl[A-Za-z0-9_-]{21}0$required

ID of the split payment.

Example:spld1dcd2dee333cae1bfdea0

Content-Typestringrequired

The Content-Type.

Example:application/json

WP-Api-Versionstringrequired

The API version.

Example:2025-06-25

Bodyapplication/json

referencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]+$required

A reference generated by you to identify the split payments.

descriptionstring, <= 50 characters

Description of the fulfillment

Example:"optional description of fulfillment"

paymentCommandIdstring, = 25 characters^cmd[A-Za-z0-9_-]{21}0$required

A unique ID generated by us for each lifecycle event on a payment. You have received this in the response of your payment authorization request in our Card Payments API.

transactionTypestringrequired

Defines the type of payment lifecycle action.

Enum:"settle""refund"

Example:"settle"

{
  "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276",
  "description": "optional description of fulfillment",
  "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0",
  "transactionType": "settle"
}

Responses

Merchant Pay-in accepted

Headers

WP-CorrelationIdstring, (uuid)

Example:"c85762a8-93af-47e7-beae-345d3dddbe94"

Bodyapplication/json

fulfillmentstring

Update status to fulfilled

Response

{
  "fulfillment": "accepted"
}