EFT

Base URL

The base URL for all API requests is:

https://apigateway.payfirma.com

Balance

Returns wallet balance for EFT to do instant transactions else would be a few days for settlement.

Response

Returns a JSON object with the following properties:

• available_balance: fund available balance currently for transaction

• actual_balance: total balance - Funds are in the wallet

Example:

Request

Response:

Incoming Request - EFT Debit

Returns list of incoming requests asking you for funds - EFT Debit

Response

Returns a JSON object with the following properties:

• incoming_requests: Array of objects of incoming request

  • amount: amount asking for processor_transaction_id: unique identifier

  • email: email of the user asking for

  • status: status of the request

  • redirect_url: redirect URL to start EFT transaction date: date of the EFT request

  • description: description of the EFT request

Example:

Request:

Response:

Requesting Funds - EFT Credit

Requesting funds to PayHQ customer via EFT - EFT Credit

Request Body

Response

Returns a JSON object with the following properties:

• amount: amount requested

• email: email of the customer request sent to

• card_type: Type of Card Transaction(Internal Use)

• description: description of the EFT request sent

• id: unique identifier for PayHQ

• transaction_id: unique identifier for PayHQ hashed

• transaction_success: Is request sent successfully

• transaction_result: result of the EFT request sent - at first would be “PENDING” until other user do some action on it. Status would be updated on your side too

• transaction_time: time of request epoch time format transaction_type: Type of the transaction(Internal Use)

Example:

Request:

Response:

Bank Deposit:

Deposit to your linked bank account from your wallet available balance

Request Body

Response:

Only status 200 - If successful else 400 with error message

Example:

Request:

Send Funds - EFT Debit

Send funds to the customer’s Bank account directly - EFT Debit

Request Body

Response

Returns a JSON object with the following properties:

• amount: amount to send

• email: email of the customer

• first_name: first name of the customer

• last_name: last name of the customer

• province: province(in code) - BC

• country: country(in code) - CA

• card_type: Type of Card Transaction(Internal Use) description: description of the EFT request sent

• id: unique identifier for PayHQ

• transaction_id: unique identifier for PayHQ hashed transaction_success: Is request sent successfully

• transaction_result: result of the EFT request sent - at first would be “PENDING” until other user do some action on it. Status would be updated on your side too

• transaction_time: time of request epoch time format

• transaction_type: Type of the transaction(Internal Use)

Example:

Request:

Response: