---
title: "Update a payment"
method: PATCH
path: "/v1/web/payment/{id}"
tags: ["Payment"]
---

# Update a payment

`PATCH /v1/web/payment/{id}`

## Path parameters

- `id` string, required

## Request body

- object
  - `externalId` string
  - `scheduledAt` string, date — ISO date string, YYYY-MM-DD
  - `route` union[] — Flat ordered array of hops the funds will travel through
    - union
      - object
        - `type` 'fundingAccount', required
        - `accountId` string, required
        - `id` string, required
      - object
        - `type` 'fundingSource', required
        - `accountId` string, required
        - `id` string, required
        - `speed` union, required
          - 'sameDay'
          - 'standard'
      - object
        - `type` 'singleUseCard', required
        - `accountId` string, required
        - `cardHolderId` string, required
        - `name` string, required
        - `cardProfileStrategy` union
          - 'advertising_least_used'
          - 'vertical_optimized'
          - 'shipping_optimized'
          - 'plastiq'
          - 'tokenizable'
      - object
        - `type` 'cashAdvance', required
        - `accountId` string, required
        - `repaymentSchedule` union, required
          - 'today'
          - 'net-1'
          - 'net-3'
          - 'net-7'
          - 'net-15'
          - 'net-20'
          - 'net-30'
          - 'net-45'
          - 'net-60'
          - 'net-90'
      - object
        - `type` 'fundingAccount', required
        - `accountId` string, required
        - `id` string, required
      - object
        - `type` 'achPaymentMethod', required
        - `id` string, required
        - `speed` union, required
          - 'sameDay'
          - 'standard'
        - `memo` string, required
      - object
        - `type` 'email', required
        - `sharedByName` string, required
        - `email` string, required
  - `targetAmount` object
    - `value` string, required — Decimal number string
    - `currencyCode` string, required

## Response `200`

Default Response

- object
  - `id` string, required
  - `externalId` string
  - `status` union, required
    - 'scheduled'
    - 'processing'
    - 'succeeded'
    - 'failed'
    - 'stopped'
    - 'deleted'
  - `creator` object, required
    - `type` 'bill', required
    - `id` string, required
  - `scheduledAt` string, date, required — ISO date string, YYYY-MM-DD
  - `legs` object[], required
    - `id` string, required
    - `type` union, required
      - 'debitAch'
      - 'creditAch'
      - 'emailSingleUseCard'
      - 'advanceCash'
    - `status` union, required
      - 'pending'
      - 'processing'
      - 'succeeded'
      - 'failed'
    - `source` union, required
      - object
        - `type` 'fundingAccount', required
        - `accountId` string, required
        - `id` string, required
        - `amount` object, required
          - `value` string, required — Decimal number string
          - `currencyCode` string, required
      - object
        - `type` 'fundingSource', required
        - `accountId` string, required
        - `id` string, required
        - `speed` union, required
          - 'sameDay'
          - 'standard'
        - `amount` object, required
          - `value` string, required — Decimal number string
          - `currencyCode` string, required
      - object
        - `type` 'singleUseCard', required
        - `accountId` string, required
        - `cardHolderId` string, required
        - `name` string, required
        - `cardProfileStrategy` union
          - 'advertising_least_used'
          - 'vertical_optimized'
          - 'shipping_optimized'
          - 'plastiq'
          - 'tokenizable'
        - `amount` object, required
          - `value` string, required — Decimal number string
          - `currencyCode` string, required
      - object
        - `type` 'cashAdvance', required
        - `accountId` string, required
        - `repaymentSchedule` union, required
          - 'today'
          - 'net-1'
          - 'net-3'
          - 'net-7'
          - 'net-15'
          - 'net-20'
          - 'net-30'
          - 'net-45'
          - 'net-60'
          - 'net-90'
        - `amount` object, required
          - `value` string, required — Decimal number string
          - `currencyCode` string, required
    - `target` union, required
      - object
        - `type` 'fundingAccount', required
        - `accountId` string, required
        - `id` string, required
        - `amount` object, required
          - `value` string, required — Decimal number string
          - `currencyCode` string, required
      - object
        - `type` 'achPaymentMethod', required
        - `id` string, required
        - `speed` union, required
          - 'sameDay'
          - 'standard'
        - `memo` string, required
        - `amount` object, required
          - `value` string, required — Decimal number string
          - `currencyCode` string, required
      - object
        - `type` 'email', required
        - `sharedByName` string, required
        - `email` string, required
        - `amount` object, required
          - `value` string, required — Decimal number string
          - `currencyCode` string, required
    - `fees` object
      - `value` string, required — Decimal number string
      - `currencyCode` string, required
    - `integration` union
      - object
        - `type` 'cfxDeposit', required
        - `id` string
        - `organizationId` string, required
        - `depositRequestId` string
        - `error` object
          - `code` string, required
          - `message` string, required
          - `details` object
      - object
        - `type` 'cfxWithdrawal', required
        - `id` string, required
        - `organizationId` string, required
        - `error` object
          - `code` string, required
          - `message` string, required
          - `details` object
      - object
        - `type` 'cardShare', required
        - `id` string, required
        - `cardSpendLimitRuleId` string
        - `cardShare` object
          - `id` string, required
          - `shareUrl` string, required
          - `expiresAt` string, date-time, required
        - `knockWorkflowRunId` string
        - `error` object
          - `code` string, required
          - `message` string, required
      - object
        - `type` 'cashAdvance', required
        - `id` string, required
        - `error` object
          - `code` string, required
          - `message` string, required
    - `startedAt` string, date-time
    - `completedAt` string, date-time
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `startedAt` string, date-time
  - `completedAt` string, date-time

## Other responses

- `400` — Default Response
- `401` — The access to this resource has been denied
- `403` — The access to this resource is forbidden
- `404` — The resource was not found
- `default` — Catch-all error response for any unexpected internal errors

---

[API](https://skmtc.net/funneldash/apis/surface-web-api.md) · [All operations](https://skmtc.net/funneldash/apis/surface-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/funneldash/surface-web-api/revisions/ac700d65f443/schema)