Skip to main content

Enabling Automatic Payments for a User

Carlos Gallegos
  • Updated

The first option is to set the automaticPayment field in the MonthlyAccount object to true.  This will cause the automatic payment job to use the "Default" paymentMethod (or any others on file if that fails) to process the payment.

 

The second option is to create an AutomaticPayment object for the User.

 

This requires a valid MonthlyAccount, a valid GarageAccount, and a valid PaymentMethod.

 

To create a GarageAccount and PaymentMethod, please see the following guides:

 

AutomaticPayment Object

{
  "active":false,
  "channels":[
  "string"
  ],
  "class":"string",
  "companyId":"string",
  "documentId":"string",
  "electronicSignature":"string",
  "endDate":"2021-05-07T00:26:16.711Z",
  "garageAccountId":"string",
  "monthlyAccountId":"string",
  "name":"string",
  "noEndDate":false,
  "paymentMethodId":"string",
  "startDate":"2021-05-07T00:26:16.711Z",
  "userId":"string"
}

 

 

Sample Response:

{
  "channels":[],
  "documentId":"automaticPayment::e828bf59-b091-45ef-b64a-f4300ff19fd5",
  "userId":"support@valet-manager.com",
  "companyId":"demo",
  "garageAccountId":"garageAccount::f91875af-d065-475b-88f7-849458d10838",
  "monthlyAccountId":"MonthlyAccount::4179dac2-87cf-43d3-a2ef-65d1b2ca8f22",
  "paymentMethodId":"paymentMethod::639e9644-c066-4e72-ab78-adca605310de",
  "startDate":"2021-05-08T00:53:23.506Z",
  "endDate":"2021-11-07T00:53:23.505Z",
  "noEndDate":true,
  "active":true,
  "name":"TEST",
  "electronicSignature":"JOHN I PAYNE",
  "class":"automaticPayment"
}

Related articles

Powered by Zendesk