Step 2 - Set shipping address
curl --request POST \
--url https://api-beta.pepay.io/api/commerce/merchant/checkout/address \
--header 'Content-Type: application/json' \
--header 'x-commerce-api-key: <api-key>' \
--data '
{
"customer_id": "cust_123456",
"estimateId": "550e8400-e29b-41d4-a716-446655440000",
"address": {
"first_name": "Jane",
"last_name": "Doe",
"street_address": "123 Main St",
"address_line2": "Apt 4B",
"city": "Miami",
"state": "FL",
"zip_code": "33101",
"country": "US",
"phone": "+13055550123",
"email": "jane@example.com"
}
}
'import requests
url = "https://api-beta.pepay.io/api/commerce/merchant/checkout/address"
payload = {
"customer_id": "cust_123456",
"estimateId": "550e8400-e29b-41d4-a716-446655440000",
"address": {
"first_name": "Jane",
"last_name": "Doe",
"street_address": "123 Main St",
"address_line2": "Apt 4B",
"city": "Miami",
"state": "FL",
"zip_code": "33101",
"country": "US",
"phone": "+13055550123",
"email": "jane@example.com"
}
}
headers = {
"x-commerce-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-commerce-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: 'cust_123456',
estimateId: '550e8400-e29b-41d4-a716-446655440000',
address: {
first_name: 'Jane',
last_name: 'Doe',
street_address: '123 Main St',
address_line2: 'Apt 4B',
city: 'Miami',
state: 'FL',
zip_code: '33101',
country: 'US',
phone: '+13055550123',
email: 'jane@example.com'
}
})
};
fetch('https://api-beta.pepay.io/api/commerce/merchant/checkout/address', 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-beta.pepay.io/api/commerce/merchant/checkout/address",
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([
'customer_id' => 'cust_123456',
'estimateId' => '550e8400-e29b-41d4-a716-446655440000',
'address' => [
'first_name' => 'Jane',
'last_name' => 'Doe',
'street_address' => '123 Main St',
'address_line2' => 'Apt 4B',
'city' => 'Miami',
'state' => 'FL',
'zip_code' => '33101',
'country' => 'US',
'phone' => '+13055550123',
'email' => 'jane@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-commerce-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://api-beta.pepay.io/api/commerce/merchant/checkout/address"
payload := strings.NewReader("{\n \"customer_id\": \"cust_123456\",\n \"estimateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"street_address\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zip_code\": \"33101\",\n \"country\": \"US\",\n \"phone\": \"+13055550123\",\n \"email\": \"jane@example.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-commerce-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://api-beta.pepay.io/api/commerce/merchant/checkout/address")
.header("x-commerce-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"cust_123456\",\n \"estimateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"street_address\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zip_code\": \"33101\",\n \"country\": \"US\",\n \"phone\": \"+13055550123\",\n \"email\": \"jane@example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-beta.pepay.io/api/commerce/merchant/checkout/address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-commerce-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"cust_123456\",\n \"estimateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"street_address\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zip_code\": \"33101\",\n \"country\": \"US\",\n \"phone\": \"+13055550123\",\n \"email\": \"jane@example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"addressId": "550e8400-e29b-41d4-a716-446655440222",
"validated": true,
"standardized": {
"first_name": "Jane",
"last_name": "Doe",
"street_address": "123 Main St",
"address_line2": "Apt 4B",
"city": "Miami",
"state": "FL",
"zip_code": "33101",
"country": "US",
"phone": "+13055550123",
"email": "jane@example.com"
},
"shippingOptions": [
{
"id": "standard",
"name": "Standard Shipping",
"price": 5.99,
"estimatedDays": "5-7 business days"
}
]
}
}Commerce
Step 2 - Set shipping address
Sets and validates shipping address for the order. Requires a valid estimate ID from step 1.
POST
/
api
/
commerce
/
merchant
/
checkout
/
address
Step 2 - Set shipping address
curl --request POST \
--url https://api-beta.pepay.io/api/commerce/merchant/checkout/address \
--header 'Content-Type: application/json' \
--header 'x-commerce-api-key: <api-key>' \
--data '
{
"customer_id": "cust_123456",
"estimateId": "550e8400-e29b-41d4-a716-446655440000",
"address": {
"first_name": "Jane",
"last_name": "Doe",
"street_address": "123 Main St",
"address_line2": "Apt 4B",
"city": "Miami",
"state": "FL",
"zip_code": "33101",
"country": "US",
"phone": "+13055550123",
"email": "jane@example.com"
}
}
'import requests
url = "https://api-beta.pepay.io/api/commerce/merchant/checkout/address"
payload = {
"customer_id": "cust_123456",
"estimateId": "550e8400-e29b-41d4-a716-446655440000",
"address": {
"first_name": "Jane",
"last_name": "Doe",
"street_address": "123 Main St",
"address_line2": "Apt 4B",
"city": "Miami",
"state": "FL",
"zip_code": "33101",
"country": "US",
"phone": "+13055550123",
"email": "jane@example.com"
}
}
headers = {
"x-commerce-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-commerce-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: 'cust_123456',
estimateId: '550e8400-e29b-41d4-a716-446655440000',
address: {
first_name: 'Jane',
last_name: 'Doe',
street_address: '123 Main St',
address_line2: 'Apt 4B',
city: 'Miami',
state: 'FL',
zip_code: '33101',
country: 'US',
phone: '+13055550123',
email: 'jane@example.com'
}
})
};
fetch('https://api-beta.pepay.io/api/commerce/merchant/checkout/address', 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-beta.pepay.io/api/commerce/merchant/checkout/address",
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([
'customer_id' => 'cust_123456',
'estimateId' => '550e8400-e29b-41d4-a716-446655440000',
'address' => [
'first_name' => 'Jane',
'last_name' => 'Doe',
'street_address' => '123 Main St',
'address_line2' => 'Apt 4B',
'city' => 'Miami',
'state' => 'FL',
'zip_code' => '33101',
'country' => 'US',
'phone' => '+13055550123',
'email' => 'jane@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-commerce-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://api-beta.pepay.io/api/commerce/merchant/checkout/address"
payload := strings.NewReader("{\n \"customer_id\": \"cust_123456\",\n \"estimateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"street_address\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zip_code\": \"33101\",\n \"country\": \"US\",\n \"phone\": \"+13055550123\",\n \"email\": \"jane@example.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-commerce-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://api-beta.pepay.io/api/commerce/merchant/checkout/address")
.header("x-commerce-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"cust_123456\",\n \"estimateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"street_address\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zip_code\": \"33101\",\n \"country\": \"US\",\n \"phone\": \"+13055550123\",\n \"email\": \"jane@example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-beta.pepay.io/api/commerce/merchant/checkout/address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-commerce-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"cust_123456\",\n \"estimateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"street_address\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zip_code\": \"33101\",\n \"country\": \"US\",\n \"phone\": \"+13055550123\",\n \"email\": \"jane@example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"addressId": "550e8400-e29b-41d4-a716-446655440222",
"validated": true,
"standardized": {
"first_name": "Jane",
"last_name": "Doe",
"street_address": "123 Main St",
"address_line2": "Apt 4B",
"city": "Miami",
"state": "FL",
"zip_code": "33101",
"country": "US",
"phone": "+13055550123",
"email": "jane@example.com"
},
"shippingOptions": [
{
"id": "standard",
"name": "Standard Shipping",
"price": 5.99,
"estimatedDays": "5-7 business days"
}
]
}
}Authorizations
commerceApiKeymerchantApiKey
Legacy alias for commerce-scoped API keys. Prefer x-api-key with scope=commerce.
Body
application/json
Was this page helpful?
⌘I

