Set Payment Method Status

This operation sets the Payment Method active or inactive.

SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-ID
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Request Body schema: application/json
carrierAccountId
required
string

A unique identifier assigned to the specific carrier account. Its value can be referred from the response of Get Carrier Accounts API.

paymentMethodId
required
string

It specifies payment method id. Its value can be referred from response of Get Payment Methods API.

paymentMethodStatus
required
string

It specified the status to mark ACTIVE or INACTIVE

Enum: "ACTIVE" "INACTIVE"
Responses
200

Set Payment Method Status

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

patch/api/v1/payments/methods/status
Request samples
application/json
{
  • "carrierAccountId": "gOpvB5GjV8r",
  • "paymentMethodId": "4b60dba7-8f01-4f4f-9900-956f1e4cb7bf",
  • "paymentMethodStatus": "ACTIVE"
}
Response samples
application/json
{ }