Get wallet approval options

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options', 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.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "options": [
    {
      "optionId": "opt_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "source": {
        "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
        "network": "base",
        "asset": "usdc"
      },
      "payloads": [
        {
          "payloadId": "payload_af2937b0-9846-4fe7-bfe9-ccc22d935114",
          "type": "eip2612",
          "data": {
            "types": {
              "EIP712Domain": [
                {
                  "name": "name",
                  "type": "string"
                },
                {
                  "name": "version",
                  "type": "string"
                },
                {
                  "name": "chainId",
                  "type": "uint256"
                },
                {
                  "name": "verifyingContract",
                  "type": "address"
                }
              ],
              "Permit": [
                {
                  "name": "owner",
                  "type": "address"
                },
                {
                  "name": "spender",
                  "type": "address"
                },
                {
                  "name": "value",
                  "type": "uint256"
                },
                {
                  "name": "nonce",
                  "type": "uint256"
                },
                {
                  "name": "deadline",
                  "type": "uint256"
                }
              ]
            },
            "primaryType": "Permit",
            "domain": {
              "name": "USD Coin",
              "version": "2",
              "chainId": 8453,
              "verifyingContract": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
            },
            "message": {
              "owner": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
              "spender": "0x9Fb909eA400c2b8D99Be292DADf07e63B814527c",
              "value": "115792089237316195423570985008687907853269984665640564039457584007913129639935",
              "nonce": "0",
              "deadline": "1798761600"
            }
          }
        }
      ]
    }
  ],
  "ineligibleAddresses": []
}

Mandates

Get wallet approval options

Returns the available wallet approval options for a mandate. The mandate must be in created or approval_failed status, not expired, and have no approval or revocation in flight.

Provide one or more customer wallet addresses as query parameters. Each option specifies the network, asset, and payloads the customer must sign to approve the mandate. Present the options to the customer and let them choose one, then call Approve a mandate with a wallet with the selected option and its signed payloads.

This is a stateless read operation and does not modify the mandate. The payloads embed fresh on-chain signing data such as a nonce and deadline, so sign and submit the payloads from a single response rather than caching them.

If a requested address has no eligible approval options, it appears in ineligibleAddresses with a code and message instead of being absent from options.

GET

mandates

{mandateId}

approvals

wallet

options

Get wallet approval options

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options', 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.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/wallet/options")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "options": [
    {
      "optionId": "opt_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "source": {
        "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
        "network": "base",
        "asset": "usdc"
      },
      "payloads": [
        {
          "payloadId": "payload_af2937b0-9846-4fe7-bfe9-ccc22d935114",
          "type": "eip2612",
          "data": {
            "types": {
              "EIP712Domain": [
                {
                  "name": "name",
                  "type": "string"
                },
                {
                  "name": "version",
                  "type": "string"
                },
                {
                  "name": "chainId",
                  "type": "uint256"
                },
                {
                  "name": "verifyingContract",
                  "type": "address"
                }
              ],
              "Permit": [
                {
                  "name": "owner",
                  "type": "address"
                },
                {
                  "name": "spender",
                  "type": "address"
                },
                {
                  "name": "value",
                  "type": "uint256"
                },
                {
                  "name": "nonce",
                  "type": "uint256"
                },
                {
                  "name": "deadline",
                  "type": "uint256"
                }
              ]
            },
            "primaryType": "Permit",
            "domain": {
              "name": "USD Coin",
              "version": "2",
              "chainId": 8453,
              "verifyingContract": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
            },
            "message": {
              "owner": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
              "spender": "0x9Fb909eA400c2b8D99Be292DADf07e63B814527c",
              "value": "115792089237316195423570985008687907853269984665640564039457584007913129639935",
              "nonce": "0",
              "deadline": "1798761600"
            }
          }
        }
      ]
    }
  ],
  "ineligibleAddresses": []
}

Path Parameters

mandateId

string

required

The unique identifier of the mandate. The ID of the mandate, a UUID prefixed by mandate_.

Pattern: ^mandate_[a-f0-9\-]{36}$

Example:

"mandate_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

Query Parameters

addresses

string[]

required

The customer's wallet addresses to generate approval options for. Provide between 1 and 5 unique addresses, comma-separated (e.g. ?addresses=0xA,0xB). Each returned option's source.address identifies which requested address it applies to. If a requested address has no eligible approval options, it appears in ineligibleAddresses with a code explaining why.

Required array length: 1 - 5 elements

A blockchain address. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana).

Required string length: 1 - 128

network

enum<string>

Optional filter to restrict options to a specific blockchain network. The blockchain network supported for payment session sources. Testnet networks are only available in sandbox environments.

Available options:

arbitrum,

arbitrum-sepolia,

avalanche,

base,

base-sepolia,

ethereum,

ethereum-sepolia,

optimism,

optimism-sepolia,

polygon,

polygon-amoy,

solana,

solana-devnet

Example:

"base"

asset

string

Filter options by asset. Currently, only usdc and usdt return results. The symbol of the asset (e.g., eth, usd, usdc, usdt).

Required string length: 1 - 42

Example:

"usd"

Response

Successfully retrieved mandate wallet approval options.

The available options for approving this mandate on a wallet source, one per eligible asset the address can back. Present them to the customer, have them sign the chosen option's payloads, then call Approve a mandate with a wallet. Requested addresses with no eligible option appear in ineligibleAddresses with a code explaining why. This is a stateless read operation and does not modify the mandate.

options

Wallet Mandate Approval Option · object[]

required

The available wallet mandate approval options.

Show child attributes

Example:

[
  {
    "optionId": "opt_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "source": {
      "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
      "network": "base",
      "asset": "usdc"
    },
    "payloads": [
      {
        "payloadId": "payload_af2937b0-9846-4fe7-bfe9-ccc22d935114",
        "type": "eip2612",
        "data": {
          "types": {
            "EIP712Domain": [
              { "name": "name", "type": "string" },
              { "name": "version", "type": "string" },
              { "name": "chainId", "type": "uint256" },
              {
                "name": "verifyingContract",
                "type": "address"
              }
            ],
            "Permit": [
              { "name": "owner", "type": "address" },
              { "name": "spender", "type": "address" },
              { "name": "value", "type": "uint256" },
              { "name": "nonce", "type": "uint256" },
              { "name": "deadline", "type": "uint256" }
            ]
          },
          "primaryType": "Permit",
          "domain": {
            "name": "USD Coin",
            "version": "2",
            "chainId": 8453,
            "verifyingContract": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
          },
          "message": {
            "owner": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
            "spender": "0x9Fb909eA400c2b8D99Be292DADf07e63B814527c",
            "value": "115792089237316195423570985008687907853269984665640564039457584007913129639935",
            "nonce": "0",
            "deadline": "1798761600"
          }
        }
      }
    ]
  }
]

ineligibleAddresses

Ineligible Wallet Mandate Approval Addresses · object[]

required

Requested customer addresses that have no eligible mandate approval option, each with a code explaining why. Empty when every requested address can approve the mandate.

Show child attributes

Example:

[]

CDP API

REST API

Get wallet approval options

Path Parameters

Query Parameters

Response