POST v1/Payment/UpdateAutoPayEFT?PolicyNumber={PolicyNumber}&IsUpdateAutoPay={IsUpdateAutoPay}
Update Autopay EFT Details
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PolicyNumber |
Policy number |
string |
Required |
IsUpdateAutoPay |
Update autopay flag |
boolean |
Default value is True |
Body Parameters
Auto pay info
AutoPayEFTDTOName | Description | Type | Additional information |
---|---|---|---|
Id |
EFT master id, use for existing bank account. |
integer |
None. |
BankTransitNumber |
Bank routing / transit code (Required if Id not set) |
string |
None. |
AccountHolderName |
Name of the bank account holder (Required if Id not set) |
string |
None. |
AccountNumber |
Bank account number (Required if Id not set) |
string |
None. |
EFTBankAccountType |
Bank account type (Checking, Savings) (Required if Id not set) |
BankAccountTypeEnum |
None. |
AuthorizationType |
Authorization type (Optional) |
AutopayAuthorizationTypeEnum |
None. |
AutoPayDayOfMonth |
Autopay day of month (Optional) |
integer |
None. |
Expand |
Comma separated list of expansions to include in results |
string |
None. |
Request Formats
application/json, text/json
{ "Id": 1, "BankTransitNumber": "sample string 2", "AccountHolderName": "sample string 3", "AccountNumber": "sample string 4", "EFTBankAccountType": "Unknown", "AuthorizationType": "Unknown", "AutoPayDayOfMonth": 1, "Expand": "" }
application/xml, text/xml
<AutoPayEFTDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound"> <Expand></Expand> <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <Id>1</Id> <AuthorizationType>Unknown</AuthorizationType> <AutoPayDayOfMonth>1</AutoPayDayOfMonth> <AccountHolderName>sample string 3</AccountHolderName> <AccountNumber>sample string 4</AccountNumber> <BankTransitNumber>sample string 2</BankTransitNumber> <EFTBankAccountType>Unknown</EFTBankAccountType> </AutoPayEFTDTO>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Update Autopay EFT Details
AutoPayOutboundDTOName | Description | Type | Additional information |
---|---|---|---|
DayOfTheMonth |
Day of month on which deductions should be taken |
integer |
None. |
Type |
Autopay account type |
AutopayTypeEnum |
None. |
Last4Digits |
Last 4 digits of the payment method. |
string |
None. |
WarningMessages |
List of warning messages encountered while servicing request |
Collection of string |
None. |
Response Formats
application/json, text/json
{ "DayOfTheMonth": 1, "Type": "Unknown", "Last4Digits": "sample string 1" }
application/xml, text/xml
<AutoPayOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound"> <Id>2</Id> <DayOfTheMonth>1</DayOfTheMonth> <Last4Digits>sample string 1</Last4Digits> <Type>Unknown</Type> </AutoPayOutboundDTO>