Rize API Endpoints
9999008541294.99999900830665746978438746978438TrinityDicksontrueOnly validated if the recurring transfer is true
Successful Operation
This error can occur because of an invalid value / a value is required or for BaaS reasons.
Failed because the authentication token is not sent or it has already expired.
Synthetic account not found
This error can occur because the name of the synthetic account already exists or for other BaaS reasons.
POST /baas/transfer-internal HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 384
{
"fromAccountId": "999900854129",
"amount": "4.99",
"toAccountId": "999900830665",
"toAccountNumber": "746978438",
"toRoutingNumber": "746978438",
"toFirstName": "Trinity",
"toLastName": "Dickson",
"isRecurring": true,
"recurringTransfer": {
"frequency": "monthly",
"startingDate": "2023-03-17",
"durationType": "numberOfTransfers",
"frequencyData": 31,
"memo": "Rent",
"doTransfer": false,
"transfersQuantity": 3
}
}{
"statusCode": 201
}99990085781724.99myAccountId86704702746978438TrinityDicksoncreditPossible values: checkingPossible values: trueOnly validated if the recurring transfer is true
Successful Operation
This error can occur because of an invalid value / a value is required or for BaaS reasons.
Failed because the authentication token is not sent or it has already expired.
Synthetic account not found
This error can occur because the name of the synthetic account already exists or for other BaaS reasons.
POST /baas/transfer-ach HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 442
{
"fromAccountId": "999900857817",
"amount": "24.99",
"toAccountId": "myAccountId",
"toAccountNumber": "86704702",
"toRoutingNumber": "746978438",
"toFirstName": "Trinity",
"toLastName": "Dickson",
"debitCreditIndicator": "credit",
"toAccountType": "checking",
"isRecurring": true,
"recurringTransfer": {
"frequency": "monthly",
"startingDate": "2023-03-17",
"durationType": "numberOfTransfers",
"frequencyData": 31,
"memo": "Rent",
"doTransfer": false,
"transfersQuantity": 3
}
}{
"statusCode": 201
}1000Rent["0,500"]Successful operation
Failed because the authentication token is not sent or it has already expired.
GET /baas/recurring-transfers HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 200,
"data": {
"recurringTransfers": [
{
"id": "284c3de4-0460-408e-a56e-f066507ce43b",
"memo": "Rent",
"amount": "500",
"frequency": "monthly",
"frequencyData": "31",
"status": "ACTIVE",
"durationType": "numberOfTransfers",
"endingDate": "2023-06-10",
"startingDate": "2023-01-20",
"remainingTransfersQuantity": 4,
"from": {
"name": "My general account",
"lastFour": "1234"
},
"to": {
"name": "My general account",
"lastFour": "1234"
}
}
]
}
}Successful operation
This error can occur because of an invalid value or a value is required
Failed because the authentication token is not sent or it has already expired.
Recurring transfer job not found or is not of this user
GET /baas/recurring-transfers/jobs/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 200,
"data": {
"id": "90936b8c-fc3b-4c5c-bf4d-69c3e59548c2",
"memo": "Rent",
"amount": "500",
"scheduledDate": "2023-03-31",
"from": {
"name": "My general account",
"lastFour": "1234"
},
"to": {
"name": "My general account",
"lastFour": "1234"
}
}
}Successful operation
{"statusCode":200}This error can occur because of an invalid value or a value is required
Failed because the authentication token is not sent or it has already expired.
Recurring transfer job not found or is not of this user
DELETE /baas/recurring-transfers/jobs/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 200
}1000Successful operation
Failed because the authentication token is not sent or it has already expired.
GET /baas/recurring-transfers/jobs HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 200,
"data": {
"recurringTransferJobs": [
{
"id": "90936b8c-fc3b-4c5c-bf4d-69c3e59548c2",
"memo": "Rent",
"amount": "500",
"scheduledDate": "2023-03-31",
"from": {
"name": "My general account",
"lastFour": "1234"
},
"to": {
"name": "My general account",
"lastFour": "1234"
}
}
]
}
}Successful operation
This error can occur because of an invalid value or a value is required
Failed because the authentication token is not sent or it has already expired.
Recurring transfer not found or is not of this user
GET /baas/recurring-transfers/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 200,
"data": {
"id": "284c3de4-0460-408e-a56e-f066507ce43b",
"memo": "Rent",
"amount": "500",
"frequency": "monthly",
"frequencyData": "31",
"status": "ACTIVE",
"durationType": "numberOfTransfers",
"endingDate": "2023-06-10",
"startingDate": "2023-01-20",
"remainingTransfersQuantity": 4,
"from": {
"name": "My general account",
"lastFour": "1234"
},
"to": {
"name": "My general account",
"lastFour": "1234"
}
}
}10monthlyPossible values: 1Water BillcontinuousPossible values: 2023-03-17Helps to identify if the frontend has selected "set today" or "future date" for the first transfer
trueOnly validated if the recurring transfer duration type is "numberOfTransfers"
0Successful operation
{"statusCode":200}This error can occur because of an invalid value or a value is required
Failed because the authentication token is not sent or it has already expired.
Recurring transfer not found or is not of this user
PUT /baas/recurring-transfers/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 169
{
"amount": 10,
"frequency": "monthly",
"frequencyData": 1,
"memo": "Water Bill",
"durationType": "continuous",
"startingDate": "2023-03-17",
"doTransfer": true,
"transfersQuantity": 0
}{
"statusCode": 200
}Successful operation
{"statusCode":200}This error can occur because of an invalid value or a value is required
Failed because the authentication token is not sent or it has already expired.
Recurring transfer not found or is not of this user
DELETE /baas/recurring-transfers/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 200
}Successful operation
{"statusCode":200}This error can occur because of an invalid value or a value is required
Failed because the authentication token is not sent or it has already expired.
Recurring transfer not found or is not of this user
PUT /baas/recurring-transfers/{id}/deactivate HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 200
}Local datetime of the user
2023-04-21Successful operation
{"statusCode":200}This error can occur because of an invalid value or a value is required
Failed because the authentication token is not sent or it has already expired.
Recurring transfer not found or is not of this user
PUT /baas/recurring-transfers/{id}/activate HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"localDateTime": "2023-04-21"
}{
"statusCode": 200
}Last updated
Was this helpful?