v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

PaymentSchedules

Update a payment schedule

patch/payment_schedules/{payment_schedule_id}

Path parameters

payment_schedule_idstring uuid required

Payment schedule ID

Request body

status'CANCELLED'

Target payment schedule status

Response

Updated payment schedule

creation_timestring date-time required

last_updated_timestring date-time required

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

descriptionstring required

User provided description for the payment schedule

idstring uuid

Payment schedule ID

metadataobject

User provided JSON format data

status'ACTIVE' | 'CANCELLED' | 'ERRORED' | 'EXPIRED'

Status of the payment schedule.

Example response

{
  "tenant": "abcdef_ghijkl",
  "payment_instruction": {
    "request": {
      "amount": 607,
      "company_entry_description": "PAYROLL",
      "company_name": "Asdf Finance",
      "currency": "USD",
      "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "dc_sign": "debit",
      "effective_date": "2022-03-18",
      "hold": {
        "duration": 2
      },
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "reference_info": "Tempore atque et cum."
    }
  },
  "schedule": {
    "execution_time": "07:30:00"
  }
}