Create Push Transaction

Create a transaction to credit a Financial Account for a specific amount.

This has the effect of Pushing funds to a Financial Account so that the amount will appear as a credit
on the Financial Account.

Request

FieldTypeDescription
amountinteger, requiredtransaction amount, smallest unit in currency (example 10000 for $100.00 CAD )
currencystring, requiredtransaction currency, 3 character code
financial_accountstring, requiredid of the financial account to pull funds from
productstring, requiredproduct for transaction, must have an active subscription for this product and must match pull transaction product if a pull transaction_id is supplied
pull_transaction_idstringid of the corresponding pull transaction
idempotency_keystringunique value to associate with the transaction request

EFT only fields

These fields will only have effect for transactions on the EFT network.

FieldTypeDescription
descriptorstring, optionalDescriptor that will be displayed to the owner of the financial account. Usually an invoice or pay stub number
originator_idnumber, optionalAllows sending a different originator with the EFT than the default.

E-Transfer only fields

These fields will only have effect for E-Transfers.

FieldTypeDescription
security_questionstring, required for push

question to answer for e-transfer payment

security_question_answerstring, 3-25 characters, no white-space, required for pushanswer to the security_question provided

Response

FieldValueDescription
statusstringThe transaction status
idalphanumericThe transaction ID
financial_accountalphanumericThe encrypted financial account associated with the transaction
currencystringThe country currency for the transaction
amountnumberThe amount of the transaction
gateway_codesarrayCodes returned from the gateway. Each code is an object that includes a code and message field.
Language
URL
Click Try It! to start a request and see the response here!