---
updatedAt: 2026-04-23T04:17:15.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# interac/money-request

This API endpoint is used to create a new Interac money request transaction.

 If a ClientAccountID is provided, the client account's first/last name, and email address will be used for the transaction.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Payment Rails",
    "description": "The Payment Rails API allows you to manage transactions in your account. You can cancel transactions, refund transactions, and confirm flagged transactions.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/interac/money-request": {
      "post": {
        "description": "This API endpoint is used to create a new Interac money request transaction.\n\n If a ClientAccountID is provided, the client account's first/last name, and email address will be used for the transaction.",
        "summary": "interac/money-request",
        "tags": [
          "Interac Endpoints"
        ],
        "operationId": "InteracMoneyRequestPost",
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "AccountID": {
                    "description": "Your account ID",
                    "type": "string"
                  },
                  "Key": {
                    "description": "API key for the account",
                    "type": "string"
                  },
                  "Signature": {
                    "description": "Hashed signature for the request",
                    "type": "string"
                  },
                  "ClientAccountID": {
                    "description": "Client Account ID",
                    "type": "string"
                  },
                  "ContactID": {
                    "description": "The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.",
                    "type": "string"
                  },
                  "PhoneNumber": {
                    "description": "Customer's phone number. (Digits only - no parentheses or dashes allowed.)",
                    "type": "string"
                  },
                  "Address1": {
                    "description": "Customer's address line 1",
                    "type": "string"
                  },
                  "Address2": {
                    "description": "Customer's address line 2",
                    "type": "string"
                  },
                  "City": {
                    "description": "Customer's city",
                    "type": "string"
                  },
                  "Province": {
                    "description": "Customer's province specified using two character abbreviations (eg. BC, AB)",
                    "type": "string"
                  },
                  "Country": {
                    "description": "Customer's country specified using full country name or ISO 3166-1 alpha-2 code.",
                    "type": "string"
                  },
                  "PostalCode": {
                    "description": "Customer's postal code.",
                    "type": "string"
                  },
                  "Amount": {
                    "description": "The amount to debit from the customer's bank account.",
                    "type": "number"
                  },
                  "Currency": {
                    "description": "3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency (generally CAD).  NOTE: Currently the eft/fund API endpoint only supports CAD transactions.",
                    "type": "string"
                  },
                  "EmailAddress": {
                    "description": "Email address the interac money request transaction was sent to.",
                    "type": "string"
                  },
                  "RecipientName": {
                    "description": "The money transfer recipient's name",
                    "type": "string"
                  },
                  "MessageForRecipient": {
                    "description": "An optional message set by client for the recipient. Maximum 140 characters.",
                    "type": "string"
                  },
                  "Notes": {
                    "description": "An optional note to associate with the transaction.",
                    "type": "string"
                  },
                  "ClientReferenceNumber": {
                    "description": "An optional reference number which was associated with the transaction. This can only be used to look up the transaction if it was a unique ID.",
                    "type": "string"
                  },
                  "GenerateURL": {
                    "description": "Generate a URL for the money request instead of sending an e-mail.",
                    "type": "boolean"
                  },
                  "IdempotencyKey": {
                    "description": "A unique key which the server can use to recognize and reject subsequent retries of the same request.",
                    "type": "string"
                  },
                  "GLCode": {
                    "description": "An optional unique identification general ledger code.",
                    "type": "string"
                  },
                  "TransactionTypeCode": {
                    "description": "CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).",
                    "type": "string"
                  }
                },
                "required": [
                  "AccountID",
                  "Key",
                  "Signature",
                  "Amount",
                  "Currency",
                  "EmailAddress",
                  "RecipientName"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "TransactionID": {
                      "type": "integer",
                      "description": "The unique ID of the transaction",
                      "example": "1122"
                    },
                    "TransactionStatus": {
                      "type": "string",
                      "description": "A message indicating the current transaction status. Statuses are: requested, pending, successful, failed, cancelled",
                      "example": "pending"
                    },
                    "Flagged": {
                      "type": "string",
                      "description": "Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.",
                      "example": "The transaction has been flagged as a potential duplicate.",
                      "x-absent-when": "transaction not flagged"
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "TransactionID",
                    "TransactionStatus"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```