POST
to create a documentPATCH
to update itGET
to query one or more documentsDELETE
to cancel or delete a document (Subtext: nothing gets deleted. It is either unindexed in case of a user or a bank account or it's canceled in case of a transaction)GET
calls that get multiple documents support pagination and since our primary database is mongoDB (that's why we call everything documents), it also supports mongo filters. Example call for retrieving LOCKED
users, page 2 with max 10 documents:X-SP-GATEWAY
your_client_id|your_client_key
X-SP-USER
user_oauth_key|user_device_fingerprint
X-SP-USER-IP
user_ip
X-SP-IDEMPOTENCY-KEY
idempotency_key
(X-SP-USER-IP)
while others require client-level credentials (X-SP-GATEWAY)
.POST
calls support idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transaction fails due to a network connectivity error, you can retry the request with the same idempotency key to guarantee that only a single charge is created.POST
call before attempting to retry the call.from
and to
nodes, and we will move money between both accounts. This is handy because this gives you one unified way of creating all kinds of transactions: Internal Transfers, ACH Debit, ACH Credit, Interchange Pulls, Push to Card, Wires, BillPay, etc.oauth_key
for users.refresh_token
for users.refresh_token
.supp_id
, verify micro-deposits, etc.