POST api/payments/requests/{paymentId}/update
Replaces the payment request's RequestData: the payment plugin's own data about the payment in progress, such as the terminal's status. The whole value is replaced. Responses: 200 with the updated request. 404 if the request no longer exists.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| paymentId |
The payment request's PaymentId. |
globally unique identifier |
Required |
Body Parameters
The new RequestData.
PaymentRequestUpdateDT| Name | Description | Type | Additional information |
|---|---|---|---|
| RequestData |
Replaces the request's RequestData: the payment plugin's own data, usually JSON. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"requestData": "sample string 1"
}
Response Information
Resource Description
The updated payment request.
PaymentRequestDT| Name | Description | Type | Additional information |
|---|---|---|---|
| FailureLog |
Why the payment failed, when it's cancelled. |
string |
None. |
| PaymentMask |
The masked card number. |
string |
None. |
| ContextUser |
The session's context user: the customer, when an operator is acting for one. |
UserDT |
None. |
| User |
The session's user. |
UserDT |
None. |
| PaymentType |
The payment type. |
PaymentTypeDT |
None. |
| PaymentId | globally unique identifier |
None. |
|
| PaymentReference | string |
None. |
|
| UserId | globally unique identifier |
None. |
|
| ContextUserId | globally unique identifier |
None. |
|
| SessionId | globally unique identifier |
None. |
|
| PaymentTypeId | string |
None. |
|
| PaymentTimeStamp | date |
None. |
|
| PaymentFeeAmount | decimal number |
None. |
|
| HardwareId | string |
None. |
|
| PaymentRecipientId | globally unique identifier |
None. |
|
| CardType | string |
None. |
|
| PaymentNetAmount | decimal number |
None. |
|
| BasketId | globally unique identifier |
None. |
|
| RequestData | string |
None. |
|
| LedgerCode | string |
None. |
|
| IsSaved | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"failureLog": "sample string 1",
"paymentMask": "sample string 2",
"contextUser": {
"userDescription": "sample string 9 sample string 10",
"salutationCalculated": "sample string 17",
"fullNameCalculated": "sample string 19",
"listAlerts": [
"sample string 1",
"sample string 2"
],
"userFullDescription": "sample string 9 sample string 10 sample string 14",
"roleSummary": "sample string 5",
"orderCount": 6,
"statusCount": 7,
"defaultAddress": {
"country": {
"countryId": "sample string 1",
"countryName": "sample string 2",
"addressTemplate": "sample string 3",
"sortOrder": "sample string 4",
"requiresPostcode": true,
"alpha3": "sample string 6",
"numeric": 1,
"isSaved": true
},
"addressSummaryShort": "sample string 8, sample string 9, sample string 10, sample string 12 sample string 14",
"addressSummaryFull": "sample string 3",
"addressId": "9dc86af2-6a0c-4450-9bec-1266838e5c8f",
"sao": "sample string 8",
"pao": "sample string 9",
"street": "sample string 10",
"locality": "sample string 11",
"town": "sample string 12",
"county": "sample string 13",
"postCode": "sample string 14",
"countryId": "sample string 15",
"isSaved": true
},
"defaultMobilePhone": {
"phoneNumberId": "7859fcb5-6ef0-45a2-9b68-b42f690e88f6",
"phoneNumber": "sample string 2",
"phoneNumberType": "sample string 3",
"phoneNumberDigitsOnly": "sample string 4",
"isSaved": true
},
"userId": "fef5fae2-ea0e-4176-a419-aa46de1c32ae",
"firstName": "sample string 9",
"lastName": "sample string 10",
"sortName": "sample string 11",
"emailAddress": "sample string 12",
"lastActivityDate": "2026-11-04T14:41:14.8271552+00:00",
"title": "sample string 14",
"isActive": true,
"createdDate": "2026-11-04T14:41:14.8271552+00:00",
"salutation": "sample string 17",
"suffix": "sample string 18",
"fullName": "sample string 19",
"companyName": "sample string 20",
"topicCollectionId": "d6d72317-8e1e-4c70-a009-50a405f29adb",
"dateOfBirth": "2026-11-04T14:41:14.8271552+00:00",
"pronouns": "sample string 21",
"isEmailAddressValidated": true,
"userAccountType": "sample string 22",
"isSaved": true
},
"user": {
"userDescription": "sample string 9 sample string 10",
"salutationCalculated": "sample string 17",
"fullNameCalculated": "sample string 19",
"listAlerts": [
"sample string 1",
"sample string 2"
],
"userFullDescription": "sample string 9 sample string 10 sample string 14",
"roleSummary": "sample string 5",
"orderCount": 6,
"statusCount": 7,
"defaultAddress": {
"country": {
"countryId": "sample string 1",
"countryName": "sample string 2",
"addressTemplate": "sample string 3",
"sortOrder": "sample string 4",
"requiresPostcode": true,
"alpha3": "sample string 6",
"numeric": 1,
"isSaved": true
},
"addressSummaryShort": "sample string 8, sample string 9, sample string 10, sample string 12 sample string 14",
"addressSummaryFull": "sample string 3",
"addressId": "9dc86af2-6a0c-4450-9bec-1266838e5c8f",
"sao": "sample string 8",
"pao": "sample string 9",
"street": "sample string 10",
"locality": "sample string 11",
"town": "sample string 12",
"county": "sample string 13",
"postCode": "sample string 14",
"countryId": "sample string 15",
"isSaved": true
},
"defaultMobilePhone": {
"phoneNumberId": "7859fcb5-6ef0-45a2-9b68-b42f690e88f6",
"phoneNumber": "sample string 2",
"phoneNumberType": "sample string 3",
"phoneNumberDigitsOnly": "sample string 4",
"isSaved": true
},
"userId": "fef5fae2-ea0e-4176-a419-aa46de1c32ae",
"firstName": "sample string 9",
"lastName": "sample string 10",
"sortName": "sample string 11",
"emailAddress": "sample string 12",
"lastActivityDate": "2026-11-04T14:41:14.8271552+00:00",
"title": "sample string 14",
"isActive": true,
"createdDate": "2026-11-04T14:41:14.8271552+00:00",
"salutation": "sample string 17",
"suffix": "sample string 18",
"fullName": "sample string 19",
"companyName": "sample string 20",
"topicCollectionId": "d6d72317-8e1e-4c70-a009-50a405f29adb",
"dateOfBirth": "2026-11-04T14:41:14.8271552+00:00",
"pronouns": "sample string 21",
"isEmailAddressValidated": true,
"userAccountType": "sample string 22",
"isSaved": true
},
"paymentType": {
"paymentFeeAmountPreview": 1.0,
"roleFilter": {
"roleIds": [
"0854463b-27f2-472c-9a66-16bd3cd4105d",
"a7acadcb-72a0-4897-8684-4ab9e06f4616"
],
"roleFilterId": "5a32a77c-2578-47a6-87da-5f28efa713d0",
"roleFilterRule": "sample string 2",
"isSaved": true
},
"displayAsIframe": true,
"paymentTypeId": "sample string 3",
"paymentTypeName": "sample string 4",
"imageURL": "sample string 5",
"requiresAddress": true,
"requiresPhone": true,
"requiresEmail": true,
"isEnabled": true,
"sortOrder": "sample string 10",
"requiresCustomerPresence": "sample string 11",
"paymentFeeSchemeId": "0c2fc7ea-0378-4ba8-870a-a41f1cadd2f1",
"paymentTypeDescription": "sample string 12",
"requiresAddressMessage": "sample string 13",
"requiresPhoneMessage": "sample string 14",
"requiresEmailMessage": "sample string 15",
"requiresName": true,
"requiresNameMessage": "sample string 17",
"roleFilterId": "127c1cc4-1860-493f-a2f0-c930bf6be19b",
"isAutomaticRenewal": true,
"paymentTypeCaption": "sample string 19",
"ledgerCodeSchemeId": "a1eef95e-dca2-462a-b51a-ea74f209423a",
"isSaved": true
},
"paymentId": "e388924e-f643-471a-a793-bb52cf4eccf4",
"paymentReference": "sample string 5",
"userId": "6bbca6e8-8a09-460e-8a2e-17eefe6d20fa",
"contextUserId": "339d99e8-f9b5-4ff6-8e40-25b710e9d8ab",
"sessionId": "05bca7a5-4e6b-4a1c-95e8-92b3d61b8a77",
"paymentTypeId": "sample string 9",
"paymentTimeStamp": "2026-11-04T14:41:14.8271552+00:00",
"paymentFeeAmount": 11.0,
"hardwareId": "sample string 12",
"paymentRecipientId": "8dc05c3b-03bb-4234-9b8b-abdafa902b35",
"cardType": "sample string 14",
"paymentNetAmount": 15.0,
"basketId": "f1614ff1-244e-496d-87dc-9c76df18e7b8",
"requestData": "sample string 17",
"ledgerCode": "sample string 18",
"isSaved": true
}