Create Ramp checkout session
curl --request POST \
--url https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts \
--header 'API-Key: <api-key>' \
--header 'API-Nonce: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"from": {
"symbol": "USD",
"type": "fiat",
"method": "credit_card",
"amount": "100.00"
},
"to": {
"symbol": "BTC",
"type": "crypto",
"method": "Bitcoin",
"network": "Bitcoin",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": "123456"
},
"affiliate_fee_bps": "250",
"country": "US",
"subdivision": "CA",
"redirect_url": "https://example.com/checkout/success",
"failure_url": "https://example.com/checkout/failure",
"external_user_id": "user_01J0M7C0Z9F8YX3GQH8E",
"external_partner_id": "partner_456",
"external_transaction_id": "INV-2026-04-0042",
"external_metadata": "{\"order_id\":\"order_12345\"}"
}
'import requests
url = "https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts"
payload = {
"from": {
"symbol": "USD",
"type": "fiat",
"method": "credit_card",
"amount": "100.00"
},
"to": {
"symbol": "BTC",
"type": "crypto",
"method": "Bitcoin",
"network": "Bitcoin",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": "123456"
},
"affiliate_fee_bps": "250",
"country": "US",
"subdivision": "CA",
"redirect_url": "https://example.com/checkout/success",
"failure_url": "https://example.com/checkout/failure",
"external_user_id": "user_01J0M7C0Z9F8YX3GQH8E",
"external_partner_id": "partner_456",
"external_transaction_id": "INV-2026-04-0042",
"external_metadata": "{\"order_id\":\"order_12345\"}"
}
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Nonce": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Nonce': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
from: {symbol: 'USD', type: 'fiat', method: 'credit_card', amount: '100.00'},
to: {
symbol: 'BTC',
type: 'crypto',
method: 'Bitcoin',
network: 'Bitcoin',
address: 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
memo: '123456'
},
affiliate_fee_bps: '250',
country: 'US',
subdivision: 'CA',
redirect_url: 'https://example.com/checkout/success',
failure_url: 'https://example.com/checkout/failure',
external_user_id: 'user_01J0M7C0Z9F8YX3GQH8E',
external_partner_id: 'partner_456',
external_transaction_id: 'INV-2026-04-0042',
external_metadata: '{"order_id":"order_12345"}'
})
};
fetch('https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts', 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://api.services.payward.com/v1/users/{user_id}/ramp/checkouts",
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([
'from' => [
'symbol' => 'USD',
'type' => 'fiat',
'method' => 'credit_card',
'amount' => '100.00'
],
'to' => [
'symbol' => 'BTC',
'type' => 'crypto',
'method' => 'Bitcoin',
'network' => 'Bitcoin',
'address' => 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
'memo' => '123456'
],
'affiliate_fee_bps' => '250',
'country' => 'US',
'subdivision' => 'CA',
'redirect_url' => 'https://example.com/checkout/success',
'failure_url' => 'https://example.com/checkout/failure',
'external_user_id' => 'user_01J0M7C0Z9F8YX3GQH8E',
'external_partner_id' => 'partner_456',
'external_transaction_id' => 'INV-2026-04-0042',
'external_metadata' => '{"order_id":"order_12345"}'
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Nonce: <api-key>",
"API-Sign: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.services.payward.com/v1/users/{user_id}/ramp/checkouts"
payload := strings.NewReader("{\n \"from\": {\n \"symbol\": \"USD\",\n \"type\": \"fiat\",\n \"method\": \"credit_card\",\n \"amount\": \"100.00\"\n },\n \"to\": {\n \"symbol\": \"BTC\",\n \"type\": \"crypto\",\n \"method\": \"Bitcoin\",\n \"network\": \"Bitcoin\",\n \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\",\n \"memo\": \"123456\"\n },\n \"affiliate_fee_bps\": \"250\",\n \"country\": \"US\",\n \"subdivision\": \"CA\",\n \"redirect_url\": \"https://example.com/checkout/success\",\n \"failure_url\": \"https://example.com/checkout/failure\",\n \"external_user_id\": \"user_01J0M7C0Z9F8YX3GQH8E\",\n \"external_partner_id\": \"partner_456\",\n \"external_transaction_id\": \"INV-2026-04-0042\",\n \"external_metadata\": \"{\\\"order_id\\\":\\\"order_12345\\\"}\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Nonce", "<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://api.services.payward.com/v1/users/{user_id}/ramp/checkouts")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Nonce", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": {\n \"symbol\": \"USD\",\n \"type\": \"fiat\",\n \"method\": \"credit_card\",\n \"amount\": \"100.00\"\n },\n \"to\": {\n \"symbol\": \"BTC\",\n \"type\": \"crypto\",\n \"method\": \"Bitcoin\",\n \"network\": \"Bitcoin\",\n \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\",\n \"memo\": \"123456\"\n },\n \"affiliate_fee_bps\": \"250\",\n \"country\": \"US\",\n \"subdivision\": \"CA\",\n \"redirect_url\": \"https://example.com/checkout/success\",\n \"failure_url\": \"https://example.com/checkout/failure\",\n \"external_user_id\": \"user_01J0M7C0Z9F8YX3GQH8E\",\n \"external_partner_id\": \"partner_456\",\n \"external_transaction_id\": \"INV-2026-04-0042\",\n \"external_metadata\": \"{\\\"order_id\\\":\\\"order_12345\\\"}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": {\n \"symbol\": \"USD\",\n \"type\": \"fiat\",\n \"method\": \"credit_card\",\n \"amount\": \"100.00\"\n },\n \"to\": {\n \"symbol\": \"BTC\",\n \"type\": \"crypto\",\n \"method\": \"Bitcoin\",\n \"network\": \"Bitcoin\",\n \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\",\n \"memo\": \"123456\"\n },\n \"affiliate_fee_bps\": \"250\",\n \"country\": \"US\",\n \"subdivision\": \"CA\",\n \"redirect_url\": \"https://example.com/checkout/success\",\n \"failure_url\": \"https://example.com/checkout/failure\",\n \"external_user_id\": \"user_01J0M7C0Z9F8YX3GQH8E\",\n \"external_partner_id\": \"partner_456\",\n \"external_transaction_id\": \"INV-2026-04-0042\",\n \"external_metadata\": \"{\\\"order_id\\\":\\\"order_12345\\\"}\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"checkout_id": "018fdb88-4a87-73b2-9b9f-b5f38d11b924",
"checkout_url": "https://ramp.kraken.com/confirmation#checkout_id=018fdb88-4a87-73b2-9b9f-b5f38d11b924",
"expires_in": 600,
"request_data": {
"from": {
"symbol": "USD",
"type": "fiat",
"method": "credit_card",
"amount": "100.00"
},
"to": {
"symbol": "BTC",
"type": "crypto",
"method": "Bitcoin",
"network": "Bitcoin",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": "123456"
},
"affiliate_fee_bps": "250",
"country": "US",
"subdivision": "CA",
"redirect_url": "https://example.com/checkout/success",
"failure_url": "https://example.com/checkout/failure",
"external_user_id": "user_01J0M7C0Z9F8YX3GQH8E",
"external_partner_id": "partner_456",
"external_transaction_id": "INV-2026-04-0042",
"external_metadata": "{\"order_id\":\"order_12345\"}"
}
}
}{
"error": {
"type": "validation_error",
"status": 400,
"instance": "req_123",
"code": "bad_request"
}
}{
"error": {
"type": "authentication_error",
"status": 401,
"instance": "req_123",
"code": "unauthenticated"
}
}{
"error": {
"type": "authorization_error",
"status": 403,
"instance": "req_123",
"code": "forbidden"
}
}{
"error": {
"type": "rate_limit_error",
"status": 429,
"instance": "req_123",
"code": "resource_exhausted"
}
}{
"error": {
"type": "internal_error",
"status": 500,
"instance": "req_123",
"code": "internal"
}
}{
"error": {
"type": "api_error",
"status": 501,
"instance": "req_123",
"code": "unimplemented"
}
}{
"error": {
"type": "service_error",
"status": 503,
"instance": "req_123",
"code": "unavailable"
}
}{
"error": {
"type": "service_error",
"status": 504,
"instance": "req_123",
"code": "deadline_exceeded"
}
}Ramp
Create Ramp checkout session
Creates a Ramp checkout for a selected user and returns the widget redirect URL with the checkout UUID in the fragment. No access token is minted here; the widget mints it via the bootstrap call (BootstrapRampCheckout). The URL must still be treated as sensitive — the UUID is a capability handle.
For loginless SEPA checkouts, submit from.method = "sepa", from.symbol = "EUR", and an EEA country.
POST
/
v1
/
users
/
{user_id}
/
ramp
/
checkouts
Create Ramp checkout session
curl --request POST \
--url https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts \
--header 'API-Key: <api-key>' \
--header 'API-Nonce: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"from": {
"symbol": "USD",
"type": "fiat",
"method": "credit_card",
"amount": "100.00"
},
"to": {
"symbol": "BTC",
"type": "crypto",
"method": "Bitcoin",
"network": "Bitcoin",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": "123456"
},
"affiliate_fee_bps": "250",
"country": "US",
"subdivision": "CA",
"redirect_url": "https://example.com/checkout/success",
"failure_url": "https://example.com/checkout/failure",
"external_user_id": "user_01J0M7C0Z9F8YX3GQH8E",
"external_partner_id": "partner_456",
"external_transaction_id": "INV-2026-04-0042",
"external_metadata": "{\"order_id\":\"order_12345\"}"
}
'import requests
url = "https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts"
payload = {
"from": {
"symbol": "USD",
"type": "fiat",
"method": "credit_card",
"amount": "100.00"
},
"to": {
"symbol": "BTC",
"type": "crypto",
"method": "Bitcoin",
"network": "Bitcoin",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": "123456"
},
"affiliate_fee_bps": "250",
"country": "US",
"subdivision": "CA",
"redirect_url": "https://example.com/checkout/success",
"failure_url": "https://example.com/checkout/failure",
"external_user_id": "user_01J0M7C0Z9F8YX3GQH8E",
"external_partner_id": "partner_456",
"external_transaction_id": "INV-2026-04-0042",
"external_metadata": "{\"order_id\":\"order_12345\"}"
}
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Nonce": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Nonce': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
from: {symbol: 'USD', type: 'fiat', method: 'credit_card', amount: '100.00'},
to: {
symbol: 'BTC',
type: 'crypto',
method: 'Bitcoin',
network: 'Bitcoin',
address: 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
memo: '123456'
},
affiliate_fee_bps: '250',
country: 'US',
subdivision: 'CA',
redirect_url: 'https://example.com/checkout/success',
failure_url: 'https://example.com/checkout/failure',
external_user_id: 'user_01J0M7C0Z9F8YX3GQH8E',
external_partner_id: 'partner_456',
external_transaction_id: 'INV-2026-04-0042',
external_metadata: '{"order_id":"order_12345"}'
})
};
fetch('https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts', 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://api.services.payward.com/v1/users/{user_id}/ramp/checkouts",
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([
'from' => [
'symbol' => 'USD',
'type' => 'fiat',
'method' => 'credit_card',
'amount' => '100.00'
],
'to' => [
'symbol' => 'BTC',
'type' => 'crypto',
'method' => 'Bitcoin',
'network' => 'Bitcoin',
'address' => 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
'memo' => '123456'
],
'affiliate_fee_bps' => '250',
'country' => 'US',
'subdivision' => 'CA',
'redirect_url' => 'https://example.com/checkout/success',
'failure_url' => 'https://example.com/checkout/failure',
'external_user_id' => 'user_01J0M7C0Z9F8YX3GQH8E',
'external_partner_id' => 'partner_456',
'external_transaction_id' => 'INV-2026-04-0042',
'external_metadata' => '{"order_id":"order_12345"}'
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Nonce: <api-key>",
"API-Sign: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.services.payward.com/v1/users/{user_id}/ramp/checkouts"
payload := strings.NewReader("{\n \"from\": {\n \"symbol\": \"USD\",\n \"type\": \"fiat\",\n \"method\": \"credit_card\",\n \"amount\": \"100.00\"\n },\n \"to\": {\n \"symbol\": \"BTC\",\n \"type\": \"crypto\",\n \"method\": \"Bitcoin\",\n \"network\": \"Bitcoin\",\n \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\",\n \"memo\": \"123456\"\n },\n \"affiliate_fee_bps\": \"250\",\n \"country\": \"US\",\n \"subdivision\": \"CA\",\n \"redirect_url\": \"https://example.com/checkout/success\",\n \"failure_url\": \"https://example.com/checkout/failure\",\n \"external_user_id\": \"user_01J0M7C0Z9F8YX3GQH8E\",\n \"external_partner_id\": \"partner_456\",\n \"external_transaction_id\": \"INV-2026-04-0042\",\n \"external_metadata\": \"{\\\"order_id\\\":\\\"order_12345\\\"}\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Nonce", "<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://api.services.payward.com/v1/users/{user_id}/ramp/checkouts")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Nonce", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": {\n \"symbol\": \"USD\",\n \"type\": \"fiat\",\n \"method\": \"credit_card\",\n \"amount\": \"100.00\"\n },\n \"to\": {\n \"symbol\": \"BTC\",\n \"type\": \"crypto\",\n \"method\": \"Bitcoin\",\n \"network\": \"Bitcoin\",\n \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\",\n \"memo\": \"123456\"\n },\n \"affiliate_fee_bps\": \"250\",\n \"country\": \"US\",\n \"subdivision\": \"CA\",\n \"redirect_url\": \"https://example.com/checkout/success\",\n \"failure_url\": \"https://example.com/checkout/failure\",\n \"external_user_id\": \"user_01J0M7C0Z9F8YX3GQH8E\",\n \"external_partner_id\": \"partner_456\",\n \"external_transaction_id\": \"INV-2026-04-0042\",\n \"external_metadata\": \"{\\\"order_id\\\":\\\"order_12345\\\"}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.services.payward.com/v1/users/{user_id}/ramp/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": {\n \"symbol\": \"USD\",\n \"type\": \"fiat\",\n \"method\": \"credit_card\",\n \"amount\": \"100.00\"\n },\n \"to\": {\n \"symbol\": \"BTC\",\n \"type\": \"crypto\",\n \"method\": \"Bitcoin\",\n \"network\": \"Bitcoin\",\n \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\",\n \"memo\": \"123456\"\n },\n \"affiliate_fee_bps\": \"250\",\n \"country\": \"US\",\n \"subdivision\": \"CA\",\n \"redirect_url\": \"https://example.com/checkout/success\",\n \"failure_url\": \"https://example.com/checkout/failure\",\n \"external_user_id\": \"user_01J0M7C0Z9F8YX3GQH8E\",\n \"external_partner_id\": \"partner_456\",\n \"external_transaction_id\": \"INV-2026-04-0042\",\n \"external_metadata\": \"{\\\"order_id\\\":\\\"order_12345\\\"}\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"checkout_id": "018fdb88-4a87-73b2-9b9f-b5f38d11b924",
"checkout_url": "https://ramp.kraken.com/confirmation#checkout_id=018fdb88-4a87-73b2-9b9f-b5f38d11b924",
"expires_in": 600,
"request_data": {
"from": {
"symbol": "USD",
"type": "fiat",
"method": "credit_card",
"amount": "100.00"
},
"to": {
"symbol": "BTC",
"type": "crypto",
"method": "Bitcoin",
"network": "Bitcoin",
"address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"memo": "123456"
},
"affiliate_fee_bps": "250",
"country": "US",
"subdivision": "CA",
"redirect_url": "https://example.com/checkout/success",
"failure_url": "https://example.com/checkout/failure",
"external_user_id": "user_01J0M7C0Z9F8YX3GQH8E",
"external_partner_id": "partner_456",
"external_transaction_id": "INV-2026-04-0042",
"external_metadata": "{\"order_id\":\"order_12345\"}"
}
}
}{
"error": {
"type": "validation_error",
"status": 400,
"instance": "req_123",
"code": "bad_request"
}
}{
"error": {
"type": "authentication_error",
"status": 401,
"instance": "req_123",
"code": "unauthenticated"
}
}{
"error": {
"type": "authorization_error",
"status": 403,
"instance": "req_123",
"code": "forbidden"
}
}{
"error": {
"type": "rate_limit_error",
"status": 429,
"instance": "req_123",
"code": "resource_exhausted"
}
}{
"error": {
"type": "internal_error",
"status": 500,
"instance": "req_123",
"code": "internal"
}
}{
"error": {
"type": "api_error",
"status": 501,
"instance": "req_123",
"code": "unimplemented"
}
}{
"error": {
"type": "service_error",
"status": 503,
"instance": "req_123",
"code": "unavailable"
}
}{
"error": {
"type": "service_error",
"status": 504,
"instance": "req_123",
"code": "deadline_exceeded"
}
}Authorizations
Your public API key. Identifies the partner making the request.
HMAC signature over the request, computed with your private key.
Monotonically increasing nonce included in the request signature.
Headers
Client-generated canonical UUIDv4 that uniquely identifies a request for safe retries.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Example:
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Globally unique public identifier for a user.
Required string length:
14 - 42Body
application/json
Request to create a token-bound Ramp checkout session.
The from/to pairing determines the Ramp direction. Only on-ramp (from fiat, to crypto or stablecoin) is currently supported; other pairings are rejected with 400 BadRequest. For loginless SEPA checkouts, submit from.method = "sepa", from.symbol = "EUR", and an EEA country.
Source side of the checkout — the asset the user pays with.
Show child attributes
Show child attributes
Destination side of the checkout — the asset the user receives.
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code. Use GET /v1/ramp/countries to discover supported values.
Required string length:
2Pattern:
^[A-Za-z]{2}$Affiliate fee in basis points to attribute to the partner (0-10000 where 100 = 1%).
Required string length:
1 - 5Pattern:
^(10000|[0-9]{1,4})$ISO 3166-2 subdivision code suffix (e.g., CA for California when country is US). Use GET /v1/ramp/countries to discover supported values.
Required string length:
1 - 64Pattern:
^[A-Za-z0-9-]+$URL to redirect the user after completing checkout successfully.
Required string length:
1 - 255URL to redirect the user after a failed checkout.
Required string length:
1 - 255Optional partner-supplied user identifier.
Required string length:
1 - 64Optional partner-supplied partner identifier.
Required string length:
1 - 64Optional partner transaction identifier.
Required string length:
1 - 64Optional metadata to store alongside the checkout.
Required string length:
1 - 1000Response
Successful response
Created checkout session details.
Show child attributes
Show child attributes