Rize API Endpoints

POST/baas/transfer-internal

Authorization

bearer

Body

application/json

fromAccountId*string

Example: "999900854129"

amount*string

Example: "4.99"

toAccountIdstring

Example: "999900830665"

toAccountNumberstring

Example: "746978438"

toRoutingNumberstring

Example: "746978438"

toFirstNamestring

Example: "Trinity"

toLastNamestring

Example: "Dickson"

isRecurringboolean

Example: true

recurringTransferall of

Only validated if the recurring transfer is true

Response

201400401404422

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/transfer-internal', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fromAccountId": "999900854129",
      "amount": "4.99"
    }),
});
const data = await response.json();

Response

201400401404422

{
  "statusCode": 201
}

POST/baas/transfer-ach

Authorization

bearer

Body

application/json

fromAccountId*string

Example: "999900857817"

amount*string

Example: "24.99"

toAccountIdstring

Example: "myAccountId"

toAccountNumberstring

Example: "86704702"

toRoutingNumberstring

Example: "746978438"

toFirstNamestring

Example: "Trinity"

toLastNamestring

Example: "Dickson"

debitCreditIndicatorenum

Example: "credit"

creditdebit

toAccountTypeenum

Example: "checking"

checkingsavingsmoneyMarket

isRecurringboolean

Example: true

recurringTransferall of

Only validated if the recurring transfer is true

Response

201400401404422

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/transfer-ach', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fromAccountId": "999900857817",
      "amount": "24.99"
    }),
});
const data = await response.json();

Response

201400401404422

{
  "statusCode": 201
}

GET/baas/recurring-transfers

Authorization

bearer

Query parameters

Response

200401

Successful operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401

{
  "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"
        }
      }
    ]
  }
}

GET/baas/recurring-transfers/jobs/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401404

Successful operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/jobs/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404

{
  "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"
    }
  }
}

DELETE/baas/recurring-transfers/jobs/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401404

Successful operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/jobs/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404

{
  "statusCode": 200
}

GET/baas/recurring-transfers/jobs

Authorization

bearer

Query parameters

Response

200401

Successful operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/jobs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401

{
  "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"
        }
      }
    ]
  }
}

GET/baas/recurring-transfers/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401404

Successful operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404

{
  "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"
    }
  }
}

PUT/baas/recurring-transfers/{id}

Authorization

bearer

Path parameters

id*string

Body

application/json

amountstring

Example: 10

frequencyenum

Example: "monthly"

monthly

frequencyDatanumber

Example: 1

memostring

Example: "Water Bill"

durationTypeenum

Example: "continuous"

continuousnumberOfTransfers

startingDatestring (date-time)

Example: "2023-03-17"

doTransferboolean

Helps to identify if the frontend has selected "set today" or "future date" for the first transfer

Example: true

transfersQuantitynumber

Only validated if the recurring transfer duration type is "numberOfTransfers"

Example: 0

Response

200400401404

Successful operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404

{
  "statusCode": 200
}

DELETE/baas/recurring-transfers/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401404

Successful operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404

{
  "statusCode": 200
}

PUT/baas/recurring-transfers/{id}/deactivate

Authorization

bearer

Path parameters

id*string

Response

200400401404

Successful operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/{id}/deactivate', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404

{
  "statusCode": 200
}

PUT/baas/recurring-transfers/{id}/activate

Authorization

bearer

Path parameters

id*string

Body

application/json

localDateTime*string (date-time)

Local datetime of the user

Example: "2023-04-21"

Response

200400401404

Successful operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/recurring-transfers/{id}/activate', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "localDateTime": "2023-04-21"
    }),
});
const data = await response.json();

Response

200400401404

{
  "statusCode": 200
}