Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Accounts

Create a link for a sub account to authorize their account

We recommend calling this endpoint first when you onboard your users to cater for those that may already have Ryft accounts. If the email supplied is not registered with Ryft then you should instead use our account-links API to register a new user. This API can only be accessed for Hosted sub accounts.

post/accounts/authorize

Request body

emailstring email

The main email address for the account

redirectUrlstring

The URL to redirect back to once the customer has authenticated (success/fail). We will append the accountId under query parameter account for the customer onto your redirectUrl once they successfully authenticate. You should check for this parameter once the customer returns and store it for future use.

Example request

{
  "email": "test@ryftpay.com",
  "redirectUrl": "https://mywebsite.com/account/verification?p1=kjr4jbnm4bm4b5mnb"
}

Response

Successfully created temporary auth link

createdTimestampinteger

The epoch timestamp (seconds) when the temporary auth link was created

expiresTimestampinteger

The epoch timestamp (seconds) when the temporary auth link expires

urlstring

The URL to redirect to.

Example response

{
  "createdTimestamp": 1631696701,
  "expiresTimestamp": 1631703901,
  "url": "https://sandbox-dash.ryftpay.com/signin?atl=123"
}