Payment method
Update Payment Method
Update an existing payment method.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Path Parameters
methodKey*string
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Request Body
application/json
includes*array<>
logo_img?|
Payment method logo image (max 2MB) or its existing URL. Must not be greater than 2048 characters.
is_online?|
Whether the payment method is online.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:8000/api/v2/payment-methods/sunt" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "includes": [ "ipsum" ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Payment method updated successfully."
},
"data": {
"key": "MADA",
"name": "Mada",
"is_online": true,
"logo_img": "https://cdn.example.com/payment-methods/mada.png",
"created_at": 1782824838438,
"updated_at": 1782824839134,
"scopes": [
"SCOPE_ORDER"
],
"settings_count": "1"
}
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 422,
"status": "error",
"message": "The is online field must be true or false."
},
"data": [
{
"code": 0,
"message": "The is online field must be true or false.",
"field": "is_online"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}