Set rank of payment method

This operation sets rank (priority) of payment method for postage refill and subscription billing .

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

It specifies the unique carrier account id. Its value can be referred from Get Carrier Accounts API

paymentMethodId
required
string

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

paymentMethodRankFor
required
string

This is to specify Postage or Subscription rank to be set

Enum: "POSTAGE" "SUBSCRIPTION"
paymentMethodRank
required
integer

It specify the rank(priority) for the payment method. It takes numeric value, 1 being the highest priority

Responses
200

Updated rank of Payment Method

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/rank
Request samples
application/json
{
  • "carrierAccountId": "gOpvB5GjV8r",
  • "paymentMethodId": "4b60dba7-8f01-4f4f-9900-956f1e4cb7bf",
  • "paymentMethodRankFor": "POSTAGE",
  • "paymentMethodRank": 1
}
Response samples
application/json
[
  • {
    }
]