Create Transaction

Create Transaction for immediate disbursement.

Visit the About Transactions to learn more about Transaction methods, types, and requests parameters.

Response Codes
102 - Idempotent matched request currently processing
201 - Created, will include a Location response header
200 - Request Succeeded, but entity not created
400 - Bad Request, missing or invalid parameters
409 - Idempotent matched request already processed
422 - Request not process due to business constraints

📘

ACH & RTP Transaction Requests

The initial status from the ACH & RTP transaction request will be PROCESSING.

  • ACH
    • The initial PROCESSING status depends on the banking partner processing the ACH funds movement. Our team will discuss the status differences during the integration/onboarding process.
    • ACH transactions can be processed "same day" (business day) or the "standard" 3-5 days. The PAID or FAILED status update will trigger a webhook once the final status is known.
  • RTP
    • The roundtrip RTP request could take up to 30 seconds. A webhook will be sent when a definitive status is known.
📘

Card Transaction Requests - Instant Deposit and Instant Funding

Visa and Mastercard networks handle requests with expired cards differently.

  • Visa will accept an expiration date in the past and attempt to process the transaction through the issuing bank. The bank will determine whether or not to honor the transaction. A Visa decline may result in action code 54.
  • Mastercard will reject the transaction request. For this reason, we will validate the card expiration date before processing through Mastercard. If the card is expired, a 422 status code with ERR_CARD_ACCOUNT_EXPIRED will be returned in the API response.
❗️

Transaction ID with Error Response

The transaction_id parameter will not always be present in the error response body. Under certain 400 and 422 scenarios, the response is returned before processing of the transaction occurs.


📘

ACH and AFT Refunds

Transactions can be logically linked by supplying the originating_transaction_id for the CREDIT (payout) transaction. Including the originating_transaction_id will add additional validation checks:

  • Does the originating_transaction_id exist?
  • Is the amount equal or less than the original transaction?

After processing the refund-oriented transaction, the original transaction status will update to REFUNDED or REFUND_PARTIAL.

ACH_REFUND is its own distinct method to link ACH_FUNDING_PLUS transactions.

INSTANT_DEPOSIT can be used to link an INSTANT_FUNDING transactions.

📘

Instant Funding Partial Authorization

Visa allows for an Instant Funding transaction to authorized for a lesser amount if the user has funds available. Transactions that qualify for partial authorization will include the funding_options_response object in the transaction response, shown below. The amount in the Transaction response is the authorized transaction amount. If the authorized amount is not desired by the end-user, a transaction reversal request can be issued via API (Update Transaction).

This feature is enabled by client configuration. Additionally we can configure a minimum amount to authorize. If the amount authorized is below the minimum, we will issue a reversal and fail the transaction with the error code ERR_PARTIAL_AUTH_BELOW_THRESHOLD .

"funding_options_response": {
    "partial_auth_result": {
      "amount_requested": 10,
      "amount_approved": 8,
      "amount_threshold": 5
    }
}
Path Params
string
required

Payer ID

Body Params
string

Recipient ID

string

Payment Account ID

string
enum

Direction of funds - CREDIT funds to Recipient or DEBIT funds from Recipient

Allowed:
string
enum

Transaction method

double

Transaction amount

string

Transaction reference ID - optional

string

Transaction memo - optional

string

Email override for ECHECK transactions - optional

string

JSON string of values to include for reporting requirements. Please consult with technical team on usage.

string

Originating Transaction ID to be referenced in the event of an ACH_REFUND transaction

funding_options
object

Required for Funding Transactions, not applicable for Payout transactions

location
object

Possibly required for compliance purposes

Headers
string

Uniquely generated key

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json