Get Prefund balance

Returns the current state of the Partner's Prefund Account. This endpoint is partner-scoped, not user-scoped; UR maintains one Prefund Account per partner, and the response is a flat, single-currency object for the settlement currency (defaults to USD). Poll at operational dashboard cadence, e.g. no more frequently than once per minute unless UR advises otherwise and do not call it from inside the Card Authorization callback; UR already performs Prefund availability checks before approving.

get

/api/fma/v1/prefund-balance

Authorizations

X-Api-SignaturestringRequired

Partner Auth: EIP-191 signature by the partner's registered backend key, with X-Api-Deadline and optional X-Api-PublicKey headers. See the Signature and verify guide.

Header parameters

X-Api-SignaturestringRequired

Partner's EIP-191 signature for Partner Auth (0x-prefixed hex).

X-Api-DeadlinestringRequired

Unix seconds expiry for the request signature.

X-Api-PublicKeystringRequired

Partner's signer Ethereum address.

Responses

200

Current Prefund Account state for the partner's settlement currency. The response does not include a settleMode field; record your configured settlement mode from onboarding.

application/json

Standard response envelope for the Prefund balance endpoint. code 0 means success.

codeintegerRequired

0 on success; a non-zero value indicates a business rejection.

messagestringRequired

Human-readable diagnostic; empty on success.

get/api/fma/v1/prefund-balance

GET /api/fma/v1/prefund-balance HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Api-Deadline: text
X-Api-PublicKey: text
Accept: */*

200

Current Prefund Account state for the partner's settlement currency. The response does not include a settleMode field; record your configured settlement mode from onboarding.

{
  "code": 0,
  "message": "",
  "data": {
    "partnerId": "partner_id",
    "account": "0xPrefundAccAddress",
    "currency": "USD",
    "balance": "125000.00",
    "minBalance": "50000.00",
    "level": "normal",
    "allowance": "125000.00",
    "updatedAt": 1713700000
  }
}