setting/payment_method/edit

This edits a payment method in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

payment_method_id

integer

required

The payment method ID to edit.

name

string

required

The name of the payment method.

channel_group_id

integer

required

The channel group ID for restriction control. Accepts 0 if none.

order_status_id

integer

required

The default order status ID when this payment method is used.

credit_note_status_id

integer

required

The default credit note status ID when this payment method is used.

sort_order

integer

required

The sort order for the payment method.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "payment_method_id": 0,
    "name": "string",
    "channel_group_id": 0,
    "order_status_id": 0,
    "credit_note_status_id": 0,
    "sort_order": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

success

boolean

optional

Returns only if there is no error.

payment_method_id

integer

optional

The edited payment method ID.

Example

{
    "error": [
        "string"
    ],
    "success": true,
    "payment_method_id": 0
}