HTTP API reference › GalaSwap DEX › onramper
GalaSwap DEX — onramper
Source commit: unknown. Generated: 2026-10-26T22:08:07.607Z.
1 operation in this group.
- POST /api/v1/onramper/generate-widget-url — Generate an Onramper widget URL
POST /api/v1/onramper/generate-widget-url
OnramperController_generateWidgetUrl
Generate an Onramper widget URL
Creates a widget URL for the requested wallet and payment configuration.
Security: []
Request body
Required: yes
application/json
Schema: GenerateWidgetUrlDto
| Field | Type | Required | Description |
|---|---|---|---|
| walletAddress | string | yes | Wallet receiving the purchased or swapped crypto. |
| mode | string enum: buy, sell, swap | no | Widget transaction mode. |
| defaultFiat | string | no | Fiat currency code. |
| defaultAmount | number | no | Default fiat amount. |
| sellDefaultAmount | number | no | Default crypto amount for sell mode. |
| onlyCryptoNetworks | string | no | Allowed crypto network identifiers. |
| defaultPaymentMethod | string | no | Default payment method. |
| defaultCrypto | string | no | Default crypto ticker. |
| onlyPaymentMethods | string | no | Allowlisted payment methods. |
| excludePaymentMethods | string | no | Payment methods excluded from the widget. |
| onlyFiat | string | no | Allowlisted fiat currencies. |
| excludeFiat | string | no | Fiat currencies excluded from the widget. |
| isAddressEditable | string | no | Whether the user can edit the wallet address, encoded as a string. |
| networkPrefix | string | no | Onramper network prefix. |
Responses
200 — Widget URL generated.
Content type: application/json
Schema: GenerateWidgetUrlResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
| status | number | yes | |
| error | boolean | yes | |
| message | string | yes | |
| data | GenerateWidgetUrlDataDto | yes |
default — An error response using the shared backend error envelope.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| status | integer | yes | |
| error | boolean | yes | |
| message | string | yes | |
| errorKey | string | no |
Example request
[]
Example response
[]