Create Offramp Session

curl --request POST \
  --url https://staging.crossmint.com/api/unstable/offramp-sessions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "payer": {
    "address": "<string>",
    "chain": "<string>"
  },
  "receiptEmail": "jsmith@example.com",
  "userLocator": "<string>"
}
'

import requests

url = "https://staging.crossmint.com/api/unstable/offramp-sessions"

payload = {
    "payer": {
        "address": "<string>",
        "chain": "<string>"
    },
    "receiptEmail": "jsmith@example.com",
    "userLocator": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payer: {address: '<string>', chain: '<string>'},
    receiptEmail: 'jsmith@example.com',
    userLocator: '<string>'
  })
};

fetch('https://staging.crossmint.com/api/unstable/offramp-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.crossmint.com/api/unstable/offramp-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payer' => [
        'address' => '<string>',
        'chain' => '<string>'
    ],
    'receiptEmail' => 'jsmith@example.com',
    'userLocator' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.crossmint.com/api/unstable/offramp-sessions"

	payload := strings.NewReader("{\n  \"payer\": {\n    \"address\": \"<string>\",\n    \"chain\": \"<string>\"\n  },\n  \"receiptEmail\": \"jsmith@example.com\",\n  \"userLocator\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://staging.crossmint.com/api/unstable/offramp-sessions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payer\": {\n    \"address\": \"<string>\",\n    \"chain\": \"<string>\"\n  },\n  \"receiptEmail\": \"jsmith@example.com\",\n  \"userLocator\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/unstable/offramp-sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payer\": {\n    \"address\": \"<string>\",\n    \"chain\": \"<string>\"\n  },\n  \"receiptEmail\": \"jsmith@example.com\",\n  \"userLocator\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "clientSecret": "<string>",
  "expiresAt": "2024-01-15T10:30:00.000Z",
  "sessionId": "<string>"
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

POST

unstable

offramp-sessions

Create Offramp Session

curl --request POST \
  --url https://staging.crossmint.com/api/unstable/offramp-sessions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "payer": {
    "address": "<string>",
    "chain": "<string>"
  },
  "receiptEmail": "jsmith@example.com",
  "userLocator": "<string>"
}
'

import requests

url = "https://staging.crossmint.com/api/unstable/offramp-sessions"

payload = {
    "payer": {
        "address": "<string>",
        "chain": "<string>"
    },
    "receiptEmail": "jsmith@example.com",
    "userLocator": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payer: {address: '<string>', chain: '<string>'},
    receiptEmail: 'jsmith@example.com',
    userLocator: '<string>'
  })
};

fetch('https://staging.crossmint.com/api/unstable/offramp-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.crossmint.com/api/unstable/offramp-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payer' => [
        'address' => '<string>',
        'chain' => '<string>'
    ],
    'receiptEmail' => 'jsmith@example.com',
    'userLocator' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.crossmint.com/api/unstable/offramp-sessions"

	payload := strings.NewReader("{\n  \"payer\": {\n    \"address\": \"<string>\",\n    \"chain\": \"<string>\"\n  },\n  \"receiptEmail\": \"jsmith@example.com\",\n  \"userLocator\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://staging.crossmint.com/api/unstable/offramp-sessions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payer\": {\n    \"address\": \"<string>\",\n    \"chain\": \"<string>\"\n  },\n  \"receiptEmail\": \"jsmith@example.com\",\n  \"userLocator\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/unstable/offramp-sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payer\": {\n    \"address\": \"<string>\",\n    \"chain\": \"<string>\"\n  },\n  \"receiptEmail\": \"jsmith@example.com\",\n  \"userLocator\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "clientSecret": "<string>",
  "expiresAt": "2024-01-15T10:30:00.000Z",
  "sessionId": "<string>"
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

{
  "error": true,
  "message": "<string>",
  "code": "<string>",
  "parameters": {}
}

This endpoint needs a server API key. In production, the project needs offramp enabled. See Going to production.

Authorizations

X-API-KEY

string

header

required

API key required for authentication

Body

application/json

payer

object

required

Show child attributes

receiptEmail

string<email>

required

Where the withdrawal receipt is sent. A reused session keeps the address it was created with.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

userLocator

string

required

The user who withdraws, as userId:<id>. Email and phone locators are refused.

Minimum string length: 1

Response

The session. The same open session is returned for the same user and wallet until it is used or expires.

clientSecret

string

required

The session token. Pass it to the component as credentials.clientSecret.

expiresAt

string<date-time>

required

When the session stops accepting new withdrawals, in ISO 8601 format. Status tracking continues for 24 hours.

Example:

"2024-01-15T10:30:00.000Z"

sessionId

string

required

The session id. Pass it to the component as credentials.sessionId.

Introduction

Quickstarts ⚡

Concepts

Guides

API Reference

Create Offramp Session

Authorizations

Body

Response