HomeGuidesAPI Reference
Guides

PaymentServicer

Payitoff API: PaymentServicer Schema

✉️

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

A PaymentServicer object describes a Servicer, and exposes Payments-related information.

Schema Definition

PropertyTypeFormatDescription
addressobjectAddressServicer's address.
autopaybooleanIndicates whether this PaymentServicer supports activating and deactivating Autopay via our API.
featuresobjectAn object describing supported features for a PaymentServicer.
namestringServicer's name.
idstringuuidUnique identifier of a PaymentServicer

Example

{
  "address": {
    "street1": "123 Main St",
    "street2": "Suite 501",
    "street3": null,
    "city": "Poughkeepsie",
    "state": "NY",
    "zipcode": "12345-6789"
  },
  "autopay": true,
  "features": {
    "payment_profiles": false
   },
  "name": "Great Lakes",
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}