Skip to main content
Every method returns a promise and throws TransfersApiError on a non-2xx reply.

getRoutes

Lists every route. Needs no token.

quote

A quote is a server-side record. Creating a transfer uses only its id, so the terms cannot be changed by the client.

createTransfer

Creates a transfer from a quote. Calling it again with the same key returns the same transfer. A used or expired quote returns 409.

getActions

Returns the one action the user can take now, or null when it is Pesa’s or a chain’s turn.

submit

Submit an EVM transaction hash only after it is mined. The server reads the burn or send from the mined receipt. A submission that does not match the issued action returns 422 with no change. Pesa’s relay wraps a signed Stellar transaction in a fee-bump and submits it, so the user needs no XLM.

getTransfer

See Transfer lifecycle for every stage and status.

listTransfers

The owner’s transfers, newest first. To get the next page, pass the oldest started_at you have as before (an ISO date).

cancel

Allowed in AWAITING_FUNDS, FUNDED and AWAITING_SIGNATURE, before anything irreversible. Otherwise 409 with the stage.