Create Transaction

Create EFT Transaction

curl --request POST \
  --url https://www.{baseurl}.com/api/v1/transactions \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --data '
[
  {
    "transactionCode": 1,
    "amount": 250,
    "description": "Invoice 1001",
    "crossReferenceNumber": "INV-1001",
    "paymentDirection": "DEBIT",
    "currency": "CAD",
    "payor": {
      "accountInfo": {
        "institutionCode": "001",
        "transitNumber": "12345",
        "accountNumber": "1234567"
      },
      "contactInfo": {
        "firstName": "Jane",
        "lastName": "Doe"
      }
    },
    "scheduleInfo": {
      "paymentFrequency": "OneTime",
      "startDate": "2026-04-15"
    }
  }
]
'

import requests

url = "https://www.{baseurl}.com/api/v1/transactions"

payload = [
    {
        "transactionCode": 1,
        "amount": 250,
        "description": "Invoice 1001",
        "crossReferenceNumber": "INV-1001",
        "paymentDirection": "DEBIT",
        "currency": "CAD",
        "payor": {
            "accountInfo": {
                "institutionCode": "001",
                "transitNumber": "12345",
                "accountNumber": "1234567"
            },
            "contactInfo": {
                "firstName": "Jane",
                "lastName": "Doe"
            }
        },
        "scheduleInfo": {
            "paymentFrequency": "OneTime",
            "startDate": "2026-04-15"
        }
    }
]
headers = {
    "x-client-id": "<x-client-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-client-id': '<x-client-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      transactionCode: 1,
      amount: 250,
      description: 'Invoice 1001',
      crossReferenceNumber: 'INV-1001',
      paymentDirection: 'DEBIT',
      currency: 'CAD',
      payor: {
        accountInfo: {institutionCode: '001', transitNumber: '12345', accountNumber: '1234567'},
        contactInfo: {firstName: 'Jane', lastName: 'Doe'}
      },
      scheduleInfo: {paymentFrequency: 'OneTime', startDate: '2026-04-15'}
    }
  ])
};

fetch('https://www.{baseurl}.com/api/v1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.{baseurl}.com/api/v1/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'transactionCode' => 1,
        'amount' => 250,
        'description' => 'Invoice 1001',
        'crossReferenceNumber' => 'INV-1001',
        'paymentDirection' => 'DEBIT',
        'currency' => 'CAD',
        'payor' => [
                'accountInfo' => [
                                'institutionCode' => '001',
                                'transitNumber' => '12345',
                                'accountNumber' => '1234567'
                ],
                'contactInfo' => [
                                'firstName' => 'Jane',
                                'lastName' => 'Doe'
                ]
        ],
        'scheduleInfo' => [
                'paymentFrequency' => 'OneTime',
                'startDate' => '2026-04-15'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-client-id: <x-client-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.{baseurl}.com/api/v1/transactions"

	payload := strings.NewReader("[\n  {\n    \"transactionCode\": 1,\n    \"amount\": 250,\n    \"description\": \"Invoice 1001\",\n    \"crossReferenceNumber\": \"INV-1001\",\n    \"paymentDirection\": \"DEBIT\",\n    \"currency\": \"CAD\",\n    \"payor\": {\n      \"accountInfo\": {\n        \"institutionCode\": \"001\",\n        \"transitNumber\": \"12345\",\n        \"accountNumber\": \"1234567\"\n      },\n      \"contactInfo\": {\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\"\n      }\n    },\n    \"scheduleInfo\": {\n      \"paymentFrequency\": \"OneTime\",\n      \"startDate\": \"2026-04-15\"\n    }\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.{baseurl}.com/api/v1/transactions")
  .header("x-client-id", "<x-client-id>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"transactionCode\": 1,\n    \"amount\": 250,\n    \"description\": \"Invoice 1001\",\n    \"crossReferenceNumber\": \"INV-1001\",\n    \"paymentDirection\": \"DEBIT\",\n    \"currency\": \"CAD\",\n    \"payor\": {\n      \"accountInfo\": {\n        \"institutionCode\": \"001\",\n        \"transitNumber\": \"12345\",\n        \"accountNumber\": \"1234567\"\n      },\n      \"contactInfo\": {\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\"\n      }\n    },\n    \"scheduleInfo\": {\n      \"paymentFrequency\": \"OneTime\",\n      \"startDate\": \"2026-04-15\"\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.{baseurl}.com/api/v1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"transactionCode\": 1,\n    \"amount\": 250,\n    \"description\": \"Invoice 1001\",\n    \"crossReferenceNumber\": \"INV-1001\",\n    \"paymentDirection\": \"DEBIT\",\n    \"currency\": \"CAD\",\n    \"payor\": {\n      \"accountInfo\": {\n        \"institutionCode\": \"001\",\n        \"transitNumber\": \"12345\",\n        \"accountNumber\": \"1234567\"\n      },\n      \"contactInfo\": {\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\"\n      }\n    },\n    \"scheduleInfo\": {\n      \"paymentFrequency\": \"OneTime\",\n      \"startDate\": \"2026-04-15\"\n    }\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "schedules": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "amount": 250,
      "startDate": "2026-04-15T00:00:00",
      "endDate": "0001-01-01T00:00:00",
      "transactionsCount": 1,
      "frequency": "OneTime",
      "payor": {
        "name": "Jane Doe",
        "email": null
      },
      "payee": {
        "name": null,
        "email": null
      },
      "status": "Active",
      "padStatus": null,
      "padId": null,
      "crossReferenceNumber": "INV-1001",
      "paymentDirection": "DEBIT"
    }
  ]
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "errors": {
    "Amount": [
      "Amount should be greater than 1 cent"
    ],
    "ScheduleInfo.StartDate": [
      "Start Date must be in future"
    ]
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "<string>",
  "errors": {}
}

POST

api

transactions

Create EFT Transaction

curl --request POST \
  --url https://www.{baseurl}.com/api/v1/transactions \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --data '
[
  {
    "transactionCode": 1,
    "amount": 250,
    "description": "Invoice 1001",
    "crossReferenceNumber": "INV-1001",
    "paymentDirection": "DEBIT",
    "currency": "CAD",
    "payor": {
      "accountInfo": {
        "institutionCode": "001",
        "transitNumber": "12345",
        "accountNumber": "1234567"
      },
      "contactInfo": {
        "firstName": "Jane",
        "lastName": "Doe"
      }
    },
    "scheduleInfo": {
      "paymentFrequency": "OneTime",
      "startDate": "2026-04-15"
    }
  }
]
'

import requests

url = "https://www.{baseurl}.com/api/v1/transactions"

payload = [
    {
        "transactionCode": 1,
        "amount": 250,
        "description": "Invoice 1001",
        "crossReferenceNumber": "INV-1001",
        "paymentDirection": "DEBIT",
        "currency": "CAD",
        "payor": {
            "accountInfo": {
                "institutionCode": "001",
                "transitNumber": "12345",
                "accountNumber": "1234567"
            },
            "contactInfo": {
                "firstName": "Jane",
                "lastName": "Doe"
            }
        },
        "scheduleInfo": {
            "paymentFrequency": "OneTime",
            "startDate": "2026-04-15"
        }
    }
]
headers = {
    "x-client-id": "<x-client-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-client-id': '<x-client-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      transactionCode: 1,
      amount: 250,
      description: 'Invoice 1001',
      crossReferenceNumber: 'INV-1001',
      paymentDirection: 'DEBIT',
      currency: 'CAD',
      payor: {
        accountInfo: {institutionCode: '001', transitNumber: '12345', accountNumber: '1234567'},
        contactInfo: {firstName: 'Jane', lastName: 'Doe'}
      },
      scheduleInfo: {paymentFrequency: 'OneTime', startDate: '2026-04-15'}
    }
  ])
};

fetch('https://www.{baseurl}.com/api/v1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.{baseurl}.com/api/v1/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'transactionCode' => 1,
        'amount' => 250,
        'description' => 'Invoice 1001',
        'crossReferenceNumber' => 'INV-1001',
        'paymentDirection' => 'DEBIT',
        'currency' => 'CAD',
        'payor' => [
                'accountInfo' => [
                                'institutionCode' => '001',
                                'transitNumber' => '12345',
                                'accountNumber' => '1234567'
                ],
                'contactInfo' => [
                                'firstName' => 'Jane',
                                'lastName' => 'Doe'
                ]
        ],
        'scheduleInfo' => [
                'paymentFrequency' => 'OneTime',
                'startDate' => '2026-04-15'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-client-id: <x-client-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.{baseurl}.com/api/v1/transactions"

	payload := strings.NewReader("[\n  {\n    \"transactionCode\": 1,\n    \"amount\": 250,\n    \"description\": \"Invoice 1001\",\n    \"crossReferenceNumber\": \"INV-1001\",\n    \"paymentDirection\": \"DEBIT\",\n    \"currency\": \"CAD\",\n    \"payor\": {\n      \"accountInfo\": {\n        \"institutionCode\": \"001\",\n        \"transitNumber\": \"12345\",\n        \"accountNumber\": \"1234567\"\n      },\n      \"contactInfo\": {\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\"\n      }\n    },\n    \"scheduleInfo\": {\n      \"paymentFrequency\": \"OneTime\",\n      \"startDate\": \"2026-04-15\"\n    }\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.{baseurl}.com/api/v1/transactions")
  .header("x-client-id", "<x-client-id>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"transactionCode\": 1,\n    \"amount\": 250,\n    \"description\": \"Invoice 1001\",\n    \"crossReferenceNumber\": \"INV-1001\",\n    \"paymentDirection\": \"DEBIT\",\n    \"currency\": \"CAD\",\n    \"payor\": {\n      \"accountInfo\": {\n        \"institutionCode\": \"001\",\n        \"transitNumber\": \"12345\",\n        \"accountNumber\": \"1234567\"\n      },\n      \"contactInfo\": {\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\"\n      }\n    },\n    \"scheduleInfo\": {\n      \"paymentFrequency\": \"OneTime\",\n      \"startDate\": \"2026-04-15\"\n    }\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.{baseurl}.com/api/v1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"transactionCode\": 1,\n    \"amount\": 250,\n    \"description\": \"Invoice 1001\",\n    \"crossReferenceNumber\": \"INV-1001\",\n    \"paymentDirection\": \"DEBIT\",\n    \"currency\": \"CAD\",\n    \"payor\": {\n      \"accountInfo\": {\n        \"institutionCode\": \"001\",\n        \"transitNumber\": \"12345\",\n        \"accountNumber\": \"1234567\"\n      },\n      \"contactInfo\": {\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\"\n      }\n    },\n    \"scheduleInfo\": {\n      \"paymentFrequency\": \"OneTime\",\n      \"startDate\": \"2026-04-15\"\n    }\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "schedules": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "amount": 250,
      "startDate": "2026-04-15T00:00:00",
      "endDate": "0001-01-01T00:00:00",
      "transactionsCount": 1,
      "frequency": "OneTime",
      "payor": {
        "name": "Jane Doe",
        "email": null
      },
      "payee": {
        "name": null,
        "email": null
      },
      "status": "Active",
      "padStatus": null,
      "padId": null,
      "crossReferenceNumber": "INV-1001",
      "paymentDirection": "DEBIT"
    }
  ]
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "errors": {
    "Amount": [
      "Amount should be greater than 1 cent"
    ],
    "ScheduleInfo.StartDate": [
      "Start Date must be in future"
    ]
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "<string>",
  "errors": {}
}

Work in progressThis section is currently under active development as part of improvements planned for 2026. Content may change as we expand product capabilities.If you’re interested in early access or want to learn more about what’s coming, feel free to reach out to the team.

Create a new EFT transaction with optional recurring schedule. Supports both debit (collect from customer) and credit (send to customer) directions. The request body is a JSON array containing one transaction object. Batch transactions are not currently supported.

Validation Rules

DEBIT Transactions

payor is required; payee must be null
startDate must be a future date
OneTime: only startDate is required
Recurring: startDate plus exactly one of endDate or transactionsCount
- endDate must be after startDate
- transactionsCount maximum is 300

CREDIT Transactions

payee is required; payor must be null
Only OneTime frequency is supported
startDate must be today’s date (same-day processing only)

Account Info Logic

Provide either accountId or the combination of institutionCode + transitNumber + accountNumber. You cannot provide both.

Contact Info Logic

Provide either contactId or name fields (firstName + lastName, or legalName). You cannot provide both.

Headers

x-client-id

string

required

Your API key provided during onboarding.

Body

application/json

Required array length: 1 element

transactionCode

integer

required

Three-digit code identifying the payment type, as defined by Payments Canada Standard 007.

Example:

450

amount

number<double>

required

Payment amount. Minimum $0.01.

Required range: x >= 0.01

Example:

250

paymentDirection

enum<string>

required

DEBIT to collect from customer, CREDIT to send to customer.

Available options:

DEBIT,

CREDIT

Example:

"DEBIT"

currency

enum<string>

required

Currency code. Only CAD is supported.

Available options:

CAD

Example:

"CAD"

scheduleInfo

object

required

Show child attributes

description

string

Short description. Max 15 characters.

Maximum string length: 15

Example:

"Invoice 1001"

crossReferenceNumber

string

Your reference identifier. Alphanumeric and hyphens, max 36 characters.

Maximum string length: 36

Pattern: ^[A-Za-z0-9-]+$

Example:

"INV-1001"

purposeCategory

string

Category for the payment purpose.

payor

object | null

Required for DEBIT transactions. Must be null for CREDIT.

Show child attributes

payee

object | null

Required for CREDIT transactions. Must be null for DEBIT.

Show child attributes

Response

Transaction created successfully

schedules

object[]

Show child attributes

⌘I

API Reference

Auth

Connect

Enrich

Outbound

Pay

Upload

Utilities

Validation Rules

DEBIT Transactions

CREDIT Transactions

Account Info Logic

Contact Info Logic

Headers

Body

Response

​Validation Rules

​DEBIT Transactions

​CREDIT Transactions

​Account Info Logic

​Contact Info Logic

Headers

Body

Response

Validation Rules

DEBIT Transactions

CREDIT Transactions

Account Info Logic

Contact Info Logic