---
updatedAt: 2025-05-19T21:13:17.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# Residential Rent Collection / Property Management

```curl cURL
 curl --request POST \
     --url https://earthnode-dev.vopay.com/api/v2/account/client-accounts/business \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data 'AccountID={AccountID}' \
     --data 'Key={APIKey}' \
     --data 'Signature={Signature}' \
     --data FirstName=Ada \
     --data LastName=Lovelace \
     --data EmailAddress=ada.lovelace@gmail.com \
     --data 'Address1=123 Fake St' \
     --data City=Vancouver \
     --data Province=BC \
     --data Country=CA \
     --data PostalCode=A1A1A1 \
     --data Currency=CAD \
     --data 'BusinessName=Lovelace Properties' \
     --data BusinessNumber=123456789 \
     --data BusinessTypeID=8 \
     --data BusinessTypeCategoryID=0 \
     --data BusinessWebsite=https://lovelaceproperties.com \
     --data BusinessPhone=5551234567 \
     --data FinancialInstitutionNumber=010 \
     --data BranchTransitNumber=12345 \
     --data AccountNumber=1234567
     
 curl --request POST \
     --url https://earthnode-dev.vopay.com/api/v2/account/client-accounts/individual \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data 'AccountID={AccountID}' \
     --data 'Key={APIKey}' \
     --data 'Signature={Signature}' \
     --data FirstName=Grace \
     --data LastName=Hopper \
     --data EmailAddress=grace.hopper@gmail.com \
     --data 'Address1=123 Fake St' \
     --data City=Vancouver \
     --data Province=BC \
     --data Country=CA \
     --data PostalCode=A1A1A1 \
     --data Currency=CAD \
     --data DOB=02/29/1980 \
     --data SINLastDigits=1234 \
     --data FinancialInstitutionNumber=001 \
     --data BranchTransitNumber=12345 \
     --data AccountNumber=1234567
 
curl --request POST \
     --url https://earthnode-dev.vopay.com/api/v2/account/client-accounts/fund-transfer-withdraw/schedule \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data 'AccountID={AccountID}' \
     --data 'Key={APIKey}' \
     --data 'Signature={Signature}' \
     --data DebitorClientAccountID=GraceHopperInd \
     --data RecipientClientAccountID=AdaLovelaceBus \
     --data Amount=1500 \
     --data Frequency=monthly \
     --data ScheduleStartDate=2023-01-01 \
     --data ScheduleEndDate=2023-12-31 \
     --data 'Description=Monthly Rent'
```

```javascript JavaScript
const sdk = require('api')('@vopay-api/v2.0#1k6f827lavrdxve');

sdk.clientAccountBusinessPOST({
  AccountID: '{AccountID}',
  Key: '{APIKey}',
  Signature: '{Signature}',
  FirstName: 'Ada',
  LastName: 'Lovelace',
  EmailAddress: 'ada.lovelace@gmail.com',
  Address1: '123 Fake St',
  City: 'Vancouver',
  Province: 'BC',
  Country: 'CA',
  PostalCode: 'A1A1A1',
  Currency: 'CAD',
  BusinessName: 'Lovelace Properties',
  BusinessNumber: '123456789',
  BusinessTypeID: 8,
  BusinessTypeCategoryID: 0,
  BusinessWebsite: 'https://lovelaceproperties.com',
  BusinessPhone: '5551234567',
  FinancialInstitutionNumber: '010',
  BranchTransitNumber: '12345',
  AccountNumber: '1234567'
}, {accept: 'application/json'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));


sdk.clientAccountIndividualPOST({
  AccountID: '{AccountID}',
  Key: '{APIKey}',
  Signature: '{Signature}',
  FirstName: 'Grace',
  LastName: 'Hopper',
  EmailAddress: 'grace.hopper@gmail.com',
  Address1: '123 Fake St',
  City: 'Vancouver',
  Province: 'BC',
  Country: 'CA',
  PostalCode: 'A1A1A1',
  Currency: 'CAD',
  DOB: '02/29/1980',
  SINLastDigits: 1234,
  FinancialInstitutionNumber: '001',
  BranchTransitNumber: '12345',
  AccountNumber: '1234567'
}, {accept: 'application/json'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));


sdk.clientAccountFundTransferWithdrawSchedulePOST({
  AccountID: '{AccountID}',
  Key: '{APIKey}',
  Signature: '{Signature}',
  DebitorClientAccountID: 'GraceHopperInd',
  RecipientClientAccountID: 'AdaLovelaceBus',
  Amount: 1500,
  Frequency: 'monthly',
  ScheduleStartDate: '2023-01-01',
  ScheduleEndDate: '2023-12-31',
  Description: 'Monthly Rent'
}, {accept: 'application/json'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));
```

```php PHP
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://earthnode-dev.vopay.com/api/v2/account/client-accounts/business', [
  'form_params' => [
    'AccountID' => '{AccountID}',
    'Key' => '{APIKey}',
    'Signature' => '{Signature}',
    'FirstName' => 'Ada',
    'LastName' => 'Lovelace',
    'EmailAddress' => 'ada.lovelace@gmail.com',
    'Address1' => '123 Fake St',
    'City' => 'Vancouver',
    'Province' => 'BC',
    'Country' => 'CA',
    'PostalCode' => 'A1A1A1',
    'Currency' => 'CAD',
    'BusinessName' => 'Lovelace Properties',
    'BusinessNumber' => '123456789',
    'BusinessTypeID' => 8,
    'BusinessTypeCategoryID' => 0,
    'BusinessWebsite' => 'https://lovelaceproperties.com',
    'BusinessPhone' => '5551234567',
    'FinancialInstitutionNumber' => '010',
    'BranchTransitNumber' => '12345',
    'AccountNumber' => '1234567'
  ],
  'headers' => [
    'accept' => 'application/json',
    'content-type' => 'application/x-www-form-urlencoded',
  ],
]);

echo $response->getBody();


$response = $client->request('POST', 'https://earthnode-dev.vopay.com/api/v2/account/client-accounts/individual', [
  'form_params' => [
    'AccountID' => '{AccountID}',
    'Key' => '{APIKey}',
    'Signature' => '{Signature}',
    'FirstName' => 'Grace',
    'LastName' => 'Hopper',
    'EmailAddress' => 'grace.hopper@gmail.com',
    'Address1' => '123 Fake St',
    'City' => 'Vancouver',
    'Province' => 'BC',
    'Country' => 'CA',
    'PostalCode' => 'A1A1A1',
    'Currency' => 'CAD',
    'DOB' => '02/29/1980',
    'SINLastDigits' => 1234,
    'FinancialInstitutionNumber' => '001',
    'BranchTransitNumber' => '12345',
    'AccountNumber' => '1234567'
  ],
  'headers' => [
    'accept' => 'application/json',
    'content-type' => 'application/x-www-form-urlencoded',
  ],
]);

echo $response->getBody();


$response = $client->request('POST', 'https://earthnode-dev.vopay.com/api/v2/account/client-accounts/fund-transfer-withdraw/schedule', [
  'form_params' => [
    'AccountID' => '{AccountID}',
    'Key' => '{APIKey}',
    'Signature' => '{Signature}',
    'DebitorClientAccountID' => 'GraceHopperInd',
    'RecipientClientAccountID' => 'AdaLovelaceBus',
    'Amount' => 1500,
    'Frequency' => 'monthly',
    'ScheduleStartDate' => '2023-01-01',
    'ScheduleEndDate' => '2023-12-31',
    'Description' => 'Monthly Rent'
  ],
  'headers' => [
    'accept' => 'application/json',
    'content-type' => 'application/x-www-form-urlencoded',
  ],
]);

echo $response->getBody();

?>
```

```python Python
import requests

url = "https://earthnode-dev.vopay.com/api/v2/account/client-accounts/business"

payload = "AccountID=%7BAccountID%7D&Key=%7BAPIKey%7D&Signature=%7BSignature%7D&FirstName=Ada&LastName=Lovelace&EmailAddress=ada.lovelace%40gmail.com&Address1=123%20Fake%20St&City=Vancouver&Province=BC&Country=CA&PostalCode=A1A1A1&Currency=CAD&BusinessName=Lovelace%20Properties&BusinessNumber=123456789&BusinessTypeID=8&BusinessTypeCategoryID=0&BusinessWebsite=https%3A%2F%2Flovelaceproperties.com&BusinessPhone=5551234567&FinancialInstitutionNumber=010&BranchTransitNumber=12345&AccountNumber=1234567"
headers = {
    "accept": "application/json",
    "content-type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)


url = "https://earthnode-dev.vopay.com/api/v2/account/client-accounts/individual"

payload = "AccountID=%7BAccountID%7D&Key=%7BAPIKey%7D&Signature=%7BSignature%7D&FirstName=Grace&LastName=Hopper&EmailAddress=grace.hopper%40gmail.com&Address1=123%20Fake%20St&City=Vancouver&Province=BC&Country=CA&PostalCode=A1A1A1&Currency=CAD&DOB=02%2F29%2F1980&SINLastDigits=1234&FinancialInstitutionNumber=001&BranchTransitNumber=12345&AccountNumber=1234567"
headers = {
    "accept": "application/json",
    "content-type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)


url = "https://earthnode-dev.vopay.com/api/v2/account/client-accounts/fund-transfer-withdraw/schedule"

payload = {
    "AccountID": "{AccountID}",
    "Key": "{APIKey}",
    "Signature": "{Signature}",
    "DebitorClientAccountID": "GraceHopperInd",
    "RecipientClientAccountID": "AdaLovelaceBus",
    "Amount": 1500,
    "Frequency": "monthly",
    "ScheduleStartDate": "2023-01-01",
    "ScheduleEndDate": "2023-12-31",
    "Description": "Monthly Rent"
}
headers = {
    "accept": "application/json",
    "content-type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)
```

```json Response Example
{"success":true}
```

# Add a property

<!-- curl@1-25 -->
<!-- javascript@3-27 -->
<!-- php@6-36 -->
<!-- python@3-13 -->

Create a client account for each property you manage

# Add a tenant

<!-- curl@27-47 -->
<!-- javascript@30-50 -->
<!-- php@39-65 -->
<!-- python@16-26 -->

Create a client account for each tenant

# Collect the rent

<!-- curl@49-62 -->
<!-- javascript@53-66 -->
<!-- php@68-87 -->
<!-- python@29-50 -->

Transfer funds from the renter to the property owner on a monthly schedle