Business Treasury Prime API Endpoints

PreviousTreasury Prime API Endpoints NextBaaS

Last updated 1 year ago

Was this helpful?

get

Authorizations

Query parameters

limitstringOptionalExample: 100

offsetstringOptionalExample: 0

searchstringOptionalExample: Rent

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

Responses

200

Successful operation

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

500

Internal server error.

application/json

get

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

get

Authorizations

Path parameters

idstringRequired

Responses

200

Successful operation

application/json

400

This error can occur because of an invalid value or a value is required

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

Recurring transfer job not found or is not of this user

application/json

500

Internal server error.

application/json

get

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

delete

Authorizations

Path parameters

idstringRequired

Responses

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or a value is required

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

Recurring transfer job not found or is not of this user

application/json

500

Internal server error.

application/json

delete

DELETE /baas/recurring-transfers/jobs/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200
}

get

Authorizations

Query parameters

limitstringOptionalExample: 100

offsetstringOptionalExample: 0

Responses

200

Successful operation

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

500

Internal server error.

application/json

get

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

get

Authorizations

Path parameters

idstringRequired

Responses

200

Successful operation

application/json

400

This error can occur because of an invalid value or a value is required

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

Recurring transfer not found or is not of this user

application/json

500

Internal server error.

application/json

get

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

delete

Authorizations

Path parameters

idstringRequired

Responses

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or a value is required

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

Recurring transfer not found or is not of this user

application/json

500

Internal server error.

application/json

delete

DELETE /baas/recurring-transfers/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200
}

put

Authorizations

Path parameters

idstringRequired

Responses

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or a value is required

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

Recurring transfer not found or is not of this user

application/json

500

Internal server error.

application/json

put

PUT /baas/recurring-transfers/{id}/deactivate HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200
}

post

Authorizations

Header parameters

Idempotency-KeystringOptional

Body

fromAccountIdstringRequiredExample: acct_11j3vge7ksyqt2

amountstring · 00.00RequiredExample: 4.99

toAccountIdstringRequiredExample: acct_11j3vge7ksyqt3

toAccountNumberstringOptionalExample: 746978438

toRoutingNumberstringOptionalExample: 746978438

toFirstNamestringOptionalExample: Trinity

toLastNamestringOptionalExample: Dickson

isRecurringbooleanOptionalExample: true

recurringTransferall ofOptional

Only validated if the recurring transfer is true

Responses

201

Successful Operation.

application/json

ResponseanyExample: {"statusCode":201}

400

Any parameter that was sent is invalid.

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

403

Customer has not been created

application/json

422

Error processing the information

application/json

500

Internal server error.

application/json

post

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
}

post

Authorizations

Header parameters

Idempotency-KeystringOptional

Body

fromAccountIdstringRequiredExample: acct_11j3vge7ksyqt3

amountstring · 00.00RequiredExample: 24.99

toAccountIdstringOptionalExample: cp_11j3vge7ksyqt3

toAccountNumberstringOptionalExample: 86704702

toRoutingNumberstringOptionalExample: 746978438

toFirstNamestringOptionalExample: Trinity

toLastNamestringOptionalExample: Dickson

debitCreditIndicatorstring · enumOptionalExample: creditPossible values:

toAccountTypestring · enumOptionalExample: checkingPossible values:

isRecurringbooleanOptionalExample: true

recurringTransferall ofOptional

Only validated if the recurring transfer is true

Responses

201

Successful Operation.

application/json

ResponseanyExample: {"statusCode":201}

400

Error processing the information

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

403

Customer has not been created

application/json

422

Error processing the information

application/json

500

Internal server error.

application/json

post

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
}

put

Authorizations

Path parameters

idstringRequired

Header parameters

businessIdstringRequired

Body

amountstringOptionalExample: 10

frequencystring · enumOptionalExample: monthlyPossible values:

frequencyDatanumberOptionalExample: 1

memostringOptionalExample: Water Bill

durationTypestring · enumOptionalExample: continuousPossible values:

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

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or a value is required

application/json

401

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.

application/json

404

Recurring transfer not found or is not of this user

application/json

422

Error processing the information

application/json

500

Internal server error.

application/json

put

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
}

put

Authorizations

Path parameters

idstringRequired

Body

localDateTimestring · date-timeRequired

Local datetime of the user

Example: 2023-04-21

Responses

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or a value is required

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

Recurring transfer not found or is not of this user

application/json

500

Internal server error.

application/json

put

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
}