Recover funds

curl --request POST \
  --url https://api.agentcard.sh/api/v2/company_wallet/recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "amount_cents": 2
}
'

import requests

url = "https://api.agentcard.sh/api/v2/company_wallet/recoveries"

payload = {
    "user_id": "<string>",
    "amount_cents": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_id: '<string>', amount_cents: 2})
};

fetch('https://api.agentcard.sh/api/v2/company_wallet/recoveries', 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.agentcard.sh/api/v2/company_wallet/recoveries",
  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([
    'user_id' => '<string>',
    'amount_cents' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.agentcard.sh/api/v2/company_wallet/recoveries"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"amount_cents\": 2\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.agentcard.sh/api/v2/company_wallet/recoveries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"amount_cents\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentcard.sh/api/v2/company_wallet/recoveries")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"<string>\",\n  \"amount_cents\": 2\n}"

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

{
  "object": "company_wallet_recovery",
  "id": "<string>",
  "status": "requested",
  "user_id": "<string>",
  "amount_cents": 123,
  "livemode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "tx_hash": "<string>",
  "completed_at": "<string>"
}

{
  "object": "company_wallet_recovery",
  "id": "<string>",
  "status": "requested",
  "user_id": "<string>",
  "amount_cents": 123,
  "livemode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "tx_hash": "<string>",
  "completed_at": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

POST

api

company_wallet

recoveries

Recover funds

curl --request POST \
  --url https://api.agentcard.sh/api/v2/company_wallet/recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "amount_cents": 2
}
'

import requests

url = "https://api.agentcard.sh/api/v2/company_wallet/recoveries"

payload = {
    "user_id": "<string>",
    "amount_cents": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_id: '<string>', amount_cents: 2})
};

fetch('https://api.agentcard.sh/api/v2/company_wallet/recoveries', 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.agentcard.sh/api/v2/company_wallet/recoveries",
  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([
    'user_id' => '<string>',
    'amount_cents' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.agentcard.sh/api/v2/company_wallet/recoveries"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"amount_cents\": 2\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.agentcard.sh/api/v2/company_wallet/recoveries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"amount_cents\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentcard.sh/api/v2/company_wallet/recoveries")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"<string>\",\n  \"amount_cents\": 2\n}"

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

{
  "object": "company_wallet_recovery",
  "id": "<string>",
  "status": "requested",
  "user_id": "<string>",
  "amount_cents": 123,
  "livemode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "tx_hash": "<string>",
  "completed_at": "<string>"
}

{
  "object": "company_wallet_recovery",
  "id": "<string>",
  "status": "requested",
  "user_id": "<string>",
  "amount_cents": 123,
  "livemode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "tx_hash": "<string>",
  "completed_at": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "docs": "<string>",
    "field_errors": {},
    "warnings": [
      "<string>"
    ]
  }
}

When a user’s company-funded card closes with money left on it, that money stays with the user and counts toward their next card. For someone you won’t fund again, recover it to your balance instead. The user doesn’t need to be connected any more.

curl -X POST https://api.agentcard.sh/api/v2/company_wallet/recoveries \
  -H "Authorization: Bearer $ORG_TOKEN" \
  -H "Idempotency-Key: offboard-usr_123" \
  -H "Content-Type: application/json" \
  -d '{"user_id": "usr_123"}'

Leave out amount_cents to recover all of it. In sandbox the recovery completes at once. A live one starts as requested and completes later, and recovery.completed or recovery.rejected tells you how it ended.

Authorizations

Authorization

string

header

required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Headers

Idempotency-Key

string

Your key for this recovery. A retry with the same key returns the first one.

Body

application/json

user_id

string

required

The user to recover from.

amount_cents

integer

How much, in cents. Leave it out to recover all of it.

Required range: x >= 1

Response

The recovery a retry with the same Idempotency-Key already made.

object

enum<string>

required

Always company_wallet_recovery.

Available options:

company_wallet_recovery

string

required

status

enum<string>

required

requested and processing while it's under way, then completed or rejected.

Available options:

requested,

processing,

completed,

rejected

user_id

string | null

required

The user the money came from.

amount_cents

integer

required

What's recovered.

livemode

boolean

required

false on a sandbox credential.

created_at

string<date-time>

required

failure_reason

string | null

Why a rejected recovery was rejected.

tx_hash

string | null

The onchain transaction that moved it, once there is one.

completed_at

string | null

When it completed.

Overview

Access tokens

Connections

Vault

Commerce SDK

Cards

Company wallet

User balance

Transactions

Identity verification

Webhook endpoints

Blooio connection

Recover funds

Authorizations

Headers

Body

Response