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 maximum length of 255 characters.
Provide a unique idempotency key (a unique string that identifies the transaction) in the Idempotency-Key header. If you need to retry the request, use the same idempotency key to ensure that the subsequent request will not result in the creation of a duplicate transaction batch. For more information, see About Idempotent Transaction 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, value: SEND, REQUEST
Type of transaction. Possible values are:
batchMode
string enum, values: RELAXED, STRICT
default: RELAXED
Batch mode. Possible values are:
solution REQUIRED
string enum, values: push-to-card, ach
Name of the RocketKOR solution used for the transaction batch. Possible values are:
description REQUIRED
string
Description of the transaction batch.
settlementPriority
string enum, values: IMMEDIATE, SAME_DAY, NEXT_DAY, SCHEDULED
default: IMMEDIATE
Expected priority for settling the transactions in the batch. Possible values are:
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
number
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 for the Financial Account used as the debit account (source of the funds) for the transaction.
creditFinancialAccountId REQUIRED
string (UUID)
ID for the Financial Account used as the credit account (receiver of the funds) for the transaction.
paymentReasonId REQUIRED
string
Unique ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.
amount REQUIRED
string
Amount to be transferred from the debit account to the credit account. Must be a positive number.
Note This amount must conform to any transaction limits.
Returns the batch details, including a unique ID for the batch. For details, see the Transaction Batch object.
SAMPLE REQUEST
{
"transactionType": "SEND",
"solution": "push-to-card",
"currency": "USD",
"batchMode": "RELAXED",
"description": "This is a batch",
"transactionCount": 5000,
"totalAmount": 52450.26,
"transactions": [
{
"debitFinancialAccountId": "00303bff-29af-4213-bc7d-d9127a16927e",
"creditFinancialAccountId": "cf2944c7-465b-427c-b933-4d33526b391a",
"amount": "250.00",
"paymentReasonId": "loan-payments"
},
{...},
{...}
]
}
SAMPLE RESPONSE
{
"id": "65078464-2dd1-496a-8a07-7dfd9e36b0a0",
"businessAccountId": "77051b4b-4c5f-4f65-af6d-87a8b61f73a6",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"transactionType": "SEND",
"batchMode": "RELAXED",
"solution": "push-to-card",
"description": "This is a batch",
"settlementPriority": "SAME_DAY",
"currency": "USD",
"transactionCount": 5000,
"totalAmount": 52450.26,
"status": "PENDING",
"transactions": [
{
"id": "ce0c8e6d-f747-4aff-b607-8a6d1a10968c",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"debitFinancialAccountId": "00303bff-29af-4213-bc7d-d9127a16927e",
"creditFinancialAccountId": "cf2944c7-465b-427c-b933-4d33526b391a",
"paymentReasonId": "loan-payouts",
"amount": "250.00",
"latestStatus": {
"status": "NEW",
"message": "New transaction",
"createdAt": "2023-02-06T01:02:45.943Z"
}
},
{...},
{...}
],
"createdAt": "2023-04-06T01:02:45.943Z",
"createdBy": {
"id": "4bd3aff1-cf97-4480-96f4-cfe3656500a3",
"type": "EMPLOYEE"
}
}
© 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.