A transaction requires two Financial Accounts: a debit account and a credit account. These accounts must belong to the Business Account associated with the request access token.
Debit Financial Account
The funds will be taken from this account. The debit account can be a Business Financial Account or a Customer Financial Account.
Credit Financial Account
The funds will be transferred to this account. The credit account can be a Business Financial Account, a Recipient Financial Account, or a Customer Financial Account.
POST /v1/transactions
Authorization: Bearer <access_token>
Idempotency-Key: <key>
where <key> is a v4 UUID or any other unique string with a minimum length of 6 characters and a maximum length of 255 characters.
The idempotency key identifies the request. If a network error occurs, you can safely retry the request using the same idempotency key and the request will only be executed once. This ensures that calling the API multiple times will not result in duplicate requests. For more information, see Idempotent Calls.
metadata
string, max items: 6, value max length: 1024
Use a maximum of 6 key/value pairs to store additional information with a transaction.
debitFinancialAccountId REQUIRED
string (UUID)
ID of the Financial Account used as the debit account (source of the funds) for the transaction.
creditFinancialAccountId REQUIRED
string (UUID)
ID of the Financial Account used as the credit account (receiver of the funds) for the transaction.
transactionType REQUIRED
string enum, values: SEND, REQUEST, REVERSAL
Type of transaction. The following values are supported:
SEND, REQUEST, and REVERSAL transactions are originated on RocketKOR.
solution REQUIRED
string enum, values: push-to-card, ach, wire
Name of the RocketKOR solution used for the transaction. The following values are supported:
paymentReasonId REQUIRED
string
ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.
amount REQUIRED
string (currency)
Amount to be transferred from the debit account to the credit account. Must be a positive number. The 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.
settlementPriority
string enum, values: IMMEDIATE, SAME_DAY, NEXT_DAY, SCHEDULED, default: IMMEDIATE
Expected priority for settling the transaction. The following values are supported:
This parameter is configurable for some RocketKOR solutions, such as ACH. Note that Push to Card transactions always use the IMMEDIATE settlement priority.
description CONDITIONAL
string, max length: 100
Required for the Wire solution. Not available for other solutions. Brief description of the transaction.
If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.
memo
string, max length: 100
Only available for the Wire solution. Brief additional note about the transaction.
If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.
Returns the Transaction object. This object contains the transaction details, including a unique ID for the transaction.
SAMPLE REQUEST
{
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"transactionType": "SEND",
"solution": "ach",
"paymentReasonId": "loan-payouts",
"amount": "1000.00",
"currency": "USD",
"settlementPriority": "SAME_DAY",
"description": "",
"memo": ""
}
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",
"transactionType": "SEND",
"solution": "ach",
"paymentReasonId": "loan-payouts",
"paymentReason": "Loan Payouts",
"amount": "1000.00",
"currency": "USD",
"settlementPriority": "SAME_DAY",
"latestStatus": {
"status": "NEW",
"message": "Transaction creation successful",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z"
},
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z",
"reversalReason": "",
"description": "",
"memo": ""
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.