Skip to content
/
Creates a new payout meth...

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.

Authentication

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 API key

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.

Secret API key

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.

Rate Limiting

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
openapi.json
openapi.yaml
Overview
URL
https://ryftpay.com
Ryft
support@ryftpay.com
Languages
Servers
Sandbox environmment
https://sandbox-api.ryftpay.com/v1/
Production environment
https://api.ryftpay.com/v1/

Payments

Process payments with Ryft: authorizations, voids, captures, refunds etc.

Operations

Webhooks

Create and manage webhooks.

Operations

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

Accounts

Account registration for your sub accounts

Operations

Persons

The Persons API allows the creation and management of one or more persons for the purpose of verification for Business sub accounts. Recommended if you wish to implement verification programmatically for your sub accounts. This API cannot be accessed for Individual sub accounts.

Operations

Payout Methods

The Payout Methods API allows the creation and management of payout methods for use when receiving payouts, e.g. bank accounts. Recommended if you wish to implement payouts programmatically for your sub accounts.

Operations

Creates a new payout method for a sub account

Request

This is for creating payout methods for one of your sub accounts, so they can receive payouts. You can only create 1 payout method per currency

Security
secretApiKeyAuth
Path
idstring^ac_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a...required

the account id of one of your sub accounts

Example: ac_b83f2653-06d7-44a9-a548-5825e8186004
Bodyapplication/json
typestring(PayoutMethodType)
Value"BankAccount"
Example: "BankAccount"
displayNamestring or null

A friendly name for the payout method, for display only

Example: "Primary GBP Account"
currencystring= 3 characters

The three-character ISO 4217 currency code of the payout method. The currencies available here are the same as are available for making payments.

Example: "GBP"
countrystring= 2 characters

The two-character ISO 3166 country code of the payout method. Only certain countries are supported for a given currency

Example: "GB"
bankAccountobject(BankAccountRequest)
curl -i -X POST \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/payout-methods \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "BankAccount",
    "currency": "GBP",
    "country": "GB",
    "bankAccount": {
      "bankIdType": "SortCode",
      "bankId": "123456",
      "accountNumberType": "UnitedKingdom",
      "accountNumber": "12345678",
      "address": {
        "lineOne": "123 Street",
        "city": "Manchester",
        "country": "GB",
        "postalCode": "M1 1AA"
      }
    }
  }'

Responses

The payout method was created successfully

Bodyapplication/json
idstring^pm_[0-7][0-9A-HJKMNP-TV-Z]{25}

The id of the payout method

Example: "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ"
typestring(PayoutMethodType)
Value"BankAccount"
Example: "BankAccount"
displayNamestring or null

A friendly name for the payout method, for display only

Example: "Primary GBP Account"
statusstring(PayoutMethodStatus)
Enum"Pending""Invalid""Valid"
Example: "Valid"
invalidReasonstring or null

The reason why the payout method has been marked as 'Invalid'

Example: null
currencystring

The three-character ISO 4217 currency code of the payout method

Example: "GBP"
countryCodestring

The two-character ISO 3166 country code of the payout method

Example: "GB"
bankAccountobject(BankAccount)
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was last updated

Example: 1470989538
Response
application/json
{
  "id": "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "type": "BankAccount",
  "displayName": "Primary GBP Account",
  "status": "Valid",
  "invalidReason": null,
  "currency": "GBP",
  "countryCode": "GB",
  "bankAccount": {
    "bankIdType": "SortCode",
    "bankId": "0123",
    "bankName": "Ryft Bank Ltd",
    "accountNumberType": "UnitedKingdom",
    "last4": "0001",
    "address": { … }
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Retrieves payout methods in sorted (by epoch) order

Request

Retrieves a list of the payout methods you've created for one of your sub accounts They are returned in sorted (by epoch) order (default is newest first)

Security
secretApiKeyAuth
Path
idstring^ac_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a...required

the account id of one of your sub accounts

Example: ac_b83f2653-06d7-44a9-a548-5825e8186004
Query
ascendingboolean(boolean)

Control the order (newest or oldest) in which the payout methods are returned. false will arrange the results with newest first whereas true shows oldest first

Example: ascending=false
limitinteger(int32)

Control how many items are return in a given page The max limit we allow is 25. The default is 10.

Example: limit=10
startsAfterstring

A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results.

Example: startsAfter=pm_01FCTS1XMKH9FF43CAFA4CXT3P
curl -i -X GET \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/payout-methods \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved your payout methods

Bodyapplication/json
itemsArray of objects(PayoutMethod)
Response
application/json
{
  "items": [
    { … }
  ]
}

Retrieve a payout method by Id

Request

This is used to fetch a payout method by its unique Id for one of your sub accounts

Security
secretApiKeyAuth
Path
idstring^ac_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a...required

the account id of one of your sub accounts

Example: ac_b83f2653-06d7-44a9-a548-5825e8186004
payoutMethodIdstring^pm_[0-7][0-9A-HJKMNP-TV-Z]{25}required

Payout method to retrieve

Example: pm_01FCTS1XMKH9FF43CAFA4CXT3P
curl -i -X GET \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/payout-methods/pm_01FCTS1XMKH9FF43CAFA4CXT3P \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved the given payout method

Bodyapplication/json
idstring^pm_[0-7][0-9A-HJKMNP-TV-Z]{25}

The id of the payout method

Example: "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ"
typestring(PayoutMethodType)
Value"BankAccount"
Example: "BankAccount"
displayNamestring or null

A friendly name for the payout method, for display only

Example: "Primary GBP Account"
statusstring(PayoutMethodStatus)
Enum"Pending""Invalid""Valid"
Example: "Valid"
invalidReasonstring or null

The reason why the payout method has been marked as 'Invalid'

Example: null
currencystring

The three-character ISO 4217 currency code of the payout method

Example: "GBP"
countryCodestring

The two-character ISO 3166 country code of the payout method

Example: "GB"
bankAccountobject(BankAccount)
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was last updated

Example: 1470989538
Response
application/json
{
  "id": "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "type": "BankAccount",
  "displayName": "Primary GBP Account",
  "status": "Valid",
  "invalidReason": null,
  "currency": "GBP",
  "countryCode": "GB",
  "bankAccount": {
    "bankIdType": "SortCode",
    "bankId": "0123",
    "bankName": "Ryft Bank Ltd",
    "accountNumberType": "UnitedKingdom",
    "last4": "0001",
    "address": { … }
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Update a payout method by Id

Request

This is used to update an existing payout method for one of your sub accounts

Security
secretApiKeyAuth
Path
idstring^ac_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a...required

the account id of one of your sub accounts

Example: ac_b83f2653-06d7-44a9-a548-5825e8186004
payoutMethodIdstring^pm_[0-7][0-9A-HJKMNP-TV-Z]{25}required

Payout method to retrieve

Example: pm_01FCTS1XMKH9FF43CAFA4CXT3P
Bodyapplication/json
displayNamestring or null

A friendly name for the payout method, for display only

Example: "Primary GBP Account"
bankAccount(BankAccountRequest (object or null))
(BankAccountRequest (object or null))
curl -i -X PATCH \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/payout-methods/pm_01FCTS1XMKH9FF43CAFA4CXT3P \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Primary GBP Account",
    "bankAccount": {
      "bankIdType": "SortCode",
      "bankId": "0230",
      "accountNumberType": "UnitedKingdom",
      "accountNumber": "082100",
      "address": {
        "lineOne": "123 Test Street",
        "lineTwo": null,
        "city": "Manchester",
        "country": "GB",
        "postalCode": "SP4 7DE",
        "region": null
      }
    }
  }'

Responses

Successfully updated the given payout method

Bodyapplication/json
idstring^pm_[0-7][0-9A-HJKMNP-TV-Z]{25}

The id of the payout method

Example: "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ"
typestring(PayoutMethodType)
Value"BankAccount"
Example: "BankAccount"
displayNamestring or null

A friendly name for the payout method, for display only

Example: "Primary GBP Account"
statusstring(PayoutMethodStatus)
Enum"Pending""Invalid""Valid"
Example: "Valid"
invalidReasonstring or null

The reason why the payout method has been marked as 'Invalid'

Example: null
currencystring

The three-character ISO 4217 currency code of the payout method

Example: "GBP"
countryCodestring

The two-character ISO 3166 country code of the payout method

Example: "GB"
bankAccountobject(BankAccount)
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was last updated

Example: 1470989538
Response
application/json
{
  "id": "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "type": "BankAccount",
  "displayName": "Primary GBP Account",
  "status": "Valid",
  "invalidReason": null,
  "currency": "GBP",
  "countryCode": "GB",
  "bankAccount": {
    "bankIdType": "SortCode",
    "bankId": "0123",
    "bankName": "Ryft Bank Ltd",
    "accountNumberType": "UnitedKingdom",
    "last4": "0001",
    "address": { … }
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Delete a payout method

Request

This is used to delete a payout method by its unique Id for one of your sub accounts

Security
secretApiKeyAuth
Path
idstring^ac_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a...required

the account id of one of your sub accounts

Example: ac_b83f2653-06d7-44a9-a548-5825e8186004
payoutMethodIdstring^pm_[0-7][0-9A-HJKMNP-TV-Z]{25}required

Payout method to retrieve

Example: pm_01FCTS1XMKH9FF43CAFA4CXT3P
curl -i -X DELETE \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/payout-methods/pm_01FCTS1XMKH9FF43CAFA4CXT3P \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Payout method successfully deleted

Bodyapplication/json
idstring^pm_[0-7][0-9A-HJKMNP-TV-Z]{25}

The id of the payout method

Example: "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ"
typestring(PayoutMethodType)
Value"BankAccount"
Example: "BankAccount"
displayNamestring or null

A friendly name for the payout method, for display only

Example: "Primary GBP Account"
statusstring(PayoutMethodStatus)
Enum"Pending""Invalid""Valid"
Example: "Valid"
invalidReasonstring or null

The reason why the payout method has been marked as 'Invalid'

Example: null
currencystring

The three-character ISO 4217 currency code of the payout method

Example: "GBP"
countryCodestring

The two-character ISO 3166 country code of the payout method

Example: "GB"
bankAccountobject(BankAccount)
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the payout method was last updated

Example: 1470989538
Response
application/json
{
  "id": "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "type": "BankAccount",
  "displayName": "Primary GBP Account",
  "status": "Valid",
  "invalidReason": null,
  "currency": "GBP",
  "countryCode": "GB",
  "bankAccount": {
    "bankIdType": "SortCode",
    "bankId": "0123",
    "bankName": "Ryft Bank Ltd",
    "accountNumberType": "UnitedKingdom",
    "last4": "0001",
    "address": { … }
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

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

Balances

The balances API allows you to view your own or a particular sub accounts balances in real-time.

Typically useful when making use of manual payouts or our transfers API so you can determine the funds available prior to initiating requests.

Operations

Balance Transactions

Allows you to query for balance transactions. These transactions represent all actions within a Ryft account that impact account balances.

This API can only be used for reconciliation on transactions created from July 2025 onwards

Operations

Platform Fees

Query any platform fees that your account has taken (when taking payments on behalf of linked sub accounts)

Operations

Customers

The Customers API allows you to persist customer details across sessions. You should use this if you wish to support saving a customer's payment methods and thereby enabling them to reuse previously entered details for future payments.

Operations

Payment Methods

The Payment Methods API allows you to tokenize and store previously used payment methods.

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

Files

The Files API allows you to query for and upload files to Ryft. Some files may be generated internally by Ryft when requesting reports, or alternatively you may have uploaded evidence/verification documents

Operations

Apple Pay

Allows implementation of Apple Pay on the web via the API with Ryft's Apple Pay processing certificate.

Operations

Disputes

Disputes (also known as chargebacks) occur when a cardholder wants to query or challenge a transaction on their card statement. The Disputes API allows you to keep track of and manage disputes.

Operations

In-Person Products

The in-person products API allows you query for the products we offer for in-person payments. Useful to view and decide which SKUs you wish to order. Note that products themselves cannot be ordered. You must select one or more SKUs to purchase equipment.

Operations

In-Person SKUs

The in-person SKUs API allows you query for the SKUs we offer for in-person payments. SKUs are ultimately the items you order when purchasing equipment. Each SKU is scoped to a specific country and currency.

Operations

In-Person Orders

The in-person orders API allows you to request physical terminal orders to specific locations. Used in combination with our terminal API you can integrate in-person (card present) payments.

Operations

In-Person Locations

The in-person locations API allows you to setup and manage the locations in which terminals reside.

Operations

In-Person Terminals

The in-person terminals API allows you to setup and manage your physical terminal hardware for in-person (card present) payments.

Operations