Skip to main content

API reference

Spec and package​

OpenAPI 3.1 spec, as the beta runs itpayfi-v1.yaml
Spec as published in 0.2.2payfi-v1.yaml on jsDelivr
Package@crediolabs/payfi-sdk on npm
ChangesCHANGELOG.md
Servicehttps://payfi-beta.untangled.finance (Stellar testnet)

Conventions​

  • Amounts are decimal strings of whole tokens with at most 7 decimals: "1000", "0.5". Ledger numbers and seconds are integers.
  • Every answer carries request_id, also sent as the X-Request-Id header.
  • Lists are cursor-paged: ?limit= (50 by default, at most 200) and ?cursor= from the previous page's next_cursor, which is null on the last page.
  • The service answers under /v1/ at the service's root. The app's /api/v1/ serves the same routes with a tighter limit on changes.
  • Each call that changes state carries an Idempotency-Key (Idempotency).

Routes​

line is client.line(id). The auth column follows the spec's x-payfi-auth; Auth explains each kind.

MethodPathSDK callAuth
GET/v1/healthclient.health()Anyone
GET/v1/linesclient.lines()Anyone
GET/v1/lines/{line}line.get()Anyone
GET/v1/lines/{line}/whoamiline.whoami()Read grant or signed by the PO or admin
GET/v1/lines/{line}/basketline.basket()Anyone
POST/v1/lines/{line}/read-grantsline.readGrant()Signed by a PO key or the admin
GET/v1/lines/{line}/payinsline.payins.list()Read grant or signed by the PO or admin
POST/v1/lines/{line}/payinsline.payins.prepare()Anyone; a key of the line is served first
GET/v1/lines/{line}/payins/{reference}line.payins.get()Read grant or signed by the PO or admin
POST/v1/lines/{line}/payins/{reference}/release/stepline.payins.release()Anyone; a key of the line is served first
POST/v1/lines/{line}/payins/{reference}/releaseline.payins.reportRelease()Signed by a PO key
POST/v1/lines/{line}/payins/{reference}/release/renewline.payins.renewRelease()Signed by a PO key
POST/v1/lines/{line}/payins/{reference}/returnedline.payins.markReturned()Signed by a PO key
POST/v1/lines/{line}/payins/{reference}/resolveline.payins.resolve()Signed by a PO key or the admin
POST/v1/lines/{line}/screeningsline.screen()Read grant or signed by the PO or admin
GET/v1/lines/{line}/receiversline.receivers.list()Read grant or signed by the PO or admin
POST/v1/lines/{line}/repaymentsline.repayments.report()Signed by a PO key
POST/v1/lines/{line}/repayments/stepline.repayments.create()Anyone; a key of the line is served first
GET/v1/lines/{line}/marketline.market.get()Anyone
POST/v1/lines/{line}/market/stepline.market.step()Signed by Untangled's admin
POST/v1/lines/{line}/withdrawalsline.withdrawals.create()Anyone; a key of the line is served first
POST/v1/lines/{line}/liquidations/quoteline.liquidations.quote()Anyone
POST/v1/lines/{line}/liquidationsline.liquidations.create()Anyone
POST/v1/lines/{line}/liquidations/scanline.liquidations.scan()Signed by Untangled's admin
GET/v1/lines/{line}/takeoversline.takeovers.list()Read grant or signed by the PO or admin
POST/v1/lines/{line}/takeoversline.takeovers.queue()Signed by Untangled's admin
GET/v1/lines/{line}/takeovers/{number}line.takeovers.get()Read grant or signed by the PO or admin
POST/v1/lines/{line}/takeovers/{number}/runline.takeovers.run()Signed by Untangled's admin
POST/v1/lines/{line}/takeovers/{number}/cancelline.takeovers.cancel()Signed by Untangled's admin
POST/v1/lines/{line}/takeovers/{number}/cancel-by-poline.takeovers.cancelByPo()Anyone
GET/v1/lines/{line}/steps/{id}line.steps.get()Anyone
POST/v1/lines/{line}/steps/{id}/submitline.steps.sign()Anyone
GET/v1/lines/{line}/freezeline.freeze.get()Anyone
POST/v1/lines/{line}/freezeline.freeze.set()Signed by Untangled's admin
DELETE/v1/lines/{line}/freezeline.freeze.lift()Signed by Untangled's admin
POST/v1/lines/{line}/limitsline.limits.setOverdueWindow(), setLineCap()Signed by Untangled's admin
GET/v1/lines/{line}/decisionsline.decisions.list()Read grant or signed by the PO or admin
GET/v1/lines/{line}/eventsline.events.list()Read grant or signed by the PO or admin