Confirm a collection

curl --request POST \
  --url https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection"

payload = {}
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({})
};

fetch('https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection', 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/transfers/{transfer_id}/collection",
  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([
    
  ]),
  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/transfers/{transfer_id}/collection"

	payload := strings.NewReader("{}")

	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/transfers/{transfer_id}/collection")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection")

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 = "{}"

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

{
  "object": "company_wallet_transfer",
  "id": "<string>",
  "status": "pending",
  "substatus": "<string>",
  "kind": "<string>",
  "user_id": "<string>",
  "amount_cents": 123,
  "livemode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "card_id": "<string>",
  "fee_cents": 123,
  "transferred_cents": 123,
  "released_cents": 123,
  "failure_reason": "<string>",
  "collection_deadline": "<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

transfers

{transfer_id}

collection

Confirm a collection

curl --request POST \
  --url https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection"

payload = {}
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({})
};

fetch('https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection', 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/transfers/{transfer_id}/collection",
  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([
    
  ]),
  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/transfers/{transfer_id}/collection"

	payload := strings.NewReader("{}")

	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/transfers/{transfer_id}/collection")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentcard.sh/api/v2/company_wallet/transfers/{transfer_id}/collection")

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 = "{}"

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

{
  "object": "company_wallet_transfer",
  "id": "<string>",
  "status": "pending",
  "substatus": "<string>",
  "kind": "<string>",
  "user_id": "<string>",
  "amount_cents": 123,
  "livemode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "card_id": "<string>",
  "fee_cents": 123,
  "transferred_cents": 123,
  "released_cents": 123,
  "failure_reason": "<string>",
  "collection_deadline": "<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>"
    ]
  }
}

If your company collects from its own customer before Agentcard funds a card, each transfer waits on you: card_flow.started arrives with ack_required: true. Collect, then send the outcome before collection_deadline. succeeded lets the transfer go on to the card, and the agent’s retry returns it. failed leaves the money on your balance. If you send neither, the transfer fails at the deadline.

curl -X POST https://api.agentcard.sh/api/v2/company_wallet/transfers/owt_123/collection \
  -H "Authorization: Bearer $ORG_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"outcome": "succeeded"}'

The API returns the transfer again when you send the same outcome, so a retry is safe.

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.

Path Parameters

transfer_id

string

required

Body

application/json

outcome

enum<string>

required

Whether you collected.

Available options:

succeeded,

failed

Response

The transfer, as the outcome left it.

object

enum<string>

required

Always company_wallet_transfer.

Available options:

company_wallet_transfer

string

required

status

enum<string>

required

pending until the money reaches the card, funded once it has, consumed once the card holds it, reclaimed once a closed card gave it back, failed when it never moved.

Available options:

pending,

funded,

consumed,

reclaimed,

failed

substatus

string

required

Where a pending transfer is: awaiting_collection (waiting on you), collection_confirmed or transferring.

kind

string

required

mint for a new card, top_up for a raise on an existing one.

user_id

string | null

required

The user the card is for.

amount_cents

integer

required

What the card asked for.

livemode

boolean

required

false on a sandbox credential.

created_at

string<date-time>

required

card_id

string | null

The card the transfer made or raised.

fee_cents

integer

The fee on top.

transferred_cents

integer

What has moved so far.

released_cents

integer

What a closed card gave back. It counts toward the user's next card until you recover it.

failure_reason

string | null

Why a failed transfer failed.

collection_deadline

string | null

When a transfer waiting on you fails if you haven't confirmed it.

Overview

Access tokens

Connections

Vault

Commerce SDK

Cards

Company wallet

User balance

Transactions

Identity verification

Webhook endpoints

Blooio connection

Confirm a collection

Authorizations

Path Parameters

Body

Response