POST Api/PatientAccount/CreditCard

Request Information

URI Parameters

None.

Body Parameters

CreditCardInformation
NameDescriptionTypeAdditional information
VisitId

integer

None.

PatientAccountId

integer

None.

CardType

string

None.

PayTypeId

integer

None.

CardNumber

string

None.

Ccv

string

None.

ExpirationYear

integer

None.

ExpirationMonth

integer

None.

ExpirationDate

string

None.

FirstName

string

None.

LastName

string

None.

Amount

decimal number

None.

Description

string

None.

Address1

string

None.

Address2

string

None.

City

string

None.

PostalCode

string

None.

State

string

None.

Zip

string

None.

IsPriorPay

boolean

None.

HealthPlanPurchase

HealthPlanPurchaseVm

None.

Last4

string

None.

CardHolderName

string

None.

SendReceiptToEmail

boolean

None.

SendReceiptToPhone

boolean

None.

FlexPatientId

string

None.

Phone

string

None.

Email

string

None.

IsActive

boolean

None.

FlexProfileId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "visitId": 1,
  "patientAccountId": 1,
  "cardType": "sample string 2",
  "payTypeId": 1,
  "cardNumber": "sample string 3",
  "ccv": "sample string 4",
  "expirationYear": 5,
  "expirationMonth": 6,
  "expirationDate": "sample string 7",
  "firstName": "sample string 8",
  "lastName": "sample string 9",
  "amount": 10.0,
  "description": "sample string 11",
  "address1": "sample string 12",
  "address2": "sample string 13",
  "city": "sample string 14",
  "postalCode": "sample string 15",
  "state": "sample string 16",
  "zip": "sample string 17",
  "isPriorPay": true,
  "healthPlanPurchase": {
    "healthPlanUnits": 1,
    "dmeUnits": 2,
    "pharmacyUnits": 3,
    "payTypeId": 1,
    "userAccountEmail": "sample string 4",
    "healthPlanPurchaseId": 5,
    "dmeActualValue": 1.0,
    "dmeSubTotal": 1.0,
    "dmeUnitCost": 1.0,
    "flexPaymentTransactionId": "sample string 6",
    "flexProfileId": "sample string 7",
    "patientAccount": {
      "patientAccountId": 1,
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "gender": "sample string 4",
      "socialSecurity": "sample string 5",
      "birthDate": "2026-05-06T03:48:31.1389375+02:00",
      "address1": "sample string 7",
      "address2": "sample string 8",
      "country": "sample string 9",
      "city": "sample string 10",
      "province": "sample string 11",
      "postalCode": "sample string 12",
      "phoneNumber": "sample string 13",
      "emailAddress": "sample string 14",
      "isActive": true,
      "healthPlanUnits": 16,
      "healthPlanUnitsUsed": 17,
      "healthPlanUnitValue": 18.0,
      "healthPlanUnitsAvailable": 19,
      "pharmacyAmount": 20.0,
      "pharmacyUsed": 21.0,
      "dmeAmount": 22.0,
      "dmeUsed": 23.0,
      "driverCardBack": "QEA=",
      "azureDriverCardBack": "sample string 24",
      "driverCardBackMimeType": "sample string 25",
      "azureDriverCardBackUrl": "sample string 26",
      "driverCardFront": "QEA=",
      "azureDriverCardFront": "sample string 27",
      "driverCardFrontMimeType": "sample string 28",
      "azureDriverCardFrontUrl": "sample string 29",
      "photo": "QEA=",
      "azurePhoto": "sample string 30",
      "photoMimeType": "sample string 31",
      "azurePhotoUrl": "sample string 32",
      "hasDriverCardBack": true,
      "hasDriverCardFront": true,
      "decryptedSocialSecurity": "sample string 33"
    },
    "patientAccountId": 8,
    "payTypeName": "sample string 9",
    "payType": {
      "payTypeId": 1,
      "name": "sample string 2",
      "isVisibleToUser": true,
      "isActive": true,
      "isVisibleToHealthPlanPurchase": true
    },
    "pharmacyActualValue": 1.0,
    "pharmacySubTotal": 1.0,
    "pharmacyUnitCost": 1.0,
    "purcahseDate": "2026-05-06T03:48:31.145944+02:00",
    "purchaseTotal": 11.0,
    "unitActualValue": 1.0,
    "unitCost": 1.0,
    "unitSubTotal": 1.0,
    "unitValue": 1.0,
    "userAccountId": 1
  },
  "last4": "sample string 18",
  "cardHolderName": "sample string 19",
  "sendReceiptToEmail": true,
  "sendReceiptToPhone": true,
  "flexPatientId": "sample string 20",
  "phone": "sample string 21",
  "email": "sample string 22",
  "isActive": true,
  "flexProfileId": "sample string 24"
}

text/html

Sample:
{"visitId":1,"patientAccountId":1,"cardType":"sample string 2","payTypeId":1,"cardNumber":"sample string 3","ccv":"sample string 4","expirationYear":5,"expirationMonth":6,"expirationDate":"sample string 7","firstName":"sample string 8","lastName":"sample string 9","amount":10.0,"description":"sample string 11","address1":"sample string 12","address2":"sample string 13","city":"sample string 14","postalCode":"sample string 15","state":"sample string 16","zip":"sample string 17","isPriorPay":true,"healthPlanPurchase":{"healthPlanUnits":1,"dmeUnits":2,"pharmacyUnits":3,"payTypeId":1,"userAccountEmail":"sample string 4","healthPlanPurchaseId":5,"dmeActualValue":1.0,"dmeSubTotal":1.0,"dmeUnitCost":1.0,"flexPaymentTransactionId":"sample string 6","flexProfileId":"sample string 7","patientAccount":{"patientAccountId":1,"firstName":"sample string 2","lastName":"sample string 3","gender":"sample string 4","socialSecurity":"sample string 5","birthDate":"2026-05-06T03:48:31.1389375+02:00","address1":"sample string 7","address2":"sample string 8","country":"sample string 9","city":"sample string 10","province":"sample string 11","postalCode":"sample string 12","phoneNumber":"sample string 13","emailAddress":"sample string 14","isActive":true,"healthPlanUnits":16,"healthPlanUnitsUsed":17,"healthPlanUnitValue":18.0,"healthPlanUnitsAvailable":19,"pharmacyAmount":20.0,"pharmacyUsed":21.0,"dmeAmount":22.0,"dmeUsed":23.0,"driverCardBack":"QEA=","azureDriverCardBack":"sample string 24","driverCardBackMimeType":"sample string 25","azureDriverCardBackUrl":"sample string 26","driverCardFront":"QEA=","azureDriverCardFront":"sample string 27","driverCardFrontMimeType":"sample string 28","azureDriverCardFrontUrl":"sample string 29","photo":"QEA=","azurePhoto":"sample string 30","photoMimeType":"sample string 31","azurePhotoUrl":"sample string 32","hasDriverCardBack":true,"hasDriverCardFront":true,"decryptedSocialSecurity":"sample string 33"},"patientAccountId":8,"payTypeName":"sample string 9","payType":{"payTypeId":1,"name":"sample string 2","isVisibleToUser":true,"isActive":true,"isVisibleToHealthPlanPurchase":true},"pharmacyActualValue":1.0,"pharmacySubTotal":1.0,"pharmacyUnitCost":1.0,"purcahseDate":"2026-05-06T03:48:31.145944+02:00","purchaseTotal":11.0,"unitActualValue":1.0,"unitCost":1.0,"unitSubTotal":1.0,"unitValue":1.0,"userAccountId":1},"last4":"sample string 18","cardHolderName":"sample string 19","sendReceiptToEmail":true,"sendReceiptToPhone":true,"flexPatientId":"sample string 20","phone":"sample string 21","email":"sample string 22","isActive":true,"flexProfileId":"sample string 24"}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[UrgentCareExtra.Data.Models.AdjustmentCodeClinic, UrgentCareExtra.Data, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[UrgentCareExtra.Data.Models.AdjustmentCodeClinic, UrgentCareExtra.Data, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreditCardInformation'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.