Business Treasury Prime API Endpoints
acct_11j3vge7ksyqt2
4.99
acct_11j3vge7ksyqt3
746978438
746978438
Trinity
Dickson
true
Only validated if the recurring transfer is true
Successful Operation.
{"statusCode":201}
Any parameter that was sent is invalid.
Failed because the authentication token was not sent or it has already expired.
Customer has not been created
Error processing the information
Internal server error.
POST /baas/transfer-internal HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 398
{
"fromAccountId": "acct_11j3vge7ksyqt2",
"amount": "4.99",
"toAccountId": "acct_11j3vge7ksyqt3",
"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
}
acct_11j3vge7ksyqt3
24.99
cp_11j3vge7ksyqt3
86704702
746978438
Trinity
Dickson
credit
Possible values: checking
Possible values: true
Only validated if the recurring transfer is true
Successful Operation.
{"statusCode":201}
Error processing the information
Failed because the authentication token was not sent or it has already expired.
Customer has not been created
Error processing the information
Internal server error.
POST /baas/transfer-ach HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 455
{
"fromAccountId": "acct_11j3vge7ksyqt3",
"amount": "24.99",
"toAccountId": "cp_11j3vge7ksyqt3",
"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
}
100
0
Rent
["0,500"]
Successful operation
Failed because the authentication token was not sent or it has already expired.
Internal server error.
GET /baas/recurring-transfers HTTP/1.1
Host:
Authorization: Bearer JWT
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 was not sent or it has already expired.
Recurring transfer job not found or is not of this user
Internal server error.
GET /baas/recurring-transfers/jobs/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
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 was not sent or it has already expired.
Recurring transfer job not found or is not of this user
Internal server error.
DELETE /baas/recurring-transfers/jobs/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
100
0
Successful operation
Failed because the authentication token was not sent or it has already expired.
Internal server error.
GET /baas/recurring-transfers/jobs HTTP/1.1
Host:
Authorization: Bearer JWT
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 was not sent or it has already expired.
Recurring transfer not found or is not of this user
Internal server error.
GET /baas/recurring-transfers/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
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"
}
}
}
10
monthly
Possible values: 1
Water Bill
continuous
Possible values: 2023-03-17
Helps to identify if the frontend has selected "set today" or "future date" for the first transfer
true
Only validated if the recurring transfer duration type is "numberOfTransfers"
0
Successful operation
{"statusCode":200}
This error can occur because of an invalid value or a value is required
Error because the authentication token was not sent, it has already expired, or you do not have access to the business you want to access.
Recurring transfer not found or is not of this user
Error processing the information
Internal server error.
PUT /baas/recurring-transfers/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
businessId: text
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 was not sent or it has already expired.
Recurring transfer not found or is not of this user
Internal server error.
DELETE /baas/recurring-transfers/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
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 was not sent or it has already expired.
Recurring transfer not found or is not of this user
Internal server error.
PUT /baas/recurring-transfers/{id}/deactivate HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
Local datetime of the user
2023-04-21
Successful operation
{"statusCode":200}
This error can occur because of an invalid value or a value is required
Failed because the authentication token was not sent or it has already expired.
Recurring transfer not found or is not of this user
Internal server error.
PUT /baas/recurring-transfers/{id}/activate HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"localDateTime": "2023-04-21"
}
{
"statusCode": 200
}
Last updated
Was this helpful?