The available parameters for each workflow step are described in the following sections. There are no parameters for the customer-account step.
phoneNumber REQUIRED
string
Customer’s mobile phone number. The LinX request is sent to this number via SMS.
channel
string enum, values: SMS
Notification method used to send the request to the Customer. If channel is not provided, the default value SMS will be used.
introductoryMessage
string
Introductory text to add to the beginning of the SMS message. If introductoryMessage is not provided, a default message will be used.
customerId REQUIRED
string (UUID)
ID of the Customer Account.
personalInfo
array
Customer profile fields. Any or all of the following values can be provided:
addresses
array
Customer’s address. Any or all of the following values can be provided:
phoneNumber
array
Customer’s phone number. One of the following values can be provided:
financialAccountSubType REQUIRED
string enum; values for BANK Financial Accounts: CHECKING, SAVING; values for CARD Financial Accounts: CREDIT, DEBIT
Financial Account subtype.
customerFinancialAccountId REQUIRED
string (UUID)
ID of an existing Customer Financial Account.
documents REQUIRED
array
Documents to be accepted by the Customer.
documentId
string
Semantic document ID. Identifies the type of acceptance document.
documentGroup
string
Group to which the document belongs.
The following documents can be added to the document-acceptance step.
|
Document |
documentId |
documentGroup |
|---|---|---|
|
Communications Consent Form |
ebt-communication-consent | bank-accounts |
|
Privacy Policy |
fncl-privacy-policy |
rocket-financial |
transactionType REQUIRED
string enum, values: SEND, REQUEST
Type of transaction. The following values are supported:
solution REQUIRED
string enum, values: push-to-card, ach, wire
RocketKOR solution used for the transaction.
baFinancialAccountId REQUIRED
string (UUID)
ID of the second Financial Account to be used in the transaction.
currency REQUIRED
string
Currency used for the transaction. Must be an ISO 4217 alpha 3-character currency code.
amount REQUIRED
number
Amount of the transaction.
priority CONDITIONAL
string enum, values: IMMEDIATE, SAME_DAY, NEXT_DAY, SCHEDULED
default value: IMMEDIATE
Required for ACH and Wire transactions.
Expected priority for settling the transaction. The following values are supported:
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.
paymentReasonId REQUIRED
string
ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
