API referenceApprovals

Sign off on a movement

Record one approval; the request completes when enough have agreed. Approving does not move the money. `assert_executable` is a separate call made immediately before the movement runs, because between the last signature and that moment the funds can have left by another route. 409 when the request is already decided, and 403 when the caller raised it: the person who initiated a movement may not approve their own.

POST
/api/b/v1/approvals/{approval_id}/approve

Record one approval; the request completes when enough have agreed.

Approving does not move the money. assert_executable is a separate call made immediately before the movement runs, because between the last signature and that moment the funds can have left by another route.

409 when the request is already decided, and 403 when the caller raised it: the person who initiated a movement may not approve their own.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

approval_id*Approval Id
Formatuuid
admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/approvals/497f6eca-6276-4993-bfeb-53cbbbba6f08/approve" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "subject_type": "payout",  "subject_id": "80e197be-61ad-4068-b4ff-a483fb5c18f9",  "amount_minor": 0,  "currency": "string",  "status": "pending",  "required_approvals": 0,  "current_level": 1,  "levels": [    {}  ],  "approvals_recorded": 0,  "initiated_by": "9f5ebe27-153d-4963-8417-06d50be356ec",  "initiated_by_name": "string",  "created_at": "2019-08-24T14:15:22Z",  "decided_at": "2019-08-24T14:15:22Z"}