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 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. 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.
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.
transactionType REQUIRED
string enum, values: SEND, REQUEST, REVERSAL
Type of transaction. Possible values are:
solution REQUIRED
string enum, values: push-to-card, ach
Name of the RocketKOR solution used for the transaction. Possible values are:
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.
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. 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.
Returns the transaction details, including a unique ID for the transaction. For details, see the Transaction object.
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"
}
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-44b+7-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",
"createdAt": "2021-07-01T17:40:22.601Z"
},
"createdAt": "2021-07-01T17:40:22.601Z",
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"reversalReason": ""
}
© 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.