Capture a hold

Capture the explicitly requested amountUc against this merchant-bound hold. Partial captures retain the held state; full capture marks captured.

POST/v1/redemptions/{id}/capture

Authorization

AuthorizationBearer token · headerrequired

Scoped merchant API key (asm_...) issued via POST /v1/merchants/{id}/api-keys. Path/scope-restricted; cannot access human or agent routes.

Path parameters

idstringrequired

Hold id (jti of the voucher)

Header parameters

Idempotency-Keystringrequired

Reuse for the same operation and payload; payload changes conflict

min length 1 · max length 255

Request body

requiredapplication/json

amountUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$

Responses

200

Capture record

idstring

agentIdstring

acceptorIdstring

offerIdstring

categorystring

amountUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$

statestring

Allowed:heldcapturedreleasedexpired

expiresAtinteger

createdAtinteger

capturedUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$

allocationsobject[]

Show properties

Array of object

lotIdstring

amountUcMicrocredits

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$

400

invalid_input problem

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

401

unauthorized problem; live 401s advertise WWW-Authenticate: Bearer resource_metadata=...

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

403

Identity, ownership, scope or policy denied (human_required, owner_claim_required, scope_required, FROZEN, CAP_EXCEEDED, SCOPE_FORBIDDEN)

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

404

not_found problem

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

503

Runtime or provider configuration unavailable (runtime_configuration_required, signing_configuration_required, runtime_unavailable, workspace_unavailable, provider_configuration_required)

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

Request

curl -X POST 'https://api.agentsub.dev/v1/redemptions/string/capture' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "amountUc": "string"
}'

const response = await fetch("https://api.agentsub.dev/v1/redemptions/string/capture", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Idempotency-Key": "string",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"amountUc\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.agentsub.dev/v1/redemptions/string/capture",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Idempotency-Key": "string",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"amountUc\": \"string\"\n}",
)

Response

{
  "id": "string",
  "agentId": "string",
  "acceptorId": "string",
  "offerId": "string",
  "category": "string",
  "amountUc": "string",
  "state": "held",
  "expiresAt": 0,
  "createdAt": 0,
  "capturedUc": "string",
  "allocations": [
    {
      "lotId": "string",
      "amountUc": "string"
    }
  ]
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}