Skip to content
/
Deletes a person by Id

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

Creates a new person under the account, for verification of Businesses

Request

This is for creating persons under your or your sub accounts account, required for verification of businesses. The following limits apply: - Maximum of 9 persons - Maximum of 5 persons with a role of Director - Maximum of 4 persons with a role of UltimateBeneficialOwner - Maximum of 1 person with a role of BusinessContact

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
firstNamestring[ 1 .. 50 ] characters

The first name of the person

Example: "Fred"
middleNamesstring or null[ 1 .. 50 ] characters

The middle names of the person

Example: "David"
lastNamestring[ 1 .. 50 ] characters

The last name / surname of the person

Example: "Jones"
emailstring(email)[ 1 .. 100 ] characters

The email address of the person

Example: "fred.jones@example.com"
dateOfBirthstring= 10 characters

The date of birth of the person, in format YYYY-MM-DD

Example: "1990-01-20"
countryOfBirthstring or null= 2 characters

The two-character ISO 3166 country code of birth of the person

Example: "GB"
genderstring

The gender of the person. International regulations require either Female or Male

Enum"Female""Male"
Example: "Male"
nationalitiesArray of strings

The countries of citizenship or nationality of the person

Example: ["GB"]
addressAccountAddressRequest (object)
AccountAddressRequest (object)
phoneNumberstring[ 1 .. 17 ] characters

The phone number of the person, in E.164 format

Example: "+447900000000"
businessRolesArray of strings(BusinessRole)

The role(s) in the business that the person performs. This must contain at least one value.

Items Enum"BusinessContact""Director""UltimateBeneficialOwner"
Example: ["BusinessContact","Director"]
documentsArray of AccountDocumentRequest (object) or null

The KYC documents. Note that a maximum of 1 of each document type can exist at any time, if you add a new document of a type that already exists then it will be replaced, regardless of it's status.

metadataobject or null

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

Example: {"accountId":"1"}
curl -i -X POST \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/persons \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "Fred",
    "middleNames": "David",
    "lastName": "Jones",
    "email": "fred.jones@example.com",
    "dateOfBirth": "1990-01-20",
    "countryOfBirth": "GB",
    "gender": "Male",
    "nationalities": [
      "GB"
    ],
    "address": {
      "lineOne": "123 Test Street",
      "lineTwo": null,
      "city": "Manchester",
      "country": "GB",
      "postalCode": "SP4 7DE",
      "region": null
    },
    "phoneNumber": "+447900000000",
    "businessRoles": [
      "BusinessContact",
      "Director"
    ],
    "documents": [
      {
        "type": "BankStatement",
        "front": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
        "back": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
        "country": "GB"
      }
    ],
    "metadata": {
      "accountId": "1"
    }
  }'

Responses

The person was created successfully

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

The ID of the person

Example: "per_01G0EYVFR02KBBVE2YWQ8AKMGJ"
firstNamestring

The first name of the person

Example: "Fred"
middleNamesstring or null

The middle names of the person

Example: "David"
lastNamestring

The last name / surname of the person

Example: "Jones"
emailstring or null(email)

The email address of the person

Example: "fred.jones@example.com"
dateOfBirthstring

The date of birth of the person, in format YYYY-MM-DD

Example: "1990-01-20"
countryOfBirthstring or null

The two-character ISO 3166 country code of birth of the person

Example: "GB"
genderstring or null

The gender of the person. International regulations require either Female or Male

Enum"Female""Male"
Example: "Male"
nationalitiesArray of strings

The countries of citizenship or nationality of the person

Example: ["GB"]
addressAccountAddress (object)
AccountAddress (object)
phoneNumberstring or null

The phone number of the person, in E.164 format

Example: "+447900000000"
businessRolesArray of strings(BusinessRole)

The role(s) in the business that the person performs

Items Enum"BusinessContact""Director""UltimateBeneficialOwner"
Example: ["BusinessContact","Director"]
verificationobject(PersonVerification)

the result of submitting a person for verification

documentsArray of AccountDocumentResponse (object) or null

The KYC documents

metadataobject or null

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

Example: {"accountId":"1"}
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the person was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the person was last updated

Example: 1470989538
Response
application/json
{
  "id": "per_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "firstName": "Fred",
  "middleNames": "David",
  "lastName": "Jones",
  "email": "fred.jones@example.com",
  "dateOfBirth": "1990-01-20",
  "countryOfBirth": "GB",
  "gender": "Male",
  "nationalities": [
    "GB"
  ],
  "address": {
    "lineOne": "123 Test Street",
    "lineTwo": null,
    "city": "Manchester",
    "country": "GB",
    "postalCode": "SP4 7DE",
    "region": null
  },
  "phoneNumber": "+447900000000",
  "businessRoles": [
    "BusinessContact",
    "Director"
  ],
  "verification": {
    "status": "Required",
    "requiredFields": [ … ],
    "requiredDocuments": [ … ],
    "errors": [ … ]
  },
  "documents": [
    { … }
  ],
  "metadata": {
    "accountId": "1"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Retrieves persons in sorted (by epoch) order

Request

Retrieves a list of the persons 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 persons are returned. false will arrange the results with newest first whereas true shows oldest first.

Example: ascending=false
limitinteger(int32)

Control how many persons are returned in the result list. The max limit we allow is 50.

Example: limit=20
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=per_01FCTS1XMKH9FF43CAFA4CXT3P
curl -i -X GET \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/persons \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved your persons

Bodyapplication/json
itemsArray of objects(PersonResponse)
paginationTokenstring or null

A token to use for getting the next page of results - send the same request with this value in the 'startsAfter' query parameter. This field is null when there are no further items to return

Example: "per_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
Response
application/json
{
  "items": [
    { … }
  ],
  "paginationToken": "per_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
}

Retrieve a person by Id

Request

This is used to fetch a person by its unique Id

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
personIdstring^per_[0-7][0-9A-HJKMNP-TV-Z]{25}required

Person to retrieve

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

Responses

Successfully retrieved the given Person

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

The ID of the person

Example: "per_01G0EYVFR02KBBVE2YWQ8AKMGJ"
firstNamestring

The first name of the person

Example: "Fred"
middleNamesstring or null

The middle names of the person

Example: "David"
lastNamestring

The last name / surname of the person

Example: "Jones"
emailstring or null(email)

The email address of the person

Example: "fred.jones@example.com"
dateOfBirthstring

The date of birth of the person, in format YYYY-MM-DD

Example: "1990-01-20"
countryOfBirthstring or null

The two-character ISO 3166 country code of birth of the person

Example: "GB"
genderstring or null

The gender of the person. International regulations require either Female or Male

Enum"Female""Male"
Example: "Male"
nationalitiesArray of strings

The countries of citizenship or nationality of the person

Example: ["GB"]
addressAccountAddress (object)
AccountAddress (object)
phoneNumberstring or null

The phone number of the person, in E.164 format

Example: "+447900000000"
businessRolesArray of strings(BusinessRole)

The role(s) in the business that the person performs

Items Enum"BusinessContact""Director""UltimateBeneficialOwner"
Example: ["BusinessContact","Director"]
verificationobject(PersonVerification)

the result of submitting a person for verification

documentsArray of AccountDocumentResponse (object) or null

The KYC documents

metadataobject or null

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

Example: {"accountId":"1"}
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the person was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the person was last updated

Example: 1470989538
Response
application/json
{
  "id": "per_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "firstName": "Fred",
  "middleNames": "David",
  "lastName": "Jones",
  "email": "fred.jones@example.com",
  "dateOfBirth": "1990-01-20",
  "countryOfBirth": "GB",
  "gender": "Male",
  "nationalities": [
    "GB"
  ],
  "address": {
    "lineOne": "123 Test Street",
    "lineTwo": null,
    "city": "Manchester",
    "country": "GB",
    "postalCode": "SP4 7DE",
    "region": null
  },
  "phoneNumber": "+447900000000",
  "businessRoles": [
    "BusinessContact",
    "Director"
  ],
  "verification": {
    "status": "Required",
    "requiredFields": [ … ],
    "requiredDocuments": [ … ],
    "errors": [ … ]
  },
  "documents": [
    { … }
  ],
  "metadata": {
    "accountId": "1"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Update a person by Id

Request

This is used to update an existing person

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
personIdstring^per_[0-7][0-9A-HJKMNP-TV-Z]{25}required

Person to update

Example: per_01FCTS1XMKH9FF43CAFA4CXT3P
Bodyapplication/json
firstNamestring or null[ 1 .. 50 ] characters

The first name of the person

Example: "Fred"
middleNamesstring or null[ 1 .. 50 ] characters

The middle names of the person

Example: "David"
lastNamestring or null[ 1 .. 50 ] characters

The last name / surname of the person

Example: "Jones"
emailstring or null(email)[ 1 .. 100 ] characters

The email address of the person

Example: "fred.jones@example.com"
dateOfBirthstring or null= 10 characters

The date of birth of the person, in format YYYY-MM-DD

Example: "1990-01-20"
countryOfBirthstring or null= 2 characters

The two-character ISO 3166 country code of birth of the person

Example: "GB"
genderstring or null

The gender of the person. International regulations require either Female or Male

Enum"Female""Male"
Example: "Male"
nationalitiesArray of strings or null

The countries of citizenship or nationality of the person

Example: ["GB"]
address(AccountAddressRequest (object or null))
(AccountAddressRequest (object or null))
phoneNumberstring or null[ 1 .. 17 ] characters

The phone number of the person, in E.164 format

Example: "+447900000000"
businessRolesArray of strings(BusinessRole)

The role(s) in the business that the person performs. This must contain at least one value.

Items Enum"BusinessContact""Director""UltimateBeneficialOwner"
Example: ["BusinessContact","Director"]
documentsArray of AccountDocumentRequest (object) or null

The KYC documents. Note that a maximum of 1 of each document type can exist at any time, if you add a new document of a type that already exists then it will be replaced, regardless of it's status.

metadataobject or null

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

Example: {"accountId":"1"}
curl -i -X PATCH \
  https://sandbox-api.ryftpay.com/v1/accounts/ac_b83f2653-06d7-44a9-a548-5825e8186004/persons/per_01FCTS1XMKH9FF43CAFA4CXT3P \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "Fred",
    "middleNames": "David",
    "lastName": "Jones",
    "email": "fred.jones@example.com",
    "dateOfBirth": "1990-01-20",
    "countryOfBirth": "GB",
    "gender": "Male",
    "nationalities": [
      "GB"
    ],
    "address": {
      "lineOne": "123 Test Street",
      "lineTwo": null,
      "city": "Manchester",
      "country": "GB",
      "postalCode": "SP4 7DE",
      "region": null
    },
    "phoneNumber": "+447900000000",
    "businessRoles": [
      "BusinessContact",
      "Director"
    ],
    "documents": [
      {
        "type": "BankStatement",
        "front": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
        "back": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
        "country": "GB"
      }
    ],
    "metadata": {
      "accountId": "1"
    }
  }'

Responses

Successfully updated the given Person

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

The ID of the person

Example: "per_01G0EYVFR02KBBVE2YWQ8AKMGJ"
firstNamestring

The first name of the person

Example: "Fred"
middleNamesstring or null

The middle names of the person

Example: "David"
lastNamestring

The last name / surname of the person

Example: "Jones"
emailstring or null(email)

The email address of the person

Example: "fred.jones@example.com"
dateOfBirthstring

The date of birth of the person, in format YYYY-MM-DD

Example: "1990-01-20"
countryOfBirthstring or null

The two-character ISO 3166 country code of birth of the person

Example: "GB"
genderstring or null

The gender of the person. International regulations require either Female or Male

Enum"Female""Male"
Example: "Male"
nationalitiesArray of strings

The countries of citizenship or nationality of the person

Example: ["GB"]
addressAccountAddress (object)
AccountAddress (object)
phoneNumberstring or null

The phone number of the person, in E.164 format

Example: "+447900000000"
businessRolesArray of strings(BusinessRole)

The role(s) in the business that the person performs

Items Enum"BusinessContact""Director""UltimateBeneficialOwner"
Example: ["BusinessContact","Director"]
verificationobject(PersonVerification)

the result of submitting a person for verification

documentsArray of AccountDocumentResponse (object) or null

The KYC documents

metadataobject or null

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

Example: {"accountId":"1"}
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the person was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the person was last updated

Example: 1470989538
Response
application/json
{
  "id": "per_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "firstName": "Fred",
  "middleNames": "David",
  "lastName": "Jones",
  "email": "fred.jones@example.com",
  "dateOfBirth": "1990-01-20",
  "countryOfBirth": "GB",
  "gender": "Male",
  "nationalities": [
    "GB"
  ],
  "address": {
    "lineOne": "123 Test Street",
    "lineTwo": null,
    "city": "Manchester",
    "country": "GB",
    "postalCode": "SP4 7DE",
    "region": null
  },
  "phoneNumber": "+447900000000",
  "businessRoles": [
    "BusinessContact",
    "Director"
  ],
  "verification": {
    "status": "Required",
    "requiredFields": [ … ],
    "requiredDocuments": [ … ],
    "errors": [ … ]
  },
  "documents": [
    { … }
  ],
  "metadata": {
    "accountId": "1"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Deletes a person by Id

Request

Deletes a person under the account. This will also delete any files currently attached to the person. Note that you can only delete a person if verification.status is NotRequired or Required

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
personIdstring^per_[0-7][0-9A-HJKMNP-TV-Z]{25}required

Person to delete

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

Responses

Successfully deleted the given Person

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

The ID of the person

Example: "per_01G0EYVFR02KBBVE2YWQ8AKMGJ"
firstNamestring

The first name of the person

Example: "Fred"
middleNamesstring or null

The middle names of the person

Example: "David"
lastNamestring

The last name / surname of the person

Example: "Jones"
emailstring or null(email)

The email address of the person

Example: "fred.jones@example.com"
dateOfBirthstring

The date of birth of the person, in format YYYY-MM-DD

Example: "1990-01-20"
countryOfBirthstring or null

The two-character ISO 3166 country code of birth of the person

Example: "GB"
genderstring or null

The gender of the person. International regulations require either Female or Male

Enum"Female""Male"
Example: "Male"
nationalitiesArray of strings

The countries of citizenship or nationality of the person

Example: ["GB"]
addressAccountAddress (object)
AccountAddress (object)
phoneNumberstring or null

The phone number of the person, in E.164 format

Example: "+447900000000"
businessRolesArray of strings(BusinessRole)

The role(s) in the business that the person performs

Items Enum"BusinessContact""Director""UltimateBeneficialOwner"
Example: ["BusinessContact","Director"]
verificationobject(PersonVerification)

the result of submitting a person for verification

documentsArray of AccountDocumentResponse (object) or null

The KYC documents

metadataobject or null

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

Example: {"accountId":"1"}
createdTimestampinteger(int64)

The epoch timestamp (seconds) when the person was created

Example: 1470989538
lastUpdatedTimestampinteger(int64)

The epoch timestamp (seconds) when the person was last updated

Example: 1470989538
Response
application/json
{
  "id": "per_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "firstName": "Fred",
  "middleNames": "David",
  "lastName": "Jones",
  "email": "fred.jones@example.com",
  "dateOfBirth": "1990-01-20",
  "countryOfBirth": "GB",
  "gender": "Male",
  "nationalities": [
    "GB"
  ],
  "address": {
    "lineOne": "123 Test Street",
    "lineTwo": null,
    "city": "Manchester",
    "country": "GB",
    "postalCode": "SP4 7DE",
    "region": null
  },
  "phoneNumber": "+447900000000",
  "businessRoles": [
    "BusinessContact",
    "Director"
  ],
  "verification": {
    "status": "Required",
    "requiredFields": [ … ],
    "requiredDocuments": [ … ],
    "errors": [ … ]
  },
  "documents": [
    { … }
  ],
  "metadata": {
    "accountId": "1"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

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

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