Treasury Prime API Endpoints

PreviousRize API Endpoints NextBusiness Treasury Prime API Endpoints

Last updated 1 year ago

Was this helpful?

post

/baas/transfer-ach

Authorizations

Header parameters

Idempotency-Keystring

Body

fromAccountIdstringrequired

Example: acct_11j3vge7ksyqt3

amountstring · 00.00required

Example: 24.99

toAccountIdstring

Example: cp_11j3vge7ksyqt3

toAccountNumberstring

Example: 86704702

toRoutingNumberstring

Example: 746978438

toFirstNamestring

Example: Trinity

toLastNamestring

Example: Dickson

isRecurringboolean

Example: true

debitCreditIndicatorstring · enum

Example: credit

Options: credit, debit

toAccountTypestring · enum

Example: checking

Options: checking, savings, moneyMarket

recurringTransferall of

Only validated if the recurring transfer is true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/transfer-ach' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"fromAccountId":"acct_11j3vge7ksyqt3","amount":"24.99","toAccountId":"cp_11j3vge7ksyqt3","toAccountNumber":"86704702","toRoutingNumber":"746978438","toFirstName":"Trinity","toLastName":"Dickson","isRecurring":true,"debitCreditIndicator":"credit","toAccountType":"checking","recurringTransfer":{"startingDate":"2023-03-17","frequencyData":31,"memo":"Rent","doTransfer":false,"transfersQuantity":3,"frequency":"monthly","durationType":"numberOfTransfers"}}'

201

400

401

403

422

500

{
  "statusCode": 201
}

Successful Operation.

post

/baas/transfer-internal

Authorizations

Header parameters

Idempotency-Keystring

Body

fromAccountIdstringrequired

Example: acct_11j3vge7ksyqt2

amountstring · 00.00required

Example: 4.99

toAccountIdstringrequired

Example: acct_11j3vge7ksyqt3

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/transfer-internal' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"fromAccountId":"acct_11j3vge7ksyqt2","amount":"4.99","toAccountId":"acct_11j3vge7ksyqt3","toAccountNumber":"746978438","toRoutingNumber":"746978438","toFirstName":"Trinity","toLastName":"Dickson","isRecurring":true,"recurringTransfer":{"startingDate":"2023-03-17","frequencyData":31,"memo":"Rent","doTransfer":false,"transfersQuantity":3,"frequency":"monthly","durationType":"numberOfTransfers"}}'

201

400

401

403

422

500

{
  "statusCode": 201
}

Successful Operation.

get

/baas/recurring-transfers

Authorizations

Query parameters

limitstring

Example: 100

offsetstring

Example: 0

searchstring

Example: Rent

statusesstring · enum[]

Example: ["ACTIVE"]

frequenciesstring · enum[]

Example: ["monthly"]

amountsstring[]

Example: ["0,500"]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

500

{
  "statusCode": 200,
  "data": {
    "recurringTransfers": [
      {
        "id": "284c3de4-0460-408e-a56e-f066507ce43b",
        "memo": "Rent",
        "amount": "500",
        "frequencyData": "31",
        "endingDate": "2023-06-10",
        "startingDate": "2023-01-20",
        "remainingTransfersQuantity": 4,
        "frequency": "monthly",
        "status": "ACTIVE",
        "durationType": "numberOfTransfers",
        "from": {
          "name": "My general account",
          "lastFour": "1234"
        },
        "to": {
          "name": "My general account",
          "lastFour": "1234"
        }
      }
    ]
  }
}

Successful operation

get

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

404

500

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

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

404

500

{
  "statusCode": 200
}

Successful operation

get

/baas/recurring-transfers/jobs

Authorizations

Query parameters

limitstring

Example: 100

offsetstring

Example: 0

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

500

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

/baas/recurring-transfers/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

404

500

{
  "statusCode": 200,
  "data": {
    "id": "284c3de4-0460-408e-a56e-f066507ce43b",
    "memo": "Rent",
    "amount": "500",
    "frequencyData": "31",
    "endingDate": "2023-06-10",
    "startingDate": "2023-01-20",
    "remainingTransfersQuantity": 4,
    "frequency": "monthly",
    "status": "ACTIVE",
    "durationType": "numberOfTransfers",
    "from": {
      "name": "My general account",
      "lastFour": "1234"
    },
    "to": {
      "name": "My general account",
      "lastFour": "1234"
    }
  }
}

Successful operation

put

/baas/recurring-transfers/{id}

Authorizations

Path parameters

idstringrequired

Body

amountstring

Example: 10

frequencyDatanumber

Example: 1

memostring

Example: Water Bill

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

frequencystring · enum

Example: monthly

Options: monthly

durationTypestring · enum

Example: continuous

Options: continuous, numberOfTransfers

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

404

500

{
  "statusCode": 200
}

Successful operation

delete

/baas/recurring-transfers/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

404

500

{
  "statusCode": 200
}

Successful operation

put

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

404

500

{
  "statusCode": 200
}

Successful operation

put

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

Authorizations

Path parameters

idstringrequired

Body

localDateTimestring · date-timerequired

Local datetime of the user

Example: 2023-04-21

Responses

application/json

cURL

JavaScript

Python

HTTP

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

500

{
  "statusCode": 200
}

Successful operation