post https://api.staging.pungle.co/api/v1/transactions/pull
Create a transaction to debit a Financial Account
for a specific amount.
This has the effect of Pulling
funds from a Financial Account
so that the amount will appear as a debit on the Financial Account
.
Request
Field | Type | Description |
---|---|---|
amount | integer, required | transaction amount, smallest unit of selected currency (example 100000 for $100.00 CAD ) |
currency | string, required | transaction currency, 3 character code |
product | string, required | To proceed with this transaction, an active subscription for the product is mandatory and if a pull transaction_id is provided, it must correspond to the designated pull product |
financial_account | string, required | id of the financial account to pull funds from |
idempotency_key | string | unique value to associate with the transaction request |
three_d_secure_id | string | id from 3D Secure Authentication |
external_tag | string | User defined external tag |
EFT only fields
These fields will exclusively impact transactions conducted 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 | Provides the option to specify an alternate originator for EFT transactions, seperate from the default choice. |
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. |