Plan activity completed webhook
Allaria sends a notification to the partner's registered endpoint whenever a redemption (claim) or withdrawal on a savings plan subscription is completed. The partner must implement this endpoint to receive these notifications.
The request is sent as an HTTP POST to the full URL the partner registered. The path is the partner's own — Allaria does not impose one:
the URL you registeredFor example, a partner who registers https://api.partner.com/webhooks/allaria/plan-activity receives every notification there.
Redemptions and withdrawals arrive at the same URL. Name the endpoint accordingly — a path named after only one of the two operations will still receive the other.
The activity_type field in the body distinguishes them, and it has four possible values, not two: a partial operation reports PARTIALLY_CLAIM or PARTIALLY_WITHDRAWAL with plan_status: ACTIVE.
Match on activity_id, not on the other fields — a subscription can have several partial operations of the same type and amount, and nothing else in the body tells them apart.
The same id is:
- returned by Redemption and Withdrawal when the operation is requested;
- the
idof the activity in Get subscription activities.
Send the complete URL you want to receive notifications on to integraciones@allaria.com.ar, one per environment. There is no endpoint for this — the URL is configured on Allaria's side when your integration is set up.
Until it is registered, no notification is sent and nothing fails visibly.
Request
Allaria sends this request to the partner. The partner must expose the endpoint and respond with a 2XX status code to acknowledge receipt.
Headers
| Field | Type | Description |
|---|---|---|
Content-Type | string | Always application/json |
Path Parameters
Not applicable.
Query Parameters
Not applicable.
Body
| Field | Type | Description |
|---|---|---|
activity_id | number | Identifier of the completed activity — the same value returned by Redemption and Withdrawal when the operation was requested. Match the notification on this field. |
account_investment_plan_id | number | Subscription identifier. |
account_number | number | Account number associated with the subscription. |
activity_type | string | Type of activity that was completed. See Activity Type Values below. |
amount | number | Amount involved in the operation. On a total claim or withdrawal, the amount actually transferred. |
currency | string | Currency of the amount. Possible values: ARS, USD. |
plan_status | string | Updated status of the subscription after the operation. See Subscription Status Values below. |
Activity Type Values
| Value | Description |
|---|---|
CLAIM | Full redemption — all shares were transferred to the merchant and the subscription is closed. |
PARTIALLY_CLAIM | Partial redemption — a portion of the shares was transferred to the merchant; the subscription remains active. |
WITHDRAWAL | Full withdrawal — all funds were returned to the user's CVU and the subscription is closed. |
PARTIALLY_WITHDRAWAL | Partial withdrawal — a portion of the funds was returned to the user's CVU; the subscription remains active. |
Subscription Status Values
| Value | Description |
|---|---|
ACTIVE | The subscription is active and operating normally. |
AWAITING_BIND | Waiting for the user to approve the DEBIN direct debit recurrence in their banking app. |
PAUSED_BY_CONSECUTIVE_ERRORS_DEBIN | Paused automatically after three consecutive DEBIN failures. Allaria cancels the subscription if this state persists. |
PAUSED_BY_USER | Paused at the user's request. |
AWAITING_ASSET_TRANSFER | A redemption or withdrawal is in progress; shares are being transferred. |
AWAITING_ASSET_WITHDRAWAL | Shares are being liquidated into cash. |
AWAITING_CASH_TRANSFER | Cash transfer to the destination CVU is in progress. |
CLAIMED | All shares have been transferred to the merchant. The subscription is closed. |
WITHDRAWN | All funds have been returned to the user's CVU. The subscription is closed. |
BIND_ACTIVATION_FAILED | The DEBIN recurrence subscription expired without user approval. |
Example Payload
{
"activity_id": 4821,
"account_investment_plan_id": 42,
"account_number": 20000008,
"activity_type": "PARTIALLY_CLAIM",
"amount": 50000.00,
"currency": "ARS",
"plan_status": "ACTIVE"
}
Response
The partner must respond with any 2XX status code to acknowledge receipt.
The notification is sent only once the operation is durably recorded on Allaria's side, so the state it reports is always readable back from Get subscription and Get subscription activities.
If Allaria receives a non-2XX response or the request fails, the notification is retried automatically:
- with increasing intervals (1, 2, 4 … up to 60 minutes) for about 4 hours;
- after that, it is no longer retried and is reconciled by hand.
A failed notification does not block or reverse the underlying operation.
Delivery is at least once: the same notification can arrive more than once (for example, if your endpoint processed it but the response did not reach Allaria). Use activity_id to ignore duplicates.
Each attempt is signed again, with a new X-Allaria-Timestamp.