Create a crypto widget

post

https://api-sb.meld.io/crypto/session/widget

Use this endpoint to create a crypto widget for a session to buy or sell crypto.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

bypassKyc

boolean

When true, the system will automatically look up the customer's KYC status and generate a share token if KYC is approved. Requires a valid customerId or externalCustomerId.

customerId

string

Meld generated unique identifier for your customer. This should be used to track customer activity.

externalCustomerId

string

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity.

externalSessionId

string

Your reference id for your widget session, if you use this optional field you must pass in a unique value each time

externalSubaccountCustomerId

string

Optional external identifier for the sub-account customer this transaction belongs to. Used for tracking when multiple businesses operate under one Meld account. A sub-account customer must be created first before it can be referenced.

sessionData

required

Data related to the session

sessionType

string

enum

required

The type of widget session to create

Allowed:

subaccountCustomerId

string

Optional Meld customer id used to track the business sub-account this transaction belongs to when multiple businesses operate under one Meld account.

Responses

400

Bad Request : check request values and format

401

Invalid credentials

403

Unauthenticated or authenticated with insufficient access

500

Server Error. This applies to all 5xx errors, including but not limited to 500, 501, 502, 503, and 504 errors. You should treat all of these errors the same.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Widget created