POST api/Billing/UpdatePaymentDetails
No documentation available.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| uiModel | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"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": "ddbd2bdb-d53a-4168-87bc-1a77c1232325",
"ActionGuid": "4589fe03-b757-4d61-985d-ff75714122da",
"IsSuccessful": true,
"ResponseCode": 0,
"DurationInMiliseconds": 5,
"ClinicUid": "2c2f3a38-96db-4de9-9e51-1bb44b7a115b",
"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
}
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.