GET api/v1/xref/{tenantXRef}/cardprocessing/cardpayments/xref/{paymentXRef}

Returns the status of a specific card payment by external reference

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantXRef

Tenant xref

 string

Required
paymentXRef

Card Payment XRef

 string

Required

Body Parameters

None.

Response Information

Resource Description

Card payment status

Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.CardPaymentStatus
NameDescriptionTypeAdditional information
CardPayment

Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.CardPayment

None.
Status

Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.CardPaymentStatus+CardPaymentStatusCode

None.
DiagnosticsData

Collection of Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample: 
{
  "CardPayment": {
    "CardPaymentId": "c8362190-896e-4cc7-b2e0-1b8c438f0594",
    "TenantId": "37e6e905-53c8-41ec-bf24-104267099b2c",
    "CardPaymentXRef": "sample string 3",
    "CustomerReference": "sample string 4",
    "PaymentDate": "2025-04-21T20:10:21Z",
    "CardReader": {
      "CardReaderId": "879ab248-1aff-4aba-b9c0-f35ba6fa6d6f",
      "TenantId": "06a52f06-9f35-40c5-bb8f-f43103093bf6",
      "NodeId": 3,
      "Identifier": "sample string 4",
      "SerialNumber": "sample string 5",
      "Address": "sample string 6",
      "Port": "sample string 7",
      "ConnectionMethod": 1,
      "SharedSecret": "sample string 8",
      "NodeVersion": "sample string 9"
    },
    "TransactionDetails": {
      "CustomerTransactionXRef": "sample string 1",
      "Amount": 2.0,
      "Currency": "sample string 3",
      "BudgetMonths": 4
    },
    "TransactionResult": {
      "TransactionStatus": 0,
      "AuthorisationCode": "sample string 1",
      "BudgetNumber": "sample string 2",
      "CardEntryType": 0,
      "CardNumber": "sample string 3",
      "CardSchemeName": "sample string 4",
      "CardTypeId": "sample string 5",
      "Currency": "sample string 6",
      "CustomerReceipt": "sample string 7",
      "CustomerReference": "sample string 8",
      "EftTimestamp": "2025-04-21T20:10:21Z",
      "EFtTransactionId": "sample string 10",
      "ErrorMessage": "sample string 11",
      "GratuityAmount": 12.0,
      "GratuityPercentage": 13.1,
      "MerchantReceipt": "sample string 14",
      "SignatureReceipt": "sample string 15",
      "OriginalEftTransactionId": "sample string 16",
      "RecoveredTransaction": true,
      "RequestedAmount": 18.0,
      "SignatureRequested": true,
      "StatusMessage": "sample string 20",
      "StatusDate": "2025-04-21T20:10:21Z",
      "TotalAmount": 22.0,
      "TransactionId": "sample string 23",
      "Type": 0,
      "VerificationMethod": 0,
      "DeviceLogs": {
        "DeviceLogsId": "96676be8-206d-4ad9-a3a3-b449ad25f7ef",
        "TenantId": "111791c0-9a25-4253-961a-c6984a17a052",
        "Device": {
          "CardReaderId": "879ab248-1aff-4aba-b9c0-f35ba6fa6d6f",
          "TenantId": "06a52f06-9f35-40c5-bb8f-f43103093bf6",
          "NodeId": 3,
          "Identifier": "sample string 4",
          "SerialNumber": "sample string 5",
          "Address": "sample string 6",
          "Port": "sample string 7",
          "ConnectionMethod": 1,
          "SharedSecret": "sample string 8",
          "NodeVersion": "sample string 9"
        },
        "LogTimeStamp": "2025-04-21T20:10:21Z",
        "Logs": "sample string 4"
      }
    }
  },
  "Status": 0,
  "DiagnosticsData": [
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample: 
<CardPaymentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/rcm/cardprocessing/v1/cardpayment/">
  <CardPayment>
    <CardPaymentId>c8362190-896e-4cc7-b2e0-1b8c438f0594</CardPaymentId>
    <CardPaymentXRef>sample string 3</CardPaymentXRef>
    <CardReader>
      <Address>sample string 6</Address>
      <CardReaderId>879ab248-1aff-4aba-b9c0-f35ba6fa6d6f</CardReaderId>
      <ConnectionMethod>Bluetooth</ConnectionMethod>
      <Identifier>sample string 4</Identifier>
      <NodeId>3</NodeId>
      <NodeVersion>sample string 9</NodeVersion>
      <Port>sample string 7</Port>
      <SerialNumber>sample string 5</SerialNumber>
      <SharedSecret>sample string 8</SharedSecret>
      <TenantId>06a52f06-9f35-40c5-bb8f-f43103093bf6</TenantId>
    </CardReader>
    <CustomerReference>sample string 4</CustomerReference>
    <PaymentDate>2025-04-21T20:10:21.0230854+02:00</PaymentDate>
    <TenantId>37e6e905-53c8-41ec-bf24-104267099b2c</TenantId>
    <TransactionDetails>
      <Amount>2</Amount>
      <BudgetMonths>4</BudgetMonths>
      <Currency>sample string 3</Currency>
      <CustomerTransactionXRef>sample string 1</CustomerTransactionXRef>
    </TransactionDetails>
    <TransactionResult>
      <AuthorisationCode>sample string 1</AuthorisationCode>
      <BudgetNumber>sample string 2</BudgetNumber>
      <CardEntryType>Undefined</CardEntryType>
      <CardNumber>sample string 3</CardNumber>
      <CardSchemeName>sample string 4</CardSchemeName>
      <CardTypeId>sample string 5</CardTypeId>
      <Currency>sample string 6</Currency>
      <CustomerReceipt>sample string 7</CustomerReceipt>
      <CustomerReference>sample string 8</CustomerReference>
      <DeviceLogs>
        <Device>
          <Address>sample string 6</Address>
          <CardReaderId>879ab248-1aff-4aba-b9c0-f35ba6fa6d6f</CardReaderId>
          <ConnectionMethod>Bluetooth</ConnectionMethod>
          <Identifier>sample string 4</Identifier>
          <NodeId>3</NodeId>
          <NodeVersion>sample string 9</NodeVersion>
          <Port>sample string 7</Port>
          <SerialNumber>sample string 5</SerialNumber>
          <SharedSecret>sample string 8</SharedSecret>
          <TenantId>06a52f06-9f35-40c5-bb8f-f43103093bf6</TenantId>
        </Device>
        <DeviceLogsId>96676be8-206d-4ad9-a3a3-b449ad25f7ef</DeviceLogsId>
        <LogTimeStamp>2025-04-21T20:10:21.0230854+02:00</LogTimeStamp>
        <Logs>sample string 4</Logs>
        <TenantId>111791c0-9a25-4253-961a-c6984a17a052</TenantId>
      </DeviceLogs>
      <EFtTransactionId>sample string 10</EFtTransactionId>
      <EftTimestamp>2025-04-21T20:10:21.0230854+02:00</EftTimestamp>
      <ErrorMessage>sample string 11</ErrorMessage>
      <GratuityAmount>12</GratuityAmount>
      <GratuityPercentage>13.1</GratuityPercentage>
      <MerchantReceipt>sample string 14</MerchantReceipt>
      <OriginalEftTransactionId>sample string 16</OriginalEftTransactionId>
      <RecoveredTransaction>true</RecoveredTransaction>
      <RequestedAmount>18</RequestedAmount>
      <SignatureReceipt>sample string 15</SignatureReceipt>
      <SignatureRequested>true</SignatureRequested>
      <StatusDate>2025-04-21T20:10:21.0230854+02:00</StatusDate>
      <StatusMessage>sample string 20</StatusMessage>
      <TotalAmount>22</TotalAmount>
      <TransactionId>sample string 23</TransactionId>
      <TransactionStatus>Undefined</TransactionStatus>
      <Type>Undefined</Type>
      <VerificationMethod>Undefined</VerificationMethod>
    </TransactionResult>
  </CardPayment>
  <DiagnosticsData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
  </DiagnosticsData>
  <Status>Unknown</Status>
</CardPaymentStatus>