API – Updating an AutoPay Payment Profile

Introduction

If you've set up an AutoPay but need to update the payment profile that it will charge, you can use this request to substitute the old payment profile for a new one. You'll need the IDs for both the AutoPay itself as well as the new payment profile.

If you haven't created the AutoPay or payment profile yet, you should check out our articles API – Creating AutoPays and API – Create New Payment Profile Process.

How To

The update is done through a PUT request to the AutoPay endpoint. This endpoint is unique to each individual AutoPay; the number at the end is the AutoPay ID that distinguishes it from others. Here's a sample endpoint:


PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Autopays(6198)

The JSON payload is relatively straightforward:

{
"PrimaryPaymentMethod": {
"__id": 212
},
"__update": true
}

Just remember to switch "212" with the ID for the new payment profile.

You should get a response like this:

Expand Full Response
Here's a sample response:
{
"d": {
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/Autopays(id=246)",
"type": "Entity.Autopay"
},
"id": 246,
"loanId": 9332,
"name": "Regular Monthly Payment",
"type": "autopay.type.recurring",
"applyDate": "/Date(1641427200)/",
"processDateTime": "/Date(1641366000)/",
"originalProcessDateTime": "/Date(1641366000)/",
"amountType": "autopay.amountType.static",
"amount": 1,
"processCurrent": 0,
"chargeServiceFee": 0,
"retryDays": 0,
"retryCount": 0,
"scheduleNextIfFail": 0,
"postPaymentUpdate": 0,
"recurringFrequency": "autopay.recurringFrequency.monthly",
"recurringPeriods": 4,
"recurringDateOption": "autopay.recurringDate.processDate",
"schedulingType": "autopay.schedulingType.bankingDayPrior",
"paymentExtraTowards": "payment.extra.tx.principal",
"daysInPeriod": null,
"lastDayOfMonthEnabled": 0,
"applyLastDayOfMonthEnabled": 0,
"paymentFee": 0,
"paymentMethodAuthType": "payment.echeckauth.WEB",
"payoffAdjustment": 0,
"chargeOffRecovery": 0,
"mcProcessor": 0,
"ccProcessor": 99,
"baProcessor": 116,
"processZeroOrNegativeBalance": 0,
"status": "autopay.status.pending",
"active": 1,
"created": "/Date(1640821554)/",
"lastPaymentExtraTowards": null,
"PrimaryPaymentMethod": {
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/PaymentAccounts(id=386)",
"type": "Entity.PaymentAccount"
},
"id": 386,
"entityId": 1237,
"entityType": "Entity.Customer",
"importId": null,
"isPrimary": 0,
"isSecondary": 1,
"title": "Checking 2",
"type": "paymentAccount.type.checking",
"creditCardId": 0,
"checkingAccountId": 352,
"active": 1,
"visible": 1,
"verify": 0,
"CheckingAccount": {
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/CheckingAccounts(id=352)",
"type": "Entity.CheckingAccount"
},
"id": 352,
"addressId": 2707,
"processor": null,
"accountType": "bankacct.type.checking",
"token": "QVFJREFIalVqRlk3bHJIVFJFWERTSFljS3R6R1haaFNNNEFJVjkwbWFlalRZUEw3RmdGdmZlTjRHRnZIVEJ1R2RwY0FWVmozQUFBQWZqQjhCZ2txaGtpRzl3MEJCd2FnYnpCdEFnRUFNR2dHQ1NxR1NJYjNEUUVIQVRBZUJnbGdoa2dCWlFNRUFTNHdFUVFNVU4zQWR0L1RCcnErU2FrREFnRVFnRHR5T20vdGF1QmNsTUw5UWlrQUt0V1kvL3Iwdk1EeU5TUmZzTlhCbTd5Z2tvYThMTHhYaUJqazI4eERMZldoRS9CRU9uSS9kSlZ4OXp3ZXpRPT0ub3N3U3RCWEpOWTJ0TkV5YUFPZzdqZz09LkFRSURBSGpVakZZN2xySFRSRVhEU0hZY0t0ekdYWmhTTTRBSVY5MG1hZWpUWVBMN0ZnRnZmZU40R0Z2SFRCdUdkcGNBVlZqM0FBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVVOM0FkdC9UQnJxK1Nha0RBZ0VRZ0R0eU9tL3RhdUJjbE1MOVFpa0FLdFdZLy9yMHZNRHlOU1Jmc05YQm03eWdrb2E4TEx4WGlCamsyOHhETGZXaEUvQkVPbkkvZEpWeDl6d2V6UT09LnlsQ0FkaHBIV1RuY1lJOFhYOG44NytwSXhxQ05abzFkVFExV25VOXNKRnRkL3RjQ1BFOFo2aHA3QWcvUjVLMGY2RFcwVFRyMitvUEh0Nm5RY3JxUE9kMFBZQTh2L2hFQ0JIVDhVa0Z1ZjQ4VTJWU1h1dmxPLzZmYkFyZngxTnJuQkREaitxS2pHQlJqQjFLSWQ3QXlyZGJFOWhQeXY1QmdTS1ZuUVpQa1JLZWgyYTdWdm4rdzdFOWxOUmVmUk4rYXpTQ2MrSU93RUc4UzMyeFI5UG8wL2piWHlqeTNIcklyL2hjTWQzNVE0NWdEQmNubWJWTm96emRmUEw2QVhnVWdrYmlpVlhtbWxxRWNkRzlydzBDOEVMZDliRWhOT1V6Y1YzdTNkRVQ5Q2IvQTF0eXBjSnlOTnc3aVV3VkR5a0NkNzByWkFhd2t5TlJtSjZrU1kxOGFGM3pKUCtWeEl4TGRUUUNiczRyS2owRzVTYkJsMG5SNWdnOGNlbUg4TTZlLzVvY29nVHFwTERQb2RaajZPOHJ6b1dOQU9sMlJGQTNCL1ZWSzRKeDlWSmRXZ05XeHk3N25QNDI4dmhhYXZwUUxCUGQxL3lpOTEyOWsrcGlXMkdPem8rNDlDTmdUcm1wV2s2MVlJd0I1bUFUa0VVVDVGTTdXU1BJeFhJa3M4ODhrVnJ0M1RiZnpsUGI1bXVvS2RPdlBQZXRNbm5EelFxelhEeU1sVGFIS05MZ0JtczhMbS9EaTd6N1ZTV3I0L0xCUll5NGtYWmtLTyswcFVHWExxdExuM2s4Nms1N1owZnpIOElQQnJ3djQ1WHRyeSsvV1E2OE8relZlVzhqUHVqS0hCMHNrcEF0bmFsZ05zVVBNLzU5UW91bGs4c1RpMTFic0NyS3hpVm1JMEIzNFVNaFZ0emxaTWMrVVNNdStuV2dWSC9kUW9USWIwM0JyU1FZU2ROY0FYNTJhU0RrbGl6cjZKS0htaU9naUl6b0tJbUhMUDVNVG00eU9Gd2JleFdnaHNuRHd1b25iWWlaekJMMjFkb2I2QS9zdGc0U0Z6R3RMeXVtM1E5NWpCMGhFZkVFREJxZ2crc05UTEtzc2E2Q1Y=",
"created": "/Date(1640821648)/",
"accountNumber": "1125548",
"routingNumber": "121042882",
"branchNumber": "",
"institutionNumber": "",
"bankName": "WELLS FARGO BANK NA",
"cardHolderName": "Tom Willmington",
"Address": {
"__deferred": {
"uri": "CheckingAccounts(352)/Address"
}
}
},
"CreditCard": {
"__deferred": {
"uri": "PaymentAccounts(386)/CreditCard"
}
}
},
"SecondaryPaymentMethod": {
"__deferred": {
"uri": "Autopays(246)/SecondaryPaymentMethod"
}
},
"AdditionalPaymentMethod": {
"__deferred": {
"uri": "Autopays(246)/AdditionalPaymentMethod"
}
},
"Loan": {
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(id=9332)",
"type": "Entity.Loan"
},
"id": 9332,
"displayId": "TIL-6074-LIT",
"title": "TIL-6074-LIT",
"settingsId": 8938,
"setupId": 9298,
"insurancePolicyId": 0,
"collateralId": 0,
"linkedLoan": 0,
"modId": 0,
"modTotal": 0,
"humanActivityDate": "/Date(1640736000)/",
"created": "/Date(1640821320)/",
"lastMaintRun": "/Date(0)/",
"createdBy": 8206,
"active": 1,
"archived": 0,
"loanAlert": null,
"temporaryAccount": 0,
"deleted": 0,
"deletedAt": null,
"Insurance": {
"__deferred": {
"uri": "Loans(9332)/Insurance"
}
},
"CustomFieldValues": {
"__deferred": {
"uri": "Loans(9332)/CustomFieldValues"
}
},
"ChecklistItemValues": {
"__deferred": {
"uri": "Loans(9332)/ChecklistItemValues"
}
},
"Documents": {
"__deferred": {
"uri": "Loans(9332)/Documents"
}
},
"Collateral": {
"__deferred": {
"uri": "Loans(9332)/Collateral"
}
},
"LoanSettings": {
"__deferred": {
"uri": "Loans(9332)/LoanSettings"
}
},
"LoanSetup": {
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/LoanSetup(id=9298)",
"type": "Entity.LoanSetup"
},
"id": 9298,
"loanId": 9332,
"modId": 0,
"active": 0,
"apr": 9.9672,
"aprForceSingle": 0,
"payment": 922.9,
"origFinalPaymentDate": "/Date(1703721600)/",
"origFinalPaymentAmount": 914.85,
"tilFinanceCharge": 2141.55,
"tilTotalOfPayments": 22141.55,
"tilLoanAmount": 20000,
"tilSalesPrice": 22341.55,
"tilPaymentSchedule": "[{\"count\":23,\"payment\":922.89999999999998,\"startDate\":\"01\\/28\\/2022\"},{\"count\":1,\"payment\":914.85000000000002,\"startDate\":\"12\\/28\\/2023\"}]",
"regzCustomEnabled": 0,
"regzApr": 0,
"regzFinanceCharge": 0,
"regzAmountFinanced": 0,
"regzTotalOfPayments": 0,
"loanAmount": 20000,
"discount": 0,
"underwriting": 0,
"loanRate": 10,
"loanRateType": "loan.rateType.annually",
"loanTerm": 24,
"moneyFactor": 0,
"residual": 0,
"contractDate": "/Date(1640736000)/",
"firstPaymentDate": "/Date(1643328000)/",
"scheduleRound": 0,
"amountDown": 200,
"reserve": 0,
"salesPrice": 0,
"gap": 0,
"warranty": 0,
"dealerProfit": 0,
"taxes": 0,
"creditLimit": 0,
"reportingCreditLimit": 0,
"loanClass": "loan.class.carLoan",
"loanType": "loan.type.installment",
"discountSplit": 1,
"paymentFrequency": "loan.frequency.monthly",
"calcType": "loan.calcType.simpleInterest",
"daysInYear": "loan.daysInYear.actual",
"interestApplication": "loan.interestApplication.betweenTransactions",
"begEnd": "loan.begend.end",
"firstPeriodDays": "loan.firstPeriodDays.actual",
"firstDayInterest": 1,
"discountCalc": "loan.discountCalc.rebalancing",
"diyAlt": 0,
"dueDateOnLastDOM": 0,
"dueDatesOnBusinessDays": "loan.businessduedates.disabled",
"daysInPeriod": "loan.daysinperiod.30",
"roundDecimals": 2,
"lastAsFinal": 0,
"nddCalc": "loan.nddCalc.standard",
"endInterest": "loan.endInterest.no",
"scheduleTemplate": 0,
"curtailmentTemplate": 0,
"feesPaidBy": "loan.feesPaidBy.period",
"useInterestTiers": 0,
"calcHistoryEnabled": 0,
"calcDatesEnabled": 0,
"graceDays": 10,
"lateFeeType": "loan.lateFee.1",
"lateFeeAmount": 30,
"lateFeePercent": 10,
"lateFeeCalc": "loan.lateFeeCalc.standard",
"lateFeePercentBase": "loan.latefeepercentbase.regular",
"rollLastPayment": 0,
"paymentDateApp": "loan.pmtdateapp.actual",
"suspendForecastTo": null,
"isSetupValid": true,
"usuryAlert": false,
"maxInterestAmount": 0,
"financeChargeAsMIA": 0,
"CustomFieldValues": {
"__deferred": {
"uri": "LoanSetup(9298)/CustomFieldValues"
}
}
},
"Notes": {
"__deferred": {
"uri": "Loans(9332)/Notes"
}
},
"Promises": {
"__deferred": {
"uri": "Loans(9332)/Promises"
}
},
"Bankruptcies": {
"__deferred": {
"uri": "Loans(9332)/Bankruptcies"
}
},
"Charges": {
"__deferred": {
"uri": "Loans(9332)/Charges"
}
},
"Payments": {
"__deferred": {
"uri": "Loans(9332)/Payments"
}
},
"LoanFunding": {
"__deferred": {
"uri": "Loans(9332)/LoanFunding"
}
},
"Advancements": {
"__deferred": {
"uri": "Loans(9332)/Advancements"
}
},
"Credits": {
"__deferred": {
"uri": "Loans(9332)/Credits"
}
},
"DueDateChanges": {
"__deferred": {
"uri": "Loans(9332)/DueDateChanges"
}
},
"CurtailmentDates": {
"__deferred": {
"uri": "Loans(9332)/CurtailmentDates"
}
},
"StatusArchive": {
"__deferred": {
"uri": "Loans(9332)/StatusArchive"
}
},
"Transactions": {
"__deferred": {
"uri": "Loans(9332)/Transactions"
}
},
"EscrowCalculatedTx": {
"__deferred": {
"uri": "Loans(9332)/EscrowCalculatedTx"
}
},
"ScheduleRolls": {
"__deferred": {
"uri": "Loans(9332)/ScheduleRolls"
}
},
"StopInterestDates": {
"__deferred": {
"uri": "Loans(9332)/StopInterestDates"
}
},
"APDAdjustments": {
"__deferred": {
"uri": "Loans(9332)/APDAdjustments"
}
},
"DPDAdjustments": {
"__deferred": {
"uri": "Loans(9332)/DPDAdjustments"
}
},
"InterestAdjustments": {
"__deferred": {
"uri": "Loans(9332)/InterestAdjustments"
}
},
"LoanModifications": {
"__deferred": {
"uri": "Loans(9332)/LoanModifications"
}
},
"EscrowAdjustments": {
"__deferred": {
"uri": "Loans(9332)/EscrowAdjustments"
}
},
"EscrowTransactions": {
"__deferred": {
"uri": "Loans(9332)/EscrowTransactions"
}
},
"EscrowSubsetOptions": {
"__deferred": {
"uri": "Loans(9332)/EscrowSubsetOptions"
}
},
"EscrowCalculators": {
"__deferred": {
"uri": "Loans(9332)/EscrowCalculators"
}
},
"EstimatedDisbursements": {
"__deferred": {
"uri": "Loans(9332)/EstimatedDisbursements"
}
},
"Loans": {
"__deferred": {
"uri": "Loans(9332)/Loans"
}
},
"LinkedLoanValues": {
"__deferred": {
"uri": "Loans(9332)/LinkedLoanValues"
}
},
"LoanChilds": {
"__deferred": {
"uri": "Loans(9332)/LoanChilds"
}
},
"RecurrentCharges": {
"__deferred": {
"uri": "Loans(9332)/RecurrentCharges"
}
},
"PayNearMeOrders": {
"__deferred": {
"uri": "Loans(9332)/PayNearMeOrders"
}
},
"Customers": {
"results": [
{
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/Customers(id=1237)",
"type": "Entity.Customer"
},
"id": 1237,
"customId": null,
"mcId": 3592115,
"customerType": "customer.type.individual",
"status": "Active",
"firstName": "Tom",
"lastName": "Willmington",
"middleName": "",
"birthDate": "/Date(1640821655)/",
"gender": "customer.gender.male",
"generationCode": "customer.generationCode.none",
"email": "",
"ssn": "",
"driverLicense": "",
"companyName": "",
"contactName": "",
"customerIdType": "customer.idType.ssn",
"customerId": "",
"creditLimit": 0,
"accessUserName": "TomWillmington",
"active": 1,
"ofacMatch": 0,
"ofacTested": 0,
"saleTransferPii": 1,
"passwordChanged": 0,
"hasAvatar": 0,
"loanRole": "loan.customerRole.primary",
"created": "/Date(1640798724)/",
"lastUpdate": "/Date(1640821648)/",
"creditScoreId": 0,
"PrimaryAddress": {
"__deferred": {
"uri": "Customers(1237)/PrimaryAddress"
}
},
"MailAddress": {
"__deferred": {
"uri": "Customers(1237)/MailAddress"
}
},
"Employer": {
"__deferred": {
"uri": "Customers(1237)/Employer"
}
},
"References": {
"__deferred": {
"uri": "Customers(1237)/References"
}
},
"PaymentAccounts": {
"results": [
{
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/PaymentAccounts(id=385)",
"type": "Entity.PaymentAccount"
},
"id": 385,
"entityId": 1237,
"entityType": "Entity.Customer",
"importId": null,
"isPrimary": 1,
"isSecondary": 0,
"title": "Checking",
"type": "paymentAccount.type.credit",
"creditCardId": 45,
"checkingAccountId": 0,
"active": 1,
"visible": 1,
"verify": 0,
"CheckingAccount": {
"__deferred": {
"uri": "PaymentAccounts(385)/CheckingAccount"
}
},
"CreditCard": {
"__deferred": {
"uri": "PaymentAccounts(385)/CreditCard"
}
}
},
{
"__metadata": {
"uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/PaymentAccounts(id=386)",
"type": "Entity.PaymentAccount"
},
"id": 386,
"entityId": 1237,
"entityType": "Entity.Customer",
"importId": null,
"isPrimary": 0,
"isSecondary": 1,
"title": "Checking 2",
"type": "paymentAccount.type.checking",
"creditCardId": 0,
"checkingAccountId": 352,
"active": 1,
"visible": 1,
"verify": 0,
"CheckingAccount": {
"__deferred": {
"uri": "PaymentAccounts(386)/CheckingAccount"
}
},
"CreditCard": {
"__deferred": {
"uri": "PaymentAccounts(386)/CreditCard"
}
}
}
]
},
"Phones": {
"__deferred": {
"uri": "Customers(1237)/Phones"
}
},
"CustomFieldValues": {
"__deferred": {
"uri": "Customers(1237)/CustomFieldValues"
}
},
"Documents": {
"__deferred": {
"uri": "Customers(1237)/Documents"
}
},
"CreditScore": {
"__deferred": {
"uri": "Customers(1237)/CreditScore"
}
},
"Loans": {
"__deferred": {
"uri": "Customers(1237)/Loans"
}
},
"SocialProfiles": {
"__deferred": {
"uri": "Customers(1237)/SocialProfiles"
}
},
"Notes": {
"__deferred": {
"uri": "Customers(1237)/Notes"
}
}
}
]
},
"Portfolios": {
"__deferred": {
"uri": "Loans(9332)/Portfolios"
}
},
"SubPortfolios": {
"__deferred": {
"uri": "Loans(9332)/SubPortfolios"
}
},
"EscrowSubsets": {
"__deferred": {
"uri": "Loans(9332)/EscrowSubsets"
}
},
"RuleApplied": {
"__deferred": {
"uri": "Loans(9332)/RuleApplied"
}
},
"RuleAppliedLoanSettings": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedLoanSettings"
}
},
"RuleAppliedChargeOff": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedChargeOff"
}
},
"RuleAppliedAPDReset": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedAPDReset"
}
},
"RuleAppliedChecklists": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedChecklists"
}
},
"RuleAppliedChangeDueDates": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedChangeDueDates"
}
},
"RuleAppliedStopInterest": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedStopInterest"
}
},
"RuleAppliedAccountTools": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedAccountTools"
}
},
"RuleAppliedCustomerTools": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedCustomerTools"
}
},
"RuleAppliedAutopay": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedAutopay"
}
},
"RuleAppliedLoanSetup": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedLoanSetup"
}
},
"RuleAppliedBankruptcy": {
"__deferred": {
"uri": "Loans(9332)/RuleAppliedBankruptcy"
}
},
"Autopays": {
"__deferred": {
"uri": "Loans(9332)/Autopays"
}
},
"ActionResultNotes": {
"__deferred": {
"uri": "Loans(9332)/ActionResultNotes"
}
},
"LoanFundingTransactions": {
"__deferred": {
"uri": "Loans(9332)/LoanFundingTransactions"
}
}
},
"PaymentType": {
"__deferred": {
"uri": "Autopays(246)/PaymentType"
}
},
"TransactionChilds": {
"__deferred": {
"uri": "Autopays(246)/TransactionChilds"
}
}
}
}


How did we do?


Powered by HelpDocs (opens in a new tab)