Skip to navigation
REST RPC APIPayments

Update

View as Markdown

Activates or deactivates the specified payment method.

For merchants on Shopify Payments, this changes only Ordergroove’s record, not the card stored in Shopify. To have a customer update their card, use Shopify’s customerPaymentMethodSendUpdateEmail mutation.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

OR
authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

payment_idstringRequired
Unique Address Id

Request

This endpoint expects an object.
livebooleanRequired

Account status: active = True

Response

200
customerstringOptional
billing_addressstringOptional
cc_number_endingstring or nullOptional
public_idstringOptional
labelstring or nullOptional
token_idstringOptional
cc_holderstring or nullOptional
cc_typeintegerOptionalDefaults to 0
cc_exp_datestringOptional
payment_methodstringOptional
livebooleanOptionalDefaults to true
createdstringOptional
last_updatedstringOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error