GET api/v1/{tenantid}/cardprocessing/cardpayments
Returns the status of all card payments for specific tenant
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| tenantid |
Tenant id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of card payment status
Collection of 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": "9fe6d6a7-3100-4eb6-a16e-1c92994586c7",
"TenantId": "f7fdae5d-40ec-4917-91e3-12f959d9095d",
"CardPaymentXRef": "sample string 3",
"CustomerReference": "sample string 4",
"PaymentDate": "2025-04-10T20:05:13Z",
"CardReader": {
"CardReaderId": "e926761a-e3a1-441e-86a5-ba97b26e7ae3",
"TenantId": "7204ca78-bd31-479c-adca-7a66110953cb",
"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-10T20:05:13Z",
"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-10T20:05:13Z",
"TotalAmount": 22.0,
"TransactionId": "sample string 23",
"Type": 0,
"VerificationMethod": 0,
"DeviceLogs": {
"DeviceLogsId": "4bb43453-471b-4827-924c-c2b12f4f7298",
"TenantId": "c9bd52f9-6fa7-4351-9769-25410a8b3217",
"Device": {
"CardReaderId": "e926761a-e3a1-441e-86a5-ba97b26e7ae3",
"TenantId": "7204ca78-bd31-479c-adca-7a66110953cb",
"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-10T20:05:13Z",
"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"
}
]
},
{
"CardPayment": {
"CardPaymentId": "9fe6d6a7-3100-4eb6-a16e-1c92994586c7",
"TenantId": "f7fdae5d-40ec-4917-91e3-12f959d9095d",
"CardPaymentXRef": "sample string 3",
"CustomerReference": "sample string 4",
"PaymentDate": "2025-04-10T20:05:13Z",
"CardReader": {
"CardReaderId": "e926761a-e3a1-441e-86a5-ba97b26e7ae3",
"TenantId": "7204ca78-bd31-479c-adca-7a66110953cb",
"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-10T20:05:13Z",
"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-10T20:05:13Z",
"TotalAmount": 22.0,
"TransactionId": "sample string 23",
"Type": 0,
"VerificationMethod": 0,
"DeviceLogs": {
"DeviceLogsId": "4bb43453-471b-4827-924c-c2b12f4f7298",
"TenantId": "c9bd52f9-6fa7-4351-9769-25410a8b3217",
"Device": {
"CardReaderId": "e926761a-e3a1-441e-86a5-ba97b26e7ae3",
"TenantId": "7204ca78-bd31-479c-adca-7a66110953cb",
"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-10T20:05:13Z",
"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:
<ArrayOfCardPaymentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/rcm/cardprocessing/v1/cardpayment/">
<CardPaymentStatus>
<CardPayment>
<CardPaymentId>9fe6d6a7-3100-4eb6-a16e-1c92994586c7</CardPaymentId>
<CardPaymentXRef>sample string 3</CardPaymentXRef>
<CardReader>
<Address>sample string 6</Address>
<CardReaderId>e926761a-e3a1-441e-86a5-ba97b26e7ae3</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>7204ca78-bd31-479c-adca-7a66110953cb</TenantId>
</CardReader>
<CustomerReference>sample string 4</CustomerReference>
<PaymentDate>2025-04-10T20:05:13.5353032+02:00</PaymentDate>
<TenantId>f7fdae5d-40ec-4917-91e3-12f959d9095d</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>e926761a-e3a1-441e-86a5-ba97b26e7ae3</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>7204ca78-bd31-479c-adca-7a66110953cb</TenantId>
</Device>
<DeviceLogsId>4bb43453-471b-4827-924c-c2b12f4f7298</DeviceLogsId>
<LogTimeStamp>2025-04-10T20:05:13.5353032+02:00</LogTimeStamp>
<Logs>sample string 4</Logs>
<TenantId>c9bd52f9-6fa7-4351-9769-25410a8b3217</TenantId>
</DeviceLogs>
<EFtTransactionId>sample string 10</EFtTransactionId>
<EftTimestamp>2025-04-10T20:05:13.5353032+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-10T20:05:13.5353032+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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:ArrayOfKeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d3p1:ArrayOfKeyValueOfstringstring>
<d3p1:ArrayOfKeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d3p1:ArrayOfKeyValueOfstringstring>
</DiagnosticsData>
<Status>Unknown</Status>
</CardPaymentStatus>
<CardPaymentStatus>
<CardPayment>
<CardPaymentId>9fe6d6a7-3100-4eb6-a16e-1c92994586c7</CardPaymentId>
<CardPaymentXRef>sample string 3</CardPaymentXRef>
<CardReader>
<Address>sample string 6</Address>
<CardReaderId>e926761a-e3a1-441e-86a5-ba97b26e7ae3</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>7204ca78-bd31-479c-adca-7a66110953cb</TenantId>
</CardReader>
<CustomerReference>sample string 4</CustomerReference>
<PaymentDate>2025-04-10T20:05:13.5353032+02:00</PaymentDate>
<TenantId>f7fdae5d-40ec-4917-91e3-12f959d9095d</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>e926761a-e3a1-441e-86a5-ba97b26e7ae3</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>7204ca78-bd31-479c-adca-7a66110953cb</TenantId>
</Device>
<DeviceLogsId>4bb43453-471b-4827-924c-c2b12f4f7298</DeviceLogsId>
<LogTimeStamp>2025-04-10T20:05:13.5353032+02:00</LogTimeStamp>
<Logs>sample string 4</Logs>
<TenantId>c9bd52f9-6fa7-4351-9769-25410a8b3217</TenantId>
</DeviceLogs>
<EFtTransactionId>sample string 10</EFtTransactionId>
<EftTimestamp>2025-04-10T20:05:13.5353032+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-10T20:05:13.5353032+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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:ArrayOfKeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d3p1:ArrayOfKeyValueOfstringstring>
<d3p1:ArrayOfKeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d3p1:ArrayOfKeyValueOfstringstring>
</DiagnosticsData>
<Status>Unknown</Status>
</CardPaymentStatus>
</ArrayOfCardPaymentStatus>