GET api/payments/requests/{paymentId}

Gets a payment request: the amount to take, the payment type and the customer. Responses: 200 with the request, or 200 with null if it no longer exists (it has been confirmed, cancelled or removed). A 404 means the URL is wrong.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
paymentId

The PaymentId from the CNP message.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The payment request, or null.

PaymentRequestDT
NameDescriptionTypeAdditional 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": "6c99a54a-8afd-4d24-a6a3-7b0699abd0a8",
      "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": "06d615be-4204-4565-aed2-326c485125b5",
      "phoneNumber": "sample string 2",
      "phoneNumberType": "sample string 3",
      "phoneNumberDigitsOnly": "sample string 4",
      "isSaved": true
    },
    "userId": "efbfd0e7-a393-4c63-9d2c-6606f3a8b45c",
    "firstName": "sample string 9",
    "lastName": "sample string 10",
    "sortName": "sample string 11",
    "emailAddress": "sample string 12",
    "lastActivityDate": "2026-11-04T06:22:48.5853195+00:00",
    "title": "sample string 14",
    "isActive": true,
    "createdDate": "2026-11-04T06:22:48.5853195+00:00",
    "salutation": "sample string 17",
    "suffix": "sample string 18",
    "fullName": "sample string 19",
    "companyName": "sample string 20",
    "topicCollectionId": "aea1a21c-2e83-44c9-98fd-7c974570bc99",
    "dateOfBirth": "2026-11-04T06:22:48.5853195+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": "6c99a54a-8afd-4d24-a6a3-7b0699abd0a8",
      "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": "06d615be-4204-4565-aed2-326c485125b5",
      "phoneNumber": "sample string 2",
      "phoneNumberType": "sample string 3",
      "phoneNumberDigitsOnly": "sample string 4",
      "isSaved": true
    },
    "userId": "efbfd0e7-a393-4c63-9d2c-6606f3a8b45c",
    "firstName": "sample string 9",
    "lastName": "sample string 10",
    "sortName": "sample string 11",
    "emailAddress": "sample string 12",
    "lastActivityDate": "2026-11-04T06:22:48.5853195+00:00",
    "title": "sample string 14",
    "isActive": true,
    "createdDate": "2026-11-04T06:22:48.5853195+00:00",
    "salutation": "sample string 17",
    "suffix": "sample string 18",
    "fullName": "sample string 19",
    "companyName": "sample string 20",
    "topicCollectionId": "aea1a21c-2e83-44c9-98fd-7c974570bc99",
    "dateOfBirth": "2026-11-04T06:22:48.5853195+00:00",
    "pronouns": "sample string 21",
    "isEmailAddressValidated": true,
    "userAccountType": "sample string 22",
    "isSaved": true
  },
  "paymentType": {
    "paymentFeeAmountPreview": 1.0,
    "roleFilter": {
      "roleIds": [
        "a6da6a7a-69d1-4aaa-8b0e-51242e24e48c",
        "58ebcc5d-4216-4b8e-a398-4d08b5e5593a"
      ],
      "roleFilterId": "e25575b1-145d-4673-9c32-de192fd2f015",
      "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": "57439a65-4946-47d1-9cde-7ac134e5fd7d",
    "paymentTypeDescription": "sample string 12",
    "requiresAddressMessage": "sample string 13",
    "requiresPhoneMessage": "sample string 14",
    "requiresEmailMessage": "sample string 15",
    "requiresName": true,
    "requiresNameMessage": "sample string 17",
    "roleFilterId": "84d92087-712c-44bd-81a5-ab64d8090bb5",
    "isAutomaticRenewal": true,
    "paymentTypeCaption": "sample string 19",
    "ledgerCodeSchemeId": "26b8e641-d425-451c-ae4e-e85c58f07f21",
    "isSaved": true
  },
  "paymentId": "f2d0490e-f53f-45a2-838c-bfdba9321cc3",
  "paymentReference": "sample string 5",
  "userId": "d6cb011a-2097-4570-9a99-1975092086a0",
  "contextUserId": "802e1fc4-b913-4ba1-9889-79ce5e04e520",
  "sessionId": "1af8c65e-99e2-49a1-b597-2bbca57fb204",
  "paymentTypeId": "sample string 9",
  "paymentTimeStamp": "2026-11-04T06:22:48.5853195+00:00",
  "paymentFeeAmount": 11.0,
  "hardwareId": "sample string 12",
  "paymentRecipientId": "26a5c886-5267-4bbe-93e1-d3b843e71972",
  "cardType": "sample string 14",
  "paymentNetAmount": 15.0,
  "basketId": "e3dadf21-db69-434e-ba4e-0cbc8bebaba2",
  "requestData": "sample string 17",
  "ledgerCode": "sample string 18",
  "isSaved": true
}