Skip to main content
PATCH
Update payment
Update fields on an existing payment. Updatable fields:
  • status - Payment status
  • amount - Amount in dollars, stored to two decimal places
  • currency - Currency code
  • external_id - External payment ID

Path Parameters

id
string
required

Payment ID (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
amount
number

Payment amount in dollars, stored to two decimal places. The database rounds additional decimal places. Create, update, and payment reads use the same unit.

Required range: x > 0
Example:

5000

currency
string

Supported currency code, such as USD. Whitespace and letter case are normalized.

Example:

"USD"

external_id
string

External payment/transaction ID

status
enum<string>

Payment status

Available options:
pending,
succeeded,
failed,
refunded
Example:

"succeeded"

Response

Successfully updated payment

data
object
required
success
enum<boolean>
required
Available options:
true