POST api/Billing/WalletPayment
No documentation available.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| model | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"ReceivePayment": {
"InsuranceBalanceDue": 1.0,
"PatientBalanceDue": 2.0,
"CanIssueReceipt": true,
"ReceiptEmailedTo": "sample string 4",
"BillingPaymentId": 5,
"SelectedInsuranceCompanyId": 1,
"ClinicInsuranceCompanies": null,
"PayerType": 6,
"PayerTypes": null,
"AppointmentType": 1,
"Amount": 7.0,
"CopayAmount": 8.0,
"PaymentMethod": 9,
"PaymentMethods": [
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Select payment method",
"Value": ""
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Cash",
"Value": "1"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Credit/Debit Card",
"Value": "10"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Credit Card (External)",
"Value": "2"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Debit Card (External)",
"Value": "3"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Check",
"Value": "4"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "EFT",
"Value": "9"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "ACH Transfer",
"Value": "5"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Voucher (Groupon, Living-Social, etc.)",
"Value": "6"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Gift Card",
"Value": "7"
},
{
"Disabled": false,
"Group": null,
"Selected": false,
"Text": "Other",
"Value": "8"
}
],
"ReferenceNumber": "sample string 10",
"PaymentPostedDate": "2025-12-15 20:05",
"Description": "sample string 12",
"IsFinalPayment": true,
"IsCancellationPayment": true,
"Adjustment": 15.0,
"DisablePayerType": "sample string 16",
"PatientId": 1,
"EntityId": 17,
"SaleType": 0,
"PaymentHasAllocations": true,
"AuthorId": 19,
"IsDeleted": true,
"TotalApplied": 21.0,
"Refund": 22.0,
"CardProfileId": 1,
"CardTransactionId": 1,
"SaveCardProfile": true,
"TransFirstSaleRequest": null,
"SphereRequest": null,
"FullsteamRequest": null,
"TransFirstSaleInfo": {
"rspCode": "sample string 1",
"RecurrRsp": "sample string 2",
"TranNr": "sample string 3",
"Auth": "sample string 4",
"Date": "2025-12-15 20:05",
"Amount": "sample string 6",
"ACI": "sample string 7",
"STAN": "sample string 8",
"SwchKey": "sample string 9",
"PmtType": "sample string 10",
"PmtID": "sample string 11",
"WalletDescription": "sample string 12",
"CustID": "sample string 13",
"AccountHolderName": "sample string 14",
"CustomerReferenceId": "sample string 15",
"AddressLine1": "sample string 16",
"AddressLine2": "sample string 17",
"City": "sample string 18",
"State": "sample string 19",
"Zip": "sample string 20",
"Email": "sample string 21",
"Phone": "sample string 22",
"CardType": "sample string 23",
"mapCAID": "sample string 24",
"IndCode": 25,
"CardNumber": "sample string 26"
},
"SphereSaleInfo": {
"TransactionId": "sample string 1",
"Status": "sample string 2",
"FailReason": "sample string 3",
"AuthCode": "sample string 4",
"CardNumber": "sample string 5",
"CardType": "sample string 6",
"CardName": "sample string 7",
"Amount": 8.0,
"BillingId": "sample string 9",
"ExpiryDate": "2025-12-15 20:05",
"MaskedCardNumber": "xxxx-xxxx-xxxx-sample string 5"
},
"FullsteamSaleInfo": {
"TransactionId": 1,
"Token": "sample string 1",
"AmountDetails": {
"AttemptedSubtotalAmount": 1.0,
"AppliedSubtotalAmount": 1.0,
"AttemptedTaxAmount": 1.0,
"AppliedTaxAmount": 1.0,
"AttemptedTipAmount": 1.0,
"AppliedTipAmount": 1.0,
"AttemptedTotalAmount": 1.0,
"ApprovedTotalAmount": 1.0,
"CashoutAmount": 1.0
},
"AccountDetails": {
"PaymentMethod": 0,
"CardBIN": "sample string 1",
"PaymentAccountLast4": "sample string 2",
"NameOnAccount": "sample string 3",
"ExpirationMonth": 1,
"ExpirationYear": 1,
"CommercialCardCustomerCode": "sample string 4",
"CardBalanceAmount": 1.0,
"CardEntryMethod": 0,
"RoutingNumber": "sample string 5",
"AchAuthorizationType": "sample string 6",
"GiftCardOperationId": 1
},
"IssuerResponseDetails": {
"IssuerResponseCode": "sample string 1",
"IssuerResponseDescription": "sample string 2",
"AvsResponseCode": "sample string 3",
"AvsResponseDescription": "sample string 4",
"CvvResponseCode": "sample string 5",
"CvvResponseDescription": "sample string 6",
"AuthCode": "sample string 7",
"ProcessingNetwork": 0
},
"EMVDetails": {
"EmvApplicationIdentifier": "sample string 1",
"EmvApplicationName": "sample string 2",
"EmvCryptogramType": "sample string 3",
"EmvCryptogramValue": "sample string 4",
"EmvVerificationType": "sample string 5"
},
"ResponseDetails": [
{
"Message": "sample string 1"
},
{
"Message": "sample string 1"
},
{
"Message": "sample string 1"
}
],
"SignatureDetails": {
"SignatureGathered": true
},
"RequestGuid": "b0036413-b20d-436d-b858-700523a24039",
"ActionGuid": "e6dac381-7acd-4208-873b-07f7bdbb0fe8",
"IsSuccessful": true,
"ResponseCode": 0,
"DurationInMiliseconds": 5,
"ClinicUid": "8824451b-8773-4ab7-bb56-40f4e852f2df",
"AuthorId": 7
},
"FullsteamTerminalResponse": {
"Terminals": [
{
"TerminalMerchantData": {
"TerminalDescription": "sample string 1"
},
"IsPreReadCapable": true,
"IsPreReadWithTipCapable": true,
"TerminalId": 3,
"IsActive": true,
"SerialNumber": "sample string 5",
"ModelNumber": "sample string 6",
"Region": 0
},
{
"TerminalMerchantData": {
"TerminalDescription": "sample string 1"
},
"IsPreReadCapable": true,
"IsPreReadWithTipCapable": true,
"TerminalId": 3,
"IsActive": true,
"SerialNumber": "sample string 5",
"ModelNumber": "sample string 6",
"Region": 0
},
{
"TerminalMerchantData": {
"TerminalDescription": "sample string 1"
},
"IsPreReadCapable": true,
"IsPreReadWithTipCapable": true,
"TerminalId": 3,
"IsActive": true,
"SerialNumber": "sample string 5",
"ModelNumber": "sample string 6",
"Region": 0
}
],
"ActionGuid": "sample string 1",
"IsSuccessful": true,
"ResponseCode": 0,
"ResponseDetails": [
{
"Message": "sample string 1",
"merchantMessage": "sample string 2",
"customerMessage": "sample string 3"
},
{
"Message": "sample string 1",
"merchantMessage": "sample string 2",
"customerMessage": "sample string 3"
},
{
"Message": "sample string 1",
"merchantMessage": "sample string 2",
"customerMessage": "sample string 3"
}
],
"DurationInMilliseconds": 3
},
"DefaultTerminal": {
"TerminalId": 1,
"TerminalName": "sample string 2",
"IsSelected": true
},
"SavedCards": null,
"Terminals": null,
"SelectedTerminalId": 1
},
"ApplyPayment": {
"TotalAmount": 1.0,
"ServicesAmount": 2.0,
"ProductsAmount": 3.0,
"CopayAmount": 4.0,
"CollectingCopayAmount": 5.0,
"IsCollectingCopay": true,
"EntityId": 7,
"PatientId": 8,
"ClinicId": 1,
"ClinicUid": "f6750100-6106-43be-bfc4-ce5b60a0bbd4",
"PaymentId": 1,
"PatientItemsWithBalanceDue": null,
"UnallocatedAmount": 9.0,
"AuthorId": 10,
"SaleType": 0,
"BillingStatus": {
"BillingPaymentLinkHistory": {
"IsPreviouslySent": true,
"EntityId": 1,
"PatientId": 1,
"PatientEmail": "sample string 2",
"PatientCanReceiveSms": true,
"DateSentUtc": "2025-12-15 20:05"
},
"EntityId": 1,
"PatientId": 1,
"TotalWithTaxDueAmount": 2.0,
"ProductChargesWithTax": 3.0,
"IsWalkIn": true,
"TotalDueAmount": 5.0,
"AdjustedAmount": 6.0,
"BalanceDueAmount": 7.0,
"ServicesDiscount": 8.0,
"ProductsDiscount": 9.0,
"ServicesTax": 10.0,
"ProductsDTax": 11.0,
"ProductsBalanceDueAmount": 12.0,
"ServicesBalanceDueAmount": 13.0,
"PaidByPatientForServicesAmount": 14.0,
"PaidByPatientForProductsAmount": 15.0,
"PackageSaleChargesWithTax": 16.0,
"PackageSalesDiscount": 17.0,
"PaidByPatientForPackageSalesAmount": 18.0,
"PackageSalesBalanceDueAmount": 19.0
},
"Adjustment": 11.0,
"ProductsDiscount": 1.0,
"ServicesDiscount": 1.0,
"PackageSalesAmount": 12.0,
"PackageSalesDiscount": 1.0
},
"AppointmentBillingStatus": {
"AppointmentType": 1,
"ServicesDueAmount": 1.0,
"ServicesWithDiscountDueAmount": 2.0,
"ServicesDiscountModel": {
"Value": 1.0,
"IsPercentage": true
},
"ServicesWithTaxDueAmount": 3.0,
"ServicesChargesWithTax": 4.0,
"ServicesTaxAmount": 5.0,
"PaidByPatientAmount": 6.0,
"PaidByInsuranceAmount": 7.0,
"LocalAppointmentDateFormatted": "sample string 8",
"LocalAppointmentDate": "sample string 9",
"LocalAppointmentDateTime": "2025-12-15 20:05",
"CopayAmount": 1.0,
"CopayBalanceDueAmount": 11.0,
"PaidByPatientForCopayAmount": 12.0,
"InsuranceBalanceDue": 13.0,
"PatientBalanceDue": 14.0,
"BillingStatus": "sample string 15",
"HasInsuranceFinalPayment": true,
"CardProfileId": 1,
"PurchaseDateFormatted": "sample string 17",
"ProductsDueAmount": 18.0,
"ProductsDiscountModel": {
"Value": 1.0,
"IsPercentage": true
},
"ProductsWithDiscountDueAmount": 19.0,
"ProductsWithTaxDueAmount": 20.0,
"ItemsTaxAmount": 21.0,
"BillingPaymentLinkHistory": {
"IsPreviouslySent": true,
"EntityId": 1,
"PatientId": 1,
"PatientEmail": "sample string 2",
"PatientCanReceiveSms": true,
"DateSentUtc": "2025-12-15 20:05"
},
"EntityId": 22,
"PatientId": 1,
"TotalWithTaxDueAmount": 23.0,
"ProductChargesWithTax": 24.0,
"IsWalkIn": true,
"TotalDueAmount": 26.0,
"AdjustedAmount": 27.0,
"BalanceDueAmount": 28.0,
"ServicesDiscount": 29.0,
"ProductsDiscount": 30.0,
"ServicesTax": 31.0,
"ProductsDTax": 32.0,
"ProductsBalanceDueAmount": 33.0,
"ServicesBalanceDueAmount": 34.0,
"PaidByPatientForServicesAmount": 35.0,
"PaidByPatientForProductsAmount": 36.0,
"PackageSaleChargesWithTax": 37.0,
"PackageSalesDiscount": 38.0,
"PaidByPatientForPackageSalesAmount": 39.0,
"PackageSalesBalanceDueAmount": 40.0
},
"AddToBalance": true,
"UpdatePayment": true,
"ApplyToCurrent": true,
"ForceInsurancePayment": true,
"AppointmentType": 1,
"HasCharges": true
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.