POST api/v1/xref/{tenantXRef}/cardprocessing/cardpayments

Requests a new card payment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantXRef

Tenant xref

 string

Required

Body Parameters

Details of the card payment to be made.

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

globally unique identifier

None.
TenantId

globally unique identifier

None.
CardPaymentXRef

string

None.
CustomerReference

string

None.
PaymentDate

date

None.
CardReader

Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.CardReaderVo

None.
TransactionDetails

Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.TransactionDetails

None.
TransactionResult

Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.TransactionResult

None.

Request Formats

application/json, text/json

Sample: 
{
  "CardPaymentId": "25fe2cc4-abf1-4e6c-ae3e-64ed13ec4e79",
  "TenantId": "c83b09a1-8d50-4c2f-a720-a4153e23d1e9",
  "CardPaymentXRef": "sample string 3",
  "CustomerReference": "sample string 4",
  "PaymentDate": "2025-04-13T20:48:47Z",
  "CardReader": {
    "CardReaderId": "aa995def-04cf-4bfc-b2fe-6e2023c72cb2",
    "TenantId": "3388cef3-474e-4755-b62e-5d5c304c72d5",
    "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-13T20:48:47Z",
    "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-13T20:48:47Z",
    "TotalAmount": 22.0,
    "TransactionId": "sample string 23",
    "Type": 0,
    "VerificationMethod": 0,
    "DeviceLogs": {
      "DeviceLogsId": "94b984ad-6c3c-41c1-b01f-1cd4af18db6e",
      "TenantId": "dcfbae4d-3bf1-4831-b7ce-c1313a2be6ae",
      "Device": {
        "CardReaderId": "aa995def-04cf-4bfc-b2fe-6e2023c72cb2",
        "TenantId": "3388cef3-474e-4755-b62e-5d5c304c72d5",
        "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-13T20:48:47Z",
      "Logs": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample: 
<CardPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/rcm/cardprocessing/v1/cardpayment/">
  <CardPaymentId>25fe2cc4-abf1-4e6c-ae3e-64ed13ec4e79</CardPaymentId>
  <CardPaymentXRef>sample string 3</CardPaymentXRef>
  <CardReader>
    <Address>sample string 6</Address>
    <CardReaderId>aa995def-04cf-4bfc-b2fe-6e2023c72cb2</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>3388cef3-474e-4755-b62e-5d5c304c72d5</TenantId>
  </CardReader>
  <CustomerReference>sample string 4</CustomerReference>
  <PaymentDate>2025-04-13T20:48:47.6582562+02:00</PaymentDate>
  <TenantId>c83b09a1-8d50-4c2f-a720-a4153e23d1e9</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>aa995def-04cf-4bfc-b2fe-6e2023c72cb2</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>3388cef3-474e-4755-b62e-5d5c304c72d5</TenantId>
      </Device>
      <DeviceLogsId>94b984ad-6c3c-41c1-b01f-1cd4af18db6e</DeviceLogsId>
      <LogTimeStamp>2025-04-13T20:48:47.6582562+02:00</LogTimeStamp>
      <Logs>sample string 4</Logs>
      <TenantId>dcfbae4d-3bf1-4831-b7ce-c1313a2be6ae</TenantId>
    </DeviceLogs>
    <EFtTransactionId>sample string 10</EFtTransactionId>
    <EftTimestamp>2025-04-13T20:48:47.6582562+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-13T20:48:47.6582562+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>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CardPayment'.

Response Information

Resource Description

NodeId of the payment

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "0028570e-fc73-4643-aa8c-4771016e0725",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>0028570e-fc73-4643-aa8c-4771016e0725</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>