Get a mandate approval - Coinbase Developer Documentation

Get a mandate approval

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

import requests

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

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/{approvalId}', 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/{approvalId}",
  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/{approvalId}"

	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/{approvalId}")

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

{
  "approvalId": "approval_5f0e9d8c-7b6a-4321-fedc-ba0987654321",
  "status": "succeeded",
  "source": {
    "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
    "network": "base",
    "asset": "usdc"
  },
  "onchainTransactions": [
    {
      "transactionHash": "0xabc123def456789012345678901234567890abcdef1234567890abcdef123456",
      "network": "base"
    }
  ],
  "createdAt": "2025-06-15T12:04:00.000Z",
  "updatedAt": "2025-06-15T12:05:00.000Z"
}

{
  "errorType": "not_found",
  "errorMessage": "Approval with the given ID does not exist for this mandate."
}

{
  "errorType": "internal_server_error",
  "errorMessage": "An internal server error occurred. Please try again later."
}

{
  "errorType": "bad_gateway",
  "errorMessage": "Bad gateway. Please try again later."
}

{
  "errorType": "service_unavailable",
  "errorMessage": "Service unavailable. Please try again later."
}

GET

mandates

{mandateId}

approvals

{approvalId}

Get a mandate approval

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

import requests

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

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/{approvalId}', 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/{approvalId}",
  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/{approvalId}"

	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/{approvalId}")

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

{
  "approvalId": "approval_5f0e9d8c-7b6a-4321-fedc-ba0987654321",
  "status": "succeeded",
  "source": {
    "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
    "network": "base",
    "asset": "usdc"
  },
  "onchainTransactions": [
    {
      "transactionHash": "0xabc123def456789012345678901234567890abcdef1234567890abcdef123456",
      "network": "base"
    }
  ],
  "createdAt": "2025-06-15T12:04:00.000Z",
  "updatedAt": "2025-06-15T12:05:00.000Z"
}

{
  "errorType": "not_found",
  "errorMessage": "Approval with the given ID does not exist for this mandate."
}

{
  "errorType": "internal_server_error",
  "errorMessage": "An internal server error occurred. Please try again later."
}

{
  "errorType": "bad_gateway",
  "errorMessage": "Bad gateway. Please try again later."
}

{
  "errorType": "service_unavailable",
  "errorMessage": "Service unavailable. Please try again later."
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

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"

approvalId

string

required

The unique identifier of the approval. The ID of an approval, a UUID prefixed by approval_.

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

Example:

"approval_5f0e9d8c-7b6a-4321-fedc-ba0987654321"

Response

Successfully retrieved mandate approval.

An attempt to attach a funding source to a mandate and make it usable. A successful approval sets the mandate's source and moves the mandate to approval_succeeded; a failed one moves the mandate to approval_failed and can be retried by submitting a new approval. A mandate holds at most one active source, so at most one approval ever succeeds. The network transactions that grant the spending allowance are on onchainTransactions.

approvalId

string

required

The unique identifier of the approval.

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

Example:

"approval_5f0e9d8c-7b6a-4321-fedc-ba0987654321"

status

enum<string>

required

The current status of the approval attempt.

Available options:

pending,

succeeded,

failed

Example:

"succeeded"

createdAt

string<date-time>

required

The UTC ISO 8601 timestamp at which the approval was created.

Example:

"2025-06-15T12:04:00.000Z"

updatedAt

string<date-time>

required

The UTC ISO 8601 timestamp at which the approval was last updated.

Example:

"2025-06-15T12:05:00.000Z"

source

Mandate Source Wallet · object

The funding source this approval binds to the mandate. Present once the source has been determined from the customer's submission.

Show child attributes

Example:

{
  "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
  "network": "base",
  "asset": "usdc"
}

onchainTransactions

object[]

Network transactions that grant the spending allowance on-chain. Empty until the approval has been submitted to the network.

Show child attributes

Example:

[
  {
    "transactionHash": "0xabc123def456789012345678901234567890abcdef1234567890abcdef123456",
    "network": "base"
  }
]

error

object

Details of why the approval failed. Only present when status is failed.

Show child attributes

Example:

{
  "code": "invalid_signature",
  "message": "The submitted signature was invalid.",
  "occurredAt": "2025-06-15T12:04:00.000Z"
}

metadata

object

Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.

Show child attributes

Example:

{
  "customer_id": "cust_12345",
  "order_reference": "order-67890"
}