Update an order payment, adjust an authorization, or capture it

While a payment is an AUTHORIZED hold: PATCH amount_money to raise or lower the authorization (incremental/decremental auth), or PATCH status to COMPLETED — optionally with a lower amount_money — to capture the final total; the unused remainder is recorded as released, and capturing above the hold returns 409 (increase the authorization first). PATCH status to VOIDED or FAILED to release the hold. Otherwise updates are non-financial only: status within PENDING to COMPLETED, FAILED, or VOIDED (and COMPLETED to VOIDED), external_payment_id, and metadata. Outside an AUTHORIZED hold, amount, currency, and payment_type are immutable.

PATCH

orders

{orderId}

payments

{paymentId}

Update an order payment, adjust an authorization, or capture it

curl --request PATCH \
  --url https://api.vantr.ai/v2/orders/{orderId}/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vantr.ai/v2/orders/{orderId}/payments/{paymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vantr.ai/v2/orders/{orderId}/payments/{paymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.text)

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 with opaque bearer tokens. Authorization-code requests require PKCE S256.

Headers

X-API-Version

string

Pin a dated API release (YYYY-MM-DD). Omit for the latest (2026-06-09). Unknown values return 400 unsupported_api_version; the resolved version is echoed back in the X-API-Version response header.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-06-09"

Path Parameters

orderId

string<uuid>

required

paymentId

string<uuid>

required

Response

Payment updated.

Update an order payment, adjust an authorization, or capture it

curl --request PATCH \
  --url https://api.vantr.ai/v2/orders/{orderId}/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vantr.ai/v2/orders/{orderId}/payments/{paymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vantr.ai/v2/orders/{orderId}/payments/{paymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.text)

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}

OAuth

Usage

Capabilities

Locations

Products

Categories

Vendors

Orders

Webhooks

Update an order payment, adjust an authorization, or capture it

Authorizations

Headers

Path Parameters

Response