Update a payment


Errors

In addition to the Errors applicable to all API endpoints, the following errors are specific to updating a payment:

status code error code description
404 payment.not-found No payment was found meeting the requirements. Make sure to use the right paymentId and API key. test objects can only be accessed using test keys and live object with live keys.
Path Params
string
required

The unique identifier of the Payment object.

Body Params

Update Payment

string
length between 1 and 80

An arbitrary - ideally descriptive - long form explanation of the Refund, meant to be displayed to the customer.

metadata
object

Set of up to 20 key-value pairs that you can attach to the object.

string
length between 1 and 40

A - ideally unique - string to reference the Refund which can be used to reconcile the Refund with your internal systems.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json