post https://api.staging.pungle.co/api/v1/transactions/push
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
Field | Type | Description |
---|---|---|
amount | integer, required | transaction amount, smallest unit in currency (example 10000 for $100.00 CAD ) |
currency | string, required | transaction currency, 3 character code |
financial_account | string, required | id of the financial account to pull funds from |
product | string, required | To proceed with this transaction, an active subscription is mandatory, and if a pull transaction_id is provided, it must correspond to the designated pull transaction product |
pull_transaction_id | string | id of the corresponding pull transaction |
idempotency_key | string | unique value to associate with the transaction request |
external_tag | string | User defined external tag |
EFT only fields
These fields will only effect transactions on the EFT network.
Field | Type | Description |
---|---|---|
descriptor | string, optional | Descriptor that will be displayed to the owner of the financial account. Usually an invoice or pay stub number |
originator_id | number, optional | Allows sending a different originator with the EFT than the default. |
E-Transfer only fields
These fields will only effect E-Transfers.
Field | Type | Description |
---|---|---|
security_question | string, required for push | question to answer for e-transfer payment |
security_question_answer | string, 3-25 characters, no white-space, required for push | answer to the security_question provided |
Response
Field | Value | Description |
---|---|---|
status | string | The transaction status |
id | alphanumeric | The transaction ID |
financial_account | alphanumeric | The encrypted financial account associated with the transaction |
currency | string | The country currency for the transaction |
amount | number | The amount of the transaction |
gateway_codes | array | Codes returned from the gateway. Each code is an object that includes a code and message field. |