Payment methods (admin API)
Admin routes of the payment methods module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.
GET /v1/admin/payment-methods
Section titled “GET /v1/admin/payment-methods”List payment methods
Parameters:
isActivein query (boolean, optional).pagein query (number, min 1, optional).pageSizein query (number, min 1, max 100, optional).providerin query ("cod","gift_card","manual","paypal","stripe", optional).
Responses:
200: Methods retrieved.401: Unauthorized.403: Insufficient permissions.
POST /v1/admin/payment-methods
Section titled “POST /v1/admin/payment-methods”Create payment method
Request body: CreatePaymentMethodDto.
Responses:
201: Created.400: Invalid input.409: Code already in use.
DELETE /v1/admin/payment-methods/{id}
Section titled “DELETE /v1/admin/payment-methods/{id}”Soft-delete payment method
Parameters:
idin path (string, required).
Responses:
204: Deleted.404: Not found.
GET /v1/admin/payment-methods/{id}
Section titled “GET /v1/admin/payment-methods/{id}”Get payment method
Parameters:
idin path (string, required).
Responses:
200: Method retrieved.404: Not found.
PATCH /v1/admin/payment-methods/{id}
Section titled “PATCH /v1/admin/payment-methods/{id}”Update payment method
Parameters:
idin path (string, required).
Request body: UpdatePaymentMethodDto.
Responses:
200: Updated.400: Invalid input.404: Not found.
POST /v1/admin/payment-methods/reorder
Section titled “POST /v1/admin/payment-methods/reorder”Reorder payment methods
Request body: ReorderPaymentMethodsDto.
Responses:
204: Reordered.400: Invalid ids payload.404: One or more ids unknown.
Schemas
Section titled “Schemas”CreatePaymentMethodDto
Section titled “CreatePaymentMethodDto”code(string, pattern^[a-z0-9_]+$, min length 2, max length 50, required).name(PaymentTranslatableDto, required).description(OptionalTranslatableDto, optional).provider("cod","gift_card","manual","paypal","stripe", required).isActive(boolean, optional).isTestMode(boolean, optional).sortOrder(number, min 0, optional).config(object, optional).
OptionalTranslatableDto
Section titled “OptionalTranslatableDto”fr(string, optional).en(string, optional).ar(string, optional).default(string, optional).
PaymentTranslatableDto
Section titled “PaymentTranslatableDto”fr(string, optional).en(string, optional).ar(string, optional).default(string, required).
ReorderPaymentMethodsDto
Section titled “ReorderPaymentMethodsDto”ids(array of string, required).
UpdatePaymentMethodDto
Section titled “UpdatePaymentMethodDto”name(OptionalTranslatableDto, optional).description(OptionalTranslatableDto, optional).isActive(boolean, optional).isTestMode(boolean, optional).sortOrder(number, min 0, optional).config(object, optional).
