Participation

Search…
Participation
Participation information for a moment, request or money pool.
The participant object
Attribute
Type
Description
id
uuid
The unique identifier for the participant.
user_id
uuid
The unique identifier for the participant user.
parent_user_id
uuid
The unique identifier for the participant parent user.
transaction_id
uuid
The unique identifier for the transaction if a payment has been made.
status
string
The status of the participant.
pending
paid
settled
rejected
cancelled
invited
amount
float
The amount being paid by or requested of the participant.
currency
string
Three-letter ISO-4217 code.
full_name
string
The full name of the participant.
username
string
The username of the participant.
verified
boolean
Whether the participant has a verified user account.
official
boolean
Whether the participant's user account has been marked as an official one.
meta
string
A JSON object which can store meta data used by the client.
created_at
time
The time when the participant was created.
updated_at
time
The time when the participant was updated.
Example
{
  "id": "a0bcfb20-99fd-465d-6e23-2e19e8952420",
  "user_id": "add5c52a-0c57-4d5c-7525-db14566f2f1a",
  "parent_user_id": "79d94752-f94a-46ab-8793-7f6434025cf7",
  "transaction_id": "875ef796-88a1-4c7f-8755-d4cb066b9a3e",
  "status": "paid",
  "amount": 20.00,
  "currency": "EUR",
  "full_name": "John Dough",
  "username": "jondough",
  "verified": true,
  "official": false,
  "meta": "",
  "created_at": "2017-09-04T12:26:43.398646Z",
  "updated_at": "2017-09-04T12:26:43.398646Z"
}
The participation object
Attribute
Type
Description
count
ParticipationCount
Number of participants.
first_names
array
First names of the first 6 participants across all statuses.
ParticipationCount
Attribute
Type
Description
invited
integer
The number of participants who have been invited.
paid
integer
The number of participants who have paid.
pending
integer
The number of participants who have not responded.
rejected
integer
The number of participants who have rejected the payment request.
total
integer
The total number of participants regardless of status.
{
  "count": {
    "invited": 0,
    "paid": 2,
    "pending": 2,
    "rejected": 1,
    "total": 5
  },
  "first_names": ["Arnar", "Oskar", "Jon"]
}
Notifications
Payment
Last modified 2yr ago
Copy link
Outline
The participant object
Example
The participation object