Skip to main content
The Collections API handles inbound payments (fiat or crypto) collected from payers. Before initiating a collection, use the discovery endpoints to query available markets and payment rails.

​
Discovery

MethodPathDescription
GET/v1/collections/marketsList markets available to your integrator
GET/v1/collections/:market/railsList active rails for a market
GET/v1/collections/:market/rails/:railGet capability document for a specific rail

​
Collections

MethodPathDescription
POST/v1/collections/:market/rails/:railCreate a new collection (initiate inbound payment)
GET/v1/collectionsList collections for your integrator
GET/v1/collections/:idGet a single collection by ID
POST/v1/collections/:id/refundRefund a completed collection

​
Collection statuses

StatusMeaning
PENDINGAwaiting payment from payer
RECEIVEDPayment received, processing
COMPLETEDSuccessfully credited
FAILEDPayment failed or expired
REFUNDEDSuccessfully refunded