/api/v1/payments/gatewaysGateways with their checkout, redirect and notification setup.
sendmock payments gateways listsendmock_payment_gateway_list200 PaymentGatewayDefinition[]
/api/v1/payments/gatewaysAdd a custom gateway.
sendmock payments gateways createsendmock_payment_gateway_createPaymentGatewayCreateRequest : Body of POST /api/v1/payments/gateways.
| Field | Type | Description |
|---|---|---|
| name | string | The new gateway's name.Example: Upay |
| key | string | Its key in the API and in /providers/<key>/... paths; lowercase, fixed after creation.Example: upay |
| start_from | string | null | A gateway to copy (methods, redirect and notification), or null for blank.Example: bkash |
201 PaymentGatewayDefinition
Errors: 400, as { error: { code, message } }
/api/v1/payments/gateways/{gatewayKey}One gateway definition; secret credentials masked.
sendmock payments gateways show <gatewayKey>sendmock_payment_gateway_get200 PaymentGatewayDefinition
Errors: 404, as { error: { code, message } }
/api/v1/payments/gateways/{gatewayKey}Change a gateway; secret credentials stay masked.
sendmock payments gateways update <gatewayKey>sendmock_payment_gateway_updatePaymentGatewayInput : Body of PATCH /api/v1/payments/gateways/{gatewayKey}; the key is fixed.
| Field | Type | Description |
|---|---|---|
| key | string | The provider value in the API and in /providers/<key>/... paths.Example: upay |
| name | string | The gateway's name, shown on checkout pages.Example: Upay |
| accent | string | #rrggbb, used on its checkout pages.Example: #e2136e |
| is_enabled | boolean | Off gateways reject new checkouts.Example: true |
| method_keys | string[] | The methods its checkout offers, in order. |
| credentials | GatewayCredential[] | The merchant credentials your app is configured with. |
| notification_endpoint_id | Ulid | null | The webhook endpoint its IPN or webhook deliveries go to.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| redirect_method | "GET" | "POST" | How the browser returns to your app: GET (query string) or POST (form).One of: GET, POSTExample: POST |
| redirect_fields | GatewayRedirectField[] | The parameters sent to your app on redirect. |
| notification_content_type | "json" | "form" | How the IPN or webhook body is sent: json or form.One of: json, formExample: json |
| event_names | object | The gateway's name for each native event; blank sends nothing. |
| notification_body | string | The notification body, a template over the payment and the event.Example: {"status": "{{ event.name }}", "txn_id": "{{ payment.reference }}"} |
| notification_headers | GatewayHeaderTemplate[] | Headers sent with each notification. |
200 PaymentGatewayDefinition
Errors: 400, 404, as { error: { code, message } }
/api/v1/payments/gateways/{gatewayKey}Delete a custom gateway; 409 while payments use it.
sendmock payments gateways delete <gatewayKey>sendmock_payment_gateway_delete204 No content
Errors: 404, 409, as { error: { code, message } }
/api/v1/payments/gateways/{gatewayKey}/resetPut a built-in gateway back as shipped.
sendmock payments gateways reset <gatewayKey>sendmock_payment_gateway_reset200 PaymentGatewayDefinition
Errors: 404, 409, as { error: { code, message } }
/api/v1/payments/gateways/{gatewayKey}/previewRender a gateway's redirect and notification for a payment.
sendmock payments gateways preview <gatewayKey>sendmock_payment_gateway_previewPaymentGatewayPreviewRequest : Body of POST /api/v1/payments/gateways/{gatewayKey}/preview.
| Field | Type | Description |
|---|---|---|
| gateway | PaymentGatewayInput | The gateway settings to render, saved or not. |
| payment_id? | Ulid | The payment to render against; the newest one when left out.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| event_type | PaymentEventType | The native event to render the notification for.One of: payment.created, payment.authorized, payment.succeeded, payment.failed, payment.canceled, payment.refunded, payment.partially_refunded, payment.dispute_opened, payment.dispute_updated, payment.dispute_closed, checkout.completed, checkout.expiredExample: payment.succeeded |
| redirect_outcome | "success" | "fail" | "cancel" | The redirect to render: success, fail or cancel.One of: success, fail, cancelExample: success |
200 PaymentGatewayPreview
/api/v1/payments/gateways/{gatewayKey}/credentials/{credentialName}Reveal one secret credential (asked for after a confirmation).
sendmock payments gateways credential <gatewayKey> <credentialName> --reveal200 GatewayCredentialReveal
Errors: 404, as { error: { code, message } }