Interac e-Transfer

Initialize an Interac e-Transfer

Initialization

POST /payment-sessions

Incoming

Sample Request

{
    "customer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[e-mail]",
        "phone_number": "[phone]",
        "billing_address": {
            "line1": "123 Main St",
            "line2": "234 Zit",
            "city": "Springfield",
            "state": "ON",
            "country": "CA",
            "zip_code": "12345"
        }
    },
    "description": "Test",
    "currency": "CAD",
    "amount": 10000,
    "direction": "incoming",
    "payment_method": {
        "type": "interac",
    },
    "reference": "1b09d9b2-11jd9eheveb-9203v02g",
    "metadata": {
        "order": {
            "identifier": "ORD12345",
            "items": [
                {
                    "name": "Deposit",
                    "type": "digital"
                }
            ]
        }
    }
}

Sample Response

{
    "data": {
        "auth_type": null,
        "expires_at": null,
        "links": {
            "url": "https://"
            "gateway_url": "https://"
        },
        "message": "Pending",
        "payment": {
            "amount": 1000,
            "cancellation_reason": "",
            "correlation_id": "68516aac-e860-11ee-b44a-aedb120c6c16",
            "currency": "CAD",
            "customer": {
                "billing_address": {
                    "city": "Ontario",
                    "country": "CA",
                    "line1": "Opposite Sasa Estate",
                    "line2": "123 Abc street",
                    "state": "ON",
                    "zip_code": "08665"
                },
                "business_id": "3d6c9e2e-1caf-4807-97ff-bbd35fc4dc1b",
                "email": "[e-mail]",
                "first_name": "Enitan",
                "id": "d05e51df-809e-498a-ac3f-7acfc0b5d35d",
                "last_name": "Michael",
                "phone_number": "[phone]"
            },
            "date": "2024-03-22T15:25:25.973484Z",
            "description": "Deposit",
            "id": "6851605c-e860-11ee-9c3f-aedb120c6c16",
            "metadata": {
                "order": {
                    "identifier": "juice-deposit-d474131e-9bbf-475c-b186-0629226d7215",
                    "items": [
                        {
                            "name": "Deposit",
                            "type": "digital"
                        }
                    ]
                }
            },
            "mode": "live",
            "payment_method": null,
            "reference": "ref-juice-a1fec7e4-18e4-41f5-864d-96dabefd6836",
            "status": "pending"
        },
        "status": "pending"
    }
}

Outgoing

Sample Request

{
    "customer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[e-mail]",
        "phone_number": "[phone]",
        "billing_address": {
            "line1": "123 Main St",
            "line2": "234 Zit",
            "city": "Springfield",
            "state": "ON",
            "country": "CA",
            "zip_code": "12345"
        }
    },
    "description": "Test",
    "currency": "CAD",
    "amount": 10000,
    "direction": "outgoing",
    "payment_method": {
        "beneficiary_type": "personal | business",
        "currency": "CAD",
        "first_name": "Mikey",
        "last_name": "Gerry",
        "email": "[e-mail]", //this must be the customer's interac email.
        "question": ""
        "answer": ""
        "phone_number": ""
    },
    "reference": "1b09d9b2-11jd9eheveb-9203v02g",
    "metadata": {
        "order": {
            "identifier": "ORD12345",
            "items": [
                {
                    "name": "Deposit",
                    "type": "digital"
                }
            ]
        }
    }
}

Sample Response

{
    "data": {
        "auth_type": null,
        "expires_at": null,
        "links": ""
        "message": "Pending",
        "payment": {
            "amount": 1000,
            "cancellation_reason": "",
            "correlation_id": "68516aac-e860-11ee-b44a-aedb120c6c16",
            "currency": "CAD",
            "customer": {
                "billing_address": {
                    "city": "Ontario",
                    "country": "CA",
                    "line1": "Opposite Sasa Estate",
                    "line2": "123 Abc street",
                    "state": "ON",
                    "zip_code": "08665"
                },
                "business_id": "3d6c9e2e-1caf-4807-97ff-bbd35fc4dc1b",
                "email": "[e-mail]",
                "first_name": "Enitan",
                "id": "d05e51df-809e-498a-ac3f-7acfc0b5d35d",
                "last_name": "Michael",
                "phone_number": "[phone]"
            },
            "date": "2024-03-22T15:25:25.973484Z",
            "description": "Deposit",
            "id": "6851605c-e860-11ee-9c3f-aedb120c6c16",
            "metadata": {
                "order": {
                    "identifier": "juice-deposit-d474131e-9bbf-475c-b186-0629226d7215",
                    "items": [
                        {
                            "name": "Deposit",
                            "type": "digital"
                        }
                    ]
                }
            },
            "mode": "live",
            "payment_method": null,
            "reference": "ref-juice-a1fec7e4-18e4-41f5-864d-96dabefd6836",
            "status": "pending"
        },
        "status": "pending"
    }
}