Approvals

Get Approval

Returns the status and details of an approval request, including how many approvals are required and how many have been received. A key can always read an approval it initiated. Reading one that another key initiated also needs the accounts:transactions scope.

get/approvals/{approval_id}

Request

Path parameters

approval_idstring required

Approval to fetch. Returned as approval_id by the payment-drafting tools.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

approval_idstring uuid required

Identifier of this approval, as returned in approval_id by the endpoint that drafted the request.

status'pending_approval' | 'approved' | 'executing' | 'under_review' | 'completed' | 'rejected' | 'expired' | 'failed' required
action_type'manage_users_and_policies' | 'send_money'
transfer_type'book' | 'usdc' | 'usdt' | 'pyusd' | 'cash' | 'usdg' | 'path_usd' | 'ach' | 'wire' | 'international'

The rail a transfer moves on, as the customer API reports it.

amountstring nullable

Amount the request would send, in USD. null for requests that carry no amount.

counterparty_idstring uuid nullable

Contact the request would pay. null for requests with no contact, such as a book transfer between your own accounts.

descriptionstring nullable

Description carried on the drafted request, as submitted. null when the request has none.

recipient_namestring nullable

Who the request would pay, as Meow shows it to approvers: a contact's name with the last digits of their account, or your own account for a transfer between accounts. null when the request pays no one.

source_accountstring nullable

Your account the request would send from, by name and the last digits of its number. null when the request sends from no account.

approvals_requiredinteger required

Approvals needed before the request executes — the matched policy's quorum. 0 when no policy matched and the initiator does not require human approval, meaning the request executes on its own.

approvals_receivedinteger required

Approvals recorded so far.

approver_display_namesstring[] nullable

Names of the people who may approve, from the matched policy. null when no policy matched — the initiator then approves it themselves in the Meow dashboard.

security_policy_idstring uuid nullable

Security policy that gated this request, as it stood when the request was drafted. null when no policy matched.

created_timestring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

expires_atstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

rejection_reasonstring nullable

Why the request did not go through. Set only when status is rejected or failed; otherwise null.

metadataobject nullable

The metadata attached when this object was created, unchanged. null when none was attached. Rarely, a .created webhook can be published before the create request finishes committing, and that one event reports null; every later event and every read of the object carries the metadata.

Changes

No recorded changes to this operation across all 1 revision of this API.