Update a Payment
POST/v1/payments/:id
Update a Payment with the provided details. Only payments in open or requires_action state can be updated, except for metadata which can be updated in any state.
Request
Responses
- 200
- 202
- 400
- 401
- 403
- 404
- 409
- 429
- 500
- 504
OK
The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.
The request failed validation. errors lists every problem found; an entry attributable to a specific field is prefixed with that field’s path.
No API key was supplied, or the key is not valid.
The API key is valid but lacks the permission this operation requires.
No resource exists with the requested identifier.
The supplied X-Idempotency-Key was already used with a different request body, or the resource is being modified by another in-flight request.
Too many requests. The rate limit is applied per client across all operations.
The request could not be completed because of an unexpected error.
The request exceeded the processing time limit and was abandoned.