Tontines
Generated page, from the OpenAPI specification the gateway serves (
GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.
| Method | Path | Description |
|---|---|---|
POST |
/v1/pi-persons |
Register a person |
GET |
/v1/pi-persons/{ref} |
Retrieve a person |
POST |
/v1/tontines |
Create a tontine |
POST |
/v1/tontines/alias-lookups |
Resolve a participant's alias |
GET |
/v1/tontines/{ref} |
Retrieve a tontine |
POST |
/v1/tontines/{ref}/close |
Close a tontine |
GET |
/v1/tontines/{ref}/payouts |
Payouts from the pot |
POST |
/v1/tontines/{ref}/payouts |
Pay out the pot |
GET |
/v1/tontines/{ref}/rtp |
Contributions called |
POST |
/v1/tontines/{ref}/rtp |
Call the contributions |
POST |
/v1/tontines/{ref}/transfer-pool |
Move the pot |
POST /v1/pi-persons
Register a person
Registers a participant and their scheme account, a prerequisite for any tontine.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
Idempotency-Key |
header | no | An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409). |
Responses
201— Person registered401— API key missing or rejected403— The key does not carry the required scope, or the account is not active409— Idempotency key replayed with a different payload422— Well-formed but refused: missing field, closed corridor, insufficient balance429— The key's request budget is exhausted (300/min) — honour Retry-After
GET /v1/pi-persons/{ref}
Retrieve a person
The person and their accounts.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | The person's reference. |
Responses
200— OK401— API key missing or rejected403— The key does not carry the required scope, or the account is not active429— The key's request budget is exhausted (300/min) — honour Retry-After
POST /v1/tontines
Create a tontine
Opens a pot and its schedule.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
Idempotency-Key |
header | no | An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409). |
Responses
201— Tontine created401— API key missing or rejected403— The key does not carry the required scope, or the account is not active409— Idempotency key replayed with a different payload422— Well-formed but refused: missing field, closed corridor, insufficient balance429— The key's request budget is exhausted (300/min) — honour Retry-After
POST /v1/tontines/alias-lookups
Resolve a participant's alias
Directory resolution, restricted to the tontine perimeter.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Responses
200— OK401— API key missing or rejected403— The key does not carry the required scope, or the account is not active429— The key's request budget is exhausted (300/min) — honour Retry-After
GET /v1/tontines/{ref}
Retrieve a tontine
The pot, its participants and its state.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | The tontine's reference. |
Responses
200— OK401— API key missing or rejected403— The key does not carry the required scope, or the account is not active429— The key's request budget is exhausted (300/min) — honour Retry-After
POST /v1/tontines/{ref}/close
Close a tontine
Closes the pot. A pot whose balance is not zero does not close.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | Internal identifier, the operation's reference, or your own client_ref. |
Responses
200— OK401— API key missing or rejected403— The key does not carry the required scope, or the account is not active429— The key's request budget is exhausted (300/min) — honour Retry-After
GET /v1/tontines/{ref}/payouts
Payouts from the pot
The payouts already made from this pot.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | Internal identifier, the operation's reference, or your own client_ref. |
Responses
200— OK401— API key missing or rejected403— The key does not carry the required scope, or the account is not active429— The key's request budget is exhausted (300/min) — honour Retry-After
POST /v1/tontines/{ref}/payouts
Pay out the pot
Pays the pot to this round's beneficiary.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | Internal identifier, the operation's reference, or your own client_ref. |
Idempotency-Key |
header | no | An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409). |
Responses
201— Payout created401— API key missing or rejected403— The key does not carry the required scope, or the account is not active409— Idempotency key replayed with a different payload422— Well-formed but refused: missing field, closed corridor, insufficient balance429— The key's request budget is exhausted (300/min) — honour Retry-After
GET /v1/tontines/{ref}/rtp
Contributions called
The requests issued on this pot and their state.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | Internal identifier, the operation's reference, or your own client_ref. |
Responses
200— OK401— API key missing or rejected403— The key does not carry the required scope, or the account is not active429— The key's request budget is exhausted (300/min) — honour Retry-After
POST /v1/tontines/{ref}/rtp
Call the contributions
Issues a payment request to every participant expected on this round.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | Internal identifier, the operation's reference, or your own client_ref. |
Idempotency-Key |
header | no | An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409). |
Responses
201— Requests issued401— API key missing or rejected403— The key does not carry the required scope, or the account is not active409— Idempotency key replayed with a different payload422— Well-formed but refused: missing field, closed corridor, insufficient balance429— The key's request budget is exhausted (300/min) — honour Retry-After
POST /v1/tontines/{ref}/transfer-pool
Move the pot
Moves the pot's balance to another account on the platform.
ⓘ Family restricted to accounts with the “tontine” product enabled; everyone else gets 403.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
ref |
path | yes | Internal identifier, the operation's reference, or your own client_ref. |
Idempotency-Key |
header | no | An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409). |
Responses
200— OK401— API key missing or rejected403— The key does not carry the required scope, or the account is not active409— Idempotency key replayed with a different payload422— Well-formed but refused: missing field, closed corridor, insufficient balance429— The key's request budget is exhausted (300/min) — honour Retry-After