GUIDES

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Developer Guides  /  About the RocketKOR APIs

About the RocketKOR APIs

About the APIs

The RocketKOR APIs make it easy to embed financial services into your products and services, such as your business-to-business or business-to-consumer web and mobile applications.

With the APIs, you can create and manage recipients, create unlimited recipient Financial Accounts, create and manage fund disbursements to consumer or business customers (real-time, same day, or next day), and keep detailed notes about all of your activities.

Our API categories are described in the following sections.

Recipient Account APIs

A recipient is a person or business with whom you wish to conduct transactions. A Recipient Account contains the recipient’s profile information (name, contact information, date of birth, and so on).

These APIs can be used to:

  • Create a new Recipient Account
  • Update a Recipient Account
  • Retrieve details for a Recipient Account
  • Retrieve a list of Recipient Accounts
  • Suspend a Recipient Account
  • Remove a Recipient Account

Recipient Financial Account APIs

Recipient Financial Accounts are the accounts owned by a recipient, such as bank accounts, debit cards, and prepaid cards.

These APIs can be used to:

  • Create a new Recipient Financial Account
  • Retrieve a recipient’s default Financial Account
  • Retrieve a list of Recipient Financial Accounts belonging to a Recipient Account
  • Retrieve a list of Recipient Financial Accounts belonging to a Business Account
  • Suspend a Recipient Financial Account
  • Remove a Recipient Financial Account

Business Financial Account APIs

Business Financial Accounts are the accounts owned by your organization, such as bank accounts, debit cards, and prepaid cards.

These APIs can be used to:

  • Retrieve a list of Business Financial Accounts belonging to a Business Account

Transaction APIs

A transaction is the transfer of funds from one account to another account.

These APIs can be used to:

  • Create a new transaction
  • Retrieve details for a transaction
  • Retrieve a transaction’s status history
  • Search transactions

Note APIs

Notes can be added to Financial Accounts, Recipient Accounts, Team Members, and transactions.

These APIs can be used to:

  • Create a new note
  • Update a note
  • Retrieve details for a note
  • Retrieve a list of notes
  • Remove a note
ON THIS PAGE