API Reference
A compact index of every partner endpoint. Full request/response examples live in the guide pages linked throughout — Authentication, Sending user data, Webhooks, and Credit lifecycle.
Authentication
| Method | Path | Purpose |
|---|---|---|
POST | /auth-apps/access-token | Exchange a signed payload for a JWT access token. |
Users
| Method | Path | Purpose |
|---|---|---|
POST | /card/add-user | Register a user and submit raw data. |
POST | /card/update-user | Update user/balances (replace) and append transactions. |
GET | /card/get-normalized-user?userId= | The normalized view of the data you sent. |
Credit
| Method | Path | Purpose |
|---|---|---|
POST | /card/authorize-credit | Authorize a draw against the user's limit. |
POST | /card/submit-repayment | Report a repayment. |
GET | /card/credit-limit?userId= | Current approved limit for a user. |
GET | /card/credit-info?userId= | Credit records for a user (active + history). Optional onlyActive / onlyRepaid booleans narrow the result. |
GET | /card/credit?creditId= | A specific credit's status. |
Webhooks (outbound, Yumi → you)
| Event | Trigger |
|---|---|
CREDIT_LIMIT | A user's credit limit was set or changed. See Webhooks. |
tip
All card/* endpoints require a CARD-scoped access token (Authorization: Bearer …). Your partner id is carried inside the token — you never pass it explicitly.