Submit multiple transactions as a batch. You can submit a maximum of 10,000 transactions in a single request. Transactions will be validated and processed as individual transactions.
POST /v1/transaction-batches
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 batch.
transactionType REQUIRED
string enum, values: SEND, REQUEST
Type of transaction. The following values are supported:
batchMode
string enum, values: RELAXED, STRICT
default value: RELAXED
Batch mode. The following values are supported:
solution REQUIRED
string
Name of the RocketKOR solution used for the transaction batch.
description REQUIRED
string
Description of the transaction batch.
settlementPriority
string enum, values: IMMEDIATE, SAME_DAY, NEXT_DAY, SCHEDULED
default value: IMMEDIATE
Expected priority for settling the transactions in the batch. 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.
currency REQUIRED
string
Currency used for the transactions in the batch. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.
transactionCount REQUIRED
integer (int32)
Total number of transactions in the batch.
totalAmount REQUIRED
string (currency)
Total amount of all transactions in the batch.
transactions
object
Transactions in the batch.
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.
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.
The URI of the newly created transaction batch is returned in the Location header.
SAMPLE REQUEST
{
"metadata": {
"department": "billing"
},
"transactionType": "SEND",
"batchMode": "RELAXED",
"solution": "push-to-card",
"description": "This is a batch",
"settlementPriority": "SAME_DAY",
"currency": "USD",
"transactionCount": 5000,
"totalAmount": 52450.26,
"transactions": [
{
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"debitFinancialAccountId": "00303bff-29af-4213-bc7d-d9127a16927e",
"creditFinancialAccountId": "cf2944c7-465b-427c-b933-4d33526b391a",
"paymentReasonId": "loan-payments",
"amount": "250.00"
},
{...},
{...}
]
}
SAMPLE RESPONSE
{
201 Batch created successfully. Batch resource URI is returned in the Location header.
}
© 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.