Rize API Endpoints

post

Authorizations

Body

fromAccountIdstringrequiredExample: 999900854129

amountstringrequiredExample: 4.99

toAccountIdstringoptionalExample: 999900830665

toAccountNumberstringoptionalExample: 746978438

toRoutingNumberstringoptionalExample: 746978438

toFirstNamestringoptionalExample: Trinity

toLastNamestringoptionalExample: Dickson

isRecurringbooleanoptionalExample: true

recurringTransferall ofoptional

Only validated if the recurring transfer is true

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/baas/transfer-internal' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

201

400

401

404

422

201

{
  "statusCode": 201
}

Successful Operation

post

Authorizations

Body

fromAccountIdstringrequiredExample: 999900857817

amountstringrequiredExample: 24.99

toAccountIdstringoptionalExample: myAccountId

toAccountNumberstringoptionalExample: 86704702

toRoutingNumberstringoptionalExample: 746978438

toFirstNamestringoptionalExample: Trinity

toLastNamestringoptionalExample: Dickson

debitCreditIndicatorstring · enumoptionalExample: creditAvailable options:

toAccountTypestring · enumoptionalExample: checkingAvailable options:

isRecurringbooleanoptionalExample: true

recurringTransferall ofoptional

Only validated if the recurring transfer is true

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/baas/transfer-ach' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

201

400

401

404

422

201

{
  "statusCode": 201
}

Successful Operation

get

Authorizations

Query parameters

limitstringoptionalExample: 100

offsetstringoptionalExample: 0

searchstringoptionalExample: Rent

statusesstring · enum[]optionalExample: ["ACTIVE"]

frequenciesstring · enum[]optionalExample: ["monthly"]

amountsstring[]optionalExample: ["0,500"]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/baas/recurring-transfers' \
  --header 'Authorization: Bearer JWT'

200

401

200

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

get

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/baas/recurring-transfers/jobs/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

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

delete

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/baas/recurring-transfers/jobs/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

{
  "statusCode": 200
}

Successful operation

get

Authorizations

Query parameters

limitstringoptionalExample: 100

offsetstringoptionalExample: 0

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/baas/recurring-transfers/jobs' \
  --header 'Authorization: Bearer JWT'

200

401

200

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

get

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/baas/recurring-transfers/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

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

Successful operation

put

Authorizations

Path parameters

idstringrequired

Body

amountstringoptionalExample: 10

frequencystring · enumoptionalExample: monthlyAvailable options:

frequencyDatanumberoptionalExample: 1

memostringoptionalExample: Water Bill

durationTypestring · enumoptionalExample: continuousAvailable options:

startingDatestring · date-timeoptionalExample: 2023-03-17

doTransferbooleanoptional

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

Example: true

transfersQuantitynumberoptional

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

Example: 0

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/baas/recurring-transfers/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 10,
    "frequency": "monthly",
    "frequencyData": 1,
    "memo": "Water Bill",
    "durationType": "continuous",
    "startingDate": "2023-03-17",
    "doTransfer": true,
    "transfersQuantity": 0
  }'

200

400

401

404

200

{
  "statusCode": 200
}

Successful operation

delete

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/baas/recurring-transfers/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

{
  "statusCode": 200
}

Successful operation

put

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/baas/recurring-transfers/{id}/deactivate' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

{
  "statusCode": 200
}

Successful operation

put

Authorizations

Path parameters

idstringrequired

Body

localDateTimestring · date-timerequired

Local datetime of the user

Example: 2023-04-21

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/baas/recurring-transfers/{id}/activate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "localDateTime": "2023-04-21"
  }'

200

400

401

404

200

{
  "statusCode": 200
}

Successful operation