Atrium API
Aggregate Member Account Balances
This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data at all.
If an account balance aggregation is already running, a 202 Accepted status will be returned. If another aggregation-type process is already running — like verification or extended transaction history — a 409 Conflict will be returned.
Repeated calls to this endpoint for the same member can only be made at intervals greater than two hours. If made more frequently, a 429 Too Many Requests status will be returned.
For more information on this and other aggregation-type processes, please see our developer guide
caution
- Like aggregate member, calling this endpoint may result in multi-factor authentication. It is therefore important that the end user be present when initiating a balance request.
- Balance jobs are limited to 5 requests every 2 hours.
POST
/users/{user_guid}/members/{member_guid}/balance
Request sample
Language:sh
Response sample
Language:json