GET/api/v1/payments/methods
Methods customers pay with, and their test values.
- CLI
sendmock payments methods list- MCP tool
sendmock_payment_method_list- In the app
- Payments > Methods
Answer
200 PaymentMethodDefinition[]
Payment methods
GET
POST/api/v1/payments/methods
Add a custom method.
- CLI
sendmock payments methods create- MCP tool
sendmock_payment_method_create- In the app
- Payments > Methods > Add method
Request body (application/json)
PaymentMethodInput : Body of POST and PATCH /api/v1/payments/methods; key and flow are fixed after creation.
| Field | Type | Description |
|---|---|---|
| key | string | The method's key; fixed after creation.Example: upay_wallet |
| name | string | The method's name on checkout pages.Example: Upay wallet |
| flow | string | The key of the flow its checkout runs.Example: wallet |
| accent | string | #rrggbb, used on checkout pages.Example: #e2136e |
| is_enabled | boolean | Off methods are hidden on checkout pages.Example: true |
| test_cards | TestCardValue[] | Read by a card form step. |
| test_numbers | TestNumberValue[] | Read by an account number or voucher code step. |
| otp | string | Read by an OTP step.Example: 123456 |
| pin | string | Read by a PIN step.Example: 12121 |
| default_outcome | "succeed" | "decline" | The outcome when the flow has no deciding step.One of: succeed, declineExample: succeed |
| test_account | string | Read by a signed-in account step.Example: [email protected] |
Answer
201 PaymentMethodDefinition
Errors: 400, as { error: { code, message } }
Try it in Demo mode
GET/api/v1/payments/methods/{methodKey}
One payment method with its test values.
- CLI
sendmock payments methods show <methodKey>- MCP tool
sendmock_payment_method_get- In the app
- Payments > Methods > Edit
Answer
200 PaymentMethodDefinition
Errors: 404, as { error: { code, message } }
Try it in Demo mode
PATCH/api/v1/payments/methods/{methodKey}
Change a method.
- CLI
sendmock payments methods update <methodKey>- MCP tool
sendmock_payment_method_update- In the app
- Payments > Methods > method > Save method, enabled switch
Request body (application/json)
PaymentMethodInput : Body of POST and PATCH /api/v1/payments/methods; key and flow are fixed after creation.
| Field | Type | Description |
|---|---|---|
| key | string | The method's key; fixed after creation.Example: upay_wallet |
| name | string | The method's name on checkout pages.Example: Upay wallet |
| flow | string | The key of the flow its checkout runs.Example: wallet |
| accent | string | #rrggbb, used on checkout pages.Example: #e2136e |
| is_enabled | boolean | Off methods are hidden on checkout pages.Example: true |
| test_cards | TestCardValue[] | Read by a card form step. |
| test_numbers | TestNumberValue[] | Read by an account number or voucher code step. |
| otp | string | Read by an OTP step.Example: 123456 |
| pin | string | Read by a PIN step.Example: 12121 |
| default_outcome | "succeed" | "decline" | The outcome when the flow has no deciding step.One of: succeed, declineExample: succeed |
| test_account | string | Read by a signed-in account step.Example: [email protected] |
Answer
200 PaymentMethodDefinition
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
DELETE/api/v1/payments/methods/{methodKey}
Delete a custom method; 409 while a gateway offers it.
- CLI
sendmock payments methods delete <methodKey>- MCP tool
sendmock_payment_method_delete- In the app
- Payments > Methods > method > Delete
Answer
204 No content
Errors: 404, 409, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/payments/methods/{methodKey}/reset
Put a built-in method back as shipped.
- CLI
sendmock payments methods reset <methodKey>- MCP tool
sendmock_payment_method_reset- In the app
- Payments > Methods > method > Reset to default
Answer
200 PaymentMethodDefinition
Errors: 404, 409, as { error: { code, message } }