RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Create a Transaction

A transaction requires two Financial Accounts: a debit account and a credit account. These accounts must belong to the Business Account associated with the access token included in the request.

Debit Financial Account
The funds will be taken from this account. The debit account can be a Business Financial Account or a Recipient Financial Account.

Credit Financial Account
The funds will be disbursed to this account. The credit account can be a Business Financial Account or a Recipient Financial Account.

Endpoint

POST /transactions

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Idempotency-Key Header

Idempotency-Key: <key>

where <key> is a v4 UUID or any other unique string.

Provide a unique idempotency key in the Idempotency-Key header. The idempotency key is a unique string that identifies the transaction.

If you need to retry a request, using the same idempotency key ensures that the subsequent request will not result in the creation of a duplicate transaction.

Request Body

metadata

string, max items: 5, value max length: 1024

Use a maximum of 5 key/value pairs to store additional information with a transaction.

debitFinancialAccountId  REQUIRED

string (UUID)

ID for the Financial Account used as the funding account (source of the disbursed funds).

creditFinancialAccountId  REQUIRED

string (UUID)

ID for the Financial Account used as the deposit account (receiver of the disbursed funds).

transactionType  REQUIRED

string enum, values: SEND, REQUEST

Type of transaction. Possible values are:

  • SEND  Instruction to push funds from a Financial Account to another account.
  • REQUEST  Instruction to pull funds to a Financial Account from another account.

SEND and REQUEST transactions are originated on RocketKOR.

solution  REQUIRED

string enum, values: push-to-card

Name of the RocketKOR solution used for the transaction.

paymentReason

string

Payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.

amount  REQUIRED

number, minimum value: 0

Amount to be disbursed from the debit account to the credit account. Must be a positive number.

Note  This amount must conform to any transaction limits.

currency  REQUIRED

string

Currency used for the transaction. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.

Returns

Returns the transaction details, including a unique ID for the transaction. For details, see the Transaction object.

SAMPLE REQUEST

				
					{
  "debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "transactionType": "SEND",
  "solution": "push-to-card",
  "paymentReasonId": "loan-payouts",
  "amount": 1000.00,
  "currency": "USD"
}
				
			

SAMPLE RESPONSE

				
					{
  "id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
  "businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
  "metadata": {
    "myPaymentId": "100000333",
    "invoiceNumber": "123232333",
    "authorizedBy": "user@email.com"
  },
  "debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "solution": "push-to-card",
  "paymentReasonId": "loan-payouts",
  "paymentReason": "Loan Payouts",
  "amount": 1000.00,
  "currency": "USD",
  "latestStatus": {
    "status": "NEW",
    "message": "Transaction creation successful",
    "createdAt": "2021-07-01T17:40:22.601Z"
  },
  "createdAt": "2021-07-01T17:40:22.601Z",
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  }
}