HomeGuidesAPI Reference

AutopayPayload

Payitoff API: AutopayPayload Schema

✉️

Contact us if you're interested in using this feature.

Used to activate or deactivate autopay using a SourceAccount at a Servicer.

NOTE: The following fields are required:

  • servicer_id
  • source_account_id

Schema Definition

Properties in bold are required.

PropertyTypeFormatDescription
servicer_idstringuuidA UUID value that identifies a Servicer.
source_account_idstringuuidA UUID value that identifies a SourceAccount.

Example

{
  "servicer_id": "781d1f0c-e895-4592-80d9-6915bef4e61d",
  "source_account_id": "646cec59-1c6e-43b1-af16-028bd34546cd"
}