Gateways in depth

Every control and text this screen shows, in screen order. The list is read from the demo by a crawl, and CI fails when the screen changes without its entry here.

Payments > Gateways holds the payment providers SendMock emulates: their checkout, redirect and notifications.

The screen as a whole: Gateways.

The numbers match the entries below. The picture shows the first screenful; controls further down, and texts, have no marker.

On the screenCopy Anchor Link

1. GatewaysCopy Anchor Link

Heading.

• What it does: Names the open screen in the header.

2. Read the Gateways guideCopy Anchor Link

Link.

• What it does: Opens this screen's page in the user guide, in a new tab.
• Links to: Gateways.

3. Payment gatewaysCopy Anchor Link

Heading.

• What it does: The payment providers SendMock emulates.
• Same action elsewhere: REST GET /api/v1/payments/gateways, CLI sendmock payments gateways list, MCP sendmock_payment_gateway_list

4. The providers SendMock emulates: what their checkout offers, what they send back to your app, and the notifications they post.Copy Anchor Link

Text.

• What it does: Explains the screen.

5. Add gatewayCopy Anchor Link

Button.

• What it does: Opens Add a payment gateway; in it, adds the gateway.
• Same action elsewhere: REST POST /api/v1/payments/gateways, CLI sendmock payments gateways create, MCP sendmock_payment_gateway_create

6. GatewayCopy Anchor Link

Column.

• What it does: The gateway's name.

7. KeyCopy Anchor Link

Column.

• What it does: Its key: the provider value in the API and its /providers/<key>/ paths.

8. Methods offeredCopy Anchor Link

Column.

• What it does: The payment methods its checkout offers.

9. Notifications toCopy Anchor Link

Column.

• What it does: The webhook endpoint its notifications go to.

10. EnabledCopy Anchor Link

Column.

• What it does: Whether it takes payments.

11. … enabledCopy Anchor Link

Switch, in each row.

• What it does: Turns the gateway on or off at once.
• Same action elsewhere: REST PATCH /api/v1/payments/gateways/{gatewayKey}, CLI sendmock payments gateways update, MCP sendmock_payment_gateway_update

12. Edit …Copy Anchor Link

Button, in each row.

• What it does: Opens the gateway's editor.
• Same action elsewhere: REST GET /api/v1/payments/gateways/{gatewayKey}, CLI sendmock payments gateways show, MCP sendmock_payment_gateway_get

Add a payment gateway dialogCopy Anchor Link

13. Add a payment gatewayCopy Anchor Link

Heading.

• What it does: The Add a payment gateway dialog.

14. Emulate a provider SendMock does not ship; you set its checkout, redirect and notification next.Copy Anchor Link

Text.

• What it does: Explains adding a gateway.
• Links to: Advanced: create a payment gateway.

15. NameCopy Anchor Link

Field.

• What it does: The gateway's name.

16. KeyCopy Anchor Link

Field.

• What it does: Its key, fixed once added.

17. The provider value in the API; fixed once added.Copy Anchor Link

Text.

• What it does: Explains the key.

18. Start fromCopy Anchor Link

Drop-down.

• What it does: Blank, or a built-in gateway to copy.

19. CancelCopy Anchor Link

Button.

• What it does: Closes the dialog or editor without saving.

20. Add gatewayCopy Anchor Link

Button.

• What it does: Opens Add a payment gateway; in it, adds the gateway.
• Same action elsewhere: REST POST /api/v1/payments/gateways, CLI sendmock payments gateways create, MCP sendmock_payment_gateway_create

21. CloseCopy Anchor Link

Button.

• What it does: Closes the dialog or editor without saving.

Gateway editorCopy Anchor Link

22. StripeCopy Anchor Link

Heading.

• What it does: The gateway open in the editor (here Stripe).

23. Built-in gateway, key stripe . # payments.Copy Anchor Link

Text.

• What it does: Whether it is built in, its key and how many payments it has.

24. GeneralCopy Anchor Link

Tab.

• What it does: Name, key, colour and whether it is on.

25. CheckoutCopy Anchor Link

Tab.

• What it does: The methods its checkout page offers, and a test checkout.

26. MerchantCopy Anchor Link

Tab.

• What it does: Its merchant credentials and where its notifications go.

27. RedirectCopy Anchor Link

Tab.

• What it does: How the customer is sent back to your app, and with which fields.

28. NotificationCopy Anchor Link

Tab.

• What it does: The notification it posts to your app: format, event names, body and headers.

29. NameCopy Anchor Link

Field.

• What it does: The gateway's name.

30. KeyCopy Anchor Link

Field.

• What it does: Its key, fixed once added.

31. The provider value in the API and in /providers/<key>/... paths; fixed once added.Copy Anchor Link

Text.

• What it does: Explains the key.

32. Accent colourCopy Anchor Link

Field.

• What it does: Picks the checkout page's colour.

33. AccentCopy Anchor Link

Field.

• What it does: The colour as a hex value.

34. Used on its checkout pages.Copy Anchor Link

Text.

• What it does: Explains the accent.

35. EnabledCopy Anchor Link

Switch.

• What it does: Whether the gateway takes payments.

36. Reset to defaultCopy Anchor Link

Button.

• What it does: Brings back the shipped definition of a built-in, after you confirm.
• Same action elsewhere: REST POST /api/v1/payments/gateways/{gatewayKey}/reset, CLI sendmock payments gateways reset, MCP sendmock_payment_gateway_reset

37. CancelCopy Anchor Link

Button.

• What it does: Closes the dialog or editor without saving.

38. Save gatewayCopy Anchor Link

Button.

• What it does: Saves the gateway; the next payment uses it.
• Errors: A template with errors is refused with the reason.
• Same action elsewhere: REST PATCH /api/v1/payments/gateways/{gatewayKey}, CLI sendmock payments gateways update, MCP sendmock_payment_gateway_update

39. CloseCopy Anchor Link

Button.

• What it does: Closes the dialog or editor without saving.

Gateway editor, Checkout tabCopy Anchor Link

40. Methods offeredCopy Anchor Link

Heading.

• What it does: The methods its checkout page offers, in order.

41. One method shows its flow directly; several show a picker, in this order.Copy Anchor Link

Text.

• What it does: Explains how the checkout page shows the methods.

42. Move Card upCopy Anchor Link

Button.

• What it does: Shows the method earlier (here Card).

43. Move Card downCopy Anchor Link

Button.

• What it does: Shows the method later.

44. Remove CardCopy Anchor Link

Button.

• What it does: Stops offering the method.

45. Add a methodCopy Anchor Link

Drop-down.

• What it does: Offers another method.
• Links to: Methods.

46. Creates a test payment with this gateway and opens its checkout page.Copy Anchor Link

Text.

• What it does: Explains Open a test checkout.

47. Open a test checkoutCopy Anchor Link

Button.

• What it does: Creates a test payment and opens its checkout page.
• Same action elsewhere: REST POST /api/v1/payments/checkout, CLI sendmock payments checkout create, MCP sendmock_payment_create_checkout

Gateway editor, Merchant tabCopy Anchor Link

48. Templates read them as merchant.<name> . Secrets stay masked; the preview masks them too.Copy Anchor Link

Text.

• What it does: Explains the merchant credentials.

49. Credential # nameCopy Anchor Link

Field.

• What it does: A credential's name, such as secret_key.

50. Credential # valueCopy Anchor Link

Field.

• What it does: Its value; a secret one is masked.

51. SecretCopy Anchor Link

Checkbox.

• What it does: Masks the value everywhere.

52. Reveal secret_keyCopy Anchor Link

Button.

• What it does: Shows the secret key once, after you confirm.
• Same action elsewhere: REST GET /api/v1/payments/gateways/{gatewayKey}/credentials/{credentialName}, CLI sendmock payments gateways credential

53. Remove credentialCopy Anchor Link

Button.

• What it does: Removes the credential.

54. Reveal webhook_secretCopy Anchor Link

Button.

• What it does: Shows the webhook signing secret once, after you confirm.
• Same action elsewhere: REST GET /api/v1/payments/gateways/{gatewayKey}/credentials/{credentialName}, CLI sendmock payments gateways credential

55. Add credentialCopy Anchor Link

Button.

• What it does: Adds a credential.

56. Notification endpointCopy Anchor Link

Drop-down.

• What it does: The webhook endpoint its notifications go to.
• Links to: Endpoints.

57. Its IPN or webhook deliveries go to this webhook endpoint, with retries and replay.Copy Anchor Link

Text.

• What it does: Explains the notification endpoint.

Gateway editor, Redirect tabCopy Anchor Link

58. GET The fields go in the query string (Stripe, PayPal).Copy Anchor Link

Choice.

• What it does: The customer returns with a GET, the fields in the query string.

59. POST The browser posts a form with the fields (SSLCommerz).Copy Anchor Link

Choice.

• What it does: The customer's browser posts a form back to your app.

60. Type {{ for suggestions; {{ redirect.status }} is this gateway's event name for the outcome.Copy Anchor Link

Text.

• What it does: Explains the redirect field templates.

61. Redirect field # nameCopy Anchor Link

Field.

• What it does: A redirect field's name.

62. Redirect field # templateCopy Anchor Link

Field.

• What it does: Its value template.

63. Redirect field # sentCopy Anchor Link

Drop-down.

• What it does: When it is sent: always, or only on success or failure.

64. Remove redirect fieldCopy Anchor Link

Button.

• What it does: Removes the field.

65. Add fieldCopy Anchor Link

Button.

• What it does: Adds a redirect field.

66. PreviewCopy Anchor Link

Tab.

• What it does: Shows the redirect and notification as they would be sent.

67. ReferenceCopy Anchor Link

Tab.

• What it does: Lists every value the templates can read.

68. Preview paymentCopy Anchor Link

Drop-down.

• What it does: The payment the preview uses.

69. Preview eventCopy Anchor Link

Drop-down.

• What it does: The event the preview renders.

70. Preview redirect outcomeCopy Anchor Link

Drop-down.

• What it does: The outcome the preview's redirect shows.
• Same action elsewhere: REST POST /api/v1/payments/gateways/{gatewayKey}/preview, CLI sendmock payments gateways preview, MCP sendmock_payment_gateway_preview

71. RedirectCopy Anchor Link

Heading.

• What it does: The redirect as it would be sent.

72. GET http://localhost:#/checkout/successCopy Anchor Link

Text.

• What it does: The redirect's method and URL (here a GET to the demo app).

73. NotificationCopy Anchor Link

Heading.

• What it does: The notification as it would be sent.

74. payment_intent.succeededCopy Anchor Link

Text.

• What it does: The gateway's event name for the preview event (here Stripe's).

Gateway editor, Notification tabCopy Anchor Link

75. JSON application/json (Stripe, PayPal, bKash).Copy Anchor Link

Choice.

• What it does: The notification body is JSON.

76. Form application/x-www-form-urlencoded; write the body as name=value&... (SSLCommerz IPN).Copy Anchor Link

Choice.

• What it does: The notification body is a form.

77. This gateway's name for each event, read as {{ event.name }} . Leave one blank and nothing is sent for it.Copy Anchor Link

Text.

• What it does: Explains the event names.

78. Event name for payment.createdCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.created; blank sends nothing for it.

79. Event name for payment.authorizedCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.authorized; blank sends nothing for it.

80. Event name for payment.succeededCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.succeeded; blank sends nothing for it.

81. Event name for payment.failedCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.failed; blank sends nothing for it.

82. Event name for payment.canceledCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.canceled; blank sends nothing for it.

83. Event name for payment.refundedCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.refunded; blank sends nothing for it.

84. Event name for payment.partially_refundedCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.partially_refunded; blank sends nothing for it.

85. Event name for payment.dispute_openedCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.dispute_opened; blank sends nothing for it.

86. Event name for payment.dispute_updatedCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.dispute_updated; blank sends nothing for it.

87. Event name for payment.dispute_closedCopy Anchor Link

Field.

• What it does: The gateway's own name for payment.dispute_closed; blank sends nothing for it.

88. Event name for checkout.completedCopy Anchor Link

Field.

• What it does: The gateway's own name for checkout.completed; blank sends nothing for it.

89. Event name for checkout.expiredCopy Anchor Link

Field.

• What it does: The gateway's own name for checkout.expired; blank sends nothing for it.

90. Notification body templateCopy Anchor Link

Field.

• What it does: The notification body, in the template language.

91. Header # nameCopy Anchor Link

Field.

• What it does: A notification header's name.

92. Header # valueCopy Anchor Link

Field.

• What it does: Its value template, such as a signature.

93. Remove headerCopy Anchor Link

Button.

• What it does: Removes the header.

94. Add headerCopy Anchor Link

Button.

• What it does: Adds a header.

95. PreviewCopy Anchor Link

Tab.

• What it does: Shows the redirect and notification as they would be sent.

96. ReferenceCopy Anchor Link

Tab.

• What it does: Lists every value the templates can read.

97. Preview paymentCopy Anchor Link

Drop-down.

• What it does: The payment the preview uses.

98. Preview eventCopy Anchor Link

Drop-down.

• What it does: The event the preview renders.

99. Preview redirect outcomeCopy Anchor Link

Drop-down.

• What it does: The outcome the preview's redirect shows.
• Same action elsewhere: REST POST /api/v1/payments/gateways/{gatewayKey}/preview, CLI sendmock payments gateways preview, MCP sendmock_payment_gateway_preview

100. RedirectCopy Anchor Link

Heading.

• What it does: The redirect as it would be sent.

101. GET http://localhost:#/checkout/successCopy Anchor Link

Text.

• What it does: The redirect's method and URL (here a GET to the demo app).

102. NotificationCopy Anchor Link

Heading.

• What it does: The notification as it would be sent.

103. payment_intent.succeededCopy Anchor Link

Text.

• What it does: The gateway's event name for the preview event (here Stripe's).

When the data cannot loadCopy Anchor Link

104. Could not load the gateways. Try againCopy Anchor Link

Message.

• What it does: Shown when the gateways could not be loaded.
• Errors: Check SendMock is running, then press Try again.

105. Could not load the gateways.Copy Anchor Link

Text.

• What it does: The message inside the alert.

106. Try againCopy Anchor Link

Button.

• What it does: Loads them again.
• Same action elsewhere: REST GET /api/v1/payments/gateways, CLI sendmock payments gateways list, MCP sendmock_payment_gateway_list