updatepaymentinstrument.md
Update a Payment Instrument
Update a Payment Instrument to:
- Change the billing address in case the account holder moved (instrument_type:PAYMENT_CARD only).
- Disable the Payment Instrument resource so it can't be used in requests.
- Update the name on the Payment Instrument.
- Change the tags.
- Enable or disable Account Updater.
- Enable or disable Network Tokens.
- Update the expiration date (instrument_type:PAYMENT_CARD only).
Endpoint: PUT /payment_instruments/{payment_instrument_id} Security: BasicAuth
Path parameters:
payment_instrument_id(string, required) The Payment Instrument ID. Example: "PIhWqjo3DU13WmFzWZFLngfa"
Response 400 fields (application/json):
total(integer, required) Total number of errors returned._embedded(object, required) Container for embedded error objects._embedded.errors(array) List of individual error objects._embedded.errors.code(string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request._embedded.errors.logref(string) A log reference identifier for the error, useful for debugging and support purposes._embedded.errors.message(string) A human-friendly error message._embedded.errors._links(object) Links related to this error._embedded.errors._links.self(object) Link to the resource related to the error._embedded.errors._links.self.href(string) URL of the related resource.
Response 401 fields (application/json):
total(integer, required) Total number of errors returned._embedded(object, required) Container for embedded error objects._embedded.errors(array) List of individual error objects._embedded.errors.code(string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request._embedded.errors.logref(string) A log reference identifier for the error, useful for debugging and support purposes._embedded.errors.message(string) A human-friendly error message._embedded.errors._links(object) Links related to this error._embedded.errors._links.self(object) Link to the resource related to the error._embedded.errors._links.self.href(string) URL of the related resource.
Response 403 fields (application/json):
total(integer, required) Total number of errors returned._embedded(object, required) Container for embedded error objects._embedded.errors(array) List of individual error objects._embedded.errors.code(string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request._embedded.errors.logref(string) A log reference identifier for the error, useful for debugging and support purposes._embedded.errors.message(string) A human-friendly error message._embedded.errors._links(object) Links related to this error._embedded.errors._links.self(object) Link to the resource related to the error._embedded.errors._links.self.href(string) URL of the related resource.
Response 404 fields (application/json):
total(integer, required) Total number of errors returned._embedded(object, required) Container for embedded error objects._embedded.errors(array) List of individual error objects._embedded.errors.code(string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request._embedded.errors.logref(string) A log reference identifier for the error, useful for debugging and support purposes._embedded.errors.message(string) A human-friendly error message._embedded.errors._links(object) Links related to this error._embedded.errors._links.self(object) Link to the resource related to the error._embedded.errors._links.self.href(string) URL of the related resource.
Response 406 fields (application/json):
total(integer, required) Total number of errors returned._embedded(object, required) Container for embedded error objects._embedded.errors(array) List of individual error objects._embedded.errors.code(string) The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request._embedded.errors.logref(string) A log reference identifier for the error, useful for debugging and support purposes._embedded.errors.message(string) A human-friendly error message._embedded.errors._links(object) Links related to this error._embedded.errors._links.self(object) Link to the resource related to the error._embedded.errors._links.self.href(string) URL of the related resource.