Transactions

Overview

At Zūm Rails, there are 4 ways to create transactions, when using the portal or via API. When creating a transaction via API, the transaction type “ZumRailsType” must be specified.

There are four transaction types (ZumRailsType):

• FundZumWallet

• WithdrawZumWallet

• AccountsPayable

• AccountsReceivable

NOTE

• Zūm Rails allows money to be sent to a user from your virtual wallet or from your funding source.

• Zūm Rails allows money to be collected from a user to your virtual wallet or to your funding source.

1. If you want to send money from your Funding Source to Zūm Wallet, use ZumRailsType FundZumWallet and inform:

   • FundingSourceId

   • WalletId

2. If you want to withdraw money from Zūm Wallet to your Funding Source, use ZumRailsType WithdrawZumWallet and inform:

   • FundingSourceId

   • WalletId

3. If you want to send money (accounts payable) from your Zūm Wallet to a User, use ZumRailsType AccountsPayable and inform:

   • UserId

   • WalletId

4. If you want to send money (accounts payable) from your Funding Source to a User, use ZumRailsType AccountsPayable and inform:

   • UserId

   • FundingSourceId

5. If you want to withdraw money (accounts receivable) from a User to your Zūm Wallet, use ZumRailsType AccountsReceivable and inform:

   • UserId

   • WalletId

6. If you want to withdraw money (accounts receivable) from a User to your Funding Source, use ZumRailsType AccountsReceivable and inform:

   • UserId

   • FundingSourceId

INFO

• For accounts payable use-case, Zūm Rails recommend you to first Fund the Zūm Wallet, so that the money can be quickly moved.

INFO

• For accounts receivable use-case Zūm Rails, recommend you to move funds from the User to the Zūm Wallet, then set up an automatic daily withdrawal at the end of each day to your funding source.

INFO

• Credit Card transactions are settled directly into the merchant account. Hence, it is not required to specify the WalletId or FundingSourceId while creating a credit card transaction

Canada

US

Creating a new transaction

Use this endpoint if you want to add a new transaction.

Method: POST

Endpoint: {{env}}/api/transaction

Canada

EFT

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "Eft",
  "Amount": 123.45,
  "Memo": "Memo description",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297"
}

Visa Direct

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "VisaDirect",
  "Amount": 123.45,
  "Memo": "Memo description",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297"
}

Interac

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "Interac",
  "Amount": 123.45,
  "Memo": "Memo description",
  "Comment": "This transaction is just a test from a user to wallet",
  "User": {
    "companyName": "Example Company",
    "email": "[e-mail]"
  },
  "WalletId": "8ebd932b-...b92633e14297",
  "InteracHasSecurityQuestionAndAnswer": true,
  "InteracSecurityQuestion": "Your question",
  "InteracSecurityAnswer": "Your answer"
}

Credit Card

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "CreditCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "Authorize": {
    "Capture": false,
    "AutoExpireDays": 5
  }
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "Id": "0bc9894d-...f691024aca19"
  }
}

US

ACH

{
  "ZumRailsType": "AccountsPayable",
  "TransactionMethod": "Ach",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a wallet to user",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Debit Card

{
  "ZumRailsType": "AccountsPayable",
  "TransactionMethod": "DebitCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a wallet to user",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Credit Card

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "CreditCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Money Transfer

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "MoneyTransfer",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "Id": "0bc9894d-...f691024aca19",
    "Amount": 123.45,
    "Comment": "This transaction is just a test from a wallet to user",
    "TransactionMethod": "Ach",
    "TransactionStatus": "InProgress",
    "Customer": {
      "Id": "911388da-5095-4cc9-bf51-cf636dd6c46b",
      "CompanyName": "US Company",
      "CompanyEmail": "[e-mail]"
    },
    "ZumRailsType": "AccountsReceivable",
    "PaymentInstrumentId": "8951e72a-...d334f07fe908",
    "CreditCardResponseCode": "000",
    "CreditCardAdditionalResponseData": "APPROVAL",
    "User": {
      "Id": "8bad268a-5a76-4d59-8cc9-83e8e6cedfd1",
      "FirstName": "Jane",
      "LastName": "Smith",
      "Email": "[e-mail]"
    },
    "Wallet": {
      "Id": "1662f74a-...d8b966ac7198",
      "Type": "Unified",
      "Currency": "USD"
    },
    "From": "Jane Smith - [e-mail]",
    "Memo": "Memo",
    "To": "Zūm Wallet",
    "Currency": "USD",
    "CreatedAt": "2023-07-14T21:20:20.4715365Z",
    "TransactionHistory": [{
      {
        "Id": "1177131e-...d5a30d1f40ba",
        "CreatedAt": "2023-07-14T21:20:20.7628922Z",
        "Event": "Started",
        "EventDescription": "Transaction with type AccountsReceivable started, from Jane Smith - [e-mail] to Zūm Wallet with amount: $123.45"
      },
    }]
  }
}

Input parameters

Canada

Parameter	Type	Mandatory	Description
ZumRailsType	string	yes	Transaction type
TransactionMethod	string	yes	Transaction method
Amount	decimal	yes	Transaction amount
Memo	string	yes	Memo description. If customer transaction description type is "PerTransaction", this will be shown at the bank statements. Maximum of 15 characters. Only letters, numbers, dash, space and underscore are allowed
Comment	string	no	Internal comment you might want to add. Interac transactions will display the comment on the request.
FundingSourceId	guid	no	Funding Source Id
WalletId	guid	no	Wallet Id
UserId	guid	no	User Id
User	User input	no	It's possible to create a transaction without adding a user first. Simply pass the user object (instead of the UserId) into the transaction body. For reference, check the payload example of the user object here and pass this when you create a transaction (check interac transaction payload example). Only available for EFT and interac transaction methods
AuthCode	string	no	Processor clients can use this to securely send user information in the transaction creation API.
ScheduledStartDate	date	no	The date when the transaction will be sent to the financial institution, in the format YYYY-MM-DD. Must be greater than today.
ClientTransactionId	string	no	This field can be used to store the Transaction id created in your system when the Transaction is initiated
3D Secure	-	-	Only needed for 3D secure - Visa Direct and Credit Card
CardEci	string	no	Received from 3D secure, required if using 3D Secure but optional for Visa Direct Accounts Payable transactions
CardXid	string	no	Received from 3D secure, required if using 3D Secure but optional for Visa Direct Accounts Payable transactions
CardCavv	string	no	Received from 3D secure, required if using 3D Secure but optional for Visa Direct Accounts Payable transactions
Interac Fields	-	-	Only needed for Interac transactions
UseInteracANR	boolean	no	Indicates whether a transaction will be deposited directly to the user's saved account. (This works only for Interac account payable). Read more about Interac ANR here.
InteracHasSecurityQuestionAndAnswer	boolean	no	Indicate if there will be a question and answer for Interac
InteracSecurityQuestion	string	yes	The question for the user to process the interac request. Required if InteracHasSecurityQuestionAndAnswer is true. Pattern accepted: String [ 5 .. 40 ] characters ^[^\s]([a-zA-Z0-9àâäèéêëîïôœùûüÿçÀÂÄÈÉÊËÎÏÔŒÙÛÜŸÇ -.\?!,#]+)[^\s]$
InteracSecurityAnswer	string	yes	The answer for the user to process the interac request. Required if InteracHasSecurityQuestionAndAnswer is true. Pattern accepted: String [ 3 .. 25 ] characters [a-zA-Z0-9àâäèéêëîïôœùûüÿçÀ ÄÈÉÊËÎÏÔŒÙÛÜŸÇ]+$...
SessionFingerprint	string	yes	A unique identifier for this sender, we recommend using fingerprintjs. Required if peer-to-peer Interac transactions are enabled.
SessionIpAddress	string	yes	The IP address of the UserId, the sender, of the funds. Required if Accounts Payable with Interac, and peer-to-peer enabled.
Authorize	-	no	Only needed for authorized hold credit card transactions
Capture	boolean	no	The field is required for authorized hold credit card transactions. Capture can be set to true or false
AutoExpireDays	number	no	The field is required for authorized hold credit card transactions. AutoExpireDays should be an number between 1 to 5.

US

Parameter	Type	Mandatory	Description
ZumRailsType	string	yes	Transaction type
TransactionMethod	string	yes	Transaction method.
Amount	decimal	yes	Transaction amount
Memo	string	yes	Memo description.
Comment	string	no	Internal comment you might want to add.
FundingSourceId	guid	no	Funding Source Id
WalletId	guid	no	Wallet Id
UserId	guid	no	User Id
PaymentInstrumentId	string	yes	Payment instrument id
User	User input	no	It's possible to create a transaction without adding a user first. Simply pass the user object (instead of the UserId) into the transaction body. For reference, check the payload example of the user object here and pass this when you create a transaction.
ScheduledStartDate	date	no	The date when the transaction will be sent to the financial institution, in the format YYYY-MM-DD. Must be greater than today.
ClientTransactionId	string	no	This field can be used to store the Transaction id created in your system when the Transaction is initiated

ACH

{
  "ZumRailsType": "AccountsPayable",
  "TransactionMethod": "Ach",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a wallet to user",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Debit Card

{
  "ZumRailsType": "AccountsPayable",
  "TransactionMethod": "DebitCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a wallet to user",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Credit Card

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "CreditCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Money Transfer

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "MoneyTransfer",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "Id": "0bc9894d-...f691024aca19",
    "Amount": 123.45,
    "Comment": "This transaction is just a test from a wallet to user",
    "TransactionMethod": "Ach",
    "TransactionStatus": "InProgress",
    "Customer": {
      "Id": "911388da-5095-4cc9-bf51-cf636dd6c46b",
      "CompanyName": "US Company",
      "CompanyEmail": "[e-mail]"
    },
    "ZumRailsType": "AccountsReceivable",
    "PaymentInstrumentId": "8951e72a-...d334f07fe908",
    "CreditCardResponseCode": "000",
    "CreditCardAdditionalResponseData": "APPROVAL",
    "User": {
      "Id": "8bad268a-5a76-4d59-8cc9-83e8e6cedfd1",
      "FirstName": "Jane",
      "LastName": "Smith",
      "Email": "[e-mail]"
    },
    "Wallet": {
      "Id": "1662f74a-...d8b966ac7198",
      "Type": "Unified",
      "Currency": "USD"
    },
    "From": "Jane Smith - [e-mail]",
    "Memo": "Memo",
    "To": "Zūm Wallet",
    "Currency": "USD",
    "CreatedAt": "2023-07-14T21:20:20.4715365Z",
    "TransactionHistory": [{
      {
        "Id": "1177131e-...d5a30d1f40ba",
        "CreatedAt": "2023-07-14T21:20:20.7628922Z",
        "Event": "Started",
        "EventDescription": "Transaction with type AccountsReceivable started, from Jane Smith - [e-mail] to Zūm Wallet with amount: $123.45"
      },
    }]
  }
}

Input parameters

Canada

Parameter	Type	Mandatory	Description
ZumRailsType	string	yes	Transaction type
TransactionMethod	string	yes	Transaction method
Amount	decimal	yes	Transaction amount
Memo	string	yes	Memo description. If customer transaction description type is "PerTransaction", this will be shown at the bank statements. Maximum of 15 characters. Only letters, numbers, dash, space and underscore are allowed
Comment	string	no	Internal comment you might want to add. Interac transactions will display the comment on the request.
FundingSourceId	guid	no	Funding Source Id
WalletId	guid	no	Wallet Id
UserId	guid	no	User Id
User	User input	no	It's possible to create a transaction without adding a user first. Simply pass the user object (instead of the UserId) into the transaction body. For reference, check the payload example of the user object here and pass this when you create a transaction (check interac transaction payload example). Only available for EFT and interac transaction methods
AuthCode	string	no	Processor clients can use this to securely send user information in the transaction creation API.
ScheduledStartDate	date	no	The date when the transaction will be sent to the financial institution, in the format YYYY-MM-DD. Must be greater than today.
ClientTransactionId	string	no	This field can be used to store the Transaction id created in your system when the Transaction is initiated
3D Secure	-	-	Only needed for 3D secure - Visa Direct and Credit Card
CardEci	string	no	Received from 3D secure, required if using 3D Secure but optional for Visa Direct Accounts Payable transactions
CardXid	string	no	Received from 3D secure, required if using 3D Secure but optional for Visa Direct Accounts Payable transactions
CardCavv	string	no	Received from 3D secure, required if using 3D Secure but optional for Visa Direct Accounts Payable transactions
Interac Fields	-	-	Only needed for Interac transactions
UseInteracANR	boolean	no	Indicates whether a transaction will be deposited directly to the user's saved account. (This works only for Interac account payable). Read more about Interac ANR here.
InteracHasSecurityQuestionAndAnswer	boolean	no	Indicate if there will be a question and answer for Interac
InteracSecurityQuestion	string	yes	The question for the user to process the interac request. Required if InteracHasSecurityQuestionAndAnswer is true. Pattern accepted: String [ 5 .. 40 ] characters ^[^\s]([a-zA-Z0-9àâäèéêëîïôœùûüÿçÀÂÄÈÉÊËÎÏÔŒÙÛÜŸÇ -.\?!,#]+)[^\s]$
InteracSecurityAnswer	string	yes	The answer for the user to process the interac request. Required if InteracHasSecurityQuestionAndAnswer is true. Pattern accepted: String [ 3 .. 25 ] characters [a-zA-Z0-9àâäèéêëîïôœùûüÿçÀ ÄÈÉÊËÎÏÔŒÙÛÜŸÇ]+$...
SessionFingerprint	string	yes	A unique identifier for this sender, we recommend using fingerprintjs. Required if peer-to-peer Interac transactions are enabled.
SessionIpAddress	string	yes	The IP address of the UserId, the sender, of the funds. Required if Accounts Payable with Interac, and peer-to-peer enabled.
Authorize	-	no	Only needed for authorized hold credit card transactions
Capture	boolean	no	The field is required for authorized hold credit card transactions. Capture can be set to true or false
AutoExpireDays	number	no	The field is required for authorized hold credit card transactions. AutoExpireDays should be an number between 1 to 5.

US

Parameter	Type	Mandatory	Description
ZumRailsType	string	yes	Transaction type
TransactionMethod	string	yes	Transaction method.
Amount	decimal	yes	Transaction amount
Memo	string	yes	Memo description.
Comment	string	no	Internal comment you might want to add.
FundingSourceId	guid	no	Funding Source Id
WalletId	guid	no	Wallet Id
UserId	guid	no	User Id
PaymentInstrumentId	string	yes	Payment instrument id
User	User input	no	It's possible to create a transaction without adding a user first. Simply pass the user object (instead of the UserId) into the transaction body. For reference, check the payload example of the user object here and pass this when you create a transaction.
ScheduledStartDate	date	no	The date when the transaction will be sent to the financial institution, in the format YYYY-MM-DD. Must be greater than today.
ClientTransactionId	string	no	This field can be used to store the Transaction id created in your system when the Transaction is initiated

INFO

Either a memo or comment is mandatory for Interac transactions. If both are specified, the comment will be presented on the Interac request.

INFO

When a transaction is created with a scheduled start date (delay transaction initiation), the transaction will be prepared to be sent to the financial institution according to its scheduled start date.

INFO

When a transaction is created with a scheduled start date (delay transaction initiation), the transaction will be prepared to be sent to the financial institution according to its scheduled start date.

Response

Parameter	Type	Description
Id	guid	Transaction id

ZumRailsType

Type	Description
FundZumWallet	Send money to your Zūm Wallet
WithdrawZumWallet	Withdraw from your Zūm Wallet
AccountsPayable	Execute accounts payable AP
AccountsReceivable	Execute accounts receivable AR

TransactionMethod

Canada

Type
Eft
Interac
VisaDirect
CreditCard

US

Method	Description
Ach	ACH transaction
DebitCard	Debit card transaction
CreditCard	Credit card transaction
MoneyTransfer	MoneyTransfer transaction

Success (Canada)

{
  "ZumRailsType": "FundZumWallet",
  "TransactionMethod": "Eft",
  "Amount": 123.45,
  "Memo": "Memo description",
  "Comment": "This transaction will succeed because there's no keyword",
  "FundingSourceId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297"
}

Failure (Canada)

{
  "ZumRailsType": "FundZumWallet",
  "TransactionMethod": "Eft",
  "Amount": 123.45,
  "Memo": "Memo description",
  "Comment": "This transaction will fail (EftFailedNoDebitAllowed)",
  "FundingSourceId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297"
}

DANGER

In a sandbox environment, real bank operations are not performed. It provides a way to simulate success, failures and review situations.

CAUTION

To simulate a failure, use one of the keywords to simulate failure (shown below) in the field COMMENT while creating a transaction. If no keyword is informed, or something else is informed, the transaction will eventually change status to "Completed". This service is executed every minute.

CAUTION

Interac transactions in sandbox will be simulated like the real flow. Hence, emails will be sent out to the user email mentioned when the transaction is created. Make sure to use a real email address to be able to simulate this flow and complete the transaction.

INFO

When a transaction is created with a scheduled start date (delay transaction initiation), it won't be dispatched right away. This transaction will be prepared to be sent to the financial institution according to its scheduled start date.

Keywords to simulate a transaction failure (Canada)

Eft	VisaDirect	Interac	CreditCard
EftFailedValidationRejection	VisaDirectGenericError	InteracFailedRecipientContactInfoMissing	CreditCardDeclined
EftFailedInsufficientFunds	VisaDirectDoNotHonor	InteracFailedInvalidEmailFormat	CreditCardError *
EftFailedCannotLocateAccount	VisaDirectInsufficientFunds	InteracFailedInvalidPhoneNumber	CreditCardHeldForReview *
EftFailedStopPayment	VisaDirectNotPermittedToCardHolderInformed	InteracFailedMultipleTransferLevelErrors	CreditCardGenericError *
EftFailedAccountClosed	VisaDirectAmountLimitNotAuthorized	InteracFailedRevoked	CreditCardUnknownResponse *
EftFailedNoDebitAllowed	VisaDirectRejectedAmlOrFraud	InteracFailedBulkCancellationRequest	CreditCardHoldCallOrPickUpCard *
EftFailedFundsNotFree	VisaDirectRejectedAccountLimitExceeded	InteracFailedRecipientRejected	CreditCardSecViolation *
EftFailedCurrencyAccountMismatch	VisaDirectReenterTransaction	InteracFailedAuthentication	CreditCardServNotAllowed *
EftFailedPayorPayeeDeceased	VisaDirectInvalidTransaction	InteracFailedReachedCancellationCutOff	CreditCardCvvMismatch *
EftFailedFrozenAccount	VisaDirectInvalidCardNumber	InteracFailedNotificationDeliveryFailure	CreditCardInvalidMerchantId *
EftFailedInvalidErrorAccountNumber	VisaDirectIssuerOrSwitchInoperative	InteracFailedAmountGreaterThanMax	CreditCardAmountExceeded *
EftFailedErrorPayorPayeeName	VisaDirectUnsupportedCardType	InteracFailedDebtorRejected	CreditCardRefundAmountExceeded *
EftFailedRefusedNoAgreement	VisaDirectInvalidExpiryDate	InteracFailedFundsDepositFailed	CreditCardCashbackNotApp *
EftFailedNotInAccountAgreementP	VisaDirectInvalidPIN	InteracFailedClientEmailedToRequestCancellation	CreditCardExpiredCard *
EftFailedNotInAccountAgreementE	VisaDirectInvalidSecret	InteracFailedGenericError	CreditCardNoAccountFound *
EftFailedAgreementRevoked		InteracFailedNameMismatch	CreditCardNotPermittedToCardHolderInformed *
EftFailedDefaultByAFinancialInstitution		InteracFailedInvalidAccountNumber	CreditCardInvalidCardNumber *
EftFailedTransactionNotAllowed		InteracFailedRequestBlockedByUser	CreditCardRejectedAmlOrFraud *
			CreditCardTypeNotAccepted *
			CreditCardDomesticDebitDeclined *
			CreditCardClosedAccount *

* Not available for all credit card customers

NOTE

You can simulate late failures (Failure after transaction completion) by using a comment: (event name), Latefailure. This feature is only available for EFT transaction error. If the string is incorrect, the transaction will fail with the event specified within it.

Get a specific transaction

Use this endpoint if you want to get all the information for a specific transaction. The transaction id is informed in the url.

Method: GET

Endpoint: {{env}}/api/transaction/{transaction_id}

Response (Canada)

{
  "statusCode": 200,
  "message": "GET Request successful.",
  "isError": false,
  "result": {
    "Id": "b7a8a505...364e8836404e",
    "CreatedAt": "2020-05-13T17:59:47.039462",
    "Memo": "Memo test",
    "Comment": "This is a transaction to test",
    "Amount": 123.45,
    "Customer": {
      "Id": "e15bbe9b...dc256ba3a247",
      "CompanyName": "Sam's Gym"
    },
    "User": {
      "Id": "c11cc378...8f34ac8173be",
      "FirstName": "John",
      "LastName": "111",
      "Email": "[e-mail]",
      "IsActive": true
    },
    "Wallet": {
      "Id": "8ebd932b...b92633e14297",
      "Type": "Unified"
    },
    "FundingSource": {
      "Id": "1d431e8b...85452adb4eee",
      "Institution": "Institution",
      "InstitutionNumber": "123",
      "TransitNumber": "12345",
      "AccountNumber": "1234567"
    },
    "EventHistory": [
      {
        "CreatedAt": "2020-05-13T17:59:47.284943",
        "Event": "EFTFileUploaded",
        "EventDescription": "EFT file uploaded to Financial Institution"
      },
      {
        "CreatedAt": "2020-05-13T17:59:47.284943",
        "Event": "Started",
        "EventDescription": "Transaction with type FundZumWallet started, from Funding Source to Zūm Wallet with amount: $123.45"
      }
    ],
    "ZumRailsType": "FundZumWallet",
    "TransactionMethod": "Eft",
    "TransactionStatus": "InProgress",
    "RecurrentTransactionId": "16d2406f...87d397a8356f",
    "FailedTransactionEvent": null,
    "From": "Zūm Wallet",
    "To": "User john 111",
    "FailedAt": null,
    "IsRefundable": false,
    "AuthorizedHoldExpiredAt": ""
  }
}

Response (US)

{
  "statusCode": 200,
  "message": "GET Request successful.",
  "isError": false,
  "result": {
    "Id": "b7a8a505...364e8836404e",
    "CreatedAt": "2020-05-13T17:59:47.039462",
    "Memo": "Memo test",
    "Comment": "This is a transaction to test",
    "Amount": 123.45,
    "Currency": "USD",
    "TelecheckApprovalCode": "1228",
    "PaymentInstrumentId": "8951e72a-....d334f07fe908",
    "Customer": {
      "Id": "e15bbe9b...dc256ba3a247",
      "CompanyName": "Sam's Gym"
    },
    "User": {
      "Id": "c11cc378...8f34ac8173be",
      "FirstName": "John",
      "LastName": "111",
      "Email": "[e-mail]",
      "IsActive": true
    },
    "Wallet": {
      "Id": "8ebd932b...b92633e14297",
      "Type": "Unified",
      "Currency": "USD"
    },
    "FundingSource": {
      "Id": "1d431e8b...85452adb4eee",
      "Institution": "Institution",
      "InstitutionNumber": "123",
      "RoutingNumber": "12345",
      "AccountNumber": "1234567"
    },
    "TransactionChargeback": [
      {
        "Id": "e5ec36c3...5445500db505"
        "AcquirerReferenceNumber" : "1674915201620667421592979",
        "AuthorizationCode" : "OK5234",
        "ChargebackAmount" : 9.91,
        "ChargebackControlNumber" : "771638347",
        "ChargebackStatus" : "Disputed",
        "ChargebackWorkTypeCode" : "1",
        "DisputeCurrencyCode" : "USD",
        "DisputeReasonCode" : "1350",
        "DueDate" : "2024-04-14",
        "FileId" : "685221186",        
        "MemberMessageText" : "Misrepresentation",
        "ReceivedDate" : "2024-04-10",
      }
    ]

    "TransactionHistory": [
      {
        "CreatedAt": "2020-05-13T17:59:47.284943",
        "Event": "Started",
        "EventDescription": "Transaction with type AccountsPayable started, from Funding Source to Zūm Wallet with amount: $123.45"
      }
    ],
    "ZumRailsType": "AccountsPayable",
    "TransactionMethod": "Ach",
    "TransactionStatus": "InProgress",
    "From": "Zūm Wallet",
    "To": "User john 111",
    "FailedAt": null,
    "PaymentInstrumentId": "92142401-d17e-4906-91e8-389ba0d87e75"
  }
}

Response

Canada

Parameter	Type	Description
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
ZumRailsType	string	Transaction type
TransactionStatus	string	Indicate the status of the transaction
RecurrentTransactionId	guid	The id of the recurrent transaction that created this transaction (null if inexistent)
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date transaction will be sent to the financial institution.
ClientTransactionId	string	The Transaction id you informed in the creation of this transaction
InteracUrl	string	The interac URL to complete the transaction, if available
InteracDebtorInstitutionNumber	string	The Financial Institution used to complete the Interac Request money.
InteracDebtorFullName	string	The Full Name used to complete the Interac Request money. This information not yet 100% accurate, often is the same name sent. Gradually each Institution is improving and sending this information for Zūm Rails.
UseInteracANR	boolean	Indicates whether a transaction will be deposited directly to the user's saved account. (This works only for account payable transactions from wallet to user)
From	string	From description for the transaction
To	string	To description for the transaction
IsRefundable	boolean	Indicates if the transaction is IsRefundable
FailedAt	datetime	When the transaction was failed (null otherwise)
AuthorizedHoldExpiredAt	datetime	When the transaction was the authorized hold credit card transaction (null otherwise)
Customer		Basic Customer data
CompanyName	string	Company Name
Id	guid	Id for the related customer
User		If transaction has a user - * Not all information from a user is returned in this endpoint
Id	guid	The user id
First Name	string	User first name
Last Name	string	User last name
Company Name	string	User company name
IsActive	boolean	Indicates if the user is active or not
Wallet		If transaction has a wallet * Not all information from a user is returned in this endpoint
Id	guid	The wallet id
Type	string	The wallet type
FundingSource		If transaction has a funding source * Not all information from a user is returned in this endpoint
Id	guid	The funding source id
Institution	string	The institution name
InstitutionNumber	string	The institution number
TransitNumber	string	The transit number
AccountNumber	string	The account number
TargetWallet		If transaction has a target wallet
Id	guid	The target wallet id
Type	string	The target wallet type
TransactionHistory		List of transaction history events
CreatedAt	datetime	When the transaction event happened
Event	string	The event happened
EventDescription	string	The event description

US

Parameter	Type	Description
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
Currency	string	Transaction currency
ZumRailsType	string	Transaction type
TransactionStatus	string	Indicates the status of the transaction
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date on which the transaction will be sent to the financial institution
ClientTransactionId	string	The Transaction id you informed in the creation of this transaction
From	string	From description for the transaction
To	string	To description for the transaction
FailedAt	datetime	When the transaction was failed (null otherwise)
TelecheckApprovalCode	string	When the transaction method is ACH with provider Telecheck (null otherwise)
TelecheckDenialRecordNumber	string	When the transaction method is ACH with provider Telecheck and the transaction was denied (null otherwise)
PaymentInstrumentId	string	Payment instrument id
CreditCardResponseCode	string	Response code when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAdditionalResponseData	string	Additional response data when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAuthorizationId	string	Authorization id when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAuthorizationNetworkId	string	Authorization network id when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAuthorizationNetworkName	string	Authorization network name when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardErrorData	string	Error message when the transaction method is Credit Card with provider RapidConnect (null otherwise)
Customer		Basic Customer data
Id	guid	Id for the related customer
CompanyName	string	Company Name
User		If transaction has a user - * Not all information from a user is returned in this endpoint
Id	guid	The user id
First Name	string	User first name
Last Name	string	User last name
Company Name	string	User company name
IsActive	boolean	Indicates if the user is active or not
Wallet		If transaction has a wallet * Not all information from a user is returned in this endpoint
Id	guid	The wallet id
Type	string	The wallet type
FundingSource		If transaction has a funding source * Not all information from a user is returned in this endpoint
Id	guid	The funding source id
Institution	string	The institution name
InstitutionNumber	string	The institution number
TransitNumber	string	The transit number
RoutingNumber	string	The account number
TargetWallet		If transaction has a target wallet
Id	guid	The target wallet id
Type	string	The target wallet type
TransactionChargeback		List of transaction chargebacks
Id	guid	The transaction chargeback id
AcquirerReferenceNumber	string	Reference number associated with the inquiry
AuthorizationCode	string	Authorization code from association(s)
ChargebackAmount	decimal	Chargeback amount
ChargebackControlNumber	string	Chargeback control number
ChargebackStatus	string	Chargeback status
ChargebackWorkTypeCode	string	Chargeback work type code
DisputeCurrencyCode	string	Dispute currency code
DisputeReasonCode	string	Dispute reason code
DueDate	string	Due date (format "yyyy-MM-dd)
FileId	string	File id
MemberMessageText	string	Member message text
ReceivedDate	string	Received date (format "yyyy-MM-dd)
TransactionHistory		List of transaction history events
CreatedAt	datetime	When the transaction event happened
Event	string	The event that happened
EventDescription	string	The event description

Canada

Parameter	Type	Description
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
ZumRailsType	string	Transaction type
TransactionStatus	string	Indicate the status of the transaction
RecurrentTransactionId	guid	The id of the recurrent transaction that created this transaction (null if inexistent)
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date transaction will be sent to the financial institution.
ClientTransactionId	string	The Transaction id you informed in the creation of this transaction
InteracUrl	string	The interac URL to complete the transaction, if available
InteracDebtorInstitutionNumber	string	The Financial Institution used to complete the Interac Request money.
InteracDebtorFullName	string	The Full Name used to complete the Interac Request money. This information not yet 100% accurate, often is the same name sent. Gradually each Institution is improving and sending this information for Zūm Rails.
UseInteracANR	boolean	Indicates whether a transaction will be deposited directly to the user's saved account. (This works only for account payable transactions from wallet to user)
From	string	From description for the transaction
To	string	To description for the transaction
IsRefundable	boolean	Indicates if the transaction is IsRefundable
FailedAt	datetime	When the transaction was failed (null otherwise)
AuthorizedHoldExpiredAt	datetime	When the transaction was the authorized hold credit card transaction (null otherwise)
Customer		Basic Customer data
CompanyName	string	Company Name
Id	guid	Id for the related customer
User		If transaction has a user - * Not all information from a user is returned in this endpoint
Id	guid	The user id
First Name	string	User first name
Last Name	string	User last name
Company Name	string	User company name
IsActive	boolean	Indicates if the user is active or not
Wallet		If transaction has a wallet * Not all information from a user is returned in this endpoint
Id	guid	The wallet id
Type	string	The wallet type
FundingSource		If transaction has a funding source * Not all information from a user is returned in this endpoint
Id	guid	The funding source id
Institution	string	The institution name
InstitutionNumber	string	The institution number
TransitNumber	string	The transit number
AccountNumber	string	The account number
TargetWallet		If transaction has a target wallet
Id	guid	The target wallet id
Type	string	The target wallet type
TransactionHistory		List of transaction history events
CreatedAt	datetime	When the transaction event happened
Event	string	The event happened
EventDescription	string	The event description

US

Parameter	Type	Description
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
Currency	string	Transaction currency
ZumRailsType	string	Transaction type
TransactionStatus	string	Indicates the status of the transaction
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date on which the transaction will be sent to the financial institution
ClientTransactionId	string	The Transaction id you informed in the creation of this transaction
From	string	From description for the transaction
To	string	To description for the transaction
FailedAt	datetime	When the transaction was failed (null otherwise)
TelecheckApprovalCode	string	When the transaction method is ACH with provider Telecheck (null otherwise)
TelecheckDenialRecordNumber	string	When the transaction method is ACH with provider Telecheck and the transaction was denied (null otherwise)
PaymentInstrumentId	string	Payment instrument id
CreditCardResponseCode	string	Response code when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAdditionalResponseData	string	Additional response data when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAuthorizationId	string	Authorization id when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAuthorizationNetworkId	string	Authorization network id when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardAuthorizationNetworkName	string	Authorization network name when the transaction method is Credit Card with provider RapidConnect (null otherwise)
CreditCardErrorData	string	Error message when the transaction method is Credit Card with provider RapidConnect (null otherwise)
Customer		Basic Customer data
Id	guid	Id for the related customer
CompanyName	string	Company Name
User		If transaction has a user - * Not all information from a user is returned in this endpoint
Id	guid	The user id
First Name	string	User first name
Last Name	string	User last name
Company Name	string	User company name
IsActive	boolean	Indicates if the user is active or not
Wallet		If transaction has a wallet * Not all information from a user is returned in this endpoint
Id	guid	The wallet id
Type	string	The wallet type
FundingSource		If transaction has a funding source * Not all information from a user is returned in this endpoint
Id	guid	The funding source id
Institution	string	The institution name
InstitutionNumber	string	The institution number
TransitNumber	string	The transit number
RoutingNumber	string	The account number
TargetWallet		If transaction has a target wallet
Id	guid	The target wallet id
Type	string	The target wallet type
TransactionChargeback		List of transaction chargebacks
Id	guid	The transaction chargeback id
AcquirerReferenceNumber	string	Reference number associated with the inquiry
AuthorizationCode	string	Authorization code from association(s)
ChargebackAmount	decimal	Chargeback amount
ChargebackControlNumber	string	Chargeback control number
ChargebackStatus	string	Chargeback status
ChargebackWorkTypeCode	string	Chargeback work type code
DisputeCurrencyCode	string	Dispute currency code
DisputeReasonCode	string	Dispute reason code
DueDate	string	Due date (format "yyyy-MM-dd)
FileId	string	File id
MemberMessageText	string	Member message text
ReceivedDate	string	Received date (format "yyyy-MM-dd)
TransactionHistory		List of transaction history events
CreatedAt	datetime	When the transaction event happened
Event	string	The event that happened
EventDescription	string	The event description

Status and events

Zūm Rails offers 6 main statuses for transactions:

Transaction Status

Type	Description
InProgress	Indicates the transaction is being processed
Completed	Indicates the transaction is completed, this is a permanent status for Interac, Visa Direct and Credit Card. For EFT, a completed transaction might still fail up to 90 days after it's completion.
Failed	Indicates the transaction has failed, this is a permanent status.
Cancelled	Indicates the transaction has canceled, this is a permanent status.
Scheduled	Indicates the transaction is scheduled.
InReview	Indicates the transaction is under review. As of now, only Interac transactions uses this status. Once a transaction is "Under Review" you need to "Take Action" on the transaction from within the portal or via API implementation to guide Interac on how you want to treat this transaction. It could also happen that "Completed" transactions are flagged as "Under Review". This is when Interac requires a response from the Merchant stating if the transactions is legit/fraud/scam. Click here to read more. A transaction might be under review up to 7 days, after that our system will automatically cancel it.

Transaction Events

Zūm Rails also offers a more detailed transaction event, to indicate every step the transaction passed. Depending on the transaction methods, the events will change.

Canada

Method	Event	Description
All	Started	When the transaction started
All	Succeeded	When the transaction succeeds, when it finishes without any error
All	WalletFunded	When the transaction funds a wallet
All	WalletWithdrawn	When the transaction withdrawn a wallet
-------	-------	-------
Eft	EFTFileCreated	When an EFT file is created. One transaction might have up to 2 files
Eft	EFTFileUploaded	When an EFT file is uploaded
Eft	EFTAnswerReceived	When an EFT file response is received
Eft	EFTAnswerProcessed	When an EFT file is processed
Eft	EftFailedValidationRejection	When EFT could not be created, due an invalid information provided
Eft	EftFailedInsufficientFunds	When transaction is rejected, due non sufficient funds available
Eft	EftFailedCannotLocateAccount	When account is not located, account, transit or institution numbers are invalid
Eft	EftFailedStopPayment	Account do not allow EFT
Eft	EftFailedAccountClosed	When account is closed
Eft	EftFailedNoDebitAllowed	Account do not allow EFT
Eft	EftFailedFundsNotFree	When transaction is rejected, due non sufficient funds available
Eft	EftFailedCurrencyAccountMismatch	When the currency of the transaction does not match the currency of the account
Eft	EftFailedPayorPayeeDeceased	Account do not allow EFT
Eft	EftFailedFrozenAccount	Account do not allow EFT
Eft	EftFailedInvalidErrorAccountNumber	When account is not located, account numbers are invalid
Eft	EftFailedErrorPayorPayeeName	When account is not located, first, last or company name (business) mismatch
Eft	EftFailedRefusedNoAgreement	Account do not allow EFT
Eft	EftFailedNotInAccountAgreementP	Account do not allow EFT
Eft	EftFailedNotInAccountAgreementE	Account do not allow EFT
Eft	EftFailedAgreementRevoked	Account do not allow EFT
Eft	EftFailedDefaultByAFinancialInstitution	Generic error provided by the financial institution
Eft	EftFailedCustomerInitiatedReturnCreditOnly	When the payee has requested the credit to be returned
Eft	EftFailedTransactionNotAllowed	When the bank account is banned
Eft	EftFailedCustomerInitiatedReturnCreditOnly	When the payee has requested the credit to be returned
Eft	EftFailedNoPrenotificationP1	No Confirmation/Pre-Notification – Personal
Eft	EftFailedNoPrenotificationP2	No Confirmation/Pre-Notification – Business
Eft	EFTFileCreated	When the EFT file is created
Eft	EFTAnswerReceived	When the EFT answer is received
Eft	EFTAnswerProcessed	When the EFT answer is processed
Eft	NotEnoughBalanceInWalletError	When the wallet has not balance enough
-------	-------	-------
VisaDirect	VisaDirectGenericError	When a generic error happened in the network
VisaDirect	VisaDirectDoNotHonor	When the information provided was inconsistent, such as address or name on card
VisaDirect	VisaDirectInsufficientFunds	When not sufficient funds available in the card
VisaDirect	VisaDirectNotPermittedToCardHolderInformed	When the card holder did not authorize the transaction or the card is restricted for this usage
VisaDirect	VisaDirectAmountLimitNotAuthorized	When the limit informed invalid, too high or exceeds the withdrawal frequency limit, too many transactions for this card in the current period
VisaDirect	VisaDirectRejectedAmlOrFraud	When visa identified this transaction as AML or potential fraud
VisaDirect	VisaDirectWaitingSettlementIntoClientsAccounts	Waiting for funds to be settled into client's account
VisaDirect	VisaDirectSettledIntoClientsAccount	When visa funds are settled into client's account
VisaDirect	VisaDirectInvalidCardNumber	When the card has an invalid number
VisaDirect	VisaDirectChargeback	When the card number is invalid
VisaDirect	VisaDirectReenterTransaction	When an error happened. Retry creating the transaction
VisaDirect	VisaDirectInvalidTransaction	When transaction was considered invalid by visa direct
VisaDirect	VisaDirectIssuerOrSwitchInoperative	When issuer or switch is inoperative
VisaDirect	VisaDirectUnsupportedCardType	When a type card is not supported
VisaDirect	VisaDirectRejectedAccountLimitExceeded	When an account limit reaches the exceed amount
VisaDirect	VisaDirectInvalidExpiryDate	When a VisaDirect transaction due to invalid expiration dates
VisaDirect	VisaDirectInvalidPIN	When a VisaDirect transaction due to invalid pin
VisaDirect	VisaDirectInvalidSecret	When a VisaDirect transaction due to invalid secret
VisaDirect	VisaDirectTimeoutLimitReachedError	When a VisaDirect transaction timeout limit reached
-------	-------	-------
Interac	InteracSent	When the transaction is sent to interac
Interac	InteracAcknowledgedCredit	When a credit transaction is received by interac
Interac	InteracAcknowledgedDebit	When a debit transaction is received by interac
Interac	InteracFailedRecipientContactInfoMissing	Need to add recipient email or mobile phone number
Interac	InteracFailedInvalidEmailFormat	If the email provided is not valid. * We minimize this error by validating it before
Interac	InteracFailedInvalidPhoneNumber	If the phone number provided is not valid
Interac	InteracFailedMultipleTransferLevelErrors	If there is more than one error in the file
Interac	InteracFailedRevoked	When the transaction is revoked
Interac	InteracFailedBulkCancellationRequest	When the transaction was cancelled by request
Interac	InteracFailedRecipientRejected	When the transaction was cancelled due to recipient having declined receipt of funds
Interac	InteracFailedAuthentication	Transfer cancelled due to maximum number of unsuccessful attempts to answer the security question by the recipient
Interac	InteracFailedReachedCancellationCutOff	Transfer cancelled due to expiry
Interac	InteracFailedNotificationDeliveryFailure	Transfer cancelled due to maximum number of failed email notification attempts reached
Interac	InteracFailedAmountGreaterThanMax	If the transaction amount exceeds the maximum allowed
Interac	InteracFailedDebtorRejected	The debtor rejected the request
Interac	InteracFailedFundsDepositFailed	The funds deposit failed
Interac	InteracFailedClientEmailedToRequestCancellation	Client emailed to request cancellation
Interac	InteracFailedGenericError	When Interac Network is unavailable - * We have never seen this
Interac	InteracWaitingSettlementIntoWallet	Waiting for funds to be settled into wallet
Interac	InteracSettledIntoWallet	When Interac funds are settled into wallet
Interac	InteracFailedNameMismatch	When the debtor name used to fulfill the Interac is different than the name on file
Interac	InteracFraudAlertResponded	When a fraud alert responded for that transaction
Interac	InteracFundsHeldForValidation	User needs to contact their Financial Institution to validate the transfer and release of funds
Interac	InteracFailedInvalidAccountNumber	When the account number provided is invalid
Interac	InteracFailedRequestBlockedByUser	When the transaction failed since the user has blocked some or all Interac requests coming to their email
-------	-------	-------
CreditCard	CreditCardDeclined	Transaction declined by the issuing bank
CreditCard	CreditCardError	The card information, address, CVV is not correct
CreditCard	CreditCardHeldForReview	Transaction is pre-approved, it might take a few hours to approve completely. This is rare
CreditCard	CreditCardGenericError	The credit card network is unavailable
CreditCard	CreditCardUnknownResponse	No clear response from the issuing bank
CreditCard	CreditCardHoldCallOrPickUpCard	Credit card is considered lost or stolen by the issuing bank
CreditCard	CreditCardSecViolation	Restrictions were placed on the credit card by the issuing bank possibly due to a security violation
CreditCard	CreditCardServNotAllowed	The merchant account or credit card processor is not set up for this operation
CreditCard	CreditCardCvvMismatch	Transaction rejected since CVV provided is invalid
CreditCard	CreditCardInvalidMerchantId	The account is not approved for credit card transactions
CreditCard	CreditCardAmountExceeded	The amount exceeds the maximum allowed by the credit card provider
CreditCard	CreditCardRefundAmountExceeded	Transaction amount exceeds refund limit
CreditCard	CreditCardCashbackNotApp	Cashback not applicable on card
CreditCard	CreditCardExpiredCard	Transaction rejected since the card has expired
CreditCard	CreditCardNoAccountFound	Transaction rejected since the account was not found
CreditCard	CreditCardNotPermittedToCardHolderInformed	The card holder did not authorize the transaction or the card is restricted for this usage
CreditCard	CreditCardInvalidCardNumber	Transaction rejected since card number provided is invalid
CreditCard	CreditCardRejectedAmlOrFraud	Transaction is identified as AML or potential fraud
CreditCard	CreditCardTypeNotAccepted	Card type not accepted for the transaction
CreditCard	CreditCardDomesticDebitDeclined	Domestic debits are not allowed on the card
CreditCard	CreditCardClosedAccount	Transaction rejected since the account has been closed

US

Method	Event	Description
All	Started	When the transaction started
All	Succeeded	When the transaction succeeds, when it finishes without any error
All	WalletFunded	When the transaction funds a wallet
All	WalletWithdrawn	When the transaction withdrawn a wallet
-------	-------	-------
ACH	AchTransactionAccepted	When transaction is accepted
ACH	AchFailedTransactionExpired	When transaction has expired
ACH	AchFailedReturnedOrClosedAccount	When transaction is returned due to a closed account or any other return reason
ACH	AchFailedRejectedWithReason	When transaction is rejected for a reason
ACH	AchFailedGeneralError	When transaction has failed due to general error
ACH	AchFailedHighRiskOrPotentialFraud	When transaction is rejected as high-risk or potential fraud
ACH	AchFailedDueToMerchantSetup	When transaction failed because of invalid or inactive merchant id
ACH	AchFailedInvalidValueForField	When transaction failed due to invalid value for field
ACH	AchFailedAuthorizationRevoked	When transaction failed because authorization was revoked
ACH	AchFailedDuplicateTransaction	When transaction failed due to duplicated transaction
ACH	AchFailedDueToProcessorTimeout	When transaction is not successfully processed due to processor timeout
ACH	AchFailedTransactionNotAllowed	When transaction is not allowed by provider
ACH	AchDebitResponseReceived	When response is received for a debit transaction
ACH	AchCreditResponseReceived	When response is received for a credit transaction
ACH	AchTransactionReturned	When transaction returned from bank
ACH	AchTransactionResubmitted	When transaction is resubmitted for processing again
ACH	AchCancellationFailed	When request to cancel transaction failed
ACH	AchCancellationFailedDueToMerchantSetup	When request to cancel transaction failed due to merchant setup
ACH	AchCancellationFailedRefundGreaterThanTransactionAmount	When request to cancel transaction failed as refund amount is bigger than transaction amount
ACH	AchCancellationFailedTransactionAlreadyCancelled	When request to cancel transaction failed because transaction is already cancelled
ACH	AchFailedDueToNegativeData	When transaction failed due to negative user data
ACH	AchFailedIneligibleBankAccount	When transaction failed because bank account is not on ACH network
-------	-------	-------
DebitCard	DebitCardFailedGeneralError	When transaction has failed due to general error
DebitCard	DebitCardFailedPaymentDeclined	When transaction is declined by downstream issuer
DebitCard	DebitCardFailedTransactionExpired	When transaction has expired
DebitCard	DebitCardFailedHighRiskOrPotentialFraud	When transaction is rejected as high-risk or potential fraud
-------	-------	-------
CreditCard	CreditCardInvalidRequest	When transaction has failed due to invalid request
CreditCard	CreditCardRejectedByIssuingBank	When transaction is rejected by issuing bank
CreditCard	CreditCardExpiredCard	When transaction has failed due to expired card
CreditCard	CreditCardSuspectedFraud	When transaction has failed due to suspected fraud
CreditCard	CreditCardTransactionNotPermitted	When transaction is not permitted
CreditCard	CreditCardContactSupport	When transaction has failed. Contact support
CreditCard	CreditCardInvalidMerchantSetUp	When transaction has failed due to invalid merchant setup
CreditCard	CreditCardSecurityViolation	When transaction has failed due to security violation
CreditCard	CreditCardInvalidCardOrDetails	When transaction has failed due to invalid card or card details
CreditCard	CreditCardLostOrStolenCard	When transaction has failed due to lost ot stolen card
CreditCard	CreditCardAccountClosedOrBlocked	When transaction has failed due to account closed or blocked
CreditCard	CreditCardDeemedHighRisk	When transaction has failed due to deemed high risk
CreditCard	CreditCardUnknownResponseFromIssuingBank	When transaction has failed due to unknown response from issuing bank
CreditCard	CreditCardCouldNotLocateOriginalTransaction	When reversal transaction has failed due to could not locate original transaction
CreditCard	CreditCardTransactionAlreadyReversed	When reversal transaction has failed due to already reversed
CreditCard	CreditCardGenericError	When transaction has failed due to generic error
CreditCard	CreditCardServiceUnavailable	When transaction has failed due to service unavailable
CreditCard	CreditCardRetryLater	When transaction has failed. Retry later
CreditCard	CreditCardReversalRejected	When reversal transaction is rejected
CreditCard	CreditCardDuplicateReversal	When reversal transaction has failed due to duplicated
CreditCard	CreditCardTransactionAlreadySettled	When reversal transaction has failed due to already settled
CreditCard	CreditCardTimeoutReversal	When reversal transaction has failed due to timeout
CreditCard	CreditCardDuplicateTransaction	When transaction has failed due to duplicated
-------	-------	-------
MoneyTransfer	MoneyTransferAccountBlockForMerchant	When transaction has failed due to account blocked for merchant
MoneyTransfer	MoneyTransferAccountClosedOrBlocked	When transaction has failed due to account closed or blocked
MoneyTransfer	MoneyTransferContactSupport	When transaction has failed. Contact support
MoneyTransfer	MoneyTransferDeemedHighRisk	When transaction has failed due to deemed high risk
MoneyTransfer	MoneyTransferDuplicateTransaction	When transaction has failed due to duplicated
MoneyTransfer	MoneyTransferExceed24HoursLimitForMerchant	When transaction has failed due to exceeded preset 24-hour transaction count or amount limit for merchant.
MoneyTransfer	MoneyTransferExceed24HoursLimitForUser	When transaction has failed due to exceeded preset 24-hour transaction count or amount limit for user.
MoneyTransfer	MoneyTransferExceed30DaysLimitForMerchant	When transaction has failed due to exceeded preset 30-day transaction count or amount limit for merchant.
MoneyTransfer	MoneyTransferExceed30DaysLimitForUser	When transaction has failed due to exceeded preset 30-day transaction count or amount limit for user.
MoneyTransfer	MoneyTransferExceed7DaysLimitForMerchant	When transaction has failed due to exceeded preset 7-day transaction count or amount limit for merchant.
MoneyTransfer	MoneyTransferExceed7DaysLimitForUser	When transaction has failed due to exceeded preset 7-day transaction count or amount limit for user.
MoneyTransfer	MoneyTransferExceedsLimits	When transaction has failed due to exceeds limit
MoneyTransfer	MoneyTransferExceedsMonthlyLimits	When transaction has failed due to exceeds monthly limit
MoneyTransfer	MoneyTransferExceedsWithdrawalFrequencyLimit	When transaction has failed due to exceeds withdrawal frequency limit
MoneyTransfer	MoneyTransferExpiredCard	When transaction has failed due to expired card
MoneyTransfer	MoneyTransferGenericError	When transaction has failed due to generic error
MoneyTransfer	MoneyTransferInvalidAmount	When transaction has failed due to account blocked for merchant
MoneyTransfer	MoneyTransferInvalidCardOrDetails	When transaction has failed due to invalid card or card details
MoneyTransfer	MoneyTransferInvalidMerchantSetUp	When transaction has failed due to invalid merchant setup
MoneyTransfer	MoneyTransferInvalidRequest	When transaction has failed due to invalid request
MoneyTransfer	MoneyTransferLostOrStolenCard	When transaction has failed due to lost ot stolen card
MoneyTransfer	MoneyTransferRejectedByIssuingBank	When transaction is rejected by issuing bank
MoneyTransfer	MoneyTransferRetryLater	When transaction has failed. Retry later
MoneyTransfer	MoneyTransferSecurityViolation	When transaction has failed due to security violation
MoneyTransfer	MoneyTransferServiceUnavailable	When transaction has failed due to service unavailable
MoneyTransfer	MoneyTransferSuspectedFraud	When transaction has failed due to suspected fraud
MoneyTransfer	MoneyTransferTransactionNotPermitted	When transaction is not permitted
MoneyTransfer	MoneyTransferUnknownResponseFromIssuingBank	When transaction has failed due to unknown response from issuing bank
MoneyTransfer	MoneyTransferWithdrawalAmountLimit	When transaction has failed due to exceeds withdrawal amount limit
MoneyTransfer	MoneyTransferInitiated	When transaction is send to the bank
MoneyTransfer	MoneyTransferAuthorized	When transaction is authorized by the bank
MoneyTransfer	MoneyTransferVoidOrReversalInitiated	When transaction cancellation is initiated
MoneyTransfer	MoneyTransferVoidedOrFullyReversed	When transaction cancellation is confirmed
MoneyTransfer	MoneyTransferVoidedOrFullyReversedDueToSuspectedFraud	When transaction cancellation is confirmed due to suspicion of fraud
MoneyTransfer	MoneyTransferDuplicateReversal	When transaction cancellation is not authorized due to duplication
MoneyTransfer	MoneyTransferReversalRejected	When transaction cancellation is not authorized
MoneyTransfer	MoneyTransferTransactionAlreadyReversed	When transaction is already cancelled
MoneyTransfer	MoneyTransferTransactionAlreadySettled	When transaction cancellation is not authorized due to funds already being settled
MoneyTransfer	MoneyTransferCouldNotLocateOriginalTransaction	When transaction cancellation is not authorized due to not being able to locate transaction
MoneyTransfer	MoneyTransferReversalFailed	When transaction cancellation failed due to a error
MoneyTransfer	MoneyTransferTransactionAlreadyRefunded	When transaction is already refunded
MoneyTransfer	MoneyTransferRefundNotToOriginalCreditCard	When transaction has failed due to refund not being issued to the original credit card.

Transaction Chargeback Status

Type	Description
Pending	Indicates the chargeback is pending to take action.
AcceptedByUser	Indicates the chargeback was accepted by user via portal or API.
AcceptedByDefault	Indicates the chargeback was accepted past due date.
Disputed	Indicates the chargeback was disputed by user via portal our API.

Date Operators

Type	Description
IsInTheLast	Filter records on or after
ExactlyMatches	Filter records with exact date
IsBetween	Filters records in range
IsAfter	Filter records after date
IsOnOrAfter	Filter records on or after
IsBefore	Filter records before date
IsBeforeOrOn	Filter records before or on date

Date Types

Type	Description
CreatedAt	Filter records based on date when transactions were created
CompletedAt	Filter records based on date when transactions were completed
CancelledAt	Filters records based on date when transactions were cancelled
FailedAt	Filter records based on date when transactions were failed

Response

Parameter	Type	Description
CurrentPage	number	The current page
PageSize	number	The amount of rows returned in the current page
TotalCount	number	The total rows the filter returns
Items			List of transactions
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
ZumRailsType	string	Transaction type
TransactionMethod	string	Transaction method
TransactionStatus	string	Indicate the status of the transaction
RecurrentTransactionId	guid	The id of the recurrent transaction that created this transaction (null if inexistent)
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date transaction will be sent to the financial institution
ClientTransactionId	string	The Transaction id you informed in the creation of the transaction

Canada

Parameter	Type	Description
CurrentPage	number	The current page
PageSize	number	The amount of rows returned in the current page
TotalCount	number	The total rows the filter returns
Items			List of transactions
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
ZumRailsType	string	Transaction type
TransactionMethod	string	Transaction method
TransactionStatus	string	Indicate the status of the transaction
RecurrentTransactionId	guid	The id of the recurrent transaction that created this transaction (null if inexistent)
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date transaction will be sent to the financial institution
ClientTransactionId	string	The Transaction id you informed in the creation of the transaction

US

Parameter	Type	Description
CurrentPage	number	The current page
PageSize	number	The amount of rows returned in the current page
TotalCount	number	The total rows the filter returns
Items		List of transactions
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
Currency	string	Transaction currency
ZumRailsType	string	Transaction type
TransactionMethod	string	Transaction method
TransactionStatus	string	Indicates the status of the transaction
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date on which the transaction will be sent to the financial institution
ClientTransactionId	string	The Transaction id you informed in the creation of the transaction
TelecheckApprovalCode	string	When the transaction method is ACH with provider Telecheck (null otherwise)
TelecheckDenialRecordNumber	string	When the transaction method is ACH with provider Telecheck and the transaction was denied (null otherwise)
PaymentInstrumentId	string	ayment instrument id

TIP

If you need to search for a specific transaction, we recommend for you to retrieve the transaction id and then use the GET specific transaction endpoint to retrieve the detailed information about the transaction.

Search a transaction

Use this endpoint to search for specific transactions. You can filter results using various parameters. Transactions are returned in a paginated format, so to retrieve all results, you’ll need to make successive calls to this endpoint while incrementing the CurrentPage value.

Method: POST

Endpoint: {{env}}/api/transaction/filter

Payload

{
    "Id": "c7a8a909...364e8836409d",
    "CreatedAtFrom": "2020-05-13T04:00:00.000Z",
    "CreatedAtTo": "2020-05-13T04:00:00.000Z",
    "CreatedAtOperator": "isBetween",
    "UserId": "4085e4dc...20522aab5e1b",
    "ZumRailsType": "FundZumWallet",
    "TransactionMethod": "Eft",
    "TransactionStatus": "Completed",
    "FailedTransactionEvent": "EftFailedValidationRejection",
    "Pagination": 
    {
        "PageNumber": 1
    }
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "CurrentPage": 1,
    "PageSize": 1,
    "TotalCount": 2,
    "Items": [
      {
        "Id": "b7a8a505...364e8836404e",
        "CreatedAt": "2020-05-13T17:59:47.039462",
        "Memo": "Memo test",
        "Comment": "This is a transaction to test the platform",
        "Amount": 123.45,
        "ZumRailsType": "FundZumWallet",
        "TransactionMethod": "Eft",
        "TransactionStatus": "InProgress",
        "RecurrentTransactionId": "16d2406f...87d397a8356g",
        "FailedTransactionEvent": null
      },
      {
        "Id": "c8a8a505...364e8836405f",
        "CreatedAt": "2020-05-13T17:59:47.039462",
        "Memo": "Memo test",
        "Comment": "This is a transaction to test the platform",
        "Amount": 123.45,
        "ZumRailsType": "FundZumWallet",
        "TransactionMethod": "Eft",
        "TransactionStatus": "Failed",
        "RecurrentTransactionId": null,
        "FailedTransactionEvent": "EftFailedValidationRejection"
      }
    ]
  }
}

Input parameters

Parameter	Type	Mandatory	Description
Id	guid	no	Transaction id
GenericSearch	string	no	Filter transactions by user name, user email, client transaction id, transaction id and memo
ZumRailsType	string	no	Transaction type
TransactionMethod	string	no	The transaction method
TransactionStatus	string	no	Transaction status
FailedTransactionEvent	string	no	Transaction event (column Event from the "Transaction Events" table)
DateType	string	no	The type of date on which the date-filter applies.
CreatedAtFrom	datetime	no	Start date (This field is only used when the operator is between)
CreatedAtTo	datetime	no	End date (This field is only used when the operator is between)
CreatedAt	datetime	no	Created date
CreatedAtOperator	string	no	Operator to filter with CreatedAt properties
UserId	string	no	User id
ClientTransactionId	string	no	The Transaction id you informed in the creation of the transaction
Memo	string	no	Memo field
Comment	string	no	Comment field
FraudAlertActionTaken	boolean	no	Filter transactions for which the fraud alert action was taken
FraudAlertReported	boolean	no	Filter transactions that were reported for fraud through internal analysis
Pagination		no
PageNumber	number	no	The respective page, starting at 1

Date Operators

Type	Description
IsInTheLast	Filter records on or after
ExactlyMatches	Filter records with exact date
IsBetween	Filters records in range
IsAfter	Filter records after date
IsOnOrAfter	Filter records on or after
IsBefore	Filter records before date
IsBeforeOrOn	Filter records before or on date

Date Types

Type	Description
CreatedAt	Filter records based on date when transactions were created
CompletedAt	Filter records based on date when transactions were completed
CancelledAt	Filters records based on date when transactions were cancelled
FailedAt	Filter records based on date when transactions were failed

Response

Parameter	Type	Description
CurrentPage	number	The current page
PageSize	number	The amount of rows returned in the current page
TotalCount	number	The total rows the filter returns
Items		List of transactions
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Memo	string	Transaction memo
Comment	string	Transaction comment
Amount	decimal	Transaction amount
ZumRailsType	string	Transaction type
TransactionMethod	string	Transaction method
TransactionStatus	string	Indicate the status of the transaction
RecurrentTransactionId	guid	The id of the recurrent transaction that created this transaction (null if inexistent)
FailedTransactionEvent	string	If the transaction has failed, the transaction event that caused it (null otherwise)
ScheduledStartDate	date	The date transaction will be sent to the financial institution
ClientTransactionId	string	The Transaction id you informed in the creation of the transaction

tip

If you're looking for a specific transaction, we recommend first retrieving its transaction ID. You can then use the GET Specific Transaction endpoint to access detailed information about that transaction.

Cancel a transaction

Use this endpoint if you want to delete or cancel a specific transaction.

Method: DELETE

Endpoint: {{env}}/api/transaction/{transaction_id}

Response

{
  "statusCode": 200,
  "message": "DELETE Request successful.",
  "isError": false,
  "result": "Request completed"
}

INFO (Canada)

• For EFT, transactions can only be deleted and cancelled if it's not transmitted to the financial institution. We send transactions to the financial institution multiple times a day.

• For Interac, the transactions are not canceled right away since we need to wait for the providers’ response. We will return 200 (OK) meaning that the cancellation request was successful. Also, transactions can only be deleted and cancelled if the end-user has not yet initiated the payment by opening the email/sms.

• For Visa Direct / Credit card, transactions cannot be deleted/cancelled. If needed you can call the endpoint to Reverse a Transaction.

INFO (US)

• For credit card payment method, cancellation is allowed only on those transactions that have not been refunded.

INFO (US)

• For credit card payment method, cancellation is allowed only on those transactions that have not been refunded.

Transaction batch

It is also possible to create transactions by uploading it using a CSV file. The template CSV file can be found in the portal.

To be able to upload, first you need to validate the file, second upload and create transactions.

INFO

Uploading a Batch CSV is only available right now for transaction method: EFT

Validating a batch

Use this endpoint if you want to validate a transactions batch file.

Method: POST

Endpoint: {{env}}/api/transaction/ValidateBatchFile

Payload

{
  "TransactionType": "AccountsReceivable",
  "WalletId": "30126b59-ab21-491c-8033-008376504210",
  "Bytes": "Zmlyc3RfbmFtZSo7bGFzdF9uYW1lKjtidXNpbmVzc19uYW1lO2luc3RpdHV0aW9uX251bWJlcio7YnJhbmNoX251bWJlcio7YWNjb3VudF9udW1iZXIqO2Ftb3VudF9pbl9jZW50cyo7dHJhbnNhY3Rpb25fY29tbWVudDttZW1vKjtzY2hlZHVsZWRfZGF0ZQpKb2huO0RvZTs7MTIzOzEyMzQ1OzEyMzQ1Njc7MTAwO0ludGVybmFsIE1lc3NhZ2U7TWVtbyBtZXNzYWdlOw=="
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "InvalidTransactions": "0",
    "Status": "Ok",
    "TotalAmount": 6,
    "Transactions": [
      {
        "AccountNumber": "12345671",
        "Amount": 1,
        "Comment": "Internal message 1",
        "CompanyName": "",
        "CustomerId": null,
        "FirstName": "John1",
        "InstitutionNumber": "123",
        "LastName": "Doe1",
        "Memo": "Memo message 1",
        "Status": "Ok",
        "TransitNumber": "23451"
      },
      {
        "AccountNumber": "12345672",
        "Amount": 2,
        "Comment": "Internal message 2",
        "CompanyName": "",
        "CustomerId": null,
        "FirstName": "John2",
        "InstitutionNumber": "123",
        "LastName": "Doe2",
        "Memo": "Memo message 2",
        "Status": "Ok",
        "TransitNumber": "23452"
      },
      {
        "AccountNumber": "12345673",
        "Amount": 3,
        "Comment": "Internal message 3",
        "CompanyName": "",
        "CustomerId": null,
        "FirstName": "John3",
        "InstitutionNumber": "123",
        "LastName": "Doe3",
        "Memo": "Memo message 3",
        "Status": "Ok",
        "TransitNumber": "23453"
      }
    ],
    "ValidTransactions": 13
  }
}

Input parameters

Parameter	Type	Mandatory	Description
TransactionType	string	yes	Transaction type
WalletId	string	no	The Wallet Id, according to TransactionType
FundingSourceId	string	no	The Funding Source Id
Bytes	string	yes	The file's blob

• Concerning FundingSourceId and WalletId, just one of them must be sent

Response

Parameter	Type	Description
InvalidTransactions	string	The amount of invalid transactions
ValidTransactions	int	The amount of valid transactions
Status	string	The validation status
TotalAmount	decimal	The sum of all transactions amount
Transactions
AccountNumber	string	The account number
Amount	decimal	The transaction's amount
Comment	string	The transaction's comment
CompanyName	string	Company's name
CustomerId	string	Customer id
FirstName	string	User's first name
LastName	string	User's last name
InstitutionNumber	string	Institution's number
Memo	string	The transaction's memo
Status	string	The status
TransitNumber	string	Transit number

Each transaction will return a Status property explaining what is wrong with it

Status

Description
Ok
First Name, Last Name or Company name are mandatory
Either First and Last Name or Company Name should be informed
Institution, Transit and Account numbers are mandatory
Institution Number min length is 3 characters
Transit Number length needs to be 5 characters
Account Number min length is 5 characters
Account Number max length is 12 characters
Invalid amount
Amount must be greater than zero
Duplicated transaction

Creating a bulk transaction

Use this endpoint if you want to create transactions using a batch file.

Method: POST

Endpoint: {{env}}/api/transaction/ProcessBatchFile

Payload

{
  "TransactionType": "AccountsReceivable",
  "WalletId": "30126b59-ab21-491c-8033-008376504210",
  "Bytes": "Zmlyc3RfbmFtZSo7bGFzdF9uYW1lKjtidXNpbmVzc19uYW1lO2luc3RpdHV0aW9uX251bWJlcio7YnJhbmNoX251bWJlcio7YWNjb3VudF9udW1iZXIqO2Ftb3VudF9pbl9jZW50cyo7dHJhbnNhY3Rpb25fY29tbWVudDttZW1vKjtzY2hlZHVsZWRfZGF0ZQpKb2huO0RvZTs7MTIzOzEyMzQ1OzEyMzQ1Njc7MTAwO0ludGVybmFsIE1lc3NhZ2U7TWVtbyBtZXNzYWdlOw=="
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false
}

Input parameters

Parameter	Type	Mandatory	Description
TransactionType	string	yes	Transaction type
WalletId	string	no	The Wallet Id, according to TransactionType
FundingSourceId	string	no	The Funding Source Id
Bytes	string	yes	The file's blob
WithdrawSumTotalFromFundingSource	bool	no	If set to True, we will do one transaction to pull the entire sum of transactions in the batch from the funding source. This is only applicable for Accounts Payable transactions with more than 1 transaction in the file. It does not work for scheduled transactions. Read more about this feature here.

• Concerning FundingSourceId and WalletId, just one of them must be sent

TransactionType

Type	Description
AccountsReceivable	Execute accounts receivable AR
AccountsPayable	Execute accounts payable AP

Refund a Transaction

Use this endpoint if you want to validate a transactions batch file.

Method: POST

Endpoint: {{env}}/api/transaction/ValidateBatchFile

Payload

{
  "TransactionType": "AccountsReceivable",
  "WalletId": "30126b59-ab21-491c-8033-008376504210",
  "Bytes": "Zmlyc3RfbmFtZSo7bGFzdF9uYW1lKjtidXNpbmVzc19uYW1lO2luc3RpdHV0aW9uX251bWJlcio7YnJhbmNoX251bWJlcio7YWNjb3VudF9udW1iZXIqO2Ftb3VudF9pbl9jZW50cyo7dHJhbnNhY3Rpb25fY29tbWVudDttZW1vKjtzY2hlZHVsZWRfZGF0ZQpKb2huO0RvZTs7MTIzOzEyMzQ1OzEyMzQ1Njc7MTAwO0ludGVybmFsIE1lc3NhZ2U7TWVtbyBtZXNzYWdlOw=="
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "InvalidTransactions": "0",
    "Status": "Ok",
    "TotalAmount": 6,
    "Transactions": [
      {
        "AccountNumber": "12345671",
        "Amount": 1,
        "Comment": "Internal message 1",
        "CompanyName": "",
        "CustomerId": null,
        "FirstName": "John1",
        "InstitutionNumber": "123",
        "LastName": "Doe1",
        "Memo": "Memo message 1",
        "Status": "Ok",
        "TransitNumber": "23451"
      },
      {
        "AccountNumber": "12345672",
        "Amount": 2,
        "Comment": "Internal message 2",
        "CompanyName": "",
        "CustomerId": null,
        "FirstName": "John2",
        "InstitutionNumber": "123",
        "LastName": "Doe2",
        "Memo": "Memo message 2",
        "Status": "Ok",
        "TransitNumber": "23452"
      },
      {
        "AccountNumber": "12345673",
        "Amount": 3,
        "Comment": "Internal message 3",
        "CompanyName": "",
        "CustomerId": null,
        "FirstName": "John3",
        "InstitutionNumber": "123",
        "LastName": "Doe3",
        "Memo": "Memo message 3",
        "Status": "Ok",
        "TransitNumber": "23453"
      }
    ],
    "ValidTransactions": 13
  }
}

Input parameters

Parameter	Type	Mandatory	Description
TransactionType	string	yes	Transaction type
WalletId	string	no	The Wallet Id, according to TransactionType
FundingSourceId	string	no	The Funding Source Id
Bytes	string	yes	The file's blob

• Concerning FundingSourceId and WalletId, just one of them must be sent

Response

Parameter	Type	Description
InvalidTransactions	string	The amount of invalid transactions
ValidTransactions	int	The amount of valid transactions
Status	string	The validation status
TotalAmount	decimal	The sum of all transactions amount
Transactions
AccountNumber	string	The account number
Amount	decimal	The transaction's amount
Comment	string	The transaction's comment
CompanyName	string	Company's name
CustomerId	string	Customer id
FirstName	string	User's first name
LastName	string	User's last name
InstitutionNumber	string	Institution's number
Memo	string	The transaction's memo
Status	string	The status
TransitNumber	string	Transit number

Each transaction will return a Status property explaining what is wrong with it

Status

Description
Ok
First Name, Last Name or Company name are mandatory
Either First and Last Name or Company Name should be informed
Institution, Transit and Account numbers are mandatory
Institution Number min length is 3 characters
Transit Number length needs to be 5 characters
Account Number min length is 5 characters
Account Number max length is 12 characters
Invalid amount
Amount must be greater than zero
Duplicated transaction

Creating a bulk transaction

Use this endpoint if you want to create transactions using a batch file.

Method: POST

Endpoint: {{env}}/api/transaction/ProcessBatchFile

Payload

{
  "TransactionType": "AccountsReceivable",
  "WalletId": "30126b59-ab21-491c-8033-008376504210",
  "Bytes": "Zmlyc3RfbmFtZSo7bGFzdF9uYW1lKjtidXNpbmVzc19uYW1lO2luc3RpdHV0aW9uX251bWJlcio7YnJhbmNoX251bWJlcio7YWNjb3VudF9udW1iZXIqO2Ftb3VudF9pbl9jZW50cyo7dHJhbnNhY3Rpb25fY29tbWVudDttZW1vKjtzY2hlZHVsZWRfZGF0ZQpKb2huO0RvZTs7MTIzOzEyMzQ1OzEyMzQ1Njc7MTAwO0ludGVybmFsIE1lc3NhZ2U7TWVtbyBtZXNzYWdlOw=="
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false
}

Input parameters

Parameter	Type	Mandatory	Description
TransactionType	string	yes	Transaction type
WalletId	string	no	The Wallet Id, according to TransactionType
FundingSourceId	string	no	The Funding Source Id
Bytes	string	yes	The file's blob
WithdrawSumTotalFromFundingSource	bool	no	If set to True, we will do one transaction to pull the entire sum of transactions in the batch from the funding source. This is only applicable for Accounts Payable transactions with more than 1 transaction in the file. It does not work for scheduled transactions. Read more about this feature here.

• Concerning FundingSourceId and WalletId, just one of them must be sent

TransactionType

Type	Description
AccountsReceivable	Execute accounts receivable AR
AccountsPayable	Execute accounts payable AP

Refund a Transaction

With Zūm Rails, it is easy to refund Credit Card transactions. Currently we support whole/partial refunds of initial transactions. When you create a new refund, you must specify the transaction ID that you wish to refund. Creating a new refund will refund a transaction that has previously been created but not yet refunded. Funds will be refunded to the credit card that was originally charged. Read more about refunds here.

Method: POST

Endpoint: {{env}}/api/transaction/{transaction_id}/Refund

Response (Canada)

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "Id": "82536c13...5f1cbb98c6c3",
    "CreatedAt": "2022-07-19T16:57:48.505577Z",
    "Memo": "Refund",
    "Comment": "78f8f734...d7f8408596c9",
    "Amount": 2.74,
    "Customer": {
      "Id": "e15bbe9b...dc256ba3a247",
      "CompanyName": "Sam's Gym"
    },
    "User": {
      "Id": "c11cc378...8f34ac8173be",
      "FirstName": "John",
      "LastName": "111",
      "Email": "[e-mail]",
      "IsActive": true
    },
    "Wallet": {
      "Id": "1790e62a...fda052b74341",
      "Type": "Unified"
    },
    "ZumRailsType": "Refund",
    "TransactionMethod": "CreditCard",
    "TransactionHistory": [
      {
        "Id": "152ab24d...9b936225368a",
        "CreatedAt": "2022-07-19T16:57:48.5981359Z",
        "Event": "Started",
        "EventDescription": "Transaction with type Refund started, from Zūm Wallet to User John 111 - (************2446) with amount: $2.74"
      },
      {
        "Id": "c45a7cb5...b0cc3db894fb",
        "CreatedAt": "2022-07-19T16:57:50.2792507Z",
        "Event": "Succeeded",
        "EventDescription": "Transaction completed"
      }
    ],
    "TransactionStatus": "Completed",
    "From": "Zūm Wallet",
    "To": "User John 111 - (************2446)",
    "CompletedAt": "2022-07-19T16:57:50.2889607Z",
    "IsRefundable": false
  }
}

Response (US)

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "PaymentInstrumentId": "3394e27c...a3dba799bb0e",
    "CreditCardResponseCode": "000",
    "CreditCardAdditionalResponseData": "APPROVAL",
    "Id": "57bad817...f883d1c133bd",
    "CreatedAt": "2023-10-25T16:01:29.0270908Z",
    "Memo": "Refund",
    "Comment": "7c5af277-9509-44f8-a1e6-3e8c0c573992",
    "Amount": 9.99,
    "Customer": {
      "Id": "e15bbe9b...dc256ba3a247",
      "CompanyName": "Sam's Gym",
      "CompanyEmail": "[e-mail]"
    },
    "User": {
      "Id": "c11cc378...8f34ac8173be",
      "FirstName": "John",
      "LastName": "111",
      "Email": "[e-mail]",
      "IsActive": true,
      "PaymentInstruments": [
        {
            "Id": "3394e27c...a3dba799bb0e"
        }
      ]
    },
    "Wallet": {
      "Id": "1790e62a...fda052b74341",
      "Type": "Unified",
      "Currency": "USD"
    },
    "ZumRailsType": "Refund",
    "TransactionMethod": "CreditCard",
    "TransactionHistory": [
      {
        "Id": "37a5b114-2164-4e0e-9605-316c5c6583c6",
        "CreatedAt": "2023-10-25T16:01:29.1598149Z",
        "Event": "Started",
        "EventDescription": "Transaction with type Refund started, from Zūm Wallet to User John 111 - (************2446) with amount: $9.99"
      },
      {
        "Id": "66b6db34-2264-48ba-99d3-99446c08c8ea",
        "CreatedAt": "2023-10-25T16:01:33.1735111Z",
        "Event": "WalletWithdrawn",
        "EventDescription": "Wallet withdrawn, amount: $9.99"
      },
      {
        "Id": "1bb732fc-843f-44bc-a570-85a375ac2136",
        "CreatedAt": "2023-10-25T16:01:33.2034046Z",
        "Event": "Succeeded",
        "EventDescription": "Transaction completed"
      }
    ],
    "TransactionStatus": "Completed",
    "From": "Zūm Wallet",
    "To": "User John 111 - (************2446)",
    "CompletedAt": "2022-07-19T16:57:50.2889607Z",
    "Currency": "USD"
  }
}

Payload

{
  "Amount": 9.99
}

Response

Same response details of get transaction API.

CAUTION (Canada)

To simulate a Partial refund transaction in Sandbox, use the word PartialRefundTest in the field COMMENT while creating a Credit Card transaction. If the word PartialRefundTest is not informed, or something else is informed, you will not be able to simulate multiple Partial Refunds for this transaction.

Retrieve a refund

To retrieve the details of an existing refund, use the get transaction API.

List all refunds

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds will be returned by default. To get a list of all refunds, use the filter transaction API.