Process payments with Ryft: authorizations, voids, captures, refunds etc.
Ryft Payment API (1.1.0)
Ryft provides a collection of APIs that you can use to accept and process payments + marketplace functionality (payouts). We have a testing environment called sandbox, which you can sign up for to test API calls without affecting live data.
When you sign up for an account, you are given a secret and public API key pair. You authenticate with our API by providing the appropriate key in the request Authorization header. Never share your secret keys. Keep them guarded and secure.
Public keys should only be used in JavaScript or native applications. This key is solely used to identify the partner making requests. Supply this key in the Authorization header.
Your secret key should always be supplied in the Authorization header. Make sure this key is stored securely on your backend and never surfaced client-side.
We use rate limiting on a per-user basis to protect our APIs against abuse. Our Sandbox environment is limited to 5 requests per second. Our production environment is limited to 50 requests per second.
We also allow a brief burst above this limit to accommodate a sudden increase in traffic.
If you exceed the above quota then the API will respond with a 429 status code and you will need to retry the API call (we recommend implementing a retry policy with an exponential back-off).
Download OpenAPI description
Overview
Languages
Servers
Sandbox environmment
https://sandbox-api.ryftpay.com/v1/
Production environment
https://api.ryftpay.com/v1/
Events
Events are persisted throughout the lifecycle of a payment/action as you use our API. We use events to notify you when something important happens in your account (or a linked sub account). The most commonly used event occurs when a payment is captured, in which case we persist a PaymentSession.captured event and then (optionally) send it to any webhooks you have registered that are listening for that event type.
Note that if you are taking payments as a platform (for sub accounts), events are saved against the sub account accountId, but will be sent to any webhooks that your account has configured.
Operations
Payouts
A payout represents the transfer of money from Ryft to a connected payout method (bank account), i.e. when we send money you're owed. Typically this is automated.
However, the payouts API allows you to explicitly create payouts for your sub accounts. Generally we'd recommend this if you are a marketplace who wants to control exactly when payouts should be sent out.
Operations
Transfers
A Transfer represents the movement of money between Ryft accounts.
This API allows platforms/marketplaces to transfer money from/to particular sub accounts, useful when:
- you owe a sub account money from a particular transaction and want to explicitly send it after the fact
- you want to recoup funds from a sub account, such as when dealing with disputes
- you want to collect additional/new commission from the sub account
Operations
Subscriptions
The subscriptions API allows you to automatically have Ryft schedule and charge recurring payments for a specific day and time. This API is not required to process recurring payments. After additional configuration, you can use our payment-sessions API to create and charge the recurring payments yourself.
Operations
Query
Control the order (newest or oldest) in which the items are returned. false will arrange the results with newest first, whereas true shows oldest first. The default is false.
Example: ascending=false
Control how many items are return in a given page The max limit we allow is 50. The default is 50.
Example: limit=10
A token to identify the item to start querying after. This is used to get the next page of results after a previous response returned a non-null paginationToken. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results for that timestamp range.
Example: startsAfter=ippd_01FCTS1XMKH9FF43CAFA4CXT3P
- Sandbox environmmenthttps://sandbox-api.ryftpay.com/v1/in-person/products
- Production environmenthttps://api.ryftpay.com/v1/in-person/products
- cURL
- Node
- Python
curl -i -X GET \
https://sandbox-api.ryftpay.com/v1/in-person/products \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "items": [ { … } ], "paginationToken": "ippd_01FCTS1XMKH9FF43CAFA4CXT3P" }
- Sandbox environmmenthttps://sandbox-api.ryftpay.com/v1/in-person/products/{id}
- Production environmenthttps://api.ryftpay.com/v1/in-person/products/{id}
- cURL
- Node
- Python
curl -i -X GET \
https://sandbox-api.ryftpay.com/v1/in-person/products/ippd_01FCTS1XMKH9FF43CAFA4CXT3P \
-H 'Authorization: YOUR_API_KEY_HERE'The resource was retrieved successfully
The description of the product/model
Example: "Powered by the fastest processor to simultaneously run the most complex applications under the highest levels of inbuilt payment security. The ultimate viewing experience is delivered on the A920 PRO 5.5-inch touchscreen, enabling you to better showcase logos, adverts, and video clips, creating multiple customer engagement opportunities."
A key-value dictionary of details of this product.
Example: {"battery":"5150mAh | 3.7V","cardReaders":"Chip & PIN | Contactless | Magnetic Stripe"}
The epoch timestamp (seconds) when the object was created
Example: 1470989538
Response
application/json
{ "id": "ippd_01FCTS1XMKH9FF43CAFA4CXT3P", "name": "PAX A920 Pro", "status": "Available", "description": "Powered by the fastest processor to simultaneously run the most complex applications under the highest levels of inbuilt payment security. The ultimate viewing experience is delivered on the A920 PRO 5.5-inch touchscreen, enabling you to better showcase logos, adverts, and video clips, creating multiple customer engagement opportunities.", "details": { "battery": "5150mAh | 3.7V", "cardReaders": "Chip & PIN | Contactless | Magnetic Stripe" }, "createdTimestamp": 1470989538, "lastUpdatedTimestamp": 1470989538 }