Error
A valid request URL is required to generate request examples{
"codes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"owner_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"referred_count": 123,
"rate_basis_points": 123,
"fixed_amount_minor": 123,
"fixed_currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"balances": [
{
"referral_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"active": true,
"owner_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_name": "<string>",
"owner_email": "<string>",
"currency": "<string>",
"earned_minor": 123,
"reversed_minor": 123,
"owed_minor": 123,
"entry_count": 123
}
]
}
],
"payouts_are_manual": true
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Referrals
My referral codes and what they have earned
The codes this contact holds, how many people each brought in, and the fold of what each has earned per currency — the “invite a friend” screen, read from the customer’s own browser.
It never names who was referred: that is a list of other people’s accounts, and the count is what the person holding the code is owed an answer about.
It needs a verified session — the answer is money owed to whoever is holding it. An anonymous session may ask and answers an empty list, which is true rather than a refusal: a visitor holds no codes.
payouts_are_manual is true: what a code earned is recorded here, and the transfer is arranged outside this system.
GET
/
v1
/
contact
/
referrals
Error
A valid request URL is required to generate request examples{
"codes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"owner_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"referred_count": 123,
"rate_basis_points": 123,
"fixed_amount_minor": 123,
"fixed_currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"balances": [
{
"referral_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"active": true,
"owner_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_name": "<string>",
"owner_email": "<string>",
"currency": "<string>",
"earned_minor": 123,
"reversed_minor": 123,
"owed_minor": 123,
"entry_count": 123
}
]
}
],
"payouts_are_manual": true
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}