The scheduled payment object

{
  "object": "scheduledPayment",
  "id": "67fzr9t9b305kr051ixmq7ak",
  "name": "Monthly Installment",
  "amount": "120.00",
  "currency": "USD",
  "payerId": "fh80g9y3703gpc924m1ateee",
  "sourceId": "ew8th82xv1lilghu04hh9gzt",
  "sourceType": "Card",
  "schedule": {
    "object": "schedule",
    "id": "8cjyfzm6d0e2jecq98x1tnii",
    "interval": "month",
    "intervalCount": 1,
    "atHour": 21,
    "atMinute": 0,
    "anchor": "start",
    "dateNext": "2020-04-01T21:00:00.000Z",
    "dateStart": "2020-04-01T21:00:00.000Z",
    "timesRan": 0,
    "timesToRun": 12,
    "status": "active",
    "created": "2020-03-16T14:40:10.000Z",
    "lastUpdated": "2020-03-16T14:40:11.000Z"
  },
  "cardId": "ew8th82xv1lilghu04hh9gzt",
  "bankId": "we8th82xv1lilghu04hh9gzt",
  "bank": {
    "nameOnAccount": "Jessica Lin",
    "routingNumber": "110000000",
    "accountNumber": "000123456789",
    "currency": "USD",
    "accountType": "checking",
    "externalId": "bank_001",
    "billingAddress": {
      "street1": "payer street",
      "city": "payer city",
      "state": "CA",
      "country": "USA",
      "postalCode": "95060"
    }
  },
  "source": {
    "object": "card",
    "id": "ew8th82xv1lilghu04hh9gzt",
    "nameOnCard": "Jared Oliver",
    "brand": "visa",
    "last4": "0077",
    "expirationMonth": "11",
    "expirationYear": "2024",
    "fingerprint": "0axr8mh2g4d7ix165v02cu3t",
    "payerId": "fh80g9y3703gpc924m1ateee",
    "billingAddress": {
      "object": "address",
      "id": "sf6jl2kn4112lmt75u1jsmk5",
      "street1": "Dam street",
      "city": "Cupertino",
      "state": "AZ",
      "postalCode": "95014",
      "country": "USA",
      "status": "active",
      "created": "2020-01-14T23:00:50.000Z",
      "lastUpdated": "2020-01-14T23:00:52.000Z"
    },
    "created": "2020-01-14T23:00:50.000Z",
    "lastUpdated": "2020-01-14T23:00:52.000Z",
    "status": "active"
  },
  "payer": {
    "object": "payer",
    "id": "fh80g9y3703gpc924m1ateee",
    "name": "Jared Oliver",
    "email": "[email protected]",
    "address": {
      "object": "address",
      "id": "nvu8ogmnlvu3ic137fd4gwvd",
      "street1": "Dam street",
      "city": "Cupertino",
      "state": "AZ",
      "postalCode": "95014",
      "country": "USA",
      "status": "active",
      "created": "2020-01-14T23:00:50.000Z",
      "lastUpdated": "2020-03-16T14:40:10.000Z"
    },
    "ownerId": "nkba1gj4gt0nj42htww2g65h",
    "status": "active",
    "created": "2020-01-14T23:00:50.000Z",
    "lastUpdated": "2020-03-16T14:40:10.000Z"
  },
  "customValues": [
    {
      "object": "customValue",
      "id": "3h0h4hyrsna9le5ouhqxawyh",
      "fieldValue": "12344",
      "customField": {
        "id": "xnvnp3wuvaptje6914ax316d",
        "fieldName": "Invoice Number",
        "fieldKey": "invoiceNumber"
      },
      "resourceId": "6px4sf1lvbsnqi2bsuahf0kc",
      "resourceType": "ScheduledPayment",
      "status": "active",
      "created": "2020-03-16T15:15:34.000Z",
      "lastUpdated": "2020-03-16T15:15:34.000Z"
    }
  ],
  "ownerId": "nkba1gj4gt0nj42htww2g65h",
  "status": "active",
  "created": "2020-03-16T14:40:10.000Z",
  "lastUpdated": "2020-03-16T14:40:11.000Z"
}

Object Keys

id string
The unique id of the scheduled payment.

object string, value is "scheduledPayment"

name string
The name of the scheduled payment.

description string
A short description about the scheduled payment.

amount string
The amount of the payment.

currency string, possible values: USD, CAD, EUR, MXN, AUD and GBP.
The currency of the payment.

schedule schedule object
The schedule object used to create the schedule on which the payments need to be created.

bank bank object
The bank object used to create a scheduled payment.

tokenId string
The id of the token used to create a scheduled payment.

cardId string
The id of the card used to create a scheduled payment.

bankId string
The id of the bank used to create a scheduled payment.

payerId string
The id of the payer associated with the scheduled payment.

payer payer object
The payer object associated with the scheduled payment.

source card object | bank object
The card or bank object, returned in a scheduled payment response.

sourceId string
The id of the card or bank used for the scheduled payment.

sourceType string, possible values: Card, Bank
The source type used for the scheduled payment.

ownerId string
The customer owner of the scheduled payment.

status string, possible values: active, stopped, running, complete, inactive, failed

active
The scheduled payment is active.

stopped
The scheduled payment has been stopped.

running
The scheduled payment is actively creating a payment.

complete
The scheduled payment has run it course and finished.

inactive
The scheduled payment has been deactivated.

failed
The scheduled payment creation was unsuccessful.

created datestring
The date the scheduled payment was created.

lastUpdated datestring
The date the scheduled payment was last updated.

customValues array of custom value objects
List of custom values applied to the payments created by the scheduled payment.