GET api/v1/xref/{tenantXRef}/cardprocessing/cardpayments/{paymentid}
Returns the status of a specific card payment
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| tenantXRef |
Tenant xref |
string |
Required |
| paymentid |
Card Payment NodeId |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Card payment status
Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.CardPaymentStatus| Name | Description | Type | Additional 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": "310ca81c-2c5c-492e-8182-f55a7608d441",
"TenantId": "6a02fd46-f08b-4fc9-b34f-1fa3ff45a897",
"CardPaymentXRef": "sample string 3",
"CustomerReference": "sample string 4",
"PaymentDate": "2025-06-22T15:26:43Z",
"CardReader": {
"CardReaderId": "43442914-140d-4142-b88b-5beb66179068",
"TenantId": "804ba480-f67a-468d-9d90-56534197234e",
"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-06-22T15:26:43Z",
"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-06-22T15:26:43Z",
"TotalAmount": 22.0,
"TransactionId": "sample string 23",
"Type": 0,
"VerificationMethod": 0,
"DeviceLogs": {
"DeviceLogsId": "efdc2a3f-2562-4476-bf9a-bb3f1af7add9",
"TenantId": "986bcd57-a0b1-4278-bd2b-4d757220afc4",
"Device": {
"CardReaderId": "43442914-140d-4142-b88b-5beb66179068",
"TenantId": "804ba480-f67a-468d-9d90-56534197234e",
"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-06-22T15:26:43Z",
"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>310ca81c-2c5c-492e-8182-f55a7608d441</CardPaymentId>
<CardPaymentXRef>sample string 3</CardPaymentXRef>
<CardReader>
<Address>sample string 6</Address>
<CardReaderId>43442914-140d-4142-b88b-5beb66179068</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>804ba480-f67a-468d-9d90-56534197234e</TenantId>
</CardReader>
<CustomerReference>sample string 4</CustomerReference>
<PaymentDate>2025-06-22T15:26:43.7653481+02:00</PaymentDate>
<TenantId>6a02fd46-f08b-4fc9-b34f-1fa3ff45a897</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>43442914-140d-4142-b88b-5beb66179068</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>804ba480-f67a-468d-9d90-56534197234e</TenantId>
</Device>
<DeviceLogsId>efdc2a3f-2562-4476-bf9a-bb3f1af7add9</DeviceLogsId>
<LogTimeStamp>2025-06-22T15:26:43.7653481+02:00</LogTimeStamp>
<Logs>sample string 4</Logs>
<TenantId>986bcd57-a0b1-4278-bd2b-4d757220afc4</TenantId>
</DeviceLogs>
<EFtTransactionId>sample string 10</EFtTransactionId>
<EftTimestamp>2025-06-22T15:26:43.7653481+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-06-22T15:26:43.7653481+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>