Welcome to the Transactions section of our API. Here, we define the endpoints that enable you to initiate and manage Automated Clearing House (ACH) transactions. Whether you are pushing funds (sending money) or pulling funds (requesting money), these endpoints provide the interactivity your applications need to perform these operations.
Endpoints
Here are the endpoints of the APIs in the Transactions section:
- POST/transaction/ach/funding- performs an ACH funding transaction.
- POST/transaction/ach/manualExtract- Manually marks one return ACH transaction extracted, in case status was not updated due to some error.
- POST/transaction/ach/noc/search -Finds ACH transactions that have received NOC(Notification of Change).
- POST /transaction/ach/pull- Performs an ACH pull transaction.
POST /transaction/ach/push
- Performs an ACH push transaction.- POST/transaction/ach/return- Returns ACH transactions.
- POST /transaction/ach/search- Finds ACH transactions.
- POST/transaction/ach/withdrawal - Performs an ACH withdrawal transaction.
- GET/transaction/ach/{id} - Gets one ACH transaction.
- GET/transaction/ach/{id}/return- Gets one return ACH transaction.
- POST/transaction/ach/{id}/reverse-Reverses an ACH transaction.
- POST/transaction/adjustment/credit- Applies a credit adjustment.
- POST/transaction/adjustment/debit- Applies a debit adjustment.
- POST/transaction/fee/onetime- Applies a one-time fee debit.
- POST/transaction/internal/ecommerce- Performs an ecommerce transaction.
- POST/transaction/internal/metome- Performs a me-to-me transaction.
- POST/transaction/internal/metoyou)- Performs a me-to-you transaction.
- PUT/transaction/pending/cancel- Cancels a pending transaction.
- PUT/transaction/pending/review/approve/{paymentId}- Unblocks a transaction in manual review.
- PUT/transaction/pending/review/reject/{paymentId}- Rejects a transaction in manual review.
- POST/transaction/pos- Performs a point-of-sale (POS) transaction.
- POST/transaction/search- Searches posted transaction details within a ledger.
- GET/transaction/transactionTypes- Gets a list of all active transaction types.
- POST/transaction/wire/inbound- Applies a one-time fee debit.
-
Main Objects
These main objects are:
- Amount Object
- TransactionStatus Object
- TransactionType Object
- AchStatus Object
- Date Object
- Direction Object
Amount Object:
- amount: It refers to the numeric value representing the amount involved in the transaction.
- op: It represents the operation to be performed, like 'greater than or equal to' (gte).
- value: It signifies the threshold value for the operation.
TransactionStatus Object:
- transactionStatus: It denotes the current status of the transaction such as 'POSTED'
TransactionType Object:
- transactionType: It represents the type of transaction like 'ADJUSTMENT_CREDIT'
AchStatus Object:
- achStatus: It shows the current status of the Automated Clearing House transaction - 'INITIATED'
Date Object:
- beginDate: Date from when the transaction is effective or started.
- endDate: Date when the transaction came into effect or ended.
- updatedStart: Start date of when the transaction was last updated.
- updatedEnd: End date of when the transaction was last updated.
Direction Object:
- direction: It represents whether the transaction is a 'CREDIT' or 'DEBIT'.
Parameters
Transaction table of parameters, default values, and definitions:
Parameter | Default Value | Definition |
---|---|---|
amount | 0 | The amount involved in the transaction |
beneficiaryAccountNumber | "string" | The account number of the beneficiary |
imad | "string" | Inbound Message Authentication Data |
omad | "string" | Outbound Message Authentication Data |
originatorAccountNumber | "string" | The account number of the transaction originator |
originatorBankName | "string" | The name of the bank of the transaction originator |
originatorRoutingNumber | "string" | The routing number of the bank of the transaction originator |
originatorToBeneficiaryInfo | "string" | Contains additional information relating to the transaction |
accountNumber | "string" | Account number associated with the transaction |
achStatus | "INITIATED" | The status of the Automated Clearing House transaction (ACH) |
amount.op | "gte" | The operation to be performed on the transaction amount |
amount.value | "string" | The threshold value for the operation on the transaction amount |
beginDate | "2024-03-02T18:31:14.966Z" | The date the transaction is effective or started |
endDate | "2024-03-02T18:31:14.966Z" | The date the transaction came into effect or ended |
externalId | "string" | External identification for the transaction |
linkedPaymentId | "string" | The id of any linked payment related to this transaction |
paymentId | "string" | The payment id of the transaction |
productId | 0 | The identifier for the product relating to the transaction |
transactionStatus | "POSTED" | The current status of the transaction |
transactionType | "ADJUSTMENT_CREDIT" | The type of transaction |
updatedEnd | "2024-03-02T18:31:14.966Z" | The end date when the transaction was last updated |
updatedStart | "2024-03-02T18:31:14.966Z" | The start date when the transaction was last updated |
note | "string" | Notes or comments related to the transaction |
recipientAccountNumber | "string" | The account number of the recipient in the transaction |
reference | "string" | The reference information for the transaction |
senderAccountNumber | "string" | The account number of the sender in the transaction |
reason | "string" | The reason field relevant for some transactions |
notes | "string" | More detailed notes or comments related to the transaction |
settlementAccountNumber | "string" | The account number where the transaction amount will be settled |
subType | "SETUP_FEE" | It represents the subtype of the transaction |
description | "string" | A description of the transaction |
counterparty | "string" | The other party involved in the transaction |
direction | "CREDIT" | Indicates whether the transaction is a credit or debit |