{"info":{"_postman_id":"bd4b987d-1db5-4338-b0f9-da3c0efeec38","name":"BNA REST API DOCUMENTATION","description":"

BNA Smart Payment is a technology company working to improve the payment experience for its merchants and their customers and suppliers. As such, BNA Smart Payment strives to fill the gaps in traditional payment processing and offers an ever-growing range of payment methods. It strives to help merchants reach a wider audience and a younger demographic while increasing customer satisfaction and customer loyalty. With charities, BNA Smart Payment helps more of the raised funds reach their intended cause by lowering a charity’s overall payment processing costs. BNA Smart Payment also reduces a charity’s administrative overhead by allowing donors to manage their own payment accounts. Additionally, since no two organisations are exactly alike, BNA Smart Payment also creates custom payment solutions, tailored to fit an organisation’s unique payment requirements.

Herein are the APIs to access BNA Smart Payment payment accounts, payment methods, and payments from a merchant’s website.

Overview

BNA Smart Payment Merchant Portal allows a Merchant to set up BNA Smart Payment with a range of payment methods and recurring payment schedules, and to take payments. BNA Smart Payment APIs give access to these functions on the Merchant Portal from a Merchant’s website. The APIs allow, for example, BNA Smart Payment to manage their own payment accounts on the Merchant Portal from the Merchant’s website. Likewise, the Merchant can use the APIs to give, for example, its helpdesk access to these functions on the Merchant Portal to support its BNA Smart Payment.

Base URL

BNA Smart Payment provides two completely separate environments for API requests:

a staging environment for testing
\n
a production environment for live transactions.
\n

The environments are completely separate and share no information, including API credentials.

Staging URL

Process test transactions with the following URL:

Open API URL: https://stage-api-service.bnasmartpayment.com

Production URL

Process live transactions with the following URL:

Open API URL: https://api.bnasmartpayment.com

Credit Card Test Numbers

The following credit card test numbers may be used within the staging environment.

Visa

4441111111111111
\n
4442222222222222
\n

Mastercard

5555123444441115
\n
5555432144443212
\n

Discover

6011201300002340
\n
6011027500001232
\n

American Express Card

370000000000002
\n
340000111111117
\n

Note: Do not use real credit card numbers within the staging environment. You will receive an error. Credit card test numbers are provided above for use in the staging environment. Conversely, do not use the above test credit card numbers in the production environment. You will receive an error.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Base URL","slug":"base-url"}],"owner":"18284723","collectionId":"bd4b987d-1db5-4338-b0f9-da3c0efeec38","publishedId":"2sB3BGFokT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00ACE0"},"publishDate":"2025-08-12T17:13:54.000Z"},"item":[{"name":"Authentication","item":[{"name":"Health check","id":"0b0a3dfb-eaa1-4f4f-ad30-0e8350773e41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}","description":"

The \"Health Check\" endpoint in the \"BNA REST API Service\" is designed to ensure that the system is running and operational. This endpoint typically performs a quick assessment of the essential components and services within the API to verify they are responsive. It is a valuable tool for monitoring the API's health status, often used in production environments to ensure continuous service availability and to detect and respond to issues before they impact users.

\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8feb20ae-bf44-4de1-afb1-03f6af9d673e","name":"Health check","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 11 May 2024 20:05:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"1a2b4f20397d74a2bc16b52d416adfcc"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"date\": \"2024-05-11T20:05:10.987Z\"\n}"}],"_postman_id":"0b0a3dfb-eaa1-4f4f-ad30-0e8350773e41"}],"id":"376b0f83-c404-458f-a728-21b7af93f9d1","description":"

Authentication is the procedure used to confirm the legitimacy of the connected application. The BNA System employs API 1.0 interface to authenticate each message, ensuring that the credentials within the messages are accurate.

All requests, both financial and non-financial, are authenticated by the BNA Gateway. This authentication process utilizes Access Keys and Secret Keys.

Secret Keys can be administered through the BNA merchant portal, where multiple Secret Keys can be activated concurrently. It's imperative to securely manage these Secret Keys.

Basic Authorization

The following basic authorization is required in the header:

Authorization: Basic {{credentials}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
`credentials` required	BASE64 encoded string of client credentials: {{accessKey}}:{{secretKey}}
`accessKey` required	Merchant's Access Key.
`secretKey` required	Merchant's Secret Key.

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d1410656-ff49-4cae-bd87-3924397811ff"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"cd3aac03-a420-4194-bd57-a56438a6d8d4"}}],"_postman_id":"376b0f83-c404-458f-a728-21b7af93f9d1"},{"name":"Merchant","item":[{"name":"Retrieve Merchant account","id":"3bd31cfc-46e3-4444-b37a-b35ffb137d91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/account","description":"

The 'Retrieve account' endpoint is designed to obtain comprehensive details about the Merchant, including general information and specific fee structures for different payment methods, where applicable.

Definitions:

* A ‘Merchant’ includes any business or organization, such as retailers, charities, not-for-profits, funeral homes, auto dealers, service providers, online sites, or any entity that receives payments from third parties.

To access account information, issue a GET request to the v1/account endpoint, ensuring to include the Basic credentials in the request header.

Response parameters

Option	Type	Description
`companyName`	String	Merchant's company name.
`legalName`	String	Merchant's company legal name.
`legalAddress`	Object	An object which contains all the information about the Merchant's legal address.
├── `apartment`	String	Merchant's legal apartment number.
├── `streetNumber`	String	Merchant's legal street number.
├── `streetName`	String	Merchant's legal street name.
├── `city`	String	Merchant's legal city.
├── `province`	String	Merchant's legal province/state.
├── `country`	String	Merchant's legal country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian merchants: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`billingAddress`	Object	An object which contains all the information about the Merchant's billing address.
├── `apartment`	String	Merchant's legal apartment number.
├── `streetNumber`	String	Merchant's legal street number.
├── `streetName`	String	Merchant's legal street name.
├── `city`	String	Merchant's legal city.
├── `province`	String	Merchant's legal province/state.
├── `country`	String	Merchant's legal country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian merchants: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`businessAddress`	Object	An object which contains all the information about the Merchant's business address.
├── `apartment`	String	Merchant's legal apartment number.
├── `streetNumber`	String	Merchant's legal street number.
├── `streetName`	String	Merchant's legal street name.
├── `city`	String	Merchant's legal city.
├── `province`	String	Merchant's legal province/state.
├── `country`	String	Merchant's legal country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian merchants: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`fees`	Object	An object which contains all information about fee structures for different payment methods, when applicable
├── `cashPercentage`	Number Float to two decimal places	Percentage fee rate to be applied to the Customer for a given `CASH` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment. Possible values: from `0` to `100`
├── `cashFlat`	Number Float to two decimal places	Flat fee amount to be applied to the Customer for a given `CASH` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment.
├── `chequePercentage`	Number Float to two decimal places	Percentage fee rate to be applied to the Customer for a given `CHEQUE` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment. Possible values: from `0` to `100`
├── `chequeFlat`	Number Float to two decimal places	Flat fee amount to be applied to the Customer for a given `CHEQUE` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment.
├── `creditCardPercentage`	Number Float to two decimal places	Percentage fee rate to be applied to the Customer for a given `CREDIT CARD` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment. Possible values: from `0` to `100`
├── `creditCardFlat`	Number Float to two decimal places	Flat fee amount to be applied to the Customer for a given `CREDIT CARD` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment.
├── `etransferPercentage`	Number Float to two decimal places	Percentage fee rate to be applied to the Customer for a given `E-TRANSFER` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment. Possible values: from `0` to `100`
├── `etransferFlat`	Number Float to two decimal places	Flat fee amount to be applied to the Customer for a given `E-TRANSFER` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment.
├── `eftPercentage`	Number Float to two decimal places	Percentage fee rate to be applied to the Customer for a given `EFT` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment. Possible values: from `0` to `100`
└── `eftFlat`	Number Float to two decimal places	Flat fee amount to be applied to the Customer for a given `EFT` transaction when ‘ApplyFee’ is set to ‘true’ in the given payment.
`settlementTimes`	Array	An array containing objects that specify credit card settlement times for each currency.
├── `currency`	String	The \"currency\" key is an object property whose value represents the ISO 4217 currency code. This is a three-letter alphabetic code indicating the currency of the transaction's origin. Accepted values include CAD and USD.
├── `hour`	Number Intiger	The hour property is a key that holds an integer value representing the hour of the credit card settlement time. Possible values: from `0` to `23`
└── `minutes`	Number Intiger	The minutes property is a key that holds an integer value representing the minutes of the credit card settlement time. Possible values: from `0` to `59`
`programs`	Array	An array containing the list of programs associated with the merchant. Possible values: `payment_link`,`rest_api`,`webhooks`,`devices`,`virtual_terminal`,`scan2Give`,`3ds`,`google_pay`,`apple_pay`

","urlObject":{"path":["v1","account"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cc1d3025-dcd9-43bd-a0cb-dd042a1dbe09","name":"Retrieve Merchant account","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1042"},{"key":"x-trace-id","value":"1073d6f552c7600d335ae4caf328ec7a"},{"key":"date","value":"Thu, 11 Sep 2025 12:06:34 GMT"},{"key":"x-envoy-upstream-service-time","value":"140"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"companyName\": \"George Vince\",\n \"legalName\": \"George Vince\",\n \"legalAddress\": {\n \"city\": \"Milton\",\n \"country\": \"Canada\",\n \"postalCode\": \"L9T 8L1\",\n \"province\": \"Ontario\",\n \"streetName\": \"James Snow Parkway North\",\n \"streetNumber\": \"3333\",\n \"apartment\": \"13\"\n },\n \"billingAddress\": {\n \"city\": \"Milton\",\n \"country\": \"Canada\",\n \"postalCode\": \"L9T 8L1\",\n \"province\": \"Ontario\",\n \"streetName\": \"James Snow Parkway North\",\n \"streetNumber\": \"3333\",\n \"apartment\": \"13\"\n },\n \"businessAddress\": {\n \"city\": \"Mississauga\",\n \"country\": \"Canada\",\n \"postalCode\": \"L5T 2S9\",\n \"province\": \"Ontario\",\n \"streetName\": \"Gibraltar Drive\",\n \"streetNumber\": \"455\",\n \"apartment\": \"13\"\n },\n \"fees\": {\n \"eftFlat\": 2,\n \"cashFlat\": 4,\n \"eftPercentage\": 3,\n \"chequeFlat\": 4,\n \"cashPercentage\": 5,\n \"chequePercentage\": 2,\n \"creditCardFlat\": 6,\n \"creditCardPercentage\": 4,\n \"eTransferFlat\": 3,\n \"eTransferPercentage\": 4\n },\n \"settlementTimes\": [\n {\n \"currency\": \"USD\",\n \"hour\": 16,\n \"minutes\": 0\n },\n {\n \"currency\": \"CAD\",\n \"hour\": 16,\n \"minutes\": 0\n }\n ],\n \"programs\": [\n \"payment_link\",\n \"rest_api\",\n \"webhooks\",\n \"devices\",\n \"virtual_terminal\",\n \"scan2Give\",\n \"3ds\",\n \"payment_iframe\",\n \"wp_plugin\",\n \"google_pay\",\n \"apple_pay\",\n \"service_fee\"\n ]\n}"}],"_postman_id":"3bd31cfc-46e3-4444-b37a-b35ffb137d91"}],"id":"8a8767b2-c2fc-43a8-9859-269aa8e674db","description":"

Overview: Merchant Account

This section outlines the capabilities provided to merchants, allowing them to independently manage their payment accounts through the BNA Open API. Merchants have the autonomy to add or remove payment methods, and update their contact details. They also have the option to completely remove their payment account from the Merchant Portal.

The APIs listed below deliver uniform responses from the Merchant Portal, which simplifies integration across multiple functionalities on the merchant’s website:

Retrieve Merchant Account

\n","_postman_id":"8a8767b2-c2fc-43a8-9859-269aa8e674db"},{"name":"Customers","item":[{"name":"Report","item":[{"name":"Retrieve Customer by ID","id":"27f93035-4e1b-4c8f-a51c-9f3408339bd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/customers/:customerId","description":"

Overview: Retrieve Customer by ID API

The Retrieve Customer by Customer ID API allows a Customer to review, via the merchant’s website, their payment account on the Merchant Portal. The ‘request’ includes the Customer ID. The ‘response’ confirms whether or not the Customer information was successfully retrieved and includes all the contact and payment information found on the Merchant Portal for the given payment account. The response also includes information about whether or not to apply BNA Smart Payment Systems payment processing fees to the Customers by default, and, if so, how much for each payment method.

The Retrieve Customer API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also give its help desk this access to support its Customers, or it can just give this access to a third party administrator to manage the Customer payment accounts, and so on.

Definitions:
* A ‘Customer’ is a customer, donor, client, or other party that makes payment(s) to a merchant.
* In the case of PAYOUT, ‘Customer’ means ‘Payee’, such as a supplier or contractor, to which the merchant makes payments.
* A ‘Merchant’ is a retailer, charity, not-for-profit, funeral home, auto dealer, service provider, online site, or any other organization that accepts payments from a third party.

To retrieve a Customer by ID, send a GET request to the v1/customers/:customerId endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`customerId`	String required	Customer's unique identifier.

Response parameters

Option	Type	Description
`id`	String	Customer's ID.
`status`	String	Customer's status Possible values: `ACTIVE`, `INACTIVE`
`type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`email`	String	Customer's email.
`phoneCode`	String	Customer's country calling code.
`phoneNumber`	String	Customer's phone number.
`firstName`	String	Customer's first name.
`lastName`	String	Customer's last name.
`birthDate`	Date ISO 8601	Customer's birthday date.
`legalName`	String	Customer's legal business name. Required for business customer.
`businessIdNumber`	String	Customer's legal business number. Required for business customer.
`businessName`	String	Customer's business name. Required for business customer.
`companyName`	String	Customer's legal company name. Required for business customer.
`registrationName`	String	Customer's legal registration name. Required for business customer.
`retailName`	String	Customer's legal retail name. Required for business customer.
`billingAddress`	Object	Contains all the information about the customer's billing address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String	Customer's province/state.
├── `country`	String	Customer's country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`shippingAddress`	Object	Contains all the information about the customer's shipping address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String	Customer's province/state.
├── `country`	String	Customer's country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.

","urlObject":{"path":["v1","customers",":customerId"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{customerId}}","key":"customerId"}]}},"response":[{"id":"2d128109-ef97-4455-842c-d433ccac9004","name":"Retrieve Customer by ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/customers/:customerId","host":["{{base_url}}"],"path":["v1","customers",":customerId"],"variable":[{"key":"customerId","value":"{{customerId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"894"},{"key":"x-trace-id","value":"10bdde4b5518275323a2545fafb31578"},{"key":"date","value":"Thu, 11 Sep 2025 13:26:18 GMT"},{"key":"x-envoy-upstream-service-time","value":"52"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n },\n \"status\": \"ACTIVE\"\n}"}],"_postman_id":"27f93035-4e1b-4c8f-a51c-9f3408339bd5"},{"name":"Retrieve Customers List","id":"dab1dfb3-aa4c-448c-856d-b78771de1f03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{accessKey}}","password":"{{secretKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/customers?status=ACTIVE&limit=3&page=1","description":"

Overview: Retrieve Customers List API

The Retrieve All Customers API enables a Merchant to inspect, through their website, all customer or payee payment accounts hosted on the Merchant Portal. A successful 'response' will provide comprehensive contact and payment details for each Customer found on the portal.

The primary function of the Retrieve All Customers API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

Definitions:

* A ‘Customer’ refers to any individual or entity, such as a customer, donor, client, or similar, that makes payments to a merchant.
* A ‘Merchant’ includes any business or organization, such as retailers, charities, not-for-profits, funeral homes, auto dealers, service providers, online sites, or any entity that receives payments from third parties.

To retrieve all Customers, send a GET request to the /v1/customers endpoint with the Basic credentials included in the header.

Query parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`email`	String optional	Filter by Customer's email
`status`	String optional	Filter by Customer's status Possible values: `ACTIVE`, `INACTIVE`
`page`	Integer optional	Page number to retrieve.
`limit`	Integer optional	Number of records per page.

Response parameters

Option	Type	Description
`data`	Array	An array of objects.
`id`	String	Customer's ID.
`status`	String	Customer's status Possible values: `ACTIVE`, `INACTIVE`
`type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`email`	String	Customer's email.
`phoneCode`	String	Customer's country calling code.
`phoneNumber`	String	Customer's phone number.
`firstName`	String	Customer's first name.
`lastName`	String	Customer's last name.
`birthDate`	Date ISO 8601	Customer's birthday date.
`legalName`	String	Customer's legal business name. Required for business customer.
`businessIdNumber`	String	Customer's legal business number. Required for business customer.
`businessName`	String	Customer's business name. Required for business customer.
`companyName`	String	Customer's legal company name. Required for business customer.
`registrationName`	String	Customer's legal registration name. Required for business customer.
`retailName`	String	Customer's legal retail name. Required for business customer.
`billingAddress`	Object	Contains all the information about the customer's billing address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String	Customer's province/state.
├── `country`	String	Customer's country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`shippingAddress`	Object	Contains all the information about the customer's shipping address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String	Customer's province/state.
├── `country`	String	Customer's country
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`pages`	Object	Contains all the pagination details.
├── `totalRows`	Number	The total count of rows in the list.
├── `pageTotal`	Number	The total number of pages.
├── `pageNum`	Number	The current page number.
└── `pageSize`	Number	The number of rows per page.

","urlObject":{"path":["v1","customers"],"host":["{{base_url}}"],"query":[{"key":"status","value":"ACTIVE"},{"key":"limit","value":"3"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"811f08e0-1aa8-440c-adba-7cb3793decf5","name":"Retrieve Customers List","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/customers?status=ACTIVE&limit=3&page=1","host":["{{base_url}}"],"path":["v1","customers"],"query":[{"key":"status","value":"ACTIVE"},{"key":"limit","value":"3"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"2746"},{"key":"x-trace-id","value":"170ea74f1df1115e5f63e8e6a5caebd7"},{"key":"date","value":"Sun, 21 Sep 2025 00:26:53 GMT"},{"key":"x-envoy-upstream-service-time","value":"84"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777770\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"id\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444440\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"legalName\": \"Jason Johnson \",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61 \"\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"id\": \"62adf9d5-e7ab-4408-bdf1-6fd6a65ed9af\",\n \"email\": \"cewobo6544@mirarmax.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"6475555550\",\n \"firstName\": \"Sam\",\n \"lastName\": \"Watts\",\n \"birthDate\": \"1981-04-12\",\n \"businessIdNumber\": \"444666\",\n \"legalName\": \"Sam Watts\",\n \"businessName\": \"Sam Watts & Brothers\",\n \"companyName\": \"Sam Watts & Brothers\",\n \"registrationName\": \"Sam Watts\",\n \"retailName\": \"Sam Watts\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Caledon Street\",\n \"streetNumber\": \"35\",\n \"apartment\": \"22\",\n \"city\": \"Waterloo\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1S3D6\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n },\n \"status\": \"ACTIVE\"\n }\n ],\n \"pages\": {\n \"totalRows\": 4,\n \"pageTotal\": 2,\n \"pageNum\": 1,\n \"pageSize\": 3\n }\n}"}],"_postman_id":"dab1dfb3-aa4c-448c-856d-b78771de1f03"}],"id":"8e2c3a10-cf12-44eb-940f-b5c0d3cf19a7","description":"

Report API – Customer Retrieval

The Report API provides endpoints to retrieve customer data, either by a specific customer ID or as a complete list. These endpoints support reporting, analytics, and customer management features by enabling external systems to query customer information.

\n","_postman_id":"8e2c3a10-cf12-44eb-940f-b5c0d3cf19a7"},{"name":"Manage Customers","item":[{"name":"Create Customer","event":[{"listen":"prerequest","script":{"id":"393e5ec9-de2a-4793-b461-4db9efb025b0","exec":["pm.variables.set('randomPhoneNumber', _.random(1000000000,9999999999))"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"1aa47f3a-5cc9-44cc-ab5d-1072df8cfc17","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"porev10406@noidos.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"5555555555\",\n \"firstName\": \"Sam\",\n \"lastName\": \"Watts\",\n \"birthDate\": \"1981-04-12\",\n \"legalName\": \"Sam Watts\",\n \"type\": \"BUSINESS\",\n \"businessIdNumber\": \"444666\",\n \"businessName\": \"Sam Watts & Brothers\",\n \"companyName\": \"Sam Watts & Brothers\",\n \"registrationName\": \"Sam Watts\",\n \"retailName\": \"Sam Watts\",\n \"billingAddress\": {\n \"streetName\": \"Caledon Street\",\n \"streetNumber\": \"35\",\n \"apartment\": \"22\",\n \"city\": \"Waterloo\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1S3D6\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/customers","description":"

Overview: Create Customer API

The Create Customer API allows a user to set up their own payment account on the Merchant Portal. The ‘request’ includes Customer contact information, such as name and address. The ‘response’ confirms whether or not the payment account was successfully created and returns a Customer ID for this new payment account. This Customer ID is needed for the Customer to execute, via the merchant’s website, any/all other payment account management activities on the Merchant Portal.

The Create Customer API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also give its help desk this access to support its Customers, or it can just give this access to a third party administrator to manage the Customer payment accounts, and so on.

Definitions:

* A ‘Customer’ is a customer, donor, client, or other party that makes payment(s) to a merchant.
* In the case of PAYOUT transactions, ‘Customer’ means ‘Payee’, such as a supplier or contractor, to which the merchant makes payments.
* A ‘Merchant’ is a retailer, charity, not-for-profit, funeral home, auto dealer, service provider, online site, or any other organization that accepts payments from a third party.

To create a Customer's account, send a POST request to the /v1/customers endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`type`	String required	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`email`	String required	Customer's email address.
`phoneCode`	String optional	Customer's country calling code.
`phoneNumber`	String optional	Customer's phone number.
`firstName`	String required	Customer's first name.
`lastName`	String required	Customer's last name.
`birthDate`	String ISO 8601 optional	Customer's date of birth.
`legalName`	String conditional	Customer's legal business name. Required for business customers.
`businessIdNumber`	String conditional	Customer's legal business number.Required for business customers.
`businessName`	String conditional	Customer's business name. Required for business customers.
`companyName`	String conditional	Customer's legal company name. Required for business customers.
`registrationName`	String conditional	Customer's legal registration name. Required for business customers.
`retailName`	String conditional	Customer's legal retail name. Required for business customers.
`billingAddress`	Object required	Contains all the information about the customer's billing address.
├── `apartment`	String optional	Customer's apartment number.
├── `streetNumber`	String optional	Customer's street number.
├── `streetName`	String optional	Customer's street name.
├── `city`	String optional	Customer's city.
├── `province`	String optional	Customer's province/state.
├── `country`	String optional	Customer's country.
└── `postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\"). Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
`shippingAddress`	Object optional	Contains all the information about the customer's shipping address.
├── `apartment`	String optional	Customer's apartment number.
├── `streetNumber`	String required	Customer's street number.
├── `streetName`	String required	Customer's street name.
├── `city`	String required	Customer's city.
├── `province`	String required	Customer's province/state.
├── `country`	String required	Customer's country.
└── `postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
`additionalInfo`	Object	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.

Response parameters

Option	Type	Description
`id`	String	Customer's ID.
`status`	String	Customer's status Possible values: `ACTIVE`, `INACTIVE`
`type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`email`	String	Customer's email address.
`phoneCode`	String	Customer's country calling code.
`phoneNumber`	String	Customer's phone number.
`firstName`	String	Customer's first name.
`lastName`	String	Customer's last name.
`birthDate`	Date ISO 8601	Customer's birthday date.
`businessIdNumber`	String	Customer's legal business number. For business customers.
`businessName`	String	Customer's legal business name city.
`companyName`	String	Customer's legal company name.
`registrationName`	String	Customer's legal registration name.
`retailName`	String	Customer's legal retail name.
`billingAddress`	Object	Contains all the information about the customer's billing address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String	Customer's province/state.
├── `country`	String	Customer's country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`shippingAddress`	Object	Contains all the information about the customer's shipping address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String	Customer's province/state.
├── `country`	String	Customer's country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.

","urlObject":{"path":["v1","customers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"951a9ff2-89f0-4aaf-a05f-8a7deb405195","name":"Create Customer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4163446778\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"legalName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"businessIdNumber\": \"996933\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/customers"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"890"},{"key":"x-trace-id","value":"cb4a683f405b84200168b19391c7e1d8"},{"key":"date","value":"Thu, 11 Sep 2025 12:51:56 GMT"},{"key":"x-envoy-upstream-service-time","value":"248"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4168888888\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"996933\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n },\n \"status\": \"ACTIVE\"\n}"}],"_postman_id":"1aa47f3a-5cc9-44cc-ab5d-1072df8cfc17"},{"name":"Update Customer","id":"1fd09c9f-bbe3-4890-b5e7-812bb254308b","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/customers/:customerId","description":"

Overview: Update Customer API

The Update Customer API allows a user to update, via the merchant’s website, their contact information—name, e-mail address, phone number, address—in their payment account on the Merchant Portal. The ‘request’ includes the information to be changed in the Customer’s payment account. The ‘response’ confirms whether or not the payment account was successfully updated and includes all the contact and payment information found on the Merchant Portal for the given payment account.

The Update Customer API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also give its helpdesk this access to support its Customers, or it can just give this access to a third party administrator to manage the Customer payment accounts, and so on.

Definitions:

To update a Customer's account, send a PATCH request to the /v1/customers/:customerId endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`customerId`	String required	Customer's unique identifier.

Request parameters

Option	Type	Description
`type`	String required	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`phoneCode`	String optional	Customer's country calling code.
`phoneNumber`	String optional	Customer's phone number.
`firstName`	String required	Customer's first name.
`lastName`	String required	Customer's last name.
`birthDate`	Date ISO 8601 optional	Customer's birthday date.
`legalName`	String optional	Customer's legal business name.
`businessIdNumber`	String optional	Customer's legal business number.
`businessName`	String optional	Customer's business name.
`companyName`	String optional	Customer's legal company name.
`registrationName`	String optional	Customer's legal registration name.
`retailName`	String optional	Customer's legal retail name.
`billingAddress`	Object required	Contains all the information about the customer's billing address.
├── `apartment`	String optional	Customer's apartment number.
├── `streetNumber`	String optional	Customer's street number.
├── `streetName`	String optional	Customer's street name.
├── `city`	String optional	Customer's city.
├── `province`	String optional	Customer's province/state.
├── `country`	String optional	Customer's country.
└── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`shippingAddress`	Object optional	Contains all the information about the customer's shipping address.
├── `apartment`	String optional	Customer's apartment number.
├── `streetNumber`	String required	Customer's street number.
├── `streetName`	String required	Customer's street name.
├── `city`	String required	Customer's city.
├── `province`	String required	Customer's province/state.
├── `country`	String required	Customer's country.
└── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	An object which contains the customer's additional info.
├── `field1 - field6`	String optional	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.

Response parameters

Option	Type	Description
`id`	String	Customer's ID.
`status`	String	Customer's status Possible values: `ACTIVE`, `INACTIVE`
`type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`email`	String	Customer's email address.
`phoneCode`	String	Customer's country calling code.
`phoneNumber`	String	Customer's phone number.
`firstName`	String	Customer's first name.
`lastName`	String	Customer's last name.
`birthDate`	Date ISO 8601	Customer's birthday date.
`legalName`	String	Customer's legal business name.
`businessIdNumber`	String	Customer's legal business number. Required for business customer.
`businessName`	String	Customer's business name.
`companyName`	String	Customer's legal company name.
`registrationName`	String	Customer's legal registration name.
`retailName`	String	Customer's legal retail name.
`billingAddress`	Object	Contains all the information about the customer's billing address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String ISO 3166-2	Customer's province/state.
├── `country`	String	Customer's country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`shippingAddress`	Object	Contains all the information about the customer's shipping address.
├── `apartment`	String	Customer's apartment number.
├── `streetNumber`	String	Customer's street number.
├── `streetName`	String	Customer's street name.
├── `city`	String	Customer's city.
├── `province`	String	Customer's province/state.
├── `country`	String	Customer's country.
└── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\"). Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.

","urlObject":{"path":["v1","customers",":customerId"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"6279c64f-07d5-4dda-a20e-054a705e4a57","name":"Update Customer","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222267\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/customers/:customerId","host":["{{base_url}}"],"path":["v1","customers",":customerId"],"variable":[{"key":"customerId","value":"{{customerId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"894"},{"key":"x-trace-id","value":"d2c2c826053627eef00b993f8594668e"},{"key":"date","value":"Thu, 11 Sep 2025 13:06:07 GMT"},{"key":"x-envoy-upstream-service-time","value":"249"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222267\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n },\n \"status\": \"ACTIVE\"\n}"}],"_postman_id":"1fd09c9f-bbe3-4890-b5e7-812bb254308b"},{"name":"Delete Customer","event":[{"listen":"prerequest","script":{"id":"ced15fe1-4059-471f-ba5e-a6b37a03ae8e","exec":["pm.variables.set('randomPhoneNumber', _.random(1000000000,9999999999))"],"type":"text/javascript","packages":{}}}],"id":"6dba1018-5050-4ec8-920e-8a73f77b921e","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/customers/:customerId","description":"

Overview: Delete Customer API

The Delete Customer API allows a user to delete, via the merchant’s website, their payment account on the Merchant Portal. The entire payment account is removed—Customer contact information, Customer payment methods and recurring payment schedules are all permanently removed from the Merchant Portal. The ‘request’ includes the Merchant ID and the Customer ID. The ‘response’ confirms that the given payment account has been successfully deleted from the Merchant Portal.

The Delete Customer API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also give its helpdesk this access to support its Customers, or it can just give this access to a third party administrator to manage the Customer payment accounts, and so on.

Definitions:

* A ‘Customer’ is a customer, donor, client, or other party that makes payment(s) to a merchant.
* In the case of PAYOUT, ‘Customer’ means ‘Payee’, such as a supplier or contractor, to which the merchant makes payments.
* A ‘Merchant’ is a retailer, charity, not-for-profit, funeral home, auto dealer, service provider, online site, or any other organization that accepts payments from a third party.

Path Variables

The URL string should contain the customerId variable.

To delete a Customer's account, send a DELETE request to the /v1/customers/:customerId endpoint with the Basic credentials included in the header.

Path parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`customerId`	String required	Customer identifier

The Manage Customers API is the collection of Create Customer API,Update Customer API and Delete Customer API which enable a Customer to create,update and delete via the merchant’s website, their contact information—name, e-mail address, phone number, address—in their payment account on the Merchant Portal.

\n","_postman_id":"b9c3fd36-2d66-4101-be0c-957cdea7095e"}],"id":"ffd97e90-7d0d-42cf-917d-6ab6be71eeba","description":"

Overview: Manage customers

This section outlines the capabilities provided to customers, allowing them to independently manage their payment accounts through the BNA Open API. Users have the autonomy to add or remove payment methods, and update their contact details. They also have the option to completely remove their payment account from the portal.

The APIs listed below deliver uniform responses from the Merchant Portal, which simplifies integration across multiple functionalities on the merchant’s website:

Retrieve all Customers
\n
Retrieve Customer by ID
\n
Create Customer
\n
Update Customer
\n
Delete Customer
\n
Add Payment Method to Customer
\n
Delete Payment Method
\n

\n","_postman_id":"ffd97e90-7d0d-42cf-917d-6ab6be71eeba"},{"name":"Payment Methods","item":[{"name":"Report","item":[{"name":"Retrieve Customer's Payment Method by Payment Method ID","id":"8895d776-bfa8-49d3-9ab2-ed377bceae12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/customers/:customerId/payment-methods/:methodId","description":"

Overview: Retrieve Customer’s Payment Method by Payment Method ID API

The Retrieve Customer’s Payment Method by Payment Method ID API allows a Customer to review, via the merchant’s website, a specific previously saved payment method. The ‘request’ includes both the Customer ID and the Payment Method ID. The ‘response’ confirms whether or not the payment method was successfully retrieved and returns the key attributes of the payment method (e.g., type, masked details, status, and whether it is set as the Customer’s default method).

The Retrieve Customer’s Payment Method API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also grant its help desk this access to support Customers with card-on-file questions, or allow a third-party administrator to validate stored payment instruments before initiating a transaction, and so on.

Definitions:

To retrieve a Customer by ID, send a GET request to the /v1/customers/:customerId/payment-methods/:methodId endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`customerId`	String required	Customer's unique identifier.
`methodId`	String required	Unique identifier of the Customer’s stored payment method to retrieve.

Response parameters

Option	Type	Description
E-Transfer Payment Method
`id`	String	Customer's payment method ID
`deliveryType`	String	Payment method type.Possible values:`EMAIL`,`SMS`, `NONE`
`name`	String	Customer's e-transfer Payment Method name.
`message`	String	Customer's message
`email`	String	Customer's Interac email if deliveryType is `EMAIL`
`phoneNumber`	String	Customer's Interac phone number if deliveryType is `SMS`
`phoneCode`	String	Customer's Interac phone code if deliveryType is `SMS`
`createdAt`	String	Payment method creation time
EFT Payment Method
`id`	String	Customer's payment method ID
`method`	String	Customer's payment method `EFT`
`bankName`	String	Customer's EFT Payment Method bank name.
`bankNumber`	String	Customer's EFT Payment Method bank number.
`accountNumber`	String	The last four numbers of the Customer's EFT Payment Method account number.
`transitNumber`	String	The last two numbers of the Customer's EFT Payment Method transit number.
`createdAt`	String	Payment method creation time
Card Payment Method
`id`	String	Customer's payment method ID
`method`	String	Customer's payment method `CARD`
`cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`
`cardHolder`	String	Customer's Card Payment Method card holder.
`cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
`cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
`expiryMonth`	String 2 digits	Customer's Card Payment Method expiration month.
`expiryYear`	String 2 digits	Customer's Card Payment Method expiration year.
`currency`	String	Payment method currency Possible values : `CAD` and `USD`
`createdAt`	String	Payment method creation time

","urlObject":{"path":["v1","customers",":customerId","payment-methods",":methodId"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"customerId"},{"type":"any","value":"{{methodId}}","key":"methodId"}]}},"response":[{"id":"b84b2b7c-b70e-40cd-82db-c9faa37d591b","name":"Retrieve Customer's Payment Method by Payment Method ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/customers/:customerId/payment-methods/:methodId","host":["{{base_url}}"],"path":["v1","customers",":customerId","payment-methods",":methodId"],"variable":[{"key":"customerId","value":"{{customerId}}"},{"key":"methodId","value":"{{methodId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"252"},{"key":"x-trace-id","value":"1151d027f757152fdb8fac38f8f7e9bc"},{"key":"date","value":"Thu, 11 Sep 2025 16:53:16 GMT"},{"key":"x-envoy-upstream-service-time","value":"66"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"e81e446c-03ba-40ac-8e80-3e1a3d6d91a7\",\n \"method\": \"CARD\",\n \"createdAt\": \"2025-08-30T19:31:14.409Z\",\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"32\",\n \"currency\": \"CAD\"\n}"}],"_postman_id":"8895d776-bfa8-49d3-9ab2-ed377bceae12"},{"name":"Retrieve Customer's Payment Methods List","id":"033c460d-4eb3-4af6-9a6d-c92e877418c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{accessKey}}","password":"{{secretKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/customers/:customerId/payment-methods","description":"

Overview: Retrieve Customer’s Payment Methods List API

The Retrieve Customer’s Payment Methods List API enables a Merchant to view, through their website, all previously stored payment methods associated with a specific Customer. A successful ‘response’ returns each payment method’s key attributes so the Merchant can present, audit, or manage those instruments.

The primary function of the Retrieve Customer’s Payment Methods List API is as outlined. Nonetheless, the Merchant retains full autonomy over how the API is applied and who may access it. For example, access can be extended to the Merchant’s help desk for customer support or granted to an external administrator responsible for maintaining card-on-file and bank account details on behalf of the Merchant.

Definitions:

To retrieve all Customers, send a GET request to the v1/customers/:customerId/payment-methods endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`customerId`	String required	Customer’s unique identifier.

Request Query

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`method`	String optional	Filter by payment method type. Possible values: `E_TRANSFER`, `EFT`, `CARD`

Response parameters

Option	Type	Description
`paymentMethods`	Array	List of all payment methods of a Customer
Card Payment Method
`id`	String	Customer's payment method ID
`method`	String	Customer's payment method `CARD`
`cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`
`cardHolder`	String	Customer's Card Payment Method card holder.
`cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
`cardNumber`	String	The last four numbers of the Customer's card number.
`expiryMonth`	String 2 digits	Customer's Card Payment Method expiration month.
`expiryYear`	String 2 digits	Customer's Card Payment Method expiration year.
`currency`	String	Payment method currency Possible values`CAD` and `USD`
`createdAt`	String	Payment method creation time
EFT Payment Method
`id`	String	Customer's payment method ID
`method`	String	Customer's payment method `EFT`
`bankName`	String	Customer's EFT Payment Method bank name.
`bankNumber`	String	Customer's EFT Payment Method bank number.
`accountNumber`	String	The last four numbers of the Customer's EFT Payment Method account number.
`transitNumber`	String	The last two numbers of the Customer's EFT Payment Method transit number.
`createdAt`	String	Payment method creation time
E-Transfer Payment Method
`id`	String	Customer's payment method ID
`method`	String	Customer's payment method `E_TRANSFER`
`deliveryType`	String	Payment method type.Possible values:`EMAIL`,`SMS`, `NONE`
`name`	String	Customer's e-transfer Payment Method name.
`message`	String	Customer's message
`email`	String	Customer's Interac email if deliveryType is `EMAIL`
`phoneNumber`	String	Customer's Interac phone number if deliveryType is `SMS`
`phoneCode`	String	Customer's Interac phone code if deliveryType is `SMS`
`createdAt`	String	Payment method creation time

","urlObject":{"path":["v1","customers",":customerId","payment-methods"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{customerId}}","key":"customerId"}]}},"response":[{"id":"f1f93de7-9e51-4cc2-a918-8033a011ce54","name":"Retrieve Customer's Payment Methods List","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/customers/:customerId/payment-methods","host":["{{base_url}}"],"path":["v1","customers",":customerId","payment-methods"],"variable":[{"key":"customerId","value":"{{customerId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1118"},{"key":"x-trace-id","value":"f7ec040948fd5a1863a9388b9c82f0b3"},{"key":"date","value":"Mon, 15 Sep 2025 18:38:25 GMT"},{"key":"x-envoy-upstream-service-time","value":"89"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethods\": [\n {\n \"id\": \"425030db-7455-4b89-aa5c-c119eff72cba\",\n \"method\": \"E_TRANSFER\",\n \"createdAt\": \"2025-09-11T19:08:50.467Z\",\n \"email\": \"nacipej999@bawsny.com\",\n \"name\": \"Angelica Sloan\",\n \"deliveryType\": \"EMAIL\"\n },\n {\n \"id\": \"2fc3632e-d197-475d-a382-265583f895c9\",\n \"method\": \"E_TRANSFER\",\n \"createdAt\": \"2025-09-11T19:14:24.565Z\",\n \"phoneNumber\": \"4160000000\",\n \"phoneCode\": \"+1\",\n \"name\": \"Angelica Sloan\",\n \"deliveryType\": \"SMS\"\n },\n {\n \"id\": \"e153f730-2b6e-4893-b75c-e919fb3b7f2d\",\n \"method\": \"EFT\",\n \"createdAt\": \"2025-09-11T19:33:55.747Z\",\n \"accountNumber\": \"*****062\",\n \"bankNumber\": \"003\",\n \"transitNumber\": \"***18\",\n \"bankName\": \"ROYAL BANK OF CANADA\"\n },\n {\n \"id\": \"4275a018-c245-40f9-b852-4322ffd30864\",\n \"method\": \"CARD\",\n \"createdAt\": \"2025-09-11T20:16:29.011Z\",\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"currency\": \"CAD\"\n },\n {\n \"id\": \"43b91d63-882b-47c6-abdd-070a91721f89\",\n \"method\": \"CARD\",\n \"createdAt\": \"2025-09-15T12:12:53.255Z\",\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"currency\": \"CAD\"\n }\n ]\n}"}],"_postman_id":"033c460d-4eb3-4af6-9a6d-c92e877418c2"}],"id":"286b7649-dc39-4c00-a15f-79eee55c4872","description":"

Report API — Customer Payment Methods Retrieval

The Report API exposes endpoints for retrieving a customer’s stored payment methods. You may either:

Fetch a specific payment method by providing both customerId and methodId, or
\n
List all payment methods for a customer by providing only the customerId.
\n

These endpoints support reporting and payment-method management workflows by allowing authorized external systems to query up-to-date payment-method information.

\n","_postman_id":"286b7649-dc39-4c00-a15f-79eee55c4872"},{"name":"Manage Payment Methods","item":[{"name":"Add E-Transfer","id":"dd56b278-dfdc-48f5-830f-e0d73844ec25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/customers/:customerId/e-transfer","description":"

Overview: Add E-Transfer Payment Method API only for PAYOUT transactions

The Add E-Transfer API allows a Customer to add, via the merchant’s website, an E-Transfer payment method to their payment account on the Merchant Portal. The ‘request’ includes the Customer ID, and Customer’s email or phone number. The ‘response’ confirms whether or not the E-Transfer payment method was successfully added and includes Payment ID,Customer's name and email/phone number found on the Merchant Portal for the given payment account.

An e-transfer (short for electronic transfer) is a way to send or receive money electronically between bank accounts, usually through online or mobile banking.

Interac e-Transfer is a common method where money is transferred via email or phone number. The sender doesn't need the recipient's banking info—just their email or phone number. The recipient gets a message with a link to deposit the funds into their account.

The Add E-Transfer API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also give its helpdesk this access to support its Customers, or it can just give this access to a third party administrator to manage the Customer payment accounts, and so on.

Definitions:

To add e-Transfer payment method, send a POST request to the /v1/customers/:customerId/e-transfer endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`customerId`	String required	Customer's ID

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`email`	String conditional	Recipient’s email address. Required if `deliveryType` is set to `EMAIL`.
`phoneNumber`	String conditional	Recipient’s phone number. Required if `deliveryType` is set to `SMS`.
`phoneCode`	String conditional	Recipient’s country calling code. Required if `deliveryType` is set to `SMS`.
`name`	String required	Full name of the recipient, including both first and last names.
`deliveryType`	String required	Method used to deliver the transfer notification. Possible values: `EMAIL`, `SMS`, or `NONE`.

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`id`	String	E-transfer payment method's ID
`method`	String	E-transfer payment method `E_TRANSFER`
`email`	String	Recipient’s email address if `deliveryType` is set to `EMAIL`.
`name`	String	Full name of the recipient, including both first and last names.
`deliveryType`	String	Method used to deliver the transfer notification. Possible values: `EMAIL`, `SMS`, or `NONE`.
`createdAt`	String	E-transfer creation time

","urlObject":{"path":["v1","customers",":customerId","e-transfer"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":null,"value":""}],"variable":[{"type":"any","value":"{{customerId}}","key":"customerId"}]}},"response":[{"id":"6756c28b-2a8e-41ca-bf6a-9a595fcaeed0","name":"Add E-Transfer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"nacipej999@bawsny.com\",\n \"name\": \"Angelica Sloan\",\n \"deliveryType\": \"email\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/customers/:customerId/e-transfer","host":["{{base_url}}"],"path":["v1","customers",":customerId","e-transfer"],"query":[{"key":null,"value":"","disabled":true}],"variable":[{"key":"customerId","value":"{{customerId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"185"},{"key":"x-trace-id","value":"23cc1a8daaf7f398eac9e9e27e6fb07b"},{"key":"date","value":"Thu, 11 Sep 2025 19:08:50 GMT"},{"key":"x-envoy-upstream-service-time","value":"240"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"425030db-7455-4b89-aa5c-c119eff72cba\",\n \"method\": \"E_TRANSFER\",\n \"createdAt\": \"2025-09-11T19:08:50.467Z\",\n \"email\": \"nacipej999@bawsny.com\",\n \"name\": \"Angelica Sloan\",\n \"deliveryType\": \"EMAIL\"\n}"}],"_postman_id":"dd56b278-dfdc-48f5-830f-e0d73844ec25"},{"name":"Add Bank Transfer (EFT)","id":"5d59bbe8-9873-4aa5-8665-db9c34830789","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bankNumber\": \"003\",\n \"transitNumber\": \"118\",\n \"accountNumber\": \"47676062\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/customers/:customerId/eft","description":"

Overview: Add Bank Transfer (EFT)

The Add Bank Transfer (EFT) API allows a Customer to add, via the merchant’s website, a Bank Transfer (EFT) — to their payment account on the Merchant Portal. The ‘request’ includes the Customer ID, and Bank Account information. The ‘response’ confirms whether or not the Bank Transfer (EFT) was successfully added and includes all the payment information found on the Merchant Portal for the given payment account.

The Add Bank Transfer (EFT) API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also give its help desk this access to support its Customers, or it can just give this access to a third party administrator to manage the Customer payment accounts, and so on.

Definitions:

To add EFT payment method, send a POST request to the /v1/customers/:customerId/eft endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`customerId`	String required	Customer identifier

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`bankNumber`	String required	Customer's Bank Number
`transitNumber`	String 3 digits required	Customer's Bank Transit Number
`accountNumber`	String required	Customer's Bank Account Number

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`id`	String	Payment Method ID
`method`	String	Payment Method `EFT`
`accountNumber`	String	Customer's Bank Account Number
`bankNumber`	String	Customer's Bank Number
`transitNumber`	String 3 digits	Customer's Bank Transit Number
`createdAt`	String	EFT Payment Method creation time

","urlObject":{"path":["v1","customers",":customerId","eft"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{customerId}}","key":"customerId"}]}},"response":[{"id":"d8b30326-027a-4ee8-a7dd-f1f46a7ca1b4","name":"Add Bank Transfer (EFT)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bankNumber\": \"003\",\n \"transitNumber\": \"118\",\n \"accountNumber\": \"47676062\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/customers/:customerId/eft","host":["{{base_url}}"],"path":["v1","customers",":customerId","eft"],"variable":[{"key":"customerId","value":"{{customerId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"203"},{"key":"x-trace-id","value":"516bdf6c0da2d103eba9d8bc1b24f70c"},{"key":"date","value":"Thu, 11 Sep 2025 19:33:55 GMT"},{"key":"x-envoy-upstream-service-time","value":"269"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"e153f730-2b6e-4893-b75c-e919fb3b7f2d\",\n \"method\": \"EFT\",\n \"createdAt\": \"2025-09-11T19:33:55.747Z\",\n \"accountNumber\": \"*****062\",\n \"bankNumber\": \"003\",\n \"transitNumber\": \"***18\",\n \"bankName\": \"ROYAL BANK OF CANADA\"\n}"}],"_postman_id":"5d59bbe8-9873-4aa5-8665-db9c34830789"},{"name":"Add Payment Card","event":[{"listen":"prerequest","script":{"id":"5aa49be2-34ea-4304-9186-7341a59bc9b9","exec":["pm.variables.set('randomCardId', _.random(100, 999))","pm.variables.set('randomMonth', _.random(1, 12))","pm.variables.set('randomYear', _.random(2025, 2035))"],"type":"text/javascript","packages":{}}}],"id":"6e0b0b74-2d14-4f61-956d-3f76414c4d30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"4441111111111111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardIdNumber\": \"098\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"currency\": \"CAD\",\n \"secure\": {\n \"token\": \"AgAAAAAABk4DWZ4C28yUQAAAAAA=\",\n \"eci\": \"07\",\n \"dsTransId\": \"d4a99c10-931a-43c5-a99c-10931ac3c500\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/customers/:customerId/card","description":"

Overview: Add Credit,Debit Or Prepaid Card API

The Add Credit,Debit Or Prepaid Card API allows a Customer to add, via the merchant’s website, a Credit,Debit Or Prepaid Card — to their payment account on the Merchant Portal. The ‘request’ includes the Customer ID, Credit,Debit or Prepaid Card information,Currency,token,eci and dsTransId. The ‘response’ confirms whether or not the Payment Card was successfully added.

The Add Credit,Debit Or Prepaid Card API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use. For example, the Merchant can also give its help desk this access to support its Customers, or it can just give this access to a third party administrator to manage the Customer payment accounts, and so on.

Definitions:

To add CARD payment method, send a POST request to the /v1/customers/:customerId/card endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`customerId`	String required	Customer identifier

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`cardNumber`	String required	Customer's Card number
`cardType`	String required	Card type Possible values: `CREDIT`, `DEBIT`
`cardHolder`	String required	Card holder name
`cardIdNumber`	String 3-4 digits required	Card CVV or CVC number
`expiryMonth`	String 2 digits required	Card expiration month.
`expiryYear`	String 2 digits required	Card expiration year.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that indicates the currency associated with the payment card.Possible values: `CAD`, `USD`.
`secure`	Object conditional	An object containing the 3DS credentials from the Merchant's 3DS provider.Required if 3DS configurations of a Merchant are enabled
`token`	String required	A Base64 encoded string
`eci`	String required	The value provided by the Merchant's 3DS provider
`dsTransId`	String required	The value provided by the Merchant's 3DS provider

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`createdAt`	String	Payment Method creation time
`id`	String	Payment Method ID
`method`	String	Payment Method `CARD`
`cardNumber`	String	Customer's Card number
`cardHolder`	String	Card holder name
`cardType`	String	Card type Possible values: `CREDIT`, `DEBIT`
`cardBrand`	String	Customer's card brand Possible values: `VISA`, `MASTERCARD`,`AMEX`
`expiryMonth`	String 2 digits	Card expiration month.
`expiryYear`	String 2 digits	Card expiration year.
`currency`	String ISO 4217	The ISO currency code. A three-letter alphabetic code that indicates the currency associated with the payment card. Possible values: `CAD`, `USD`.

","urlObject":{"path":["v1","customers",":customerId","card"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{customerId}}","key":"customerId"}]}},"response":[{"id":"76c153fc-627c-49e9-9c6a-fd3dbd1cc3b5","name":"Add Payment Card","originalRequest":{"method":"POST","header":[{"key":"customerID","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"4441111111111111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardIdNumber\": \"098\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"currency\": \"CAD\",\n \"secure\": {\n \"token\": \"AgAAAAAABk4DWZ4C28yUQAAAAAA=\",\n \"eci\": \"07\",\n \"dsTransId\": \"d4a99c10-931a-43c5-a99c-10931ac3c500\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/customers/:customerId/card","host":["{{base_url}}"],"path":["v1","customers",":customerId","card"],"variable":[{"key":"customerId","value":"{{customerId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"255"},{"key":"x-trace-id","value":"19a43d98d97f713149d7b1560d5775b2"},{"key":"date","value":"Mon, 15 Sep 2025 12:12:53 GMT"},{"key":"x-envoy-upstream-service-time","value":"2707"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"43b91d63-882b-47c6-abdd-070a91721f89\",\n \"method\": \"CARD\",\n \"createdAt\": \"2025-09-15T12:12:53.255Z\",\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"currency\": \"CAD\"\n}"}],"_postman_id":"6e0b0b74-2d14-4f61-956d-3f76414c4d30"},{"name":"Delete Payment Method","event":[{"listen":"prerequest","script":{"id":"cf0d43e7-a8f8-4692-a159-0b2b5124a04f","exec":["pm.variables.set('randomCardId', _.random(100, 999))","pm.variables.set('randomMonth', _.random(1, 12))","pm.variables.set('randomYear', _.random(2025, 2035))"],"type":"text/javascript","packages":{}}}],"id":"d1e06ecf-8eb8-451b-aa26-1c8a09637409","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"DELETE","header":[],"url":"{{base_url}}/v1/customers/:customerId/payment-methods/:methodId","description":"

Overview: Delete Payment Method API

The Delete Payment Method API allows a Merchant, via their website, to remove a specific stored payment instrument from a Customer’s profile. A successful ‘response’ confirms the payment method was deleted and can no longer be used for future transactions.

The primary function of the Delete Payment Method API is as outlined. Nonetheless, the Merchant retains full autonomy over how the API is applied and who may access it. For example, access can be granted to the Merchant’s help desk to support Customer requests, or to an external administrator responsible for maintaining card-on-file and bank-account details on behalf of the Merchant.

Definitions:

* A ‘Customer’ is a customer, donor, client, or other party that makes payment(s) to a merchant.
* A ‘Merchant’ is a retailer, charity, not-for-profit, funeral home, auto dealer, service provider, online site, or any other organization that accepts payments from a third party.
** A ‘Payment Method’ is a stored instrument used for payment or payout (e.g., card-on-file, bank account, or e-transfer profile).

To delete Card payment method, send a DELETE request to the v1/customers/:customerId/payment-methods/:methodId endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	Type	Description
`customerId`	String required	Customer identifier
`methodId`	String required	Unique identifier of the Customer’s stored payment method to retrieve.

The Manage Payment Methods API is the collection of Add Payment Methods API and Delete Payment Methods API which enable user to add and delete payment methods of a customer (E-Transfer,Bank Transfer,Payment Card) via the merchant’s website

\n","_postman_id":"1603b974-cbd4-469b-b60c-2dff6a04ab8e"}],"id":"2e89db3c-3463-4538-8274-a9f83b846024","description":"

Overview: Payment Method Management

Through the merchant's website, customers have the ability to add or remove payment methods associated with their accounts on the Merchant Portal.

\n","_postman_id":"2e89db3c-3463-4538-8274-a9f83b846024"},{"name":"Transactions","item":[{"name":"Report","item":[{"name":"Retrieve Transactions List","id":"fe0764e3-f436-4f86-adfa-6a2e7850c883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/transaction?customerId={{customerId}}&limit=3","description":"

Overview: Retrieve Transactions List API

The Retrieve Transactions List API enables a Merchant to inspect, through their website, all customer transaction list on the Merchant Portal. A successful 'response' will provide all transaction list for each Customer with full customer details and transaction details found on the portal.

The primary function of the Retrieve Transactions List API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

Definitions:
* A ‘Customer’ refers to any individual or entity, such as a customer, donor, client, or similar, that makes payments to a merchant.
* For Payout transactions, the term ‘Customer’ refers to a ‘Payee’ like a supplier or contractor, to whom the merchant disburses payments.
* A ‘Merchant’ includes any business or organization, such as retailers, charities, not-for-profits, funeral homes, auto dealers, service providers, online sites, or any entity that receives payments from third parties.

To retrieve all Transactions, send a GET request to the v1/transactions endpoint with the Basic credentials included in the header.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	String optional	Filter by transaction ID
`customerId`	String optional	Filter by Customer ID
`referenceUUID`	String optional	Filter by Transaction reference ID
`subscriptionId`	String optional	Filter by Subscription ID
`dateFrom`	Date optional	Filter by Start date from
`dateTo`	Date optional	Filter by End date to
`action`	String optional	Filter by transaction action Possible values: `SALE` , `PAYOUT` , `RESERVE` , `COMPLETE` , `REFUND` , `CANCEL` , `VOID` , `VERIFICATION`
`status`	String optional	Filter by transaction status_Possible values:_ `APPROVED` , `DECLINED` , `PENDING` , `BATCHED` , `EXPIRED` , `UNDERPAID` , `OVERPAID` , `CANCELED` , `ERROR`
`paymentMethod`	String optional	Filter by payment method.Possible values: `CARD` , `E_TRANSFER` , `EFT`, `CHEQUE` , `CASH` , `APPLE PAY` , `GOOGLE PAY`.
`currency`	String optional	Filter by currency Possible values: `CAD` , `USD`
`page`	Integer optional	Page number to retrieve.
`limit`	Integer optional	Number of records per page.

Response parameters

Option	Type	Description
`data`	Array	An array of objects.
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├──`businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action.Possible values: `SALE` , `PAYOUT` , `RESERVE` , `COMPLETE` , `REFUND` , `CANCEL` , `VOID` , `VERIFICATION`.
`status`	String	Filter by transaction status.Possible values: `APPROVED` , `DECLINED` , `PENDING` , `BATCHED` , `EXPIRED` , `UNDERPAID` , `OVERPAID` , `CANCELED` , `ERROR`.
`paymentMethod`	String	Filter by payment method.Possible values: `CARD` , `E_TRANSFER` , `EFT`, `CHEQUE` , `CASH` , `APPLE PAY` , `GOOGLE PAY`.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	An object which contains information about the payment details.
Cheque Payment Method
├── `chequeNumber`	String	Customer's cheque number.
E-Transfer Payment Method
├── `deliveryType`	String	Payment method type_Possible values:_ `EMAIL`,`PHONE`, `NONE`
├── `name`	String	Customer's e-transfer Payment Method name.
├── `message`	String	Customer's message
└── `email`	String	Customer's Interac email if deliveryType is email
├── `name`	String	Customer's e-transfer Payment Method name.
├── `message`	String	Customer's message
├── `phone`	String	Customer's Interac phone.
└── `phoneCode`	String	Customer's Interac phone code.
EFT Payment Method
├── `bankName`	String	Customer's EFT Payment Method bank name.
├── `bankNumber`	String	Customer's EFT Payment Method bank number.
├── `accountNumber`	String	The last four numbers of the Customer's EFT Payment Method account number.
└── `transitNumber`	String	The last two numbers of the Customer's EFT Payment Method transit number.
Card Payment Method
├── `cardType`	String	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Customer's Card Payment Method expiration month.
└── `expiryYear`	String 2 digits	Customer's Card Payment Method expiration year.
`expiryMonth`	String 2 digits	Card expiration month.
`expiryYear`	String 2 digits	Card expiration month.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.
`pages`	Object	Contains all the pagination details.
├── `totalRows`	Number	The total count of rows in the list.
├── `pageTotal`	Number	The total number of pages.
├── `pageNum`	Number	The current page number.
└── `pageSize`	Number	The number of rows per page.

","urlObject":{"path":["v1","transaction"],"host":["{{base_url}}"],"query":[{"key":"customerId","value":"{{customerId}}"},{"key":"limit","value":"3"}],"variable":[]}},"response":[{"id":"0bb99df9-547f-43e4-9712-06c6b0f24ad4","name":"Retrieve Transactions List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage-api-service.bnasmartpayment.com/v1/transaction?customerId={{customerId}}&limit=3","protocol":"https","host":["stage-api-service","bnasmartpayment","com"],"path":["v1","transaction"],"query":[{"key":"customerId","value":"{{customerId}}"},{"key":"limit","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"4828"},{"key":"x-trace-id","value":"a460856dc6361b9db1a470328caa16dd"},{"key":"date","value":"Fri, 12 Sep 2025 19:20:45 GMT"},{"key":"x-envoy-upstream-service-time","value":"89"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5b66fb14d28d30c216ab\",\n \"referenceUUID\": \"5b66fb14d28d30c216ab\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777776\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-12T19:15:02.583Z\",\n \"paymentMethod\": \"EFT\",\n \"status\": \"PENDING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 2.66,\n \"subtotal\": 22,\n \"total\": 24.66,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"bankName\": \"ROYAL BANK OF CANADA\",\n \"accountNumber\": \"*****062\",\n \"transitNumber\": \"***18\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 22,\n \"description\": \"222\",\n \"price\": 22,\n \"quantity\": 1,\n \"sku\": \"222\"\n }\n ],\n \"metadata\": {}\n },\n {\n \"id\": \"add422190a9a0ab32f72\",\n \"referenceUUID\": \"add422190a9a0ab32f72\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777776\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-12T19:14:35.291Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 6.44,\n \"subtotal\": 11,\n \"total\": 17.44,\n \"amount\": 17.44,\n \"balance\": 11,\n \"paymentDetails\": {\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 11,\n \"description\": \"111\",\n \"price\": 11,\n \"quantity\": 1,\n \"sku\": \"111\"\n }\n ],\n \"authCode\": \"TAS657\",\n \"metadata\": {}\n },\n {\n \"id\": \"402a1f95eb28b37e54b6\",\n \"referenceUUID\": \"402a1f95eb28b37e54b6\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777776\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-12T11:46:44.543Z\",\n \"paymentMethod\": \"CHEQUE\",\n \"status\": \"PENDING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 4.14,\n \"subtotal\": 7,\n \"total\": 11.14,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n }\n ],\n \"pages\": {\n \"totalRows\": 1401,\n \"pageTotal\": 467,\n \"pageNum\": 1,\n \"pageSize\": 3\n }\n}"}],"_postman_id":"fe0764e3-f436-4f86-adfa-6a2e7850c883"},{"name":"Retrieve Transaction by ID","id":"15de240a-40cb-4240-856d-bc5b6838cc1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/transaction/:transactionId","description":"

Overview: Retrieve Transaction by ID API

The Retrieve Transaction by ID API enables a Merchant to get the details of a specific transaction using its unique ID.

These details might include:

The amount of money paid

The status of the payment (APPROVED , DECLINED , PENDING , BATCHED , EXPIRED , UNDERPAID , OVERPAID , CANCELED , ERROR.).
The action (SALE , PAYOUT , RESERVE , COMPLETE , REFUND , CANCEL , VOID , VERIFICATION)

The date and time of the transaction

The payment method.

The primary function of the Retrieve Transaction by ID API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

Definitions:

* A ‘Customer’ refers to any individual or entity, such as a customer, donor, client, or similar, that makes payments to a merchant.
* For Payout transactions, the term ‘Customer’ refers to a ‘Payee’ like a supplier or contractor, to whom the merchant disburses payments.
* A ‘Merchant’ includes any business or organization, such as retailers, charities, not-for-profits, funeral homes, auto dealers, service providers, online sites, or any entity that receives payments from third parties.

To retrieve a Transaction by ID, send a GET request to the v1/transactions/:transactionId endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`transactionId`	String required	Transaction ID.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values :`BUSINESS` or `PERSONAL`.
├── `email`	String	A string which contains the Customer's email.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. Required for business customer.
├── `businessIdNumber`	String	Customer's legal business number. Required for business customer.
├── `businessName`	String	Customer's business name. Required for business customer.
├── `companyName`	String	Customer's legal company name. Required for business customer.
├── `registrationName`	String	Customer's legal registration name. Required for business customer.
└── `retailName`	String	Customer's legal retail name. Required for business customer.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action.Possible values: `SALE` , `PAYOUT` , `RESERVE` , `COMPLETE` , `REFUND` , `CANCEL` , `VOID` , `VERIFICATION`.
`status`	String	Filter by transaction status.Possible values: `APPROVED` , `DECLINED` , `PENDING` , `BATCHED` , `EXPIRED` , `UNDERPAID` , `OVERPAID` , `CANCELED` , `ERROR`.
`paymentMethod`	String	Filter by payment method.Possible values: `CARD` , `E_TRANSFER` , `EFT`, `CHEQUE` , `CASH` , `APPLE PAY` , `GOOGLE PAY`.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	An object which contains information about the payment details.
E-TRANSFER PAYMENT METHOD
├── `id`	String	Customer's e-transfer payment id by email.
├── `type`	String	Payment method type.
├── `name`	String	Customer's e-transfer Payment Method name.
└── `email`	String	Customer's Interac email.
├── `id`	String	Customer's e-transfer payment id by phone.
├── `type`	String	Payment method type.
├── `name`	String	Customer's e-transfer Payment Method name.
├── `phone`	String	Customer's Interac phone.
└── `phoneCode`	String	Customer's Interac phone code.
EFT PAYMENT METHOD
├── `id`	String	Customer's EFT Payment Method ID.
├── `bankName`	String	Customer's EFT Payment Method bank name.
├── `bankNumber`	String	Customer's EFT Payment Method bank number.
├── `accountNumber`	String	The last three numbers of the Customer's EFT Payment Method account number.
└── `transitNumber`	String	The last two numbers of the Customer's EFT Payment Method transit number.
CARD PAYMENT METHOD
├── `id`	String	Customer's Card Payment Method ID.
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`.
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`.
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String	2 digits Card expiration month.
└── `expiryYear`	String	2 digits Card expiration month.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
├── `contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction",":transactionId"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{transactionId}}","key":"transactionId"}]}},"response":[{"id":"528139a7-2588-4133-a632-effe882e394a","name":"Retrieve Transaction by ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/transaction/:transactionId","host":["{{base_url}}"],"path":["v1","transaction",":transactionId"],"variable":[{"key":"transactionId","value":"{{transactionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1851"},{"key":"x-trace-id","value":"b6bd9e523eedf3d51144e88fc263581a"},{"key":"date","value":"Mon, 15 Sep 2025 18:32:19 GMT"},{"key":"x-envoy-upstream-service-time","value":"58"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"e4fbfda96de93d6db2a2\",\n \"referenceUUID\": \"e4fbfda96de93d6db2a2\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T16:32:43.655Z\",\n \"paymentMethod\": \"EFT\",\n \"status\": \"PENDING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 2.21,\n \"subtotal\": 7,\n \"total\": 9.21,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"bankName\": \"ROYAL BANK OF CANADA\",\n \"accountNumber\": \"*****555\",\n \"transitNumber\": \"***18\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"15de240a-40cb-4240-856d-bc5b6838cc1b"},{"name":"Retrieve Transaction Status","id":"0817cdec-3fb7-42bf-9748-1376a93be99c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/transaction/:transactionId/status","description":"

Overview: Retrieve Transaction Status API

The Retrieve Transaction Status API enables a Merchant to get the status of a specific transaction using its unique ID.

Transaction possible values could be: APPROVED , DECLINED , PENDING , BATCHED , EXPIRED , UNDERPAID , OVERPAID , CANCELED , ERROR.

The primary function of the Retrieve Transaction Status API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

Definitions:

To retrieve a Transaction Status, send a GET request to the v1/transaction/:transactionId/status endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`transactionId`	String required	Transaction ID.

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`status`	String	Transaction status. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.

The Report API allows merchants to access transaction details through three key endpoints:

1. **Retrieve Transaction by ID.**This endpoint retrieves the full details of a specific transaction by its unique transactionId. It provides information such as transaction amount, status, timestamps, customer details, and payment method.

2. **Retrieve Transactions List.**Returns a paginated list of transactions based on optional filters such as date range and status. Helps in reporting, reconciliation, and transaction history analysis.

3. **Retrieve Transaction Status.**Provides the current status of a transaction (e.g., PENDING, COMPLETED, FAILED, REFUNDED) using the transaction ID.It's useful for systems that need to poll for transaction updates or confirm final payment outcomes.

\n","_postman_id":"eaa8bcef-7f88-4ff7-b70f-c45a309f9470"},{"name":"Payment Card","item":[{"name":"Verification","id":"393f388b-c101-48d4-a085-c4891ed66315","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"currency\": \"CAD\",\n \"paymentDetails\": {\n \"cardType\": \"CREDIT\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardNumber\": \"4441111111111111\",\n \"expiryMonth\": \"09\",\n \"expiryYear\": \"28\",\n \"cardIdNumber\": \"099\"\n },\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/verify","description":"

To verify a Payment Card, send a POST request to the /v1/transaction/card/verify endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `id`	String optional	Customer's Card Payment Method ID.
├── `cardNumber`	String conditional	The last four digits of the Customer's Card Payment Method card number. Required if there is no payment ID provided.
├── `cardType`	String conditional	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`. Required if there is no payment ID provided.
├── `cardHolder`	String conditional	Customer's Card Payment Method cardholder name. Required if there is no payment ID provided.
├── `cardIdNumber`	String 3-4 digits conditional	The credit card security code. Required if there is no payment ID provided.
├── `expiryMonth`	String 2 digits conditional	Credit card expiration month in MM format. Required if there is no payment ID provided.
└── `expiryYear`	String 2 digits conditional	Credit card expiration year in YY format. Required if there is no payment ID provided.
├── `secure`	Object optional	Contains the 3DS credentials from the Merchant's 3DS provider.
├── `token`	String required	A Base64 encoded string. The value provided by the Merchant's 3DS provider.
├── `eci`	String required	The value provided by the Merchant's 3DS provider.
└── `dsTransId`	String required	The value provided by the Merchant's 3DS provider.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	An object which contains all the information about the Customer's address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name.For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action. Possible values: `VERIFICATION`.
`status`	String	Filter by transaction status. Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method. Possible values `CARD`
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	Date	Contract start date
└── `contractExpireDate` <	Date	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity. e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10
`authCode`	String	(Authorization Code) is a unique alphanumeric value generated by the card-issuing bank or payment processor when a credit card transaction is successfully authorized.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction","card","verify"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"14704b8a-701a-4973-8704-a4b733f5cc8c","name":"Verification","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"currency\": \"CAD\",\n \"paymentDetails\": {\n \"cardType\": \"CREDIT\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardNumber\": \"4441111111111111\",\n \"expiryMonth\": \"09\",\n \"expiryYear\": \"28\",\n \"cardIdNumber\": \"099\"\n },\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/verify"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1411"},{"key":"x-trace-id","value":"4bd5bfdb12660f774468e7ce69a4d2cf"},{"key":"date","value":"Mon, 15 Sep 2025 18:27:22 GMT"},{"key":"x-envoy-upstream-service-time","value":"1348"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"500492e361b85a868216\",\n \"referenceUUID\": \"500492e361b85a868216\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T18:27:21.344Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"APPROVED\",\n \"action\": \"VERIFICATION\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 0,\n \"total\": 0,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"cardNumber\": \"************5439\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"09\",\n \"expiryYear\": \"28\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": null,\n \"items\": [],\n \"authCode\": \"PREATH\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456\n }\n}"}],"_postman_id":"393f388b-c101-48d4-a085-c4891ed66315"},{"name":"Sale","id":"8834b194-eade-4ff3-b0ad-e67b6e20d4ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": \"7\",\n \"currency\": \"CAD\",\n \"paymentDetails\": {\n \"cardNumber\": \"4441111111111111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardIdNumber\": \"009\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/sale","description":"

To create a Credit,Debit or Prepaid Card Sale transaction, send a POST request to the /v1/transaction/card/sale endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `id`	String optional	Customer's Card Payment Method ID.
├── `cardNumber`	String conditional	The Customer's card number. Required if there is no payment ID provided.
├── `cardType`	String conditional	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`. Required if there is no payment ID provided.
├── `cardHolder`	String conditional	Customer's Card Payment Method cardholder name. Required if there is no payment ID provided.
├── `cardIdNumber`	String 3-4 digits conditional	The credit card security code. Required if there is no payment ID provided.
├── `expiryMonth`	String 2 digits conditional	Credit card expiration month in MM format. Required if there is no payment ID provided.
└── `expiryYear`	String 2 digits conditional	Credit card expiration year in YY format. Required if there is no payment ID provided.
├── `secure`	Object optional	Contains the 3DS credentials from the Merchant's 3DS provider.
├──── `token`	String required	A Base64 encoded string. The value provided by the Merchant's 3DS provider.
├──── `eci`	String required	The value provided by the Merchant's 3DS provider.
└──── `dsTransId`	String required	The value provided by the Merchant's 3DS provider.
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol.e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity.e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers
├── `businessName`	String	Customer's business name. For business customers
├── `companyName`	String	Customer's legal company name. For business customers
├── `registrationName`	String	Customer's legal registration name. For business customers
├── `retailName`	String	Customer's legal retail name. For business customers
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action. Possible values: `SALE`.
`status`	String	Filter by transaction status Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method.Possible values: `CARD`, `APPLE PAY`, `GOOGLE PAY`
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is `true`.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is `true`.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is `true`.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	Date	Contract start date
└── `contractExpireDate`	Date	Contract expiration date
`transactionComment`	Date	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol. e.g. 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity. e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10, it could be positive and negative number.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction","card","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1255d822-e1ca-4c4c-999a-0aa98d81054a","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": \"7\",\n \"currency\": \"CAD\",\n \"paymentDetails\": {\n \"cardNumber\": \"4441111111111111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardIdNumber\": \"009\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/sale"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1890"},{"key":"x-trace-id","value":"566d2773194ec9d1edfd072c08c73209"},{"key":"date","value":"Fri, 12 Sep 2025 19:31:52 GMT"},{"key":"x-envoy-upstream-service-time","value":"1688"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1a6fdb65556f657bb325\",\n \"referenceUUID\": \"1a6fdb65556f657bb325\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-12T19:31:51.275Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": {\n \"cardNumber\": \"************5439\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"authCode\": \"TAS931\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"8834b194-eade-4ff3-b0ad-e67b6e20d4ba"},{"name":"Refund","id":"1d8c69c9-bd7f-40a0-b321-cc00b9740527","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"6fea058a7c35175ca7ef\",\n \"subtotal\": 7,\n \"transactionComment\": \"Requested by Customer\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/refund","description":"

To Refund a Credit,Debit or Prepaid Card Sale transaction, send a POST request to the /v1/transaction/card/refund endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subtotal`	Number Float to two decimal places required	The amount to be refunded. This can be a partial or full amount of the original transaction.
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being refunded.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	An object which contains all the information about the Customer's address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action.Possible values: `REFUND`.
`status`	String	Filter by transaction status.Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method.Possible values: `CARD`, `APPLE PAY`, `GOOGLE PAY`
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `id`	String	Customer's Card Payment Method ID.
├── `cardType`	String	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
├── `invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	Date	Contract start date
└── `contractExpireDate` _	Date	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction","card","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"65cea79d-a933-42b4-b1bd-158bf660a1d9","name":"Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"6fea058a7c35175ca7ef\",\n \"subtotal\": 7,\n \"transactionComment\": \"Requested by Customer\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/refund"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1666"},{"key":"x-trace-id","value":"c57ee905b71f3077789f2d724925108f"},{"key":"date","value":"Mon, 15 Sep 2025 18:28:53 GMT"},{"key":"x-envoy-upstream-service-time","value":"1629"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"08a1cc6ebf2279252a48\",\n \"referenceUUID\": \"6fea058a7c35175ca7ef\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T18:28:51.720Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"APPROVED\",\n \"action\": \"REFUND\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": {\n \"cardNumber\": \"************5439\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"authCode\": \"TAS924\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"1d8c69c9-bd7f-40a0-b321-cc00b9740527"},{"name":"Void","id":"6125e57b-e696-483c-a5e3-f255b1ccd75e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"6fea058a7c35175ca7ef\",\n \"transactionComment\": \"Requested by Customer\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/void","description":"

To void a Credit,Debit or Prepaid Card transaction, send a POST request to the /v1/transaction/card/void endpoint with the Basic credentials included in the header.

This section details the parameters required to void transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being voided.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action.Possible values: `VOID`.
`status`	String	Filter by transaction status.Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method.Possible values: `CARD`, `APPLE PAY`, `GOOGLE PAY`
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be voided.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `id`	String	Customer's Card Payment Method ID.
├── `cardType`	String	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	Date	Contract start date
└── `contractExpireDate`	Date	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity.e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction","card","void"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"eecb6602-e658-47e7-9778-c98740f37b7e","name":"Void","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"6fea058a7c35175ca7ef\",\n \"transactionComment\": \"Requested by Customer\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/void"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1668"},{"key":"x-trace-id","value":"52a242099a246b5b2cae4803ad8e37bc"},{"key":"date","value":"Mon, 15 Sep 2025 18:29:40 GMT"},{"key":"x-envoy-upstream-service-time","value":"1250"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"15bb1b7c58a398623c60\",\n \"referenceUUID\": \"6fea058a7c35175ca7ef\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T18:29:38.979Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"DECLINED\",\n \"action\": \"VOID\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 0,\n \"total\": 0,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"cardNumber\": \"************5439\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"declineReason\": \"D0004\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"6125e57b-e696-483c-a5e3-f255b1ccd75e"},{"name":"Reserve","id":"8a7944bb-ba78-4291-9cf3-933c1fc9556e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"applyFee\": true,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"paymentDetails\": {\n \"cardNumber\": \"4441111111111111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardIdNumber\": \"123\",\n \"expiryMonth\": \"09\",\n \"expiryYear\": \"28\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/reserve","description":"

To Reserve funds from Credit,debit or Prepaid Card, send a POST request to the /v1/transaction/card/reserve endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name. Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `id`	String optional	Customer's Card Payment Method ID.
├── `cardNumber`	String conditional	The last four digits of the Customer's Card Payment Method card number. Required if there is no payment ID provided.
├── `cardType`	String conditional	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`. Required if there is no payment ID provided.
├── `cardHolder`	String conditional	Customer's Card Payment Method cardholder name. Required if there is no payment ID provided.
├── `cardIdNumber`	String 3-4 digits conditional	The credit card security code. Required if there is no payment ID provided.
├── `expiryMonth`	String 2 digits conditional	Credit card expiration month in MM format. Required if there is no payment ID provided.
└── `expiryYear`	String 2 digits conditional	Credit card expiration year in YY format. Required if there is no payment ID provided.
`secure`	Object optional	Contains the 3DS credentials from the Merchant's 3DS provider.
├── `token`	String required	A Base64 encoded string. The value provided by the Merchant's 3DS provider.
├── `eci`	String required	The value provided by the Merchant's 3DS provider.
└── `dsTransId`	String required	The value provided by the Merchant's 3DS provider.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places required	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit). It could be positive and negative number.
├── `quantity`	Number Integer required	The number of units purchased.
└── `amount`	Number Float to two decimal places required	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10). It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type.Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name.
├── `businessIdNumber`	String	Customer's legal business number.
├── `businessName`	String	Customer's business name.
├── `companyName`	String	Customer's legal company name.
├── `registrationName`	String	Customer's legal registration name.
├── `retailName`	String	Customer's legal retail name.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action.Possible values: `RESERVE`
`status`	String	Filter by transaction status.Possible values: `APPROVED` , `DECLINED` , `ERROR`.
`paymentMethod`	String	Filter by payment method.Possible values: `CARD`.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be reserved.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`authCode`	String	(Authorization Code) is a unique alphanumeric value generated by the card-issuing bank or payment processor when a credit card transaction is successfully authorized.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction","card","reserve"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3e0db70d-fd1c-4b74-a80a-6087673b27b9","name":"Reserve","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"legalName\": \"Jason Johnson\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"applyFee\": true,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"paymentDetails\": {\n \"cardNumber\": \"4441111111111111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardType\": \"CREDIT\",\n \"cardIdNumber\": \"123\",\n \"expiryMonth\": \"09\",\n \"expiryYear\": \"28\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/reserve"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1904"},{"key":"x-trace-id","value":"c7a1cc1fcfb6abbda69a3032a0714f5c"},{"key":"date","value":"Mon, 15 Sep 2025 15:21:55 GMT"},{"key":"x-envoy-upstream-service-time","value":"2785"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"234baa6e5e5456742f3a\",\n \"referenceUUID\": \"234baa6e5e5456742f3a\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T15:21:52.877Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"APPROVED\",\n \"action\": \"RESERVE\",\n \"currency\": \"CAD\",\n \"fee\": 6.28,\n \"subtotal\": 7,\n \"total\": 13.28,\n \"amount\": 13.28,\n \"balance\": 7,\n \"paymentDetails\": {\n \"cardNumber\": \"************5439\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"09\",\n \"expiryYear\": \"28\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"authCode\": \"TAS917\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"8a7944bb-ba78-4291-9cf3-933c1fc9556e"},{"name":"Complete","id":"5f0d0834-74fe-4667-9a56-00c64b58b78e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"0acdd6137c02c8498728\",\n \"transactionComment\":\"Requested by Customer\",\n \"subtotal\": 5,\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/complete","description":"

To complete previously reserved Credit,Debit or Prepaid Card transaction, send a POST request to the /v1/transaction/card/complete endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subtotal`	Number Float to two decimal places required	The amount to be refunded. This can be a partial or full amount of the original transaction.
`referenceUUID`	String required	The unique identifier for the reserved transaction to be completed.
`transactionComment`	String optional	A comment for internal use by the merchant regarding the transaction.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `email`	String	An object which contains all the information about the Customer's address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name.
├── `businessIdNumber`	String	Customer's legal business number.
├── `businessName`	String	Customer's business name.
├── `companyName`	String	Customer's legal company name.
├── `registrationName`	String	Customer's legal registration name.
├── `retailName`	String	Customer's legal retail name.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`action`	String	Filter by transaction action. Possible values: `COMPLETE`.
`status`	String	Filter by transaction status. Possible values: `APPROVED` , `DECLINED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`paymentMethod`	String	Filter by payment method. Possible values: `CARD`.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be completed.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10, It could be positive and negative number.
`authCode`	String	(Authorization Code) is a unique alphanumeric value generated by the card-issuing bank or payment processor when a credit card transaction is successfully authorized.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction","card","complete"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c7abae1c-6a12-4d09-a4f1-fdd4433fb386","name":"Complete","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"0acdd6137c02c8498728\",\n \"transactionComment\":\"Requested by Customer\",\n \"subtotal\": 5,\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/card/complete"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1902"},{"key":"x-trace-id","value":"26f8800d856a865567fb7cc395e32fd6"},{"key":"date","value":"Mon, 15 Sep 2025 18:26:24 GMT"},{"key":"x-envoy-upstream-service-time","value":"1510"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0acdd6137c02c8498728\",\n \"referenceUUID\": \"0acdd6137c02c8498728\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T18:25:44.743Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"APPROVED\",\n \"action\": \"COMPLETE\",\n \"currency\": \"CAD\",\n \"fee\": 6.2,\n \"subtotal\": 5,\n \"total\": 11.2,\n \"amount\": 11.2,\n \"balance\": 5,\n \"paymentDetails\": {\n \"cardNumber\": \"************5439\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"09\",\n \"expiryYear\": \"28\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"authCode\": \"TAS908\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"5f0d0834-74fe-4667-9a56-00c64b58b78e"}],"id":"d6ed8e69-a56f-4c88-9453-6a3be3dcfca7","description":"

Overview: Credit,Debit Or Prepaid Card - Create Payment API

The Credit,Debit Or Prepaid Card Create Payment API allows the merchant to initiate a CREDIT CARD payment through BNA Smart Payment Systems. Credit,Debit Or Prepaid Card payments may be one-time payments or recurring payments. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

\n","_postman_id":"d6ed8e69-a56f-4c88-9453-6a3be3dcfca7"},{"name":"Apple pay","item":[{"name":"Sale","id":"1f0a1525-fa37-44dd-bf50-7371d1a78fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionTime\": \"2026-04-07T03:48:26.777Z\",\r\n \"transactionComment\": \"Apple Pay Sale\",\r\n \"metadata\": {\r\n \"order_id\": \"ORD12345\",\r\n \"user_segment\": \"VIP\"\r\n },\r\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\r\n \"applyFee\": true,\r\n \"subtotal\": 175.5,\r\n \"currency\": \"CAD\",\r\n \"paymentDetails\": {\r\n \"decryptedData\": {\r\n \"applicationPrimaryAccountNumber\": \"4111111111111111\",\r\n \"applicationExpirationDate\": \"251231\",\r\n \"currencyCode\": \"CAD\",\r\n \"transactionAmount\": 10.50,\r\n \"deviceManufacturerIdentifier\": \"040010030273\",\r\n \"paymentDataType\": \"3DSecure\",\r\n \"paymentData\": {\r\n \"onlinePaymentCryptogram\": \"AgAAAAAABk4DWZ4C28yUQAAAAAA=\",\r\n \"eciIndicator\": \"7\"\r\n }\r\n },\r\n \"paymentMethod\": {\r\n \"displayName\": \"Visa •••• 1111\",\r\n \"network\": \"Visa\",\r\n \"type\": \"credit\"\r\n },\r\n \"transactionIdentifier\": \"21579207-f4b9-4fa1-b0af-5c8b93ddd34e\"\r\n },\r\n \"items\": [\r\n {\r\n \"sku\": \"ITEMSKU001\",\r\n \"quantity\": 1,\r\n \"price\": 175.5,\r\n \"amount\": 175.5,\r\n \"description\": \"Apple Pay Item\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/apple-pay/sale","description":"

To create an Apple Pay Sale transaction, send a POST request to the /v1/transaction/apple-pay/sale endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `decryptedData`	Object required	Contains the sensitive payment information from an Apple Pay transaction after it has been decrypted on your secure backend server.
├── `applicationPrimaryAccountNumber`	String required	Primary account number of a credit or debit card, typically a 16-digit number found on the front of a physical card.
├── `applicationExpirationDate`	String required	the expiration date of the user's payment card (credit or debit card) that is added to Apple Pay.
├── `currencyCode`	String required	Specifies the currency in which the payment will be processed.
├── `transactionAmount`	String required	Total amount of money that will be charged to the customer in the Apple Pay transaction.
├── `deviceManufacturerIdentifier`	String variable	Unique identifier assigned to the manufacturer of the device that generated the Apple Pay payment.
└── `paymentDataType`	String variable	Format or protocol used for the cryptographic data in the Apple Pay payment.
`paymentData`	Object required	Contains the encrypted payment information that Apple Pay sends after a user authorizes a payment
├──── `onlinePaymentCryptogram`	String required	Cryptographic token used to securely authenticate the Apple Pay transaction.
└──── `eciIndicator`	String required	It tells the card network what level of security was used in the Apple Pay transaction.
`paymentMethod`	Object required	Contains the customer's additional information.
├── `network`	String required	Identifies which card network is being used for the payment method the user selected in Apple Pay. This identifies the payment brand, like Visa, Mastercard, or American Express.
└── `type`	String required	Describes the kind of payment method the user selected in Apple Pay.
`transactionIdentifier`	String optional	Unique ID generated by Apple Pay to identify a specific payment transaction.
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├──`description`	String	The name of the item being purchased, which will be displayed to the customer.
├──`sku`	String required	The SKU of the item.
├──`price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├──`quantity`	Number Integer	The number of units purchased.
└──`amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action.
`status`	String	Filter by transaction status.Possible values: APPROVED , DECLINED, ERROR.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol. e.g. 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity. e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10, it could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":true,"source":{"_postman_id":"8f82ee2b-87a9-48b0-8dff-2d2378e0f7f5","id":"8f82ee2b-87a9-48b0-8dff-2d2378e0f7f5","name":"Apple pay","type":"folder"}},"urlObject":{"path":["v1","transaction","apple-pay","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f4d05169-8de8-42d6-bcb1-393cd215f215","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionComment\": \"Apple Pay Sale\",\r\n \"metadata\": {\r\n \"order_id\": \"ORD12345\",\r\n \"user_segment\": \"VIP\"\r\n },\r\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\r\n \"applyFee\": true,\r\n \"subtotal\": 175.5,\r\n \"currency\": \"CAD\",\r\n \"paymentDetails\": {\r\n \"decryptedData\": {\r\n \"applicationPrimaryAccountNumber\": \"4111111111111111\",\r\n \"applicationExpirationDate\": \"251231\",\r\n \"currencyCode\": \"CAD\",\r\n \"transactionAmount\": 10.50,\r\n \"deviceManufacturerIdentifier\": \"040010030273\",\r\n \"paymentDataType\": \"3DSecure\",\r\n \"paymentData\": {\r\n \"onlinePaymentCryptogram\": \"AgAAAAAABk4DWZ4C28yUQAAAAAA=\",\r\n \"eciIndicator\": \"7\"\r\n }\r\n },\r\n \"paymentMethod\": {\r\n \"displayName\": \"Visa •••• 1111\",\r\n \"network\": \"Visa\",\r\n \"type\": \"credit\"\r\n },\r\n \"transactionIdentifier\": \"21579207-f4b9-4fa1-b0af-5c8b93ddd34e\"\r\n },\r\n \"items\": [\r\n {\r\n \"sku\": \"ITEMSKU001\",\r\n \"quantity\": 1,\r\n \"price\": 175.5,\r\n \"amount\": 175.5,\r\n \"description\": \"Apple Pay Item\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/apple-pay/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 11:53:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1282"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"5c937de340fce850c8674c2d834d82ea"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a6534bed2efc846b62c2\",\n \"referenceUUID\": \"a6534bed2efc846b62c2\",\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-06-23T11:53:42.818Z\",\n \"paymentMethod\": \"APPLE_PAY\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 20.89,\n \"subtotal\": 175.5,\n \"total\": 196.39,\n \"amount\": 196.39,\n \"balance\": 175.5,\n \"paymentDetails\": {\n \"cardNumber\": \"************••••\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"25\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": \"Apple Pay Sale\",\n \"items\": [\n {\n \"sku\": \"ITEMSKU001\",\n \"quantity\": 1,\n \"price\": 175.5,\n \"amount\": 175.5,\n \"description\": \"Apple Pay Item\"\n }\n ],\n \"authCode\": \"TAS211\",\n \"metadata\": {\n \"order_id\": \"ORD12345\",\n \"user_segment\": \"VIP\"\n }\n}"}],"_postman_id":"1f0a1525-fa37-44dd-bf50-7371d1a78fe8"},{"name":"Refund","id":"695f9322-438f-47bf-b644-d6071518a7d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"referenceUUID\": \"a6534bed2efc846b62c2\",\r\n \"transactionTime\": \"2025-06-23T11:53:42.818Z\",\r\n \"subtotal\": 7,\r\n \"transactionComment\": \"hello\",\r\n \"metadata\": {\r\n \"test1\": \"string\",\r\n \"test2\": true,\r\n \"test3\": false,\r\n \"test4\": 123456,\r\n \"test5\": null,\r\n \"test6\": \"Ontario\",\r\n \"test7\": \"N2A 5N1\",\r\n \"test8\": \"Toronto\",\r\n \"test9\": -7.5,\r\n \"test10\": \"2025-01-27T01:58:06.057Z\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/apple-pay/refund","description":"

To refund an Apple Pay Sale transaction, send a POST request to the /v1/transaction/apple-pay/refund endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.
This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
subtotal	Number Float to two decimal places required	The amount to be refunded. This can be a partial or full amount of the original transaction.
referenceUUID	String required	The unique reference UUID of the original transaction.
transactionComment	String required	The reason for the transaction being refunded.
metadata	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	An object which contains all the information about the Customer's address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action. Possible values: `REFUND`.
`status`	String	Filter by transaction status. Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
├── `invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate` _	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":true,"source":{"_postman_id":"8f82ee2b-87a9-48b0-8dff-2d2378e0f7f5","id":"8f82ee2b-87a9-48b0-8dff-2d2378e0f7f5","name":"Apple pay","type":"folder"}},"urlObject":{"path":["v1","transaction","apple-pay","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1d34a0cc-4237-4d95-a441-517a31358597","name":"Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"referenceUUID\": \"a6534bed2efc846b62c2\",\r\n \"subtotal\": 7,\r\n \"transactionComment\": \"Requested by Customer\",\r\n \"metadata\": {\r\n \"test1\": \"string\",\r\n \"test2\": true,\r\n \"test3\": false,\r\n \"test4\": 123456,\r\n \"test5\": null,\r\n \"test6\": \"Ontario\",\r\n \"test7\": \"N2A 5N1\",\r\n \"test8\": \"Toronto\",\r\n \"test9\": -7.5,\r\n \"test10\": \"2025-01-27T01:58:06.057Z\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/apple-pay/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 11:56:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1428"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"62444e3ea037781a74d336a42d1cc5cd"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"235cdd50cdabab0af18f\",\n \"referenceUUID\": \"a6534bed2efc846b62c2\",\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-06-23T11:53:42.818Z\",\n \"paymentMethod\": \"APPLE_PAY\",\n \"status\": \"APPROVED\",\n \"action\": \"REFUND\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": {\n \"cardNumber\": \"************••••\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"25\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": \"Requested by Customer\",\n \"items\": [\n {\n \"sku\": \"ITEMSKU001\",\n \"quantity\": 1,\n \"price\": 175.5,\n \"amount\": 175.5,\n \"description\": \"Apple Pay Item\"\n }\n ],\n \"authCode\": \"TAS211\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\",\n \"order_id\": \"ORD12345\",\n \"user_segment\": \"VIP\"\n }\n}"}],"_postman_id":"695f9322-438f-47bf-b644-d6071518a7d9"},{"name":"Void","id":"f9e6cdac-d4a1-472e-8984-67f5b3d5edf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionTime\": \"2026-04-07T03:48:26.778Z\",\r\n \"referenceUUID\": \"1f60f67db95ece75d187\",\r\n \"transactionComment\": \"no comment\",\r\n \"metadata\": {\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/apple-pay/void","description":"

To void an Apple Pay Sale transaction, send a POST request to the /v1/transaction/apple-pay/void endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being refunded.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	An object which contains all the information about the Customer's address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action. Possible values: `REFUND`.
`status`	String	Filter by transaction status. Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be voided.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
├── `invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate` _	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

Overview: Apple Pay Payment API
The Apple Pay Payment API allows the merchant to initiate Apple Pay payments through BNA Smart Payment. Apple Pay payments may be one-time purchases or recurring subscriptions. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

To create an Google Pay Sale transaction, send a POST request to the /v1/transaction/google-pay/sale endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `description`	String required	Describes the payment method with which the customer is about to pay for with Google Pay.
`info`	Object required	Additional structured information about the payment item or transaction being charged through Google Pay.
├── `cardDetails`	String required	Provides a masked version of the card number, usually showing only the last four digits of the card the customer used with Google Pay.
├── `cardNetwork`	String required	Tells you the card brand / network of the payment card the customer used in Google Pay.
`assuranceDetails`	Object required	Provides security assurance information about the Google Pay transaction. It tells you how strongly Google Pay has verified the cardholder and the payment credentials.
├── `accountVerified`	Boolean required	Tells whether the cardholder’s account was verified by the issuing bank when the card was added to Google Pay.Possible values: true or false
├── `cardHolderAuthenticated`	Boolean required	Tells whether the cardholder was successfully authenticated on the device before the Google Pay payment was authorized.Possible values: `true` or `false`
`decryptedData`	Object required	Contains the sensitive payment information from an Apple Pay transaction after it has been decrypted on your secure backend server.
├── `messageExpiration`	String required	Date and time when the decrypted Apple Pay payment token is no longer valid.
├── `messageId`	String required	Unique identifier for the Apple Pay payment token message. It’s generated by Apple when the token is created and is included inside the decryptedData object after you decrypt the payment.
├── `paymentMethod`	String required	Type of card account used in the Apple Pay transaction. It comes from the decrypted Apple Pay payment token and tells you whether the user’s card is a debit, credit, or prepaid card.
├── `paymentMethodDetails`	Object required	Additional descriptive information about the payment method used in the Google Pay transaction.
├──── `pan`	String variable	Primary Account Number (PAN) — the actual card number for the payment method stored in Google Pay.
├──── `expirationMonth`	String required	Credit card expiration month in MM format.
├──── `expirationYear`	String required	Credit card expiration year in YY format.
├──── `authMethod`	String required	authentication method that was used by the card network when provisioning and verifying the card for Google Pay.
├──── `cryptogram`	String required	Dynamic, one-time-use cryptographic value generated by the Secure Element on the user’s device.It is included in the decrypted Google Pay token.
└──── `eciIndicator`	String required	It tells the card network what level of security was used in the Google Pay transaction.
`paymentMethod`	Object required	Contains the customer's additional information.
├── `network`	String required	Identifies which card network is being used for the payment method the user selected in Google Pay. This identifies the payment brand, like Visa, Mastercard, or American Express.
└── `type`	String required	Describes the kind of payment method the user selected in Google Pay.
`transactionIdentifier`	String optional	Unique ID generated by Google Pay to identify a specific payment transaction.
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action.
`status`	String	Filter by transaction status.Possible values: APPROVED , DECLINED, ERROR.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
├── `meta`	Object	Provides extra metadata about the payment transaction. It contains Google-defined or processor-specific fields that are not strictly part of the payment token itself, but which add context about the payment.
├──── `type`	String	The kind of Google Pay integration that was used to process the payment.
├──── `description`	String	Describes the payment method with which the customer is about to pay for with Google Pay.
├──── `info`	Object	Additional structured information about the payment item or transaction being charged through Google Pay.
├────── `assuranceDetails`	Object	Provides security assurance information about the Google Pay transaction. It tells you how strongly Google Pay has verified the cardholder and the payment credentials.
├─────── `accountVerified`	Boolean	Tells whether the cardholder’s account was verified by the issuing bank when the card was added to Google Pay.Possible values: true or false
├─────── `cardHolderAuthenticated`	Boolean	Tells whether the cardholder was successfully authenticated on the device before the Google Pay payment was authorized.Possible values: true or false
├── `cardDetails`	String	Provides a masked version of the card number, usually showing only the last four digits of the card the customer used with Google Pay.
├── `cardNetwork`	String	Tells you the card brand / network of the payment card the customer used in Google Pay.
`decryptedData`	Object	contains the sensitive payment card details that you get after decrypting the Google Pay payment token.
├──── `messageExpiration`	String	Indicates the date and time when the Google Pay payment token expires.
├──── `messageId`	String	Unique identifier for the Google Pay payment token message.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├──── `paymentMethod`	String	Describes the type of card funding source used for the Google Pay transaction.
`paymentMethodDetails`	Object	Provides specific technical details about the card and how it was authenticated in Google Pay.
├── `pan`	String	Primary Account Number (PAN) of the card used in the Google Pay transaction — in other words, the actual card number.
├── `expirationMonth`	String	2 digits Card expiration month.
├── `expirationYear`	String	4 digits Card expiration year.
├── `authMethod`	String	Tells how the card was provisioned and authenticated in Google Pay.It indicates whether the card uses tokenized cryptographic authentication (CRYPTOGRAM_3DS) or whether Google Pay is simply returning the raw PAN (PAN_ONLY).
├── `cryptogram`	String	A dynamic, one-time-use cryptographic value generated for a Google Pay transaction.
├── `eciIndicator`	String	Stands for Electronic Commerce Indicator.It indicates the level of authentication for the Google Pay transaction, especially in the context of 3-D Secure (3DS).
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol. e.g. 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity. e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10, it could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":true,"source":{"_postman_id":"935673c1-592e-41da-a6e3-0ef4ffbbddcc","id":"935673c1-592e-41da-a6e3-0ef4ffbbddcc","name":"Google pay","type":"folder"}},"urlObject":{"path":["v1","transaction","google-pay","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f6157809-f8d0-4d4c-8ab4-f373d3dc692f","name":"Sale (CRYPTOGRAM_3DS)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionComment\": \"Google Pay Sale\",\r\n \"metadata\": {\r\n \"order_id\": \"ORD12345\",\r\n \"user_segment\": \"VIP\"\r\n },\r\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\r\n \"applyFee\": true,\r\n \"subtotal\": 175.5,\r\n \"currency\": \"CAD\",\r\n \"paymentDetails\": {\r\n \"description\": \"Visa •••• 1234\",\r\n \"info\": {\r\n \"assuranceDetails\": {\r\n \"accountVerified\": true,\r\n \"cardHolderAuthenticated\": false\r\n },\r\n \"cardDetails\": \"1234\",\r\n \"cardNetwork\": \"VISA\"\r\n },\r\n \"decryptedData\": {\r\n \"messageExpiration\": \"1640995200000\",\r\n \"messageId\": \"21579207-f4b9-4fa1-b0af-5c8b93ddd34e\",\r\n \"paymentMethod\": \"CARD\",\r\n \"paymentMethodDetails\": {\r\n \"pan\": \"4514862898239250\",\r\n \"expirationMonth\": 12,\r\n \"expirationYear\": 2025,\r\n \"authMethod\": \"CRYPTOGRAM_3DS\",\r\n \"cryptogram\": \"AgAAAAAABk4DWZ4C28yUQAAAAAA=\",\r\n \"eciIndicator\": \"07\"\r\n }\r\n },\r\n \"type\": \"CARD\"\r\n },\r\n \"items\": [\r\n {\r\n \"sku\": \"ITEMSKU001\",\r\n \"quantity\": 1,\r\n \"price\": 175.5,\r\n \"amount\": 175.5,\r\n \"description\": \"Google Pay Item\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/google-pay/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 11:10:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1781"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"3c63dfdb5f2ddf0e281815c7159be5c6"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7b6ecc12ab5570891df2\",\n \"referenceUUID\": \"7b6ecc12ab5570891df2\",\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-06-23T11:10:15.370Z\",\n \"paymentMethod\": \"GOOGLE_PAY\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 20.89,\n \"subtotal\": 175.5,\n \"total\": 196.39,\n \"amount\": 196.39,\n \"balance\": 175.5,\n \"paymentDetails\": {\n \"cardNumber\": \"************1234\",\n \"expiryMonth\": \"25\",\n \"expiryYear\": \"12\",\n \"meta\": {\n \"description\": \"Visa •••• 1234\",\n \"info\": {\n \"assuranceDetails\": {\n \"accountVerified\": true,\n \"cardHolderAuthenticated\": false\n },\n \"cardDetails\": \"1234\",\n \"cardNetwork\": \"VISA\"\n },\n \"decryptedData\": {\n \"messageExpiration\": \"1640995200000\",\n \"messageId\": \"21579207-f4b9-4fa1-b0af-5c8b93ddd34e\",\n \"paymentMethod\": \"CARD\",\n \"paymentMethodDetails\": {\n \"pan\": \"4514862898239250\",\n \"expirationMonth\": 12,\n \"expirationYear\": 2025,\n \"authMethod\": \"CRYPTOGRAM_3DS\",\n \"cryptogram\": \"AgAAAAAABk4DWZ4C28yUQAAAAAA=\",\n \"eciIndicator\": \"07\"\n }\n },\n \"type\": \"CARD\"\n },\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": \"Google Pay Sale\",\n \"items\": [\n {\n \"sku\": \"ITEMSKU001\",\n \"quantity\": 1,\n \"price\": 175.5,\n \"amount\": 175.5,\n \"description\": \"Google Pay Item\"\n }\n ],\n \"authCode\": \"TAS594\",\n \"metadata\": {\n \"order_id\": \"ORD12345\",\n \"user_segment\": \"VIP\"\n }\n}"},{"id":"ec0e6a8d-241d-43f1-87a5-ae794d2a972e","name":"Sale (PAN_ONLY)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionComment\": \"Google Pay Sale\",\r\n \"metadata\": {\r\n \"order_id\": \"ORD12345\",\r\n \"user_segment\": \"VIP\"\r\n },\r\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\r\n \"applyFee\": true,\r\n \"subtotal\": 175.5,\r\n \"currency\": \"CAD\",\r\n \"paymentDetails\": {\r\n \"description\": \"Visa •••• 1234\",\r\n \"info\": {\r\n \"assuranceDetails\": {\r\n \"accountVerified\": true,\r\n \"cardHolderAuthenticated\": false\r\n },\r\n \"cardDetails\": \"1234\",\r\n \"cardNetwork\": \"VISA\"\r\n },\r\n \"decryptedData\": {\r\n \"messageExpiration\": \"1640995200000\",\r\n \"messageId\": \"21579207-f4b9-4fa1-b0af-5c8b93ddd34e\",\r\n \"paymentMethod\": \"CARD\",\r\n \"paymentMethodDetails\": {\r\n \"pan\": \"4111111111111111\",\r\n \"expirationMonth\": 12,\r\n \"expirationYear\": 2025,\r\n \"authMethod\": \"PAN_ONLY\"\r\n }\r\n },\r\n \"type\": \"CARD\"\r\n },\r\n \"items\": [\r\n {\r\n \"sku\": \"ITEMSKU001\",\r\n \"quantity\": 1,\r\n \"price\": 175.5,\r\n \"amount\": 175.5,\r\n \"description\": \"Google Pay Item\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/google-pay/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 14:16:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1711"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"cfeb3c37cfa28836b98f59ac382801b6"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7e3588f3902050c9b938\",\n \"referenceUUID\": \"7e3588f3902050c9b938\",\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-06-23T14:16:47.872Z\",\n \"paymentMethod\": \"GOOGLE_PAY\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 20.89,\n \"subtotal\": 175.5,\n \"total\": 196.39,\n \"amount\": 196.39,\n \"balance\": 175.5,\n \"paymentDetails\": {\n \"cardNumber\": \"************1234\",\n \"expiryMonth\": \"25\",\n \"expiryYear\": \"12\",\n \"meta\": {\n \"description\": \"Visa •••• 1234\",\n \"info\": {\n \"assuranceDetails\": {\n \"accountVerified\": true,\n \"cardHolderAuthenticated\": false\n },\n \"cardDetails\": \"1234\",\n \"cardNetwork\": \"VISA\"\n },\n \"decryptedData\": {\n \"messageExpiration\": \"1640995200000\",\n \"messageId\": \"21579207-f4b9-4fa1-b0af-5c8b93ddd34e\",\n \"paymentMethod\": \"CARD\",\n \"paymentMethodDetails\": {\n \"pan\": \"4111111111111111\",\n \"expirationMonth\": 12,\n \"expirationYear\": 2025,\n \"authMethod\": \"PAN_ONLY\"\n }\n },\n \"type\": \"CARD\"\n },\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": \"Google Pay Sale\",\n \"items\": [\n {\n \"sku\": \"ITEMSKU001\",\n \"quantity\": 1,\n \"price\": 175.5,\n \"amount\": 175.5,\n \"description\": \"Google Pay Item\"\n }\n ],\n \"authCode\": \"TAS898\",\n \"metadata\": {\n \"order_id\": \"ORD12345\",\n \"user_segment\": \"VIP\"\n }\n}"}],"_postman_id":"fd816834-c9d7-4450-96d0-4e059c72cd22"},{"name":"Refund","id":"73d74b59-db3b-4493-be20-946fe7ab50ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"7b6ecc12ab5570891df2\",\n \"transactionTime\": \"2026-04-07T03:48:26.779Z\",\n \"subtotal\": 7,\n \"transactionComment\": \"hello\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/google-pay/refund","description":"

To create an Google Pay Refund transaction, send a POST request to the /v1/transaction/google-pay/refund endpoint with the Basic credentials included in the header.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
subtotal	Number Float to two decimal places required	The amount to be refunded. This can be a partial or full amount of the original transaction.
referenceUUID	String required	The unique reference UUID of the original transaction.
transactionComment	String required	The reason for the transaction being refunded.
metadata	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action.
`status`	String	Filter by transaction status.Possible values: APPROVED , DECLINED, ERROR.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
├── `meta`	Object	Provides extra metadata about the payment transaction. It contains Google-defined or processor-specific fields that are not strictly part of the payment token itself, but which add context about the payment.
├──── `type`	String	The kind of Google Pay integration that was used to process the payment.
├──── `description`	String	Describes the payment method with which the customer is about to pay for with Google Pay.
├──── `info`	Object	Additional structured information about the payment item or transaction being charged through Google Pay.
├────── `assuranceDetails`	Object	Provides security assurance information about the Google Pay transaction. It tells you how strongly Google Pay has verified the cardholder and the payment credentials.
├─────── `accountVerified`	Boolean	Tells whether the cardholder’s account was verified by the issuing bank when the card was added to Google Pay.Possible values: true or false
├─────── `cardHolderAuthenticated`	Boolean	Tells whether the cardholder was successfully authenticated on the device before the Google Pay payment was authorized.Possible values: true or false
├── `cardDetails`	String	Provides a masked version of the card number, usually showing only the last four digits of the card the customer used with Google Pay.
├── `cardNetwork`	String	Tells you the card brand / network of the payment card the customer used in Google Pay.
`decryptedData`	Object	contains the sensitive payment card details that you get after decrypting the Google Pay payment token.
├──── `messageExpiration`	String	Indicates the date and time when the Google Pay payment token expires.
├──── `messageId`	String	Unique identifier for the Google Pay payment token message.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├──── `paymentMethod`	String	Describes the type of card funding source used for the Google Pay transaction.
`paymentMethodDetails`	Object	Provides specific technical details about the card and how it was authenticated in Google Pay.
├── `pan`	String	Primary Account Number (PAN) of the card used in the Google Pay transaction — in other words, the actual card number.
├── `expirationMonth`	String	2 digits Card expiration month.
├── `expirationYear`	String	4 digits Card expiration year.
├── `authMethod`	String	Tells how the card was provisioned and authenticated in Google Pay.It indicates whether the card uses tokenized cryptographic authentication (CRYPTOGRAM_3DS) or whether Google Pay is simply returning the raw PAN (PAN_ONLY).
├── `cryptogram`	String	A dynamic, one-time-use cryptographic value generated for a Google Pay transaction.
├── `eciIndicator`	String	Stands for Electronic Commerce Indicator.It indicates the level of authentication for the Google Pay transaction, especially in the context of 3-D Secure (3DS).
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol. e.g. 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity. e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10, it could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

To create an Google Pay Void transaction, send a POST request to the /v1/transaction/google-pay/void endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`transactionTime`	Date ISO 8601 required	Timestamp created by the merchant at the time of the request, in UTC.
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object variable	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String variable	Customer's legal business name.
├── `businessIdNumber`	String variable	Customer's legal business number. Required for business customers.
├── `businessName`	String variable	Customer's business name.
├── `companyName`	String variable	Customer's legal company name.
├── `registrationName`	String variable	Customer's legal registration name.
├── `retailName`	String variable	Customer's legal retail name.
└── `address`	Object required	Contains all the information about the customer's address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province or state (full name).
├──── `country`	String optional	Customer's country (full name).
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `description`	String required	Describes the payment method with which the customer is about to pay for with Google Pay.
`info`	Object required	Additional structured information about the payment item or transaction being charged through Google Pay.
├── `cardDetails`	String required	Provides a masked version of the card number, usually showing only the last four digits of the card the customer used with Google Pay.
├── `cardNetwork`	String required	Tells you the card brand / network of the payment card the customer used in Google Pay.
`assuranceDetails`	Object required	Provides security assurance information about the Google Pay transaction. It tells you how strongly Google Pay has verified the cardholder and the payment credentials.
├── `accountVerified`	Boolean required	Tells whether the cardholder’s account was verified by the issuing bank when the card was added to Google Pay.Possible values: true or false
├── `cardHolderAuthenticated`	Boolean required	Tells whether the cardholder was successfully authenticated on the device before the Google Pay payment was authorized.Possible values: true or false
`decryptedData`	Object required	Contains the sensitive payment information from an Apple Pay transaction after it has been decrypted on your secure backend server.
├── `messageExpiration`	String required	Date and time when the decrypted Apple Pay payment token is no longer valid.
├── `messageId`	String required	Unique identifier for the Apple Pay payment token message. It’s generated by Apple when the token is created and is included inside the decryptedData object after you decrypt the payment.
├── `paymentMethod`	String required	Type of card account used in the Apple Pay transaction. It comes from the decrypted Apple Pay payment token and tells you whether the user’s card is a debit, credit, or prepaid card.
├── `paymentMethodDetails`	Object required	Additional descriptive information about the payment method used in the Google Pay transaction.
├──── `pan`	String variable	Primary Account Number (PAN) — the actual card number for the payment method stored in Google Pay.
├──── `expirationMonth`	String required	Credit card expiration month in MM format.
├──── `expirationYear`	String required	Credit card expiration year in YY format.
├──── `authMethod`	String required	authentication method that was used by the card network when provisioning and verifying the card for Google Pay.
├──── `cryptogram`	String required	Dynamic, one-time-use cryptographic value generated by the Secure Element on the user’s device.It is included in the decrypted Google Pay token.
└──── `eciIndicator`	String required	It tells the card network what level of security was used in the Google Pay transaction.
`paymentMethod`	Object required	Contains the customer's additional information.
├── `network`	String required	Identifies which card network is being used for the payment method the user selected in Google Pay. This identifies the payment brand, like Visa, Mastercard, or American Express.
└── `type`	String _required	Describes the kind of payment method the user selected in Google Pay.
`transactionIdentifier`	String optional	Unique ID generated by Google Pay to identify a specific payment transaction.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action.
`status`	String	Filter by transaction status.Possible values: APPROVED , DECLINED, ERROR.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be voided.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
├── `meta`	Object	Provides extra metadata about the payment transaction. It contains Google-defined or processor-specific fields that are not strictly part of the payment token itself, but which add context about the payment.
├──── `type`	String	The kind of Google Pay integration that was used to process the payment.
├──── `description`	String	Describes the payment method with which the customer is about to pay for with Google Pay.
├──── `info`	Object	Additional structured information about the payment item or transaction being charged through Google Pay.
├────── `assuranceDetails`	Object	Provides security assurance information about the Google Pay transaction. It tells you how strongly Google Pay has verified the cardholder and the payment credentials.
├─────── `accountVerified`	Boolean	Tells whether the cardholder’s account was verified by the issuing bank when the card was added to Google Pay.Possible values: true or false
├─────── `cardHolderAuthenticated`	Boolean	Tells whether the cardholder was successfully authenticated on the device before the Google Pay payment was authorized.Possible values: true or false
├── `cardDetails`	String	Provides a masked version of the card number, usually showing only the last four digits of the card the customer used with Google Pay.
├── `cardNetwork`	String	Tells you the card brand / network of the payment card the customer used in Google Pay.
`decryptedData`	Object	contains the sensitive payment card details that you get after decrypting the Google Pay payment token.
├──── `messageExpiration`	String	Indicates the date and time when the Google Pay payment token expires.
├──── `messageId`	String	Unique identifier for the Google Pay payment token message.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├──── `paymentMethod`	String	Describes the type of card funding source used for the Google Pay transaction.
`paymentMethodDetails`	Object	Provides specific technical details about the card and how it was authenticated in Google Pay.
├── `pan`	String	Primary Account Number (PAN) of the card used in the Google Pay transaction — in other words, the actual card number.
├── `expirationMonth`	String	2 digits Card expiration month.
├── `expirationYear`	String	4 digits Card expiration year.
├── `authMethod`	String	Tells how the card was provisioned and authenticated in Google Pay.It indicates whether the card uses tokenized cryptographic authentication (CRYPTOGRAM_3DS) or whether Google Pay is simply returning the raw PAN (PAN_ONLY).
├── `cryptogram`	String	A dynamic, one-time-use cryptographic value generated for a Google Pay transaction.
├── `eciIndicator`	String	Stands for Electronic Commerce Indicator.It indicates the level of authentication for the Google Pay transaction, especially in the context of 3-D Secure (3DS).
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol. e.g. 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity. e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10, it could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

Overview: Google Play Payment API
The Google Play Payment API allows the merchant to initiate Google Play payments through BNA Smart Payment. Google Play payments may be one-time purchases or recurring subscriptions. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

To create an Samsung Pay Sale transaction, send a POST request to the /v1/transaction/samsung-pay/sale endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `currencyCode`	String required	Specifies the currency in which the payment will be processed.
├── `amount`	String required	Total amount of money that will be charged to the customer in the Samsung Pay transaction.
├──── `cryptogram`	String required	Cryptographic token used to securely authenticate the Samsung Pay transaction.
├── `utc`	String required	Date and time of the Samsung Pay transaction in Coordinated Universal Time (UTC).
├── `tokenPAN`	String required	(Tokenized Primary Account Number) is a device-specific substitute card number assigned when a card is added to Samsung Pay.
└──── `eciIndicator`	String required	It tells the card network what level of security was used in the Samsung Pay transaction.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name.For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action.
`status`	String	Filter by transaction status.Possible values: APPROVED , DECLINED, ERROR.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type.
├── `cardBrand`	String	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol. e.g. 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity. e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10, it could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":true,"source":{"_postman_id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f","id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f","name":"Samsung pay","type":"folder"}},"urlObject":{"path":["v1","transaction","samsung-pay","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"28244c38-8e94-4022-9392-4326b4ee20e4","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionComment\": \"Samsung Pay Sale\",\r\n \"metadata\": {\r\n \"order_id\": \"ORD12345\",\r\n \"user_segment\": \"VIP\"\r\n },\r\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\r\n \"applyFee\": true,\r\n \"subtotal\": 175.5,\r\n \"currency\": \"CAD\",\r\n \"paymentDetails\": {\r\n \"amount\": \"175.5\",\r\n \"currency_code\": \"CAD\",\r\n \"utc\": \"2025-06-26\",\r\n \"eci_indicator\": \"5\",\r\n \"tokenPAN\": \"4532015112830366\",\r\n \"tokenPanExpiration\": \"2512\",\r\n \"cryptogram\": \"AgAAAAAABk4DWZ4C28yUQAAAAAA=\"\r\n },\r\n \"items\": [\r\n {\r\n \"sku\": \"ITEMSKU001\",\r\n \"quantity\": 1,\r\n \"price\": 175.5,\r\n \"amount\": 175.5,\r\n \"description\": \"Samsung Pay Item\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/samsung-pay/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 26 Jun 2025 19:39:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1274"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"55c68d7be08ba382a9d3077ae0cfa608"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"c505183600a0b314a97c\",\n \"referenceUUID\": \"c505183600a0b314a97c\",\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-06-26T19:39:14.213Z\",\n \"paymentMethod\": \"SAMSUNG_PAY\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 175.5,\n \"total\": 175.5,\n \"amount\": 175.5,\n \"balance\": 175.5,\n \"paymentDetails\": {\n \"cardNumber\": \"************0366\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"25\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": \"Samsung Pay Sale\",\n \"items\": [\n {\n \"sku\": \"ITEMSKU001\",\n \"quantity\": 1,\n \"price\": 175.5,\n \"amount\": 175.5,\n \"description\": \"Samsung Pay Item\"\n }\n ],\n \"authCode\": \"TAS183\",\n \"metadata\": {\n \"order_id\": \"ORD12345\",\n \"user_segment\": \"VIP\"\n }\n}"}],"_postman_id":"c3aec19f-daf1-4f26-aae5-3c2e4beb4d5e"},{"name":"Refund","id":"a8f978fe-a726-4358-b597-8c28d33dd4d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base_url}}/v1/transaction/samsung-pay/refund","description":"

To refund an Samsung Pay transaction, send a POST request to the /v1/transaction/samsung-pay/refund endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subtotal`	Number Float to two decimal places required	The amount to be refunded. This can be a partial or full amount of the original transaction.
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being refunded.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	An object which contains all the information about the Customer's address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. Required for business customer.
├── `businessIdNumber`	String	Customer's legal business number. Required for business customer.
├── `businessName`	String	Customer's business name. Required for business customer.
├── `companyName`	String	Customer's legal company name. Required for business customer.
├── `registrationName`	String	Customer's legal registration name. Required for business customer.
├── `retailName`	String	Customer's legal retail name. Required for business customer.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action.Possible values: `REFUND`.
`status`	String	Filter by transaction status.Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String	2 digits Card expiration month.
└── `expiryYear`	String	2 digits Card expiration month.
├── `invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":true,"source":{"_postman_id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f","id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f","name":"Samsung pay","type":"folder"}},"urlObject":{"path":["v1","transaction","samsung-pay","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cd8a020c-e624-49d3-9459-f21be0d67ed7","name":"Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"referenceUUID\": \"7e8bdb780987f8c6d50a\",\r\n \"subtotal\": 7,\r\n \"transactionComment\": \"Customer Request\",\r\n \"metadata\": {\r\n \"order_id\": \"ORD12345\",\r\n \"user_segment\": \"VIP\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/samsung-pay/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 26 Jun 2025 23:16:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1249"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"3b866972a135b2c22ef7c1cd66362863"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ff3831bf5aaa40199a9c\",\n \"referenceUUID\": \"7e8bdb780987f8c6d50a\",\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-06-26T23:16:07.270Z\",\n \"paymentMethod\": \"SAMSUNG_PAY\",\n \"status\": \"APPROVED\",\n \"action\": \"REFUND\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": {\n \"cardNumber\": \"************0366\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"25\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": \"Customer Request\",\n \"items\": [\n {\n \"sku\": \"ITEMSKU001\",\n \"quantity\": 1,\n \"price\": 175.5,\n \"amount\": 175.5,\n \"description\": \"Samsung Pay Item\"\n }\n ],\n \"authCode\": \"TAS667\",\n \"metadata\": {\n \"order_id\": \"ORD12345\",\n \"user_segment\": \"VIP\"\n }\n}"}],"_postman_id":"a8f978fe-a726-4358-b597-8c28d33dd4d3"},{"name":"Void","id":"0b237a8b-7083-4d9d-bfe1-7fd1b953b38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionTime\": \"2026-04-07T03:48:26.781Z\",\r\n \"referenceUUID\": \"8dca05b4028287e94f3f\",\r\n \"transactionComment\": \"no comment\",\r\n \"metadata\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/samsung-pay/void","description":"

To Void an Samsung Pay Sale transaction, send a POST request to the /v1/transaction/samsung-pay/void endpoint with the Basic credentials included in the header.
This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being refunded.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	An object which contains all the information about the Customer's address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	String	Transaction time.
`action`	String	Filter by transaction action. Possible values: `VOID`.
`status`	String	Filter by transaction status. Possible values: `APPROVED` , `DECLINED`, `ERROR`.
`paymentMethod`	String	Filter by payment method.
`currency`	String	Transaction currency Possible values: `CAD` , `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be voided.
`paymentDetails`	Object	An object which contains information about the payment details.
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String 2 digits	Card expiration month.
└── `expiryYear`	String 2 digits	Card expiration year.
├── `invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	String	Contract start date
└── `contractExpireDate`	String	Contract expiration date
`transactionComment`	String	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
`quantity`	Number Integer	The number of units purchased.
`amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 , It could be positive and negative number.
`authCode`	String	Code returned by the payment processor or card issuer to indicate that the payment authorization was successful.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":true,"source":{"_postman_id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f","id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f","name":"Samsung pay","type":"folder"}},"urlObject":{"path":["v1","transaction","samsung-pay","void"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bc6056cd-f470-4df5-80fb-89c89d5e53e5","name":"Void","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"referenceUUID\": \"8dca05b4028287e94f3f\",\r\n \"transactionComment\": \"Samsung Pay Sale\",\r\n \"metadata\": {\r\n \"test1\": \"string\",\r\n \"test2\": true,\r\n \"test3\": false,\r\n \"test4\": 123456,\r\n \"test5\": null,\r\n \"test6\": \"Ontario\",\r\n \"test7\": \"N2A 5N1\",\r\n \"test8\": \"Toronto\",\r\n \"test9\": -7.5,\r\n \"test10\": \"2025-01-27T01:58:06.057Z\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/samsung-pay/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Jun 2025 10:02:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1280"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"1c2c0286a34089718b479576b7eb810d"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"8dca05b4028287e94f3f\",\n \"referenceUUID\": \"8dca05b4028287e94f3f\",\n \"customerId\": \"243ce827-b894-406c-8e87-ab6b4ee53276\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444444\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222972\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-06-27T10:02:18.177Z\",\n \"paymentMethod\": \"SAMSUNG_PAY\",\n \"status\": \"APPROVED\",\n \"action\": \"VOID\",\n \"currency\": \"CAD\",\n \"fee\": 20.89,\n \"subtotal\": 175.5,\n \"total\": 196.39,\n \"amount\": 196.39,\n \"balance\": 175.5,\n \"paymentDetails\": {\n \"cardNumber\": \"************0366\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"25\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {},\n \"contractInfo\": {},\n \"transactionComment\": \"Samsung Pay Sale\",\n \"items\": [\n {\n \"sku\": \"ITEMSKU001\",\n \"quantity\": 1,\n \"price\": 175.5,\n \"amount\": 175.5,\n \"description\": \"Samsung Pay Item\"\n }\n ],\n \"authCode\": \"TAS873\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"0b237a8b-7083-4d9d-bfe1-7fd1b953b38e"}],"id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f","description":"

Overview: Samsung Pay Payment API
The Samsung Pay Payment API allows the merchant to initiate SamsungPay payments through BNA Smart Payment. Samsung Pay payments may be one-time purchases or recurring subscriptions. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

\n","auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"34fa4d98-95c4-49dd-b1b7-5fefa9af50cd"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"0368e325-d537-47d3-b3cf-ff9d21a4755c"}}],"_postman_id":"2a0c0ba6-d5d0-4d31-846d-b32183538f4f"},{"name":"Bank Transfer (EFT)","item":[{"name":"Sale","id":"811d29f5-89a1-4dcd-9886-93be80ab22c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"transitNumber\": \"118\",\n \"accountNumber\": \"4440555\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"applyFee\": true,\n \"subtotal\": \"7\",\n \"currency\": \"CAD\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/eft/sale","description":"

To create Sale Bank Transfer (EFT) transaction, send a POST request to the /v1/transaction/eft/sale endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	`String` conditional	The ID of the customer. Required if the Customer Info object is not provided.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply fees to the customer. Possible values: `true`, `false`.
`subtotal`	Number required	Transaction subtotal. Float with two decimal places.
`currency`	String required	ISO 4217 currency code. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `id`	String optional	Customer's Card Payment Method ID.
├── `bankNumber`	String conditional	Customer's bank number. Required if no payment ID is provided.
├── `transitNumber`	String conditional	Customer's bank transit number. Required if no payment ID is provided.
└── `accountNumber`	String conditional	Customer's bank account number. Required if no payment ID is provided.
`items`	Array required	List of cart items. Each must contain an \"item\" object.
├── `description`	String required	Name of the item displayed to the customer.
├── `sku`	String required	SKU of the item.
├── `price`	Number required	Per-unit price (float, two decimals).It could be positive and negative number.
├── `quantity`	Number required	Number of units purchased (integer).
└── `amount`	Number required	Total cost for the item (price × quantity).It could be positive and negative number.
`transactionComment`	String optional	Internal transaction comment.
`metadata`	Object optional	Up to 10 metadata properties of type String, Boolean, Null, or Number.

Transaction Options Documentation
This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. Required for business customer.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. Required for business customer.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `EFT`.
`status`	String	Status of the transaction.Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `SALE`.
`currency`	String	Transaction currency Possible values: `CAD`, `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	Contains detailed information about the payment.
├── `id`	String	Unique identifier for the customer's EFT payment method.
├── `bankName`	String	Name of the bank for the EFT payment method.
├── `bankNumber`	String	Bank number for the EFT payment method.
├── `accountNumber`	String	The last three digits of the customer's EFT payment method account number.
└── `transitNumber`	String	The last two digits of the customer's EFT payment method transit number.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","eft","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a4e6eb55-a247-48f2-a127-eba0ef8911a2","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"transitNumber\": \"118\",\n \"accountNumber\": \"4440555\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"applyFee\": true,\n \"subtotal\": \"7\",\n \"currency\": \"CAD\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/eft/sale"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1851"},{"key":"x-trace-id","value":"d8722b8f0bcc9603cbfb91a963fe14d1"},{"key":"date","value":"Mon, 15 Sep 2025 16:32:45 GMT"},{"key":"x-envoy-upstream-service-time","value":"1893"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"e4fbfda96de93d6db2a2\",\n \"referenceUUID\": \"e4fbfda96de93d6db2a2\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T16:32:43.655Z\",\n \"paymentMethod\": \"EFT\",\n \"status\": \"PENDING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 2.21,\n \"subtotal\": 7,\n \"total\": 9.21,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"bankName\": \"ROYAL BANK OF CANADA\",\n \"accountNumber\": \"*****555\",\n \"transitNumber\": \"***18\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"811d29f5-89a1-4dcd-9886-93be80ab22c2"},{"name":"Payout 🔒","id":"21850f2c-5fcb-4db5-95f2-ac43d41c6d9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"transitNumber\": \"118\",\n \"accountNumber\": \"4440555\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"applyFee\": true,\n \"subtotal\": \"7\",\n \"currency\": \"CAD\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/eft/payout","description":"

To create a Bank Transfer (EFT) Payout transaction, send a POST request to the /v1/transaction/eft/payout endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains information about the payment details.
├── `id`	String optional	Customer's Card Payment Method ID.
├── `bankNumber`	String conditional	The Customer's bank number. Required if there is no payment ID provided.
├── `transitNumber`	String conditional	The Customer's bank transit number. Required if there is no payment ID provided.
└── `accountNumber`	String conditional	The Customer's bank account number. Required if there is no payment ID provided.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit). It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10). It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation
This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`paymentMethod`	String	Payment method used for the transaction Possible values: `EFT`.
`status`	String	Status of the transaction.Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `PAYOUT`.
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	Contains detailed information about the payment.
├── `id`	String	Unique identifier for the customer's EFT payment method.
├── `bankName`	String	Name of the bank for the EFT payment method.
├── `bankNumber`	String	Bank number for the EFT payment method.
├── `accountNumber`	String	The last three digits of the customer's EFT payment method account number.
└── `transitNumber`	String	The last two digits of the customer's EFT payment method transit number.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10, it could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","eft","payout"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d7131111-629c-45a0-b80d-0dab5e934a28","name":"Payout","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"transitNumber\": \"118\",\n \"accountNumber\": \"4440555\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"applyFee\": true,\n \"subtotal\": \"7\",\n \"currency\": \"CAD\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/eft/payout"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1853"},{"key":"x-trace-id","value":"efce570cf03206394bfba0d6d62741a4"},{"key":"date","value":"Mon, 15 Sep 2025 16:34:22 GMT"},{"key":"x-envoy-upstream-service-time","value":"1902"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"77d5741fc4d646172e82\",\n \"referenceUUID\": \"77d5741fc4d646172e82\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T16:34:20.816Z\",\n \"paymentMethod\": \"EFT\",\n \"status\": \"PENDING\",\n \"action\": \"PAYOUT\",\n \"currency\": \"CAD\",\n \"fee\": 2.21,\n \"subtotal\": 7,\n \"total\": 9.21,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"bankName\": \"ROYAL BANK OF CANADA\",\n \"accountNumber\": \"*****555\",\n \"transitNumber\": \"***18\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"21850f2c-5fcb-4db5-95f2-ac43d41c6d9d"},{"name":"Refund","id":"c96bb09b-a37f-4c6f-a65a-e3706007c3c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"81bcaba8572922dffbda\",\n \"subtotal\": 7,\n \"transactionComment\": \"Customer Request\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/eft/refund","description":"

To create a Refund a Bank Transfer (EFT) transaction, send a POST request to the /v1/transaction/eft/refund endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subtotal`	Number Float to two decimal places required	The amount to be refunded. This can be a partial or full amount of the original transaction.
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being refunded.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation
This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name.
├── `businessIdNumber`	String	Customer's legal business number.
├── `businessName`	String	Customer's business name.
├── `companyName`	String	Customer's legal company name.
├── `registrationName`	String	Customer's legal registration name.
├── `retailName`	String	Customer's legal retail name.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`paymentMethod`	String	Payment method used for the transaction.Possible values: `EFT`.
`status`	String	Status of the transaction.Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `REFUND`.
`currency`	String	Transaction currency Possible values: `CAD`, `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	Contains detailed information about the payment.
`id`	String	Unique identifier for the customer's EFT payment method.
`bankName`	String	Name of the bank for the EFT payment method.
`bankNumber`	String	Bank number for the EFT payment method.
`accountNumber`	String	The last three digits of the customer's EFT payment method account number.
`transitNumber`	String	The last two digits of the customer's EFT payment method transit number.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","eft","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a82ee56f-152d-4099-af91-cfc84e0d64e3","name":"Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"81bcaba8572922dffbda\",\n \"subtotal\": 7,\n \"transactionComment\": \"Customer Request\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/eft/refund"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1847"},{"key":"x-trace-id","value":"ce049a8320412698969abb77e1cd2ee2"},{"key":"date","value":"Mon, 22 Sep 2025 19:52:52 GMT"},{"key":"x-envoy-upstream-service-time","value":"2254"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"680370fa81a689290057\",\n \"referenceUUID\": \"81bcaba8572922dffbda\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777770\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-22T19:52:50.404Z\",\n \"paymentMethod\": \"EFT\",\n \"status\": \"PENDING\",\n \"action\": \"REFUND\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"bankName\": \"ROYAL BANK OF CANADA\",\n \"accountNumber\": \"*****555\",\n \"transitNumber\": \"***18\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"c96bb09b-a37f-4c6f-a65a-e3706007c3c4"}],"id":"bc26afb5-4fb7-4a73-9447-26a30e265454","description":"

Overview: Bank Transfer (EFT) - Create Payment API

The Bank Transfer (EFT) Create Payment API allows the merchant to initiate a Bank Transfer payment through BNA Smart Payment. Bank Transfer (EFT) payments may be one-time payments or recurring payments. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

\n","_postman_id":"bc26afb5-4fb7-4a73-9447-26a30e265454"},{"name":"e-Transfer","item":[{"name":"Sale","id":"1b37cd8f-0d1e-4883-a9a7-0178ae5f3cae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"transactionComment\": \"hello\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"name\": \"Angelica Sloan\",\n \"phoneNumber\": \"4167777777\",\n \"phoneCode\": \"+1\",\n \"message\": \"Request money\",\n \"deliveryType\": \"sms\"\n },\n \"applyFee\": true,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/e-transfer/sale","description":"

To create a Sale E-Transfer transaction, send a POST request to the /v1/transaction/e-transfer/sale endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name. Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`paymentDetails`	Object required	Contains the details required for processing an Interac e-Transfer payment.
├──── `name`	String required	Full name of the recipient, including both first and last names.
├──── `email`	String conditional	Recipient’s email address. Required if `deliveryType` is set to `EMAIL`.
├──── `phoneCode`	String conditional	Recipient’s country calling code. Required if `deliveryType` is set to `SMS`.
├──── `phoneNumber`	String conditional	Recipient’s phone number. Required if `deliveryType` is set to `SMS`.
├──── `message`	String optional	Optional message to include in the Interac e-Transfer request.
└──── `deliveryType`	String required	Method used to deliver the transfer notification. Possible values: `EMAIL`, `SMS`, or `NONE`.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places required	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name.For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`paymentMethod`	String	Payment method used for the transaction.Possible values: `EFT`.
`status`	String	Status of the transaction.Possible values: `DECLINED`, `PENDING`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `SALE`.
`currency`	String	Transaction currency Possible values: `CAD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be paid.
`paymentDetails`	Object	Contains detailed information about the payment.
`id`	String	Unique identifier for the customer's e-Transfer payment method.
`invoiceInfo`	Object	An object which contains additional information about the invoice.
├── `invoiceId`	String	Invoice number
└── `invoiceAdditionalInfo`	String	Invoice additional info
`contractInfo`	Object	An object which contains additional information about the contract.
├── `contractId`	String	Contract number
├── `contractAdditionalInfo`	String	Contract additional info
├── `contractStartDate`	Date	Contract start date
└── `contractExpireDate`	Date	Contract expiration date
`transactionComment`	Date	Transaction comment
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10 .It could be positive and negative number.
`interacUrl`	String	The URL to the Interac payment page
`interacReference`	String	Interac Reference Number
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","transaction","e-transfer","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"162a6dc1-6868-4f71-b421-4e8dc3c6e1b4","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"transactionComment\": \"Money Request\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"name\": \"Angelica Sloan\",\n \"email\": \"nacipej999@bawsny.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"EMAIL\"\n },\n \"applyFee\": true,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-service.bnasmartpayment.com/v1/transaction/e-transfer/sale"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1972"},{"key":"x-trace-id","value":"21595dc53800e52f19f2dfe3613b58b4"},{"key":"date","value":"Mon, 15 Sep 2025 18:06:32 GMT"},{"key":"x-envoy-upstream-service-time","value":"2051"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"d714b97aa54cdd1f2ad9\",\n \"referenceUUID\": \"d714b97aa54cdd1f2ad9\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T18:06:30.916Z\",\n \"paymentMethod\": \"E_TRANSFER\",\n \"status\": \"PENDING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 3.28,\n \"subtotal\": 7,\n \"total\": 10.28,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"name\": \"Angelica Sloan\",\n \"email\": \"nacipej999@bawsny.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"EMAIL\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"interacUrl\": \"https://gateway-web.fit.interac.ca/reqPayment/eml/CA1MREvKGUz5\",\n \"interacReference\": \"CA1MREvKGUz5\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"1b37cd8f-0d1e-4883-a9a7-0178ae5f3cae"},{"name":"Payout 🔒","id":"2cbca125-c68a-4747-a589-0e063e5af87a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"applyFee\": false,\n \"subtotal\": 46,\n \"currency\": \"CAD\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"name\": \"Angelica Sloan\",\n \"email\": \"nacipej999@bawsny.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"email\",\n \"securityQuestion\": \"name of dog\",\n \"securityAnswer\": \"marsel\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 46,\n \"description\": \"12312\",\n \"price\": 46,\n \"quantity\": 1,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/e-transfer/payout","description":"

To create a Payout E-Transfer transaction, send a POST request to the /v1/transaction/e-transfer/payout endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name. Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated.Possible values: `CAD`, `USD`.
`paymentDetails`	Object required	Contains all necessary information for processing an Interac e-Transfer payment.
├──── `name`	String required	Full legal name of the recipient, including both first and last names.
├──── `email`	String conditional	Recipient’s Interac-registered email address. Required if `deliveryType` is set to `EMAIL`.
├──── `phoneCode`	String conditional	Recipient’s country calling code (e.g., `+1` for Canada/USA). Required if `deliveryType` is set to `SMS`.
├──── `phoneNumber`	String conditional	Recipient’s Interac-registered phone number. Required if `deliveryType` is set to `SMS`.
├──── `message`	String optional	Personal message to include with the Interac e-Transfer notification.
├──── `securityQuestion`	String conditional	Security question for the recipient to answer in order to deposit the transfer. Required if the recipient does not have a Direct Deposit Registration (DDR).
├──── `securityAnswer`	String conditional	Answer to the security question, subject to the following rules: - Must not contain spaces. - Must be between 3 and 25 characters in length. Required if `securityQuestion` is provided.
└──── `deliveryType`	String required	The notification delivery method.Possible values: `EMAIL` or `SMS`.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places required	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit). It could be positive and negative number.
├── `quantity`	Number Integer required	The number of units purchased.
└── `amount`	Number Float to two decimal places required	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10). It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Response parameters

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	Object	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. RFor business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `E-TRANSFER`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `PAYOUT`.
`currency`	String	Transaction currency Possible values: `CAD`, `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	Contains detailed information about the payment.
`id`	String	Unique identifier for the customer's e-Transfer payment method.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","e-transfer","payout"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c7bd97da-76aa-4f1d-860b-ac6a6250445b","name":"Payout","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"applyFee\": false,\n \"subtotal\": 46,\n \"currency\": \"CAD\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"paymentDetails\": {\n \"name\": \"Angelica Sloan\",\n \"email\": \"nacipej999@bawsny.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"EMAIL\",\n \"securityQuestion\": \"name of dog\",\n \"securityAnswer\": \"marsel\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 46,\n \"description\": \"12312\",\n \"price\": 46,\n \"quantity\": 1,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-service.bnasmartpayment.com/v1/transaction/e-transfer/payout"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1861"},{"key":"x-trace-id","value":"ca912dccb1908a03bb5f1376c5be16ca"},{"key":"date","value":"Mon, 15 Sep 2025 18:18:18 GMT"},{"key":"x-envoy-upstream-service-time","value":"3269"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1962bbebeb8ea3cedd2c\",\n \"referenceUUID\": \"1962bbebeb8ea3cedd2c\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T18:18:15.806Z\",\n \"paymentMethod\": \"E_TRANSFER\",\n \"status\": \"PENDING\",\n \"action\": \"PAYOUT\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 46,\n \"total\": 46,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"name\": \"Angelica Sloan\",\n \"email\": \"nacipej999@bawsny.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"EMAIL\",\n \"securityQuestion\": \"name of dog\",\n \"securityAnswer\": \"*******\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 46,\n \"description\": \"12312\",\n \"price\": 46,\n \"quantity\": 1,\n \"sku\": \"123\"\n }\n ],\n \"interacUrl\": null,\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"2cbca125-c68a-4747-a589-0e063e5af87a"},{"name":"Refund","id":"584f038c-a7e7-4132-b183-3eea5ef10f7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"0340ee806130c6dfe6e7\",\n \"subtotal\": 7,\n \"transactionComment\": \"Request By Customer\",\n \"paymentDetails\": {\n \"name\": \"Franko Dunn\",\n \"email\": \"bolep35009@dpwev.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"EMAIL\",\n \"securityQuestion\": \"Dog Name\",\n \"securityAnswer\": \"Marcel\"\n },\n \"metadata\": {\n \"test\": \"metadata\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/e-transfer/refund","description":"

To Refund E-Transfer transaction, send a POST request to the /v1/transaction/e-transfer/refund endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`paymentDetails`	Object required	Contains all necessary information for processing an Interac e-Transfer payment.
├──── `name`	String required	The recipient’s full legal name, including both first and last names.
├──── `email`	String conditional	The recipient’s regular email address for a PAYOUT transaction refund, or the Interac-registered email address for a SALE transaction refund. Required if `deliveryType` is `EMAIL`.
├──── `phoneCode`	String conditional	The recipient’s country calling code (e.g., `+1` for Canada/USA). Required if `deliveryType` is `SMS`.
├──── `phoneNumber`	String conditional	The recipient’s regular phone number for a PAYOUT transaction refund, or the Interac-registered phone number for a SALE transaction refund. Required if `deliveryType` is `SMS`.
├──── `message`	String optional	A personal message to include with the Interac e-Transfer notification.
├──── `securityQuestion`	String conditional	The security question the recipient must answer to deposit the transfer.Required for a SALE transaction refund if the recipient does not have a Direct Deposit Registration (DDR).
├──── `securityAnswer`	String conditional	The answer to the security question. Must meet the following criteria:cannot contain spaces and length must be between 3 and 25 characters.Required only for a SALE transaction refund when `securityQuestion` is provided.
└──── `deliveryType`	String required	The notification delivery method. Possible values: `EMAIL`, `SMS`, or `NONE`. The value `NONE` is permitted only for SALE transaction refunds.
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being refunded.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Transaction ID.
`referenceUUID`	String	Transaction reference UUID.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`subscriptionId`	String	Subscription ID.
`transactionTime`	Date	Transaction time.
`paymentMethod`	String	Payment method used for the transaction.Possible values: `E-TRANSFER`.
`status`	String	Status of the transaction.Possible values: `APPROVED`, `DECLINED`, `PENDING`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `REFUND`.
`currency`	String	Transaction currency Possible values: `CAD`, `USD`
`fee`	Number Float to two decimal places	The amount of the BNA Smart Payment Systems payment processing fee. This amount is applied to the Customer when applyFee is ‘true’.
`subtotal`	Number Float to two decimal places	Total of amounts found in the cart items. Excludes BNA Smart Payment Systems applied fees, if any.
`total`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`amount`	Number Float to two decimal places	Total amount to be paid by Customer, includes subtotal plus BNA Smart Payment Systems applied fees when applyFee is ‘true’.
`balance`	Number Float to two decimal places	The available amount that can be refunded.
`paymentDetails`	Object	Contains detailed information about the payment.
`id`	String	Unique identifier for the customer's e-Transfer payment method.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","e-transfer","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3321d20c-28fa-452c-a84c-942783ba26b4","name":"Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"029f4f8864b12c2cc7d3\",\n \"subtotal\": 7,\n \"transactionComment\": \"Request By Customer\",\n \"paymentDetails\": {\n \"name\": \"Franko Dunn\",\n \"email\": \"bolep35009@dpwev.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"EMAIL\",\n \"securityQuestion\": \"Dog Name\",\n \"securityAnswer\": \"Marcel\"\n },\n \"metadata\": {\n \"test\": \"metadata\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-service.bnasmartpayment.com/v1/transaction/e-transfer/refund"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1769"},{"key":"x-trace-id","value":"64c2c3c183f30efb651f4693b8272a5d"},{"key":"date","value":"Tue, 16 Sep 2025 13:24:16 GMT"},{"key":"x-envoy-upstream-service-time","value":"3415"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"9127f9a89e73d855d4e3\",\n \"referenceUUID\": \"029f4f8864b12c2cc7d3\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777770\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-16T13:24:13.061Z\",\n \"paymentMethod\": \"E_TRANSFER\",\n \"status\": \"PENDING\",\n \"action\": \"REFUND\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"name\": \"Franko Dunn\",\n \"email\": \"bolep35009@dpwev.com\",\n \"message\": \"Request money\",\n \"deliveryType\": \"EMAIL\",\n \"securityQuestion\": \"Dog Name\",\n \"securityAnswer\": \"*******\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"interacUrl\": null,\n \"metadata\": {\n \"test\": \"metadata\"\n }\n}"}],"_postman_id":"584f038c-a7e7-4132-b183-3eea5ef10f7a"},{"name":"Cancel","id":"b40cce11-c85f-4f7b-9e11-8164534bdc85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"9fe21583865362c24e89\",\n \"transactionComment\": \"thank you\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/e-transfer/cancel","description":"

To cancel an E-Transfer transaction, send a POST request to the /v1/transaction/e-transfer/cancel endpoint with the Basic credentials included in the header.

Transactions that have reached a terminal status—such as being completed or already cancelled—cannot be cancelled again.

Only transactions with a status of PENDING are eligible for cancellation.

Please note that while the cancellation is processed immediately on Interac's end once the request is successful, the transaction status in our system may take up to 10 minutes to reflect the update.

This section details the parameters required for the Cancel transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being canceled.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all relevant information about the customer.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Country calling code of the customer.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birth date in ISO 8601 format.
├── `legalName`	String	Legal business name of the customer. For business customers.
├── `businessIdNumber`	String	Legal business number of the customer. For business customers.
├── `businessName`	String	Business name of the customer. For business customers.
├── `companyName`	String	Legal company name of the customer. For business customers.
├── `registrationName`	String	Legal registration name of the customer. For business customers.
├── `retailName`	String	Legal retail name of the customer. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`subscriptionId`	String	Unique identifier for the subscription.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `E_TRANSFER`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `CANCEL`.
`currency`	String	Currency of the transaction. Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be canceled.
`paymentDetails`	Object	Contains detailed information about the payment.
`id`	String	Unique identifier for the customer's e-Transfer payment method.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","e-transfer","cancel"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"9d826ff2-c2e7-42cc-ba42-e45eef6c122e","name":"Cancel","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"9fe21583865362c24e89\",\n \"transactionComment\": \"thank you\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage-api-service.bnasmartpayment.com/v1/transaction/e-transfer/cancel","protocol":"https","host":["stage-api-service","bnasmartpayment","com"],"path":["v1","transaction","e-transfer","cancel"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1872"},{"key":"x-trace-id","value":"4b21331bf2c008dcdeab578e27e3a556"},{"key":"date","value":"Mon, 15 Sep 2025 18:19:09 GMT"},{"key":"x-envoy-upstream-service-time","value":"1677"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ebf170f95ad1df25f1f5\",\n \"referenceUUID\": \"9fe21583865362c24e89\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T18:19:07.890Z\",\n \"paymentMethod\": \"E_TRANSFER\",\n \"status\": \"PENDING\",\n \"action\": \"CANCEL\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"name\": \"Angelica Sloan\",\n \"phoneNumber\": \"4167777777\",\n \"phoneCode\": \"+1\",\n \"message\": \"Request money\",\n \"deliveryType\": \"SMS\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": \"thank you\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"b40cce11-c85f-4f7b-9e11-8164534bdc85"},{"name":"Check Direct Deposit Registration (DDR)","id":"9b3cc8da-3634-4862-9325-4b5cd444d311","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/e-transfer/ddr?email={{email}}","description":"

Interac e-Transfer Autodeposit is a feature in Canada that allows money sent via Interac e-Transfer to be automatically deposited into customer's bank account—without having to answer a security question.

To check Direct Deposit Registration, send a GET request to the /v1/e-transfer/ddr?email={{email}} endpoint with the Basic credentials included in the header.

Query parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`email`	String required	Customer's Interac e-transfer email

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`hasDDR`	Boolean	This field indicated if customer's Interac e-transfer email has DDR.Possible values: `true` or `false`.

","urlObject":{"path":["v1","e-transfer","ddr"],"host":["{{base_url}}"],"query":[{"key":"email","value":"{{email}}"}],"variable":[]}},"response":[{"id":"b118b16b-62db-4c53-854a-0098aa1f5f1d","name":"Check Direct Deposit Registration (DDR)","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/e-transfer/ddr?email={{email}}","host":["{{base_url}}"],"path":["v1","e-transfer","ddr"],"query":[{"key":"email","value":"{{email}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"16"},{"key":"x-trace-id","value":"700d134c8f0f9c508feedd8e09397aa8"},{"key":"date","value":"Mon, 15 Sep 2025 18:22:03 GMT"},{"key":"x-envoy-upstream-service-time","value":"480"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"hasDDR\": false\n}"}],"_postman_id":"9b3cc8da-3634-4862-9325-4b5cd444d311"}],"id":"e2566024-b4d3-4d25-94e9-6368126c4f7e","description":"

Overview: E-Transfer - Create Payment API

The e-Transfer Create Payment API allows the merchant to initiate an E-TRANSFER payment through BNA Smart Payment. E-TRANSFER payments may be one-time payments or recurring payments. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

\n","_postman_id":"e2566024-b4d3-4d25-94e9-6368126c4f7e"},{"name":"Cash","item":[{"name":"Sale","id":"f6bb9070-555d-4efe-a532-e6016335b43e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \n \"city\": \"Richmond\",\n \n \n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cash/sale","description":"

To create a Cash Sale transaction send a POST request to the /v1/transaction/cash/sale endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10). It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a descriptio

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name.
├── `companyName`	String	Customer's legal company name.
├── `registrationName`	String	Customer's legal registration name.
├── `retailName`	String	Customer's legal retail name.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `CASH`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `SALE`.
`currency`	String	Currency of the transaction. Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be paid.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","cash","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0af5afeb-07b1-4cb4-a3bd-d5aae7d77b58","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cash/sale"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1524"},{"key":"x-trace-id","value":"efaca2138602dbab855c6618699e485a"},{"key":"date","value":"Mon, 15 Sep 2025 16:53:50 GMT"},{"key":"x-envoy-upstream-service-time","value":"535"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"3037c4aacab117c79315\",\n \"referenceUUID\": \"3037c4aacab117c79315\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"transactionTime\": \"2025-09-15T16:53:49.696Z\",\n \"paymentMethod\": \"CASH\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": null,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {}\n}"}],"_postman_id":"f6bb9070-555d-4efe-a532-e6016335b43e"},{"name":"Payout","id":"6ecaf8f2-e123-4e34-b4ce-a0b57e0de7d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cash/payout","description":"

To create a Cash Payout transaction, send a POST request to the /v1/transaction/cash/payout endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit). It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10). It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name.
├── `businessIdNumber`	String	Customer's legal business number. Required for business customers.
├── `businessName`	String	Customer's business name.
├── `companyName`	String	Customer's legal company name.
├── `registrationName`	String	Customer's legal registration name.
├── `retailName`	String	Customer's legal retail name.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `cash`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `PAYOUT`.
`currency`	String	Currency of the transaction.Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be paid.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","cash","payout"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3a4905c2-6906-44a3-b569-9fe114d28b0d","name":"Payout","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cash/payout"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1496"},{"key":"x-trace-id","value":"bc0a2d0bbe7193737af95b0524cbd6a8"},{"key":"date","value":"Fri, 19 Sep 2025 11:56:50 GMT"},{"key":"x-envoy-upstream-service-time","value":"846"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"7f4e7dd9ff45eaf5970b\",\n \"referenceUUID\": \"7f4e7dd9ff45eaf5970b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"field1\",\n \"field2\": \"field2\",\n \"field3\": \"field3\",\n \"field4\": \"field4\",\n \"field5\": \"field5\",\n \"field6\": \"field6\"\n }\n },\n \"transactionTime\": \"2025-09-19T11:56:49.317Z\",\n \"paymentMethod\": \"CASH\",\n \"status\": \"APPROVED\",\n \"action\": \"PAYOUT\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": null,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {}\n}"}],"_postman_id":"6ecaf8f2-e123-4e34-b4ce-a0b57e0de7d4"},{"name":"Refund","id":"645cbd2d-8ccb-4bb2-a166-2d8faa1a50ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"3037c4aacab117c79315\",\n \"subtotal\": 7,\n \"transactionComment\": \"hello\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cash/refund","description":"

To Refund a Cash transaction, send a POST request to the /v1/transaction/cash/refund endpoint with the Basic credentials included in the header.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`referenceUUID`	String required	Unique reference UUID for the transaction.
`subtotal`	Number Float to two decimal places required	Subtotal amount of the items in the cart, excluding any applied fees.
`transactionComment`	String required	Merchant's internal transaction comment.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name.For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name.For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name.For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction.Possible values: `CASH`.
`status`	String	Status of the transaction.Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `REFUND`.
`currency`	String	Currency of the transaction.Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be refunded.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","cash","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e1613160-917c-4d4f-9700-c4603bb9ad36","name":"Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"3037c4aacab117c79315\",\n \"subtotal\": 7,\n \"transactionComment\": \"Customer Request\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cash/refund"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1526"},{"key":"x-trace-id","value":"b1c257db027ad035bde4b71c60c9b11f"},{"key":"date","value":"Mon, 15 Sep 2025 16:56:05 GMT"},{"key":"x-envoy-upstream-service-time","value":"757"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"aa69d5d39d6ac3967d07\",\n \"referenceUUID\": \"3037c4aacab117c79315\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"transactionTime\": \"2025-09-15T16:56:04.500Z\",\n \"paymentMethod\": \"CASH\",\n \"status\": \"APPROVED\",\n \"action\": \"REFUND\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": null,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {}\n}"}],"_postman_id":"645cbd2d-8ccb-4bb2-a166-2d8faa1a50ff"},{"name":"Update Status","id":"a85ff21a-93ba-4314-807a-78e1e9bba516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"APPROVED\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/:transactionId/status","description":"

To Update Cash transaction status, send a GET request to the /v1/transaction/:transactionId/status endpoint with the Basic credentials included in the header.

This section details the parameters required for the updating Cash transaction status API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`transactionId`	String required	Unique Identifier of a transaction

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`status`	String required	Status of the transaction.Possible values: `APPROVED`, `DECLINED`.
`transactionComment`	String conditional	The reason for the transaction being changed the status Required for changing the transaction status for `DECLINED`

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name.For business customers.
├── `companyName`	String	Customer's legal company name.For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`subscriptionId`	String	Unique identifier for the subscription.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `CASH`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `SALE`.
`currency`	String	Currency of the transaction.Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be refunded.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction",":transactionId","status"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{transactionId}}","key":"transactionId"}]}},"response":[{"id":"3063f743-5243-46dc-b135-6ce94061dfc2","name":"Update Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"DECLINED\",\n \"transactionComment\": \"requested by customer\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage-api-service.bnasmartpayment.com/v1/transaction/:transactionId/status","protocol":"https","host":["stage-api-service","bnasmartpayment","com"],"path":["v1","transaction",":transactionId","status"],"variable":[{"key":"transactionId","value":"{{transactionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jan 2025 14:14:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1430"},{"key":"Connection","value":"keep-alive"},{"key":"x-trace-id","value":"7280e7e2165badb12e6f3cdb22a05ef8"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f433662709e35a594536\",\n \"referenceUUID\": \"f433662709e35a594536\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167768900\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"address\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-01-27T11:19:22.000Z\",\n \"paymentMethod\": \"CASH\",\n \"status\": \"DECLINED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": null,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": \"requested by customer\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456\n }\n}"}],"_postman_id":"a85ff21a-93ba-4314-807a-78e1e9bba516"}],"id":"84403d8a-cb51-4912-a558-627cf6a7c7b3","description":"

Overview: Cash - Create Payment API

The Cash Create Payment API allows the merchant to initiate a CASH payment through BNA Smart Payment Systems. CASH payments may be one-time payments or recurring payments. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

\n","_postman_id":"84403d8a-cb51-4912-a558-627cf6a7c7b3"},{"name":"Cheque","item":[{"name":"Sale","event":[{"listen":"test","script":{"id":"a1e6b92a-24ca-4aaa-b779-34c5cbb66d6a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a2d2ecfc-d437-44f3-b780-02db49387fb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cheque/sale","description":"

To create a Cheque Sale transaction, send a POST request to the /v1/transaction/cheque/sale endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name. Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object conditional	Contains information about the payment details. Required if the customer ID is not provided.
`chequeNumber`	String required	Customer's cheque number.
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit). It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10). It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name.For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`subscriptionId`	String	Unique identifier for the subscription.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `CHEQUE`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `SALE`.
`currency`	String	Currency of the transaction. Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be paid.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`paymentDetails`	Object	Payment details of a cheque transaction.
├── `chequeNumber`	String	Cheque number.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit. It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10. It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","cheque","sale"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6e394de3-7138-4dd7-9ba9-6f763187ba2a","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cheque/sale"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1715"},{"key":"x-trace-id","value":"cfec9b7db65ffc3de3b065f911abfbdf"},{"key":"date","value":"Mon, 15 Sep 2025 17:01:43 GMT"},{"key":"x-envoy-upstream-service-time","value":"552"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"47f5bab7a7af6143360a\",\n \"referenceUUID\": \"47f5bab7a7af6143360a\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"transactionTime\": \"2025-09-15T17:01:43.515Z\",\n \"paymentMethod\": \"CHEQUE\",\n \"status\": \"PENDING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"a2d2ecfc-d437-44f3-b780-02db49387fb3"},{"name":"Payout","id":"8a6fea0a-87af-4a97-8c0b-28aed6444dcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cheque/payout","description":"

To create a Cheque Payout transaction, send a POST request to the /v1/transaction/cheque/payout endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String optional	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String optional	Customer's country calling code.
├── `phoneNumber`	String optional	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name. Required for business customers.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name. Required for business customers.
├── `companyName`	String conditional	Customer's legal company name. Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name. Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name. Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├──`shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String optional	Customer's street number.
├──── `streetName`	String optional	Customer's street name.
├──── `city`	String optional	Customer's city.
├──── `province`	String optional	Customer's province/state.
├──── `country`	String optional	Customer's country.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	Contains the customer's additional information.
├── `field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`paymentDetails`	Object conditional	Contains information about the payment details. Required id the customer ID is not provided.
`chequeNumber`	String required	Customer's cheque number.
`items`	Array	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String	The SKU of the item.
├── `price`	Number Float to two decimal places	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer	The number of units purchased.
└── `amount`	Number Float to two decimal places	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`transactionComment`	String optional	Merchant's internal transaction comment.
`metadata`	Object optional	Contains up to ten \"metadata\" properties of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name.For business customers.
├── `registrationName`	String	Customer's legal registration name.For business customers.
├── `retailName`	String	Customer's legal retail name.For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`paymentDetails`	Object	Payment details of a cheque transaction.
├── `chequeNumber`	String	Customer's cheque number.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `CHEQUE`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `SALE`.
`currency`	String	Currency of the transaction. Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be paid.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10.It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","cheque","payout"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3037f833-5acb-4d20-b8d2-fbb2039ab430","name":"Payout","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"applyFee\": false,\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cheque/payout"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1717"},{"key":"x-trace-id","value":"81749bc82ce68aedffb7d50643dce974"},{"key":"date","value":"Mon, 15 Sep 2025 17:02:25 GMT"},{"key":"x-envoy-upstream-service-time","value":"525"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"bb92fad66e213419df90\",\n \"referenceUUID\": \"bb92fad66e213419df90\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"transactionTime\": \"2025-09-15T17:02:24.911Z\",\n \"paymentMethod\": \"CHEQUE\",\n \"status\": \"PENDING\",\n \"action\": \"PAYOUT\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"8a6fea0a-87af-4a97-8c0b-28aed6444dcb"},{"name":"Refund","id":"fb71f454-1a08-4354-8a6d-26b31743317a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"307290b828fbcfc69857\",\n \"subtotal\": 7,\n \"transactionComment\": \"thank you\",\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cheque/refund","description":"

To Refund a Cheque transaction, send a POST request to the /v1/transaction/cheque/refund endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subtotal`	Number Float to two decimal places required	The amount to be refunded. This can be a partial or full amount of the original transaction.
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being refunded.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name.For business customers.
├── `retailName`	String	Customer's legal retail name.For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`subscriptionId`	String	Unique identifier for the subscription.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction.Possible values: `CHEQUE`.
`status`	String	Status of the transaction.Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `REFUND`.
`currency`	String	Currency of the transaction.Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be refunded to the customer, excluding applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be refunded.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","cheque","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c01fae2b-7044-4965-91e4-150f5fef88fb","name":"Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"307290b828fbcfc69857\",\n \"subtotal\": 7,\n \"transactionComment\": \"Cheque Refund\",\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cheque/refund"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1679"},{"key":"x-trace-id","value":"61d3378a45f40cbd9f30a44351c49370"},{"key":"date","value":"Mon, 15 Sep 2025 17:29:18 GMT"},{"key":"x-envoy-upstream-service-time","value":"809"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2ac314efa2df3de1a2e5\",\n \"referenceUUID\": \"307290b828fbcfc69857\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"transactionTime\": \"2025-09-15T17:29:17.341Z\",\n \"paymentMethod\": \"CHEQUE\",\n \"status\": \"PENDING\",\n \"action\": \"REFUND\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"fb71f454-1a08-4354-8a6d-26b31743317a"},{"name":"Cancel","id":"e942f2ee-e689-4781-989e-a4e5461b13a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"db7ab53b1da4680635f5\",\n \"transactionComment\": \"hello\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/cheque/cancel","description":"

To cancel a Cheque transaction, send a POST request to the /v1/transaction/cheque/cancel endpoint with the Basic credentials included in the header.

This section details the parameters required for the refund transaction API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`referenceUUID`	String required	The unique reference UUID of the original transaction.
`transactionComment`	String required	The reason for the transaction being canceled.
`metadata`	Object optional	Contains up to ten metadata properties, which can be of type String, Boolean, Null, or Number.

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`subscriptionId`	String	Unique identifier for the subscription.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction. Possible values: `CHEQUE`.
`status`	String	Status of the transaction. Possible values: `APPROVED`, `DECLINED`, `PENDING`, `BATCHED`, `EXPIRED`, `UNDERPAID`, `OVERPAID`, `CANCELED`, `ERROR`.
`action`	String	Action taken for the transaction. Possible values: `CANCEL`.
`currency`	String	Currency of the transaction.Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be refunded.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10.It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction","cheque","cancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ba77dd78-ded7-43ad-8c8b-1adcdde05b74","name":"Cancel","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"referenceUUID\": \"db7ab53b1da4680635f5\",\n \"transactionComment\": \"Customer Request\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-service.bnasmartpayment.com/v1/transaction/cheque/cancel"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1764"},{"key":"x-trace-id","value":"69981d9a6e081e63524fdd1e76eaf8e9"},{"key":"date","value":"Mon, 15 Sep 2025 17:31:45 GMT"},{"key":"x-envoy-upstream-service-time","value":"363"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"db7ab53b1da4680635f5\",\n \"referenceUUID\": \"db7ab53b1da4680635f5\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T17:31:30.324Z\",\n \"paymentMethod\": \"CHEQUE\",\n \"status\": \"CANCELED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": \"Customer Request\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"e942f2ee-e689-4781-989e-a4e5461b13a5"},{"name":"Update Status","id":"97d433ff-778b-4010-9ec7-73f12867db4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"DECLINED\",\n \"transactionComment\": \"Requested by Customer\"\n \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/:id/status","description":"

To update cheque transaction status, send a GET request to the /v1/transaction/:transactionId/status endpoint with the Basic credentials included in the header.

This section details the parameters required for the Update Cheque transaction status API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`transactionId`	String required	Unique Identifier of transaction.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`status`	String required	Status of the transaction.Possible values: `APPROVED`, `DECLINED`.
`transactionComment`	String conditional	The reason for the transaction being changed the status Required for changing the status for `DECLINED`
`chequeNumber`	String conditional	Cheque number Required for changing the status for `APPROVED`

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Response parameters

Option	Type	Description
`id`	String	Unique identifier for the transaction.
`referenceUUID`	String	Unique reference UUID for the transaction.
`customerId`	String	Unique identifier for the customer.
`customerInfo`	Object	Contains all customer information. Required if the Customer ID is not provided.
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email address.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's date of birth.
├── `legalName`	String	Customer's legal business name. For business customers.
├── `businessIdNumber`	String	Customer's legal business number. For business customers.
├── `businessName`	String	Customer's business name. For business customers.
├── `companyName`	String	Customer's legal company name. For business customers.
├── `registrationName`	String	Customer's legal registration name. For business customers.
├── `retailName`	String	Customer's legal retail name. For business customers.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	Contains additional information about the customer.
├── `field1 - field6`	String	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`transactionTime`	Date	Timestamp of the transaction.
`paymentMethod`	String	Payment method used for the transaction.Possible values: `CHEQUE`.
`status`	String	Status of the transaction.Possible values: `APPROVED`, `DECLINED`, `ERROR`.
`action`	String	Action taken for the transaction.Possible values: `SALE`, `PAYOUT`, `REFUND`, `CANCEL`.
`currency`	String	Currency of the transaction. Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places	Available amount that can be refunded.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	Unique identifier for the invoice.
└── `invoiceAdditionalInfo`	String	Additional information related to the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	Unique identifier for the contract.
├── `contractAdditionalInfo`	String	Additional information related to the contract.
├── `contractStartDate`	Date	Start date of the contract.
└── `contractExpireDate`	Date	Expiration date of the contract.
`transactionComment`	String	Comment related to the transaction.
`items`	Array	Array of cart items, each item is an object. Must contain at least one item.
├── `description`	String	Name of the item being purchased, displayed to the customer.
├── `sku`	String	Stock Keeping Unit (SKU) of the item.
├── `price`	Number Float to two decimal places	Unit price of the item without currency symbol. e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	Number of units purchased.
└── `amount`	Number Float to two decimal places	Total amount for the item, calculated as unit price multiplied by quantity. e.g., if the unit price is 10.55 and the quantity is 2, the amount is 21.10.It could be positive and negative number.
`metadata`	Object	Contains up to ten metadata properties of type String, Boolean, Null, or Number.

","urlObject":{"path":["v1","transaction",":id","status"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{transactionId}}","key":"id"}]}},"response":[{"id":"23f000cf-e4a4-48cd-85c9-ce8ca282694e","name":"Update Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"APPROVED\",\n \"chequeNumber\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/transaction/:id/status","host":["{{base_url}}"],"path":["v1","transaction",":id","status"],"variable":[{"key":"id","value":"{{transactionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1764"},{"key":"x-trace-id","value":"6bcd5752e44ea788f8216a9673d53221"},{"key":"date","value":"Mon, 15 Sep 2025 17:28:00 GMT"},{"key":"x-envoy-upstream-service-time","value":"407"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"307290b828fbcfc69857\",\n \"referenceUUID\": \"307290b828fbcfc69857\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T17:26:56.910Z\",\n \"paymentMethod\": \"CHEQUE\",\n \"status\": \"APPROVED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 7,\n \"balance\": 7,\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"},{"id":"f0732050-abc9-4a1d-b293-4ee3aa9f491f","name":"Update Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"DECLINED\",\n \"transactionComment\": \"Requested by Customer\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/transaction/:id/status","host":["{{base_url}}"],"path":["v1","transaction",":id","status"],"variable":[{"key":"id","value":"{{transactionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"1783"},{"key":"x-trace-id","value":"86156e91ff839f36f4c4a12f5fde75ae"},{"key":"date","value":"Mon, 15 Sep 2025 19:31:40 GMT"},{"key":"x-envoy-upstream-service-time","value":"396"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"6891cff2bd42e265ad0e\",\n \"referenceUUID\": \"6891cff2bd42e265ad0e\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-15T19:30:29.134Z\",\n \"paymentMethod\": \"CHEQUE\",\n \"status\": \"DECLINED\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 0,\n \"subtotal\": 7,\n \"total\": 7,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"chequeNumber\": \"1\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"transactionComment\": \"Requested by Customer\",\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"97d433ff-778b-4010-9ec7-73f12867db4c"}],"id":"355c4444-ea11-42ca-a6a9-27abcdc37a78","description":"

Overview: Cheque - Create Payment API

The Cheque Create Payment API allows the merchant to initiate a CHEQUE payment through BNA Smart Payment Systems. CHEQUE payments may be one-time payments or recurring payments. All related Customer and payment information are automatically deleted from the system when the requested transactions are completed.

\n","_postman_id":"355c4444-ea11-42ca-a6a9-27abcdc37a78"},{"name":"Notifications","item":[{"name":"Transaction receipt by email","id":"637b818d-9f9f-4a68-b072-c7658aa4ad25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/transaction/:transactionId/email-receipt","description":"

A transaction receipt by email is a digital confirmation sent to a customer or recipient after a financial transaction has been completed. It serves as proof of payment or receipt of funds, and includes important details about the transaction.

Information Included:

Sender’s Name or Business Name
\n
Recipient’s Name
\n
Transaction Amount
\n
Date and Time of Transaction
\n
Transaction ID or Reference Number
\n
Payment Method (e.g., Interac e-Transfer, Credit Card, Bank Transfer)
\n
Description or Purpose of Payment
\n
Status (e.g., Successful, Pending, Failed)
\n

To send a transaction receipt by email, send a POST request to the v1/transaction/:transactionId/email-receipt endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the options available for developers to create a subscription. Each option includes its type and a description.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`transactionId`	String required	Unique Identifier of transaction.

","urlObject":{"path":["v1","transaction",":transactionId","email-receipt"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{transactionId}}","key":"transactionId"}]}},"response":[{"id":"6224b124-6728-44c7-bd8b-e2b86b3efed0","name":"Transaction receipt by email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/transaction/:transactionId/email-receipt","host":["{{base_url}}"],"path":["v1","transaction",":transactionId","email-receipt"],"variable":[{"key":"transactionId","value":"{{transactionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"2"},{"key":"x-trace-id","value":"ac6662157dbd7cd00fb55e29b4dfc096"},{"key":"date","value":"Mon, 15 Sep 2025 17:30:44 GMT"},{"key":"x-envoy-upstream-service-time","value":"100"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"637b818d-9f9f-4a68-b072-c7658aa4ad25"}],"id":"3058b902-43fb-4367-ab24-8b6325e74339","description":"

Overview: Notifications API

The Notifications API allows merchants and integrated systems to automatically trigger and send digital receipts to customers via email upon successful transactions. This functionality ensures timely and consistent delivery of receipts, enhancing the customer experience and reducing the need for manual receipt handling.

With this API, developers can:

Send email receipts for completed purchases, refunds, or other transaction events.
\n
Customize the content, branding, and language of the email receipt.
\n
Track the delivery status of each notification for auditing or troubleshooting.
\n

Typical use cases include:

Sending purchase confirmations immediately after payment.
\n
Providing proof of refund to the customer.
\n
Notifying customers of recurring subscription charges.
\n

This API supports secure, reliable delivery and is compliant with email standards and customer privacy best practices.

\n","_postman_id":"3058b902-43fb-4367-ab24-8b6325e74339"}],"id":"60e8cc93-613e-4fb0-9fcd-823f1c687045","description":"

Overview: Create Payment API

The Create Payment API allows a merchant to initiate a payment using any of BNA Smart Payment payment methods — E-TRANSFER, CREDIT CARD, DIRECT DEBIT,BANK TRANSFER,CASH,CHEQUE and so on. In order to process a transaction, the API collects information temporarily about the Customer and the payment method being used. The API does not save this information; when the requested transactions are completed, all related Customer and payment information are automatically deleted from the system.

Definitions:

A ‘Customer’ is a customer or donor making a payment to the merchant.

\n","_postman_id":"60e8cc93-613e-4fb0-9fcd-823f1c687045"},{"name":"Payment Links","item":[{"name":"Report","item":[{"name":"Retrieve Payment Link List","id":"df76730f-2129-4d91-86f2-d9cf1e50633d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/payment-links?status=PENDING&limit=3","description":"

Overview: Retrieve Payment Links List API

The Retrieve Payment Links List API enables a Merchant to inspect, through their website, all Payment Links hosted on the Merchant Portal.

The primary function of the Retrieve Payment Links List API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

Definitions:

To retrieve all Payment Links, send a GET request to the v1/payment-links endpoint with the Basic credentials included in the header.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	String optional	Filter by transaction ID
`status`	String optional	Filter by transaction status.Possible values: `PENDING` , `PAID`, `EXPIRED` , `DECLINED` ,`CANCELED`, `ERROR`, `INPROCESS`.
`page`	Integer optional	Page number to retrieve.
`limit`	Integer optional	Number of records per page.

Response parameters

Option	Type	Description
`data`	Array	An array of objects.
`id`	String	The unique identifier for the payment link.
`status`	String	Filters transactions based on their status.Possible values: `PENDING` , `PAID`, `EXPIRED` , `DECLINED` ,`CANCELED`, `ERROR`, `INPROCESS`.
`currency`	String	The currency of the transaction.Possible values: `CAD`, `USD`.
`applyFee`	Boolean	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer.Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`customerContactType`	String	The method by which the customer will be contacted.Possible values: `EMAIL`, `PHONE`.
`customerContact`	String	The customer's email address or phone number, including the country code.
`recurring`	Boolean	Specifies if the payment link is for a recurring payment.Possible values: `true` or `false`.
`recurrence`	String	The frequency of the recurring payment. This field is required if `recurring` is set to `true`.Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	The invoice number.
└── `invoiceAdditionalInfo`	String	Additional information about the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	The contract number.
├── `contractAdditionalInfo`	String	Additional information about the contract.
├── `contractStartDate`	Date	The start date of the contract.
└── `contractExpireDate`	Date	The expiration date of the contract.
`paymentMethod`	String	The payment method chosen by the customer. This field is required if the `status` is set to `PAID`.
`paymentMethods`	Array	An array of preferred payment methods by the merchant. Must contain at least one payment method.Possible values: `CARD`, `EFT`, `E_TRANSFER`
`subtotal`	Number Float to two decimal places	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`items`	Array	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String	The name of the item being purchased, displayed to the customer.
├── `sku`	String	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places	The unit price of the item, without the currency symbol e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units being purchased.
└── `amount`	String	The per-unit price for the given item multiplied by the quantity.It could be positive and negative number.
`token`	String	The token for the payment link.
`expirationTime`	Date ISO 8601	The expiration time of the payment link, in UTC.
`processTime`	Date ISO 8601	The processing time of the payment link, in UTC. This field is required if the `status` is set to `PAID`.
`reason`	String	The reason for a declined payment link. This field is required if the `status` is set to `DECLINED`.
`paymentUrl`	String	The URL for the payment link.
`pages`	Object	Contains all the pagination details.
`totalRows`	Number	The total count of rows in the list.
`pageTotal`	Number	The total number of pages.
`pageNum`	Number	The current page number.
`pageSize`	Number	The number of rows per page.

","urlObject":{"path":["v1","payment-links"],"host":["{{base_url}}"],"query":[{"key":"status","value":"PENDING"},{"key":"limit","value":"3"}],"variable":[]}},"response":[{"id":"89bcfe17-0485-4172-943a-313d6aa1eaa0","name":"Retrieve Payment Link list","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/payment-links?status=PENDING&limit=3","host":["{{base_url}}"],"path":["v1","payment-links"],"query":[{"key":"status","value":"PENDING"},{"key":"limit","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"2758"},{"key":"x-trace-id","value":"60485bfe124728f7339aca445e52bc74"},{"key":"date","value":"Wed, 17 Sep 2025 16:36:20 GMT"},{"key":"x-envoy-upstream-service-time","value":"31"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5b414b3e356e26c5cc372635\",\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"customerContact\": \"+1 4165556666\",\n \"customerContactType\": \"PHONE\",\n \"recurring\": false,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentMethod\": null,\n \"paymentMethods\": [\n \"CARD\",\n \"E_TRANSFER\",\n \"EFT\"\n ],\n \"subtotal\": 7,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"PENDING\",\n \"token\": \"48c1ffe1db18a90cfddb126de40f9ec8e5db6631\",\n \"expirationTime\": \"2025-09-27T16:36:05.060Z\",\n \"processTime\": null,\n \"paymentUrl\": \"https://payment-stage.bnasmartpayment.com?token=48c1ffe1db18a90cfddb126de40f9ec8e5db6631\"\n },\n {\n \"id\": \"c0e8d40049d20b9c26818179\",\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"customerContact\": \"ponebov818@ncien.com\",\n \"customerContactType\": \"EMAIL\",\n \"recurring\": false,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentMethod\": null,\n \"paymentMethods\": [\n \"CARD\",\n \"E_TRANSFER\",\n \"EFT\"\n ],\n \"subtotal\": 7,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"PENDING\",\n \"token\": \"3f30bf6b871a4721f803d84621eb440718419c00\",\n \"expirationTime\": \"2025-09-27T16:16:20.157Z\",\n \"processTime\": null,\n \"paymentUrl\": \"https://payment-stage.bnasmartpayment.com?token=3f30bf6b871a4721f803d84621eb440718419c00\"\n },\n {\n \"id\": \"1e7b8c0cf1657a6424ef4b49\",\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"customerContact\": \"ponebov818@ncien.com\",\n \"customerContactType\": \"EMAIL\",\n \"recurrence\": \"MONTHLY\",\n \"recurring\": true,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentMethod\": null,\n \"paymentMethods\": [\n \"CARD\",\n \"E_TRANSFER\",\n \"EFT\"\n ],\n \"subtotal\": 7,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"PENDING\",\n \"token\": \"e807488b0a8f7bfd142e33365673171e343d4843\",\n \"expirationTime\": \"2025-09-27T15:00:23.737Z\",\n \"processTime\": null,\n \"paymentUrl\": \"https://payment-stage.bnasmartpayment.com?token=e807488b0a8f7bfd142e33365673171e343d4843\"\n }\n ],\n \"pages\": {\n \"totalRows\": 7,\n \"pageTotal\": 3,\n \"pageNum\": 1,\n \"pageSize\": 3\n }\n}"}],"_postman_id":"df76730f-2129-4d91-86f2-d9cf1e50633d"},{"name":"Retrieve Payment Link by ID","id":"8088513c-3b38-4608-882a-0fc0d7cc1107","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/payment-links/:linkId","description":"

Overview: Retrieve Payment Link by ID API

The Retrieve Payment Link by ID API enables a Merchant to inspect, through their website, a Payment Link hosted on the Merchant Portal.

The primary function of the Retrieve Payment Link by ID API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

Definitions:

To retrieve a Payment Link by ID, send a GET request to the v1/payment-links/:linkId endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`linkId`	String required	Filter by link ID

Response parameters

Option	Type	Description
`id`	String	The unique identifier for the payment link.
`status`	String	Filters transactions based on their status.Possible values: `PENDING`, `PAID`, `EXPIRED`, `DECLINED`, `CANCELED`, `ERROR`, `INPROCESS`.
`currency`	String	The currency of the transaction.Possible values: `CAD`, `USD`.
`applyFee`	Boolean	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer.Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`customerContactType`	String	The method by which the customer will be contacted.Possible values: `EMAIL`, `PHONE`.
`customerContact`	String	The customer's email address or phone number, including the country code.
`recurring`	Boolean	Specifies if the payment link is for a recurring payment.Possible values: `true` or `false`.
`recurrence`	String	The frequency of the recurring payment. This field is required if `recurring` is set to `true`. Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	The invoice number.
└── `invoiceAdditionalInfo`	String	Additional information about the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	The contract number.
├── `contractAdditionalInfo`	String	Additional information about the contract.
├── `contractStartDate`	Date	The start date of the contract.
└── `contractExpireDate`	Date	The expiration date of the contract.
`paymentMethod`	String	The payment method chosen by the customer. This field is required if the `status` is set to `PAID`.
`paymentMethods`	Array	An array of preferred payment methods by the merchant. Must contain at least one payment method.
`subtotal`	Number Float to two decimal places	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`items`	Array	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String	The name of the item being purchased, displayed to the customer.
├── `sku`	String	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places	The unit price of the item, without the currency symbol e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units being purchased.
└── `amount`	String	The per-unit price for the given item multiplied by the quantity.It could be positive and negative number.
`token`	String	The token for the payment link.
`expirationTime`	Date ISO 8601	The expiration time of the payment link, in UTC.
`processTime`	Date ISO 8601	The processing time of the payment link, in UTC. This field is required if the `status` is set to `PAID`.
`reason`	String	The reason for a declined payment link. This field is required if the `status` is set to `DECLINED`.
`paymentUrl`	String	The URL for the payment link.

","urlObject":{"path":["v1","payment-links",":linkId"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{linkId}}","key":"linkId"}]}},"response":[{"id":"db8f1a09-64bd-4788-b397-557423da99d1","name":"Retrieve Payment Link by ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/payment-links/:linkId","host":["{{base_url}}"],"path":["v1","payment-links",":linkId"],"variable":[{"key":"linkId","value":"{{linkId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"911"},{"key":"x-trace-id","value":"ff9f8bfcafa71d161a265a775ef6a00e"},{"key":"date","value":"Wed, 17 Sep 2025 14:57:08 GMT"},{"key":"x-envoy-upstream-service-time","value":"80"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"01cb7bfcafda8a7c387aac9c\",\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"customerContact\": \"ponebov818@ncien.com\",\n \"customerContactType\": \"EMAIL\",\n \"recurrence\": \"MONTHLY\",\n \"recurring\": true,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentMethod\": null,\n \"paymentMethods\": [\n \"CARD\",\n \"E_TRANSFER\",\n \"EFT\"\n ],\n \"subtotal\": 7,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"PENDING\",\n \"token\": \"12549689ac07cc5b3cf011a104e68ce14bc52698\",\n \"expirationTime\": \"2025-09-26T14:39:40.255Z\",\n \"processTime\": null,\n \"paymentUrl\": \"https://payment-stage.bnasmartpayment.com?token=12549689ac07cc5b3cf011a104e68ce14bc52698\"\n}"}],"_postman_id":"8088513c-3b38-4608-882a-0fc0d7cc1107"}],"id":"a9029984-3c5a-492f-b38a-8ffd1b8875ba","description":"

Report APIs – Payment Links

These endpoints allow merchants to retrieve reports of generated payment links, either as a complete list or by specifying a particular Payment Link ID.

1. Retrieve Payment Link List

Returns a paginated list of all payment links created by the merchant. Filters can be applied based on parameters such as status, creation date, or customer reference.

2. Retrieve Payment Link by ID

Returns detailed information for a specific payment link identified by its unique ID.

\n","_postman_id":"a9029984-3c5a-492f-b38a-8ffd1b8875ba"},{"name":"Manage Payment Links","item":[{"name":"Create Payment Link","id":"e7b6606a-b182-4583-9ccd-ca56e27a5ff7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"customerContactType\": \"PHONE\",\n \"customerContact\": \"+1 4165556666\",\n \"paymentMethods\": [\n \"CARD\",\n \"E_TRANSFER\",\n \"EFT\"\n ],\n \"currency\": \"CAD\",\n \"expiryDays\": \"10\",\n \"subtotal\": 7,\n \"recurring\": false,\n \"applyFee\": false,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/payment-links","description":"

Overview: Create Payment Link API

The Create Payment Link API allows a user to create a payment link on the Merchant Portal. The ‘request’ includes Customer contact information, such as email or phone number,payment method, possible values: CARD,EFT,E_TRANSFER. The ‘response’ confirms whether or not the payment link was successfully created and returns a payment link ID, it's status,possible values: PENDING,PAID,EXPIRED,CANCELED,ERROR.

The Create Payment Link API is primarily used as described above. However, the Merchant has complete control over how the API is used and who has access to its use.

Definitions:

To create a Payment Link, send a POST request to the /v1/payment-links endpoint with the Basic credentials included in the header.

Request parameters

Option	Type	Description
`customerId`	String required	The ID of a customer
`customerContactType`	String required	Specifies the contact method through which the customer will receive the Payment Link. Possible values: `EMAIL`, `PHONE`.
`customerContact`	String conditional	Contains the contact details of the customer. If the `customerContactType` is `EMAIL`, this must be an email address. If the `customerContactType` is `PHONE`, it should be a phone number formatted as \"+1 111111111\", with the country code followed by the phone number, separated by a space. This field is required if `customerInfo` is not provided.
`expiryDays`	String required	Specifies the duration in days until the Payment Link expires (e.g., \"15\"). The maximum allowed value is 30.
`paymentMethods`	Array required	An array of strings representing payment methods accepted by the merchant. Must include at least one \"paymentMethod\" string.Possible values: `CARD`, `EFT`, `E_TRANSFER`. If `CARD` is included, Google Pay and Apple Pay will be automatically added as accepted payment methods.
`recurring`	Boolean required	Specifies if the payment is recurring or a one-time payment. Possible values: `true` or `false`.
`recurrence`	Object conditional	Specifies the frequency of recurring payments.Possible values: `DAILY`, `WEEKLY`, `BI-WEEKLY`, `MONTHLY`, `EVERY-3-MONTH`, `EVERY-6-MONTH`, `YEARLY`. This parameter is mandatory if the `recurring` parameter is set to true.
`startPaymentDate`	Date ISO 8601 optional	The start date for the recurring payment, in ISO 8601 format. This is used to delay the first recurring payment. If not specified, the first payment will occur immediately.
`remainingPayments`	Number Integer conditional	The number of payments that should occur in the recurring cycle. This parameter is mandatory if the `recurring` parameter is set to `true`.
`currency`	String ISO 4217	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated. Possible values: `CAD`, `USD`.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places required	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer required	The number of units purchased.
└── `amount`	Number Float to two decimal places required	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`invoiceInfo`	Object required	An object which contains additional information about the invoice.
├── `invoiceId`	String optional	Invoice number
└── `invoiceAdditionalInfo`	String optional	Invoice additional info
`contractInfo`	Object required	An object which contains additional information about the contract.
├── `contractId`	String optional	Contract number
├── `contractAdditionalInfo`	String optional	Contract additional info
├── `contractStartDate`	Date optional	Contract start date
└── `contractExpireDate`	Date optional	Contract expiration date

Response parameters

Option	Type	Description
`id`	String	The unique identifier for the payment link.
`status`	String	Filters transactions based on their status.Possible values: `PENDING`, `PAID`, `EXPIRED`, `DECLINED`, `CANCELED`, `ERROR`, `INPROCESS`.
`currency`	String	The currency of the transaction.Possible values: `CAD`, `USD`.
`applyFee`	Boolean	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer.Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`customerContactType`	String	The method by which the customer will be contacted.Possible values: `EMAIL`, `PHONE`.
`customerContact`	String	The customer's email address or phone number, including the country code.
`recurring`	Boolean	Specifies if the payment link is for a recurring payment.Possible values: `true` or `false`.
`recurrence`	String	The frequency of the recurring payment. This field is required if `recurring` is set to `true`. Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	The invoice number.
└── `invoiceAdditionalInfo`	String	Additional information about the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	The contract number.
├── `contractAdditionalInfo`	String	Additional information about the contract.
├── `contractStartDate`	Date	The start date of the contract.
└── `contractExpireDate`	Date	The expiration date of the contract.
`paymentMethod`	String	The payment method chosen by the customer. This field is required if the `status` is set to `PAID`.
`paymentMethods`	Array	An array of preferred payment methods by the merchant. Must contain at least one payment method.
`subtotal`	Number Float to two decimal places	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`items`	Array	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String	The name of the item being purchased, displayed to the customer.
├── `sku`	String	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places	The unit price of the item, without the currency symbol e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units being purchased.
└── `amount`	String	The per-unit price for the given item multiplied by the quantity.It could be positive and negative number.
`token`	String	The token for the payment link.
`expirationTime`	Date ISO 8601	The expiration time of the payment link, in UTC.
`processTime`	Date ISO 8601	The processing time of the payment link, in UTC. This field is required if the `status` is set to `PAID`.
`reason`	String	The reason for a declined payment link. This field is required if the `status` is set to `DECLINED`.
`paymentUrl`	String	The URL for the payment link.

","urlObject":{"path":["v1","payment-links"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"719490df-2cf1-4d22-9ccd-0041dab5a7c3","name":"Create Payment Link","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"customerContactType\": \"EMAIL\",\n \"customerContact\": \"ponebov818@ncien.com\",\n \"paymentMethods\": [\n \"CARD\",\n \"E_TRANSFER\",\n \"EFT\"\n ],\n \"currency\": \"CAD\",\n \"expiryDays\": \"10\",\n \"subtotal\": 7,\n \"recurring\": true,\n \"recurrence\": \"MONTHLY\",\n \"applyFee\": false,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/payment-links"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"911"},{"key":"x-trace-id","value":"470a303ca873cc08eab795803a671083"},{"key":"date","value":"Tue, 16 Sep 2025 14:39:40 GMT"},{"key":"x-envoy-upstream-service-time","value":"141"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"01cb7bfcafda8a7c387aac9c\",\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"customerContact\": \"ponebov818@ncien.com\",\n \"customerContactType\": \"EMAIL\",\n \"recurrence\": \"MONTHLY\",\n \"recurring\": true,\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"paymentMethod\": null,\n \"paymentMethods\": [\n \"CARD\",\n \"E_TRANSFER\",\n \"EFT\"\n ],\n \"subtotal\": 7,\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"PENDING\",\n \"token\": \"12549689ac07cc5b3cf011a104e68ce14bc52698\",\n \"expirationTime\": \"2025-09-26T14:39:40.255Z\",\n \"processTime\": null,\n \"paymentUrl\": \"https://payment-stage.bnasmartpayment.com?token=12549689ac07cc5b3cf011a104e68ce14bc52698\"\n}"}],"_postman_id":"e7b6606a-b182-4583-9ccd-ca56e27a5ff7"},{"name":"Cancel Payment Link","id":"f025ea59-8e30-40bc-a1fc-4d16a4163f01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"reason\": \"Requested by Customer\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/payment-links/:linkId","description":"

Overview: Cancel Payment Link API

The Cancel Payment Link API allows a Merchant, via their website, to cancel a payment link on the Merchant web site. A successful ‘response’ confirms the payment link was canceled and can no longer be used for making a transaction.

The primary function of the Cancel Payment Link API is as outlined. Nonetheless, the Merchant retains full autonomy over how the API is applied and who may access it.
To cancel a Payment Link, send a POST request to the /v1/payment-links endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`linkId`	String required	The unique identifier of the payment link.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`reason`	String required	The explanation provided by the merchant for canceling the payment link.

The Manage Payment Links API is the collection of Create Payment Link API and Cancel Payment Link API which enable a merchant to create and cancel a payment link correspondingly for a customer on the Merchant Portal.

\n","_postman_id":"3303a167-fbbd-4225-861b-f999a47f6f15"},{"name":"Notifications","item":[{"name":"Resend Payment Link Notification","id":"ea8e4863-b08c-49c9-874b-ce6a0c8ca9f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/payment-links/:linkId/resend","description":"

Overview: Resend Payment Link Notification API

A Resend Payment Link Notification API allows the merchant to resend payment link notification to customers if the initial notification was missed or failed to be delivered, ensuring customers receive the necessary information to complete their payment.

The primary function of the Resend Payment Link Notification API is as outlined. Nonetheless, the Merchant retains full autonomy over how the API is applied and who may access it.
To Resend Payment Link notification, send a POST request to the /v1/payment-links/:linkId/resend endpoint with the Basic credentials included in the header.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`linkId`	String required	The ID of a payment link.

","urlObject":{"path":["v1","payment-links",":linkId","resend"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{linkId}}","key":"linkId"}]}},"response":[{"id":"8170814f-2798-4db7-94c0-d75daa9b002a","name":"Resend Payment Link notification","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://stage-api-service.bnasmartpayment.com/v1/payment-links/:linkId/resend","protocol":"https","host":["stage-api-service","bnasmartpayment","com"],"path":["v1","payment-links",":linkId","resend"],"variable":[{"key":"linkId","value":"{{linkId}}"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":null,"header":[{"key":"content-length","value":"0"},{"key":"x-trace-id","value":"337ac93a32a6bcdfdc6f1fe4041efae1"},{"key":"date","value":"Mon, 15 Sep 2025 17:50:02 GMT"},{"key":"x-envoy-upstream-service-time","value":"153"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ea8e4863-b08c-49c9-874b-ce6a0c8ca9f5"}],"id":"ceb379f8-56be-43fe-89d7-62c96e7ee463","description":"

The Notifications API sends a payment link notification to a customer via email or phone number. It allows merchants to request payment by delivering a secure, trackable payment link to the recipient.

\n","_postman_id":"ceb379f8-56be-43fe-89d7-62c96e7ee463"}],"id":"a8c54fdb-f167-4fc0-8022-278929e04108","description":"

The Payment Links API allows the merchant to send payment links to customers through BNA Smart Payment Systems.

Payment Links are secure, shareable web links that allow businesses or individuals to request and collect payments online—without needing a full e-commerce setup or website.

\n","_postman_id":"a8c54fdb-f167-4fc0-8022-278929e04108"},{"name":"Subscriptions","item":[{"name":"Report","item":[{"name":"Retrieve subscriptions list","id":"b9928f6d-e454-42db-874e-77e9abb57e07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/subscription?customerId={{customerId}}&limit=3","description":"

Overview: Retrieve Transactions List API

The Retrieve Subscriptions List API enables a Merchant to inspect, through their website, all customer subscriptions list on the Merchant Portal. A successful 'response' will provide all subscriptions list for each Customer, if there are any, with full customer details and transaction details found on the portal.

The primary function of the Retrieve Subscriptions List API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

To retrieve all Transactions, send a GET request to the v1/transactions endpoint with the Basic credentials included in the header.

To fetch all subscriptions, send a GET request to the v1/subscription endpoint, ensuring the Basic credentials are included in the header.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	String optional	Filter by subscription ID.
`customerId`	String optional	Filter by Customer ID.
`recurrence`	String optional	Filter by subscription recurrence.Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`action`	String optional	Filter by subscription action.possible values: `SALE`, `PAYOUT`.
`status`	String optional	Filter by subscription status.Possible values: `NEW`, `ACTIVE`, `SUSPENDED`, `EXPIRED`, `INVALID`, `CANCELED`, `FAILED`, `DELETED`.
`page`	Integer optional	Page number to retrieve.
`limit`	Integer optional	Number of records per page.

Response Parameters

Option	Type	Description
`data`	Array	An array of objects.
`id`	String	The unique identifier for the subscription.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer
├── `type`	String	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String	Customer's email.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. Required for business customer.
├──`businessIdNumber`	String	Customer's legal business number. Required for business customer.
├── `businessName`	String	Customer's business name. Required for business customer.
├── `companyName`	String	Customer's legal company name. Required for business customer.
├── `registrationName`	String	Customer's legal registration name. Required for business customer.
├── `retailName`	String	Customer's legal retail name. Required for business customer.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`recurrence`	String	The frequency of the recurring payment. This field is required if `recurring` is set to `true`. Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`action`	String	The subscription's action.POSSIBLE VALUES: `SALE`, `PAYOUT`.
`currency`	String	The currency of the transaction. Possible values: `CAD`, `USD`.
`applyFee`	Boolean	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer. Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`startPaymentDate`	Date ISO 8601	The start date for the recurring payments.
`lastPaymentDate`	Date ISO 8601	The last date for the recurring payments.
`nextPaymentDate`	Date ISO 8601	The next date for the recurring payments.
`remainingPayments`	Number	The number of remaining recurring payments.
`paymentMethod`	String	The payment method chosen by the customer.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	The invoice number.
└── `invoiceAdditionalInfo`	String	Additional information about the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	The contract number.
├── `contractAdditionalInfo`	String	Additional information about the contract.
├── `contractStartDate`	Date	The start date of the contract.
└── `contractExpireDate`	Date	The expiration date of the contract.
`items`	Array	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String	The name of the item being purchased, displayed to the customer.
├── `sku`	String	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places	The unit price of the item, without the currency symbol.e.g.,10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units being purchased.
`amount`	String	Price amount for the item.It could be positive and negative number.
`status`	String	Filters transactions based on their status. Possible values: `NEW`, `ACTIVE`, `SUSPENDED`, `EXPIRED`, `INVALID`, `CANCELED`, `FAILED`, `DELETED`.
`customerContactType`	String	The method by which the customer will be contacted.Possible values: `EMAIL`, `PHONE`.
`recurring`	Boolean	Specifies if the payment link is for a recurring payment.Possible values: `true` or `false`.
`subtotal`	Number Float to two decimal places	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`paymentDetails`	Object	An object which contains information about the payment details.
E-TRANSFER PAYMENT METHOD
├── `id`	String	Customer's e-transfer payment id by email.
├── `type`	String	Payment method type.
├── `name`	String	Customer's e-transfer Payment Method name.
└── `email`	String	Customer's Interac email.
├── `id`	String	Customer's e-transfer payment id by phone.
├── `type`	String	Payment method type.
├── `name`	String	Customer's e-transfer Payment Method name.
├── `phone`	String	Customer's Interac phone.
└── `phoneCode`	String	Customer's Interac phone code.
EFT PAYMENT METHOD
├── `id`	String	Customer's EFT Payment Method ID.
├── `bankName`	String	Customer's EFT Payment Method bank name.
├── `bankNumber`	String	Customer's EFT Payment Method bank number.
├── `accountNumber`	String	The last three numbers of the Customer's EFT Payment Method account number.
└── `transitNumber`	String	The last two numbers of the Customer's EFT Payment Method transit number.
CARD PAYMENT METHOD
├── `id`	String	Customer's Card Payment Method ID.
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`.
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`.
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String	2 digits Card expiration month.
└── `expiryYear`	String	2 digits Card expiration month.
`comment`	String	Subscription comment.
`managementUrl`	String	URL for subscription management which can be provided to the customer.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.
`pages`	Object	Contains all the pagination details.
├── `totalRows`	Number	The total count of rows in the list.
├── `pageTotal`	Number	The total number of pages.
├── `pageNum`	Number	The current page number.
└── `pageSize`	Number	The number of rows per page.

","urlObject":{"path":["v1","subscription"],"host":["{{base_url}}"],"query":[{"key":"customerId","value":"{{customerId}}"},{"key":"limit","value":"3"}],"variable":[]}},"response":[{"id":"e5633d65-10d2-4a66-9017-d5369cdb8621","name":"Retrieve subscriptions list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage-api-service.bnasmartpayment.com/v1/subscription?customerId=e1ab898b-ba6b-4d4f-bf2c-0de4e6cd23ba&limit=3","protocol":"https","host":["stage-api-service","bnasmartpayment","com"],"path":["v1","subscription"],"query":[{"key":"customerId","value":"e1ab898b-ba6b-4d4f-bf2c-0de4e6cd23ba"},{"key":"limit","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"6182"},{"key":"x-trace-id","value":"7bc37665647a9f13ea9f687ca5c291c2"},{"key":"date","value":"Mon, 15 Sep 2025 20:35:28 GMT"},{"key":"x-envoy-upstream-service-time","value":"57"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"823be4d7-32d8-4e3f-b83f-e6c9e2b32a23\",\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444400\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"recurrence\": \"DAILY\",\n \"action\": \"SALE\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"startPaymentDate\": \"2025-09-15T22:31:22.000Z\",\n \"lastPaymentDate\": \"2025-09-15T20:32:34.611Z\",\n \"nextPaymentDate\": \"2025-09-16T20:32:34.611Z\",\n \"remainingPayments\": 9,\n \"paymentMethod\": \"EFT\",\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"bankName\": \"ROYAL BANK OF CANADA\",\n \"accountNumber\": \"*****345\",\n \"transitNumber\": \"***18\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"ACTIVE\",\n \"comment\": \"Subscriptions\",\n \"managementUrl\": \"https://payment-stage.bnasmartpayment.com/management/cf924c3fb3f9baef\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n },\n {\n \"id\": \"425c05db-3294-4b89-99ea-f1a201e41a73\",\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444400\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"recurrence\": \"DAILY\",\n \"action\": \"SALE\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"startPaymentDate\": \"2025-09-15T22:31:22.000Z\",\n \"lastPaymentDate\": \"2025-09-15T20:33:08.691Z\",\n \"nextPaymentDate\": \"2025-09-16T20:33:08.691Z\",\n \"remainingPayments\": 9,\n \"paymentMethod\": \"CARD\",\n \"paymentDetails\": {\n \"cardNumber\": \"************1191\",\n \"cardHolder\": \"Jason Johnson\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"ACTIVE\",\n \"comment\": \"Subscriptions\",\n \"managementUrl\": \"https://payment-stage.bnasmartpayment.com/management/a79208c85e55f101\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n },\n {\n \"id\": \"5b35f855-04df-4e84-9eaf-2499acda6a84\",\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444400\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222278\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61\"\n }\n },\n \"recurrence\": \"DAILY\",\n \"action\": \"SALE\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"startPaymentDate\": \"2025-09-15T22:31:22.000Z\",\n \"lastPaymentDate\": \"2025-09-15T20:35:03.412Z\",\n \"nextPaymentDate\": \"2025-09-16T20:35:03.411Z\",\n \"remainingPayments\": 9,\n \"paymentMethod\": \"E-TRANSFER\",\n \"paymentDetails\": {\n \"name\": \"Ed Watts\",\n \"email\": \"ponebov818@ncien.com\",\n \"deliveryType\": \"EMAIL\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"ACTIVE\",\n \"comment\": \"Subscriptions\",\n \"managementUrl\": \"https://payment-stage.bnasmartpayment.com/management/e9b4137df4190026\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n }\n ],\n \"pages\": {\n \"totalRows\": 3,\n \"pageTotal\": 1,\n \"pageNum\": 1,\n \"pageSize\": 3\n }\n}"}],"_postman_id":"b9928f6d-e454-42db-874e-77e9abb57e07"},{"name":"Retrieve Subscription by ID","id":"cb6f3655-ba6a-44c9-a795-3ec339aec57c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/subscription/:subscriptionId","description":"

Overview: Retrieve Subscriptions by ID API

The Retrieve Subscriptions by ID API enables a Merchant to get the details of a specific subscription using its unique ID.

These details might include:
Customer information,customer contact type (EMAIL or PHONE)
The status of the subscription ( NEW, ACTIVE, SUSPENDED, EXPIRED, INVALID, CANCELED, FAILED, DELETED). Subscription's action (SALE,PAYOUT),start payment date, last payment date, next payment date

The primary function of the Retrieve Subscription by ID API is as outlined. Nonetheless, the Merchant retains full autonomy over the application and accessibility of this API. For instance, access can be extended to the Merchant's help desk or an external administrator tasked with overseeing these payment accounts on behalf of the Merchant.

Definitions:

To fetch subscription by ID, send a GET request to the v1/subscription/:subscriptionId endpoint, ensuring the Basic credentials are included in the header.
The query string should contain the subscriptionId parameter

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subscriptionId`	String required	Subscription ID.

Response Parameters

Option	Type	Description
`id`	String	The unique identifier for the subscription.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values :`BUSINESS` or `PERSONAL`.
├── `email`	String	A string which contains the Customer's email.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. Required for business customer.
├── `businessIdNumber`	String	Customer's legal business number. Required for business customer.
├── `businessName`	String	Customer's business name. Required for business customer.
├── `companyName`	String	Customer's legal company name. Required for business customer.
├── `registrationName`	String	Customer's legal registration name. Required for business customer.
└── `retailName`	String	Customer's legal retail name. Required for business customer.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`recurrence`	String	The frequency of the recurring payment. This field is required if `recurring` is set to `true`. Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`action`	String	The subscription's action.possible values: `SALE`, `PAYOUT`.
`currency`	String	The currency of the transaction. Possible values: `CAD`, `USD`.
`applyFee`	Boolean	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer. Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`startPaymentDate`	Date ISO 8601	The start date for the recurring payments.
`lastPaymentDate`	Date ISO 8601	The last date for the recurring payments.
`nextPaymentDate`	Date ISO 8601	The next date for the recurring payments.
`remainingPayments`	Number	The number of remaining recurring payments.
`paymentMethod`	String	The payment method chosen by the customer.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	The invoice number.
└── `invoiceAdditionalInfo`	String	Additional information about the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	The contract number.
├── `contractAdditionalInfo`	String	Additional information about the contract.
├── `contractStartDate`	Date	The start date of the contract.
└── `contractExpireDate`	Date	The expiration date of the contract.
`items`	Array	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String	The name of the item being purchased, displayed to the customer.
├── `sku`	String	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places	The unit price of the item, without the currency symbol. e.g.,10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units being purchased.
└── `amount`	String	Price amount for the item.It could be positive and negative number.
`status`	String	Filters transactions based on their status. Possible values: `NEW`, `ACTIVE`, `SUSPENDED`, `EXPIRED`, `INVALID`, `CANCELED`, `FAILED`, `DELETED`.
`customerContactType`	String	The method by which the customer will be contacted.Possible values: `EMAIL`, `PHONE`.
`customerContact`	String	The customer's email address or phone number, including the country code.
`recurring`	Boolean	Specifies if the payment link is for a recurring payment.Possible values: `true` or `false`.
`subtotal`	Number Float to two decimal places	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`paymentDetails`	Object	An object which contains information about the payment details.
E-TRANSFER PAYMENT METHOD
├── `type`	String	Payment method type.
├── `name`	String	Customer's e-transfer Payment Method name.
└── `email`	String	Customer's Interac email.
├── `type`	String	Payment method type.
├── `name`	String	Customer's e-transfer Payment Method name.
├── `phone`	String	Customer's Interac phone.
└── `phoneCode`	String	Customer's Interac phone code.
EFT PAYMENT METHOD
├── `bankName`	String	Customer's EFT Payment Method bank name.
├── `bankNumber`	String	Customer's EFT Payment Method bank number.
├── `accountNumber`	String	The last three numbers of the Customer's EFT Payment Method account number.
└── `transitNumber`	String	The last two numbers of the Customer's EFT Payment Method transit number.
CARD PAYMENT METHOD
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`.
├── `cardHolder`	String	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`.
├── `cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String	2 digits Card expiration month.
└── `expiryYear`	String	2 digits Card expiration month.
`comment`	String	Subscription comment.
`managementUrl`	String	URL for subscription management which can be provided to the customer.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","subscription",":subscriptionId"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{subscriptionId}}","key":"subscriptionId"}]}},"response":[{"id":"bceca941-7372-4fd7-b7b6-88d1994031af","name":"Retrieve subscription by ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://stage-api-service.bnasmartpayment.com/v1/subscription/:subscriptionId","protocol":"https","host":["stage-api-service","bnasmartpayment","com"],"path":["v1","subscription",":subscriptionId"],"variable":[{"key":"subscriptionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"2032"},{"key":"x-trace-id","value":"15f2ab2570680f2692ac31aef7637005"},{"key":"date","value":"Mon, 15 Sep 2025 20:36:11 GMT"},{"key":"x-envoy-upstream-service-time","value":"52"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"823be4d7-32d8-4e3f-b83f-e6c9e2b32a23\",\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\",\n \"customerInfo\": {\n \"email\": \"ponebov818@ncien.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4164444400\",\n \"firstName\": \"Jason\",\n \"lastName\": \"Johnson\",\n \"birthDate\": \"1989-09-26\",\n \"businessIdNumber\": \"222222\",\n \"businessName\": \"Jason Johnson & Brothers\",\n \"companyName\": \"Jason Johnson & Brothers\",\n \"registrationName\": \"Jason Johnson\",\n \"retailName\": \"Jason Johnson\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Kitchener\",\n \"province\": \"Ontario\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A1A1\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Main Street\",\n \"streetNumber\": \"10\",\n \"apartment\": \"7\",\n \"city\": \"Winnipeg\",\n \"province\": \"Manitoba\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A2S3\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 11\",\n \"field2\": \"Field 21\",\n \"field3\": \"Field 31\",\n \"field4\": \"Field 41\",\n \"field5\": \"Field 51\",\n \"field6\": \"Field 61 \"\n }\n },\n \"recurrence\": \"DAILY\",\n \"action\": \"SALE\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"startPaymentDate\": \"2025-09-15T22:31:22.000Z\",\n \"lastPaymentDate\": \"2025-09-15T20:32:34.611Z\",\n \"nextPaymentDate\": \"2025-09-16T20:32:34.611Z\",\n \"remainingPayments\": 9,\n \"paymentMethod\": \"EFT\",\n \"paymentDetails\": {\n \"bankNumber\": \"003\",\n \"bankName\": \"ROYAL BANK OF CANADA\",\n \"accountNumber\": \"*****345\",\n \"transitNumber\": \"***18\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"ACTIVE\",\n \"comment\": \"Subscriptions Retrieval\",\n \"managementUrl\": \"https://payment-stage.bnasmartpayment.com/management/cf924c3fb3f9baef\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"cb6f3655-ba6a-44c9-a795-3ec339aec57c"}],"id":"ae0b3a5e-9c51-45b7-83ec-e414c2b9151c","description":"

The Report API allows clients to fetch subscription data for reporting or analytical purposes.

1. Retrieve Subscriptions List.

Returns a list of all subscriptions with optional filters such as status, date range, or customer ID. This endpoint supports pagination to manage large result sets.

2. Retrieve Subscriptions by ID

Fetches detailed information for a specific subscription by its unique ID.

\n","_postman_id":"ae0b3a5e-9c51-45b7-83ec-e414c2b9151c"},{"name":"Manage Subscriptions","item":[{"name":"Create Subscription","id":"7eb10c8f-732e-4116-86f3-e82852872e16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"recurrence\": \"DAILY\",\n \"remainingPayments\": 10,\n \"startPaymentDate\": \"2025-09-23 22:31:22\",\n \"action\": \"PAYOUT\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"paymentMethod\": \"E_TRANSFER\",\n \"paymentDetails\": {\n \"phoneNumber\": \"6474445555\",\n \"phoneCode\": \"+1\",\n \"name\": \"Angelica Sloan\",\n \"deliveryType\": \"SMS\",\n \"message\": \"Money Request\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14\",\n \"contractExpireDate\": \"2024-09-28\"\n },\n \"comment\": \"hello\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/subscription","description":"

To create a Subscription, send a POST request to the /v1/subscription endpoint with the Basic credentials included in the header.

Transaction Options Documentation

This table provides a detailed description of the options available for developers to create a subscription. Each option includes its type and a description.

Request parameters

Option	Type	Description
`customerId`	String required	The ID of the customer.
`recurrence`	Object required	Specifies the frequency of recurring payments.Possible values: `DAILY`, `WEEKLY`, `BI-WEEKLY`, `MONTHLY`, `EVERY-3-MONTHS`, `EVERY-6-MONTHS`, `YEARLY`. This parameter is mandatory if the `recurring` parameter is set to true.
`remainingPayments`	Number Integer optional	Number of payments to be created. If this parameter is missing, the subscription will not have an expiration date, or in the case of a PAYMENT CARD, it will be counted automatically until the expiration PAYMENT CARD.
`startPaymentDate`	Date ISO 8601 optional	The date for the initial payment in the subscription cycle to be delayed. If not provided, the first payment will be processed right away.
`action`	String required	Action taken for the transaction.Possible values: `SALE`, `PAYOUT`.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`currency`	String ISO 4217 required	The ISO currency code. A three-letter alphabetic code that represents the currency in which the transaction originated.Possible values: `CAD`, `USD`.
`applyFee`	Boolean required	Indicates whether to apply the BNA Smart Payment Systems fee to the customer. Possible values: `true` or `false`. When set to `true`, BNA Smart Payment Systems will pass the merchant's payment processing fees to the customer.
`paymentMethod`	String required	Payment method used for the transaction.Possible values: `CARD`, `E-TRANSFER`, `EFT`, `CHEQUE`, `CASH`, `APPLE PAY`, `GOOGLE PAY`.
`paymentDetails`	Object required	Contains detailed information about the payment.
├── `id`	String optional	Unique identifier for the payee's e-Transfer payment method.
├──── `name`	String required	Full name of the recipient, including both first and last names.
├──── `email`	String conditional	Recipient’s email address.Required if `deliveryType` is set to `EMAIL`.
├──── `phoneCode`	String conditional	Recipient’s country calling code.Required if `deliveryType` is set to `SMS`.
├──── `phoneNumber`	String conditional	Recipient’s phone number.Required if `deliveryType` is set to `PHONE`.
├──── `message`	String optional	Optional message to include in the Interac e-Transfer request.
├──── `securityQuestion`	String conditional	Security question for the recipient to answer in order to deposit the transfer.Required if the recipient does not have a Direct Deposit Registration (DDR) and `action` is `SALE`
├──── `securityAnswer`	String conditional	Answer to the security question, subject to the following rules: a.Must not contain spaces b.Must be between 3 and 25 characters in length. Required if `securityQuestion` is provided and `action` is `SALE`
└──── `deliveryType`	String required	Method used to deliver the transfer notification. Possible values: `EMAIL`, `SMS`, or `NONE`.
EFT Payment Method
├── `id`	String optional	Customer's Card Payment Method ID.
├── `bankNumber`	String conditional	The Customer's bank number. Required if there is no payment ID provided.
├── `transitNumber`	String conditional	The Customer's bank transit number. Required if there is no payment ID provided.
└──`accountNumber`	String conditional	The Customer's bank account number. Required if there is no payment ID provided.
Card Payment Method
├── `id`	String optional	Customer's Card Payment Method ID.
├── `cardNumber`	String conditional	The last four digits of the Customer's Card Payment Method card number. Required if there is no payment ID provided.
├── `cardType`	String conditional	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`. Required if there is no payment ID provided.
├── `cardHolder`	String conditional	Customer's Card Payment Method cardholder name. Required if there is no payment ID provided.
├── `cardIdNumber`	String 3-4 digits conditional	The credit card security code. Required if there is no payment ID provided.
├── `expiryMonth`	String 2 digits conditional	Credit card expiration month in MM format. Required if there is no payment ID provided.
└── `expiryYear`	String 2 digits conditional	Credit card expiration year in YY format. Required if there is no payment ID provided.
`secure`	Object optional	Contains the 3DS credentials from the Merchant's 3DS provider.
├── `token`	String required	A Base64 encoded string. The value provided by the Merchant's 3DS provider.
├── `eci`	String required	The value provided by the Merchant's 3DS provider.
└── `dsTransId`	String required	The value provided by the Merchant's 3DS provider.
Cheque Payment Method
└──`chequeNumber`	String required	Mandatory if `startPaymentDate` is not specified and the initial payment for the subscription cycle is to be made immediately.
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"items\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places required	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer required	The number of units purchased.
└── `amount`	Number Float to two decimal places required	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.
`invoiceInfo`	Object required	An object which contains additional information about the invoice.
├── `invoiceId`	String optional	Invoice number.
└── `invoiceAdditionalInfo`	String optional	Invoice additional info.
`contractInfo`	Object required	An object which contains additional information about the contract.
├── `contractId`	String optional	Contract number.
├── `contractAdditionalInfo`	String optional	Contract additional inf.
├── `contractStartDate`	Date optional	Contract start date.
└── `contractExpireDate`	Date optional	Contract expiration date.

Response parameters

Option	Type	Description
`id`	String	The unique identifier for the subscription.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values :`BUSINESS` or `PERSONAL`.
├── `email`	String	A string which contains the Customer's email.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. Required for business customer.
├── `businessIdNumber`	String	Customer's legal business number. Required for business customer.
├── `businessName`	String	Customer's business name. Required for business customer.
├── `companyName`	String	Customer's legal company name. Required for business customer.
├── `registrationName`	String	Customer's legal registration name. Required for business customer.
└── `retailName`	String	Customer's legal retail name. Required for business customer.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`recurrence`	String	The frequency of the recurring payment. This field is required if `recurring` is set to `true`. Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`action`	String	The subscription's action.POSSIBLE VALUES: `SALE`, `PAYOUT`.
`currency`	String	The currency of the transaction. Possible values: `CAD`, `USD`.
`applyFee`	Boolean	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer. Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`startPaymentDate`	Date ISO 8601	The start date for the recurring payments.
`lastPaymentDate`	Date ISO 8601	The last date for the recurring payments.
`nextPaymentDate`	Date ISO 8601	The next date for the recurring payments.
`remainingPayments`	Number	The number of remaining recurring payments.
`paymentMethod`	String	The payment method chosen by the customer.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	The invoice number.
└── `invoiceAdditionalInfo`	String	Additional information about the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	The contract number.
├── `contractAdditionalInfo`	String	Additional information about the contract.
├── `contractStartDate`	Date	The start date of the contract.
└── `contractExpireDate`	Date	The expiration date of the contract.
`items`	Array	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String	The name of the item being purchased, displayed to the customer.
├── `sku`	String	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places	The unit price of the item, without the currency symbol. e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units being purchased.
└── `amount`	Number Float to two decimal places	It could be positive and negative number.
`status`	String	Filters transactions based on their status. Possible values: `NEW`, `ACTIVE`, `SUSPENDED`, `EXPIRED`, `INVALID`, `CANCELED`, `FAILED`, `DELETED`.
`customerContactType`	String	The method by which the customer will be contacted.Possible values: `EMAIL`, `PHONE`.
`customerContact`	String	The customer's email address or phone number, including the country code.
`recurring`	Boolean	Specifies if the payment link is for a recurring payment.Possible values: `true` or `false`.
`subtotal`	Number Float to two decimal places	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`paymentDetails`	Object	An object which contains information about the payment details.
E-TRANSFER PAYMENT METHOD
`id`	String	Customer's Interac email.
EFT PAYMENT METHOD
`id`	String	Customer's EFT Payment Method ID.
`bankName`	String	Customer's EFT Payment Method bank name.
`bankNumber`	String	Customer's EFT Payment Method bank number.
`accountNumber`	String	The last three numbers of the Customer's EFT Payment Method account number.
`transitNumber`	String	The last two numbers of the Customer's EFT Payment Method transit number.
CARD PAYMENT METHOD
`id`	String	Customer's CARD Payment Method ID.
`cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`.
`cardHolder`	String	Customer's Card Payment Method card holder.
`cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`.
`cardNumber`	String	The last four numbers of the Customer's Card Payment Method card number.
`expiryMonth`	String	2 digits Card expiration month.
`expiryYear`	String	2 digits Card expiration month.
`comment`	String	Subscription comment.
`managementUrl`	String	URL for subscription management which can be provided to the customer.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","subscription"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a9412eff-0b58-4364-a4e1-76a6c1021772","name":"Create Subscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"recurrence\": \"DAILY\",\n \"remainingPayments\": 10,\n \"startPaymentDate\": \"2025-09-23 22:31:22\",\n \"action\": \"SALE\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"paymentMethod\": \"E_TRANSFER\",\n \"paymentDetails\": {\n \"phoneNumber\": \"6474445555\",\n \"phoneCode\": \"+1\",\n \"name\": \"Angelica Sloan\",\n \"deliveryType\": \"SMS\",\n \"message\": \"Money Request\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14\",\n \"contractExpireDate\": \"2024-09-28\"\n },\n \"comment\": \"hello\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/subscription"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"2035"},{"key":"x-trace-id","value":"1f3f265f64e2acb956081fcd73560605"},{"key":"date","value":"Tue, 23 Sep 2025 16:01:55 GMT"},{"key":"x-envoy-upstream-service-time","value":"3559"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"8ef3024a-ecc7-4c13-9e6d-7b829a64f249\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"6474445555\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"recurrence\": \"DAILY\",\n \"action\": \"SALE\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"startPaymentDate\": \"2025-09-23T22:31:22.000Z\",\n \"lastPaymentDate\": \"2025-09-23T16:01:55.612Z\",\n \"nextPaymentDate\": \"2025-09-24T16:01:55.612Z\",\n \"remainingPayments\": 9,\n \"paymentMethod\": \"E-TRANSFER\",\n \"paymentDetails\": {\n \"phoneNumber\": \"6478671629\",\n \"phoneCode\": \"+1\",\n \"name\": \"Angelica Sloan\",\n \"deliveryType\": \"sms\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"ACTIVE\",\n \"comment\": \"hello\",\n \"managementUrl\": \"https://payment-stage.bnasmartpayment.com/management/92eeca2091191929\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"7eb10c8f-732e-4116-86f3-e82852872e16"},{"name":"Suspend Subscription","id":"086729f5-912d-4a16-ad44-f693c5b33c37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"suspend\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/subscription/:subscriptionId/suspend","description":"

To Suspend a subscription by ID, send a PATCH request to the v1/subscription/:subscriptionId/suspend endpoint, ensuring the Basic credentials are included in the header.
This section details the parameters required for the suspend subscription API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subscriptionId`	String required	The unique identifier for the subscription.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`suspend`	String required	Suspension of a subscription.Possible value: `true`,`false`

Response Parameters

Option	Type	Description
`id`	String	The unique identifier for the subscription.
`customerId`	String	Customer ID.
`customerInfo`	Object	An object which contains all the information about the Customer.
├── `type`	String	Customer type. Possible values :`BUSINESS` or `PERSONAL`.
├── `email`	String	A string which contains the Customer's email.
├── `phoneCode`	String	Customer's country calling code.
├── `phoneNumber`	String	Customer's phone number.
├── `firstName`	String	Customer's first name.
├── `lastName`	String	Customer's last name.
├── `birthDate`	Date ISO 8601	Customer's birthday date.
├── `legalName`	String	Customer's legal business name. Required for business customer.
├── `businessIdNumber`	String	Customer's legal business number. Required for business customer.
├── `businessName`	String	Customer's business name. Required for business customer.
├── `companyName`	String	Customer's legal company name. Required for business customer.
├── `registrationName`	String	Customer's legal registration name. Required for business customer.
└── `retailName`	String	Customer's legal retail name. Required for business customer.
├── `billingAddress`	Object	Contains all the information about the customer's billing address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
├── `shippingAddress`	Object	Contains all the information about the customer's shipping address.
├──── `apartment`	String	Customer's apartment number.
├──── `streetNumber`	String	Customer's street number.
├──── `streetName`	String	Customer's street name.
├──── `city`	String	Customer's city.
├──── `province`	String	Customer's province/state.
├──── `country`	String	Customer's country.
└──── `postalCode`	String	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
├── `field1 - field6`	String	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`recurrence`	String	The frequency of the recurring payment. This field is required if `recurring` is set to `true`. Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`action`	String	The subscription's action.POSSIBLE VALUES: `SALE`, `PAYOUT`.
`currency`	String	The currency of the transaction. Possible values: `CAD`, `USD`.
`applyFee`	Boolean	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer. Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`startPaymentDate`	Date ISO 8601	The start date for the recurring payments.
`lastPaymentDate`	Date ISO 8601	The last date for the recurring payments.
`nextPaymentDate`	Date ISO 8601	The next date for the recurring payments.
`remainingPayments`	Number	The number of remaining recurring payments.
`paymentMethod`	String	The payment method chosen by the customer.
`invoiceInfo`	Object	Contains additional information about the invoice.
├── `invoiceId`	String	The invoice number.
└── `invoiceAdditionalInfo`	String	Additional information about the invoice.
`contractInfo`	Object	Contains additional information about the contract.
├── `contractId`	String	The contract number.
├── `contractAdditionalInfo`	String	Additional information about the contract.
├── `contractStartDate`	Date	The start date of the contract.
└── `contractExpireDate`	Date	The expiration date of the contract.
`items`	Array	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String	The name of the item being purchased, displayed to the customer.
├── `sku`	String	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places	The unit price of the item, without the currency symbol. e.g., 10.55 if the price is $10.55 per unit.It could be positive and negative number.
├── `quantity`	Number Integer	The number of units being purchased.
└── `amount`	Number Float to two decimal places	It could be positive and negative number.
`status`	String	Filters transactions based on their status. Possible values: `NEW`, `ACTIVE`, `SUSPENDED`, `EXPIRED`, `INVALID`, `CANCELED`, `FAILED`, `DELETED`.
`customerContactType`	String	The method by which the customer will be contacted.Possible values: `EMAIL`, `PHONE`.
`customerContact`	String	The customer's email address or phone number, including the country code.
`recurring`	Boolean	Specifies if the payment link is for a recurring payment.Possible values: `true` or `false`.
`subtotal`	Number Float to two decimal places	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`paymentDetails`	Object	An object which contains information about the payment details.
e-Transfer Payment Method
├──── `name`	String	Full name of the recipient, including both first and last names.
├──── `email`	String	Recipient’s email address.
├──── `phoneCode`	String	Recipient’s country calling code.
├──── `phoneNumber`	String	Recipient’s phone number.
├──── `message`	String	Optional message to include in the Interac e-Transfer request.
└──── `deliveryType`	String	Method used to deliver the transfer notification.Possible values: `EMAIL`, `PHONE`, or `NONE`.
EFT Payment Method
├── `bankNumber`	String	The Customer's bank number. Required if there is no payment ID provided.
├── `transitNumber`	String	The Customer's bank transit number. Required if there is no payment ID provided.
└──`accountNumber`	String	The Customer's bank account number. Required if there is no payment ID provided.
Card Payment Method
├── `cardNumber`	String	The last four digits of the Customer's Card Payment Method card number. Required if there is no payment ID provided.
├── `cardType`	String	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`. Required if there is no payment ID provided.
├── `cardHolder`	String	Customer's Card Payment Method cardholder name. Required if there is no payment ID provided.
├── `cardIdNumber`	String 3-4 digits	The credit card security code. Required if there is no payment ID provided.
├── `expiryMonth`	String 2 digits	Credit card expiration month in MM format. Required if there is no payment ID provided.
└── `expiryYear`	String 2 digits	Credit card expiration year in YY format. Required if there is no payment ID provided.
Cheque Payment Method
└──`chequeNumber`	String	Customer's cheque number
`comment`	String	Subscription comment.
`managementUrl`	String	URL for subscription management which can be provided to the customer.
`metadata`	Object	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","urlObject":{"path":["v1","subscription",":subscriptionId","suspend"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{subscriptionId}}","key":"subscriptionId"}]}},"response":[{"id":"dbe84580-8382-423d-94e3-ef77f5943111","name":"Suspend Subscription","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"suspend\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/subscription/:subscriptionId/suspend","host":["{{base_url}}"],"path":["v1","subscription",":subscriptionId","suspend"],"variable":[{"key":"subscriptionId","value":"{{subscriptionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"2081"},{"key":"x-trace-id","value":"a5d70215275f3deb6ce4a7f65618a5e9"},{"key":"date","value":"Thu, 18 Sep 2025 16:06:11 GMT"},{"key":"x-envoy-upstream-service-time","value":"272"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"ed2ec641-3717-4439-b8a2-274c34c15ca7\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4167777777\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"apartment\": \"54\",\n \"city\": \"Richmond\",\n \"province\": \"British Columbia\",\n \"country\": \"Canada\",\n \"postalCode\": \"V6X 2C9\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"recurrence\": \"DAILY\",\n \"action\": \"SALE\",\n \"subtotal\": 7,\n \"currency\": \"CAD\",\n \"applyFee\": false,\n \"startPaymentDate\": \"2025-09-18T22:31:22.000Z\",\n \"lastPaymentDate\": \"2025-09-18T16:05:51.212Z\",\n \"nextPaymentDate\": \"2025-09-19T16:05:51.212Z\",\n \"remainingPayments\": 9,\n \"paymentMethod\": \"CARD\",\n \"paymentDetails\": {\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"123546abc\",\n \"invoiceAdditionalInfo\": \"12345\"\n },\n \"contractInfo\": {\n \"contractId\": \"123546abc\",\n \"contractAdditionalInfo\": \"Contract additional info\",\n \"contractStartDate\": \"2020-07-14T00:00:00.000Z\",\n \"contractExpireDate\": \"2024-09-28T00:00:00.000Z\"\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"12312\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"123\"\n },\n {\n \"amount\": -3,\n \"description\": \"12312\",\n \"price\": -1.5,\n \"quantity\": 2,\n \"sku\": \"123\"\n }\n ],\n \"status\": \"SUSPENDED\",\n \"comment\": \"hello\",\n \"managementUrl\": \"https://payment-stage.bnasmartpayment.com/management/bd4bd562b9ac1678\",\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n }\n}"}],"_postman_id":"086729f5-912d-4a16-ad44-f693c5b33c37"},{"name":"Delete Subscription","id":"e43c064f-d165-483d-a45d-f99919376ff2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"DELETE","header":[],"url":"{{base_url}}/v1/subscription/:subscriptionId","description":"

To Delete a subscription by ID, send DELETE request to the v1/subscription/:subscriptionId endpoint, ensuring the Basic credentials are included in the header.
This section details the parameters required for the delete subscription API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subscriptionId`	String required	The unique identifier for the subscription.

Manage Subscriptions API combines the Merchant's ability to create,suspend and delete recurring payments subscriptions

\n","_postman_id":"a75b2e10-e209-4a77-84e2-b4a6c69797ce"},{"name":"Notifications","item":[{"name":"Resend Subscription Notification","id":"1ed8ab5b-69eb-481a-9b8f-72cb0be19aa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/subscription/:subscriptionId/notify","description":"

To Resend a subscription notification, send a POST request to the v1/subscription/:subscriptionId/notify endpoint, ensuring the Basic credentials are included in the header.

This section details the parameters required for the Resend Subscription Notification API. Each parameter is described with its type and constraints to ensure proper usage by developers.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`subscriptionId`	String required	The unique identifier for the subscription.

","urlObject":{"path":["v1","subscription",":subscriptionId","notify"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{subscriptionId}}","key":"subscriptionId"}]}},"response":[{"id":"a16f7404-9515-45e1-8775-9d0c36356565","name":"Resend Subscription notification","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/subscription/:subscriptionId/notify","host":["{{base_url}}"],"path":["v1","subscription",":subscriptionId","notify"],"variable":[{"key":"subscriptionId","value":"{{subscriptionId}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":[{"key":"x-trace-id","value":"e360e99ddf7f282ae5ed9683d5470205"},{"key":"date","value":"Mon, 15 Sep 2025 20:37:48 GMT"},{"key":"x-envoy-upstream-service-time","value":"67"},{"key":"server","value":"istio-envoy"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1ed8ab5b-69eb-481a-9b8f-72cb0be19aa8"}],"id":"8befc90c-5707-418c-8dd3-f6c0bccca643","description":"

Overview

The resending of recurring payment notifications feature in BNA REST API allows the system or users to reattempt sending notifications related to recurring payment subscriptions. These notifications inform merchants, customers, or beneficiaries about updates, payments, and status changes for a recurring subscription.

Applicable Subscription Statuses

Resending of notifications can occur for recurring payment subscriptions with the following statuses:

NEW: Notification sent when a recurring subscription is created.
\n
ACTIVE: Notification for successful transactions and ongoing subscription updates.
\n
SUSPENDED: Notification informing about a temporary pause in payments.
\n
EXPIRED: Notification indicating the subscription has reached its predefined end.
\n
INVALID: Notification sent when a subscription is deemed invalid due to incorrect setup or payment failure.
\n
CANCELED: Notification confirming the subscription has been manually canceled.
\n
FAILED: Notification indicating an unsuccessful payment attempt.
\n
DELETED: Notification sent when a recurring subscription is permanently removed.
\n

This functionality ensures that all relevant parties are kept informed about their recurring transactions, improving transparency and reducing missed communications.

\n","_postman_id":"8befc90c-5707-418c-8dd3-f6c0bccca643"}],"id":"392d811f-b785-4128-b366-ba6cb0da6758","description":"

Overview

The recurring feature in our REST API allows users to set up automated transactions that repeat at specified intervals. These transactions can be categorized as SALE or PAYOUT, each with its own purpose and use cases.

SALE: Represents a recurring payment where a customer is billed on a regular basis for services, subscriptions, or products.
\n
PAYOUT: Represents a recurring payment from a merchant or system to a beneficiary, such as vendor payments, payroll, or commission disbursements.
\n

Frequency Options

Subscriptions can be scheduled to occur at one of the following intervals:

DAILY: The transaction is processed every day.
\n
WEEKLY: The transaction is processed once a week.
\n
BIWEEKLY: The transaction occurs every two weeks.
\n
MONTHLY: The transaction is scheduled once per month.
\n
QUARTERLY: The transaction is processed once every three months.
\n
BIANNUAL: The transaction occurs every six months.
\n
ANNUAL: The transaction is executed once per year.
\n

Status Definitions

Each subscription follows a lifecycle that is tracked through specific statuses:

NEW: The subscription has been created but is not yet active.
\n
ACTIVE: The subscription is currently active and scheduled to process payments as per the defined frequency.
\n
SUSPENDED: The transaction is temporarily paused and will not process further payments until reactivated.
\n
EXPIRED: The subscription has reached its predefined end date or has exceeded its allowed cycles.
\n
INVALID: The transaction is deemed invalid due to incorrect configuration, payment failure, or missing information.
\n
CANCELED: The subscription has been manually canceled by the user or system before its scheduled end.
\n
FAILED: The transaction attempt was unsuccessful due to an error such as insufficient funds, declined payments, or system issues.
\n
DELETED: The subscription has been permanently removed from the system and cannot be reinstated.
\n

This structured approach ensures flexibility in handling recurring transactions while providing clear tracking and status management.

\n","_postman_id":"392d811f-b785-4128-b366-ba6cb0da6758"},{"name":"iFrames","item":[{"name":"Check out","id":"f3310c44-4c22-4a8c-ab1d-c4e5c32b3444","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{secretKey}}","username":"{{accessKey}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"iframeId\": \"9af9523f-6934-42f0-8689-f7e2451b57d8\",\n \"recurrence\": \"WEEKLY\",\n \"customerInfo\": {\n \"email\": \"xokohac777@dawhe.com\",\n \"type\": \"BUSINESS\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4162223345\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"2342\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"billingAddress\": {\n \"apartment\": \"Suite 100\",\n \"streetNumber\": \"123\",\n \"streetName\": \"Main Street\",\n \"country\": \"Canada\",\n \"province\": \"Ontario\",\n \"city\": \"Toronto\",\n \"postalCode\": \"M5V 3A8\"\n },\n \"shippingAddress\": {\n \"apartment\": \"12\",\n \"streetNumber\": \"456\",\n \"streetName\": \"Shipping Lane\",\n \"country\": \"Canada\",\n \"province\": \"Ontario\",\n \"city\": \"Mississauga\",\n \"postalCode\": \"L5B 2N4\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"office chair\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"452611\"\n }\n ],\n \"subtotal\": 10,\n \"startPaymentDate\": \"2025-09-19 22:31:22\",\n \"remainingPayments\": 10,\n \"saveCustomer\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/checkout","description":"

To create a checkout in iFrames, send a POST request to the v1/checkout endpoint with the Basic credentials included in the header.The request body (payload) must reflect the iFrame settings configured in the BNA Merchant Portal.

Payload:
Refer to the Request Parameters Table for required and optional fields, which should match the customizations applied in the Merchant Portal (e.g., fields enabled, payment types, customer information)

Checkout Payload (Add Payment Method iFrame)
When using the Add Payment Method iFrame, include only iframeId and customerId in the Checkout request payload.

(Optional example)

{\n  \"iframeId\": \"<IFRAME_ID>\",\n  \"customerId\": \"<CUSTOMER_ID>\"\n}\n\n

Upon a successful request, the API will return a secure token. This token is valid for 30 minutes and is required to embed the iFrame.

Embed the iFrame in Your Website
On the client’s website, navigate to the page where the payment iFrame should be displayed. Use the following HTML snippet, replacing {base_url} and {token} with your environment's base URL and the token previously received :

<iframe src=\"{base_url}/v1/checkout/{token}\"></iframe>\n\n

This iFrame will render the payment interface as configured in your Merchant Portal.

✅ *Tracking Payment Results_*_To track the payment result, subscribe to the message event. This will allow you to receive real-time updates about the payment status.

window.addEventListener('message', function(event) {\n  // Validate the origin of the message for security\n  if (event.origin !== '{base_url}') return;\n  const data = event.data;\n  // Handle the payment status\n  switch(data.type) {\n    case 'payment_success':\n      console.log('Payment succeeded:', data.data.id, data.data.status);\n      // Handle successful payment\n      break;\n    case 'payment_failed':\n      console.log('Payment failed:', data.message);\n      // Handle failed payment\n      break;\n    case 'payment_error':\n      console.log('Payment error:', data.message);\n      // Handle payment processing error\n      break;\n  }\n});\n\n

You will receive one of these three event payloads:

{\n  type: 'payment_error',\n  message: string\n}\n\n

{\n  type: 'payment_failed',\n  message: string\n}\n\n

{\n  type: 'payment_success',\n  data: {\n    id: string, // id of transaction/subscription\n    status: string, // status of transaction/subscription\n    interacUrl: string // in case of e-transfer transaction\n  }\n}\n\n

Use these events to update your user interface and backend systems accordingly.

⚠️ Domain Whitelisting Requirement

Important: The iFrame will only be rendered on web pages whose URLs match the domains registered under the Trusted Domains section in the Merchant Portal.
Ensure the intended website URL is added there before deploying the iFrame.

Request parameters

Option	Type	Description
`iframeId`	String required	The unique iFrame ID assigned through the BNA Merchant Portal
`customerId`	String required	The ID of the customer.
`customerInfo`	Object conditional	Contains all customer information.Required if the Customer ID is not provided.
├── `type`	String required	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String required	Contains all the information about the customer's email address.
├── `phoneCode`	String required	Customer's country calling code.
├── `phoneNumber`	String required	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 required	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name.Required for business customers.
├── `companyName`	String conditional	Customer's legal company name.Required for business customers.
├── `registrationName`	String conditional	Customer's legal registration name.Required for business customers.
├── `retailName`	String conditional	Customer's legal retail name.Required for business customers.
├── `billingAddress`	Object required	Contains all the information about the customer's billing address.
├──── `apartment`	String required	Customer's apartment number.
├──── `streetNumber`	String required	Customer's street number.
├──── `streetName`	String required	Customer's street name.
├──── `city`	String required	Customer's city.
├──── `province`	String required	Customer's province or state (full name).
├──── `country`	String required	Customer's country (full name).
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
├── `shippingAddress`	Object required	Contains all the information about the customer's shipping address.
├──── `apartment`	String required	Customer's apartment number.
├──── `streetNumber`	String required	Customer's street number.
├──── `streetName`	String required	Customer's street name.
├──── `city`	String required	Customer's city.
├──── `province`	String required	Customer's province or state (full name).
├──── `country`	String required	Customer's country (full name).
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").
`additionalInfo`	Object required	Contains all customer's additional information.
`field1 - field6`	String required	User defined fields 1 through 6. These can be used to
`recurrence`	Object conditional	Specifies the frequency of recurring payments.Possible values: `DAILY`, `WEEKLY`, `BI-WEEKLY`, `MONTHLY`, `EVERY-3-MONTHS`, `EVERY-6-MONTHS`, `YEARLY`. This parameter is mandatory if the `recurring` parameter is set to true.
`remainingPayments`	Number Integer conditional	Number of payments to be created. If this parameter is missing, the subscription will not have an expiration date, or in the case of a PAYMENT CARD, it will be counted automatically until the expiration PAYMENT CARD.
`startPaymentDate`	Date ISO 8601 conditional	The date for the initial payment in the subscription cycle to be delayed. If not provided, the first payment will be processed right away.
`subtotal`	Number Float to two decimal places required	Total of amounts found in the cart items, excluding BNA Smart Payment Systems applied fees, if any.
`saveCustomer`	Boolean required	Whether to persist the customer in BNA Smart Payment Systems. When true, a customerId is created and included in the webhook update.Possible values: true, false
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"item\" object.
├── `description`	String required	The name of the item being purchased, which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places required	The per-unit price for the given item without the currency symbol (e.g., 10.55 if the price is $10.55 per unit).It could be positive and negative number.
├── `quantity`	Number Integer required	The number of units purchased.
└── `amount`	Number Float to two decimal places required	The per-unit price for the given item multiplied by the quantity (e.g., If the per-unit price is 10.55 and the quantity is 2, then the amount is 21.10, where 10.55 x 2 = 21.10).It could be positive and negative number.

Response parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Description
`token`	String	A secure `token` that must be included in the src attribute of the iframe tag, as shown in the example:

","urlObject":{"path":["v1","checkout"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"36b96333-b7c2-4d26-9ca1-d30b5139ca76","name":"Check out","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"iframeId\": \"9af9523f-6934-42f0-8689-f7e2451b57d8\",\n \"recurrence\": \"WEEKLY\",\n \"customerInfo\": {\n \"email\": \"xokohac777@dawhe.com\",\n \"type\": \"BUSINESS\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4162223345\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15\",\n \"businessIdNumber\": \"2342\",\n \"legalName\": \"Angelica Sloan\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan\",\n \"billingAddress\": {\n \"apartment\": \"Suite 100\",\n \"streetNumber\": \"123\",\n \"streetName\": \"Main Street\",\n \"country\": \"Canada\",\n \"province\": \"Ontario\",\n \"city\": \"Toronto\",\n \"postalCode\": \"M5V 3A8\"\n },\n \"shippingAddress\": {\n \"apartment\": \"12\",\n \"streetNumber\": \"456\",\n \"streetName\": \"Shipping Lane\",\n \"country\": \"Canada\",\n \"province\": \"Ontario\",\n \"city\": \"Mississauga\",\n \"postalCode\": \"L5B 2N4\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"items\": [\n {\n \"amount\": 10,\n \"description\": \"Office Chair\",\n \"price\": 10,\n \"quantity\": 1,\n \"sku\": \"452611\"\n }\n ],\n \"subtotal\": 10,\n \"startPaymentDate\": \"2025-09-19 22:31:22\",\n \"remainingPayments\": 10,\n \"saveCustomer\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-service.bnasmartpayment.com/v1/checkout"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"content-type","value":"application/json"},{"key":"content-length","value":"44"},{"key":"x-trace-id","value":"fc1e484c160fdc36228d41a5f838cdf5"},{"key":"date","value":"Thu, 18 Sep 2025 16:37:32 GMT"},{"key":"x-envoy-upstream-service-time","value":"87"},{"key":"server","value":"istio-envoy"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"token\": \"rOV6qBK6sA4P2FoCiF01DTon6qHIVaqS\"\n}"}],"_postman_id":"f3310c44-4c22-4a8c-ab1d-c4e5c32b3444"}],"id":"9d83ec64-664e-450b-8960-5c60c0a6549c","description":"

BNA Smart Payment Customizable iFrame

BNA Smart Payment offers merchants a powerful, secure, and fully customizable iFrame solution for seamless online payment integration. Designed with flexibility and user experience in mind, our iFrame allows clients to match the look and feel of their existing website while benefiting from advanced features and robust security — all without the burden of maintaining PCI compliance independently.

Key Features and Benefits

1. Full Visual Customization

Merchants can tailor the appearance of the iFrame directly through the BNA Merchant Portal:

Color Branding: Customize button, input borders, and icon colors to match your website’s theme.
\n
Logo Support: Add your company logo for a branded payment experience.
\n
Layout Flexibility: Choose input field shapes (rounded or rectangular) and fonts for a consistent UI.
\n
Seamless Integration: Match the design of the host website so customers perceive a unified experience.
\n

2. Flexible Content and Messaging

Custom Titles & Subtitles: Personalize iFrame headings and button labels.
\n
Multiple iFrames per Website: Create and configure separate iFrames for different pages or workflows based on your site’s structure.
\n

3. Dynamic Payment Setup

One-Time or Recurring Payments: Configure the iFrame for single purchases or subscription-based billing.
\n
Apply Fees Option: Easily include processing or convenience fees in the transaction.
\n

4. Rich Customer Data Collection

Optional Fields: Capture phone numbers, billing addresses, and birthdates as needed.
\n
Support for Individual and Business Customers: Display customized input forms based on the customer type.
\n

5. Saved Customer and Payment Methods

Repeat Customer Support: Enable returning users to save profiles and payment methods securely.
\n
Tokenized Storage: Utilize customer IDs and payment method IDs for secure, tokenized future transactions.
\n

6. Legal and Policy Integration

Terms and Privacy Policy Links: Embed links to your Terms of Service and Privacy Policy directly in the iFrame for compliance and transparency.

iFrame Testing Environment

To simplify integration and ensure proper setup before going live, BNA Smart Payment provides a dedicated iFrame testing page:

🔗 Test URL

https://payment-test-iframe.bnasmartpayment.com

🧪 How to Use the Test Environment

Register the Test Domain
Log in to the Merchant Portal, navigate to the iFrame settings, and add the test URL payment-test-iframe.bnasmartpayment.com under the Trusted Domain section.
\n
Generate a Secure Token
Send a POST request to the following endpoint as described in the main documentation: Check out - POST {{base_url}}/v1/checkout
\n

Include your Basic Authentication credentials and the payload reflecting your iFrame configuration. If successful, a secure token with a 30-minute lifetime will be returned.

Open the Test Page
Visit https://payment-test-iframe.bnasmartpayment.com.
\n
Select Environment
On the test page, choose the Staging environment from the available options.
\n
Enter the Token
Paste the token received from the previous API request into the Token field on the test page.
\n
Click \"Submit\"
If all steps were performed correctly, the iFrame will render on the page, showing your customized payment interface exactly as it would appear on your live site.
\n

Use Cases

E-Commerce: Provide a smooth, branded checkout directly on your website.
\n
Donation Platforms: Collect one-time or recurring donations with a secure, trusted interface.
\n
Subscription Services: Enable recurring billing with saved customer credentials.
\n
Service Providers: Customize data collection fields and payment options based on service requirements.
\n

Conclusion

The BNA Smart Payment iFrame is a secure, adaptable, and visually customizable solution that simplifies online payment integration. Whether you run an online store, service-based business, or donation platform, our iFrame provides a professional user experience while keeping your payment flow PCI-compliant and fully secure.

\n","_postman_id":"9d83ec64-664e-450b-8960-5c60c0a6549c"},{"name":"Webhooks","item":[{"name":"Customers","item":[{"name":"Customers","id":"5d71dc54-924f-4db8-b17c-dea96f392a84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4163337760\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15T05:00:00.000Z\",\n \"type\": \"BUSINESS\",\n \"legalName\": \"Angelica Sloan\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan Inc.\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Richmond\",\n \"postalCode\": \"V6X 2C9\",\n \"apartment\": \"54\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n },\n \"status\": \"ACTIVE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}","urlObject":{"host":["{{URL_provided_by_Merchant}}"],"query":[],"variable":[]}},"response":[{"id":"56415e71-4e76-47eb-bb56-fc89c0763989","name":"Customers","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4163337760\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15T05:00:00.000Z\",\n \"type\": \"BUSINESS\",\n \"legalName\": \"Angelica Sloan\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan Inc.\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Richmond\",\n \"postalCode\": \"V6X 2C9\",\n \"apartment\": \"54\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n },\n \"status\": \"ACTIVE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"text/html; charset=UTF-8"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-request-id","value":"a4aedc48-104a-40be-a434-7547d5817b82"},{"key":"x-token-id","value":"c4437aff-d02b-42f5-9a3b-89c0c5571f13"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Wed, 24 Sep 2025 12:21:31 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"5d71dc54-924f-4db8-b17c-dea96f392a84"}],"id":"44649d7d-e772-4639-811a-9c63db5d2ab9","description":"

Customer Events Overview

Customer Events (`customer.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*`)

Customer events occur when user accounts and profiles are created, updated or deleted.

Available customer events:
customer.created – Triggered when customer has been created
customer.updated – Triggered when customer has been updated
customer.deleted – Triggered when customer has been deleted

When a Customers event is triggered, the webhook request body contains a JSON object with the following parameters:

Payload parameters

Option	Type	Description
`id`	String required	Customer's ID.
`type`	String required	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`status`	String required	Customer's status Possible values: `ACTIVE` when `customer.created` and `customer.updated` events occur.And `DELETED` when `customer.deleted` event occur
`email`	String required	Customer's email address.
`phoneCode`	String optional	Customer's country calling code.
`phoneNumber`	String optional	Customer's phone number.
`firstName`	String required	Customer's first name.
`lastName`	String required	Customer's last name.
`birthDate`	Date ISO 8601 optional	Customer's birthday date.
`legalName`	String conditional	Customer's legal business name. Required for business customer.
`businessIdNumber`	String conditional	Customer's legal business number. Required for business customer.
`businessName`	String conditional	Customer's business name. Required for business customer.
`companyName`	String conditional	Customer's legal company name. Required for business customer.
`registrationName`	String conditional	Customer's legal registration name. Required for business customer.
`retailName`	String conditional	Customer's legal retail name. Required for business customer.
`billingAddress`	Object required	An object which contains all the information about the customer's address.
├── `apartment`	String optional	Customer's apartment number.
├── `streetNumber`	String optional	Customer's street number.
├── `streetName`	String optional	Customer's street name.
├── `city`	String optional	Customer's city.
├── `province`	String optional	Customer's province/state.
├── `country`	String optional	Customer's country.
└── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object	An object which contains the customer's additional info.
└── `shippingAddress`	Object required	An object which contains all the information about the customer's address.
├── `apartment`	String optional	Customer's apartment number.
├── `streetNumber`	String optional	Customer's street number.
├── `streetName`	String optional	Customer's street name.
├── `city`	String optional	Customer's city.
├── `province`	String optional	Customer's province/state.
├── `country`	String optional	Customer's country.
└── `postalCode`	String required	USA customers: 5-digit ZIP code (eg. \"12345\").Canadian customers: 6-character alphanumeric postal code (eg. \"A1A1A1\").
`additionalInfo`	Object optional	An object which contains the customer's additional info.
`field1 - field6`	String optional	User defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.

","_postman_id":"44649d7d-e772-4639-811a-9c63db5d2ab9"},{"name":"Transactions","item":[{"name":"Transactions","id":"4548f3b3-a4d1-46be-bdbc-9ede04bb4b87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"b45482ca45e074e34abf\",\n \"referenceUUID\": \"b45482ca45e074e34abf\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4163337760\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15T05:00:00.000Z\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan Inc.\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Richmond\",\n \"postalCode\": \"V6X 2C9\",\n \"apartment\": \"54\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-24T13:31:57.793Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"PROCESSING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 7,\n \"subtotal\": 25,\n \"total\": 32,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardBrand\": \"VISA\",\n \"cardType\": \"CREDIT\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"4488\",\n \"invoiceAdditionalInfo\": \"Office Chairs\"\n },\n \"contractInfo\": {\n \"contractId\": \"4488\",\n \"contractAdditionalInfo\": \"Contract Information\",\n \"contractStartDate\": \"2025-09-24T14:31:16.663Z\",\n \"contractExpireDate\": \"2025-09-30T14:31:16.663Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 25,\n \"description\": \"Description\",\n \"price\": 12.5,\n \"quantity\": 2,\n \"sku\": \"2345\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n },\n \"declineReason\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}","urlObject":{"host":["{{URL_provided_by_Merchant}}"],"query":[],"variable":[]}},"response":[{"id":"b2b05ade-125e-426c-b226-ab83f36adf9f","name":"Transactions","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"b45482ca45e074e34abf\",\n \"referenceUUID\": \"b45482ca45e074e34abf\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4163337760\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15T05:00:00.000Z\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan Inc.\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Richmond\",\n \"postalCode\": \"V6X 2C9\",\n \"apartment\": \"54\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"subscriptionId\": null,\n \"transactionTime\": \"2025-09-24T13:31:57.793Z\",\n \"paymentMethod\": \"CARD\",\n \"status\": \"PROCESSING\",\n \"action\": \"SALE\",\n \"currency\": \"CAD\",\n \"fee\": 7,\n \"subtotal\": 25,\n \"total\": 32,\n \"amount\": 0,\n \"balance\": 0,\n \"paymentDetails\": {\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardBrand\": \"VISA\",\n \"cardType\": \"CREDIT\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"4488\",\n \"invoiceAdditionalInfo\": \"Office Chairs\"\n },\n \"contractInfo\": {\n \"contractId\": \"4488\",\n \"contractAdditionalInfo\": \"Contract Information\",\n \"contractStartDate\": \"2025-09-24T14:31:16.663Z\",\n \"contractExpireDate\": \"2025-09-30T14:31:16.663Z\"\n },\n \"transactionComment\": null,\n \"items\": [\n {\n \"amount\": 25,\n \"description\": \"Description\",\n \"price\": 12.5,\n \"quantity\": 2,\n \"sku\": \"2345\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n },\n \"declineReason\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"4548f3b3-a4d1-46be-bdbc-9ede04bb4b87"}],"id":"6dff24fc-0af8-4f4e-85d5-6499def8f454","description":"

Transaction Events Overview

Transaction Events (`transaction.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*`)

Notifies when a payment transaction changes state.

Available transactions events:
transaction.created – Triggered when transaction has been created and sent to processing
transaction.processed – Triggered when transaction has been processed by BNA and waiting for external action
transaction.approved – Triggered when transaction has been approved
transaction.declined – Triggered when transaction has been declined
transaction.canceled – Triggered when transaction has been canceled
transaction.updated – Triggered when transaction has been updated

Transaction Options Documentation

This table provides a detailed description of the transaction options available for developers. Each option includes its type and a description.
When a Transaction event is triggered, the webhook request body contains a JSON object with the following parameters:

Payload parameters

Option	Type	Description
`id`	String required	Unique identifier for the transaction.
`referenceUUID`	String required	Unique reference UUID for the transaction.
`customerId`	String optional	Unique identifier for the customer.
`customerInfo`	Object conditional	Contains all customer information. Required if the Customer ID is not provided.
`type`	String required	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
`email`	String required	Customer's email address.
`phoneCode`	String optional	Customer's country calling code.
`phoneNumber`	String optional	Customer's phone number.
`firstName`	String required	Customer's first name.
`lastName`	String required	Customer's last name.
`birthDate`	Date ISO 8601 optional	Customer's date of birth.
`legalName`	String conditional	Customer's legal business name. Required for business customers.
`businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
`businessName`	String conditional	Customer's business name. Required for business customers.
`companyName`	String conditional	Customer's legal company name. Required for business customers.
`registrationName`	String conditional	Customer's legal registration name. Required for business customers.
`retailName`	String conditional	Customer's legal retail name. Required for business customers.
`billingAddress`	Object required	Contains all the information about the customer's address.
`apartment`	String optional	Customer's apartment number.
`streetNumber`	String optional	Customer's street number.
`streetName`	String optional	Customer's street name.
`city`	String optional	Customer's city.
`province`	String optional	Customer's province or state (full name).
`country`	String optional	Customer's country (full name).
`postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
`shippingAddress`	Object required	Contains all the information about the customer's address.
`apartment`	String optional	Customer's apartment number.
`streetNumber`	String optional	Customer's street number.
`streetName`	String optional	Customer's street name.
`city`	String optional	Customer's city.
`province`	String optional	Customer's province or state (full name).
`country`	String optional	Customer's country (full name).
`postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
`additionalInfo`	Object required	Contains additional information about the customer.
`field1 - field6`	String optional	Custom fields for user-defined information. These can reference internal transaction numbers and are returned unmodified in the response.
`subscriptionId`	String optional	Unique identifier for the subscription.
`transactionTime`	Date required	Timestamp of the transaction.
`paymentMethod`	String required	Payment method used for the transaction. Possible values: `CARD`, `E-TRANSFER`, `EFT`, `CHEQUE`, `CASH`, `APPLE-PAY`, `GOOGLE-PAY`,`SAMSUNG-PAY`
`status`	String required	Status of the transaction. Possible values: `APPROVED` when `transaction.approved` event occurs,`PROCESSING` when `transaction.created` event occurs,`DECLINED` when `transaction.declined` event occurs, `PENDING` when `transaction.processed` event occurs, `CANCELED` when `transaction.canceled` event occurs
`action`	String required	Action taken for the transaction. Possible values: `SALE`, `PAYOUT`, `RESERVE`, `COMPLETE`, `REFUND`, `CANCEL`, `VOID`, `VERIFICATION`.
`currency`	String required	Currency of the transaction. Possible values: `CAD`, `USD`.
`fee`	Number Float to two decimal places required	Amount of the payment processing fee applied by BNA Smart Payment Systems.
`subtotal`	Number Float to two decimal places required	Subtotal amount of the items in the cart, excluding any applied fees.
`total`	Number Float to two decimal places required	Total amount to be paid by the customer, including subtotal and any applied fees.
`amount`	Number Float to two decimal places required	Total amount to be paid by the customer, including subtotal and any applied fees.
`balance`	Number Float to two decimal places required	Available amount that can be refunded.
`paymentDetails`	Object required	Contains detailed information about the payment.
E_TRANSFER PAYMENT METHOD
├── `deliveryType`	String required	Payment method type.Possible values: EMAIL,SMS,NONE
├── `name`	String required	Customer's e-transfer Payment Method name.
└── `email`	String conditional	Customer's Interac email.Required if deliveryType is EMAIL
├── `id`	String required	Customer's e-transfer payment id by phone.
├── `deliveryType`	String required	Payment method type.
├── `name`	String required	Customer's e-transfer Payment Method name.
├── `phoneNumber`	String conditional	Customer's Interac phone.Required if deliveryType is SMS
└── `phoneCode`	String conditional	Customer's Interac phone code.Required if deliveryType is SMS
EFT PAYMENT METHOD
├── `bankName`	String required	Customer's EFT Payment Method bank name.
├── `bankNumber`	String required	Customer's EFT Payment Method bank number.
├── `accountNumber`	String required	The last three numbers of the Customer's EFT Payment Method account number.
└── `transitNumber`	String required	The last two numbers of the Customer's EFT Payment Method transit number.
CARD PAYMENT METHOD
├── `cardType`	String required	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`.
├── `cardHolder`	String required	Customer's Card Payment Method card holder.
├── `cardBrand`	String	Customer's Card Payment Method card brand. Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`.
├── `cardNumber`	String required	The last four numbers of the Customer's Card Payment Method card number.
├── `expiryMonth`	String required	2 digits Card expiration month.
└── `expiryYear`	String required	2 digits Card expiration year.
`invoiceInfo`	Object required	An object which contains additional information about the invoice.
├── `invoiceId`	String required	Invoice number
└── `invoiceAdditionalInfo`	String required	Invoice additional info
├── `contractInfo`	Object required	An object which contains additional information about the contract.
├── `contractId`	String required	Contract number
├── `contractAdditionalInfo`	String required	Contract additional info
├── `contractStartDate`	Date required	Contract start date
└── `contractExpireDate`	Date required	Contract expiration date
`transactionComment`	String required	Transaction comment
`items`	Array required	An array of \"cartItems\" objects. Must contain at least one \"cartItems\" object.
├── `description`	String required	The name of the item being purchased which will be displayed to the customer.
├── `sku`	String required	The SKU of the item.
├── `price`	Number Float to two decimal places	The per unit price for the given item without the currency symbol e.g. 10.55 if the price is $10.55 per unit.
├── `quantity`	Number Integer required	The number of units purchased.
└── `amount`	Number Float to two decimal places required	The per unit price for the given item multiplied by the quantity e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10
`declineReason`	String required	A reason for declining a transaction
`metadata`	Object optional	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","_postman_id":"6dff24fc-0af8-4f4e-85d5-6499def8f454"},{"name":"Subscriptions","item":[{"name":"Subscriptions","id":"10f1f8fd-5a5e-4824-99bc-d60df17023fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"5832cce9-40fd-44b4-9f36-8304bff4104d\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4163337760\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15T05:00:00.000Z\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan Inc.\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Richmond\",\n \"postalCode\": \"V6X 2C9\",\n \"apartment\": \"54\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"recurrence\": \"WEEKLY\",\n \"action\": \"SALE\",\n \"subtotal\": 283.2,\n \"currency\": \"CAD\",\n \"applyFee\": true,\n \"startPaymentDate\": \"2025-09-24T14:31:16.663Z\",\n \"remainingPayments\": 20,\n \"paymentMethod\": \"CARD\",\n \"paymentDetails\": {\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardBrand\": \"VISA\",\n \"cardType\": \"CREDIT\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"4488\",\n \"invoiceAdditionalInfo\": \"Office Chairs\"\n },\n \"items\": [\n {\n \"amount\": 283.2,\n \"description\": \"office chairs\",\n \"price\": 23.6,\n \"quantity\": 12,\n \"sku\": \"3366\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n },\n \"status\": \"NEW\",\n \"managementUrl\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}","urlObject":{"host":["{{URL_provided_by_Merchant}}"],"query":[],"variable":[]}},"response":[{"id":"0a275363-a4db-49aa-ba3f-55bd2916afbe","name":"Subscriptions","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"5832cce9-40fd-44b4-9f36-8304bff4104d\",\n \"customerId\": \"b45e4091-403c-401c-8eb6-c2acd67fe12b\",\n \"customerInfo\": {\n \"email\": \"nacipej999@bawsny.com\",\n \"phoneCode\": \"+1\",\n \"phoneNumber\": \"4163337760\",\n \"firstName\": \"Angelica\",\n \"lastName\": \"Sloan\",\n \"birthDate\": \"1986-05-15T05:00:00.000Z\",\n \"businessIdNumber\": \"656565\",\n \"businessName\": \"Angelica Sloan\",\n \"companyName\": \"Angelica Sloan Inc.\",\n \"registrationName\": \"Angelica Sloan\",\n \"retailName\": \"Angelica's Kitchen\",\n \"type\": \"BUSINESS\",\n \"billingAddress\": {\n \"streetName\": \"Ackroyd Road\",\n \"streetNumber\": \"7788\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Richmond\",\n \"postalCode\": \"V6X 2C9\",\n \"apartment\": \"54\"\n },\n \"shippingAddress\": {\n \"streetName\": \"Lougheed Highway\",\n \"streetNumber\": \"4664\",\n \"apartment\": \"12\",\n \"country\": \"Canada\",\n \"province\": \"British Columbia\",\n \"city\": \"Burnaby\",\n \"postalCode\": \"V5C 3Y2\"\n },\n \"additionalInfo\": {\n \"field1\": \"Field 1\",\n \"field2\": \"Field 2\",\n \"field3\": \"Field 3\",\n \"field4\": \"Field 4\",\n \"field5\": \"Field 5\",\n \"field6\": \"Field 6\"\n }\n },\n \"recurrence\": \"WEEKLY\",\n \"action\": \"SALE\",\n \"subtotal\": 283.2,\n \"currency\": \"CAD\",\n \"applyFee\": true,\n \"startPaymentDate\": \"2025-09-24T14:31:16.663Z\",\n \"remainingPayments\": 20,\n \"paymentMethod\": \"CARD\",\n \"paymentDetails\": {\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Angelica Sloan\",\n \"cardBrand\": \"VISA\",\n \"cardType\": \"CREDIT\",\n \"expiryMonth\": \"11\",\n \"expiryYear\": \"30\"\n },\n \"invoiceInfo\": {\n \"invoiceId\": \"4488\",\n \"invoiceAdditionalInfo\": \"Office Chairs\"\n },\n \"items\": [\n {\n \"amount\": 283.2,\n \"description\": \"office chairs\",\n \"price\": 23.6,\n \"quantity\": 12,\n \"sku\": \"3366\"\n }\n ],\n \"metadata\": {\n \"test1\": \"string\",\n \"test2\": true,\n \"test3\": false,\n \"test4\": 123456,\n \"test5\": null,\n \"test6\": \"Ontario\",\n \"test7\": \"N2A 5N1\",\n \"test8\": \"Toronto\",\n \"test9\": -7.5,\n \"test10\": \"2025-01-27T01:58:06.057Z\"\n },\n \"status\": \"NEW\",\n \"managementUrl\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"10f1f8fd-5a5e-4824-99bc-d60df17023fb"}],"id":"06294902-424b-4b6d-862b-30a0e84849c2","description":"

Subscription Events Overview

Subscription Events (`subscription.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*`)

Subscription events track recurring payment subscriptions and their lifecycle management.

Covers recurring billing or subscription lifecycle changes.
Available subscriptions events:
subscription.created – Triggered when subscription has been created
subscription.processed – Triggered when transaction by subscription has been processed
subscription.will_expire – Triggered if subscription expires in 10 days
subscription.updated – Triggered when subscription has been updated
subscription.deleted – Triggered when subscription has been deleted

When a Subscription event is triggered, the webhook request body contains a JSON object with the following parameters:

Payload Parameters

Option	Type	Description
`id`	String required	The unique identifier for the subscription.
`customerId`	String optional	Customer ID.
`customerInfo`	Object conditional	An object which contains all the information about the Customer.
├── `type`	String required	Customer type. Possible values: `BUSINESS` or `PERSONAL`.
├── `email`	String required	Customer's email address.
├── `phoneCode`	String required	Customer's country calling code.
├── `phoneNumber`	String required	Customer's phone number.
├── `firstName`	String required	Customer's first name.
├── `lastName`	String required	Customer's last name.
├── `birthDate`	Date ISO 8601 optional	Customer's date of birth.
├── `legalName`	String conditional	Customer's legal business name.
├── `businessIdNumber`	String conditional	Customer's legal business number. Required for business customers.
├── `businessName`	String conditional	Customer's business name.
├── `companyName`	String conditional	Customer's legal company name.
├── `registrationName`	String conditional	Customer's legal registration name.
├── `retailName`	String conditional	Customer's legal retail name.
└── `billingAddress`	Object required	Contains all the information about the customer's address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String required	Customer's street number.
├──── `streetName`	String required	Customer's street name.
├──── `city`	String required	Customer's city.
├──── `province`	String ISO 3166-2 required	Customer's province/state. The complete ISO 3166-2 code consists of two parts, separated by a hyphen (e.g., \"ON-CA\"). See Wikipedia.
├──── `country`	String ISO 3166-1 alpha-2 required	Customer's country. The ISO 3166-1 alpha-2 country code (e.g., \"CA\"). See Wikipedia.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
└── `shippingAddress`	Object required	Contains all the information about the customer's address.
├──── `apartment`	String optional	Customer's apartment number.
├──── `streetNumber`	String required	Customer's street number.
├──── `streetName`	String required	Customer's street name.
├──── `city`	String required	Customer's city.
├──── `province`	String ISO 3166-2 required	Customer's province/state. The complete ISO 3166-2 code consists of two parts, separated by a hyphen (e.g., \"ON-CA\"). See Wikipedia.
├──── `country`	String ISO 3166-1 alpha-2 required	Customer's country. The ISO 3166-1 alpha-2 country code(e.g., \"CA\"). See Wikipedia.
└──── `postalCode`	String required	USA customers: 5-digit ZIP code (e.g., \"12345\").Canadian customers: 6-character alphanumeric postal code (e.g., \"A1A1A1\").
`additionalInfo`	Object	Contains the customer's additional information.
`field1 - field6`	String optional	User-defined fields 1 through 6. These can be used to reference your internal transaction number, etc. These fields are returned unmodified in the response.
`recurrence`	String conditional	The frequency of the recurring payment. This field is required if `recurring` is set to `true`. Possible values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `BIANNUAL`, `ANNUAL`.
`action`	String required	The subscription's action.Possible values: `SALE`, `PAYOUT`.
`currency`	String required	The currency of the transaction. Possible values: `CAD`, `USD`.
`applyFee`	Boolean required	Indicates whether the BNA Smart Payment Systems fee should be applied to the customer. Possible values: `true` or `false`. When set to `true`, the merchant's payment processing fees will be passed to the customer.
`startPaymentDate`	Date ISO 8601 required	The start date for the recurring payments.
`remainingPayments`	Number required	The number of remaining recurring payments.
`paymentMethod`	String required	The payment method chosen by the customer.Possible values: `CARD`,`EFT`,`E_TRANSFER`,`CASH`,`CHEQUE`,`APPLE-PAY`,`GOOGLE-PAY`,`SAMSUNG-PAY`
`invoiceInfo`	Object conditional	Contains additional information about the invoice.
├── `invoiceId`	String conditional	The invoice number.
└── `invoiceAdditionalInfo`	String conditional	Additional information about the invoice.
`contractInfo`	Object conditional	Contains additional information about the contract.
├── `contractId`	String conditional	The contract number.
├── `contractAdditionalInfo`	String conditional	Additional information about the contract.
├── `contractStartDate`	Date conditional	The start date of the contract.
└── `contractExpireDate`	Date conditional	The expiration date of the contract.
`items`	Array required	An array of cart item objects. Must contain at least one cart item object.
├── `description`	String required	The name of the item being purchased, displayed to the customer.
├── `sku`	String required	The SKU (Stock Keeping Unit) of the item.
├── `price`	Number Float to two decimal places required	The unit price of the item, without the currency symbol. e.g., 10.55 if the price is $10.55 per unit.
├── `quantity`	Number Integer required	The number of units being purchased.
└── `amount`	Number Float to two decimal places	The per unit price for the given item multiplied by the quantity.e.g. If the per unit price is 10.55 and the quantity is 2, then the ‘amount’ is 21.10 where 10.55 x 2 = 21.10
`status`	String required	Filters transactions based on their status. Possible values: `NEW` when `subscription.created` event occurs, `ACTIVE` when `subscription.processed` and `subscription.updated` events occur, `SUSPENDED` when `subscription.updated` event occurs, `DELETED` when `subscription.deleted` event occurs
`subtotal`	Number Float to two decimal places required	The total amount of the items in the cart, excluding any BNA Smart Payment Systems fees.
`paymentDetails`	Object required	An object which contains information about the payment details.
E-TRANSFER PAYMENT METHOD
`name`	String required	Customer's Interac full name.
`message`	String optional	Optional message to include in the Interac e-Transfer request.
`deliveryType`	String required	Method used to deliver the transfer notification.Possible value: EMAIL, SMS, or NONE.
`email`	String conditional	Recipient’s email address. Required if deliveryType is set to EMAIL.
`phoneCode`	String conditional	Recipient’s phone code address. Required if deliveryType is set to SMS.
`phoneNumber`	String conditional	Recipient’s phone number address. Required if deliveryType is set to SMS.
EFT PAYMENT METHOD
`bankName`	String required	Customer's EFT Payment Method bank name.
`bankNumber`	String required	Customer's EFT Payment Method bank number.
`accountNumber`	String required	The last three numbers of the Customer's EFT Payment Method account number.
`transitNumber`	String required	The last two numbers of the Customer's EFT Payment Method transit number.
CARD PAYMENT METHOD
`cardType`	String required	Customer's Card Payment Method type. Possible values: `CREDIT`, `DEBIT`.
`cardHolder`	String required	Customer's Card Payment Method card holder.
`cardBrand`	String required	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`.
`cardNumber`	String required	The last four numbers of the Customer's Card Payment Method card number.
`expiryMonth`	String required	2 digits Card expiration month.
`expiryYear`	String required	2 digits Card expiration month.
`comment`	String required	Subscription comment.
`managementUrl`	String required	URL for subscription management which can be provided to the customer.
`metadata`	Object required	An object containing up to ten \"metadata\" properties of type String, Boolean, Null, or a Number.

","_postman_id":"06294902-424b-4b6d-862b-30a0e84849c2"},{"name":"Payment Methods","item":[{"name":"Payment Methods","id":"92dc6cca-66bf-4c54-9204-46896a8071e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"327f4287-3cbb-48cc-b745-2bcc5a8ff06e\",\n \"method\": \"CARD\",\n \"createdAt\": \"2025-09-24T14:57:48.172Z\",\n \"currency\": \"CAD\",\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Jason Johnson\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"32\",\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}","urlObject":{"host":["{{URL_provided_by_Merchant}}"],"query":[],"variable":[]}},"response":[{"id":"0c570038-481e-4e12-a976-5a5d3e756c01","name":"Payment Methods","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"327f4287-3cbb-48cc-b745-2bcc5a8ff06e\",\n \"method\": \"CARD\",\n \"createdAt\": \"2025-09-24T14:57:48.172Z\",\n \"currency\": \"CAD\",\n \"cardNumber\": \"************1111\",\n \"cardHolder\": \"Jason Johnson\",\n \"cardType\": \"CREDIT\",\n \"cardBrand\": \"VISA\",\n \"expiryMonth\": \"12\",\n \"expiryYear\": \"32\",\n \"customerId\": \"7cf4adb1-9e68-43ed-b4c7-4f712c4642f7\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_provided_by_Merchant}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"92dc6cca-66bf-4c54-9204-46896a8071e5"}],"id":"64e7ecd9-106b-4ac5-be8b-e5b8609fff81","description":"

Payment Method Events Overview

Payment Method Events (`payment_method.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*`)

Tracks changes to saved payment methods.

Available payment method events:
payment_method.created – Triggered when a payment method has been created
payment_method.updated – Triggered when a payment method has been updated
payment_method.deleted– Triggered when a payment method has been deleted

When a Payment Method event is triggered, the webhook request body contains a JSON object with the following parameters:

Payload Parameters

Option	Type	Description
CARD Payment Method
`id`	String required	Customer's payment method ID
`customerId`	String required	Customer's ID
`method`	String required	Customer's payment method `CARD`
`cardType`	String required	Customer's Card Payment Method type.Possible values: `CREDIT`, `DEBIT`
`cardHolder`	String required	Customer's Card Payment Method card holder.
`cardBrand`	String required	Customer's Card Payment Method card brand.Possible values: `VISA`, `MASTERCARD`, `DISCOVER`, `AMEX`
`cardNumber`	String required	The last four numbers of the Customer's card number.
`expiryMonth`	String required 2 digits	Customer's Card Payment Method expiration month.
`expiryYear`	String required 2 digits	Customer's Card Payment Method expiration year.
`currency`	String required	Payment method currency Possible values `CAD` and `USD`
EFT Payment Method
`id`	String required	Customer's payment method ID
`customerId`	String required	Customer's ID
`method`	String required	Customer's payment method `EFT`
`bankName`	String required	Customer's EFT Payment Method bank name.
`bankNumber`	String required	Customer's EFT Payment Method bank number.
`accountNumber`	String required	The last four numbers of the Customer's EFT Payment Method account number.
`transitNumber`	String required	The last two numbers of the Customer's EFT Payment Method transit number.
`createdAt`	String required	Payment method creation time
E_TRANSFER Payment Method
`id`	String required	Customer's payment method ID
`customerId`	String required	Customer's ID
`method`	String required	Customer's payment method_ `E_TRANSFER`
`deliveryType`	String required	Payment method type.Possible values:`EMAIL`,`SMS`, `NONE`
`name`	String required	Customer's e-transfer Payment Method name.
`message`	String required	Customer's message
`email`	String conditional	Customer's Interac email. Required if deliveryType is `EMAIL`
`phoneNumber`	String conditional	Customer's Interac phone number.Required if deliveryType is `SMS`
`phoneCode`	String conditional	Customer's Interac phone code.Required if deliveryType is `SMS`
`createdAt`	String required	Payment method creation time

","_postman_id":"64e7ecd9-106b-4ac5-be8b-e5b8609fff81"}],"id":"48688e2d-cfa2-4219-a0e2-6e68cdf56d91","description":"

Webhook Documentation

This documentation provides comprehensive guidance for implementing and managing webhooks in our payment platform. Webhooks enable real-time notifications about important events in your system, such as transaction status changes, customer updates, and subscription activities. Learn how to securely receive, verify, and process webhook events using industry-standard HMAC authentication.

Event Types and Data Structure

Overview

Our webhook system organizes events using a hierarchical naming convention: domain.subdomain. Events within the same domain share identical payload structures, regardless of the subdomain. This consistent approach simplifies integration and ensures predictable data formats across related events.

Event Categories

Events are grouped into categories so Merchants can subscribe to only the data they need.

Webhook Request Format

Overview

When an event occurs in the system, a webhook sends an HTTP POST request to the specified URL with event details. The request contains special headers for authentication and a body with event data.

Request Structure

HTTP Method

POST

Headers

`X-Bna-Signature`

Type: string
\n
Description: HMAC-SHA256 signature for request authenticity verification
\n
Example: a1b2c3d4e5f6...
\n

`X-Bna-Timestamp`

Type: (ISO 8601) string
\n
Description: Exact timestamp of request creation in UTC
\n
Example: 2023-12-01T10:30:45.123Z
\n

`Content-Type`

Value: application/json

Request Body

{\n  \"event\": \"string\",\n  \"deliveryId\": \"string\",\n  \"configId\": \"string\", \n  \"data\": {\n    // Event data (depends on event type)\n  }\n}\n\n

Body Fields:

event (string): Type of event that occurred
\n
deliveryId (string): Unique identifier for webhook delivery
\n
configId (string): Webhook configuration identifier
\n
data (object): Data related to the event (structure depends on event type)
\n

Complete Request Example

POST https://your-webhook-endpoint.com/webhooks\nContent-Type: application/json\nX-Bna-Signature: d4f5e6a7b8c9d0e1f2a3b4c5d6e7f8g9h0i1j2k3l4m5n6o7p8q9r0s1t2u3v4w5x6y7z8\nX-Bna-Timestamp: 2023-12-01T10:30:45.123Z\n{\n  \"event\": \"customer.created\",\n  \"deliveryId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"configId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"data\": {\n   \"id\": \"4e9d9472-2fd1-4ebd-8cef-decd41e14b63\",\n  \"email\": \"hasihef288@dawhe.com\",\n  \"phoneCode\": \"+1\",\n  \"phoneNumber\": \"4169980000\",\n  \"firstName\": \"Richard\",\n  \"lastName\": \"Lowe\",\n  \"birthDate\": \"1968-09-27T04:00:00.000Z\",\n  \"type\": \"BUSINESS\",\n  \"legalName\": \"Richard Lowe Inc.\",\n  \"businessIdNumber\": \"227778\",\n  \"businessName\": \"Richard Lowe Inc.\",\n  \"companyName\": \"Richard Lowe Inc.\",\n  \"registrationName\": \"Richard Lowe Inc.\",\n  \"retailName\": \"Richard Lowe Inc.\",\n  \"billingAddress\": {\n    \"streetName\": \"Victoria Street\",\n    \"streetNumber\": \"244\",\n    \"apartment\": \"11A\",\n    \"country\": \"Canada\",\n    \"province\": \"Ontario\",\n    \"city\": \"Toronto\",\n    \"postalCode\": \"M5B 1V8\"\n  },\n  \"shippingAddress\": {\n    \"streetName\": \"Chemin de Chambly\",\n    \"streetNumber\": \"2877\",\n    \"apartment\": \"33\",\n    \"country\": \"Canada\",\n    \"province\": \"Québec\",\n    \"city\": \"Longueuil\",\n    \"postalCode\": \"J4L 1M8\"\n  },\n  \"additionalInfo\": {\n    \"field1\": \"Customer Field 1\",\n    \"field2\": \"Customer Field 2\",\n    \"field3\": \"Customer Field 3\",\n    \"field4\": \"Customer Field 4\",\n    \"field5\": \"Customer Field 5\",\n    \"field6\": \"Customer Field 6\"\n  },\n  \"status\": \"ACTIVE\"\n  }\n}\n\n

HMAC Signature Verification Algorithm for Webhooks

General Algorithm

Here's a step-by-step algorithm for verifying HMAC signatures on the receiver side:

Step 1: Extract Data from Request

Extract the request body (JSON data)
\n
Get the header (expected signature) X-Bna-Signature
\n
Get the header (timestamp) X-Bna-Timestamp
\n

Step 2: Validate Timestamp (Optional)

Ensure the request is not too old (e.g., not older than 5 minutes)
\n
This protects against replay attacks
\n

Step 3: Reproduce the Signing Algorithm

Serialize JSON data exactly the same way as the sender:
\n
- without spaces and indentation JSON.stringify(data, null, 0)
\n
Create SHA-256 hash of the serialized data
\n
Combine hash and timestamp with colon: hash:timestamp
\n
Create HMAC-SHA256 signature using the secret key
\n
Convert result to hex format
\n

Step 4: Compare Signatures

Use secure comparison (constant-time comparison)
\n
If signatures match - the request is authentic
\n

How to Get Your Webhook Secret Key

Overview

A Secret Key is required to verify the authenticity of webhook messages. This key is used to create and verify HMAC signatures, ensuring the security of your webhooks.

Step-by-Step Instructions

1. Log into Merchant Portal

Sign in to your Merchant Portal account
\n
Ensure you have the necessary permissions to manage webhooks
\n

2. Navigate to Webhooks Page

In the main menu, find and click on the section \"Merchant Profile\"
\n
Click on the \"Webhooks\" tab
\n
This will open the webhook management page
\n

3. Generate a New Key

Click the \"Generate webhook key\" button
\n
The system will generate a new unique secret key
\n
The key will be displayed on screen
\n

4. Save the Key

⚠️ Important: The key is displayed only once after generation!

Copy the key completely (usually a long string of characters)
\n
Save it in a secure location:
\n
- Password manager
  \n
- Environment variable
  \n
- Secure configuration storage
  \n
- Secret management system
  \n
\n

5. If You Lost Your Key

If you have lost your current key:

Click the \"Regenerate webhook key\" button
\n
Warning: The old key will become invalid
\n
Copy and save the new key
\n
Make sure to update the key everywhere it's being used
\n

\n","_postman_id":"48688e2d-cfa2-4219-a0e2-6e68cdf56d91"},{"name":"Error Codes","item":[],"id":"962ba3ee-1969-4847-8f12-bf7ab72f1502","description":"

Overview: Error Codes

The Error Codes section defines the standardized codes returned by the API when a request fails. Each code represents a specific type of error—such as invalid input, authentication failure, or server issues—allowing developers to quickly identify the problem and take corrective action. Responses typically include an HTTP status code, an error code, and a descriptive message to help diagnose and resolve the issue.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Status	Description
RETRIEVE MERCHANT ACCOUNT
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE CUSTOMER BY ID
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE CUSTOMERS LIST
BAD_REQUEST_ERROR	400	Validation error
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CREATE CUSTOMER
BAD_REQUEST_ERROR	400	Validation error
CUSTOMER_ALREADY_EXISTS	409	Customer already exists
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
UPDATE CUSTOMER
BAD_REQUEST_ERROR	400	Validation error
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
DELETE CUSTOMER
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE CUSTOMER'S PAYMENT METHODS LIST
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE CUSTOMER'S PAYMENT METHOD BY PAYMENT METHOD ID
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
ADD E-TRANSFER
BAD_REQUEST_ERROR	400	Validation error
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_ALREADY_EXISTS	409	Payment method already exists
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
ADD BANK TRANSFER (EFT)
BAD_REQUEST_ERROR	400	Validation error
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_ALREADY_EXISTS	409	Payment method already exists
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
ADD PAYMENT CARD
BAD_REQUEST_ERROR	400	Validation error
CARD_BRAND_NOT_ALLOWED	403	Processing {cardBrand} cards is not allowed. Contact support for more information
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_ALREADY_EXISTS	409	Payment method already exists
INVALID_CONFIG	429	Invalid config. Contact support for more information
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE TRANSACTION LIST
BAD_REQUEST_ERROR	400	Validation error
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE TRANSACTION BY ID
BAD_REQUEST_ERROR	400	Validation error
TRANSACTION_NOT_FOUND	404	Transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE TRANSACTION STATUS
BAD_REQUEST_ERROR	400	Validation error
TRANSACTION_NOT_FOUND	404	Transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
SEND TRANSACTION RECEIPT
TRANSACTION_NOT_FOUND	404	Transaction not found
CARD SALE
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
CARD_BRAND_NOT_ALLOWED	403	Processing Card Brand cards is not allowed. Contact support for more information
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CARD RESERVE
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
CARD_BRAND_NOT_ALLOWED	403	Processing {cardBrand} cards is not allowed. Contact support for more information
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CARD COMPLETE
BAD_REQUEST_ERROR	400	Validation error
INVALID_SUBTOTAL	400	The provided subtotal amount exceeds the available balance
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CARD REFUND
BAD_REQUEST_ERROR	400	Validation error
INVALID_SUBTOTAL	400	The provided subtotal amount exceeds the available balance
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CARD VOID
BAD_REQUEST_ERROR	400	Validation error
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
VOID_NOT_PROCESSABLE	422	The void transaction cannot be processed after settlement
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CARD VERIFICATION
BAD_REQUEST_ERROR	400	Validation error
CARD_BRAND_NOT_ALLOWED	403	Processing {cardBrand} cards is not allowed. Contact support for more information
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
E-TRANSFER SALE
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
ONLY_FOR_CANADA	403	E-Transfer processing allowed only for customers from Canada
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
E-TRANSFER PAYOUT
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
MISSING_SECURITY_QUESTION_ANSWER	400	Customer doesn't have DDR. Please provide security question and answer
FEATURE_NOT_ALLOWED	403	You are not allowed to use this feature. Contact support for more information
ONLY_FOR_CANADA	403	E-Transfer processing allowed only for customers from Canada
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
E-TRANSFER REFUND
BAD_REQUEST_ERROR	400	Validation error
MISSING_SECURITY_QUESTION_ANSWER	400	Customer doesn't have DDR. Please provide security question and answer
INVALID_SUBTOTAL	400	The provided subtotal amount exceeds the available balance
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
E-TRANSFER CANCEL
BAD_REQUEST_ERROR	400	Validation error
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
E-TRANSFER CHECK DDR
BAD_REQUEST_ERROR	400	Validation error
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
EFT SALE
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
ONLY_FOR_CANADA	403	E-Transfer processing allowed only for customers from Canada
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
EFT PAYOUT
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
FEATURE_NOT_ALLOWED	403	You are not allowed to use this feature. Contact support for more information
ONLY_FOR_CANADA	403	E-Transfer processing allowed only for customers from Canada
CUSTOMER_NOT_FOUND	404	Customer not found
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
EFT REFUND
BAD_REQUEST_ERROR	400	Validation error
INVALID_SUBTOTAL	400	The provided subtotal amount exceeds the available balance
PAYMENT_METHOD_NOT_FOUND	404	Payment method not found
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
EFT CANCEL
BAD_REQUEST_ERROR	400	Validation error
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CHEQUE SALE
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CHEQUE PAYOUT
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CHEQUE REFUND
BAD_REQUEST_ERROR	400	Validation error
INVALID_SUBTOTAL	400	The provided subtotal amount exceeds the available balance
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CHEQUE CANCEL
BAD_REQUEST_ERROR	400	Validation error
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CHEQUE UPDATE STATUS
BAD_REQUEST_ERROR	400	Validation error
MISSING_CHEQUE_NUMBER	400	Missing cheque number.
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CASH SALE
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CASH PAYOUT
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
CUSTOMER_NOT_FOUND	404	Customer not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CASH REFUND
BAD_REQUEST_ERROR	400	Validation error
INVALID_SUBTOTAL	400	The provided subtotal amount exceeds the available balance
REFERENCE_TRANSACTION_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE PAYMENT LINK LIST
BAD_REQUEST_ERROR	400	Validation error
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE PAYMENT LINK BY ID
PAYMENT_LINK_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CREATE PAYMENT LINK
BAD_REQUEST_ERROR	400	Validation error
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
FEATURE_NOT_ALLOWED	403	You are not allowed to use this feature. Contact support for more information
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CANCEL PAYMENT LINK
FEATURE_NOT_ALLOWED	403	You are not allowed to use this feature. Contact support for more information
PAYMENT_LINK_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RESEND PAYMENT LINK NOTIFICATION
FEATURE_NOT_ALLOWED	403	You are not allowed to use this feature. Contact support for more information
PAYMENT_LINK_NOT_FOUND	404	Reference transaction not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE SUBSCRIPTIONS LIST
BAD_REQUEST_ERROR	400	Validation error
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RETRIEVE SUBSCRIPTION BY ID
BAD_REQUEST_ERROR	400	Validation error
SUBSCRIPTION_NOT_FOUND	404	Subscription not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
CREATE SUBSCRIPTION
BAD_REQUEST_ERROR	400	Validation error
PAYOUT_NOT_PROCESSABLE	400	Cannot process payout for customer without DDR
SUBTOTAL_ITEMS_INCONSISTENCY	400	The subtotal amount does not match the sum of item prices
CUSTOMER_NOT_FOUND	404	Customer not found
FEATURE_NOT_ALLOWED	403	You are not allowed to use this feature. Contact support for more information
CARD_BRAND_NOT_ALLOWED	403	Processing {cardBrand} cards is not allowed. Contact support for more information
INVALID_PAYMENT_METHOD	404	Payment method not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
SUSPEND SUBSCRIPTION
SUBSCRIPTION_NOT_FOUND	400	Subscription not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
DELETE SUBSCRIPTION
SUBSCRIPTION_NOT_FOUND	400	Subscription not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
RESEND SUBSCRIPTION NOTIFICATION
SUBSCRIPTION_NOT_FOUND	400	Subscription not found
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information
IFRAME CHECKOUT
BAD_REQUEST_ERROR	400	Validation error
INVALID_START_PAYMENT_DATE	400	Start payment date should be in the future
FEATURE_NOT_ALLOWED	403	You are not allowed to use this feature. Contact support for more information
CUSTOMER_NOT_FOUND	404	Customer not found
IFRAME_NOT_FOUND	404	iFrame config not found
CUSTOMER_ALREADY_EXISTS	409	Customer already exists
UNEXPECTED_ERROR	500	Unexpected error occurred. Contact support for more information

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a05eedc5-a30c-4320-950b-1ac5f77c990d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cfd0ac06-b5b2-4f6d-868b-634023df0288"}}],"_postman_id":"962ba3ee-1969-4847-8f12-bf7ab72f1502"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"33f35b67-744e-4a14-94bf-47db14ccb49c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4721bd48-5aa9-4f16-a1c8-ad862566ccc3"}}]}