API reference
A REST API with predictable resource-oriented URLs, JSON bodies, HTTP Basic auth, and standard status codes. Base URL https://api.yusker.com/v1.
Conventions
- All amounts are integers in the smallest currency unit (cents).
- Timestamps are ISO-8601 UTC. IDs are prefixed by type (
ID,MU,PI,TR). - Send
Idempotency-IDon writes to make retries safe. - Errors return a JSON body with
codeandmessage;2xxsuccess,4xxclient error,5xxYusker error.
Identities
| POST | /v1/identities | Create an identity (business or buyer). |
| GET | /v1/identities/{id} | Retrieve an identity. |
| POST | /v1/identities/{id}/merchants | Provision a merchant from an identity. |
Merchants
| GET | /v1/merchants/{id} | Retrieve a merchant + processing state. |
| GET | /v1/merchants | List merchants. |
Payment Instruments
| POST | /v1/payment_instruments | Tokenize a card / exchange a token. |
| GET | /v1/payment_instruments/{id} | Retrieve an instrument. |
Transfers
| POST | /v1/transfers | Create a sale (debit) with a platform fee. |
| GET | /v1/transfers/{id} | Retrieve a transfer. |
| POST | /v1/transfers/{id}/reversals | Refund a transfer. |
Webhooks
| POST | /v1/webhooks | Register a webhook endpoint. |
| GET | /v1/webhooks | List webhook endpoints. |
Errors
{
"code": "invalid_request",
"message": "amount must be a positive integer",
"field": "amount"
}400 invalid_request— malformed or missing parameters.401 unauthenticated— missing or invalid API key.402 charge_declined— the issuer declined the card.403 forbidden— the key lacks access to the resource.404 not_found— no such resource.409 conflict— idempotency or state conflict.429 rate_limited— slow down and retry with backoff.