🔗
Linker Studio
  • Welcome!!
  • 🚀GETTING STARTED
    • Set up your custom project from Linker Studio
    • How to run the project
    • Linker Features
      • Glossary
      • Web
      • Mobile
        • Aggregators
        • Analytics
        • Authentication
        • BaaS
        • Carousel
        • Client Support
        • Error and Crash Reporting
        • Info Onboarding
        • KYC
        • Payroll
        • Pii Onboarding
        • Push Notifications - OneSignal
        • Settings
        • Subscriptions
      • Backend
        • Authentication
        • MFA
        • BaaS
        • Aggregators
        • Notifications
        • Payments
        • Deposit Switching
        • Support
        • Vault
        • Storage
        • Monitoring
        • Analytics
  • 🖥️WEB FEATURES
    • Page 2
  • 📱Mobile App Features
    • Project File Structure
    • Figma Tokens Integration
    • Core Module
      • Core UI Components
        • Atoms
        • Molecules
        • Organisms
        • Templates
      • Core Elements
      • Hooks
        • Force update
      • Endpoints used
      • States And Selectors
        • contentsDocuments
    • Modules
      • [New Feature Template]- Feature Name
        • UI Components - Template
          • Atoms
          • Molecules
          • Organisms
          • Templates
        • Hooks - Template
        • Endpoints Used
        • States and Selectors - Template
      • 📥KYC
        • Alloy
        • Baas
          • UI Components
            • Templates
          • Hooks - Template
          • Endpoints Used
          • States and Selectors - Template
        • common
          • UI Components
            • Templates
          • Endpoints Used
      • 🤝Aggregators
        • Plaid
          • Plaid/Rize notification before disabling account
      • 🤖Analytics
        • Amplitude
      • 🔐Authentication
        • Hooks
        • Auth0
          • Hooks
            • Login
            • Forgot password
          • 📧Verify Email
            • Hooks
        • Biometrics
          • Hooks
        • Auto Logout
        • States And Selectors
          • Authentication
      • 💰BaaS
        • Common
          • BaaS Navigation
          • External Accounts
          • UI Components
            • Molecules
            • Organisms
            • Templates
          • Hooks
            • Statements
            • Recurrent Transfers
            • Cards
              • Get Full Card
              • Lock and Unlock
              • Request Physical Debit Card
              • Reissue Debit Card
              • Set / Reset Debit Card Pin
            • Transfer
          • States And Selectors
            • Customer
            • Accounts
            • Cards
            • Transactions
          • Endpoints used
          • Constants
            • ACH_SERVICES
        • treasury
          • Constants
            • CONFIG_VALUES
      • 🛂Client Support
      • 🐛Error and Crash Reporting
        • Crashlytics
      • ℹ️Info Onboarding
        • States and Selectors
        • Hooks
          • Physical Card Request
      • 🌯Linker Wrapper
        • Linker Wrapper Messages Structure
        • Linker Wrapper Features
          • Push Notifications
            • Braze
          • In-App Purchase
      • 🛗MFA Verification Code
        • UI Components
          • Molecules
          • Templates
        • Hooks
        • Endpoints used
        • Configurable Constants
      • 🗞️Payroll
        • UI Components
          • Organisms
          • Templates
        • Hooks
        • States and Selectors
      • 📋PII Onboarding
        • UI Components
          • Atoms
          • Molecules
          • Organisms
          • Templates
        • Hooks
        • States and Selectors
      • 🔔Push Notifications
        • OneSignal
      • 🔧Settings
      • 🗄️Vault
        • VGS Show
        • VGS Collect
    • Cookbook
      • 🏦Neobank
        • Linked Functionalities
          • Edit Personal Details Linking
          • Request Physical Debit Card Linking
          • Get customer Data after SignUp/Login
  • ⛓️Backend API
    • Environments
    • Migrations
      • Configuration
      • Migration Commands
      • Base Model
      • Migration Structure
    • Seeds and Factories
      • Configuration
      • Seeds And Factories
    • SoftDelete
    • DB Fields Encryption
    • DB Structure
    • DB Configuration Table
      • API Endpoints
    • Orchestrator
    • Swagger
      • Setup
      • Decorators for Requests and Responses
      • Decorators for Controllers and HTTP Responses
      • Auth Decorator
      • Multiple Decorators
  • 🪙Finance Integrations
    • Recurring Transfers
      • Architecture
      • Jobs Server
      • Functionality
      • BaaS
        • Rize API Endpoints
        • Treasury Prime API Endpoints
        • Business Treasury Prime API Endpoints
    • BaaS
      • Rize
        • Env Variables
        • Rize API authentication
        • Onboarding
          • Customer Enrollment
          • Get Compliance Workflow
          • Acknowledge Compliance Workflow
          • Customer Complete Enrollment
        • KYC - Know Your Customer
          • Get KYC Documents
          • Upload KYC Document
        • Accounts
          • Get Customer Accounts
          • Get Customer Account By ID
          • Create Customer Account
          • Archive Customer Account
          • Get ACH Customer Accounts
        • Debit Cards
          • Get Debit Cards
          • Get Debit Card Image
          • Lock Debit Card
          • Unlock Debit Card
          • Create Physical Card
          • Activate Debit Card
          • Get Debit Card Set-Pin URL
          • Reissue Debit Card
        • Transactions
          • Get Transactions
        • Transfers
          • Internal Transfers
          • ACH transfers
        • Statements
          • Get Statements
          • Get Statement Document
        • Fake Transactions
        • Message Queue
        • Web Sockets
        • API Endpoints
          • Account Enums
          • Debit Card Enums
          • Transaction Enums
          • KYC Enums
      • Galileo
        • Environment Variables
        • Onboarding
          • Get Customer
          • Customer Enrollment
          • Customer Complete Enrollment
        • Customer Management
          • Get Profile
          • Update Profile
        • Accounts
        • Add Accounts
        • Card Management
          • Get Debit Cards
          • Get Image Card
          • Card Statuses
          • Debit Card Activation
          • Request Physical Card
          • Set PIN
          • Lock/Unlock
        • Transfer
        • Transactions
          • Get Transactions
          • Filter Transactions
        • ACH
          • Add ACH Account
          • Get ACH Accounts
          • Remove ACH Account
          • ACH Transactions
        • Statements
        • Plaid Integration
      • Synapse
        • Environment Variables
        • Terminology
        • Resources
        • API Endpoints
    • Aggregators
      • Add Account Service and new DB Table
      • Plaid
        • Plaid Configuration
        • Application Creation
        • Custom Application
        • Configure Single or Multi Accounts
        • Security Settings
        • Verification of Environment Variables
        • API Endpoints
        • Resources
        • Integrations
          • Rize
      • MX
        • Env Configuration
        • API Endpoints
  • 🔐Authentication
    • Auth0
      • Configuration
      • Protecting an endpoint
      • Email verification
      • API Reference
    • Twilio
      • 2FA
        • Verify Service Configuration
        • Verification Workflow
        • API Endpoints
  • 🪪 KYC
    • Persona
      • Configuration
      • Environment Variables
      • KYC Flow
  • ✉️ Mailings
    • Sendgrid
      • Configuration
      • Environment Variables
      • Send Email with Attachments
  • 🆘Supports
    • Zendesk
      • Configuration
      • API Endpoints
  • 📳NOTIFICATIONS
    • OneSignal
      • Schema
      • Setup
      • Environment Variables
      • API Endpoints
  • 🔐Security
    • VGS
      • Configuration
      • Rize Route Configuration
      • VGS Vault Basics
      • VGS Show
  • 🖥️MONITORING
    • New Relic
      • Configuration
      • Interceptor
  • 🧑‍🔧CONTENT ADMINISTRATOR
    • Notifications
    • Onboardings
      • DB Schema
      • Admin - API Endpoints
      • Client - API Endpoints
    • Documents
      • Document Category
      • Document
      • Client - API Endpoints
      • Admin - API Endpoints
    • App Versions
      • Device App Versions
      • API - Administrator
      • API - Client
  • 💵Payments
    • Stripe
      • Configuration
      • Customers
      • Sources
      • Authorization
      • Charges
      • API Endpoints
Powered by GitBook
On this page

Was this helpful?

  1. Finance Integrations
  2. Recurring Transfers
  3. BaaS

Treasury Prime API Endpoints

PreviousRize API EndpointsNextBusiness Treasury Prime API Endpoints

Last updated 2 years 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/baas/transfer-ach
  • POST/baas/transfer-internal
  • GET/baas/recurring-transfers
  • GET/baas/recurring-transfers/jobs/{id}
  • DELETE/baas/recurring-transfers/jobs/{id}
  • GET/baas/recurring-transfers/jobs
  • GET/baas/recurring-transfers/{id}
  • PUT/baas/recurring-transfers/{id}
  • DELETE/baas/recurring-transfers/{id}
  • PUT/baas/recurring-transfers/{id}/deactivate
  • PUT/baas/recurring-transfers/{id}/activate
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
}
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
}
put
Authorizations
Path parameters
idstringRequired
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
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} HTTP/1.1
Host: 
Authorization: Bearer JWT
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
}