# Accounts

Account registration for your sub accounts

## Create a new sub account

 - [POST /accounts](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/subaccountcreate.md): This is for registering new users onto your platform that will act as one of your 'sub' accounts

## Retrieve a sub account by Id

 - [GET /accounts/{id}](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/subaccountgetbyid.md): This is used to fetch details for one of your sub accounts.

## Update a sub account by Id

 - [PATCH /accounts/{id}](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/subaccountupdate.md): This is used to update the details of one of your sub accounts. This API can only be accessed for NonHosted sub accounts.

## Verify a 'Business' entity sub account

 - [POST /accounts/{id}/verify](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/subaccountverify.md): Once you have created all Persons and satisfied all the verification requirements for them and the Business, you submit these details for verification. This endpoint cannot be accessed for Individual sub accounts as this process is done automatically after satisfying the verification requirements.

## Create a manual payout for a sub account

 - [POST /accounts/{id}/payouts](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/payoutcreate.md): Used to create manual payouts for a specified sub account.
This API can only be accessed for NonHosted sub accounts that are configured for manual payouts.
Note that the following requirements must be met:
  - the payoutMethodId supplied must have status equal to Valid
  - amount must be greater than or equal to the minimum configured payout amount for the account (e.g. £100)
  - verification.status cannot be Required on the account
  - frozen must not be true on the account

## List payouts for a sub account

 - [GET /accounts/{id}/payouts](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/payoutslist.md): Used to fetch a paginated list of payouts for the given sub account

## Retrieve a a payout for a sub account by Id

 - [GET /accounts/{id}/payouts/{payoutId}](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/payoutgetbyid.md): This is used to fetch a payout by its unique Id

## Create a link for a sub account to authorize their account

 - [POST /accounts/authorize](https://developer.ryftpay.com/documentation/api/reference/openapi/accounts/subaccountauthorize.md): 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.

## Create a manual payout for a sub account

 - [POST /accounts/{id}/payouts](https://developer.ryftpay.com/documentation/api/reference/openapi/payouts/payoutcreate.md): Used to create manual payouts for a specified sub account.
This API can only be accessed for NonHosted sub accounts that are configured for manual payouts.
Note that the following requirements must be met:
  - the payoutMethodId supplied must have status equal to Valid
  - amount must be greater than or equal to the minimum configured payout amount for the account (e.g. £100)
  - verification.status cannot be Required on the account
  - frozen must not be true on the account

## List payouts for a sub account

 - [GET /accounts/{id}/payouts](https://developer.ryftpay.com/documentation/api/reference/openapi/payouts/payoutslist.md): Used to fetch a paginated list of payouts for the given sub account

## Retrieve a a payout for a sub account by Id

 - [GET /accounts/{id}/payouts/{payoutId}](https://developer.ryftpay.com/documentation/api/reference/openapi/payouts/payoutgetbyid.md): This is used to fetch a payout by its unique Id