Skip to main content

Payouts to Canada

Payout parameters​

NameMandatoryTypeDescription
payment_method+objectPayout data
 type+stringValue: bank_account
 bank_account+objectBank account
  system_type+stringValue: global
  global+objectBank account details
   description+stringPurpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
   routing_code+stringRouting code in the following format: 0AAABBBBB, where AAA is an institution code, BBBBB is a transit code
   account_number+stringBank account number for the payout
participant_details+objectInformation on the payout participants
 recipient+objectRecipient details
  bank_name+stringImportant: the bank name must be chosen from the List of supported banks, otherwise the payout will fail
  currency+stringRecipient's currency in ISO 4217 format. Case insensitive
  country_iso3+stringRecipient's country code (ISO-3166-1 alpha-3)
  first_name+stringRecipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  last_name+stringRecipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
 sender+objectSender details
  company_name+stringSender company name. Limited to 100 characters, cannot contain digits only
  registration_number+stringSender company registration number
  country_iso3+stringSender’s country code (ISO-3166-1 alpha-3)
  code+stringSender company registration number
amount_details+objectPayout amount details
 amount+intPayout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
 currency+stringISO 4217 currency code. Case insensitive

Example​

curl -X POST \
  https://demo.smart-glocal.com/api/v1/session/start/payout \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: signature' \
  -d'{
    "session_id": "ps_1053680",
    "payment_method": {
        "type": "bank_account",
        "bank_account": {
            "system_type": "global",
            "global": {
                "account_number": "NUMBER_VALUE",
                "routing_code": "AXISINBB250",
                "description": "purpose of remittance"
            }
        }
    },
    "participant_details": {
        "recipient": {
            "bank_name": "Bank name from the list below",
            "currency": "cad",
            "first_name": "John",
            "last_name": "Johnson"
        },
        "sender": {
            "company_name": "Company name",
            "registration_number": "1234567890",
            "country_iso3": "USA",
            "code": "1234567890"
        }
    },
    "amount_details": {
        "amount": 1000,
        "currency": "usd"
    }
}'

List of supported banks​

CountryCurrencyBank
CanadaCADADS Canadian Bank
CanadaCADAmex Bank of Canada
CanadaCADATB Financial
CanadaCADAtlantic Central (Institution Code 839)
CanadaCADAtlantic Central (Institution Code 849)
CanadaCADB2B Bank
CanadaCADBank of America, National Association
CanadaCADBank of Canada
CanadaCADBank of China (Canada)
CanadaCADBank of China, Toronto Branch
CanadaCADBank of Montreal
CanadaCADBarclays Bank PLC, Canada Branch
CanadaCADBNP Paribas
CanadaCADBridgewater Bank
CanadaCADCaisse Desjardins Ontario Credit Union Inc.
CanadaCADCaisse populaire acadienne ltée
CanadaCADCaisse populaire Alliance Limitée
CanadaCADCaisse Populaire Group Financier Ltée
CanadaCADCanadian Imperial Bank of Commerce (Institution Code 010)
CanadaCADCanadian Imperial Bank of Commerce (Institution Code 326)
CanadaCADCanadian Tire Bank
CanadaCADCanadian Western Bank
CanadaCADCapital One Bank (Canada Branch)
CanadaCADCentral 1 Credit Union (Institution Code 809)
CanadaCADCentral 1 Credit Union (Institution Code 828)
CanadaCADCentral 1 Credit Union (Institution Code 869)
CanadaCADChina Construction Bank Toronto Branch
CanadaCADCIBC Trust Corporation
CanadaCADCidel Bank Canada
CanadaCADCitco Bank Canada
CanadaCADCitibank Canada
CanadaCADCitibank, N.A
CanadaCADCoast Capital Savings Federal Credit Union
CanadaCADComerica Bank
CanadaCADCommunity Trust Company
CanadaCADConcentra Bank
CanadaCADCredit Union Central Alberta Limited
CanadaCADCredit Union Central of Manitoba Limited
CanadaCADCredit Union Central of Saskatchewan
CanadaCADCS Alterna Bank
CanadaCADCTBC Bank Corp. (Canada)
CanadaCADDeutsche Bank AG
CanadaCADDigital Commerce Bank
CanadaCADDuo Bank of Canada
CanadaCADEdward Jones
CanadaCADEffort Trust Company
CanadaCADEquitable Bank
CanadaCADExchange Bank of Canada
CanadaCADFédération des caisses Desjardins du Quebec
CanadaCADFifth Third Bank, National Association
CanadaCADFirst Commercial Bank
CanadaCADFirst Nations Bank of Canada
CanadaCADGeneral Bank of Canada
CanadaCADHabib Canadian Bank
CanadaCADHaventree Bank
CanadaCADHome Bank
CanadaCADHome Trust Company
CanadaCADHomeEquity Bank
CanadaCADHSBC Bank Canada
CanadaCADHSBC Mortgage Corporation (Canada)
CanadaCADICICI Bank Canada
CanadaCADIndustrial and Commercial Bank of China (Canada)
CanadaCADInvestors Group Trust Co. Ltd.
CanadaCADJ.P. Morgan Bank Canada
CanadaCADJPMorgan Chase Bank, National Association
CanadaCADKEB Hana Bank Canada
CanadaCADLaurentian Bank of Canada
CanadaCADM & T Bank
CanadaCADManufacturers Life Insurance Company
CanadaCADManulife Bank of Canada
CanadaCADManulife Trust Company
CanadaCADMega International Commercial Bank Co., Ltd.
CanadaCADMizuho Bank Ltd.
CanadaCADMontreal Trust Company of Canada
CanadaCADMotus Bank
CanadaCADMUFG Bank, Ltd., Canada Branch
CanadaCADNatcan Trust Company
CanadaCADNational Bank of Canada
CanadaCADNational Trust Company
CanadaCADPeace Hills Trust Company
CanadaCADPeoples Bank of Canada
CanadaCADPeoples Trust Company
CanadaCADPNC Bank Canada Branch
CanadaCADPresident's Choice Bank
CanadaCADRabobank Canada
CanadaCADRFA Bank of Canada
CanadaCADRogers Bank
CanadaCADRoyal Bank of Canada
CanadaCADRoyal Trust Corporation of Canada
CanadaCADSBI Canada Bank
CanadaCADScotia Mortgage Corporation
CanadaCADShinhan Bank Canada
CanadaCADSociété Générale (Canada Branch) (Institution Code 292)
CanadaCADSociété Générale (Canada Branch) (Institution Code 346)
CanadaCADState Street
CanadaCADSumitomo Mitsui Banking Corporation, Canada Branch
CanadaCADSun Life Financial Trust Inc.
CanadaCADTangerine Bank
CanadaCADTD Mortgage Corporation
CanadaCADTD Pacific Mortgage Corporation
CanadaCADThe Bank of New York Mellon
CanadaCADThe Bank of Nova Scotia
CanadaCADThe Canada Trust Company
CanadaCADThe Northern Trust Company, Canada Branch
CanadaCADThe Royal Trust Company
CanadaCADThe Toronto-Dominion Bank
CanadaCADTrust La Laurentienne du Canada Inc.
CanadaCADU.S. Bank National Association
CanadaCADUBS Bank (Canada)
CanadaCADUnited Overseas Bank Limited
CanadaCADVancity Community Investment Bank
CanadaCADVersaBank
CanadaCADWealth One Bank of Canada
CanadaCADWells Fargo Bank, National Association, Canadian Branch