Payment Methods: Re-activates a stored-but-inactive payment method for the merchant.
POST
/api/merchants/{merchantId}/billing/payment-method/{paymentMethodId}/activate
deprecated
Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope.
Only one method may be active per merchant, so the currently-active method is soft-deactivated as part of this call. The chosen method is activated first, so the merchant never passes through a zero-active state.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
merchantId
required |
path | string (uuid) | The billed merchant whose stored method is being activated. |
paymentMethodId
required |
path | string (uuid) | The stored payment method to make active. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.