{"info":{"_postman_id":"51d66162-b58d-4043-adf1-c3b533c70512","name":"Developers Documentation","description":"

Our API is organized around REST. It has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27266646","collectionId":"51d66162-b58d-4043-adf1-c3b533c70512","publishedId":"2s9YJdWhLW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-10-31T12:51:23.000Z"},"item":[{"name":"General Information","item":[{"name":"Authentication","item":[],"id":"4c63b0f8-7726-42a0-b89d-855356ef43de","description":"

Our API uses Access Token to authenticate requests. You can view and manage your Access Token in the Dashboard.

The method we use for authentication is Bearer Authentication

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

\n
Warning Don't share your Access Token with anybody.
\n

Bearer Authentication

Bearer Authentication is an HTTP authentication scheme that involves security tokens called bearer tokens. The client must send this token in the Authorization header when making requests to protected resources.

Authorization: Bearer

\n","_postman_id":"4c63b0f8-7726-42a0-b89d-855356ef43de"},{"name":"Errors","item":[],"id":"cfc8e54c-2d5b-409f-82ec-ef4105936436","description":"

We use conventional HTTP response codes to indicate the success or failure of an API request.

The 2XX range indicates success.

The 4XX range indicates an error that failed given the information provided (e.g., a required parameter was omitted, etc.).

The 5XX range indicates an error with our servers (these are rare).

In addition, name, message, code, and status will be applied to the error response.

Example Response

{\n    \"name\":\"Unprocessable entity\",\n    \"message\":\"Amount cannot be blank.\",\n    \"code\":422,\n    \"status\":422\n}\n\n

\n","_postman_id":"cfc8e54c-2d5b-409f-82ec-ef4105936436"},{"name":"Responses","item":[],"id":"30aaff5c-66bb-4fec-93aa-c0f1f0972dc4","description":"

Our response will be divided into 3 sections:

items - contains the actual result of your request

_meta - contains meta information of your request like total results, number of pages, etc.

_links - contains links to the next page, last page, etc.

{\n    \"items\": [\n        // Results goes here\n    ],\n    \"_links\": {\n        \"self\": {\n            \"href\": \"/path?page=1&per-page=10\"\n        },\n        \"next\": {\n            \"href\": \"/path?page=2&per-page=10\"\n        },\n        \"last\": {\n            \"href\": \"/path?page=5&per-page=10\"\n        }\n    },\n    \"_meta\": {\n        \"totalCount\": 50,\n        \"pageCount\": 5,\n        \"currentPage\": 1,\n        \"perPage\": 10\n    }\n}\n\n

\n","_postman_id":"30aaff5c-66bb-4fec-93aa-c0f1f0972dc4"},{"name":"Filters","item":[{"name":"Example - gte","id":"246a8261-fd21-4a8a-b556-2952a3ab7467","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.paysecureonline.com/path?filter[createdOn][gte]=2023-01-01 00:00:00","description":"

Find all records created after 2023-01-01 00:00:00

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","name":"Filters","type":"folder"}},"urlObject":{"path":["path"],"host":["https://dashboard.paysecureonline.com"],"query":[{"key":"filter[createdOn][gte]","value":"2023-01-01 00:00:00"}],"variable":[]}},"response":[],"_postman_id":"246a8261-fd21-4a8a-b556-2952a3ab7467"},{"name":"Example - between","id":"967d62c5-2927-45e6-94fe-26258aef37fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.paysecureonline.com/path?filter[and][0][createdOn][gte]=2019-01-01 00:00:00&filter[and][0][createdOn][lte]=2019-01-01 23:59:59","description":"

Find all records created between 2019-01-01 00:00:00 and 2019-01-01 23:59:59

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","name":"Filters","type":"folder"}},"urlObject":{"path":["path"],"host":["https://dashboard.paysecureonline.com"],"query":[{"key":"filter[and][0][createdOn][gte]","value":"2019-01-01 00:00:00"},{"key":"filter[and][0][createdOn][lte]","value":"2019-01-01 23:59:59"}],"variable":[]}},"response":[],"_postman_id":"967d62c5-2927-45e6-94fe-26258aef37fd"},{"name":"Example - like","id":"ee3393db-178e-43b0-810d-494a01bdb2a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.paysecureonline.com/path?filter[customer.email][like]=example.com","description":"

Find all records whose email contains example.com

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","name":"Filters","type":"folder"}},"urlObject":{"path":["path"],"host":["https://dashboard.paysecureonline.com"],"query":[{"key":"filter[customer.email][like]","value":"example.com"}],"variable":[]}},"response":[],"_postman_id":"ee3393db-178e-43b0-810d-494a01bdb2a4"},{"name":"Example - in","id":"4c8c2842-f8af-47bd-b5eb-53bb98637195","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.paysecureonline.com/path?filter[id][in][]=1&filter[id][in][]=2","description":"

Find all records with IDs 1 or 2

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","id":"8c0ab957-1b05-46c5-97ac-db13c65fff79","name":"Filters","type":"folder"}},"urlObject":{"path":["path"],"host":["https://dashboard.paysecureonline.com"],"query":[{"key":"filter[id][in][]","value":"1"},{"key":"filter[id][in][]","value":"2"}],"variable":[]}},"response":[],"_postman_id":"4c8c2842-f8af-47bd-b5eb-53bb98637195"},{"name":"Example - non-empty","id":"5338aba1-94c5-4ea3-a687-fb45163f258c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.paysecureonline.com/path?filter[not][id]=NULL","description":"

Find all records with ID with non-empty values (ie. NOT NULL)

Filters will help you find what you search.

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

Parameters	Description
lt	Stands for the less-than sign <
gt	Stands for the greater-than sign >
lte	Stands for the less-than or equals sign <=
gte	Stands for the greater-than or equals sign >=
eq	Stands for the equals sign =
neq	Stands for the not equals sign !=
in	IN
nin	NOT IN
like	LIKE
or	OR
and	AND
not	Exclude specified values

Use NULL as a value if you want to select empty values.

\n
Only fields marked with Filterable can be used for filtering the results.
\n

If there are too many results of your request, we will enable pagination of the results.

Two parameters can control pagination page and per-page.

page - The page number you want to get. By default is 1.

per-page - Items per page. The value can be between 1 and 50. By default is 30.

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

Type	Description
Boolean	`Yes` or `No`
Integer	A number which is not a fraction; a whole number. `1`, `2`, `3`...
Number	Floating point numbers. `1.5`, `2.9`,`3.59`...
String	A string is a collection of characters, can contain alphanumeric characters.
ENUM	Enumeration type or ENUM for short, is a data type to categorize named values.
Date	Date is in the following format `YYYY-MM-DD` (Example: 2019-02-17) Always in `UTC` time zone
Datetime	Date and time is in the following format `YYYY-MM-DD HH:MM:SS` (Example: 2019-02-17 20:05:34) Always in `UTC` time zone.
Object	An object is a collection of properties, and a property is an association between a name/key and a value.

","_postman_id":"43512f4e-0734-4b26-a845-5bb9b1dcbbeb"}],"id":"2c1e8626-7139-486f-8d83-41a06b6c1d34","_postman_id":"2c1e8626-7139-486f-8d83-41a06b6c1d34","description":""},{"name":"Payment Gateway","item":[{"name":"Sandbox","item":[{"name":"Sandbox Payment Gateway","id":"3099b88d-2e22-4cdf-b3f5-f19ee3ae6d2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-gateway.paysecureonline.com/","description":"

For testing purposes, please use our sandbox endpoint.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}},"urlObject":{"host":["https://sandbox-gateway.paysecureonline.com/"],"query":[],"variable":[]}},"response":[{"id":"1d68b1a2-840c-4d32-8852-c3efb3f37e31","name":"Sandbox Payment Gateway","originalRequest":{"method":"GET","header":[],"url":"https://sandbox-gateway.paysecureonline.com/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 May 2023 15:49:18 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept-Encoding"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"set-cookie","value":"Path=/; HttpOnly; Secure"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=l5S5n%2Fdb9wIQUc0Hhyd3b5l%2B4V5O6%2B5VRtTWox6TAl8s3pmsgmvUHl9lT84VvqHZf9dXk8%2BJNhUz5i4t7F%2F%2F6WBNTZHgL1FUCYPeavMYEEK9n7PoBWRDJlYAqhe2ENMaoku2VqBd0AtjySskpnf1UGhRDPkAbQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7c2a21f22a033b0b-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Welcome to Payment Gateway, please check the API Documentation for more information.\"\n}"}],"_postman_id":"3099b88d-2e22-4cdf-b3f5-f19ee3ae6d2b"}],"id":"5883da19-0bb2-468a-9438-f041be3a8bff","_postman_id":"5883da19-0bb2-468a-9438-f041be3a8bff","description":"","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Resources","item":[{"name":"Payments","item":[{"name":"List","id":"3ed2da38-9549-404d-be16-7cbc00996178","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://gateway.dashboard.paysecureonline.com/payments","description":"

Use this endpoint to list all transactions for all of your terminal.id.

\n
Here as an exception you do not need to include the terminal.id in your request. Using this endpoint we will return all your transactions with their corresponding terminal.id.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payments"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"0260f5d2-349f-4161-9247-e6b7a846f408","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://gateway.dashboard.paysecureonline.com/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 863,\n \"amount\": \"2.00\",\n \"origin\": \"HostedForm\",\n \"type\": \"Auth\",\n \"level\": 1,\n \"authCode\": \"TAS364\",\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": 39\n },\n \"card\": {\n \"bin\": 411111,\n \"name\": \"test test\",\n \"number\": 1111,\n \"exp\": \"2024-11-30\",\n \"verification\": {\n \"cvv\": \"M\",\n \"address\": \"N\"\n },\n \"networkTransactionId\": \"000000000173444\"\n },\n \"contact\": {\n \"name\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": true,\n \"captured\": false,\n \"history\": [],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"50.17.187.84\",\n \"isp\": \"Amazon.com\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"Ashburn\",\n \"state\": \"VA\",\n \"country\": \"US\",\n \"zip\": \"20149\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"Yes\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Decline\",\n \"reason\": \"Transaction rejected due to: AVS Zip Mismatch, AVS Address Mismatch\"\n },\n \"updatedOn\": \"2023-04-25 14:46:07\",\n \"createdOn\": \"2023-04-25 14:46:07\"\n },\n {\n \"id\": 862,\n \"amount\": \"2.00\",\n \"origin\": \"HostedForm\",\n \"type\": \"Capture\",\n \"level\": 1,\n \"authCode\": null,\n \"parent\": {\n \"id\": 861\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 401200,\n \"name\": null,\n \"number\": 26,\n \"exp\": \"2033-11-30\",\n \"verification\": {\n \"cvv\": null,\n \"address\": null\n },\n \"networkTransactionId\": null\n },\n \"contact\": null,\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": false,\n \"history\": [],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://gateway.dashboard.paysecureonline.com/payments?page=1\"\n },\n \"first\": {\n \"href\": \"https://gateway.dashboard.paysecureonline.com/payments?page=1\"\n },\n \"last\": {\n \"href\": \"https://gateway.dashboard.paysecureonline.com/payments?page=1\"\n },\n \"next\": {\n \"href\": \"https://gateway.dashboard.paysecureonline.com/payments?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"3ed2da38-9549-404d-be16-7cbc00996178"},{"name":"View","id":"458c90c0-9a71-44c7-b022-e80f2237123e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://gateway.dashboard.paysecureonline.com/payment/","description":"

Use this endpoint to view information for a specific transaction record.

\n
You need to provide the transaction.id in your request.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment",""],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"e3a10df5-8267-475e-88d1-9085f40c3d20","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://gateway.dashboard.paysecureonline.com/payment/863"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 863,\n \"amount\": \"2.00\",\n \"origin\": \"HostedForm\",\n \"type\": \"Auth\",\n \"level\": 1,\n \"authCode\": \"TAS364\",\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": 39\n },\n \"card\": {\n \"bin\": 411111,\n \"name\": \"test test\",\n \"number\": 1111,\n \"exp\": \"2024-11-30\",\n \"verification\": {\n \"cvv\": \"M\",\n \"address\": \"N\"\n },\n \"networkTransactionId\": \"000000000173444\"\n },\n \"contact\": {\n \"name\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": true,\n \"captured\": false,\n \"history\": [],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"50.17.187.84\",\n \"isp\": \"Amazon.com\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"Ashburn\",\n \"state\": \"VA\",\n \"country\": \"US\",\n \"zip\": \"20149\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"Yes\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Decline\",\n \"reason\": \"Transaction rejected due to: AVS Zip Mismatch, AVS Address Mismatch\"\n },\n \"updatedOn\": \"2023-04-25 14:46:07\",\n \"createdOn\": \"2023-04-25 14:46:07\"\n}"}],"_postman_id":"458c90c0-9a71-44c7-b022-e80f2237123e"},{"name":"Sale","id":"f378ced7-7c10-4a6b-8e5d-4d8b5286a098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"2.10\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5309572686772257,\n \"exp\": \"12/30\",\n \"cvv\": 998,\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"contact\":{\n \"email\": \"test@testemail.com\"\n },\n \"sendReceipt\": \"Yes\"\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale","description":"

The Sale method creates a new authorization and a capture request by default.

\n
It is important to note that these requests need to always include the system terminal.id for which you are making a payment.
\n

Sale transactions are settled automatically while auth-only transactions are not included in the batch for settlement.

\n
Keep in mind the required fields in order to initiate a sale transaction. If you want to perform level 2 or level 3 the required fields are outlined below.
\n

Fields	Level 2	Level 3	Visa	Mastercard	AMEX (Level 2 Only)
order.id	Yes	Yes	Yes	Yes	No
order.date	No	Yes	Yes	No	No
order.invoice	No	Yes	Yes	No	No
order.summaryCommodityCode	No	Yes	Yes	No	No
order.description	Yes	No	No	No	Yes
order.supplierRefNo	Yes	No	No	No	Yes
order.customer.id	Yes	No	No	No	Yes
order.customer.vat	No	Yes	Yes	No	No
order.shipping.fromZip	No	Yes	Yes	Yes	No
order.shipping.toZip	Yes	Yes	Yes	Yes	Yes
order.shipping.toCountry	No	Yes	Yes	Yes	No
order.shipping.cost	No	Yes	Yes	Yes	No
order.shipping.dutyCost	No	Yes	Yes	Yes	No
order.tax.amount	Yes	Yes	Yes	Yes	Yes
order.tax.details.type	No	Yes	Yes	Yes	No
order.tax.details.amount	No	Yes	Yes	Yes	No
order.tax.details.rate	No	Yes	Yes	No	No
order.tax.details.category	No	Yes	Yes	Yes	No
order.products.id	No	Yes	Yes	Yes	No
order.products.name	No	Yes	Yes	Yes	No
order.products.price	No	Yes	Yes	Yes	No
order.products.quantity	No	Yes	Yes	Yes	No
order.products.measurementUnit	No	Yes	Yes	Yes	No
order.products.commodityCode	No	Yes	Yes	Yes	No
order.discount.amount	No	Yes	Yes	Yes	No

Object

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

Fields	Description	Type	Filterable	Required	Readonly	Level 1	Level 2	Level 3
id	Unique ID of the payment record	Integer	Yes	No	Yes	No	No	No
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No	Yes	Yes	Yes
amount	Payment amount	Number	No	Yes	No	Yes	Yes	Yes
source	Transaction source `Internet`, `Phone` and `Mail`	ENUM	Yes	Yes	No	Yes	Yes	Yes
origin	Origin of the transaction (i.e. Website, CRM, etc)	String	Yes	No	No	No	No	No
level	Desired level of the payment `1`, `2` or `3`	ENUM	Yes	Yes	No	Yes	Yes	No
threeds	3DS Object	Object	No	Yes	No
threeds.id	The ID that is returned from the 3DS response	Integer	No	Yes	No	Yes	Yes	Yes
card	Card details	Object	No	Yes	No
card.name	Cardholder name	String	No	Conditional	No	Yes	Yes	Yes
card.number	Card number	Integer	No	Conditional	No	Yes	Yes	Yes
card.cvv	Card security code / CVV	Integer	No	Conditional	No	Yes	Yes	Yes
card.exp	Card expiration date /Format: mm/yy	String	No	Conditional	No	Yes	Yes	Yes
card.save	Save the card details for future use `Yes` or `No`. This will return a token	ENUM	No	No	No	No	No	No
card.store	`Yes` or `No`. This indicates if the transaction is a Card On File (COF) or Merchant Initiated Transaction (MIT) type. For use with Visa only	ENUM	No	No	No	No	No	No
card.token	Card token. This is used for saved card and for future billing.	String	No	Conditional	No	No	No	No
card.verification	Verification object	Object	No	No	Yes
card.verification.cvv	The card security code verification response.	String	No	No	Yes	No	No	No
card.verification.address	The Address Verification System response.	String	No	No	Yes	No	No	No
card.address	Card billing address details	Object	No	No	No
card.address.country	Card billing country	String	No	No	No	Yes	Yes	Yes
card.address.state	Card billing state	String	No	No	No	Yes	Yes	Yes
card.address.city	Card billing city	String	No	No	No	Yes	Yes	Yes
card.address.street	Card billing street	String	No	No	No	Yes	Yes	Yes
card.address.zip	Card billing zip	String	No	No	No	Yes	Yes	Yes
card.networkTransactionId	This field is a unique network transaction identifier for all card types. If used in consecutive Visa/Mastercard transactions, it indicates the transaction is being processed using a card in the customer wallet.	String	No	No	Yes	Yes	Yes	Yes
contact	Contact object	Object	No	No	No
contact.name	Contact name	String	No	No	No	No	No	No
contact.phone	Contact phone	String	No	No	No	No	No	No
contact.email	Contact email	String	No	No	No	No	No	No
sendReceipt	Send receipt on `Sale` or `Capture` action. This parameter requires `contact.email` to be provided. `Yes` or `No`.	ENUM	No	No	No	No	No	No
externalId	Unique record identifiers from a system outside of Payment Gateway	String	Yes	No	No	No	No	No
isRecurring	Set this flag to `Yes` if the payment request comes from a recurring system	Boolean	No	No	No	No	No	No
split	`Yes` or `No` If this is a split Tender transaction. This will return an ID that needs to be provided in the next sequence	String	No	No	No	No	Yes	Yes
ip	IP Object	Object	No	No	No
ip.address	Cardholder IP address	String	Yes	No	No	No	No	No
ip.isp	Internet Service Provider	String	No	No	No	No	No	No
ip.type	The type of the IP	String	No	No	No	No	No	No
ip.location	IP location Object	Object	No	No	No
ip.location.city	City	String	No	No	No	No	No	No
ip.location.state	State	String	No	No	No	No	No	No
ip.location.country	Country	String	No	No	No	No	No	No
ip.location.zip	ZIP Code	String	No	No	No	No	No	No
ip.info	Info	Object	No	No	No
ip.info.isAnonymous	Anonymous Check	Boolean	No	No	No	No	No	No
ip.info.isAnonymousVpn	Anonymous VPN	Boolean	No	No	No	No	No	No
ip.info.isPublicProxy	Public Proxy	Boolean	No	No	No	No	No	No
ip.info.isHostingProvider	Hosting Provider IP	Boolean	No	No	No	No	No	No
ip.info.isTorExitNode	Tor Exit Node of the IP	Boolean	No	No	No	No	No	No
order	Order details	Object	No	No	No
order.id	Purchase order	String	No	No	No	No	Yes	Yes
order.date	Purchase order date	Date	No	No	No	No	No	Yes
order.invoice	Order invoice number	String	No	No	No	No	No	Yes
order.summaryCommodityCode	The international description code of the overall goods/services being supplied.	Integer	No	No	No	No	No	Yes
order.description	Also referred to as Soft Descriptor. The text on the cardholder's statement that describes the purchase. If the order.description is sent, it will be forwarded in the authorization and capture for all card types.	String	No	No	No	No	Yes	Yes
order.supplierRefNo	Supplier reference number	String	No	No	No	No	Yes	No
order.customer	Customer details	Object	No	No	No
order.customer.identifier	Customer reference identifier	String	No	No	No	No	No	No
order.customer.vat	Customer's government assigned tax identification number	String	No	No	No	No	No	No
order.shipping	Order shipping details	Object	No	No	No
order.shipping.fromZip	Shipping from zip code	String	No	No	No	No	No	Yes
order.shipping.toZip	Destination zip code	String	No	No	No	No	Yes	Yes
order.shipping.toCountry	Destination county code	String	No	No	No	No	No	Yes
order.shipping.cost	Shipping cost	Number	No	No	No	No	No	Yes
order.shipping.dutyCost	Shipping duty cost	Number	No	No	No	No	No	Yes
order.tax	Order tax details	Object	No	No	No
order.tax.amount	Sales tax	Number	No	No	No	No	Yes	Yes
order.tax.details	Additional sales tax information	Array	No	No	No
order.tax.details.type	The type of sales tax applied	String	No	No	No	No	No	Yes
order.tax.details.amount	The sales tax amount applied to the order	Number	No	No	No	No	No	Yes
order.tax.details.rate	Tax rate (Allowed range 0.01-100)	Number	No	No	No	No	No	Yes
order.tax.details.category	`Service`, `Duty`, `VAT`, `Alternate`, `National` `TaxExempt`	ENUM	No	No	No	No	No	Yes
order.products	Product/s details	Object	No	No	No
order.products.id	Product ID	String	No	No	No	No	No	Yes
order.products.name	Product name	String	No	No	No	No	No	Yes
order.products.price	Product price	Number	No	No	No	No	No	Yes
order.products.quantity	Product quantity	Integer	No	No	No	No	No	Yes
order.products.measurementUnit	Product measurement unit	String	No	No	No	No	No	Yes
order.products.commodityCode	Product commodity code	String	No	No	No	No	No	Yes
order.discount	Order discounts details	Object	No	No	No
order.discount.amount	Discounts amount	Number	No	No	No	No	No	Yes
order.discount.details	Discount	Object	No	No	No
order.discount.details.name	Discount name	String	No	No	No	No	No	Yes
order.discount.details.amount	Discount amount	Number	No	No	No	No	No	Yes
order.discount.details.percentage	Discount percentage	Number	No	No	No	No	No	Yes
order.discount.details.priority	Discount priority	Integer	No	No	No	No	No	Yes
feeTransaction	In cases where a fee is run as a separate transaction on another terminal	Object	No	No	Yes
feeTransaction.id	Fee Transaction ID	Integer	No	No	Yes	No	No	No
feeTransaction.type	The type of sales tax applied	String	No	No	Yes	No	No	No
feeTransaction.amount	The sales tax amount applied to the order	Number	No	No	Yes	No	No	No
batch	Object	Object	No	No	Yes
batch.id	Batch ID	Integer	Yes	No	Yes	No	No	No
batch.number	Batch Number	Integer	No	No	Yes	No	No	No
batch.batchedOn	Date when batch was generated	Datetime	No	No	Yes	No	No	No
status	Status Object	Object	No	No	Yes
status.status	Status	String	Yes	No	Yes	No	No	No
status.reason	Description	String	No	No	Yes	No	No	No

\n
If you pass the level parameter in your request, we will validate the field requirements of the level you have requested. In the event of an incomplete validation we will return an error with the missing fields.
\n

\n
If a transaction has a batch information in the response, this means that this transaction has batched.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment","sale"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"7de4a072-683a-4b67-8afa-f7da4baa6b73","name":"Sale","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"2.10\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5309572686772257,\n \"exp\": \"12/30\",\n \"cvv\": 998,\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"contact\":{\n \"email\": \"test@testemail.com\"\n },\n \"sendReceipt\": \"Yes\"\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 874,\n \"amount\": \"2.10\",\n \"origin\": null,\n \"type\": \"Auth\",\n \"level\": 1,\n \"authCode\": \"VTLMC1\",\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 530957,\n \"name\": \"John Wick\",\n \"number\": 2257,\n \"exp\": \"2030-12-31\",\n \"verification\": {\n \"cvv\": \"M\",\n \"address\": \"Y\"\n },\n \"networkTransactionId\": \"1212MCC111736**\"\n },\n \"contact\": {\n \"name\": null,\n \"phone\": null,\n \"email\": \"test@testemail.com\"\n },\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": true,\n \"history\": [\n {\n \"id\": 875,\n \"type\": \"Capture\",\n \"amount\": \"2.10\",\n \"createdOn\": \"2023-05-09 15:03:50\"\n }\n ],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"173.239.211.197\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10118\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"No\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": \"2023-05-09 15:03:51\",\n \"createdOn\": \"2023-05-09 15:03:48\"\n}"}],"_postman_id":"f378ced7-7c10-4a6b-8e5d-4d8b5286a098"},{"name":"Authorization","id":"e944cdcb-f800-4b0d-9481-32515c155168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"1.99\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5309572686772257,\n \"exp\": \"12/30\",\n \"cvv\": 998,\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"contact\":{\n \"email\": \"test@testemail.com\"\n },\n \"sendReceipt\": \"Yes\"\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/auth","description":"

The Auth method initializes an authorization-only transaction. Authorization-only transactions are not included in the batch for settlement.

A separate capture request must be submitted in order for the transaction to be settled.

\n
The suggested authorization period is 10 days. You need to capture a payment within the authorization period to collect the funds of the transaction. Note, the authorization period can vary by issuer and/or card brand, it is your responsibility to ensure whatever window period is appropriate for your use case.
\n

\n
It is important to note that these requests need to always include the system terminal.id for which you are making a payment.
\n

Object

Fields	Description	Type	Filterable	Required	Readonly	Level 1	Level 2	Level 3
id	Unique ID of the payment record	Integer	Yes	No	Yes	No	No	No
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No	Yes	Yes	Yes
amount	Payment amount	Number	No	Yes	No	Yes	Yes	Yes
source	Transaction source `Internet`, `Phone` and `Mail`	ENUM	Yes	Yes	No	Yes	Yes	Yes
origin	Origin of the transaction (i.e. Website, CRM, etc)	String	Yes	No	No	No	No	No
level	Desired level of the payment `1`, `2` or `3`	ENUM	Yes	Yes	No	Yes	Yes	No
threeds	3DS Object	Object	No	Yes	No
threeds.id	The ID that is returned from the 3DS response	Integer	No	Yes	No	Yes	Yes	Yes
card	Card details	Object	No	Yes	No
card.name	Cardholder name	String	No	Conditional	No	Yes	Yes	Yes
card.number	Card number	Integer	No	Conditional	No	Yes	Yes	Yes
card.cvv	Card security code / CVV	Integer	No	Conditional	No	Yes	Yes	Yes
card.exp	Card expiration date /Format: mm/yy	String	No	Conditional	No	Yes	Yes	Yes
card.save	Save the card details for future use `Yes` or `No`. This will return a token	ENUM	No	No	No	No	No	No
card.store	`Yes` or `No`. This indicates if the transaction is a Card On File (COF) or Merchant Initiated Transaction (MIT) type. For use with Visa only	ENUM	No	No	No	No	No	No
card.token	Card token. This is used for saved card and for future billing.	String	No	Conditional	No	No	No	No
card.verification	Verification object	Object	No	No	Yes
card.verification.cvv	The card security code verification response.	String	No	No	Yes	No	No	No
card.verification.address	The Address Verification System response.	String	No	No	Yes	No	No	No
card.address	Card billing address details	Object	No	No	No
card.address.country	Card billing country	String	No	No	No	Yes	Yes	Yes
card.address.state	Card billing state	String	No	No	No	Yes	Yes	Yes
card.address.city	Card billing city	String	No	No	No	Yes	Yes	Yes
card.address.street	Card billing street	String	No	No	No	Yes	Yes	Yes
card.address.zip	Card billing zip	String	No	No	No	Yes	Yes	Yes
card.networkTransactionId	This field is a unique network transaction identifier for all card types. If used in consecutive Visa/Mastercard transactions, it indicates the transaction is being processed using a card in the customer wallet.	String	No	No	Yes	Yes	Yes	Yes
contact	Contact object	Object	No	No	No
contact.name	Contact name	String	No	No	No	No	No	No
contact.phone	Contact phone	String	No	No	No	No	No	No
contact.email	Contact email	String	No	No	No	No	No	No
sendReceipt	Send receipt on `Sale` or `Capture` action. This parameter requires `contact.email` to be provided. `Yes` or `No`.	ENUM	No	No	No	No	No	No
externalId	Unique record identifiers from a system outside of Payment Gateway	String	Yes	No	No	No	No	No
isRecurring	Set this flag to `Yes` if the payment request comes from a recurring system	Boolean	No	No	No	No	No	No
split	If this is a split Tender transaction. This will return an ID that needs to be provided in the next sequence	`Yes` or `No`	String	No	No	No	Yes	Yes
ip	IP Object	Object	No	No	No
ip.address	Cardholder IP address	String	Yes	No	No	No	No	No
ip.isp	Internet Service Provider	String	No	No	No	No	No	No
ip.type	The type of the IP	String	No	No	No	No	No	No
ip.location	IP location Object	Object	No	No	No
ip.location.city	City	String	No	No	No	No	No	No
ip.location.state	State	String	No	No	No	No	No	No
ip.location.country	Country	String	No	No	No	No	No	No
ip.location.zip	ZIP Code	String	No	No	No	No	No	No
ip.info	Info	Object	No	No	No
ip.info.isAnonymous	Anonymous Check	Boolean	No	No	No	No	No	No
ip.info.isAnonymousVpn	Anonymous VPN	Boolean	No	No	No	No	No	No
ip.info.isPublicProxy	Public Proxy	Boolean	No	No	No	No	No	No
ip.info.isHostingProvider	Hosting Provider IP	Boolean	No	No	No	No	No	No
ip.info.isTorExitNode	Tor Exit Node of the IP	Boolean	No	No	No	No	No	No
order	Order details	Object	No	No	No
order.id	Purchase order	String	No	No	No	No	Yes	Yes
order.date	Purchase order date	Date	No	No	No	No	No	Yes
order.invoice	Order invoice number	String	No	No	No	No	No	Yes
order.summaryCommodityCode	The international description code of the overall goods/services being supplied.	Integer	No	No	No	No	No	Yes
order.description	Also referred to as Soft Descriptor. The text on the cardholder's statement that describes the purchase. If the order.description is sent, it will be forwarded in the authorization and capture for all card types.	String	No	No	No	No	Yes	Yes
order.supplierRefNo	Supplier reference number	String	No	No	No	No	Yes	No
order.customer	Customer details	Object	No	No	No
order.customer.identifier	Customer reference identifier	String	No	No	No	No	No	No
order.customer.vat	Customer's government assigned tax identification number	String	No	No	No	No	No	No
order.shipping	Order shipping details	Object	No	No	No
order.shipping.fromZip	Shipping from zip code	String	No	No	No	No	No	Yes
order.shipping.toZip	Destination zip code	String	No	No	No	No	Yes	Yes
order.shipping.toCountry	Destination county code	String	No	No	No	No	No	Yes
order.shipping.cost	Shipping cost	Number	No	No	No	No	No	Yes
order.shipping.dutyCost	Shipping duty cost	Number	No	No	No	No	No	Yes
order.tax	Order tax details	Object	No	No	No
order.tax.amount	Sales tax	Number	No	No	No	No	Yes	Yes
order.tax.details	Additional sales tax information	Array	No	No	No
order.tax.details.type	The type of sales tax applied	String	No	No	No	No	No	Yes
order.tax.details.amount	The sales tax amount applied to the order	Number	No	No	No	No	No	Yes
order.tax.details.rate	Tax rate (Allowed range 0.01-100)	Number	No	No	No	No	No	Yes
order.tax.details.category	`Service`, `Duty`, `VAT`, `Alternate`, `National` `TaxExempt`	ENUM	No	No	No	No	No	Yes
order.products	Product/s details	Object	No	No	No
order.products.id	Product ID	String	No	No	No	No	No	Yes
order.products.name	Product name	String	No	No	No	No	No	Yes
order.products.price	Product price	Number	No	No	No	No	No	Yes
order.products.quantity	Product quantity	Integer	No	No	No	No	No	Yes
order.products.measurementUnit	Product measurement unit	String	No	No	No	No	No	Yes
order.products.commodityCode	Product commodity code	String	No	No	No	No	No	Yes
order.discounts	Order discounts details	Object	No	No	No
order.discounts.amount	Discounts amount	Number	No	No	No	No	No	Yes
order.discounts.details	Discount	Object	No	No	No
order.discounts.details.name	Discount name	String	No	No	No	No	No	Yes
order.discounts.details.amount	Discount amount	Number	No	No	No	No	No	Yes
order.discounts.details.percentage	Discount percentage	Number	No	No	No	No	No	Yes
order.discounts.details.priority	Discount priority	Integer	No	No	No	No	No	Yes
feeTransaction	In cases where a fee is run as a separate transaction on another terminal	Object	No	No	Yes
feeTransaction.id	Fee Transaction ID	Integer	No	No	Yes	No	No	No
feeTransaction.type	The type of sales tax applied	String	No	No	Yes	No	No	No
feeTransaction.amount	The sales tax amount applied to the order	Number	No	No	Yes	No	No	No
batch	Object	Object	No	No	Yes
batch.id	Batch ID	Integer	Yes	No	Yes	No	No	No
batch.number	Batch Number	Integer	No	No	Yes	No	No	No
batch.batchedOn	Date when batch was generated	Datetime	No	No	Yes	No	No	No
status	Status Object	Object	No	No	Yes
status.status	Status	String	Yes	No	Yes	No	No	No
status.reason	Description	String	No	No	Yes	No	No	No

\n
If you pass the level parameter in your request, we will validate the field requirements of the level you have requested. In the event of an incomplete validation we will return an error with the missing fields.
\n

\n
If a transaction has a batch information in the response, this means that this transaction has batched.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment","auth"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"7740b70e-b7f1-4c35-b559-2bdcf8cd15ed","name":"Auth","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"1.99\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5309572686772257,\n \"exp\": \"12/30\",\n \"cvv\": 998,\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"contact\":{\n \"email\": \"test@testemail.com\"\n },\n \"sendReceipt\": \"Yes\"\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 876,\n \"amount\": \"1.99\",\n \"origin\": null,\n \"type\": \"Auth\",\n \"level\": 1,\n \"authCode\": \"VTLMC1\",\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 530957,\n \"name\": \"John Wick\",\n \"number\": 2257,\n \"exp\": \"2030-12-31\",\n \"verification\": {\n \"cvv\": \"M\",\n \"address\": \"Y\"\n },\n \"networkTransactionId\": \"1212MCC111863**\"\n },\n \"contact\": {\n \"name\": null,\n \"phone\": null,\n \"email\": \"test@testemail.com\"\n },\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": false,\n \"history\": [],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"173.239.211.183\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10118\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"No\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": \"2023-05-09 15:23:44\",\n \"createdOn\": \"2023-05-09 15:23:44\"\n}"}],"_postman_id":"e944cdcb-f800-4b0d-9481-32515c155168"},{"name":"Capture","id":"9a3b8770-f38f-46e0-a160-01e3daef7d85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": \"1.99\",\r\n \"partial\": {\r\n \"total\": null,\r\n \"sequence\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment//capture","description":"

The capture method marks an Auth transaction for settlement, therefore the transaction ID is needed. This method also allows adjustments of the transaction amount.

\n
If your request does not include the amount, our system will settle the full transaction with no changes in the amount field and vice versa.
\n

\n
You can perform multiple capture requests for a specific auth transaction until you reach the authorized amount. After that, you must submit a new authorization request to capture additional amounts.
\n

Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the capture record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Amount of the capture	Number	No	No	No
partial	Partial Object	Object	No	No	No
partial.total	Total payments	Integer	No	No	No
partial.sequence	Current payment sequence number	Integer	No	No	No
sendReceipt	Send receipt	Integer	No	No	No

We provide the functionality to create partial captures.

If partial is included in the request the gateway marks the specified transaction amount for settlement.

\n
When performing partial capture it is required to pass the sequence and total to indicate how many partial captures will be performed.
\n

The refund method is used to refund/void an authorized or settled transaction. This method will void or reverse the transaction based on the card network.

\n
Important: We do not allow refunds without transaction.id and an amount that exceeds the captured of the original transaction.
\n

We support additional data for a refund request. If no amount is specified in the request, the system will return the full amount of the original transaction. You need to provide any discount and tax amount that was in the original transaction to perform a partial refund.

\n
Important: In a refund request if the amount is present but the order.tax and order.discounts amounts are not present, the amount must be less than or equal to the subtotal amount of the original order.
\n

The system will create a new transaction id for all refund transactions.

If the original transaction has been settled, the new transaction id created by the return will be processed offline and will not generate an auth code.
If the original transaction has not been settled, we link the original transaction to the return transaction. The gateway automatically reverses the transaction and an auth code will be generated.

\n\n

Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the refund record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Amount of the refund	Number	No	No	No

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment","","refund\n"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"54182ccc-e04f-43f7-ad5f-bcd819f440fd","name":"Refund","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/882/refund\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 883,\n \"amount\": \"1.99\",\n \"origin\": \"API\",\n \"type\": \"Return\",\n \"level\": 1,\n \"authCode\": null,\n \"parent\": {\n \"id\": 882\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 530957,\n \"name\": null,\n \"number\": 2257,\n \"exp\": \"2030-12-31\",\n \"verification\": {\n \"cvv\": null,\n \"address\": null\n },\n \"networkTransactionId\": null\n },\n \"contact\": null,\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": false,\n \"history\": [],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"216.73.161.60\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10013\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"Yes\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": \"2023-05-09 15:51:36\",\n \"createdOn\": \"2023-05-09 15:51:36\"\n}"}],"_postman_id":"4a64ab6a-77c0-47db-8ad3-a2c123bfbeab"},{"name":"Partial Refund","id":"e38f9515-df7c-4d73-95bc-de37fafbb611","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"1.10\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5146312200000035,\n \"exp\": \"12/30\",\n \"cvv\": \"998\",\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"ip\": {\n \"address\": \"123.123.123.123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment//refund\n","description":"

You are allowed to perform a partial refund by providing a lower amount than the original captured transaction if no amount is provided the transaction will be fully refunded. You need to provide any discount and tax amount that was in the original transaction to perform a partial refund.

EndFragme

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment","","refund\n"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"31f617c0-8f11-48ab-9ca4-77d05c830883","name":"Partial Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"1.10\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5146312200000035,\n \"exp\": \"12/30\",\n \"cvv\": \"998\",\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"ip\": {\n \"address\": \"123.123.123.123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/884/refund\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 884,\n \"amount\": \"0.99\",\n \"origin\": \"API\",\n \"type\": \"Return\",\n \"level\": 1,\n \"authCode\": null,\n \"parent\": {\n \"id\": 884\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 530957,\n \"name\": null,\n \"number\": 2257,\n \"exp\": \"2030-12-31\",\n \"verification\": {\n \"cvv\": null,\n \"address\": null\n },\n \"networkTransactionId\": null\n },\n \"contact\": null,\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": false,\n \"history\": [],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"173.239.211.192\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10118\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"No\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": \"2023-05-09 15:56:59\",\n \"createdOn\": \"2023-05-09 15:56:59\"\n}"}],"_postman_id":"e38f9515-df7c-4d73-95bc-de37fafbb611"},{"name":"Soft/Dynamic Descriptor","id":"0cb08e16-cfde-42ae-b398-92b50da4d405","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"9.99\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5146312200000035,\n \"exp\": \"12/30\",\n \"cvv\": \"998\",\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"order\": {\n \"description\": \"Grandmas Cookie Store\"\n }\n} ","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale","description":"

Soft Descriptor or Dynamic Descriptor functionality gives you the ability to modify the statement descriptor on a per-transaction basis. Using this feature, you gain the ability to change this information according to your discretion and needs.

\n
In order to use this functionality always include order.description in your Sale or Auth requests.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment","sale"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"c5775a85-def8-4613-9da4-9368dc4717b3","name":"Sale with Dynamic Descriptor","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"9.99\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5146312200000035,\n \"exp\": \"12/30\",\n \"cvv\": \"998\",\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"order\": {\n \"description\": \"Grandmas Cookie Store\"\n }\n} ","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 887,\n \"amount\": \"9.99\",\n \"origin\": null,\n \"type\": \"Auth\",\n \"level\": 1,\n \"authCode\": \"VTLMC1\",\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 514631,\n \"name\": \"John Wick\",\n \"number\": 35,\n \"exp\": \"2030-12-31\",\n \"verification\": {\n \"cvv\": \"M\",\n \"address\": \"Y\"\n },\n \"networkTransactionId\": \"1212MCC111168**\"\n },\n \"contact\": {\n \"name\": null,\n \"phone\": null,\n \"email\": null\n },\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": true,\n \"history\": [\n {\n \"id\": 888,\n \"type\": \"Capture\",\n \"amount\": \"9.99\",\n \"createdOn\": \"2023-05-09 16:02:30\"\n }\n ],\n \"order\": {\n \"identifier\": null,\n \"date\": null,\n \"invoice\": null,\n \"description\": \"Grandmas Cookie Store\",\n \"note\": null,\n \"summaryCommodityCode\": null,\n \"supplierRefNo\": null,\n \"tax\": {\n \"amount\": null,\n \"details\": []\n },\n \"discount\": {\n \"amount\": null\n },\n \"customer\": {\n \"id\": null,\n \"vat\": null\n }\n },\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"173.239.211.198\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10118\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"No\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": \"2023-05-09 16:02:32\",\n \"createdOn\": \"2023-05-09 16:02:29\"\n}"}],"_postman_id":"0cb08e16-cfde-42ae-b398-92b50da4d405"},{"name":"Card Authentication","id":"0a829dca-888f-4ae0-9001-f08b663079d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"0.00\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5146312200000035,\n \"exp\": \"12/30\",\n \"cvv\": \"998\",\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/card-authentication","description":"

The Card authentication method supports a zero-dollar authorization. This way you can check that the credit card is valid, and if needed that the card has enough funds on it for the transaction. This type of authorization does not hold any funds on the cardholder account.

\n
A zero dollar authorization cannot be submitted for settlement or for return.
\n

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the payment record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Amount of the payment	Number	No	Yes	No
source	Where the card details come from `Internet` or `MOTO`	ENUM	Yes	Yes	No
card	Card details	Object	No	Yes	No
card.name	Cardholder name	String	No	Yes	No
card.number	Card number	Integer	No	Yes	No
card.exp	Card expiration date `mm/yy`	String	No	Yes	No
card.save	Save the card details for future use `Yes` or `No`	ENUM	No	Yes	No
card.verification	Verification object	Object	No	No	Yes
card.verification.cvv	Returns the verification cvv code	String	No	No	Yes
card.verification.address	Returns the verification address code	String	No	No	Yes
card.address	Card billing address details	Object	No	Yes	No
card.address.country	Card billing country	String	No	Yes	No
card.address.state	Card billing state	String	No	No	No
card.address.city	Card billing city	String	No	Yes	No
card.address.street	Card billing street	String	No	Yes	No
card.address.zip	Card billing zip	String	No	Yes	No

Tokenization is the process of exchanging sensitive card data with a unique token without compromising its security when you desire to use this card for future payments. A token is up to 64-digit characters.

Keep in mind that when you are using a token for a transaction we also automatically include the networkTransactionId in the request.

\n
Tokenization can be performed during a sale, auth and cardAuthentication request when the value of card.save parameter is passed as Yes. We will generate a secure token for that card. The response will include the first six and the last four digits of the card number in the card.number field and a token in the card.token field, which can be used in the future in place of a card number.
\n

Although you can tokenize a card in any sale, auth, and cardAuthentication request, as mentioned above, this endpoint can be utilized to generate a token-only request for your convenience.

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

Fields	Description	Type	Filterable	Required	Readonly
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Terminal ID	Integer	No	Yes	No
source	Where the card details come from `Internet` or `MOTO`	ENUM	No	Yes	No
card	Card details	Object	No	Yes	No
card.name	Cardholder name	String	No	Yes	No
card.number	Card number	Integer	No	Yes	No
card.exp	Card expiration date `mm/yy`	String	No	Yes	No
card.cvv	Card security code	Integer	No	Conditional	No

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment","generate-token"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"c8f1f026-3289-4e19-92cf-c285a830d8de","name":"Card Tokenization","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"source\": \"Internet\",\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5146312200000035,\n \"exp\": \"12/30\",\n \"cvv\": \"998\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/generate-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"890\",\n \"amount\": 0,\n \"origin\": \"API\",\n \"type\": \"GenerateToken\",\n \"level\": 1,\n \"authCode\": null,\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 514631,\n \"name\": \"John Wick\",\n \"number\": 35,\n \"exp\": \"2030-12-31\",\n \"verification\": {\n \"cvv\": null,\n \"address\": null\n },\n \"networkTransactionId\": \"1212MCC111268**\",\n \"token\": \"1kDCZY8x9saJ0035\"\n },\n \"contact\": null,\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": false,\n \"history\": [],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"173.239.211.182\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10118\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"No\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": null,\n \"createdOn\": \"2023-05-09 16:17:30\"\n}"}],"_postman_id":"2bd247ce-c78e-4b82-8345-e21319b4764e"},{"name":"Sale with a Fee Terminal","id":"39cc2f2e-d429-4b4c-80ed-dfb2a8cdc7d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"20.99\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5309572686772257,\n \"exp\": \"12/30\",\n \"cvv\": 998,\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"order\": {\n \"tax\": {\n \"amount\": 0.23,\n \"details\": [\n {\n \"category\": \"Service\",\n \"type\": \"ServiceFee\",\n \"amount\": 0.23\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale","description":"

In some cases, there can be 2 terminals involved in one transaction. We call this functionality a Fee Terminal.

You can utilize this endpoint if your merchant account is setup to have a separate fee terminal. The transaction will be divided into two separate authorizations and captures.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018","id":"aa628120-843e-4c89-8b8d-9e7b05558018","name":"Payments","type":"folder"}},"urlObject":{"path":["payment","sale"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"9ed4e5b5-53ee-4226-bd04-66bd2ad66f1b","name":"Sale with a Fee Terminal","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"20.99\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 5309572686772257,\n \"exp\": \"12/30\",\n \"cvv\": 998,\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n },\n \"order\": {\n \"tax\": {\n \"amount\": 0.23,\n \"details\": [\n {\n \"category\": \"Service\",\n \"type\": \"ServiceFee\",\n \"amount\": 0.23\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 891,\n \"amount\": \"20.76\",\n \"origin\": null,\n \"type\": \"Auth\",\n \"level\": 1,\n \"authCode\": \"VTLMC1\",\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 530957,\n \"name\": \"John Wick\",\n \"number\": 2257,\n \"exp\": \"2030-12-31\",\n \"verification\": {\n \"cvv\": \"M\",\n \"address\": \"Y\"\n },\n \"networkTransactionId\": \"1212MCC111330**\"\n },\n \"contact\": {\n \"name\": null,\n \"phone\": null,\n \"email\": null\n },\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": true,\n \"history\": [\n {\n \"id\": 893,\n \"type\": \"Capture\",\n \"amount\": \"20.76\",\n \"createdOn\": \"2023-05-09 16:24:04\"\n }\n ],\n \"order\": null,\n \"feeTransaction\": {\n \"id\": 892,\n \"type\": \"Sale\",\n \"amount\": \"0.23\",\n \"createdOn\": \"2023-05-09 16:24:03\"\n },\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"173.239.211.191\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10118\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"No\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"No\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": \"2023-05-09 16:24:06\",\n \"createdOn\": \"2023-05-09 16:24:01\"\n}"}],"_postman_id":"39cc2f2e-d429-4b4c-80ed-dfb2a8cdc7d1"}],"id":"aa628120-843e-4c89-8b8d-9e7b05558018","description":"

\n
In the payment gateway, your requests need to always include the system terminal.id. Within itself the system terminal.id contains DBA, MID, and terminal TID information, this way we always ensure that you are using the correct MID and TID if you have more than one.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"aa628120-843e-4c89-8b8d-9e7b05558018"}],"id":"0f003dca-1fa3-4676-bcf1-9e9860de968e","_postman_id":"0f003dca-1fa3-4676-bcf1-9e9860de968e","description":"","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Hosted Form","item":[{"name":"Generate","id":"bb16ed99-0941-4da5-a597-ea87d048e64c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dba\": {\n \"id\": 9\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": \"Disabled\",\n \"amount\": 2,\n \"feeType\": \"amount\",\n \"fee\": 2,\n \"externalId\": \"example\",\n \"origin\": \"WEB\",\n \"returnUrl\": \"https://example.com\",\n \"returnUrlNavigation\": \"top\",\n \"useLogo\": \"Yes\",\n \"visibleNote\": \"Yes\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/gateway/hosted-form","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"1885cd16-5535-46bc-95be-f1a98b62eb63","id":"1885cd16-5535-46bc-95be-f1a98b62eb63","name":"Hosted Form","type":"folder"}},"urlObject":{"path":["api","gateway","hosted-form"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"97747194-6127-4afb-901f-d07b36c8cc1d","name":"Generate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dba\": {\n \"id\": 9\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": \"Disabled\",\n \"amount\": 2,\n \"feeType\": \"amount\",\n \"fee\": 2,\n \"externalId\": \"example\",\n \"origin\": \"WEB\",\n \"returnUrl\": \"https://example.com\",\n \"returnUrlNavigation\": \"top\",\n \"useLogo\": \"Yes\",\n \"visibleNote\": \"Yes\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/gateway/hosted-form"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"

\",\n \"url\": \"https://dashboard.dashboard.paysecureonline.com/gateway/public/form?dbaId=9&terminalId=24&hash=a85785f919774e4517847b5e98e43f62&origin=WEB&threeds=Disabled&amount=2&fee=2&feeType=amount&requestContactInfo=No&requestBillingInfo=No&sendReceipt=No&returnURL=https%3A%2F%2Fexample.com&externalId=example&logo=on&visibleNote=Yes\"\n}"}],"_postman_id":"bb16ed99-0941-4da5-a597-ea87d048e64c"}],"id":"1885cd16-5535-46bc-95be-f1a98b62eb63","description":"

With our Gateway embedded hosted form functionality, you can achieve quick, efficient, and secure online transactions, without the worry of PCI compliance.

The overall process to generate and prepare a hosted gateway payment form is as follows.

Create a POST request with the required parameters for your needs
We will return the code of the hosted form and the URL in the response

Hosted Form Object

Fields	Description	Type	Required
dba	Dba Object	Object	Yes
dba.id	DBA ID	Integer	Yes
terminal	Terminal Object	Object	Yes
terminal.id	Terminal ID	Integer	Yes
threeds	Activate 3D Secure `Required`, `Disabled` or `RequiredIfAvailable`	ENUM	No
amount	Payment Amount	Number	No
feeType	The type of sales tax applied `amount` or `percent`	ENUM	No
fee	The sales tax value applied to the order	Number	No
externalId	Unique record identifiers from a system outside of Payment Gateway	String	No
origin	Origin of the transaction (i.e. Website, CRM, etc)	String	No
returnUrl	The return URL after payment completion (i.e success/error page)	String	No
returnUrlNavigation	How to redirect the URL (Inside/Outside of frame) `top` or `self`	ENUM	No
useLogo	Use the logo of your merchant profile `Yes` or `No`	ENUM	No
visibleNote	Adds an additional text field to the hosted form `Yes` or `No`	ENUM	No
requestBillingInfo	Adds a billing info step to the hosted form `Yes` or `No`	ENUM	No
requestContactInfo	Adds a contact info step to the hosted form `Yes` or `No`	ENUM	No
sendReceipt	Send a customized receipt after successful payment `Yes` or `No`	ENUM	No

\n
The Amount and External ID are dynamic parameters that can still be provided after the form is generated.
If you want to dynamically provide Amount and External ID you can do so at the end of the URL using &amount=&externalId= or you can provide them in the corresponding javascript parameters. Keep in mind that if the amount is not provided the client will be prompted to enter it.
\n

The return URL also gives you the option to change the mapping of specific parameters based on your needs.
The parameters that we have are as follows: Success, Failed and Cancelled.

\n
IMPORTANT If you have set sendReciept to \"Yes\" requestContactInfo needs to be also \"Yes\" as well or no receipt will be generated.
\n

StartFragment

There are 2 versions of 3DS that we support. Based on what version of 3DS is offered by the issuing bank the authentication of the transaction goes through a different flow.

v1.0 - the original version that relies on redirects to iFrame and popup to complete consumer authentication. The authentication process verifies the consumer via a challenge in a window.
v2.1 - this is the newest version of the protocol. It's faster, less consumer obtrusive, and offers multiple ways to authenticate including passive, biometric, and two-factor authentication methods.

Verification process

The overall process can be summarized as follows. You initiate a Create that will return a unique id and an iframe that needs to be presented in the browser. The iframe can be either hidden or visible based on the 3DS version. After that, you initiate Check with the provided id. The result will either return a status which will indicate the outcome of the 3DS authentication. If the status is successful you will proceed in creating a Sale or an Auth using the provided id in threeds.id.

\n
<p >The version will be included in the response to the Create command. </p>
\n

StartFragment

v1.0 Flow

Create a 3DS authentication request using card data
We send the 3DS authentication request via form submission in an iframe in the browser
If a challenge is required, it appears in the browser in the same iframe
Utilizing the Check command will return status for that 3DS authentication
Proceed by creating a Sale or an Auth for this 3DS authentication

v2.2 Flow

Create a 3DS authentication request using card data
We send the 3DS authentication request via form submission in a hidden iframe in the browser
Utilize the Check command to verify if authentication is successful or additional challenge is required
If an additional challenge is required we present it in a new iframe that needs to be shown in the browser
Utilizing the Check command will return status for that 3DS authentication
Proceed by creating a Sale or an Auth for this 3DS authentication

\n

Always initiate Check for a specific id to verify the status before proceeding to a Sale or an Auth. Once a status changes from the initial Pending it will never change again. The acceptable statuses for proceeding to an Auth or Sale are Success, Attempted, and Not Enrolled.

EndFragment

EndFragmen

\n","_postman_id":"fa7a5562-6936-44cf-928f-b056be6e1c95","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Create","item":[{"name":"Create","id":"3e396dc2-19ea-49af-9a03-c1d0f439580b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"45.00\",\n \"card\": {\n \"number\": 5555555555554444,\n \"exp\": \"12/25\"\n },\n \"browserData\": {\n \"acceptHeader\": \"application/json\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36\",\n \"language\": \"en-US\",\n \"timezone\": \"-420\",\n \"colorDepth\": 30,\n \"screen\": {\n \"height\": \"900\",\n \"width\": \"1440\"\n },\n \"javaScriptEnabled\": true,\n \"javaEnabled\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/3ds/create","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}},"urlObject":{"path":["3ds","create"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"1217e145-372c-4873-983e-b86dd9bd0d11","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"45.00\",\n \"card\": {\n \"number\": 5555555555554444,\n \"exp\": \"12/25\"\n },\n \"browserData\": {\n \"acceptHeader\": \"application/json\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36\",\n \"language\": \"en-US\",\n \"timezone\": \"-420\",\n \"colorDepth\": 30,\n \"screen\": {\n \"height\": \"900\",\n \"width\": \"1440\"\n },\n \"javaScriptEnabled\": true,\n \"javaEnabled\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/3ds/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3e396dc2-19ea-49af-9a03-c1d0f439580b"}],"id":"4e18a6ea-a027-490e-afae-f19f03f19f75","description":"

This will initiate the 3DS process and id, version and iframe will be presented in the response.

\n
Keep in mind that in very few cases a 406 - Not Acceptable error can be returned. This happens when certain cards cannot be verified at the moment. If you are not required to use 3DS authentication as a merchant you can still proceed in processing the payment without Utilizing 3DS authentication and with no liability shift.
\n

Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the capture record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Amount of the sale/auth	Number	No	Yes	No
card	Card Object	Object	No	Yes	No
card.number	Card number	Integer	No	Yes	No
card.exp	Card expiration date	Date	No	Yes	No
browserData	Data generated by the provided JS	Object	No	Yes	No
browserData.acceptHeader	Set to \"application/json\"	String	No	Yes	No
browserData.userAgent	Browser and OS details of the cardholder	String	No	Yes	No
browserData.language	Value representing the browser language as defined in IETF BCP47	String	No	Yes	No
browserData.timezone	Time difference between UTC time and the Cardholder browser local time, in minutes.	String	No	Yes	No
browserData.colorDepth	Value representing the bit depth of the colour palette for displaying images, in bits per pixel.	String	No	Yes	No
browserData.screen	Screen Data	Object	No	Yes	No
browserData.screen.width	Total width of the Cardholder's screen in pixels.	String	No	Yes	No
browserData.screen.height	Total height of the cardholder's screen in pixels.	String	No	Yes	No
browserData.javaScriptEnabled	Boolean that represents the ability of the cardholder browser to execute JavaScript.	Boolean	No	Yes	No
browserData.javaEnabled	Boolean that represents the ability of the cardholder browser to execute Java.	Boolean	No	Yes	No

","_postman_id":"4e18a6ea-a027-490e-afae-f19f03f19f75","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Check","item":[{"name":"Check","id":"0c619dca-7034-4996-bd2c-7b2c00d3d90d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"45.00\",\n \"card\": {\n \"number\": 5555555555554444,\n \"exp\": \"12/25\"\n },\n \"browserData\": {\n \"acceptHeader\": \"application/json\",\n \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36\",\n \"language\": \"en-US\",\n \"timezone\": \"-420\",\n \"colorDepth\": 30,\n \"screen\": {\n \"height\": \"900\",\n \"width\": \"1440\"\n },\n \"javaScriptEnabled\": true,\n \"javaEnabled\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/3ds/22/check","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}},"urlObject":{"path":["3ds","22","check"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c619dca-7034-4996-bd2c-7b2c00d3d90d"}],"id":"d275f468-2f5a-42de-9a59-d2857721c414","description":"

For 3DS v1.0 this will return the status for the specific id.

For 3DS v2.2 if the additional challenge is needed this will return a new iframe along with the status for the specific id.

\n
Always initiate Check for a specific id to verify the status before proceeding to an Auth or Sale. Once a status changes from the initial Pending it will never change again. The acceptable statuses for proceeding to an Auth or Sale are Success, Attempted, and Not Enrolled.
\n

Below are the possible status values:

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

Code	Description	Liability Shift
Y	Authentication Successful by issuer	Yes
A	Network stepped in for the authentication because the issuer was not participating	Yes
I	Data Share - Informational only; 3DS requestor challenge preference acknowledged	No
N	Not Authenticated /Account Not Verified; Transaction denied	No
U	Authentication/ Account Verification Could Not Be Performed; Technical or other problems.	No
C	Challenge Required; Additional authentication is still required from the user	Depends on if the client completes the challenge and Issuer successfully authenticates the transaction
R	Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification.	No

","_postman_id":"d275f468-2f5a-42de-9a59-d2857721c414","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Test Cards","item":[],"id":"49648176-d017-4992-adbd-1674322869fe","description":"

We offer you test cards for the sandbox environment so you can confirm your integration works before using real card data.

Credit Cards / Pans	Networks	Type of Transaction	Status/Success
4005519200000004 4124939999999990 4444333322221111	Visa	Frictionless	Y
4009348888881881 4485660000000007	Visa	Frictionless	N
4012000033330026 4485666666666668	Visa	Challenge/Prompt	? - Depends on the challenge completion
4012000077777777 4124930001898619	Visa	-	Error: Card Not Enrolled
4166676667666746	Visa	Frictionless	R - Issuer rejected authentication and requested authorization not to be attempted
4917300800000000	Visa Electron	Frictionless	Y
5555341244441115 5406004444444443 5407721000353481	MasterCard	Frictionless	Y
5577000055770004 5415244444444444	MasterCard	Frictionless	N
5100060000000002 5472065555555557	MasterCard	Challenge/Prompt	? - Depends on the challenge completion
6771798021000008	Maestro	Frictionless	Y
6011601160116611 6011450103333333	Discover	Frictionless	Y
6445644564456445 6011993333333334	Discover	Frictionless	N
6011000991300009 6011402344444445	Discover	Challenge/Prompt	? - Depends on the challenge completion
36006666333344	Dinner's Club	Frictionless	Y
370000000000002 370000999999990	AmEx	Frictionless	Y
370000000100018 370000222222228	AmEx	Frictionless	N
378282246310005 340000111111117	AmEx	Challenge/Prompt	? - Depends on the challenge completion

","_postman_id":"49648176-d017-4992-adbd-1674322869fe","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}}],"id":"fb1e291e-da31-4818-89a7-0fcaf624670d","description":"

3DSecure (3DS) is a fraud prevention security protocol that allows consumers to shop online more securely. It works by verifying that the consumer entering the credit card information on an e-commerce site is the owner or person authorized to use that credit card. How this works depends on which version of the 3DS protocol is being used. Using 3DS can provide you with chargeback protection and lower interchange rates.

\n
3DS will be enabled at the merchant level. If you want to utilize this protocol contact us. Some merchants may be required to use 3DS by default for all transactions.
\n

Integration

The following JavaScript needs to be embedded on your checkout page to collect browser data information. You will need to pass the collected data from the JavaScript in the browserData field in the Create method when creating 3DS authentication. This information is needed to increase the level of security and accuracy of the 3DS authentication.

<script src=\"/js/main.js\"></script>\n<script>\n    ((function() {document.querySelector(\"#browserData\").value = getBrowserData();}))();\n</script>\n\n

\n
#browserData is just an example field you need to change it according to your HTML form.
\n

\n","_postman_id":"fb1e291e-da31-4818-89a7-0fcaf624670d","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Account Updater","item":[{"name":"Card Compatibility","item":[],"id":"3a6fe1fa-8674-46c8-b9f5-9b1c192a615e","description":"

Whether a card can be updated using Account Updater is solely dependent on the customer's issuing bank and that bank's participation in this service. Sometimes even if the customer's card is compatible, it might not be eligible for automatic updates if the issuing bank does not participate.

\n
Prepaid, gift cards and cards processed with ApplePay or GooglePay are not supported.
\n

\n","_postman_id":"3a6fe1fa-8674-46c8-b9f5-9b1c192a615e","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"How It Works","item":[{"name":"Sale with Account Updater","id":"4375453e-e807-44d8-ac9e-3c1dc9073eed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"1.10\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 4000000000000051,\n \"exp\": \"05/30\",\n \"cvv\": \"999\",\n \"save\": \"Yes\",\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}},"urlObject":{"path":["payment","sale"],"host":["https://gateway.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"d292a424-5df9-406a-9b8d-8ee850c25d56","name":"Sale with Account Updater","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"terminal\": {\n \"id\": 24\n },\n \"amount\": \"1.10\",\n \"source\": \"Internet\",\n \"level\": 1,\n \"card\": {\n \"name\": \"John Wick\",\n \"number\": 4000000000000051,\n \"exp\": \"05/30\",\n \"cvv\": \"999\",\n \"save\": \"Yes\",\n \"address\": {\n \"country\": \"United State of America\",\n \"state\": \"CA\",\n \"city\": \"Calabasas\",\n \"street\": \"8320\",\n \"zip\": \"85284\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.dashboard.paysecureonline.com/payment/sale"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 894,\n \"amount\": \"1.10\",\n \"origin\": null,\n \"type\": \"Auth\",\n \"level\": 1,\n \"authCode\": \"TAS183\",\n \"parent\": {\n \"id\": null\n },\n \"terminal\": {\n \"id\": 24\n },\n \"threeds\": {\n \"id\": null\n },\n \"card\": {\n \"bin\": 400000,\n \"name\": \"John Wick\",\n \"number\": 51,\n \"exp\": \"2030-05-31\",\n \"verification\": {\n \"cvv\": \"M\",\n \"address\": \"Y\"\n },\n \"networkTransactionId\": \"000000000014910\",\n \"token\": \"IidC1AkxAyyz0051\"\n },\n \"contact\": {\n \"name\": null,\n \"phone\": null,\n \"email\": null\n },\n \"externalId\": null,\n \"isRecurring\": \"No\",\n \"split\": null,\n \"refunded\": false,\n \"captured\": true,\n \"history\": [\n {\n \"id\": 895,\n \"type\": \"Capture\",\n \"amount\": \"1.10\",\n \"createdOn\": \"2023-05-10 09:27:06\"\n }\n ],\n \"order\": null,\n \"feeTransaction\": null,\n \"batch\": {\n \"id\": null,\n \"number\": null,\n \"batchedOn\": null\n },\n \"ip\": {\n \"address\": \"104.234.53.183\",\n \"isp\": \"Ipxo Limited\",\n \"type\": \"hosting\",\n \"location\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip\": \"10118\"\n },\n \"info\": {\n \"isAnonymous\": \"Yes\",\n \"isAnonymousVpn\": \"Yes\",\n \"isPublicProxy\": \"No\",\n \"isHostingProvider\": \"Yes\",\n \"isTorExitNode\": \"No\"\n }\n },\n \"status\": {\n \"status\": \"Approved\",\n \"reason\": null\n },\n \"updatedOn\": \"2023-05-10 09:27:07\",\n \"createdOn\": \"2023-05-10 09:27:04\"\n}"}],"_postman_id":"4375453e-e807-44d8-ac9e-3c1dc9073eed"}],"id":"8000e99c-7c40-4982-bf18-39ec3d76610b","description":"

Account Updater works on a transaction level whether you initiate a Sale, Auth, or Return. The card needs to be tokenized, the card.save need to be Yes first, and then all future transactions are going to be checked for card updates, if any. In the event that the card has been updated, we will automatically charge the new card and will return the new details in the card object along with some additional status details.

\n","_postman_id":"8000e99c-7c40-4982-bf18-39ec3d76610b","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}}],"id":"4319c816-4858-481a-9c27-27918d708c2f","description":"

Account Updater is a feature that automatically requests updates for tokenized cards on file in the event that a customer's card expires or is replaced. This will help you avoid or reduce billing issues.

\n
Account updater is not enabled on your account by default. Contact us so that we can set it up and ensure that this feature is configured in a way that best suits your business.
\n

\n","_postman_id":"4319c816-4858-481a-9c27-27918d708c2f","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Gateway Test Cards","item":[],"id":"3f578b8d-a396-4677-9474-5dac13b90d2b","description":"

We offer you test cards for the sandbox environment so you can confirm your integration works before using real card data.

\n
IMPORTANT For AVS you can use the Address: 8320 and ZIP: 85284
\n

Card Number	Network	Expiration Date	CVV
4539225011794489	VISA	12/30	999
4957587837877027	VISA	12/30	999
4632633008802809	VISA	12/30	999
4539225011794430	VISA	12/30	999
5296345017707556	MASTERCARD	12/30	998
5309572686772257	MASTERCARD	12/30	998
6011421812165456	DISCOVER	12/30	996
6011891662320957	DISCOVER	12/30	996
340200784265287	AMEX	12/30	9997
371632530176123	AMEX	12/30	9997
4111111111111111	VISA	12/30	999
4000111111111115	VISA	12/30	999
4916909992637469	VISA	12/30	999
4000008500910067	VISA	12/30	999
5555555555554444	MASTERCARD	12/30	998
5105105105105100	MASTERCARD	12/30	998
5339978447172907	MASTERCARD	12/30	998

Partial Approval

There are cases where you will encounter partial approvals, such as gift cards etc. To test this use the following:

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

Card Number	Network	Expiration Date	CVV	Amount	Approved Amount
2223000048400011	MASTERCARD	12/25	998	11.10	5.55

","_postman_id":"3f578b8d-a396-4677-9474-5dac13b90d2b","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}},{"name":"Response Codes","item":[{"name":"Verification Response Codes","item":[],"id":"bbb4c850-6f70-4528-b90e-f90492815c04","description":"

In addition to our status response codes, we have verification codes within the transaction response.

Card Verification Object

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

Fields	Description	Type	Filterable	Required	Readonly	Level 1	Level 2	Level 3
card.verification	Verification object	Object	No	No	Yes
card.verification.cvv	The card security code verification response.	String	No	No	Yes	No	No	No
card.verification.address	The Address Verification System response.	String	No	No	Yes	No	No	No

CVV Verification Response

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

Response Code	Response Description
M	CVV2 verification successful
P	CVV2 verification not performed
U	CVV2 verification not available
N	CVV2 verification fail/mismatch
S	CVV2 code not present on card

Address Verification Response

Address Verification Code is a one-character field that contains the address verification result code. This code defines the result of the address verification performed by the issuer on the address submitted in a transaction request.

Response Code	Response Definition
0	Address verification was not requested.
A	The street address submitted matches what is on file.
B	The street address submitted matches what is on file. The ZIP code does not match what was on file.
C	This service is not supported.
D	The street address submitted matches what is on file.
F	The street address and ZIP code submitted match what is on file. This applies to UK transactions.
G	The issuer does not participate in this service. This applies to non-US issuers.
I	The AVS information was not verified.
M	The street address submitted matches what is on file.
N	Neither the street address or ZIP code match what is on file.
P	The ZIP code submitted matches what is on file. The street address does not match what is on file.
R	The issuer system is currently unavailable.
S	This service is not supported.
U	AVS is unavailable.
W	The nine-character ZIP code submitted matches what is on file.
X	The nine-character ZIP code submitted matches what is on file.
Y	The street address and five-character ZIP code submitted match what is on file.
Z	The nine-character ZIP code submitted matches what is on file.
1	AMEX only; The cardholder name and ZIP code submitted matches what is on file.
2	AMEX only; The cardholder name, address, and ZIP code submitted match what is on file.
3	AMEX only; The cardholder name and address submitted match what is on file.
4	AMEX only; The cardholder name submitted match what is on file.
5	AMEX only; The cardholder name does not match what is on file. The ZIP code submitted matches what is on file.
6	AMEX only; The cardholder name does not match what is on file. The address and ZIP code submitted matches what is on file.
7	AMEX only; The cardholder name does not match what is on file. The address submitted matches what is on file.
8	AMEX only; Neither the cardholder name, address, or ZIP code match what is on file.

","_postman_id":"bbb4c850-6f70-4528-b90e-f90492815c04","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}}],"id":"6eb1c794-c698-4483-bbc6-64bc0136d126","description":"

Responses to any request clearly indicate if the request is processed successfully. We have integrated the following logic and groups in our response codes.

Status Object

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

Fields	Description	Type	Filterable	Required	Readonly	Level 1	Level 2	Level 3
status	Status Object	Object	No	No	Yes
status.status	`Approved`,`Declined`, `Error`	String	Yes	No	Yes	No	No	No
status.reason	Status reason	String	No	No	Yes	No	No	No

Approval Response

This is the only response that we will return only a status for it. Do not expect a status.reason here

Example:

\"status\": {\n        \"status\": \"Approved\",\n        \"reason\": null\n    }\n\n

Decline Response

The decline response will include a status.reason giving you more details on the type of decline.

Example:

\"status\": {\n        \"status\": \"Declined\",\n        \"reason\": Insufficient Funds\n    }\n\n

Here is a list of all possible decline codes:

Status Reason Message	Details
Duplicate Request (Approved previously)	The transaction was already performed and approved. Verify if the request was submitted twice for the same transaction ID or external reference number.
Reversal Not Allowed	The transaction is not authorized for reversal. This error may occur because the transaction was settled, declined, or already reversed.
Return Not Allowed	The transaction is not authorized for return. This error may occur because the transaction was not settled, was declined, or was already reversed.
Supervisor Override Required
Modify Transaction Not Allowed	The transaction is not authorized for modification. This error may occur because the transaction was already settled, or was declined.
Possible Duplicate Request	This is a duplicate request. The credentials for this transaction (i.e. amount, card number, or same service) are the same as another transaction submitted less than one minute apart.
Duplicate Request (Reversed previously)	The request with the same credentials (amount, card number, or same service) hit the server twice within a minute.
Inactive Device (Terminal)	The device is not registered, or is inactive in the system.
Device (Terminal) Configuration missing	The configuration parameter is missing.
Insufficient privileges
Incremental Auth Not Allowed
Unable to process your request. Settlement InProgress.	The transaction settlement is in progress.
Functionality currently not available.	The functionality is not supported by .
Inactive Merchant (Account)	The merchant is not registered, or is inactive in the system.
Merchant (Account) configuration missing	The configuration parameter is missing.
Processor configuration missing	The processor parameter is missing.
Unique ID Error	The terminal unique ID is invalid, or is not registered in the system.
Service Not Allowed
Inactive terminal (Backend)	The device is inactive or is not registered at the host.
Inactive account (Backend)	The account is inactive, or is not registered at the host.
Unique ID Error (Backend)	The terminal unique ID is invalid, or is not registered at the host.
Duplicate Request (Backend)	This is a duplicate transaction. This transaction was already approved and processed.
Reversal Not Allowed (Backend)	The transaction is not authorized for reversal. This error may occur because the transaction was settled, declined, or already reversed.
Return Not Allowed (Backend)	The transaction is not authorized for return. This error may occur because the transaction was settled, declined, or already reversed.
Re-enter transaction
Encryption failure from host
Return not allowed, Card number requested does not match with original transaction card number
Invalid taskID
Currency code mismatch with original transaction
Multiple amount format in single request not supported
Time out
System Error
Error on Host
System error (DB Insert)
Invalid store ID	Invalid store ID.
Invalid amount	Amount provided in request is invalid.
Coupon service is temporarily unavailable.	Coupon service is temporarily unavailable.
Host Auth initialization declined
Card not accepted by host
Host Auth finalization declined
Host connectivity failed
Host Reversal declined
Host Return initialization declined
Host Return finalization declined
Payment_Facilitator_ID is mandatory for VISA, Mastercard Payment facilitator transactions	The transaction does not contain Payment_Facilitator_ID information, which is mandatory for Payment Facilitator Visa and Mastercard transactions.
General Bill Pay Decline	General declined please contact help desk.
Refer to Issuer	The merchant must call the issuer to obtain verbal authorization.
Suspected Card (pick-up, hot-card)	This credit card has been flagged for fraud. the merchant should call the number on the back of the card to obtain further instructions. Suspected card error occurs in the following scenarios: - The card is restricted by the issuer - Loss of card is reported Theft of card is reported
Honor with identification?	The card is not identified.
Invalid Amount	The amount exceeds the limits established by the issuer for this type of transaction.
Invalid Card	The issuer indicates that this card is invalid.
No such issuer	The card issuer number is invalid.
Invalid fee	The transaction fee is unacceptable.
Incorrect Pin	The PIN entered by the cardholder is incorrect.
Pin attempts exceeded	The number of attempts to enter the PIN has exceeded.
Key synchronization failed from the host	The failure of a key synchronization from the host.
Expired Card	The card has expired.
Insufficient Funds	The credit limit for this account has been exceeded, or the amount is not enough to perform the transaction.
Invalid From Account	The transaction account is invalid.
Invalid To Account	The transaction account is invalid.
Withdrawal Limit exceeded	The withdrawal limit on an account is exceeded.
Withdrawal frequency exceeded	The withdrawal frequency on an account is exceeded.
Time limit for Pre-Auth reached	The time for Pre-Auth has reached its limit.
AVS FAILED	The address verification has failed and the merchant is configured for auto decline on AVS failure.
Billing ZIP Mismatch	The zip provided does not match the billing address on file and the merchant is configured for auto decline on ZIP code mismatch.
CVV2 verification failed	The V code provided is invalid or does not match what is on file and the merchant set up for auto decline on CVV2 failure.
Issuer or Switch inoperative	The bank is unavailable to authorize this transaction.
Duplicate transaction ( Same amount / Account)	The transaction with the same amount and account is performed twice.
Balance unavailable for inquiry	The balance cannot be validated.
Check Digit Err	The credit card number entered did not pass validation. Correct and re-enter the credit card number.
Excluded Bin ID for Merchant	Card is not allowed to do transactions at this merchant.
Do not honor	The transaction was declined by the issuer.
AVS and CVV2 failed	The address verification and V code verification failed and the merchant set up for auto decline on AVS and CVV2 failure.
Invalid Date	The credit card expiration date is invalid. Verify and re-enter the expiration date.
Invalid Service	The service provided by the card is invalid.
Host Validation Error	The host is an invalid host.
Activity Limit exceeded	The daily card activity limit has been exceeded.
Cannot complete because of Violation	The transaction cannot be completed because the credit card account has been flagged with a violation.
Debit Pin Required	The BIN is blocked by the issuer.
Check Service authentication failure
Could Not Retrieve a Valid Card Number for Token
Card information is not provided
No Card found for the BIN
Card verification failed for card number	Verification of the card number has failed.
PreFraudScout Decline	Transaction is declined in Pre Fraud rules.
General Card Auth Decline	This is a general decline error.
Blocked Account	The account provided in transaction is blocked.
Blocked Check	The check provided in transaction is blocked.
Invalid Token
Service Not Allowed

Error Response

These are rare and are usually returned due to incorrect request formatting or general system errors.

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

Status Reason Message	Details
Format Error field details	Check the formatting of your request parameters
Customer requested stop of all recurring payments from specific merchant
Transaction is in process. Please try again after some time.	Simultaneous actions cannot be performed on the same customer record. The application is unable to perform edits on a customer record while the record is in use.
An error has occurred. Your request couldn't be processed because of a technical issue. Please try again later. We apologize for the inconvenience. Our technical team has been notified	This is a system general error and you can contact us if you are experiencing these errors for more information.

","_postman_id":"6eb1c794-c698-4483-bbc6-64bc0136d126","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","name":"Payment Gateway","type":"folder"}}}],"id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"dd55f844-f6cb-414c-9d63-668ab33c34e9","description":""},{"name":"Dashboard","item":[{"name":"Sandbox","item":[{"name":"Sandbox Dashboard","id":"09d9c839-36b1-413c-8899-e94c58c3cab6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-dashboard.paysecureonline.com/","description":"

For testing purposes, please use our sandbox endpoint.

\n","urlObject":{"host":["https://sandbox-dashboard.paysecureonline.com/"],"query":[],"variable":[]}},"response":[],"_postman_id":"09d9c839-36b1-413c-8899-e94c58c3cab6"}],"id":"1b0f8591-61b4-48ad-9148-9c28ccd31f1d","_postman_id":"1b0f8591-61b4-48ad-9148-9c28ccd31f1d","description":""},{"name":"Resources","item":[{"name":"Boarding Applications","item":[{"name":"Campaigns","item":[{"name":"List","id":"d66a5729-84e5-4011-89c3-07e215f3d9ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/campaigns","description":"

Use this endpoint to list all Campaigns

A Boarding Application always starts by choosing a campaign and processingMethod. We have two main types of campaigns Standard or Other.

A standard campaign is a pre-fixed system campaign with standard pricing fees (Interchange or 3 Tier). Other is used for all the other types of campaigns where we do special conditions, pricing fees etc. The processingMethod determines the method of processing that a merchants wants to apply for.

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the campaign	Integer	Yes	No	Yes
name	Name of the campaign	String	Yes	No	Yes
type	`Standard` or `Other`	ENUM	Yes	No	Yes
processingMethod	`Acquiring`, `ACH` or `All`	ENUM	Yes	No	Yes
createdOn	Date and Time of creation	DateTime	Yes	No	Yes

","_postman_id":"382fe813-25f2-43db-9ae3-73b348a7d2b6","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Equipment","item":[{"name":"Terminals","item":[{"name":"List","id":"cd41c57c-332f-48e2-9c13-2563f5b3234a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application//equipment/terminals","description":"

List all terminals that have been added to a Boarding Application. These terminals will be sent to the merchant when the application is approved.

View a specific Terminal in the Equipment section of the Boarding Application

Add a Terminal in the Equipment section of the Boarding Application

Update a Terminal in the Equipment section of the Boarding Application.

Just as in the dashboard, most of the fields are lockable.

Depending on the user's permissions in the dashboard, you won't be able to edit locked fields.

\n
Important: Attempting to update a locked field or a lock flag without the appropriate permissions will simply return the old values for these fields.
\n

You can utilize this endpoint to delete a terminal in the Equipment section of the Boarding Application

When creating a boarding application we give you the ability to add existing terminals.

By utilizing this endpoint you can perform several operations with the Existing terminals section of the Boarding Application.

\n
IMPORTANT You can only create, update, and delete Terminals information on pre-approved
applications.
\n

Equipment Terminal Object

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

Fields	Description	Type	Filterable	Required	Readonly
tid	TID	Integer	No	No	No
vnumber	V#	String	No	No	No
gateway	`Internal` or `Other`	ENUM	No	No	No
note	Note	String	No	No	No

","_postman_id":"ef6ff741-c226-4743-a789-ba1f3cf7b46d","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"View","id":"5ee03b99-0f1a-4ee5-bd78-f28315432b55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application//equipment","description":"

Use this endpoint to view the equipment settings on a Boarding Application.

Use this endpoint the update the equipment section of a Boarding Application

Just as in the dashboard, most of the fields are lockable.

Depending on permission you might not be able to update locked fields.

\n
Important: Attempting to update a locked field or a lock flag without the appropriate permissions will simply return the old values for these fields as they won't be updated.
\n

You can utilize this endpoint to perform several operation in the Equipment section of the Boarding Application

Equipment Oject

Fields	Description	Type	Filterable	Required	Readonly
equipment	Equipment Info	Object	No	No	No
equipment.used	Equipment Used Object	Object	No	No	No
equipment.used.value	Equipment Used Value	String	No	No	No
equipment.used.locked	Equipment Used Locked Flag `Yes` or `No`	Enum	No	No	No
equipment.note	Equipment Note Object	Object	No	No	No
equipment.note.value	Equipment Note Value	String	No	No	No
equipment.note.locked	Equipment Note Locked Flag `Yes` or `No`	Enum	No	No	No
equipment.providedBy	Equipment Provided By Object	Object	No	No	No
equipment.providedBy.value	Equipment Provided By Value `ISO` or `Deployment Center`	String	No	No	No
equipment.providedBy.locked	Equipment Provided By Locked Flag `Yes` or `No`	Enum	No	No	No
varRequired	Var Required Object	Object	No	No	No
varRequired.value	Var Required Value `Yes` or `No`	Enum	No	No	No
varRequired.locked	Var Required Locked Flag `Yes` or `No`	Enum	No	No	No
discountPeriod	Discount Period Object	Object	No	No	No
discountPeriod.value	Discount Period Value `Daily` or `Monthly`	Enum	No	No	No
discountPeriod.locked	Discount Period Locked Flag `Yes` or `No`	Enum	No	No	No
fundingPeriod	Funding Period Object	Object	No	No	No
fundingPeriod.value	Funding Period Value `TwoBusinessDays`, `NextDay`, `SameDay`	Enum	No	No	No
fundingPeriod.locked	Funding Period Locked Flag `Yes` or `No`	Enum	No	No	No
type	Type Object	Object	No	No	No
type.value	Type Value `StageOnly` or `Custom`	Enum	No	No	No
type.locked	Type Locked Flag `Yes` or `No`	Enum	No	No	No
emv	Emv Object	Object	No	No	No
emv.value	Emv Value `Yes` or `No`	Enum	No	No	No
emv.locked	Emv Locked Flag `Yes` or `No`	Enum	No	No	No
mobileTerminal	Mobile Terminal Object	Object	No	No	No
mobileTerminal.value	Mobile Terminal Value `Yes` or `No`	Enum	No	No	No
mobileTerminal.locked	Mobile Terminal Locked Flag `Yes` or `No`	Enum	No	No	No
externalPinPad	External Pin Pad Object	Object	No	No	No
externalPinPad.value	External Pin Pad Value `Yes` or `No`	Enum	No	No	No
externalPinPad.locked	External Pin Pad Locked Flag `Yes` or `No`	Enum	No	No	No
contactless	Contactless Object	Object	No	No	No
contactless.value	Contactless Value `Yes` or `No`	Enum	No	No	No
contactless.locked	Contactless Locked Flag `Yes` or `No`	Enum	No	No	No
existingTID	Existing TID Object	Object	No	No	No
existingTID.value	Existing TID Value `Yes` or `No`	Enum	No	No	No
existingTID.locked	Existing TID Locked Flag `Yes` or `No`	Enum	No	No	No
existingTID.terminals	Existing TID Boarding Application Terminals Object	Object	No	No	No
serialNumberSettings	Serial Number Settings Object	Object	No	No	No
serialNumberSettings.value	Serial Number Settings Value	String	No	No	No
serialNumberSettings.locked	Serial Number Settings Locked Flag `Yes` or `No`	Enum	No	No	No
pinDebitPad	Pin Debit Pad Object	Object	No	No	No
pinDebitPad.value	Pin Debit Pad Value `Internal` or `External`	Enum	No	No	No
pinDebitPad.locked	Pin Debit Pad Locked Flag `Yes` or `No`	Enum	No	No	No
ebtFnsNumber	EBT FNS Number	Object	No	No	No
ebtFnsNumber.value	EBT FNS Number Value	String	No	No	No
ebtFnsNumber.locked	EBT By Locked Flag `Yes` or `No`	Enum	No	No	No
terminal	Terminal Object	Object	No	No	No
terminal.paidBy	Terminal Paid By Object	Object	No	No	No
terminal.paidBy.value	Terminal Paid By Value `ISO`, `Sub-Agent`, `Merchant`	Enum	No	No	No
terminal.paidBy.locked	Terminal Paid By Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.paidAmount	Terminal Paid Amount Object	Object	No	No	No
terminal.paidAmount.value	Terminal Paid Amount Value	Number	No	No	No
terminal.paidAmount.locked	Terminal Paid Amount Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.shipTo	Terminal Ship To Object	Object	No	No	No
terminal.shipTo.value	Terminal Ship To Value `ISO`, `Sub-Agent`, `Merchant`	Enum	No	No	No
terminal.shipTo.locked	Terminal Ship To Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.shipping	Terminal Shipping Object	Object	No	No	No
terminal.shipping.address	Terminal Shipping Address Object	Object	No	No	No
terminal.shipping.address.value	Terminal Shipping Address Value	String	No	No	No
terminal.shipping.address.locked	Terminal Shipping Address Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.shipping.method	Terminal Shipping Method Object	Object	No	No	No
terminal.shipping.method.value	Terminal Shipping Method Value `Overnight`, `OvernightAm`, `SecondDay`, `FedexExpressSaver`	Enum	No	No	No
terminal.shipping.method.locked	Terminal Shipping Method Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.communication	Terminal Communication Object	Object	No	No	No
terminal.communication.value	Terminal Communication Value `Dial`, `Ethernet`, `Wireless`	Enum	No	No	No
terminal.communication.locked	Terminal Communication Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.batch	Terminal Batch Object	Object	No	No	No
terminal.batch.type	Terminal Batch Type Object	Object	No	No	No
terminal.batch.type.value	Terminal Batch Type Value `Auto` or `Manual`	Enum	No	No	No
terminal.batch.type.locked	Terminal Batch Type Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.batch.period	Terminal Batch Period Object	Object	No	No	No
terminal.batch.period.value	Terminal Batch Period Value	String	No	No	No
terminal.batch.period.locked	Terminal Batch Period Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.header	Terminal Header Object	Object	No	No	No
terminal.header.value	Terminal Header Value	String	No	No	No
terminal.header.locked	Terminal Header Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.footerLine	Terminal Footer Line Object	Object	No	No	No
terminal.footerLine.value	Terminal Footer Line Value `One`, `Two`, `Three`, `Four`	Enum	No	No	No
terminal.footerLine.locked	Terminal Footer Line Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.surcharge	Terminal Surcharge Object	Object	No	No	No
terminal.surcharge.feeDescription	Terminal Surcharge Fee Description Object	Object	No	No	No
terminal.surcharge.feeDescription.value	Terminal Surcharge Fee Description Value	String	No	No	No
terminal.surcharge.feeDescription.locked	Terminal Surcharge Fee Description Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.surcharge.percentage	Terminal Surcharge Percentage Object	Object	No	No	No
terminal.surcharge.percentage.value	Terminal Surcharge Percentage Value	Number	No	No	No
terminal.surcharge.percentage.locked	Terminal Surcharge Percentage Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.surcharge.bypassOption	Terminal Surcharge Bypass Option Object	Object	No	No	No
terminal.surcharge.bypassOption.value	Terminal Surcharge Bypass Option Value `Yes` or `No`	Enum	No	No	No
terminal.surcharge.bypassOption.locked	Terminal Surcharge Bypass Option Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.surcharge.notes	Terminal Surcharge Notes Object	Object	No	No	No
terminal.surcharge.notes.value	Terminal Surcharge Notes Value	String	No	No	No
terminal.surcharge.notes.locked	Terminal Surcharge Notes Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.tip	Terminal Tip Object	Object	No	No	No
terminal.tip.line	Terminal Tip Line Object	Object	No	No	No
terminal.tip.line.value	Terminal Tip Line Value `Yes` or `No`	Enum	No	No	No
terminal.tip.line.locked	Terminal Tip Line Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.tip.prompt	Terminal Tip Prompt Object	Object	No	No	No
terminal.tip.prompt.value	Terminal Tip Prompt Value `Yes` or `No`	Enum	No	No	No
terminal.tip.prompt.locked	Terminal Tip Prompt Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.tip.suggestion	Terminal Tip Suggestion Object	Object	No	No	No
terminal.tip.suggestion.value	Terminal Tip Suggestion Value `Yes` or `No`	Enum	No	No	No
terminal.tip.suggestion.locked	Terminal Tip Suggestion Locked Flag `Yes` or `No`	Enum	No	No	No
terminal.tip.suggestion.percentages	Terminal Tip Suggestion Percentages Object	Object	No	No	No
terminal.tip.suggestion.percentages.value	Terminal Tip Suggestion Percentages Value	String	No	No	No
terminal.tip.suggestion.percentages.locked	Terminal Tip Suggestion Percentages Locked Flag `Yes` or `No`	Enum	No	No	No
lastEquipmentUpdated	Last Date Equipment Updated	Datetime	No	No	No
lastAgentReview	Last Date Reviewed By Agent	Datetime	No	No	No

","_postman_id":"04ca6112-a84c-4bb8-b1e3-c02d207c98d8","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"List","item":[{"name":"List Boarding Applications","id":"8f4a8f3b-e3db-4b1f-887d-0735a495b637","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"46397d0e-8eb4-47c1-9415-e693127938d8","name":"List Boarding Applications","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 606,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-04-16 13:13:02\",\n \"createdOn\": \"2023-03-16 14:57:16\"\n },\n {\n \"id\": 605,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-04-10 13:13:02\",\n \"createdOn\": \"2023-03-10 11:05:22\"\n },\n {\n \"id\": 603,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-04-10 13:13:02\",\n \"createdOn\": \"2023-03-10 10:52:25\"\n },\n {\n \"id\": 601,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-04-10 13:13:02\",\n \"createdOn\": \"2023-03-10 10:33:17\"\n },\n {\n \"id\": 600,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-04-10 13:13:02\",\n \"createdOn\": \"2023-03-10 10:29:43\"\n },\n {\n \"id\": 599,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-04-06 13:13:02\",\n \"createdOn\": \"2023-03-04 16:26:12\"\n },\n {\n \"id\": 597,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Signed\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-03-23 13:13:01\",\n \"createdOn\": \"2023-02-20 18:15:14\"\n },\n {\n \"id\": 596,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-03-23 13:13:01\",\n \"createdOn\": \"2023-02-20 18:14:59\"\n },\n {\n \"id\": 595,\n \"processingMethod\": \"Acquiring\",\n \"company\": {\n \"name\": null\n },\n \"dba\": {\n \"name\": null\n },\n \"campaign\": {\n \"id\": 1\n },\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\"\n },\n \"status\": \"Cancelled\",\n \"updatedOn\": \"2023-03-18 13:13:01\",\n \"createdOn\": \"2023-02-15 10:28:59\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/boarding-application?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/boarding-application?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/boarding-application?page=1\"\n },\n \"next\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/boarding-application?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 7,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"8f4a8f3b-e3db-4b1f-887d-0735a495b637"}],"id":"1679cd54-9781-427d-8d42-4ba88a0663d0","description":"

Use this endpoint to list all Boarding Applications that you have available.

\n","_postman_id":"1679cd54-9781-427d-8d42-4ba88a0663d0","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Create","item":[{"name":"Create Boarding Application","id":"e1068d1f-7f8e-4db5-9023-6841561bed5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"campaign\": {\n \"id\": 206\n },\n \"processingMethod\": \"Acquiring\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application","description":"

Creating an Acquiring Boarding Application from a standard Campaign with ID 206 as an example.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"8551855d-3486-4f93-94af-0340065a4d75","name":"Create Boarding Application","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"campaign\": {\n \"id\": 206\n },\n \"processingMethod\": \"Acquiring\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 607,\n \"processingMethod\": \"Acquiring\",\n \"mcc\": null,\n \"campaign\": {\n \"id\": 206\n },\n \"company\": {\n \"name\": null,\n \"type\": null,\n \"federalTaxId\": null,\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n },\n \"founded\": null\n },\n \"dba\": {\n \"sameAsCompany\": \"Yes\",\n \"name\": null,\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n }\n },\n \"website\": null,\n \"serviceDescription\": null,\n \"mailingAddress\": \"legal\",\n \"businessLocation\": {\n \"buildingType\": null,\n \"numberOfLocations\": null,\n \"buildingOwnership\": null,\n \"areaZoned\": null,\n \"squareFootage\": null\n },\n \"customerServiceContact\": {\n \"phone\": null,\n \"email\": null\n },\n \"corporateContact\": {\n \"phone\": null,\n \"fax\": null,\n \"email\": null\n },\n \"bankruptcy\": {\n \"hasBankruptcy\": null,\n \"description\": null\n },\n \"principals\": [\n {\n \"id\": 739,\n \"title\": null,\n \"name\": {\n \"first\": null,\n \"last\": null\n },\n \"dayOfBirth\": null,\n \"ssn\": null,\n \"nationalId\": null,\n \"nationality\": {\n \"id\": 199\n },\n \"driverLicense\": {\n \"number\": null,\n \"expiration\": null,\n \"state\": {\n \"id\": null\n }\n },\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n },\n \"phone\": null,\n \"email\": null,\n \"ownershipPercentage\": null,\n \"isManagement\": \"Yes\"\n }\n ],\n \"processing\": {\n \"bank\": {\n \"accountNumber\": null,\n \"routingNumber\": null\n },\n \"volumes\": {\n \"monthlyTransactionAmount\": null,\n \"avgTransactionAmount\": null,\n \"maxTransactionAmount\": null\n },\n \"sales\": {\n \"swiped\": null,\n \"mail\": null,\n \"internet\": null\n },\n \"alreadyProcessing\": {\n \"isProcessing\": \"No\",\n \"processor\": null\n },\n \"terminated\": {\n \"isTerminated\": null,\n \"description\": null\n },\n \"customers\": {\n \"type\": {\n \"individual\": null,\n \"business\": null,\n \"government\": null\n },\n \"location\": {\n \"local\": null,\n \"national\": null,\n \"international\": null\n }\n },\n \"fulfillmentPolicy\": {\n \"fulfillment\": null,\n \"fulfillmentOther\": null,\n \"delivery\": null,\n \"deliveryOther\": null\n },\n \"recurringPayments\": {\n \"hasRecurring\": \"No\",\n \"description\": null\n },\n \"intendedUsage\": {\n \"creditCards\": \"No\",\n \"pinDebit\": \"No\",\n \"ebt\": \"No\",\n \"fns\": null,\n \"notes\": null\n },\n \"seasonalBusiness\": {\n \"isSeasonal\": \"No\",\n \"months\": []\n },\n \"inventory\": {\n \"onSite\": \"No\",\n \"offSite\": \"No\",\n \"offSiteAddress\": null,\n \"thirdParty\": \"No\",\n \"serviceOnly\": \"No\"\n },\n \"retailLocation\": null,\n \"externalFulfillment\": \"No\",\n \"customerCharged\": null,\n \"equipmentUsed\": null,\n \"advertise\": null,\n \"refundPolicy\": null,\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": 19321,\n \"type\": {\n \"id\": 1\n },\n \"value\": \"1.00001\"\n },\n {\n \"id\": 19322,\n \"type\": {\n \"id\": 2\n },\n \"value\": \"0.00002\"\n },\n {\n \"id\": 19323,\n \"type\": {\n \"id\": 3\n },\n \"value\": \"0.00003\"\n },\n {\n \"id\": 19324,\n \"type\": {\n \"id\": 4\n },\n \"value\": \"0.00004\"\n },\n {\n \"id\": 19325,\n \"type\": {\n \"id\": 5\n },\n \"value\": \"0.00005\"\n },\n {\n \"id\": 19326,\n \"type\": {\n \"id\": 6\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19327,\n \"type\": {\n \"id\": 7\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19328,\n \"type\": {\n \"id\": 8\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19329,\n \"type\": {\n \"id\": 9\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19330,\n \"type\": {\n \"id\": 10\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19331,\n \"type\": {\n \"id\": 11\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19332,\n \"type\": {\n \"id\": 12\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19333,\n \"type\": {\n \"id\": 13\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19334,\n \"type\": {\n \"id\": 14\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19335,\n \"type\": {\n \"id\": 15\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19336,\n \"type\": {\n \"id\": 16\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19337,\n \"type\": {\n \"id\": 17\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19338,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19339,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19340,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19341,\n \"type\": {\n \"id\": 19\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19342,\n \"type\": {\n \"id\": 20\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19343,\n \"type\": {\n \"id\": 21\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19344,\n \"type\": {\n \"id\": 22\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n },\n \"ach\": null,\n \"documents\": [],\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\",\n \"via\": null\n },\n \"auto\": {\n \"sign\": \"Yes\",\n \"underwriting\": \"No\"\n },\n \"status\": \"New\",\n \"updatedOn\": \"2023-05-10 11:52:41\",\n \"createdOn\": \"2023-05-10 11:52:40\"\n}"}],"_postman_id":"e1068d1f-7f8e-4db5-9023-6841561bed5d"}],"id":"6f7f53d4-2e74-441e-b9b7-12d422843151","description":"

An application needs to be created first before proceeding to updating with the necessary fields. We have 3 types of Boarding Applications based on the processing type that the merchant is applying for.

An Acquiring Boarding Application
An ACH Boarding Application
A hybrid, Acquiring and ACH Boarding Application.

\n
Keep in mind that the number of required fields are dependent on the processingMethod. For example if the Boarding Application is for Acquiring there is no need to send ACH section. Also for an Acquiring Boarding Application based on the processing.sales values we might require additional fields if the merchant has 70% or more processing.sales.mail + processing.sales.internet.
\n

\n","_postman_id":"6f7f53d4-2e74-441e-b9b7-12d422843151","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Delete","item":[{"name":"Delete Boarding Application","id":"e03136d5-4bc8-4f3e-a7a3-90346e575a71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"72ec3d8c-4151-48c7-bf27-112d28396a1d","name":"Delete Boarding Application","originalRequest":{"method":"DELETE","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/599"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"e03136d5-4bc8-4f3e-a7a3-90346e575a71"}],"id":"39ec8f6e-e5cb-4804-af67-c6193b893875","description":"

You can use this endpoint to Delete a boarding application.

\n
NOTE This functionality is permission based, and in some case we might return an exception
\n

\n","_postman_id":"39ec8f6e-e5cb-4804-af67-c6193b893875","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"View","item":[{"name":"View Boarding Application","id":"6440fefb-fd87-4cbf-a8e0-0b0c36d1c457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/","description":"

You can utilize this endpoint for viewing the full Boarding Application

View Boarding Application with id 607

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"33010733-03e0-4575-9468-d17f2a87ffe7","name":"View Boarding Application","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/607"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 607,\n \"processingMethod\": \"Acquiring\",\n \"mcc\": null,\n \"campaign\": {\n \"id\": 206\n },\n \"company\": {\n \"name\": null,\n \"type\": null,\n \"federalTaxId\": null,\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n },\n \"founded\": null\n },\n \"dba\": {\n \"sameAsCompany\": \"Yes\",\n \"name\": null,\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n }\n },\n \"website\": null,\n \"serviceDescription\": null,\n \"mailingAddress\": \"legal\",\n \"businessLocation\": {\n \"buildingType\": null,\n \"numberOfLocations\": null,\n \"buildingOwnership\": null,\n \"areaZoned\": null,\n \"squareFootage\": null\n },\n \"customerServiceContact\": {\n \"phone\": null,\n \"email\": null\n },\n \"corporateContact\": {\n \"phone\": null,\n \"fax\": null,\n \"email\": null\n },\n \"bankruptcy\": {\n \"hasBankruptcy\": null,\n \"description\": null\n },\n \"principals\": [\n {\n \"id\": 739,\n \"title\": null,\n \"name\": {\n \"first\": null,\n \"last\": null\n },\n \"dayOfBirth\": null,\n \"ssn\": null,\n \"nationalId\": null,\n \"nationality\": {\n \"id\": 199\n },\n \"driverLicense\": {\n \"number\": null,\n \"expiration\": null,\n \"state\": {\n \"id\": null\n }\n },\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n },\n \"phone\": null,\n \"email\": null,\n \"ownershipPercentage\": null,\n \"isManagement\": \"Yes\"\n }\n ],\n \"processing\": {\n \"bank\": {\n \"accountNumber\": null,\n \"routingNumber\": null\n },\n \"volumes\": {\n \"monthlyTransactionAmount\": null,\n \"avgTransactionAmount\": null,\n \"maxTransactionAmount\": null\n },\n \"sales\": {\n \"swiped\": null,\n \"mail\": null,\n \"internet\": null\n },\n \"alreadyProcessing\": {\n \"isProcessing\": \"No\",\n \"processor\": null\n },\n \"terminated\": {\n \"isTerminated\": null,\n \"description\": null\n },\n \"customers\": {\n \"type\": {\n \"individual\": null,\n \"business\": null,\n \"government\": null\n },\n \"location\": {\n \"local\": null,\n \"national\": null,\n \"international\": null\n }\n },\n \"fulfillmentPolicy\": {\n \"fulfillment\": null,\n \"fulfillmentOther\": null,\n \"delivery\": null,\n \"deliveryOther\": null\n },\n \"recurringPayments\": {\n \"hasRecurring\": \"No\",\n \"description\": null\n },\n \"intendedUsage\": {\n \"creditCards\": \"No\",\n \"pinDebit\": \"No\",\n \"ebt\": \"No\",\n \"fns\": null,\n \"notes\": null\n },\n \"seasonalBusiness\": {\n \"isSeasonal\": \"No\",\n \"months\": []\n },\n \"inventory\": {\n \"onSite\": \"No\",\n \"offSite\": \"No\",\n \"offSiteAddress\": null,\n \"thirdParty\": \"No\",\n \"serviceOnly\": \"No\"\n },\n \"retailLocation\": null,\n \"externalFulfillment\": \"No\",\n \"customerCharged\": null,\n \"equipmentUsed\": null,\n \"advertise\": null,\n \"refundPolicy\": null,\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": 19321,\n \"type\": {\n \"id\": 1\n },\n \"value\": \"1.00001\"\n },\n {\n \"id\": 19322,\n \"type\": {\n \"id\": 2\n },\n \"value\": \"0.00002\"\n },\n {\n \"id\": 19323,\n \"type\": {\n \"id\": 3\n },\n \"value\": \"0.00003\"\n },\n {\n \"id\": 19324,\n \"type\": {\n \"id\": 4\n },\n \"value\": \"0.00004\"\n },\n {\n \"id\": 19325,\n \"type\": {\n \"id\": 5\n },\n \"value\": \"0.00005\"\n },\n {\n \"id\": 19326,\n \"type\": {\n \"id\": 6\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19327,\n \"type\": {\n \"id\": 7\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19328,\n \"type\": {\n \"id\": 8\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19329,\n \"type\": {\n \"id\": 9\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19330,\n \"type\": {\n \"id\": 10\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19331,\n \"type\": {\n \"id\": 11\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19332,\n \"type\": {\n \"id\": 12\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19333,\n \"type\": {\n \"id\": 13\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19334,\n \"type\": {\n \"id\": 14\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19335,\n \"type\": {\n \"id\": 15\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19336,\n \"type\": {\n \"id\": 16\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19337,\n \"type\": {\n \"id\": 17\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19338,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19339,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19340,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19341,\n \"type\": {\n \"id\": 19\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19342,\n \"type\": {\n \"id\": 20\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19343,\n \"type\": {\n \"id\": 21\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19344,\n \"type\": {\n \"id\": 22\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n },\n \"ach\": null,\n \"documents\": [],\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\",\n \"via\": null\n },\n \"auto\": {\n \"sign\": \"Yes\",\n \"underwriting\": \"No\"\n },\n \"status\": \"New\",\n \"updatedOn\": \"2023-05-10 11:52:41\",\n \"createdOn\": \"2023-05-10 11:52:40\"\n}"}],"_postman_id":"6440fefb-fd87-4cbf-a8e0-0b0c36d1c457"}],"id":"2c454cbb-42be-4a8a-bc3a-014a57c37cf8","description":"

You can either view the full Boarding Application or only a specific section.

\n
Keep in mind that based on the processingMethod the Processing/ACH section can be null.
\n

The sections of the Boarding Application that are available to be viewed/updated separately are as follows:

Principals
Processing
ACH
Documents
Fees

Each section and all endpoints associated with it are described in detail in our developers documentation

\n","_postman_id":"2c454cbb-42be-4a8a-bc3a-014a57c37cf8","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Update","item":[{"name":"Update Boarding Application","id":"a0efa9af-942a-4931-9810-00e3ea9577cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"company\": {\n \"name\":\"Demo Company 2\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608","description":"

In the below example, we are updating only the company.name of the Boarding Application.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","608"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"b9533b22-28b3-4d99-a2ee-8b6f67519f01","name":"Update Boarding Application","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"company\": {\n \"name\":\"Demo Company 2\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 608,\n \"processingMethod\": \"Acquiring\",\n \"mcc\": null,\n \"campaign\": {\n \"id\": 206\n },\n \"company\": {\n \"name\": \"Demo Company 2\",\n \"type\": null,\n \"federalTaxId\": null,\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n },\n \"founded\": null\n },\n \"dba\": {\n \"sameAsCompany\": \"Yes\",\n \"name\": null,\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n }\n },\n \"website\": null,\n \"serviceDescription\": null,\n \"mailingAddress\": \"legal\",\n \"businessLocation\": {\n \"buildingType\": null,\n \"numberOfLocations\": null,\n \"buildingOwnership\": null,\n \"areaZoned\": null,\n \"squareFootage\": null\n },\n \"customerServiceContact\": {\n \"phone\": null,\n \"email\": null\n },\n \"corporateContact\": {\n \"phone\": null,\n \"fax\": null,\n \"email\": null\n },\n \"bankruptcy\": {\n \"hasBankruptcy\": null,\n \"description\": null\n },\n \"principals\": [\n {\n \"id\": 740,\n \"title\": null,\n \"name\": {\n \"first\": null,\n \"last\": null\n },\n \"dayOfBirth\": null,\n \"ssn\": null,\n \"nationalId\": null,\n \"nationality\": {\n \"id\": 199\n },\n \"driverLicense\": {\n \"number\": null,\n \"expiration\": null,\n \"state\": {\n \"id\": null\n }\n },\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": {\n \"id\": null\n },\n \"country\": {\n \"id\": 199\n }\n },\n \"phone\": null,\n \"email\": null,\n \"ownershipPercentage\": null,\n \"isManagement\": \"Yes\"\n }\n ],\n \"processing\": {\n \"bank\": {\n \"accountNumber\": null,\n \"routingNumber\": null\n },\n \"volumes\": {\n \"monthlyTransactionAmount\": null,\n \"avgTransactionAmount\": null,\n \"maxTransactionAmount\": null\n },\n \"sales\": {\n \"swiped\": null,\n \"mail\": null,\n \"internet\": null\n },\n \"alreadyProcessing\": {\n \"isProcessing\": \"No\",\n \"processor\": null\n },\n \"terminated\": {\n \"isTerminated\": null,\n \"description\": null\n },\n \"customers\": {\n \"type\": {\n \"individual\": null,\n \"business\": null,\n \"government\": null\n },\n \"location\": {\n \"local\": null,\n \"national\": null,\n \"international\": null\n }\n },\n \"fulfillmentPolicy\": {\n \"fulfillment\": null,\n \"fulfillmentOther\": null,\n \"delivery\": null,\n \"deliveryOther\": null\n },\n \"recurringPayments\": {\n \"hasRecurring\": \"No\",\n \"description\": null\n },\n \"intendedUsage\": {\n \"creditCards\": \"No\",\n \"pinDebit\": \"No\",\n \"ebt\": \"No\",\n \"fns\": null,\n \"notes\": null\n },\n \"seasonalBusiness\": {\n \"isSeasonal\": \"No\",\n \"months\": []\n },\n \"inventory\": {\n \"onSite\": \"No\",\n \"offSite\": \"No\",\n \"offSiteAddress\": null,\n \"thirdParty\": \"No\",\n \"serviceOnly\": \"No\"\n },\n \"retailLocation\": null,\n \"externalFulfillment\": \"No\",\n \"customerCharged\": null,\n \"equipmentUsed\": null,\n \"advertise\": null,\n \"refundPolicy\": null,\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": 19357,\n \"type\": {\n \"id\": 1\n },\n \"value\": \"1.00001\"\n },\n {\n \"id\": 19358,\n \"type\": {\n \"id\": 2\n },\n \"value\": \"0.00002\"\n },\n {\n \"id\": 19359,\n \"type\": {\n \"id\": 3\n },\n \"value\": \"0.00003\"\n },\n {\n \"id\": 19360,\n \"type\": {\n \"id\": 4\n },\n \"value\": \"0.00004\"\n },\n {\n \"id\": 19361,\n \"type\": {\n \"id\": 5\n },\n \"value\": \"0.00005\"\n },\n {\n \"id\": 19362,\n \"type\": {\n \"id\": 6\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19363,\n \"type\": {\n \"id\": 7\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19364,\n \"type\": {\n \"id\": 8\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19365,\n \"type\": {\n \"id\": 9\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19366,\n \"type\": {\n \"id\": 10\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19367,\n \"type\": {\n \"id\": 11\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19368,\n \"type\": {\n \"id\": 12\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19369,\n \"type\": {\n \"id\": 13\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19370,\n \"type\": {\n \"id\": 14\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19371,\n \"type\": {\n \"id\": 15\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19372,\n \"type\": {\n \"id\": 16\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19373,\n \"type\": {\n \"id\": 17\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19374,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19375,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19376,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19377,\n \"type\": {\n \"id\": 19\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19378,\n \"type\": {\n \"id\": 20\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19379,\n \"type\": {\n \"id\": 21\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19380,\n \"type\": {\n \"id\": 22\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n },\n \"ach\": null,\n \"documents\": [],\n \"agent\": {\n \"id\": 14\n },\n \"signature\": {\n \"status\": \"Unsigned\",\n \"via\": null\n },\n \"auto\": {\n \"sign\": \"Yes\",\n \"underwriting\": \"No\"\n },\n \"status\": \"New\",\n \"updatedOn\": \"2023-05-10 11:59:19\",\n \"createdOn\": \"2023-05-10 11:59:19\""}],"_postman_id":"a0efa9af-942a-4931-9810-00e3ea9577cb"}],"id":"a3747021-784c-4d0e-a94f-23538db1304e","description":"

For testing purposes, please use our sandbox endpoint below.

\n","_postman_id":"a3747021-784c-4d0e-a94f-23538db1304e","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Principals","item":[{"name":"List Principals","id":"47b92ae7-c588-47e7-bcf2-8578e2a4895b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/principals","description":"

List all Principals for Boarding Application 608.

Add a second Principal to Boarding Application 608

You can utilize this endpoint to update information on a single principal in the Principals section of the Boarding Application.

Updating the dayOfBirth for Principal with id 741 for Boarding Application 607.

\n
NOTE Only send the parameters that you want to update, there is no need to send a full request with all the parameters for the Principal.
\n

You can utilize this endpoint to mass add, update or delete principal information.

\n
IMPORTANT Only send the parameters that you want to update for a specific principal, there is no need to send a full request with all the parameters for the Principal. However, if you have more than one principal on the Boarding Application you will need to provide all the Principal id's even if there are no changes to them or else those id's that are not provided in the request will be deleted.
\n

Delete Principal with id 741 for Boarding Application 607.

You can use this endpoint to execute all necessary operations in the Principals section of the Boarding Application. You can do the following:

List all Principals
Create an additional Principal
Update Principal informaion
Delete a Principal

\n","_postman_id":"203f9b7e-58d2-43a6-a214-4cc15e41031c","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Processing","item":[{"name":"View Processing section","id":"1c1b9574-39e0-4555-bb05-b9d0e85f883f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/607/processing","description":"

You can use this endpoint to view the necessary information in the Processing section of the Boarding Application.

Viewing only the Processing section of Boarding Application with id 607

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","607","processing"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"d9c8ed2c-c5e7-427a-b361-1667fd449cc9","name":"View Processing section","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/607/processing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"bank\": {\n \"accountNumber\": null,\n \"routingNumber\": null\n },\n \"volumes\": {\n \"monthlyTransactionAmount\": null,\n \"avgTransactionAmount\": null,\n \"maxTransactionAmount\": null\n },\n \"sales\": {\n \"swiped\": null,\n \"mail\": null,\n \"internet\": null\n },\n \"alreadyProcessing\": {\n \"isProcessing\": \"No\",\n \"processor\": null\n },\n \"terminated\": {\n \"isTerminated\": null,\n \"description\": null\n },\n \"customers\": {\n \"type\": {\n \"individual\": null,\n \"business\": null,\n \"government\": null\n },\n \"location\": {\n \"local\": null,\n \"national\": null,\n \"international\": null\n }\n },\n \"fulfillmentPolicy\": {\n \"fulfillment\": null,\n \"fulfillmentOther\": null,\n \"delivery\": null,\n \"deliveryOther\": null\n },\n \"recurringPayments\": {\n \"hasRecurring\": \"No\",\n \"description\": null\n },\n \"intendedUsage\": {\n \"creditCards\": \"No\",\n \"pinDebit\": \"No\",\n \"ebt\": \"No\",\n \"fns\": null,\n \"notes\": null\n },\n \"seasonalBusiness\": {\n \"isSeasonal\": \"No\",\n \"months\": []\n },\n \"inventory\": {\n \"onSite\": \"No\",\n \"offSite\": \"No\",\n \"offSiteAddress\": null,\n \"thirdParty\": \"No\",\n \"serviceOnly\": \"No\"\n },\n \"retailLocation\": null,\n \"externalFulfillment\": \"No\",\n \"customerCharged\": null,\n \"equipmentUsed\": null,\n \"advertise\": null,\n \"refundPolicy\": null,\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": 19357,\n \"type\": {\n \"id\": 1\n },\n \"value\": \"1.00001\"\n },\n {\n \"id\": 19358,\n \"type\": {\n \"id\": 2\n },\n \"value\": \"0.00002\"\n },\n {\n \"id\": 19359,\n \"type\": {\n \"id\": 3\n },\n \"value\": \"0.00003\"\n },\n {\n \"id\": 19360,\n \"type\": {\n \"id\": 4\n },\n \"value\": \"0.00004\"\n },\n {\n \"id\": 19361,\n \"type\": {\n \"id\": 5\n },\n \"value\": \"0.00005\"\n },\n {\n \"id\": 19362,\n \"type\": {\n \"id\": 6\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19363,\n \"type\": {\n \"id\": 7\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19364,\n \"type\": {\n \"id\": 8\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19365,\n \"type\": {\n \"id\": 9\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19366,\n \"type\": {\n \"id\": 10\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19367,\n \"type\": {\n \"id\": 11\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19368,\n \"type\": {\n \"id\": 12\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19369,\n \"type\": {\n \"id\": 13\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19370,\n \"type\": {\n \"id\": 14\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19371,\n \"type\": {\n \"id\": 15\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19372,\n \"type\": {\n \"id\": 16\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19373,\n \"type\": {\n \"id\": 17\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19374,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19375,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19376,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19377,\n \"type\": {\n \"id\": 19\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19378,\n \"type\": {\n \"id\": 20\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19379,\n \"type\": {\n \"id\": 21\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19380,\n \"type\": {\n \"id\": 22\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n}"}],"_postman_id":"1c1b9574-39e0-4555-bb05-b9d0e85f883f"},{"name":"Update Processing section","id":"16a8448b-734d-4615-9713-b8cc723337b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"bank\": {\n \"accountNumber\": \"222222233\",\n \"routingNumber\": \"444444444\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/607/processing","description":"

You can use this endpoint to update the necessary information in the Processing section of the Boarding Application.

Update the bank.accountNumber and bank.routingNumber in the Processing section of Boarding Application with id 607

\n
NOTE You do not need to send the all the parameters in the Processing section. You can send only the parameters that you are updating.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","607","processing"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"309123a0-293a-4e7a-b158-0f4797eac292","name":"Update Processing section","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"bank\": {\n \"accountNumber\": \"222222233\",\n \"routingNumber\": \"444444444\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/607/processing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"bank\": {\n \"accountNumber\": \"222222233\",\n \"routingNumber\": \"444444444\"\n },\n \"volumes\": {\n \"monthlyTransactionAmount\": null,\n \"avgTransactionAmount\": null,\n \"maxTransactionAmount\": null\n },\n \"sales\": {\n \"swiped\": null,\n \"mail\": null,\n \"internet\": null\n },\n \"alreadyProcessing\": {\n \"isProcessing\": \"No\",\n \"processor\": null\n },\n \"terminated\": {\n \"isTerminated\": null,\n \"description\": null\n },\n \"customers\": {\n \"type\": {\n \"individual\": null,\n \"business\": null,\n \"government\": null\n },\n \"location\": {\n \"local\": null,\n \"national\": null,\n \"international\": null\n }\n },\n \"fulfillmentPolicy\": {\n \"fulfillment\": null,\n \"fulfillmentOther\": null,\n \"delivery\": null,\n \"deliveryOther\": null\n },\n \"recurringPayments\": {\n \"hasRecurring\": \"No\",\n \"description\": null\n },\n \"intendedUsage\": {\n \"creditCards\": \"No\",\n \"pinDebit\": \"No\",\n \"ebt\": \"No\",\n \"fns\": null,\n \"notes\": null\n },\n \"seasonalBusiness\": {\n \"isSeasonal\": \"No\",\n \"months\": []\n },\n \"inventory\": {\n \"onSite\": \"No\",\n \"offSite\": \"No\",\n \"offSiteAddress\": null,\n \"thirdParty\": \"No\",\n \"serviceOnly\": \"No\"\n },\n \"retailLocation\": null,\n \"externalFulfillment\": \"No\",\n \"customerCharged\": null,\n \"equipmentUsed\": null,\n \"advertise\": null,\n \"refundPolicy\": null,\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": 19357,\n \"type\": {\n \"id\": 1\n },\n \"value\": \"1.00001\"\n },\n {\n \"id\": 19358,\n \"type\": {\n \"id\": 2\n },\n \"value\": \"0.00002\"\n },\n {\n \"id\": 19359,\n \"type\": {\n \"id\": 3\n },\n \"value\": \"0.00003\"\n },\n {\n \"id\": 19360,\n \"type\": {\n \"id\": 4\n },\n \"value\": \"0.00004\"\n },\n {\n \"id\": 19361,\n \"type\": {\n \"id\": 5\n },\n \"value\": \"0.00005\"\n },\n {\n \"id\": 19362,\n \"type\": {\n \"id\": 6\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19363,\n \"type\": {\n \"id\": 7\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19364,\n \"type\": {\n \"id\": 8\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19365,\n \"type\": {\n \"id\": 9\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19366,\n \"type\": {\n \"id\": 10\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19367,\n \"type\": {\n \"id\": 11\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19368,\n \"type\": {\n \"id\": 12\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19369,\n \"type\": {\n \"id\": 13\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19370,\n \"type\": {\n \"id\": 14\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19371,\n \"type\": {\n \"id\": 15\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19372,\n \"type\": {\n \"id\": 16\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19373,\n \"type\": {\n \"id\": 17\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19374,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19375,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19376,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19377,\n \"type\": {\n \"id\": 19\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19378,\n \"type\": {\n \"id\": 20\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19379,\n \"type\": {\n \"id\": 21\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 19380,\n \"type\": {\n \"id\": 22\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n}"}],"_postman_id":"16a8448b-734d-4615-9713-b8cc723337b2"}],"id":"b85a8b3c-09f5-4beb-aa3d-62dd6592fead","description":"

You can use this endpoint to execute all necessary operations in the Processing section of the Boarding Application. You can do the following:

View all the information in the Processing section
Update information in the Processing section

\n","_postman_id":"b85a8b3c-09f5-4beb-aa3d-62dd6592fead","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"ACH","item":[{"name":"View ACH section","id":"1991824d-f945-40ba-b51e-2a5ce89614f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/609/ach","description":"

You can use this endpoint to view the necessary information in the ACH section of the Boarding Application.

Viewing only the ACH section of Boarding Application with id 609

You can use this endpoint to update the necessary information in the ACH section of the Boarding Application.

Update the bank.accountNumber and bank.routingNumber in the ACH section of Boarding Application with id 609

NOTE You do not need to send all the parameters in the Ach section. You can send only the parameters that you are updating.

You can use this endpoint to execute all necessary operations in the ACH section of the Boarding Application. You can do the following:

View all the information in the ACH section
Update information in the ACH section

\n","_postman_id":"5d8496e2-b6fe-4f60-9688-ac0f8e27f9ac","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Documents","item":[{"name":"Attachment About","item":[{"name":"List All Document Categories","id":"60b92f71-a65b-41cf-89b7-3dd8e255c8e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/attachments/about","description":"

Note: Keep in mind that the about.id differs from our Sandbox and Production environments. Please ensure to use and assign the correct about.id with their corresponding environment.

The Attachment-about endpoint is used for the categorization of all the supporting documents that can be assigned to a Boarding Application. We have a list of several categories that are used to tell us what the document on a Boarding Application contains.

\n
IMPORTANT Always add about.id to your documents when assigning them to a Boarding Application. This will speed up the Underwriting process. We allow more than one about.id to be added to a document when you have more information in it.
\n

Attachment About Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	ID of the about	Integer	No	No	Yes
name	Description of the about	String	No	No	Yes
owner	`true` or `false`	ENUM	No	No	Yes
forMerchant	`true` or `false`	ENUM	No	No	Yes
forStaff	`true` or `false`	ENUM	No	No	Yes

","_postman_id":"48f1227b-e65f-4d90-a328-64a3a6d92fe2","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"View all documents","id":"da7fe2fb-b801-41a9-9701-2f3a1abc7891","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application//documents","description":"

You can utilize this endpoint to list all uploaded documents to a boarding application.

Once a boarding application has been signed, you can utilize this endpoint to download the merchant agreement.

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

Type	Description
ach	The signed ACH merchant agreement pdf
acquiring	The signed Acquiring merchant agreement pdf
certificate	The e-signed certificate pdf
all	This will download all MPA related documents in a zip file

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","","download-signed-document",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"45178bef-50fd-4ebe-8a1d-97279045217a","name":"Download MPA","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/1/download-signed-document/all"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"026a797e-08f6-4063-bab2-6ef9098f58b9"},{"name":"Assign a single document","id":"b40c7269-a20f-4ebc-aa3b-3d154f2682d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"attachment\": {\n \"id\": 1916\n },\n \"about\": [\n 1,\n 2\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/607/document","description":"

In this example, we will add one document and categorize it by adding to it about.id [1,2] for \"Other\" and \"Voided Check\"

\n
NOTE We allow more than one about.id to be set to an attachment when you are uploading a larger document that has more information in it.
\n

In this example, we will add

One document and categorize it by adding to it about.id 2 for \"Voided Check\"
And another document and categorize it by adding to it about.id 6 for \"Driver’s License\" and additionally adding a principal.id so that we can provide additional detail to which principal this driver's license belongs.

\n
IMPORTANT Again it is important to mention that principal.id is needed if the about.owner is true. See our Attachment About endpoint.
\n

In this example, we will update the about.id for document with id1916

In this example, we will delete document with id1916

This endpoint is used for all the supporting documents on a Boarding Application. There are several things to consider with documents on a Boarding Application.

The process begins by utilizing one of our upload methods via the Attachments endpoint.
Each attachment needs to be assigned to a Boarding Application and categorized with about.id. (See Attachment About) Assigning an about.id tells us what the attached document contains.

\n
IMPORTANT It is important to note that the drivers license category with about.id 6 needs an additional principal.id, since more than one principals can exist on a Boarding Application.
\n

\n
NOTE We allow more than one about.id to be set to an attachment when you are uploading a larger document that has more information in it.
\n

Documents Object

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

Fields	Description	Type	Filterable	Required	Readonly
attachment	Object	Object	No	No	Yes
attachment.id	Relation to the ID of the attachment	Integer	No	No	Yes
about	Object	Object	No	No	Yes
about.id	ID of the about	String	No	No	Yes
principal	Object	String	No	No	Yes
principal.id	Principal ID on the Boarding Application	String	No	No	Yes

You can use this endpoint to execute all necessary operations in the Documents section of the Boarding Application. You can do the following:

View all assigned documents to a Boarding Application
Assign documents to a Boarding Application
Update documents to a Boarding Application
Delete documents in a Boarding Application

\n","_postman_id":"0bb775a9-99b5-412a-a86d-851858b09468","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Fees","item":[{"name":"Types","item":[{"name":"List","id":"9ce0cdfe-3af9-4cce-b08c-2585f20a553d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/fees","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","fees"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"18d49a90-87b6-4fbb-afe3-a89931b640cb","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/fees"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Interchange Plus\",\n \"type\": \"percent\",\n \"period\": \"Year\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 2,\n \"name\": \"PIN Debit Rate\",\n \"type\": \"percent\",\n \"period\": \"Transaction\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 3,\n \"name\": \"EBT Rate\",\n \"type\": \"percent\",\n \"period\": \"Month\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 4,\n \"name\": \"Transaction Fee\",\n \"type\": \"amount\",\n \"period\": \"Transaction\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 5,\n \"name\": \"Authorization Fee\",\n \"type\": \"amount\",\n \"period\": \"Year\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 6,\n \"name\": \"AVS\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 7,\n \"name\": \"Voice Authorization\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 8,\n \"name\": \"PIN Debit Authorization Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 9,\n \"name\": \"EBT Authorization Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 10,\n \"name\": \"Monthly Online Access Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 11,\n \"name\": \"Monthly PCI Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 12,\n \"name\": \"Monthly Minimum Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 13,\n \"name\": \"Application Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 14,\n \"name\": \"Annual Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 15,\n \"name\": \"Batch Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 16,\n \"name\": \"Chargeback Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 17,\n \"name\": \"Retrieval Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 18,\n \"name\": \"Other\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 19,\n \"name\": \"Qualified Rate\",\n \"type\": \"percent\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 20,\n \"name\": \"Monthly Fee\",\n \"type\": \"amount\",\n \"period\": \"Month\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 21,\n \"name\": \"Mid-Qual Surcharge (Qual+)\",\n \"type\": \"percent\",\n \"period\": \"Month\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 22,\n \"name\": \"Non-Qual Surcharge (Qual+)\",\n \"type\": \"percent\",\n \"period\": \"Month\",\n \"processingMethod\": \"Acquiring\"\n },\n {\n \"id\": 25,\n \"name\": \"Initial Setup Fee\",\n \"type\": \"amount\",\n \"period\": \"OneTime\",\n \"processingMethod\": \"ACH\"\n },\n {\n \"id\": 26,\n \"name\": \"Per File Fee\",\n \"type\": \"amount\",\n \"period\": \"Transaction\",\n \"processingMethod\": \"ACH\"\n },\n {\n \"id\": 27,\n \"name\": \"FED Unauthorized Return Fee\",\n \"type\": \"amount\",\n \"period\": \"Transaction\",\n \"processingMethod\": \"ACH\"\n },\n {\n \"id\": 28,\n \"name\": \"Rate\",\n \"type\": \"percent\",\n \"period\": \"Month\",\n \"processingMethod\": \"ACH\"\n },\n {\n \"id\": 29,\n \"name\": \"Notification of Change\",\n \"type\": \"amount\",\n \"period\": \"Transaction\",\n \"processingMethod\": \"ACH\"\n },\n {\n \"id\": 30,\n \"name\": \"Per Transaction Fee\",\n \"type\": \"amount\",\n \"period\": \"Transaction\",\n \"processingMethod\": \"ACH\"\n },\n {\n \"id\": 31,\n \"name\": \"Return Item Processing\",\n \"type\": \"amount\",\n \"period\": \"Transaction\",\n \"processingMethod\": \"ACH\"\n },\n {\n \"id\": 32,\n \"name\": \"Monthly Maintenance Fee\",\n \"type\": \"amount\",\n \"period\": \"Month\",\n \"processingMethod\": \"ACH\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/fees?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/fees?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/fees?page=2\"\n },\n \"next\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/fees?page=2\"\n }\n },\n \"_meta\": {\n \"totalCount\": 33,\n \"pageCount\": 2,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"9ce0cdfe-3af9-4cce-b08c-2585f20a553d"}],"id":"c6dd8a68-cd08-44a6-b24e-18a7414bfae1","description":"

Use this endpoint to list all the system fee types with their corresponding detailed information.

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

Fields	Description	Type	Filterable	Required	Readonly
id	ID of the fee	Integer	No	No	Yes
name	Fee name	String	No	No	Yes
type	`percent` or `amount`	ENUM	No	No	Yes
period	`Year`,`Month`, `Week`,`Day`,`OneTime`,`Transaction`	ENUM	No	No	Yes
processingMethod	`Acquiring` or `Ach`	ENUM	No	No	Yes

","_postman_id":"c6dd8a68-cd08-44a6-b24e-18a7414bfae1","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"List all fees","id":"ff750be5-fc26-424f-87c9-916d662de06a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/fees","description":"

Listing all fees for boarding application with id 608

View all the information for fee with id 19445 for boarding application with id 608

Update the value for fee with id 19445 for boarding application with id 608

Update the values for fees with id 19452 and id 19451 for boarding application with id 608

You can use this endpoint to execute all necessary operations in the Fee section of the Boarding Application. You can do the following:

List all the fees in the Fee section
View a single fee in the Fee section
Update a single or multiple fees in the Fee section

Fee Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the fee line item for the specific Boarding Application	Integer	No	Yes	Yes
type	Object	Object	No	No	Yes
type.id	This is a relation to the ID of fee line item Fees	Integer	No	No	Yes
value	The value for the fee line item on the specific Boarding Application	Integer	No	Yes	No

","_postman_id":"74a923dd-00ca-4884-bb32-0888884bc137","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Validate","item":[{"name":"Validate a Boarding Application","id":"00f5e4f1-9fa6-4f77-abbf-21f797b16dc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/386/validate","description":"

Validate Boarding Application with id 386

Use this endpoint to validate your Boarding Application before changing the status to Underwriting.

In doing so you will eliminate status change exception errors and you will make sure there is no missing required information in the Boarding Application.

\n","_postman_id":"198301d4-43fa-498f-80a0-e0b2cb4572dd","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"URL","item":[{"name":"GET URL of Boarding Application","id":"ea53a615-a705-46fd-8b7a-2942ba3da8ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/url","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","608","url"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"1ea126b4-cd74-46c2-b121-0b86e9476bec","name":"GET URL of Boarding Application","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://dashboard.dashboard.paysecureonline.com//dashboard/web/boarding/public/modify?id=608&guest=&token=716baea1-9749-3543-acd7-7dfc3affb40b\"\n}"}],"_postman_id":"ea53a615-a705-46fd-8b7a-2942ba3da8ee"}],"id":"dfdf95bf-ff3d-4b5c-8b02-e3fde6de109b","description":"

You can get the Boarding Application URL to send out for merchant completion via our online web interface form.

Utilizing this endpoint we will return the URL that can be used to fill in all required information.

\n","_postman_id":"dfdf95bf-ff3d-4b5c-8b02-e3fde6de109b","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Signature","item":[{"name":"Request Signature","id":"a5c18208-5f11-4c5f-8180-0d737c771aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/request-signature","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","608","request-signature"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"cdc34587-0b2b-4318-baf9-5a85df63af31","name":"Request Signature","originalRequest":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/request-signature"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"a5c18208-5f11-4c5f-8180-0d737c771aa9"}],"id":"f2c7151b-59be-41e0-bb99-5b7c3a7d9988","description":"

An application needs to be completed with a signature(s) before you can send it to Underwriting for approval and boarding.

There are several ways to achieve signing of the application. Either manually requesting a signature or by using Boarding Application Automation options.

When manually requesting signing we initiate an email to all the principals on the application with a link to our online eSign section.

\n
IMPORTANT Keep in mind that before initiating a signature request the Boarding Application needs to be fully completed with all the required field. You can always use our Validate endpoint for verification.
\n

\n","_postman_id":"f2c7151b-59be-41e0-bb99-5b7c3a7d9988","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Automation","item":[{"name":"AutoSign","item":[{"name":"Set AutoSign","id":"145b7937-f601-4647-bc18-4840d4947e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/auto-sign/Yes","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","608","auto-sign","Yes"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"84c126a1-b567-47e3-b5d4-0cd48e6c2c56","name":"Set AutoSign","originalRequest":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/auto-sign/Yes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"145b7937-f601-4647-bc18-4840d4947e4d"}],"id":"bc6d6f3c-0605-4c44-95f8-402fb925202e","description":"

Enabling this option will trigger the eSign section of the online application after all the required fields from the other sections have been completed.

\n
NOTE If you feel confident that all the information will be filled correctly on a Boarding Application we always encourage you to use this automation as it will speed up the approval process.
\n

\n","_postman_id":"bc6d6f3c-0605-4c44-95f8-402fb925202e","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"AutoUnderwriting","item":[{"name":"Set AutoUnderwriting","id":"308ba2b3-ff8c-4c7c-84b0-90a40b77bae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/auto-underwriting/Yes","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","608","auto-underwriting","Yes"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"b51bd890-7b20-4d4b-a7ae-175195f7c25e","name":"Set AutoUnderwriting","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/auto-underwriting/Yes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"308ba2b3-ff8c-4c7c-84b0-90a40b77bae8"}],"id":"0717bb1d-5423-4452-a9c1-d859e8caffe1","description":"

Enabling this option will trigger the eSign section of the online Boarding Application and after the application is signed its status will automatically change to Underwriting.

\n
NOTE If you feel confident that all the information will be filled correctly on a Boarding Application we always encourage you to use this automation as it will speed up the approval process.
\n

\n","_postman_id":"0717bb1d-5423-4452-a9c1-d859e8caffe1","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}}],"id":"156efa07-e8c0-4965-9921-1855007c8060","description":"

We offer Boarding Application automation to streamline some of the processes where needed. At this point there are two options, AutoSign and AutoUnderwriting.

\n","_postman_id":"156efa07-e8c0-4965-9921-1855007c8060","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Status","item":[{"name":"Set status to Underwriting","id":"501b3aa1-5379-40a9-b263-d7b2817fb751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/status/Underwriting","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","608","status","Underwriting"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"e94d5023-f7e1-40c5-bef0-4fbeeea28866","name":"Set status to Underwriting","originalRequest":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/status/Underwriting"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"501b3aa1-5379-40a9-b263-d7b2817fb751"}],"id":"610cb2dc-d8d0-48fb-ac66-68db03b9b1b0","description":"

In order to initiate the approval process of a Boarding Application its status needs to be changed to Underwriting.

This can be achieved either using the Automation options or by manually changing the status of the application.

\n","_postman_id":"610cb2dc-d8d0-48fb-ac66-68db03b9b1b0","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}},{"name":"Notes","item":[{"name":"List","id":"cb0917a5-c748-4c14-9616-6568eb5792d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/notes","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}},"urlObject":{"path":["api","boarding-application","608","notes"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"efc7cac5-b4b0-46e5-912e-a983fa21232e","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/notes"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 740,\n \"note\": \"Duplicate: Duplicate information found on this application.\",\n \"user\": false,\n \"notification\": \"No\",\n \"updatedOn\": \"2023-05-11 15:50:02\",\n \"createdOn\": \"2023-05-11 15:50:02\"\n },\n {\n \"id\": 63,\n \"note\": \"A Funding Period for TwoBusinessDays has been requested.
\\n
\\nA Discount Period for Daily has been requested.\",\n \"user\": false,\n \"notification\": \"Yes\",\n \"updatedOn\": \"2020-02-19 15:27:56\",\n \"createdOn\": \"2020-02-19 15:27:56\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/136/notes?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/136/notes?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/136/notes?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"cb0917a5-c748-4c14-9616-6568eb5792d9"},{"name":"Create","id":"2815a0c3-a2f1-4c64-88de-de4ec4f519da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"note\": \"I will send the needed information ASAP\",\n \"notification\": \"Yes\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/boarding-application/608/note","description":"

Create a note for Boarding Application with id 608 and send a notification to the appropriate department

By utilizing this endpoint you can read all notes associated with the Boarding Application. During the underwriting process, additional information may be requested and this is the endpoint to read all the notes from our Underwriting team.

Notes Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the Boarding Application Note	Integer	Yes	No	Yes
note	Content of the note	String	No	Yes	No
user	The user who create the note	String	No	No	Yes
notification	Notification for the added note `Yes` `No`	ENUM	No	Yes	No
updatedOn	Date and Time of last update on the application note	Datetime	Yes	No	Yes
createdOn	Date and Time when the application note was created	Datetime	Yes	No	Yes

You can do the following:

List all notes for a specific Boarding Application
Create a note for a specific Boarding Application

\n","_postman_id":"b3819e21-c75c-4aa0-ad8d-254043181794","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"f160ec72-b784-44ef-9188-587a16e22d30","id":"f160ec72-b784-44ef-9188-587a16e22d30","name":"Boarding Applications","type":"folder"}}}],"id":"f160ec72-b784-44ef-9188-587a16e22d30","description":"

This endpoint provides an interface for working with Boarding Applications. Each application belongs to a pre-created campaign. A campaign controls several aspects of a Boarding Application, such as pricing fees, the type of processing and several other parameters.

The overall boarding process is as follows:

Create a Boarding Application and get the Boarding Application id
Update the Boarding Application data using the id
- Update Principal using the principals.id
- Add Principals or Mass Update/Insert Principals if needed
- Update the Processing/ACH section
- Upload necessary documents and assign them to the Boarding Application
- Update Fee where necessary
\n
Request eSign or use AutoSign functionality to get needed signatures from principals.
Update application status to Underwriting or use AutoUnderwriting functionality
Check application status for changes.

\n
Keep in mind that after creating an application you can get the url and send it for merchant completion. The link will initiate a web interface which allows the Boarding Application to be completed by the merchant online.
\n

Application Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the Boarding Application	Integer	Yes	No	Yes
processingMethod	`Acquiring`, `ACH`, `All`	ENUM	Yes	Yes	Yes
campaign	Object	Object	No	Yes	Yes
campaign.id	Unique ID of the Campaign to which the Boarding Application is assigned	Integer	Yes	Yes	Yes
company	Object	Object	No	Yes	Yes
company.name	Corporate / Legal Name	String	Yes	Yes	No
company.type	`Individual`, `Partnership`, `Corporation`, `Government`, `LLC`, `Non-Profit`, `Publicly-Traded`	ENUM	No	Yes	No
company.federalTaxId	Federal Tax ID/EIN	Integer	No	Yes	No
company.address	Object	Object	No	Yes	No
company.address.street	Street address	String	No	Yes	No
company.address.city	City	String	No	Yes	No
company.address.zip	Zip code	String	No	Yes	No
company.address.state	Object	Object	No	Yes	No
company.address.state.id	State ID	Integer	No	Yes	No
company.address.country	Object	Object	No	Yes	No
company.address.country.id	Country ID	Integer	No	Yes	No
company.founded	The date when the business was founded	Date	No	Yes	No
dba	Object	Object	No	Yes	No
dba.sameAsCompany	Set as `Yes` if DBA information is the same as legal/corporate else `No`	ENUM	No	Yes	No
dba.name	DBA Name	String	Yes	Conditional	No
dba.address	Object	Object	No	Conditional	No
dba.address.street	Street address	String	No	Conditional	No
dba.address.city	City	String	No	Conditional	No
dba.address.zip	Zip code	String	No	Conditional	No
dba.address.state	Object	Object	No	Conditional	No
dba.address.state.id	State ID	Integer	No	Conditional	No
dba.address.country	Object	Object	No	Conditional	No
dba.address.country.id	Country ID	Integer	No	Conditional	No
website	Business website	String	No	No	No
serviceDescription	Describe your products and services	String	No	Yes	No
mailingAddress	`dba`, `legal` (Preference where to receive mail)	ENUM	No	Yes	No
businessLocation	Object	Object	No	Yes	No
businessLocation.buildingType	`Shopping Center`, `Office Building`, `Industrial Building`, `Residence`	ENUM	No	Yes	No
businessLocation.numberOfLocations	Number of business locations	Integer	No	No	No
businessLocation.buildingOwnership	`Owns`, `Rents`	ENUM	No	Yes	No
businessLocation.areaZoned	`Commercial`, `Industrial`, `Residential`	ENUM	No	Yes	No
businessLocation.squareFootage	`0-501`,`501-2500`,`2501-5000`,`5000-10000`,`10000+`	ENUM	No	Yes	No
customerServiceContact	Object	Object	No	No	No
customerServiceContact.phone	Customer service phone number	String	No	Yes	No
customerServiceContact.email	Customer service email	String	No	No	No
corporateContact	Object	Object	No	No	No
corporateContact.phone	Corporate phone number	String	No	No	No
corporateContact.fax	Corporate fax number	String	No	No	No
corporateContact.email	Corporate email	String	No	No	No
bankruptcy	Object	Object	No	Yes	No
bankruptcy.hasBankruptcy	`Business Bankruptcy`, `Personal Bankruptcy`, `Never`	ENUM	No	Yes	No
bankruptcy.description	If applicable, explain bankruptcy reason	String	No	Conditional	No
principals	Array of Objects	Object	No	Yes	No
principals.id	Unique ID of principal	Integer	Yes	No	Yes
principals.title	`CEO`, `CFO`, `Chairman`, `Co-owner`, `Controller`, `Director`, `General Manager`, `Office Manager`, `Owner`, `Partner`, `President`, `Treasurer`, `Vice President`	ENUM	No	Yes	No
principals.name	Object	Object	No	Yes	No
principals.name.first	First name	String	No	Yes	No
principals.name.last	Last name	String	No	Yes	No
principals.dayOfBirth	Date of Birth	Date	No	No	No
principals.ssn	Social Security Number	String	No	Yes	No
principals.driverLicense	Object	Object	No	Yes	No
principals.driverLicense.number	Driver's License Number	String	No	Yes	No
principals.driverLicense.expiration	Driver's License Expiration Date	Date	No	Yes	No
principals.driverLicense.state	Object	Object	No	Yes	No
principals.driverLicense.state.id	The ID of the Driver's License State	Integer	No	Yes	No
principals.address	Object	Object	No	Yes	No
principals.address.street	Street address	String	No	Yes	No
principals.address.city	City	String	No	Yes	No
principals.address.zip	Zip code	String	No	Yes	No
principals.address.state	Object	Object	No	Yes	No
principals.address.state.id	State ID	String	No	Yes	No
principals.address.country	Object	Object	No	Yes	No
principals.address.country.id	Country ID	String	No	Yes	No
principals.phone	Object	Object	No	Yes	No
principals.email	Country ID	String	No	Yes	No
principals.ownershipPercentage	Percentage of ownership	Integer	No	Yes	No
principals.isManagement	`Yes`, `No` (If this is the individual you want to list as management)	ENUM	No	Yes	No
processing	Object	Object	No	Yes	No
processing.bank	Object (Business bank account information where funds are to be deposited)	Object	No	Yes	No
processing.bank.accountNumber	Bank Account Number	Integer	No	Yes	No
processing.bank.routingNumber	Bank Routing Number	Integer	No	Yes	No
processing.volumes	Object	Object	No	Yes	No
processing.volumes.monthlyTransactionAmount	Monthly Volume	Integer	No	Yes	No
processing.volumes.avgTransactionAmount	Average Transaction Amount	Integer	No	Yes	No
processing.volumes.maxTransactionAmount	Max Transaction Amount	Integer	No	Yes	No
processing.sales	Object	Object	No	Yes	No
processing.sales.swiped	Percentage of card-present transactions	Integer	No	Yes	No
processing.sales.mail	Percentage of mail/phone card not present transactions	Integer	No	Yes	No
processing.sales.internet	Percentage of internet/eCommerce card not present transactions	Integer	No	Yes	No
processing.alreadyProcessing	Object	String	No	Yes	No
processing.alreadyProcessing.isProcessing	`Yes`, `No` (If this business currently accept credit/debit cards)	ENUM	No	Yes	No
processing.alreadyProcessing.processor	If applicable who is the current processor	String	No	Conditional	No
processing.terminated	Object	Object	No	Yes	No
processing.terminated.isTerminated	`Yes`, `No` (If business or any principal has ever been terminated from accepting bank cards)	ENUM	No	Yes	No
processing.terminated.description	If applicable Explain Terminated Reason	String	No	Conditional	No
processing.customers	Object	Object	No	Conditional	No
processing.customers.type	Object	Object	No	Conditional	No
processing.customers.type.individual	Percentage of sales to individual customers	Integer	No	Conditional	No
processing.customers.type.business	Percentage of sales to business customers	Integer	No	Conditional	No
processing.customers.type.government	Percentage of sales to government customers	Integer	No	Conditional	No
processing.customers.location	Object	Object	No	Conditional	No
processing.customers.location.local	Percentage of local sales	Integer	No	Conditional	No
processing.customers.location.national	Percentage of national sales	Integer	No	Conditional	No
processing.customers.location.international	Percentage of international sales	Integer	No	Conditional	No
processing.fulfillmentPolicy	Object	Object	No	Conditional	No
processing.fulfillmentPolicy.fulfillment	`24-hours`,`2-days`,`3-10-days`,`11-30-days`,`31-90-days`,`90-plus-days`,`other`	ENUM	No	Conditional	No
processing.fulfillmentPolicy.fulfillmentOther	If your fulfillment policy is not listed above explain it briefly here	String	No	Conditional	No
processing.fulfillmentPolicy.delivery	`24-hours`, `2-5-days`, `6-10-days`, `11-plus-days`, `other`	ENUM	No	Conditional	No
processing.fulfillmentPolicy.deliveryOther	If your delivery policy is not listed above explain it briefly here	String	No	Conditional	No
processing.recurringPayments	Object	Object	Yes	Conditional	No
processing.recurringPayments.hasRecurring	`Yes`, `No`	ENUM	Yes	Conditional	Yes
processing.recurringPayments.description	Explain if offered any subscriptions, memberships, recurring plans etc.	String	No	Conditional	No
processing.intendedUsage	Object (Which payments would you like to accept?)	String	No	Yes	No
processing.intendedUsage.creditCards	`Yes`, `No`	ENUM	No	Yes	No
processing.intendedUsage.pinDebit	`Yes`, `No`	ENUM	No	Yes	No
processing.intendedUsage.ebt	`Yes`, `No`	ENUM	No	Yes	No
processing.intendedUsage.fns	EBT - EBT FNS Number	String	No	Conditional	No
processing.intendedUsage.notes	Intended usage notes	String	No	No	No
processing.seasonalBusiness	Object	Object	No	No	No
processing.seasonalBusiness.isSeasonal	`Yes`, `No` (Is business seasonal?)	ENUM	No	No	No
processing.seasonalBusiness.months	`Jan`, `Feb`,`Mar`,`Apr`,`May`,`Jun`,`Jul`,`Aug`,`Sep`,`Oct`,`Nov`,`Dec`	ENUM	No	No	No
processing.inventory	Object (Where is inventory maintained)	Object	No	No	No
processing.inventory.onSite	`Yes`, `No` (Inventory maintained On-Site)	ENUM	No	Yes	No
processing.inventory.offSite	`Yes`, `No` (Inventory maintained Off-Site, Warehouse)	ENUM	No	Yes	No
processing.inventory.offSiteAddress	If inventory is maintained off-site provide the address	String	No	Conditional	No
processing.inventory.thirdParty	`Yes`, `No` (If you are using 3rd Party Fulfillment Center)	ENUM	No	Yes	No
processing.inventory.serviceOnly	`Yes`, `No` (Service only business, no product sold)	ENUM	No	Yes	No
processing.retailLocation	Confirm Physical Address of retail location	String	No	Conditional	No
processing.externalFulfillment	`Yes`, `No` (If there are any other external companies involved in fulfillment)	String	No	No	No
processing.customerCharged	`time-offer-order`, `upon-shipment` (When is the customer charged)	String	No	No	No
processing.equipmentUsed	List equipment and/or software used to process cards (point-of-sale, terminal, payment gateway, etc.)	String	No	Yes	No
processing.advertise	How do you advertise (internet, magazines, tv, etc.)	String	No	Conditional	No
processing.refundPolicy	Describe your refund and return policy	String	No	Yes	No
ach	Object	String	No	Yes	No
ach.bank	Object (Business bank account information where funds are to be deposited)	Object	No	Yes	No
ach.bank.accountNumber	Bank Account Number	Integer	No	Yes	No
ach.bank.routingNumber	Bank Routing Number	Integer	No	Yes	No
ach.volumes	Object	Object	No	Yes	No
ach.volumes.monthlyTransactions	Number Of Monthly Transactions	Integer	No	Yes	Yes
ach.volumes.monthlyTransactionAmount	Monthly Volume	Integer	No	Yes	No
ach.volumes.avgTransactionAmount	Average Transaction Amount	Integer	No	Yes	No
ach.volumes.maxTransactionAmount	Max Transaction Amount	Integer	No	Yes	No
ach.alreadyProcessing	Object	String	No	Yes	No
ach.alreadyProcessing.isProcessing	`Yes`, `No` (If this business currently processes ACH payments)	ENUM	No	Yes	No
ach.alreadyProcessing.isProcessing.processor	If applicable who is the current processor	String	No	Conditional	No
ach.terminated	Object	Object	No	Yes	No
ach.terminated.isTerminated	`Yes`, `No` (If business or any principal has ever been terminated from accepting bank cards)	ENUM	No	Yes	No
ach.terminated.description	If applicable Explain Terminated Reason	String	No	Conditional	No
ach.customers	Object	Object	No	Conditional	No
ach.customers.type	Object	Object	No	Conditional	No
ach.customers.type.individual	Percentage of sales to individual customers	Integer	No	Conditional	No
ach.customers.type.business	Percentage of sales to business customers	Integer	No	Conditional	No
ach.customers.type.government	Percentage of sales to government customers	Integer	No	Conditional	No
ach.customers.location	Object	Object	No	Conditional	No
ach.customers.location.local	Percentage of local sales	Integer	No	Conditional	No
ach.customers.location.national	Percentage of national sales	Integer	No	Conditional	No
ach.customers.location.international	Percentage of international sales	Integer	No	Conditional	No
ach.fulfillmentPolicy	Object	Object	No	Conditional	No
ach.fulfillmentPolicy.delivery	`24-hours`,`2-5-days`,`6-10-days`,`11-plus-days`,`other`	ENUM	No	Conditional	No
ach.fulfillmentPolicy.deliveryOther	If your fulfillment policy is not listed above explain it briefly here	String	No	Conditional	No
ach.recurringPayments	Object	Object	Yes	Conditional	No
ach.recurringPayments.hasRecurring	`Yes`, `No` (Do you charge any sort of recurring fees for ongoing)	ENUM	Yes	Conditional	Yes
ach.recurringPayments.description	Explain if offered any subscriptions, memberships, recurring plans/fees etc.	String	No	Conditional	No
ach.issueCredits	Object	Object	Yes	Conditional	No
ach.issueCredits.hasissueCredit	`Yes`, `No` (Will you need to issue credits)	ENUM	Yes	Conditional	Yes
ach.issueCredits.description	Provide details if you need to issue credits	String	No	Conditional	No
ach.secCodes	Object	Object	Yes	Conditional	No
ach.secCodes.ccd	Percentage of CCD ACH transactions	Integer	No	Yes	No
ach.secCodes.ppd	Percentage of PPD ACH transactions	Integer	No	Yes	No
ach.secCodes.tel	Percentage of TEL ACH transactions	Integer	No	Yes	No
ach.secCodes.web	Percentage of WEB ACH transactions	Integer	No	Yes	No
ach.customerCharged	`time-offer-order`, `upon-shipment` (When is the customer charged)	ENUM	No	No	No
ach.refundPolicy	Describe your refund and return policy	String	No	Yes	No
documents	Array of attachment ID's	Array	No	Yes	No
agent	Object	String	No	Yes	No
agent.id	Unique id of the agent to whom the Boarding Application is assigned	Integer	Yes	Yes	Yes
signature	Object	Object	No	Yes	No
signature.status	`Unsigned`, `Partially Signed`, `Signed`, `Rejected`	ENUM	Yes	No	Yes
signature.via	`eSign`, `DocuSign`, `PrintedPDF` (How was the application signed)	ENUM	No	No	Yes
status	`New`, `Pending`, `Underwriting`, `Approved`, `Declined`, `Cancelled`	ENUM	Yes	Yes	No
updatedOn	Date and Time of last update on the Boarding Application	Datetime	Yes	No	Yes
createdOn	Date and Time when the Boarding Application was created	Datetime	Yes	No	Yes

We offer a secure, streamlined ACH payment processing system. This endpoint enables you to make secure bank-to-bank transfers. We offer one-time and recurring ACH payments for various payment scenarios including corporate, consumer, telephone, and web payments.

ACH Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the ACH record	Integer	Yes	No	Yes
amount	Amount of the transaction including tax	Number	No	Yes	No
tax	The tax included in the amount in absolute value	Number	No	No	No
checkNumber	Check Number	String	Yes	No	No
routingNumber	Routing Number	String	Yes	Yes	No
accountName	Name of the account	String	No	Yes	No
accountNumber	Access Number	String	Yes	Yes	No
accountType	`Checking` or `Savings`	ENUM	No	Yes	No
traceNumber	Trace Number	String	Yes	No	Yes
transactionID	Transaction ID	Integer	Yes	No	Yes
SECCode	`PPD`, `CCD`, `WEB` or `TEL`	ENUM	No	Yes	No
transactionType	`Debit` or `Credit`	ENUM	Yes	Yes	No
transactionDate	The desired date to submit the transaction. If itâ€™s empty, it takes the current date but never before.	Date	No	No	No
transactionStatus	Status of the transaction	ENUM	Yes	No	Yes
memo	Short note on your check	String	No	No	No
addendaText	Additional information for the transaction, to appear on the statement based on the banking institution.	String	No	No	No
file	File	Object	No	No	Yes
file.id	Origination File ID	Integer	Yes	No	Yes
file.date	Origination File Date	Datetime	Yes	No	Yes
dba	Doing Business As	Object	No	Yes	No
dba.id	ID of your DBA	Integer	Yes	Yes	No
dba.name	Name of the DBA	String	No	No	Yes
customer	Customer Details	Object	Yes	Yes	No
customer.id	Unique ID of the customer	String	Yes	No	No
customer.firstName	First name of the customer	String	No	No	No
customer.lastName	Last name of the customer	String	No	No	No
customer.phone	Phone number of the customer	String	No	No	No
customer.email	Email address of the customer	String	No	Yes	No
customer.address1	Address of the customer line 1	String	No	No	No
customer.address2	Address of the customer line 2	String	No	No	No
customer.city	City of the customer	String	No	No	No
customer.state	State of the customer. Example: NY, CA, etc...	String	No	No	No
customer.zipCode	Zip Code of the customer	String	No	No	No
customer.identifier	External Unique ID on a merchants platform	String	No	No	No
customer.sendReceipt	Send receipt to the customer. `Yes` or `No` default `No`	String	No	No	No
customer.save	Save customer info for further use. `Yes` or `No`	String	No	No	No
recurring	Recurring Payment object concerned only for `recurring.id`. Everything else `recurring.\\*` is with the initializing transaction.	Object	No	No	No
recurring.id	The ID of the parent recurring transaction	Integer	Yes	No	No
recurring.init	Determine if this is a recurring transaction - `Yes` or `No`	String	Yes	No	No
recurring.every	Billing Every	Integer	No	No	No
recurring.frequency	Billing Frequency	ENUM	No	No	No
recurring.beginDate	Begin Date	Date	No	No	No
recurring.endAfter	Define the number of transactions after which recurring needs to end. If 0 will be unlimited.	Integer	No	No	No
recurring.status	The recurring transaction status: `Active`, `Cancelled` or `Completed`	String	Yes	No	Yes
verification	Verification Data	Object	No	No	Yes
verification.status	Verification Status	ENUM	Yes	No	Yes
verification.date	Datetime of last update	Datetime	No	No	Yes
source	Source	ENUM	No	No	Yes
return	Return Data	Object	No	No	Yes
return.code	Return Code	String	No	No	Yes
return.date	Return Date	Date	No	No	Yes
createdOn	Datetime of creation	Datetime	Yes	No	Yes
updatedOn	Datetime of last update	Datetime	Yes	No	Yes

","_postman_id":"5d8202cb-b592-4b53-81c5-81fa73520110","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"Transactions","item":[{"name":"SEC Codes","item":[],"id":"e6c65389-3b97-4eb3-87d7-5c0372fa0865","description":"

You need to provide the SEC Code when creating an ACH transaction.

Here is a list of SEC codes we support.

\n
IMPORTANT Note that some SEC codes do not allow addendaText
\n

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

Code	Debit	Credit	Addenda Text
`PPD`	Yes	Yes	Allowed
`CCD`	Yes	Yes	Allowed
`WEB`	Yes	No	Not Allowed
`TEL`	Yes	No	Not Allowed

","_postman_id":"e6c65389-3b97-4eb3-87d7-5c0372fa0865","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"Statuses","item":[],"id":"c0adbc38-fda5-440e-b431-3cde9b83294d","description":"

When you have successfully created an ACH Transaction, it will be given one of the following statuses, depending on the case.

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

Status	Description
Voided	The item was voided upon entry for various administrative purposes. This is very rare, and typically warrants an interactive login or call to support
Held	The item was accepted but placed on hold. This can be common and typically occurs if your daily processing limits have been exceeded. A held item is typically held for a reason and can only be released by us.
Pending	This is the \"so far so good\" status which means your item will be processed soon.
Submitted	A variant of Pending, consider Pending and Submitted to be identical. This is the most common status you will see.

Once your item has been accepted (status = Pending or Submitted) there are a few more statuses that get applied to it:

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

Status	Description
Transmitted	This occurs when the item has been sent out to the ACH network. The most significant thing to know about this status is that your item can no longer be edited or VOIDED.
Settled	For DEBIT items, this means that the debited funds have been successfully settled in your account. For CREDIT items, this means that the pre-funding requirements for your credit have been met and the credit is \"all good.\"
Returned	This status occurs when an item has been returned for one of many different reasons.

\n
Settled and Returned are both considered \"rested\" statuses. Once a transaction enters into one of those two statuses, it never leaves it.
\n

Verification Statuses

We have internal advanced prescreen ACH payment tools and based on your account settings some transaction types will require verification. We use these to reduce the risk of fraud and returns. This service will process a submitted Routing and Account Number against our database containing positive and negative ACH/check writing history. It will validate the account is open and in good standing while also returning information about critical accounts and transactions.

In most cases, you will see your verification.status in Pending, meaning no additional verification was required, and if needed we can perform a manual check for a specific ACH transaction record.

\n
IMPORTANT If your account is setup with mandatory validation and your ACH transactions do not pass our validation tool we will not process them.
\n

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

Status	Description
Pending	The transaction awaits verification.
APIError	There has been a problem with the verification API. If this occurs please contact us to investigate the problem.
Fail	The transaction has failed our verification processes.
Pass	The transaction has passed our verification processes.

Sources

Every ACH transaction record in our dashboard has a source. These are the current sources:

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

Source	Description
Dashboard	The transaction is initialized by the dashboard interface.
Imported	The transaction is initialized by the import CSV file.
Hosted	The transaction is initialized by the hosted form.
API	The transaction is initialized by the current ACH API.

","_postman_id":"c0adbc38-fda5-440e-b431-3cde9b83294d","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"Actions","item":[{"name":"Action","id":"e2ceb0b6-3bd8-4993-950d-78d53a975a02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach//","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"05e9cd92-04cf-4d4c-beea-44525c354bbe","name":"Void","originalRequest":{"method":"POST","header":[],"url":"https://dashboard.example.com/api/ach/334/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[true]"}],"_postman_id":"e2ceb0b6-3bd8-4993-950d-78d53a975a02"}],"id":"d37cbee7-1dfc-4cdf-83c2-71c3bf044276","description":"

Actions give you the possibility to update your ACH records in specific statuses.

The available actions are as follows

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

Action	Description
void	This is used to void a transaction. This action will change the status of a transaction to voided. Keep in mind that void can't be used before a transaction is submitted for processing.
cancel	This is used to change a recurring transaction record to a \"canceled\" status.
verify	This is used to pre-verify a transaction before you submit it. We use several different algorithms for this verification process.

\n
IMPORTANT You can void a transaction only in these statuses:
\n

Held
Pending
Submitted

\n","_postman_id":"d37cbee7-1dfc-4cdf-83c2-71c3bf044276","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"History Log","item":[{"name":"Log","id":"7650b51f-1383-4973-8246-dab1842b2885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach//log","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","","log"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"95a7690d-0b10-4395-9d5c-1ac23cc0833f","name":"Log","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/335/log"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"date\": \"2023-04-13 08:48:24\",\n \"description\": \"Transaction Settled\"\n },\n {\n \"date\": \"2023-04-12 21:07:35\",\n \"description\": \"Transaction sent to origination File ID: 22287\"\n },\n {\n \"date\": \"2023-04-12 21:05:53\",\n \"description\": \"Transaction released from submitted\"\n },\n {\n \"date\": \"2023-04-12 21:04:11\",\n \"description\": \"Transaction released to PENDING from SUBMITTED\"\n },\n {\n \"date\": \"2023-04-12 21:04:07\",\n \"description\": \"Transaction Created via Requester Service, SUBMITTED\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/3669937/log?page=1\"\n },\n \"first\": {\n \"href\": \"\"https://dashboard.dashboard.paysecureonline.com/api/ach/3669937/log?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/3669937/log?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 15,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"7650b51f-1383-4973-8246-dab1842b2885"}],"id":"154882b6-5929-4eb8-b94f-e933b174f6e1","description":"

Utilizing this endpoint you can see the full history log of an ACH transaction record.

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

Fields	Description	Type	Filterable	Required	Readonly
date	Date and time of the log	Datetime	Yes	No	Yes
description	Description of the log	String	No	No	Yes

","_postman_id":"154882b6-5929-4eb8-b94f-e933b174f6e1","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"List","id":"7982a944-f5c5-48da-a141-63848fcdc70d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach","description":"

Use this endpoint to list all ACH transactions in your dashboard.

View specific ACH transaction records.

In the example we are viewing transaction with id 325

Use this endpoint to create ACH Transactions.

ACH Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the ACH record	Integer	Yes	No	Yes
amount	Amount of the transaction including tax	Number	No	Yes	No
tax	The tax included in the amount in absolute value	Number	No	No	No
checkNumber	Check Number	String	Yes	No	No
routingNumber	Routing Number	String	Yes	Yes	No
accountName	Name of the account	String	No	Yes	No
accountNumber	Access Number	String	Yes	Yes	No
accountType	`Checking` or `Savings`	ENUM	No	Yes	No
traceNumber	Trace Number	String	Yes	No	Yes
transactionID	Transaction ID	Integer	Yes	No	Yes
SECCode	`PPD`, `CCD`, `WEB` or `TEL`	ENUM	No	Yes	No
transactionType	`Debit` or `Credit`	ENUM	Yes	Yes	No
transactionDate	The desired date to submit the transaction. If itâ€™s empty, it takes the current date but never before.	Date	No	No	No
transactionStatus	Status of the transaction	ENUM	Yes	No	Yes
memo	Short note on your check	String	No	No	No
addendaText	Additional information for the transaction, to appear on the statement based on the banking institution.	String	No	No	No
file	File	Object	No	No	Yes
file.id	Origination File ID	Integer	Yes	No	Yes
file.date	Origination File Date	Datetime	Yes	No	Yes
dba	Doing Business As	Object	No	Yes	No
dba.id	ID of your DBA	Integer	Yes	Yes	No
dba.name	Name of the DBA	String	No	No	Yes
customer	Customer Details	Object	Yes	Yes	No
customer.id	Unique ID of the customer	String	Yes	No	No
customer.firstName	First name of the customer (32-character limit)	String	No	No	No
customer.lastName	Last name of the customer (32-character limit)	String	No	No	No
customer.phone	Phone number of the customer	String	No	No	No
customer.email	Email address of the customer	String	No	Yes	No
customer.address1	Address of the customer line 1	String	No	No	No
customer.address2	Address of the customer line 2	String	No	No	No
customer.city	City of the customer	String	No	No	No
customer.state	State of the customer. Example: NY, CA, etc...	String	No	No	No
customer.zipCode	Zip Code of the customer	String	No	No	No
customer.identifier	External Unique ID on a merchants platform	String	No	No	No
customer.sendReceipt	Send receipt to the customer. `Yes` or `No` default `No`	String	No	No	No
customer.save	Save customer info for further use. `Yes` or `No`	String	No	No	No
recurring	Recurring Payment object concerned only for `recurring.id`. Everything else `recurring.\\\\\\*` is with the initializing transaction.	Object	No	No	No
recurring.id	The ID of the parent recurring transaction	Integer	Yes	No	No
recurring.init	Determine if this is a recurring transaction - `Yes` or `No`	String	Yes	No	No
recurring.every	Billing Every	Integer	No	No	No
recurring.frequency	Billing Frequency	ENUM	No	No	No
recurring.beginDate	Begin Date	Date	No	No	No
recurring.endAfter	Define the number of transactions after which recurring needs to end. If 0 will be unlimited.	Integer	No	No	No
recurring.status	The recurring transaction status: `Active`, `Cancelled` or `Completed`	String	Yes	No	Yes
verification	Verification Data	Object	No	No	Yes
verification.status	Verification Status	ENUM	Yes	No	Yes
verification.date	Datetime of last update	Datetime	No	No	Yes
source	Source	ENUM	No	No	Yes
return	Return Data	Object	No	No	Yes
return.code	Return Code	String	No	No	Yes
return.date	Return Date	Date	No	No	Yes
createdOn	Datetime of creation	Datetime	Yes	No	Yes
updatedOn	Datetime of last update	Datetime	Yes	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"739c6cc9-df28-4202-9e6c-2b515c8db230","name":"Create ACH","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 55.95,\n \"tax\": 5.95,\n \"routingNumber\": \"123123123\",\n \"accountName\": \"John Wick\",\n \"accountNumber\": \"1122334455\",\n \"accountType\": \"Checking\",\n \"transactionType\": \"Debit\",\n \"customer\": {\n \"email\": \"test@test.com\"\n },\n \"dba\": {\n \"id\": \"9\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"327\"\n}"}],"_postman_id":"35822d57-e8ef-49ae-b39c-b66fedf48b87"},{"name":"Create ACH & Save Customer","id":"a651cbc6-9327-4ccb-9b05-3a3a90ba96f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 9.99,\n \"tax\": 1.99,\n \"SECCode\": \"PPD\",\n \"routingNumber\": \"123456789\",\n \"accountName\": \"Jack Wick's Account\",\n \"accountNumber\": \"1234567890\",\n \"accountType\": \"Checking\",\n \"transactionType\": \"Debit\",\n \"customer\": {\n \"save\": \"Yes\",\n \"firstName\": \"Jack\",\n \"lastName\": \"Wick\",\n \"phone\": \"818-727-1234\",\n \"address1\": \"9024 Some Ave\",\n \"address2\": \"\",\n \"city\": \"LA\",\n \"state\": \"CA\",\n \"zipCode\": \"90069\",\n \"email\": \"john.wick@example.com\"\n },\n \"dba\": {\n \"id\": \"9\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach","description":"

When creating a new ACH transaction record you have the ability to save the customer and payment information to your ACH Customers for future payments. In order to do this you need to pass the customer.save as Yes.

\n
IMPORTANT When you want to save a customer from an initial transaction the customer object fields become required.
\n

Creating an ACH transaction for dba.id 9 and customer.id 42

A transaction can be deleted if there is no status set to it from our system.

Once a transaction gets into these statuses Pending, Submitted or Held you can only perform a VOID action request.

\n
IMPORTANT If the transaction is in these statuses:
Transmitted, Settled or Returned you cannot perform any actions to it.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"bcae7da7-81a8-44a4-8b00-1f592218c82c","name":"Delete","originalRequest":{"method":"DELETE","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/332"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"null "}],"_postman_id":"2ac9be4d-91b6-4603-8867-2dbd936d02c0"}],"id":"620aeb26-c2af-4a3e-a292-688e1f58f841","_postman_id":"620aeb26-c2af-4a3e-a292-688e1f58f841","description":"","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"Customers","item":[{"name":"List Customers","id":"33b7f27d-f328-4528-8f6e-fafec0018600","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","customer"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"ba6dd874-746a-40f0-847a-6dad19f739da","name":"List Customers","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 45,\n \"firstName\": \"John\",\n \"lastName\": \"Wick\",\n \"phone\": \"+1 818-727-1234\",\n \"email\": \"john.wick@example.com\",\n \"address1\": \"9024 Some Ave\",\n \"address2\": null,\n \"city\": \"LA\",\n \"state\": \"CA\",\n \"zipCode\": \"90069\",\n \"accountName\": \"John Wick\",\n \"accountNumber\": \"******7890\",\n \"accountType\": \"Checking\",\n \"routingNumber\": \"123456789\",\n \"identifier\": null,\n \"dba\": {\n \"id\": 22\n }\n },\n {\n \"id\": 44,\n \"firstName\": \"Jack\",\n \"lastName\": \"Wick\",\n \"phone\": \"+1 818-727-1234\",\n \"email\": \"john.wick@example.com\",\n \"address1\": \"9024 Thrasher Ave\",\n \"address2\": null,\n \"city\": \"LA\",\n \"state\": \"CA\",\n \"zipCode\": \"90069\",\n \"accountName\": \"Jack Wick's Account\",\n \"accountNumber\": \"******7890\",\n \"accountType\": \"Checking\",\n \"routingNumber\": \"123456789\",\n \"identifier\": null,\n \"dba\": {\n \"id\": 9\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/customer?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/customer?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/customer?page=1\"\n },\n \"next\": {\n \"href\": https://dashboard.dashboard.paysecureonline.com/api/ach/customer?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"33b7f27d-f328-4528-8f6e-fafec0018600"},{"name":"View specific Customer","id":"7483702b-b57d-437f-bcac-0865578e52d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","customer",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"17c6d887-2823-47a4-93e1-88e013f0c162","name":"View specific Customer","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer/45"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 45,\n \"firstName\": \"John\",\n \"lastName\": \"Wick\",\n \"phone\": \"+1 818-727-1234\",\n \"email\": \"john.wick@example.com\",\n \"address1\": \"9024 Some Ave\",\n \"address2\": null,\n \"city\": \"LA\",\n \"state\": \"CA\",\n \"zipCode\": \"90069\",\n \"accountName\": \"John Wick\",\n \"accountNumber\": \"******7890\",\n \"accountType\": \"Checking\",\n \"routingNumber\": \"123456789\",\n \"identifier\": null,\n \"dba\": {\n \"id\": 22\n }\n}"}],"_postman_id":"7483702b-b57d-437f-bcac-0865578e52d5"},{"name":"Create Customer","id":"336a0b2d-7941-4fd2-a9ac-7220fd1c25fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Wick\",\n \"phone\": \"+1 818-777-7777\",\n \"email\": \"john@wick.com\",\n \"address1\": \"26520 Agoura Road 1st Floor\",\n \"address2\": \"\",\n \"city\": \"CALABASAS\",\n \"state\": \"CA\",\n \"zipCode\": \"91302\",\n \"accountName\": \"John Wick\",\n \"accountNumber\": \"134567890\",\n \"accountType\": \"Checking\",\n \"routingNumber\": \"223456789\",\n \"dba\": {\n \"id\": \"9\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","customer"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"491422ec-3e47-4c52-94c3-2da08fbd32aa","name":"Create Customer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"+1 818-777-7777\",\n \"email\": \"john@wick.com\",\n \"address1\": \"123 Agoura Road 1st Floor\",\n \"address2\": \"\",\n \"city\": \"CALABASAS\",\n \"state\": \"CA\",\n \"zipCode\": \"91302\",\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"1234567890\",\n \"accountType\": \"Checking\",\n \"routingNumber\": \"123456789\",\n \"identifier\": \"777\",\n \"dba\": {\n \"id\": \"9\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"46\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phone\": \"+1 818-777-7777\",\n \"email\": \"john@wick.com\",\n \"address1\": \"123 Agoura Road 1st Floor\",\n \"address2\": null,\n \"city\": \"CALABASAS\",\n \"state\": \"CA\",\n \"zipCode\": \"91302\",\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"******7890\",\n \"accountType\": \"Checking\",\n \"routingNumber\": \"123456789\",\n \"identifier\": \"777\",\n \"dba\": {\n \"id\": \"9\"\n }\n}"}],"_postman_id":"336a0b2d-7941-4fd2-a9ac-7220fd1c25fc"},{"name":"Update Customer","id":"fdc02360-950e-41f5-b8e6-9177137aa0dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"1234567899\",\n \"routingNumber\": \"123456789\",\n \"address1\": \"26520 Agoura Road 1st Floor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer/36","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","customer","36"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"9fafce62-19df-435d-a04a-5447dc3829be","name":"Update Customer","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"1234567899\",\n \"routingNumber\": \"123456789\",\n \"address1\": \"26520 Agoura Road 1st Floor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer/36"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fdc02360-950e-41f5-b8e6-9177137aa0dc"},{"name":"Delete a Customer","id":"95c64cc7-1dc9-427b-8c7e-9d1672501274","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","customer",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"865a4df2-cf3f-4425-8763-d3c7a11d6840","name":"Delete a Customer","originalRequest":{"method":"DELETE","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/customer/46"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"95c64cc7-1dc9-427b-8c7e-9d1672501274"}],"id":"22bff8b6-3c43-43a3-aa31-affa71d061bd","description":"

Use this endpoint to store customer information in your dashboard for quick ACH payment management.

Customers Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the customer	String	Yes	No	Yes
firstName	First name of the customer	String	Yes	Yes	No
lastName	Last name of the customer	String	Yes	Yes	No
phone	Phone number of the customer	String	Yes	No	No
email	Email address of the customer	String	Yes	No	No
address1	Address of the customer line 1	String	No	Yes	No
address2	Address of the customer line 2	String	No	No	No
city	City of the customer	String	No	Yes	No
state	State of the customer. Example: NY, CA, etc...	String	No	Yes	No
zipCode	Zip Code of the customer	Integer	No	Yes	No
accountName	Name of the account	String	No	Yes	No
routingNumber	Routing Number	String	Yes	Yes	No
accountNumber	Access Number	String	Yes	Yes	No
accountType	`Checking` or `Savings`	ENUM	No	Yes	No
identifier	External Unique ID on a merchants platform	String	Yes	No	No
dba	Object	Object	-	-	-
dba.id	DBA ID	Integer	Yes	Yes	No

","_postman_id":"22bff8b6-3c43-43a3-aa31-affa71d061bd","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"Bank Information","item":[{"name":"View","id":"0186e84b-f3eb-4451-9442-a870e89bff66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/aba/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","aba",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"fba42d00-41ab-4e42-956d-a8598624e7af","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/aba/011000015"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"011000015\",\n \"bank\": \"FEDERAL RESERVE BANK OF BOSTON\"\n}"}],"_postman_id":"0186e84b-f3eb-4451-9442-a870e89bff66"}],"id":"8d01b979-d20a-4652-8bab-fe176d07d38c","description":"

Utilizing this endpoing you can view/verify the bank inforamtion associated with an ABA/Routing Number.

ABA Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	ABA/Routing Number	Integer	Yes	No	Yes
bank	Name of the bank	String	No	No	Yes

","_postman_id":"8d01b979-d20a-4652-8bab-fe176d07d38c","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}},{"name":"ACH Settlements","item":[{"name":"List","id":"a205a98c-2c20-4cf0-afdf-093da5f4d0bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/settlements/","description":"

List settlements for a specific dba.id

Get settlement details for the given dba.id and settlement.id

Settlement Details Object

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

Fields	Description	Type	Filterable
transaction	Transaction Object	Object	No
transaction.id	Transaction ID	Integer	Yes
transaction.type	Transaction Type `debit`, `credit`	ENUM	No
amount	Total Amount	Number	Yes
customerId	Customer ID	String	No
accountName	Account Name	String	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}},"urlObject":{"path":["api","ach","settlements","","details",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"56dee35c-f019-4dbc-9644-6c927f1b6e27","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ach/settlements/1/details/88757"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"transaction\": {\n \"id\": 92297509,\n \"type\": \"credit\"\n },\n \"amount\": \"3500.00\",\n \"customerId\": \"D1732A4527467\",\n \"accountName\": \"Checking\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/settlements/1732/details/88757?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/settlements/1732/details/88757?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ach/settlements/1732/details/88757?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"d208ea93-d8a7-4855-bff7-093a2f1534b1"}],"id":"f82fa4d6-dc4b-40ed-acc9-50696167f9a3","description":"

Utilizing this endpoint you can view your ACH settlement details

Settlement Object

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

Fields	Description	Type
settlement	Settlement Object	Object
settlement.id	Settlement ID	Integer
settlement.date	Settlement Date	DateTime
settlement.amount	Settlement Amount	Number
settlement.type	Settlement Type `Origination File Settlement`,`Late Return`,`ATMVerify Fee Only Settlement`,`Reserved for Future Use`,`Reserve Release`,`Transaction Fee Only Settlement`	ENUM
approvedDebits	Approved Debit Amount	Number
approvedCredits	Approved Credit Amount	Number
fees	Fees Object	Object
fees.debitCredit	Debit/Credit Fee Amount	Number
fees.noc	NOC Fee Amount	Number
fees.return	Return Fee Amount	Number
fees.lateReturn	Late Return Fee Amount	Number
fees.admin	Administrative Fee Amount	Number
reserve	Total Reserve Amount	Number
discount	Total Discount Amount	Number
lateReturns	Total Late Returns Amount	Number
hasDetails	Flag whether Details are attached `Yes` or `No`	ENUM

","_postman_id":"f82fa4d6-dc4b-40ed-acc9-50696167f9a3","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","id":"97060493-a487-4f0e-bc21-31fcf8ef1657","name":"ACH Payments","type":"folder"}}}],"id":"97060493-a487-4f0e-bc21-31fcf8ef1657","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"97060493-a487-4f0e-bc21-31fcf8ef1657","description":""},{"name":"Merchants","item":[{"name":"Terminals","item":[{"name":"List Terminals","id":"ad71792b-51a1-42f0-a926-5d5dcb9b943b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/terminals","description":"

List all terminals with their associated merchant.id and dba.id

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","name":"Merchants","type":"folder"}},"urlObject":{"path":["api","terminals"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"62317a82-d764-49d7-96bc-c149f00fa678","name":"List Terminals","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/terminals"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"ACME Corporation\",\n \"principals\": [\n {\n \"id\": 12,\n \"name\": {\n \"first\": \"Elmer\",\n \"last\": \"Fudd\"\n },\n \"isSigner\": \"Yes\",\n \"isPersonalGuarantee\": \"Yes\",\n \"ownershipPercentage\": 100\n }\n ],\n \"dbas\": [\n {\n \"id\": 14,\n \"name\": \"ACME\",\n \"address\": {\n \"street\": null,\n \"city\": null,\n \"zip\": null,\n \"state\": [\n null\n ],\n \"country\": [\n 199\n ]\n },\n \"customerServiceContact\": {\n \"phone\": \"+1 818-707-1234\",\n \"email\": \"email@email.com\"\n },\n \"processing\": {\n \"id\": 4,\n \"mid\": 1231231231231312,\n \"bank\": {\n \"name\": \"Axiom Bank\",\n \"accountNumber\": \"8888\"\n },\n \"mcc\": \"5899\",\n \"riskLevel\": \"Low\",\n \"status\": \"Live\",\n \"boardedOn\": \"2020-11-27 11:59:26\",\n \"volumes\": {\n \"monthlyTransactionAmount\": 1000,\n \"avgTransactionAmount\": 10,\n \"maxTransactionAmount\": 100\n },\n \"sales\": {\n \"swiped\": 70,\n \"mail\": 30,\n \"internet\": 0\n },\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": 49,\n \"type\": {\n \"id\": 1\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 50,\n \"type\": {\n \"id\": 2\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 51,\n \"type\": {\n \"id\": 3\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 52,\n \"type\": {\n \"id\": 4\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 53,\n \"type\": {\n \"id\": 5\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 54,\n \"type\": {\n \"id\": 6\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 55,\n \"type\": {\n \"id\": 7\n },\n \"value\": \"0.75000\"\n },\n {\n \"id\": 56,\n \"type\": {\n \"id\": 8\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 57,\n \"type\": {\n \"id\": 9\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 58,\n \"type\": {\n \"id\": 10\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 59,\n \"type\": {\n \"id\": 11\n },\n \"value\": \"5.00000\"\n },\n {\n \"id\": 60,\n \"type\": {\n \"id\": 12\n },\n \"value\": \"25.00000\"\n },\n {\n \"id\": 61,\n \"type\": {\n \"id\": 13\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 62,\n \"type\": {\n \"id\": 14\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 63,\n \"type\": {\n \"id\": 15\n },\n \"value\": \"0.05000\"\n },\n {\n \"id\": 64,\n \"type\": {\n \"id\": 16\n },\n \"value\": \"35.00000\"\n },\n {\n \"id\": 65,\n \"type\": {\n \"id\": 17\n },\n \"value\": \"5.00000\"\n },\n {\n \"id\": 66,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 67,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 68,\n \"type\": {\n \"id\": 18\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 69,\n \"type\": {\n \"id\": 19\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 70,\n \"type\": {\n \"id\": 20\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 71,\n \"type\": {\n \"id\": 21\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 72,\n \"type\": {\n \"id\": 22\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n },\n \"ach\": {\n \"id\": 13,\n \"bank\": {\n \"name\": \"Mufg Union Bank, NA\",\n \"accountNumber\": \"123456\"\n },\n \"riskLevel\": \"Low\",\n \"status\": \"Inactive\",\n \"boardedOn\": \"2020-11-27 11:59:26\",\n \"volumes\": {\n \"monthlyTransactions\": 100,\n \"avgMonthlyTransactionAmount\": 10,\n \"avgTransactionAmount\": 100,\n \"maxTransactionAmount\": 1000\n },\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": 145,\n \"type\": {\n \"id\": 25\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 146,\n \"type\": {\n \"id\": 26\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 147,\n \"type\": {\n \"id\": 27\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 148,\n \"type\": {\n \"id\": 28\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 149,\n \"type\": {\n \"id\": 29\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 150,\n \"type\": {\n \"id\": 30\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 151,\n \"type\": {\n \"id\": 31\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 152,\n \"type\": {\n \"id\": 32\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 153,\n \"type\": {\n \"id\": 33\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 154,\n \"type\": {\n \"id\": 35\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 155,\n \"type\": {\n \"id\": 35\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": 156,\n \"type\": {\n \"id\": 35\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n }\n }\n ]\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/merchant?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/merchant?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/merchant?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"ad71792b-51a1-42f0-a926-5d5dcb9b943b"},{"name":"View a specific Terminal","id":"3349b703-c99d-420a-8754-28d3dcf67cba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/terminal/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","name":"Merchants","type":"folder"}},"urlObject":{"path":["api","terminal",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"3682e38c-9194-413a-8db3-cdc360eceb8a","name":"View a specific Terminal","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/terminal/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"dba\": {\n \"id\": \"1\",\n \"name\": \"ACME\"\n },\n \"merchant\": {\n \"id\": \"1\",\n \"name\": \"ACME Corporation\"\n },\n \"name\": \"ACME Terminal\",\n \"tid\": 7000,\n \"vNumber\": \"123456\",\n \"gateway\": {\n \"provider\": \"Other\",\n \"activatedOn\": \"2021-10-11 05:08:18\",\n \"3DsStatus\": \"Unavailable\"\n },\n \"feeTerminalId\": null,\n \"website\": \"https://www.example.com\",\n \"note\": \"Demo note\",\n \"cardTypes\": {\n \"acceptVisa\": \"No\",\n \"acceptMastercard\": \"No\",\n \"acceptDiscover\": \"No\",\n \"acceptAmericanExpress\": \"No\",\n \"acceptPinDebit\": \"No\",\n \"acceptEbt\": \"No\",\n \"acceptGiftCard\": \"No\"\n },\n \"chain\": \"4\",\n \"agentBank\": \"4\",\n \"storeNumber\": \"0001\",\n \"locationNumber\": \"00001\"\n \"createdOn\": \"2019-02-06 13:55:35\",\n}"}],"_postman_id":"3349b703-c99d-420a-8754-28d3dcf67cba"},{"name":"VAR Sheet","id":"fe156c2a-fe01-4e2a-8085-d668558d62d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/terminal//var-download","description":"

By utilizing this endpoint you can download a pdf file containing the terminal information, also known as VAR Sheet.

By utilizing this endpoint you can view VAR sheet data for a specific terminal

By utilizing this endpoint you can read all terminal/s related information for a specific merchant.

Terminal Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique system ID of the terminal	Integer	Yes	No	Yes
dba	DBA Object	Object	No	No	Yes
dba.id	Unique ID of the DBA record	Integer	Yes	No	Yes
dba.name	Merchant DBA	String	No	No	Yes
merchant	Merchant Object	Integer	No	No	Yes
merchant.id	Unique ID of the merchant	Integer	Yes	No	Yes
merchant.name	Merchant Legal name	String	No	No	Yes
name	A name assigned to the merchant terminal	String	Yes	No	Yes
tid	Terminal Identification Number	Integer	Yes	No	Yes
vNumber	Vital Service Number – Terminal Identifier	String	Yes	No	Yes
gateway	Getaway Object	Object	No	No	Yes
gateway.provider	The gateway provider - `Internal` `Other`	ENUM	No	No	Yes
gateway.activatedOn	Date of activation	Datetime	No	No	Yes
gateway.3DsStatus	3Ds terminal configuration `Unavailable` `Optional` `Required`	ENUM	No	No	Yes
feeTerminalId	ID of the fee terminal	Integer	No	No	Yes
website	Website	String	No	No	Yes
note	Notes on the terminal written by Underwriting	String	No	No	Yes
cardTypes	Card Types Object	Object	No	No	Yes
cardTypes.acceptVisa	Configured to accept Visa `Yes` `No`	ENUM	No	No	Yes
cardTypes.acceptMastercard	Configured to accept Mastercard `Yes` `No`	ENUM	No	No	Yes
cardTypes.acceptDiscover	Configured to accept Discover `Yes` `No`	ENUM	No	No	Yes
cardTypes.acceptAmericanExpress	Configured to accept AmericanExpress `Yes` `No`	ENUM	No	No	Yes
cardTypes.acceptPinDebit	Configured to accept PinDebit `Yes` `No`	ENUM	No	No	Yes
cardTypes.acceptEbt	Configured to accept Ebt `Yes` `No`	ENUM	No	No	Yes
cardTypes.acceptGiftCard	Configured to accept GiftCard `Yes` `No`	ENUM	No	No	Yes
chain	A six-digit number that identifies a merchant's chain of locations or stores	Integer	No	No	Yes
agentBank	A six-digit number identifying the processing bank	Integer	No	No	Yes
storeNumber	A four-digit number that identifies a terminals location at the merchant site	Integer	No	No	Yes
locationNumber	A five digit number that identifies the store location. Start with 00001	String	No	No	Yes
createdOn	Date and Time of creation	Datetime	No	No	Yes

","_postman_id":"70cdd429-4a6d-47ec-8cc1-5558797efc80","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","name":"Merchants","type":"folder"}}},{"name":"List Merchants","id":"d195b854-d735-4c48-adfa-73a072252cd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/merchant","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","name":"Merchants","type":"folder"}},"urlObject":{"path":["api","merchant"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"12900ab7-93c5-4209-9741-4800a022c18a","name":"List Merchants","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/merchant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"1\",\n \"name\": \"Demo Merchant Inc\",\n \"principals\": [\n {\n \"name\": {\n \"first\": \"S\",\n \"last\": \"P\"\n },\n \"isSigner\": \"Yes\",\n \"isPersonalGuarantee\": \"Yes\",\n \"ownershipPercentage\": 51\n },\n {\n \"name\": {\n \"first\": \"gosho\",\n \"last\": \"goshev\"\n },\n \"isSigner\": \"Yes\",\n \"isPersonalGuarantee\": \"No\",\n \"ownershipPercentage\": 12\n }\n ],\n \"dbas\": [\n {\n \"id\": \"1\",\n \"name\": \"Demo Merchant DBA\",\n \"address\": {\n \"street\": \"Lorem 15\",\n \"city\": \"Valhala\",\n \"zip\": \"2222\",\n \"state\": [\n 15\n ],\n \"country\": [\n 199\n ]\n },\n \"customerServiceContact\": {\n \"phone\": \"+1 717-888-8888\",\n \"email\": \"demo-merchant@manky.org\"\n },\n \"processing\": {\n \"mid\": \"201143806445\",\n \"bank\": {\n \"name\": \"Esquire Bank\",\n \"accountNumber\": \"3456\"\n },\n \"mcc\": \"5734\",\n \"status\": \"Closed\",\n \"boardedOn\": \"2019-02-06 12:00:00\",\n \"closedOn\": \"2022-02-16 15:38:33\",\n \"volumes\": {\n \"monthlyTransactionAmount\": 7000000,\n \"avgTransactionAmount\": 700,\n \"maxTransactionAmount\": 7000\n },\n \"sales\": {\n \"swiped\": 30,\n \"mail\": 10,\n \"internet\": 60\n },\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": \"1\",\n \"type\": {\n \"id\": \"1\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"2\",\n \"type\": {\n \"id\": \"2\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"3\",\n \"type\": {\n \"id\": \"3\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"4\",\n \"type\": {\n \"id\": \"4\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"5\",\n \"type\": {\n \"id\": \"5\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"6\",\n \"type\": {\n \"id\": \"6\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"7\",\n \"type\": {\n \"id\": \"7\"\n },\n \"value\": \"0.75000\"\n },\n {\n \"id\": \"8\",\n \"type\": {\n \"id\": \"8\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"9\",\n \"type\": {\n \"id\": \"9\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"10\",\n \"type\": {\n \"id\": \"10\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"11\",\n \"type\": {\n \"id\": \"11\"\n },\n \"value\": \"5.00000\"\n },\n {\n \"id\": \"12\",\n \"type\": {\n \"id\": \"12\"\n },\n \"value\": \"25.00000\"\n },\n {\n \"id\": \"13\",\n \"type\": {\n \"id\": \"13\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"14\",\n \"type\": {\n \"id\": \"14\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"15\",\n \"type\": {\n \"id\": \"15\"\n },\n \"value\": \"0.05000\"\n },\n {\n \"id\": \"16\",\n \"type\": {\n \"id\": \"16\"\n },\n \"value\": \"35.00000\"\n },\n {\n \"id\": \"17\",\n \"type\": {\n \"id\": \"17\"\n },\n \"value\": \"5.00000\"\n },\n {\n \"id\": \"18\",\n \"type\": {\n \"id\": \"18\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"19\",\n \"type\": {\n \"id\": \"20\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"20\",\n \"type\": {\n \"id\": \"18\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"21\",\n \"type\": {\n \"id\": \"18\"\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n },\n \"ach\": {\n \"id\": \"14\",\n \"bank\": {\n \"name\": \"BANK OF AMERICA CALIFORNIA, NA\",\n \"accountNumber\": \"8889\"\n },\n \"status\": \"Inactive\",\n \"boardedOn\": \"2020-04-14 17:04:37\",\n \"volumes\": {\n \"monthlyTransactions\": 4,\n \"avgMonthlyTransactionAmount\": 5,\n \"avgTransactionAmount\": 6,\n \"maxTransactionAmount\": 7\n },\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": \"145\",\n \"type\": {\n \"id\": \"25\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"146\",\n \"type\": {\n \"id\": \"26\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"147\",\n \"type\": {\n \"id\": \"27\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"148\",\n \"type\": {\n \"id\": \"28\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"149\",\n \"type\": {\n \"id\": \"29\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"150\",\n \"type\": {\n \"id\": \"30\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"151\",\n \"type\": {\n \"id\": \"31\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"152\",\n \"type\": {\n \"id\": \"32\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"153\",\n \"type\": {\n \"id\": \"33\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"154\",\n \"type\": {\n \"id\": \"35\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"155\",\n \"type\": {\n \"id\": \"35\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"156\",\n \"type\": {\n \"id\": \"35\"\n },\n \"value\": \"2.00000\"\n }\n ],\n \"note\": \"2\"\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/merchant?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/merchant?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/merchant?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"d195b854-d735-4c48-adfa-73a072252cd5"}],"id":"de51b6c3-397c-4aeb-8dfd-95faa7ce38ec","description":"

This endpoint is used to view all Merchant account related inforamtion.

Merchants Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the DBA record	Integer	Yes	No	Yes
name	Name of the DBA	String	Yes	No	Yes
principals	List of principals and details	Object	No	No	Yes
principals.name	Name Object	Object	No	No	Yes
principals.name.first	First Name	String	No	No	Yes
principals.name.last	Last Name	String	No	No	Yes
principals.isSigner	`Yes`, `No`(If this is the individual you want to list as signer)	ENUM	No	No	Yes
principals.isPersonalGuarantee	`Yes`, `No`(If this is the individual you want to list as guarantee)	ENUM	No	No	Yes
principals.ownershipPercentage	Percentage of ownership	Integer	No	No	Yes
dbas	List of DBA's and details	Object	No	No	Yes
dbas.id	Unique ID of the DBA record	Integer	No	No	Yes
dbas.name	Name of the DBA	String	No	No	Yes
dbas.address	Object	Object	No	No	Yes
dbas.address.street	Street	String	No	No	Yes
dbas.address.city	City	String	No	No	Yes
dbas.address.zip	Zip code	String	No	No	Yes
dbas.address.state	Object	Object	No	No	Yes
dbas.address.state.id	State ID	String	No	No	Yes
dbas.address.country	Object	Object	No	No	Yes
dbas.address.country.id	Country ID	String	No	No	Yes
dbas.customerServiceContact	Object	Object	No	No	Yes
dbas.customerServiceContact.phone	Customer service phone number	String	No	No	Yes
dbas.customerServiceContact.email	Customer service email	String	No	No	Yes
dbas.processing	Object	Object	No	No	Yes
dbas.processing.mid	Merchant Identification Number	String	No	No	Yes
dbas.processing.bank	Bank Details	Object	No	No	Yes
dbas.processing.bank.name	Name of the bank	String	No	No	Yes
dbas.processing.bank.accountNumber	Last 4 characters from the Bank Account Number	String	No	No	Yes
dbas.processing.mcc	Merchant Category Code	String	No	No	Yes
dbas.processing.status	Status `Approved`, `Live`, `Inactive`, `Closed`	ENUM	No	No	Yes
dbas.processing.boardedOn	Date and Time when the DBA was created	Datetime	No	No	Yes
dbas.processing.closedOn	Date and Time when the DBA was closed	Datetime	No	No	Yes
dbas.processing.volumes	Object	Object	No	No	Yes
dbas.processing.volumes.monthlyTransactionAmount	Monthly Volume	Integer	No	No	Yes
dbas.processing.volume.avgTransactionAmount	Average Transaction Amount	Integer	No	No	Yes
dbas.processing.volume.maxTransactionAmount	Max Transaction Amount	Integer	No	No	Yes
dbas.processing.sales	Object	Object	No	No	Yes
dbas.processing.sales.swiped	Percentage of card-present transactions	Integer	No	No	Yes
dbas.processing.sales.mail	Percentage of mail/phone card not present transactions	Integer	No	No	Yes
dbas.processing.sales.internet	Percentage of internet/eCommerce card not present transactions	Integer	No	No	Yes
dbas.processing.feeSchedule	Object	Object	No	No	Yes
dbas.processing.feeSchedule.fees	Fee Object	Object	No	No	Yes
dbas.processing.feeSchedule.fees.id	Identifier of Fee	String	No	No	Yes
dbas.processing.feeSchedule.fees.type	Fee Type Object	Object	No	No	Yes
dbas.processing.feeSchedule.fees.type.id	Identifier of fee types	String	No	No	Yes
dbas.processing.feeSchedule.fees.value	Fee Amount	String	No	No	Yes
dbas.processing.feeSchedule.note	Fee Note	String	No	No	Yes
dbas.ach	Object	Object	No	No	Yes
dbas.ach.id	Identification Number	String	No	No	Yes
dbas.ach.bank	Bank Details	Object	No	No	Yes
dbas.ach.bank.name	Name of the bank	String	No	No	Yes
dbas.ach.bank.accountNumber	Last 4 characters from the Bank Account Number	String	No	No	Yes
dbas.ach.mcc	Merchant Category Code	String	No	No	Yes
dbas.ach.status	Status `Approved`, `Live`, `Inactive`, `Closed`	ENUM	No	No	Yes
dbas.ach.boardedOn	Date and Time when the DBA was created	Datetime	No	No	Yes
dbas.ach.closedOn	Date and Time when the DBA was closed	Datetime	No	No	Yes
dbas.ach.volumes	Object	Object	No	No	Yes
dbas.ach.monthlyTransactions	Number Of Monthly Transactions	Integer	No	No	Yes
dbas.ach.volumes.avgMonthlyTransactionAmount	Monthly Volume	Integer	No	No	Yes
dbas.ach.volume.avgTransactionAmount	Average Transaction Amount	Integer	No	No	Yes
dbas.ach.volume.maxTransactionAmount	Max Transaction Amount	Integer	No	No	Yes
dbas.ach.feeSchedule	Object	Object	No	No	Yes
dbas.ach.feeSchedule.fees	Fee Object	Object	No	No	Yes
dbas.ach.feeSchedule.fees.id	Identifier of Fee	String	No	No	Yes
dbas.ach.feeSchedule.fees.type	Fee Type Object	Object	No	No	Yes
dbas.ach.feeSchedule.fees.type.id	Identifier of fee types	String	No	No	Yes
dbas.ach.feeSchedule.fees.value	Fee Amount	String	No	No	Yes
dbas.ach.feeSchedule.note	Fee Note	String	No	No	Yes

Use this endpoint to list all DBAs that you have available.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"ced17983-7259-49c2-97b0-defe0a8dc2c6","id":"ced17983-7259-49c2-97b0-defe0a8dc2c6","name":"DBA","type":"folder"}},"urlObject":{"path":["api","dba"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"56d12643-4263-402e-8c0e-546a7f364828","name":"List DBAs","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/dba"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"1\",\n \"name\": \"Demo Merchant DBA\",\n \"address\": {\n \"street\": \"Lorem 15\",\n \"city\": \"Valhala\",\n \"zip\": \"2222\",\n \"state\": [\n 15\n ],\n \"country\": [\n 199\n ]\n },\n \"customerServiceContact\": {\n \"phone\": \"+1 717-888-8888\",\n \"email\": \"demo-example@example.org\"\n },\n \"processing\": {\n \"mid\": \"201143806445\",\n \"bank\": {\n \"name\": \"Esquire Bank\",\n \"accountNumber\": \"3456\"\n },\n \"mcc\": \"5734\",\n \"status\": \"Closed\",\n \"boardedOn\": \"2019-02-06 12:00:00\",\n \"closedOn\": \"2022-02-16 15:38:33\",\n \"volumes\": {\n \"monthlyTransactionAmount\": 7000000,\n \"avgTransactionAmount\": 700,\n \"maxTransactionAmount\": 7000\n },\n \"sales\": {\n \"swiped\": 30,\n \"mail\": 10,\n \"internet\": 60\n },\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": \"1\",\n \"type\": {\n \"id\": \"1\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"2\",\n \"type\": {\n \"id\": \"2\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"3\",\n \"type\": {\n \"id\": \"3\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"4\",\n \"type\": {\n \"id\": \"4\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"5\",\n \"type\": {\n \"id\": \"5\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"6\",\n \"type\": {\n \"id\": \"6\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"7\",\n \"type\": {\n \"id\": \"7\"\n },\n \"value\": \"0.75000\"\n },\n {\n \"id\": \"8\",\n \"type\": {\n \"id\": \"8\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"9\",\n \"type\": {\n \"id\": \"9\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"10\",\n \"type\": {\n \"id\": \"10\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"11\",\n \"type\": {\n \"id\": \"11\"\n },\n \"value\": \"5.00000\"\n },\n {\n \"id\": \"12\",\n \"type\": {\n \"id\": \"12\"\n },\n \"value\": \"25.00000\"\n },\n {\n \"id\": \"13\",\n \"type\": {\n \"id\": \"13\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"14\",\n \"type\": {\n \"id\": \"14\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"15\",\n \"type\": {\n \"id\": \"15\"\n },\n \"value\": \"0.05000\"\n },\n {\n \"id\": \"16\",\n \"type\": {\n \"id\": \"16\"\n },\n \"value\": \"35.00000\"\n },\n {\n \"id\": \"17\",\n \"type\": {\n \"id\": \"17\"\n },\n \"value\": \"5.00000\"\n },\n {\n \"id\": \"18\",\n \"type\": {\n \"id\": \"18\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"19\",\n \"type\": {\n \"id\": \"20\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"20\",\n \"type\": {\n \"id\": \"18\"\n },\n \"value\": \"0.00000\"\n },\n {\n \"id\": \"21\",\n \"type\": {\n \"id\": \"18\"\n },\n \"value\": \"0.00000\"\n }\n ],\n \"note\": null\n }\n },\n \"ach\": {\n \"id\": \"14\",\n \"bank\": {\n \"name\": \"BANK OF AMERICA CALIFORNIA, NA\",\n \"accountNumber\": \"8889\"\n },\n \"status\": \"Inactive\",\n \"boardedOn\": \"2020-04-14 17:04:37\",\n \"volumes\": {\n \"monthlyTransactions\": 4,\n \"avgMonthlyTransactionAmount\": 5,\n \"avgTransactionAmount\": 6,\n \"maxTransactionAmount\": 7\n },\n \"feeSchedule\": {\n \"fees\": [\n {\n \"id\": \"145\",\n \"type\": {\n \"id\": \"25\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"146\",\n \"type\": {\n \"id\": \"26\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"147\",\n \"type\": {\n \"id\": \"27\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"148\",\n \"type\": {\n \"id\": \"28\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"149\",\n \"type\": {\n \"id\": \"29\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"150\",\n \"type\": {\n \"id\": \"30\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"151\",\n \"type\": {\n \"id\": \"31\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"152\",\n \"type\": {\n \"id\": \"32\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"153\",\n \"type\": {\n \"id\": \"33\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"154\",\n \"type\": {\n \"id\": \"35\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"155\",\n \"type\": {\n \"id\": \"35\"\n },\n \"value\": \"2.00000\"\n },\n {\n \"id\": \"156\",\n \"type\": {\n \"id\": \"35\"\n },\n \"value\": \"2.00000\"\n }\n ],\n \"note\": \"2\"\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/dba?page=1&per-page=30\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"26ea1539-d16d-4e18-81d2-88637094a595"},{"name":"View","id":"070dd885-898d-454a-882c-c704c05a5eb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/dba/1","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"ced17983-7259-49c2-97b0-defe0a8dc2c6","id":"ced17983-7259-49c2-97b0-defe0a8dc2c6","name":"DBA","type":"folder"}},"urlObject":{"path":["api","dba","1"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"6bcc1a9f-6975-4802-8972-0d175094e815","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/dba/1"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"1\",\r\n \"name\": \"Demo Merchant DBA\",\r\n \"address\": {\r\n \"street\": \"Lorem 15\",\r\n \"city\": \"Valhala\",\r\n \"zip\": \"2222\",\r\n \"state\": [\r\n 15\r\n ],\r\n \"country\": [\r\n 199\r\n ]\r\n },\r\n \"customerServiceContact\": {\r\n \"phone\": \"+1 717-888-8888\",\r\n \"email\": \"demo-example@example.org\"\r\n },\r\n \"processing\": {\r\n \"mid\": \"201143806445\",\r\n \"bank\": {\r\n \"name\": \"Esquire Bank\",\r\n \"accountNumber\": \"3456\"\r\n },\r\n \"mcc\": \"5734\",\r\n \"status\": \"Closed\",\r\n \"boardedOn\": \"2019-02-06 12:00:00\",\r\n \"closedOn\": \"2022-02-16 15:38:33\",\r\n \"volumes\": {\r\n \"monthlyTransactionAmount\": 7000000,\r\n \"avgTransactionAmount\": 700,\r\n \"maxTransactionAmount\": 7000\r\n },\r\n \"sales\": {\r\n \"swiped\": 30,\r\n \"mail\": 10,\r\n \"internet\": 60\r\n },\r\n \"feeSchedule\": {\r\n \"fees\": [\r\n {\r\n \"id\": \"1\",\r\n \"type\": {\r\n \"id\": \"1\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"type\": {\r\n \"id\": \"2\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"type\": {\r\n \"id\": \"3\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"4\",\r\n \"type\": {\r\n \"id\": \"4\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"5\",\r\n \"type\": {\r\n \"id\": \"5\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"6\",\r\n \"type\": {\r\n \"id\": \"6\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"7\",\r\n \"type\": {\r\n \"id\": \"7\"\r\n },\r\n \"value\": \"0.75000\"\r\n },\r\n {\r\n \"id\": \"8\",\r\n \"type\": {\r\n \"id\": \"8\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"9\",\r\n \"type\": {\r\n \"id\": \"9\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"10\",\r\n \"type\": {\r\n \"id\": \"10\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"11\",\r\n \"type\": {\r\n \"id\": \"11\"\r\n },\r\n \"value\": \"5.00000\"\r\n },\r\n {\r\n \"id\": \"12\",\r\n \"type\": {\r\n \"id\": \"12\"\r\n },\r\n \"value\": \"25.00000\"\r\n },\r\n {\r\n \"id\": \"13\",\r\n \"type\": {\r\n \"id\": \"13\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"14\",\r\n \"type\": {\r\n \"id\": \"14\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"15\",\r\n \"type\": {\r\n \"id\": \"15\"\r\n },\r\n \"value\": \"0.05000\"\r\n },\r\n {\r\n \"id\": \"16\",\r\n \"type\": {\r\n \"id\": \"16\"\r\n },\r\n \"value\": \"35.00000\"\r\n },\r\n {\r\n \"id\": \"17\",\r\n \"type\": {\r\n \"id\": \"17\"\r\n },\r\n \"value\": \"5.00000\"\r\n },\r\n {\r\n \"id\": \"18\",\r\n \"type\": {\r\n \"id\": \"18\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"19\",\r\n \"type\": {\r\n \"id\": \"20\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"20\",\r\n \"type\": {\r\n \"id\": \"18\"\r\n },\r\n \"value\": \"0.00000\"\r\n },\r\n {\r\n \"id\": \"21\",\r\n \"type\": {\r\n \"id\": \"18\"\r\n },\r\n \"value\": \"0.00000\"\r\n }\r\n ],\r\n \"note\": null\r\n }\r\n },\r\n \"ach\": {\r\n \"id\": \"14\",\r\n \"bank\": {\r\n \"name\": \"BANK OF AMERICA CALIFORNIA, NA\",\r\n \"accountNumber\": \"8889\"\r\n },\r\n \"status\": \"Inactive\",\r\n \"boardedOn\": \"2020-04-14 17:04:37\",\r\n \"volumes\": {\r\n \"monthlyTransactions\": 4,\r\n \"avgMonthlyTransactionAmount\": 5,\r\n \"avgTransactionAmount\": 6,\r\n \"maxTransactionAmount\": 7\r\n },\r\n \"feeSchedule\": {\r\n \"fees\": [\r\n {\r\n \"id\": \"145\",\r\n \"type\": {\r\n \"id\": \"25\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"146\",\r\n \"type\": {\r\n \"id\": \"26\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"147\",\r\n \"type\": {\r\n \"id\": \"27\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"148\",\r\n \"type\": {\r\n \"id\": \"28\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"149\",\r\n \"type\": {\r\n \"id\": \"29\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"150\",\r\n \"type\": {\r\n \"id\": \"30\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"151\",\r\n \"type\": {\r\n \"id\": \"31\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"152\",\r\n \"type\": {\r\n \"id\": \"32\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"153\",\r\n \"type\": {\r\n \"id\": \"33\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"154\",\r\n \"type\": {\r\n \"id\": \"35\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"155\",\r\n \"type\": {\r\n \"id\": \"35\"\r\n },\r\n \"value\": \"2.00000\"\r\n },\r\n {\r\n \"id\": \"156\",\r\n \"type\": {\r\n \"id\": \"35\"\r\n },\r\n \"value\": \"2.00000\"\r\n }\r\n ],\r\n \"note\": \"2\"\r\n }\r\n }\r\n}"}],"_postman_id":"070dd885-898d-454a-882c-c704c05a5eb3"}],"id":"ced17983-7259-49c2-97b0-defe0a8dc2c6","description":"

This endpoint is used to view all Merchant DBA related information.

DBA Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the DBA record	Integer	No	No	Yes
name	Name of the DBA	String	No	No	Yes
address	Object	Object	No	No	Yes
address.street	Street	String	No	No	Yes
address.city	City	String	No	No	Yes
address.zip	Zip code	String	No	No	Yes
address.state	Object	Object	No	No	Yes
address.state.id	State ID	String	No	No	Yes
address.country	Object	Object	No	No	Yes
address.country.id	Country ID	String	No	No	Yes
customerServiceContact	Object	Object	No	No	Yes
customerServiceContact.phone	Customer service phone number	String	No	No	Yes
customerServiceContact.email	Customer service email	String	No	No	Yes
processing	Object	Object	No	No	Yes
processing.mid	Merchant Identification Number	String	No	No	Yes
processing.bank	Bank Details	Object	No	No	Yes
processing.bank.name	Name of the bank	String	No	No	Yes
processing.bank.accountNumber	Last 4 characters from the Bank Account Number	String	No	No	Yes
processing.mcc	Merchant Category Code	String	No	No	Yes
processing.status	Status `Approved`, `Live`, `Inactive`, `Closed`	ENUM	No	No	Yes
processing.boardedOn	Date and Time when the DBA was created	Datetime	No	No	Yes
processing.closedOn	Date and Time when the DBA was closed	Datetime	No	No	Yes
processing.volumes	Object	Object	No	No	Yes
processing.volumes.monthlyTransactionAmount	Monthly Volume	Integer	No	No	Yes
processing.volume.avgTransactionAmount	Average Transaction Amount	Integer	No	No	Yes
processing.volume.maxTransactionAmount	Max Transaction Amount	Integer	No	No	Yes
processing.sales	Object	Object	No	No	Yes
processing.sales.swiped	Percentage of card-present transactions	Integer	No	No	Yes
processing.sales.mail	Percentage of mail/phone card not present transactions	Integer	No	No	Yes
processing.sales.internet	Percentage of internet/eCommerce card not present transactions	Integer	No	No	Yes
processing.feeSchedule	Object	Object	No	No	Yes
processing.feeSchedule.fees	Fee Object	Object	No	No	Yes
processing.feeSchedule.fees.id	Identifier of Fee	String	No	No	Yes
processing.feeSchedule.fees.type	Fee Type Object	Object	No	No	Yes
processing.feeSchedule.fees.type.id	Identifier of fee types	String	No	No	Yes
processing.feeSchedule.fees.value	Fee Amount	String	No	No	Yes
processing.feeSchedule.note	Fee Note	String	No	No	Yes
ach	Object	Object	No	No	Yes
ach.id	Identification Number	String	No	No	Yes
ach.bank	Bank Details	Object	No	No	Yes
ach.bank.name	Name of the bank	String	No	No	Yes
ach.bank.accountNumber	Last 4 characters from the Bank Account Number	String	No	No	Yes
ach.mcc	Merchant Category Code	String	No	No	Yes
ach.status	Status `Approved`, `Live`, `Inactive`, `Closed`	ENUM	No	No	Yes
ach.boardedOn	Date and Time when the DBA was created	Datetime	No	No	Yes
ach.closedOn	Date and Time when the DBA was closed	Datetime	No	No	Yes
ach.volumes	Object	Object	No	No	Yes
ach.monthlyTransactions	Number Of Monthly Transactions	Integer	No	No	Yes
ach.volumes.avgMonthlyTransactionAmount	Monthly Volume	Integer	No	No	Yes
ach.volume.avgTransactionAmount	Average Transaction Amount	Integer	No	No	Yes
ach.volume.maxTransactionAmount	Max Transaction Amount	Integer	No	No	Yes
ach.feeSchedule	Object	Object	No	No	Yes
ach.feeSchedule.fees	Fee Object	Object	No	No	Yes
ach.feeSchedule.fees.id	Identifier of Fee	String	No	No	Yes
ach.feeSchedule.fees.type	Fee Type Object	Object	No	No	Yes
ach.feeSchedule.fees.type.id	Identifier of fee types	String	No	No	Yes
ach.feeSchedule.fees.value	Fee Amount	String	No	No	Yes
ach.feeSchedule.note	Fee Note	String	No	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"ced17983-7259-49c2-97b0-defe0a8dc2c6"},{"name":"CustomerVault","item":[{"name":"Customers","item":[{"name":"List","id":"813a65f7-7b01-4f72-a1f1-03c5c42aa0ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault","description":"

List all of your customers

Use this endpoint to view information for a specific customer.

Creating a Customer can be achieved using this endpoint

The update endpoint is used to modify the customer's information in the Customer Vault. You can modify personal details and company information of the customer in the vault.

When a specific customer in the vault has transactional history, that customer cannot be deleted. In this case, the customer needs to be archived.

\n
NOTE We allow a customer to be returned to active status from archived.
\n

If a specific customer in the vault has no transactional history your can delete the customer using this endpoint.

\n
IMPORTANT You cannot restore a deleted customer. If you are unsure of future use we suggest archiving the customer.
\n

Use this endpoint to manage all of your customers in the Customer Vault.

\n","_postman_id":"46a4f1b6-4972-49d6-80f8-a59cf80997db","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}}},{"name":"Cards","item":[{"name":"List Cards","id":"84d54965-6edb-4e17-95e5-4aa64c6d81a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//cards","description":"

List all stored payment information for a customer. This will return an object of all the stored payment card records on file for a specific customer in the vault.

To view a single card record for a specific customer use the following:

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","card",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"e06763e2-0878-4ef3-bc4d-f61d58d85792","name":"View a specific payment card record","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/1/card/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2\",\n \"billing\": {\n \"id\": \"1\"\n },\n \"number\": 4489,\n \"bin\": {\n \"bin\": 411111,\n \"brand\": \"Visa\",\n \"organization\": \"Jpmorgan Chase Bank, N.a.\",\n \"type\": \"Credit\",\n \"category\": null,\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n },\n \"exp\": \"2031-12-31\",\n \"token\": \"H3ViuS1XiX9w4489\",\n \"attempt\": {\n \"date\": null,\n \"retries\": 0\n },\n \"lastUsedOn\": null,\n \"order\": 50,\n \"status\": \"Active\",\n \"archived\": \"No\",\n \"note\": null,\n \"createdOn\": \"2021-06-02 13:47:30\",\n \"_links\": {\n \"index\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/1/cards\"\n },\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/1/card/2\"\n }\n }\n}"}],"_postman_id":"8698a7c2-d63a-4f99-831a-68bfcd7c9d98"},{"name":"Add Card","id":"81b7471a-91d4-4154-8134-37b4c8812d4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billing\": {\n \"id\": 34\n },\n \"terminal\": {\n \"id\": 1593\n },\n \"cvv\": \"996\",\n \"exp\": \"12/31\",\n \"holderName\": \"John Wick\",\n \"number\": \"6011421812165456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//card","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","card"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"ba056a9f-e64d-4531-9eed-87cd06e26ae9","name":"Add Card","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billing\": {\n \"id\": 2\n },\n \"terminal\": {\n \"id\": 1\n },\n \"cvv\": \"996\",\n \"exp\": \"12/31\",\n \"holderName\": \"John Wick\",\n \"number\": \"6011421812165456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/1/card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"number\": 5456,\n \"bin\": {\n \"bin\": 411111,\n \"brand\": \"Visa\",\n \"organization\": \"Jpmorgan Chase Bank, N.a.\",\n \"type\": \"Credit\",\n \"category\": null,\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n },\n \"exp\": \"2031-12-31\",\n \"token\": \"sThSWfACWMSp5456\",\n \"order\": 50,\n \"attempt\": {\n \"date\": null,\n \"retries\": 0\n },\n \"lastUsedOn\": null,\n \"status\": \"Active\",\n \"note\": null,\n \"createdOn\": \"2021-06-03 08:26:26\"\n}"}],"_postman_id":"81b7471a-91d4-4154-8134-37b4c8812d4d"},{"name":"Update Exp Date","id":"91e4aaab-df19-4965-abce-0a37198c3673","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"exp\": \"12/30\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//card//change-exp-date","description":"

You can utilize this endpoint to update/change the expiration date of a stored and tokenized card in the Customer vault

\n
IMPORTANT Exp.Date Format [MM/YY]. 12/30
\n

If a specific payment card record is present in the transactional history of a customer we do not allow for it to be deleted. In this case, you can archive the payment card information record.

\n
NOTE We allow a customer's payment card record to be returned to active status from archived - use our Unarchive endpoint.
\n

If you want to return an archived card to an active status use the following:

If a specific payment card is not present in the transactional history of a customer you can delete it.

\n
IMPORTANT You cannot restore a deleted payment card record. If you are unsure of future use we suggest archiving it.
\n

This will return an object of all the billing information records on file for a specific customer in the vault.

Use this endpoint to view a single billing record for a specific customer

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","billing-information",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"d247fad4-c530-4681-95dc-1d7d5284d242","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//billing-information/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 136,\r\n \"firstName\": \"Marty\",\r\n \"lastName\": \"McFly\",\r\n \"address\": \"9303 Lyon Drive\",\r\n \"state\": \"California\",\r\n \"city\": \"Hill Valley\",\r\n \"zip\": \"95420\",\r\n \"country\": \"United States\",\r\n \"archived\": \"No\",\r\n \"createdOn\": \"2022-09-08 21:19:27\"\r\n}"}],"_postman_id":"335bde7e-ab32-4841-9eec-7ce6f543c5d4"},{"name":"Update","id":"e77be49c-de8e-469d-b35f-2f6fc59fd310","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Emmett\",\n \"lastName\": \"Brown\",\n \"state\": \"CA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//billing-information/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","billing-information",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"7d2dbe81-2bc2-40d3-841f-5582ecaa3dd6","name":"Update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Emmett\",\n \"lastName\": \"Brown\",\n \"state\": \"CA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/billing-information/34"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 136,\n \"firstName\": \"Emmett\",\n \"lastName\": \"Brown\",\n \"address\": \"9303 Lyon Drive\",\n \"state\": \"California\",\n \"city\": \"Hill Valley\",\n \"zip\": \"95420\",\n \"country\": \"United States\",\n \"archived\": \"No\",\n \"createdOn\": \"2022-09-08 21:19:27\"\n}"}],"_postman_id":"e77be49c-de8e-469d-b35f-2f6fc59fd310"},{"name":"Create","id":"07bba345-b056-46f9-9a69-5cf1725a9907","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"John\",\r\n \"lastName\":\"Wick\",\r\n \"address\":\"123 Street Name\",\r\n \"city\":\"Los Angeles\",\r\n \"zip\":\"91206\",\r\n \"state\":\"CA\",\r\n \"country\":\"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//billing-information","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","billing-information"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"c01ccdb1-6740-4714-864b-dc2ce03841cf","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Marty\",\r\n \"lastName\":\"McFly\",\r\n \"address\":\"123 Street Name\",\r\n \"city\":\"Los Angeles\",\r\n \"zip\":\"91206\",\r\n \"state\":\"CA\",\r\n \"country\":\"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/billing-information"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"365\",\r\n \"firstName\": \"Marty\",\r\n \"lastName\": \"McFly\",\r\n \"address\": \"123 Street Name\",\r\n \"state\": \"California\",\r\n \"city\": \"Los Angeles\",\r\n \"zip\": \"91206\",\r\n \"country\": \"United States\",\r\n \"archived\": null,\r\n \"createdOn\": null\r\n}"}],"_postman_id":"07bba345-b056-46f9-9a69-5cf1725a9907"}],"id":"f2593879-d6c5-4236-ab86-7f853050d372","description":"

You can use this endpoint for customer billing-related operations in the customer vault. You can create, update, delete, or archive customer billing information.

Billing Information Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID	Integer	Yes	No	Yes
firstName	First name	String	Yes	Yes	No
lastName	Last name	String	Yes	Yes	No
address	Address	String	Yes	Yes	No
state	State `Example: CA, NY, etc...`	String	Yes	No	No
country	Country `Example: US, UK, etc...`	String	Yes	Yes	No
city	City	String	Yes	Yes	No
zip	ZIP code	String	Yes	Yes	No
archived	`Yes` or `No`	ENUM	Yes	No	Yes
createdOn	Datetime of creation	Datetime	Yes	No	Yes

","_postman_id":"f2593879-d6c5-4236-ab86-7f853050d372","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}}},{"name":"Shipping Information","item":[{"name":"List","id":"25d48827-12e7-4342-9834-95771a6bc272","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/ /shipping-information","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault"," ","shipping-information"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"316ece68-15aa-4774-a804-70b48f9f2887","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//shipping-information"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"items\": [\r\n {\r\n \"id\": 28,\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Wick\",\r\n \"address\": \"123 Sesame St\",\r\n \"state\": \"California\",\r\n \"city\": \"Los Angeles\",\r\n \"zip\": \"91206\",\r\n \"country\": \"United States\",\r\n \"note\": \"Example Note\",\r\n \"archived\": \"No\",\r\n \"createdOn\": \"2023-08-07 18:42:36\"\r\n }\r\n}"}],"_postman_id":"25d48827-12e7-4342-9834-95771a6bc272"},{"name":"View","id":"46f88d55-a292-448a-a08d-2a614c7d2385","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//shipping-information/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","shipping-information",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"5699b815-99ea-4f7e-95ef-e60b58cc7884","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//shipping-information/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 28,\n \"firstName\": \"John\",\n \"lastName\": \"Wick\",\n \"address\": \"123 Sesame St\",\n \"state\": \"California\",\n \"city\": \"Los Angeles\",\n \"zip\": \"91206\",\n \"country\": \"United States\",\n \"note\": \"Example Note\",\n \"archived\": \"No\",\n \"createdOn\": \"2023-08-07 18:42:36\"\n}"}],"_postman_id":"46f88d55-a292-448a-a08d-2a614c7d2385"},{"name":"Update","id":"a5240bac-93f3-40cd-a2c2-9cdab0731ba6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Wick\",\n \"state\": \"CA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//shipping-information/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","shipping-information",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"c0d180bc-69b3-4feb-b9a6-3cf6b0ce5f69","name":"Update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"address\":\"111 New Street Name\",\n \"city\": \"San Diego\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//shipping-information/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 28,\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Wick\",\r\n \"address\": \"111 New Street Name\",\r\n \"state\": \"California\",\r\n \"city\": \"San Diego\",\r\n \"zip\": \"91206\",\r\n \"country\": \"United States\",\r\n \"note\": \"Example Note\",\r\n \"archived\": \"No\",\r\n \"createdOn\": \"2023-08-07 18:42:36\"\r\n}"}],"_postman_id":"a5240bac-93f3-40cd-a2c2-9cdab0731ba6"},{"name":"Create","id":"adaff723-4eae-43c3-953c-af5527c0e89b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\":\"John\",\n \"lastName\":\"Wick\",\n \"address\":\"123 Street Name\",\n \"city\":\"Los Angeles\",\n \"zip\":\"91206\",\n \"state\":\"CA\",\n \"country\":\"US\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//shipping-information","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","","shipping-information"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"bbc4ae93-f5ab-40c4-8249-96121a2079b5","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\":\"John\",\n \"lastName\":\"Wick\",\n \"address\":\"123 Street Name\",\n \"city\":\"Los Angeles\",\n \"zip\":\"91206\",\n \"state\":\"CA\",\n \"country\":\"US\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault//shipping-information"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"30\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Wick\",\r\n \"address\": \"1234 Street Name\",\r\n \"state\": \"California\",\r\n \"city\": \"Paris\",\r\n \"zip\": \"91206\",\r\n \"country\": \"United States\",\r\n \"note\": null,\r\n \"archived\": null,\r\n \"createdOn\": null\r\n}"}],"_postman_id":"adaff723-4eae-43c3-953c-af5527c0e89b"}],"id":"54172de7-7b6e-47fa-995d-c113efc210f1","_postman_id":"54172de7-7b6e-47fa-995d-c113efc210f1","description":"","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}}},{"name":"Recurring Payment","item":[{"name":"List","id":"e9f4e748-852d-44ad-bcb8-a73a3426e335","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payments","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","38","recurring-payments"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"221d4651-2172-42cc-b18a-bb559608273e","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payments"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"items\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Monthly subscription\",\r\n \"description\": \"Cinema Membership\",\r\n \"amount\": \"3.11\",\r\n \"execute\": {\r\n \"frequency\": 1,\r\n \"period\": \"month\"\r\n },\r\n \"valid\": {\r\n \"from\": \"2020-01-01\",\r\n \"to\": \"2020-12-31\"\r\n },\r\n \"payment\": {\r\n \"next\": \"2020-02-01\",\r\n \"last\": null,\r\n \"max\": 12,\r\n \"attempt\": {\r\n \"date\": null,\r\n \"retries\": 0\r\n }\r\n },\r\n \"terminal\": {\r\n \"id\": 1\r\n },\r\n \"customer\": {\r\n \"id\": 38,\r\n \"card\": {\r\n \"id\": 1,\r\n \"number\": 4489,\r\n \"token\": \"H3ViuS1XiX9w4489\",\r\n \"exp\": \"2020-12-31\",\r\n \"order\": 50,\r\n \"status\": \"Expired\"\r\n }\r\n },\r\n \"status\": \"Active\",\r\n \"archived\": \"No\"\r\n }\r\n ]\r\n}"}],"_postman_id":"e9f4e748-852d-44ad-bcb8-a73a3426e335"},{"name":"View","id":"56e21551-7a9d-4d2a-bfd8-abf83f5f371d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payment/1","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","38","recurring-payment","1"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"5278361c-98d6-4773-94ef-a94b8e9b7b5e","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payment/1"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"Monthly subscription\",\r\n \"description\": \"Cinema Membership\",\r\n \"amount\": \"3.11\",\r\n \"execute\": {\r\n \"frequency\": 1,\r\n \"period\": \"month\"\r\n },\r\n \"valid\": {\r\n \"from\": \"2020-01-01\",\r\n \"to\": \"2020-12-31\"\r\n },\r\n \"payment\": {\r\n \"next\": \"2020-02-01\",\r\n \"last\": null,\r\n \"max\": 12,\r\n \"attempt\": {\r\n \"date\": null,\r\n \"retries\": 0\r\n }\r\n },\r\n \"terminal\": {\r\n \"id\": 1\r\n },\r\n \"customer\": {\r\n \"id\": 38,\r\n \"card\": {\r\n \"id\": 1,\r\n \"number\": 4489,\r\n \"token\": \"H3ViuS1XiX9w4489\",\r\n \"exp\": \"2020-12-31\",\r\n \"order\": 50,\r\n \"status\": \"Expired\"\r\n }\r\n },\r\n \"status\": \"Active\",\r\n \"archived\": \"No\"\r\n}"}],"_postman_id":"56e21551-7a9d-4d2a-bfd8-abf83f5f371d"},{"name":"Update","id":"4ace814e-2317-484b-a2bc-86bda5f82902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\n \"name\": \"Monthly subscription\",\n \"description\": \"Cinema Membership\",\n \"amount\": \"3.11\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payment/1","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","38","recurring-payment","1"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"2443a0bc-da7c-428e-83e4-45e63b34fe81","name":"Update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\n \"name\": \"Monthly subscription\",\n \"description\": \"Cinema Membership\",\n \"amount\": \"3.11\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payment/1"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"Monthly subscription\",\r\n \"description\": \"Cinema Membership\",\r\n \"amount\": \"3.11\",\r\n \"execute\": {\r\n \"frequency\": 1,\r\n \"period\": \"month\"\r\n },\r\n \"valid\": {\r\n \"from\": \"2020-01-01\",\r\n \"to\": \"2020-12-31\"\r\n },\r\n \"payment\": {\r\n \"next\": \"2020-02-01 00:00:00\",\r\n \"last\": null,\r\n \"max\": 12,\r\n \"attempt\": {\r\n \"date\": null,\r\n \"retries\": 0\r\n }\r\n },\r\n \"terminal\": {\r\n \"id\": 1\r\n },\r\n \"customer\": {\r\n \"id\": 38,\r\n \"card\": {\r\n \"id\": 1,\r\n \"number\": 4489,\r\n \"token\": \"H3ViuS1XiX9w4489\",\r\n \"exp\": \"2020-12-31\",\r\n \"order\": 50,\r\n \"status\": \"Expired\"\r\n }\r\n },\r\n \"status\": \"Active\",\r\n \"archived\": \"No\"\r\n}"}],"_postman_id":"4ace814e-2317-484b-a2bc-86bda5f82902"},{"name":"Create","id":"c07f62df-55b9-47f6-8b5b-fab917d39dd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly subscription\",\n \"description\": \"Cinema Membership\",\n \"amount\": 3,\n \"execute\": {\n \"frequency\": 1,\n \"period\": \"month\"\n },\n \"valid\": {\n \"from\": \"2020-01-01\",\n \"to\": \"2020-12-31\"\n },\n \"payment\": {\n \"max\": 12\n },\n \"terminal\": {\n \"id\": 1\n },\n \"customer\": {\n \"id\": 38,\n \"card\": {\n \"id\": 1\n }\n },\n \"dba\": {\n \"id\": 72\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payment","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}},"urlObject":{"path":["api","customer-vault","38","recurring-payment"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"fa3f15e1-3471-4b80-8b7b-76946d2a6ccf","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly subscription\",\n \"description\": \"Cinema Membership\",\n \"amount\": 3,\n \"execute\": {\n \"frequency\": 1,\n \"period\": \"month\"\n },\n \"valid\": {\n \"from\": \"2020-01-01\",\n \"to\": \"2020-12-31\"\n },\n \"payment\": {\n \"max\": 12\n },\n \"terminal\": {\n \"id\": 1\n },\n \"customer\": {\n \"id\": 38,\n \"card\": {\n \"id\": 1\n }\n },\n \"dba\": {\n \"id\": 72\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/customer-vault/38/recurring-payment"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"1\",\r\n \"name\": \"Monthly subscription\",\r\n \"description\": \"Cinema Membership\",\r\n \"amount\": \"3.00\",\r\n \"execute\": {\r\n \"frequency\": 1,\r\n \"period\": \"month\"\r\n },\r\n \"valid\": {\r\n \"from\": \"2020-01-01\",\r\n \"to\": \"2020-12-31\"\r\n },\r\n \"payment\": {\r\n \"next\": \"2020-02-01 00:00:00\",\r\n \"last\": null,\r\n \"max\": 12,\r\n \"attempt\": {\r\n \"date\": null,\r\n \"retries\": null\r\n }\r\n },\r\n \"terminal\": {\r\n \"id\": 1\r\n },\r\n \"customer\": {\r\n \"id\": 38,\r\n \"card\": {\r\n \"id\": 1,\r\n \"number\": 4489,\r\n \"token\": \"H3ViuS1XiX9w4489\",\r\n \"exp\": \"2020-12-31\",\r\n \"order\": 50,\r\n \"status\": \"Expired\"\r\n }\r\n },\r\n \"status\": null,\r\n \"archived\": null\r\n}"}],"_postman_id":"c07f62df-55b9-47f6-8b5b-fab917d39dd2"}],"id":"771af592-d4ad-45dd-b578-db2eff9d36d9","description":"

Recurring Payments

Easily and securely set up billing that occurs at specific intervals. If you have a customer that decides to opt for recurring billing, the system can set up an order that recurs at the decided period and automatically uses the customer's payment details to process subsequent payments.

The recurring transaction can be set with its own start and end date and time, billing frequency (complete freedom with cron expressions) and total number of payments. When recurring is configured for a customer in the system, a new transaction is sent on the set date for every billing cycle for the requested duration, without any customer or merchant intervention.

\n","_postman_id":"771af592-d4ad-45dd-b578-db2eff9d36d9","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213","id":"2165816b-ad07-4118-a06b-0311d11ff213","name":"CustomerVault","type":"folder"}}}],"id":"2165816b-ad07-4118-a06b-0311d11ff213","description":"

Customer Vault securely stores sensitive customer billing information, allowing subsequent transactions to be processed without the need for you to recollect the information or store it on your own system. This makes for a quick and simple billing process.

The Customer Vault API offers the following capabilities:

Create and modify customer profiles.
Securely store customer payment information, such as card numbers, in the Customer Cards, and link it to the customer profile.
Store multiple payment cards for each customer.
Use tokens to process transactions.

You can create, update, and delete customer information from the customer vault.

Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the customer	Integer	Yes	No	Yes
dba	DBA Object	Object	No	Yes	No
dba.id	ID	Integer	Yes	Yes	No
firstName	First name	String	Yes	No	No
lastName	Last name	String	Yes	No	No
company	Company	String	Yes	No	No
email	Email	String	Yes	Yes	No
website	Website	String	No	No	No
phone	Phone	String	Yes	Yes	No
altPhone	Alt phone	String	No	No	No
identificator	Internal customer ID on the merchants platform	String	Yes	Yes	No
description	Description	String	No	No	No
archived	`Yes` or `No`	ENUM	Yes	No	Yes
updatedOn	Datetime of last update	Datetime	Yes	No	Yes
createdOn	Datetime of creation	Datetime	Yes	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"2165816b-ad07-4118-a06b-0311d11ff213"},{"name":"Reporting","item":[{"name":"Authorizations","item":[{"name":"List","id":"e8a95f91-66bb-4ad9-9f07-80592eb94a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/authorizations/","description":"

\n
IMPORTANT If no date is specified in the request as a filter we will return authorizations for the last 5 days from the current date.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"4c3c3ead-05b2-4236-bc58-9aa21b2b45c4","id":"4c3c3ead-05b2-4236-bc58-9aa21b2b45c4","name":"Authorizations","type":"folder"}},"urlObject":{"path":["api","reporting","authorizations",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"00879fcc-3a3a-44a7-a4f5-d7dcd6a1b053","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/authorizations/9"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": \"22376031\",\n \"card\": {\n \"number\": \"473702XXXXXX6363\",\n \"bin\": {\n \"bin\": \"473702\",\n \"brand\": \"Visa\",\n \"organization\": \"Wells Fargo Bank, N.a.\",\n \"type\": \"Debit\",\n \"category\": \"Classic\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n }\n },\n \"amount\": \"0.01\",\n \"type\": \"Credit\",\n \"terminal\": {\n \"id\": \"14\",\n \"number\": 7000\n },\n \"date\": \"2020-03-24 00:10:26\",\n \"status\": \"Successful approval/completion\"\n },\n {\n \"id\": \"22375683\",\n \"card\": {\n \"number\": \"443048XXXXXX5662\",\n \"bin\": {\n \"bin\": \"443048\",\n \"brand\": \"Visa\",\n \"organization\": \"Pnc Bank, N.a.\",\n \"type\": \"Debit\",\n \"category\": \"Classic\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n }\n },\n \"amount\": \"29.99\",\n \"type\": \"Debit\",\n \"terminal\": {\n \"id\": \"14\",\n \"number\": 7000\n },\n \"date\": \"2020-03-24 00:31:25\",\n \"status\": \"Successful approval/completion\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/authorizations/1?page=1\"\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"e8a95f91-66bb-4ad9-9f07-80592eb94a34"},{"name":"List with Filters","id":"e2c05b1d-d55c-4f92-98b4-0cc2091f1f31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/authorizations/?filter[card.bin.brand]=Visa&filter[terminal.number]=7000&filter[date][gte]=2020-03-24 00:00:00&filter[date][lte]=2020-03-24 23:59:59","description":"

Example request to list all authorizations for a specific dbaId, card.bin.brand.visa and terminal.number between a date range

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"4c3c3ead-05b2-4236-bc58-9aa21b2b45c4","id":"4c3c3ead-05b2-4236-bc58-9aa21b2b45c4","name":"Authorizations","type":"folder"}},"urlObject":{"path":["api","reporting","authorizations",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[{"key":"filter[card.bin.brand]","value":"Visa"},{"key":"filter[terminal.number]","value":"7000"},{"key":"filter[date][gte]","value":"2020-03-24 00:00:00"},{"key":"filter[date][lte]","value":"2020-03-24 23:59:59"}],"variable":[]}},"response":[{"id":"46ee7870-8051-4fdb-80ed-073dea53fce3","name":"List with Filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dashboard.dashboard.paysecureonline.com/api/reporting/authorizations/9?filter[card.bin.brand]=Visa&filter[terminal.number]=7000&filter[date][gte]=2020-03-24 00:00:00&filter[date][lte]=2020-03-24 23:59:59","host":["https://dashboard.dashboard.paysecureonline.com"],"path":["api","reporting","authorizations","9"],"query":[{"key":"filter[card.bin.brand]","value":"Visa"},{"key":"filter[terminal.number]","value":"7000"},{"key":"filter[date][gte]","value":"2020-03-24 00:00:00"},{"key":"filter[date][lte]","value":"2020-03-24 23:59:59"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": \"22375683\",\n \"card\": {\n \"number\": \"443048XXXXXX5662\",\n \"bin\": {\n \"bin\": \"443048\",\n \"brand\": \"Visa\",\n \"organization\": \"Pnc Bank, N.a.\",\n \"type\": \"Debit\",\n \"category\": \"Classic\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n }\n },\n \"amount\": \"0.01\",\n \"type\": \"Credit\",\n \"terminal\": {\n \"id\": \"14\",\n \"number\": 7000\n },\n \"date\": \"2020-03-24 00:31:25\",\n \"status\": \"Successful approval/completion\"\n },\n {\n \"id\": \"22375518\",\n \"card\": {\n \"number\": \"453825XXXXXX9026\",\n \"bin\": {\n \"bin\": \"453825\",\n \"brand\": \"Visa\",\n \"organization\": \"Bank Of Nova Scotia\",\n \"type\": \"Credit\",\n \"category\": \"Business\",\n \"country\": {\n \"name\": \"Canada\",\n \"code\": \"CA\"\n }\n }\n },\n \"amount\": \"0.01\",\n \"type\": \"Credit\",\n \"terminal\": {\n \"id\": \"14\",\n \"number\": 7000\n },\n \"date\": \"2020-03-24 00:50:42\",\n \"status\": \"Successful approval/completion\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/authorizations/1?filter%5Bcard.bin.brand%5D=Visa&filter%5Bterminal.number%5D=7000&filter%5Bdate%5D%5Bgte%5D=2020-03-24+00%3A00%3A00&filter%5Bdate%5D%5Blte%5D=2020-03-24+23%3A59%3A59&page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"e2c05b1d-d55c-4f92-98b4-0cc2091f1f31"}],"id":"4c3c3ead-05b2-4236-bc58-9aa21b2b45c4","description":"

Returns a list of all authorizations for a specific dba.id

\n
IMPORTANT If no date is specified in the request as a filter we will return authorizations for the last 5 days from the current date.
\n

Authorizations Object

Fields	Description	Type	Filterable	Required	Readonly
id	Auth Identification Number	Integer	No	No	Yes
card	Card details	Object	No	No	Yes
card.number	Card number	Integer	Yes	No	Yes
card.bin	BIN Object	Object	No	No	Yes
card.bin.bin	Bank Identification Number	Integer	Yes	No	Yes
card.bin.brand	Brand of the card	String	Yes	No	Yes
card.bin.type	`Debit`, `Credit` or `ChargeCard`	ENUM	No	No	Yes
card.bin.category	Category of the card	String	No	No	Yes
card.bin.organization	Organization	String	No	No	Yes
card.bin.country	Country	Object	No	No	Yes
card.bin.country.name	Name of the country	String	No	No	Yes
card.bin.country.code	ISO Code of the country	String	No	No	Yes
amount	Authorized amount	Number	No	No	Yes
type	`Debit`, `Credit` or `PIN Debit`	ENUM	Yes	No	Yes
terminal	Terminal details	Object	No	No	Yes
terminal.id	Terminal system id	Integer	No	No	Yes
terminal.number	Terminal Identification Number	Integer	Yes	No	Yes
date	Datetime of the authorization	Datetime	Yes	No	Yes
status	Authorization Status	ENUM	Yes	No	Yes

Authorization Statuses

Below you can find some of the most common authorization statuses:

\n
Keep in mind that we may return other statuses as well this is just for your quick reference.
\n

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

Status	Description
Successful approval/completion	The authorization has been successfully approved
Insufficient funds	The authorization was declined due to insufficient funds on the card
Do not honor	The authorization has been completely rejected by the issuing bank
Pick up card	The authorization has been Pick up card and needs to be held if possible. (Usually a stolen card)
Refer to Issuer	The authorization has been declined. The customer should contact their bank for more information
Invalid account number	The authorization has been declined. The card number has been incorrectly entered

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"4c3c3ead-05b2-4236-bc58-9aa21b2b45c4"},{"name":"Batches","item":[{"name":"List","id":"e38d3eb4-5dfb-487d-8d5f-708c1719eaf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/","description":"

Use this endpoint to list all the batches for a specific dba.id

\n
IMPORTANT If no batch.date is specified in the request as a filter we will return results for the last 5 days from the current date.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"43c78142-56ba-4236-98f1-1b5756e805a4","id":"43c78142-56ba-4236-98f1-1b5756e805a4","name":"Batches","type":"folder"}},"urlObject":{"path":["api","reporting","batches",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"eeb36728-7b6d-4fb6-8877-2b940efec613","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/9"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 123456789,\n \"card\": {\n \"number\": \"531269******0736\",\n \"bin\": {\n \"bin\": 531259,\n \"brand\": \"Mastercard\",\n \"organization\": \"Bank Of America, National Association\",\n \"type\": \"Debit\",\n \"category\": \"Enhanced\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n }\n },\n \"amount\": \"10.00\",\n \"adjustment\": \"0.00\",\n \"type\": \"credit\",\n \"referenceNumber\": \"12345693222900012481321\",\n \"purchaseId\": SSS-2023032405742994,\n \"terminal\": null,\n \"batch\": {\n \"id\": xxxxxxx,\n \"date\": \"2020-03-22\"\n },\n \"date\": \"2020-03-22\"\n },\n {\n \"id\": 123456790,\n \"card\": {\n \"number\": \"483312******8992\",\n \"bin\": {\n \"bin\": 483312,\n \"brand\": \"Visa\",\n \"organization\": \"Jpmorgan Chase Bank, N.a.\",\n \"type\": \"Debit\",\n \"category\": \"Classic\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n }\n },\n \"amount\": \"100.00\",\n \"adjustment\": \"0.00\",\n \"type\": \"debit\",\n \"referenceNumber\": \"123456213222900012457999\",\n \"purchaseId\": null,\n \"terminal\": null,\n \"batch\": {\n \"id\": xxxxxxx,\n \"date\": \"2020-03-22\"\n },\n \"date\": \"2020-03-22\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/56921?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/56921?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/56921?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"e38d3eb4-5dfb-487d-8d5f-708c1719eaf9"},{"name":"List with Filters","id":"643543e4-b0a6-48e0-870d-ee9bbde50b16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/?filter[card.bin.brand]=Visa&filter[terminal.number]=7000&filter[date][gte]=2020-03-24 00:00:00&filter[date][lte]=2020-03-24 23:59:59","description":"

Example request to list all the transactions the are included in a batch for a specific date

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"43c78142-56ba-4236-98f1-1b5756e805a4","id":"43c78142-56ba-4236-98f1-1b5756e805a4","name":"Batches","type":"folder"}},"urlObject":{"path":["api","reporting","batches",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[{"key":"filter[card.bin.brand]","value":"Visa"},{"key":"filter[terminal.number]","value":"7000"},{"key":"filter[date][gte]","value":"2020-03-24 00:00:00"},{"key":"filter[date][lte]","value":"2020-03-24 23:59:59"}],"variable":[]}},"response":[{"id":"efef117d-1a0f-4f99-80a0-eb388b440f04","name":"List with Filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/1?filter[batch.date]=2020-03-22","host":["https://dashboard.dashboard.paysecureonline.com"],"path":["api","reporting","batches","1"],"query":[{"key":"filter[batch.date]","value":"2020-03-22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\n \"items\": [\n {\n \"id\": \"17385312\",\n \"card\": {\n \"number\": \"531259XXXXXX0736\",\n \"bin\": {\n \"bin\": \"531259\",\n \"brand\": \"Mastercard\",\n \"organization\": \"Bank Of America, National Association\",\n \"type\": \"Debit\",\n \"category\": \"Enhanced\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n }\n },\n \"amount\": -0.01,\n \"adjustment\": 0,\n \"type\": \"credit\",\n \"purchaseId\": \"SSS-2023032405742994\",\n \"terminal\": {\n \"vNumber\": null,\n \"id\": null,\n \"number\": null\n },\n \"batch\": {\n \"id\": \"xxxxxxx\",\n \"date\": \"2020-03-22\"\n },\n \"date\": \"2020-03-22\"\n },\n {\n \"id\": \"17385309\",\n \"card\": {\n \"number\": \"483312XXXXXX8992\",\n \"bin\": {\n \"bin\": \"483312\",\n \"brand\": \"Visa\",\n \"organization\": \"Jpmorgan Chase Bank, N.a.\",\n \"type\": \"Debit\",\n \"category\": \"Classic\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n }\n },\n \"amount\": -0.11,\n \"adjustment\": 0,\n \"type\": \"credit\",\n \"purchaseId\": \"SSS-54552405742994\",\n \"terminal\": {\n \"vNumber\": null,\n \"id\": null,\n \"number\": null\n },\n \"batch\": {\n \"id\": \"xxxxxxx\",\n \"date\": \"2020-03-22\"\n },\n \"date\": \"2020-03-22\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/batches/14?page=1\"\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"643543e4-b0a6-48e0-870d-ee9bbde50b16"},{"name":"Summary","id":"f6b7d808-a517-4434-b81f-c044c348437f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/batch-summary// or ","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"43c78142-56ba-4236-98f1-1b5756e805a4","id":"43c78142-56ba-4236-98f1-1b5756e805a4","name":"Batches","type":"folder"}},"urlObject":{"path":["api","reporting","batch-summary",""," or "],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"eb48f197-e14a-4613-810d-f01163f0f0cf","name":"Summary","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/batch-summary/9/r8nV0N"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"debit\": \"62684.00\",\n \"credit\": \"-1642.00\",\n \"date\": \"2023-03-24\",\n \"amount\": 61042,\n \"id\": \"r8nV0N\"\n}"}],"_postman_id":"f6b7d808-a517-4434-b81f-c044c348437f"}],"id":"43c78142-56ba-4236-98f1-1b5756e805a4","description":"

View batches for a specific dbaId. You can view the full batch summary for a specific date or ID and also all the transactions that are included in that batch.

\n
IMPORTANT If no batch.date is specified in the request as a filter we will return results for the last 5 days from the current date.
\n

Batch Object

Fields	Description	Type	Filterable	Required	Readonly
id	Batch Identification Number	Integer	No	No	Yes
card	Card details	Object	No	No	Yes
card.number	Card number	Integer	Yes	No	Yes
card.bin	BIN Objecct	Objecct	No	No	Yes
card.bin.bin	Bank Identification Number	Integer	No	No	Yes
card.bin.brand	Brand of the card	String	Yes	No	Yes
card.bin.type	`Debit`, `Credit` or `ChargeCard`	ENUM	No	No	Yes
card.bin.category	Category of the card	String	No	No	Yes
card.bin.organization	Organization	String	No	No	Yes
card.bin.country	Country	Object	No	No	Yes
card.bin.country.name	Name of the country	String	No	No	Yes
card.bin.country.code	ISO Code of the country	String	No	No	Yes
amount	Captured amount	Number	Yes	No	Yes
adjustment	The adjusted amount between authorized and captured (Tip amount)	Number	No	No	Yes
type	`Debit` (sale) оr`Credit`(refund) transaction	ENUM	Yes	No	Yes
terminal	Terminal details	Object	No	No	Yes
terminal.vNumber	Terminal V#	Integer	Yes	No	Yes
terminal.id	Terminal System ID	Integer	No	No	Yes
terminal.number	Terminal Identification Number	Integer	Yes	No	Yes
batch	Batch details	Object	No	No	Yes
batch.id	Batch ID	String	Yes	No	Yes
batch.date	Batch date	Date	Yes	No	Yes
date	Date of the transaction	Date	Yes	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"43c78142-56ba-4236-98f1-1b5756e805a4"},{"name":"Payouts","item":[{"name":"List","id":"5c53dded-c7c6-4585-b012-22da661e08c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/payout/acq/?filter[processingDate][gte]=2023-04-01&filter[processingDate][lte]=2023-04-30","description":"

\n
NOTE Keep in mind that running this request without specifying a processingDate filter will return all available records for the current month
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"1242019f-6dd1-4b2c-82d5-f0450a56c408","id":"1242019f-6dd1-4b2c-82d5-f0450a56c408","name":"Payouts","type":"folder"}},"urlObject":{"path":["api","reporting","payout","acq",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[{"key":"filter[processingDate][gte]","value":"2023-04-01"},{"key":"filter[processingDate][lte]","value":"2023-04-30"}],"variable":[]}},"response":[{"id":"09746aa1-fc2c-4213-8bb2-2ae1bb9dfb48","name":"List with Date Range","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dashboard.dashboard.paysecureonline.com/api/reporting/payouts/acq/9?filter[processingDate][gte]=2023-04-01&filter[processingDate][lte]=2023-04-30","host":["https://dashboard.dashboard.paysecureonline.com"],"path":["api","reporting","payouts","acq","9"],"query":[{"key":"filter[processingDate][gte]","value":"2023-04-01"},{"key":"filter[processingDate][lte]","value":"2023-04-30"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"processingDate\": \"2023-04-12\",\n \"deposit\": 9731.14,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-12\",\n \"amount\": \"9731.14\"\n }\n },\n {\n \"processingDate\": \"2023-04-11\",\n \"deposit\": 11717.87,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-11\",\n \"amount\": \"11717.87\"\n }\n },\n {\n \"processingDate\": \"2023-04-10\",\n \"deposit\": 10473.83,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-10\",\n \"amount\": \"10473.83\"\n }\n },\n {\n \"processingDate\": \"2023-04-09\",\n \"deposit\": 5779.3,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-09\",\n \"amount\": \"8881.54\"\n }\n },\n {\n \"processingDate\": \"2023-04-07\",\n \"deposit\": 10971.79,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-07\",\n \"amount\": \"10971.79\"\n }\n },\n {\n \"processingDate\": \"2023-04-06\",\n \"deposit\": 12333.28,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-06\",\n \"amount\": \"12333.28\"\n }\n },\n {\n \"processingDate\": \"2023-04-05\",\n \"deposit\": 13538.1,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-05\",\n \"amount\": \"13538.10\"\n }\n },\n {\n \"processingDate\": \"2023-04-04\",\n \"deposit\": 15223,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-04\",\n \"amount\": \"15223.00\"\n }\n },\n {\n \"processingDate\": \"2023-04-03\",\n \"deposit\": 18818.1,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-03\",\n \"amount\": \"18818.10\"\n }\n },\n {\n \"processingDate\": \"2023-04-02\",\n \"deposit\": 17091.86,\n \"feeTotalAmount\": 0,\n \"chargeback\": {\n \"totalCount\": 0,\n \"totalAmount\": 0\n },\n \"reservedAmount\": 0,\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-02\",\n \"amount\": \"27719.63\"\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/payouts/acq/9?filter%5BprocessingDate%5D%5Bgte%5D=2023-04-01&filter%5BprocessingDate%5D%5Blte%5D=2023-04-30&page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/payouts/acq/9?filter%5BprocessingDate%5D%5Bgte%5D=2023-04-01&filter%5BprocessingDate%5D%5Blte%5D=2023-04-30&page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/payouts/acq/9?filter%5BprocessingDate%5D%5Bgte%5D=2023-04-01&filter%5BprocessingDate%5D%5Blte%5D=2023-04-30&page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 10,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"5c53dded-c7c6-4585-b012-22da661e08c7"},{"name":"View","id":"36b716de-fa3a-42cd-8a27-9dc74c44bf11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/payout/acq//","description":"

View detailed payout information for a specific date

Payouts View Object

Fields	Description	Type	Filterable	Required	Readonly
processingDate	Date	Date	Yes	Yes	Yes
deposit	Deposit Amount	Number	No	No	Yes
fees	Fee Object	Object	No	No	Yes
fees.items	Fees Items Object	Object	No	No	Yes
fees.items.cardType	Fee Card Type	String	No	No	Yes
fees.items.amount	Fee Amount	Number	No	No	Yes
fees.totalAmount	Fees Total Amount	Number	No	No	Yes
chargebacks	Chargebacks Object	Object	No	No	Yes
chargebacks.items	Chargebacks Items Object	Object	No	No	Yes
chargebacks.items.referenceNumber	Chargeback Reference Number	String	No	No	Yes
chargebacks.items.amount	Chargeback Amount	Number	No	No	Yes
chargebacks.totalCount	Chargebacks Total Count	Integer	No	No	Yes
chargebacks.totalAmount	Chargebacks Amount	Number	No	No	Yes
reservedFunding	Reserved Funding Object	Object	No	No	Yes
reservedFunding.items	Reserved Funding Items Object	Object	No	No	Yes
reservedFunding.items.department	Reserve Department	String	No	No	Yes
reservedFunding.items.amount	Reserve Amount	Number	No	No	Yes
reservedFunding.totalAmount	Reserved Funding Amount	Number	No	No	Yes
releasedAmount	Released Amount	Number	No	No	Yes
batch	Batch Object	Object	No	No	Yes
batch.date	Batch Date	Date	No	No	Yes
batch.amount	Batch Amount	Number	No	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"1242019f-6dd1-4b2c-82d5-f0450a56c408","id":"1242019f-6dd1-4b2c-82d5-f0450a56c408","name":"Payouts","type":"folder"}},"urlObject":{"path":["api","reporting","payout","acq","",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"65f2405f-9a08-4fe6-84d1-adace4c2c2e1","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/payouts/acq/1/2023-04-05"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"processingDate\": \"2023-04-05\",\n \"deposit\": 732.79,\n \"fees\": {\n \"items\": [\n {\n \"cardType\": \"MASTERCARD\",\n \"amount\": \"0.24\"\n },\n {\n \"cardType\": \"MC DEBIT\",\n \"amount\": \"17.34\"\n },\n {\n \"cardType\": \"VISA\",\n \"amount\": \"1.00\"\n },\n {\n \"cardType\": \"VISA DEBIT\",\n \"amount\": \"3.37\"\n }\n ],\n \"totalAmount\": 21.95\n },\n \"chargebacks\": {\n \"items\": [\n {\n \"referenceNumber\": \"0000090001705578\",\n \"amount\": \"-39.95\"\n }\n ],\n \"totalCount\": 1,\n \"totalAmount\": -39.95\n },\n \"reservedFunding\": {\n \"items\": [\n {\n \"department\": \"RISK - AXIOM\",\n \"amount\": \"83.86\"\n }\n ],\n \"totalAmount\": 83.86\n },\n \"releasedAmount\": 0,\n \"batch\": {\n \"date\": \"2023-04-05\",\n \"amount\": \"1212.05\"\n }\n }\n ],\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"36b716de-fa3a-42cd-8a27-9dc74c44bf11"},{"name":"Export","id":"6a026d5d-b90a-44eb-8c2f-2cb5f2b0ed77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"DepositExport\",\r\n \"params\": {\r\n \"format\": \"csv\",\r\n \"from\": \"2023-04-01\",\r\n \"to\": \"2023-04-10\",\r\n \"merchantAccountId\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/request","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"1242019f-6dd1-4b2c-82d5-f0450a56c408","id":"1242019f-6dd1-4b2c-82d5-f0450a56c408","name":"Payouts","type":"folder"}},"urlObject":{"path":["api","reporting","request"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"ef2d0587-1e7c-42aa-8f5d-cf703e65e1db","name":"Export","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"DepositExport\",\n \"params\": {\n \"format\": \"csv\",\n \"from\": \"2023-04-01\",\n \"to\": \"2023-04-10\",\n \"merchantAccountId\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/request"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1\n}"}],"_postman_id":"6a026d5d-b90a-44eb-8c2f-2cb5f2b0ed77"}],"id":"1242019f-6dd1-4b2c-82d5-f0450a56c408","description":"

You can utilize this endpoint to list all payout information for a specific dba.Id

Payouts List Object

Fields	Description	Type	Filterable	Required	Readonly
processingDate	Date	Date	Yes	No	Yes
deposit	Deposit Amount	Number	No	No	Yes
feeTotalAmount	Fee Amount	Number	No	No	Yes
chargeback	Chargeback Object	Object	No	No	Yes
chargeback.totalCount	Chargeback Count	Integer	No	No	Yes
chargeback.totalAmount	Chargeback Amount	Number	No	No	Yes
reservedAmount	Reserve Amount	Number	No	No	Yes
releasedAmount	Released Amount	Number	No	No	Yes
batch	Batch Object	Object	No	No	Yes
batch.date	Batch Date	Date	No	No	Yes
batch.amount	Batch Amount	Number	No	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"1242019f-6dd1-4b2c-82d5-f0450a56c408"},{"name":"Chargebacks","item":[{"name":"Disputes","item":[{"name":"Upload a temporary file","id":"6922be66-fde5-44d9-a96e-4257bfeeef2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload/temporary","description":"

In order to upload a temporary file and submit a dispute to a chargeback case you need to utilize our standard Attachments endpoint and pass an additional URL parameter temporary

\n","urlObject":{"path":["api","attachment","upload","temporary"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"7b4ff519-6b14-4b96-b389-78e2f5ce7abf","name":"Upload a temporary file","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","src":"7L-_Am9Yd/disputeinfo.pdf"}]},"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload/temporary"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"47c2fd1ebac89e2d5244b847c9b869fb\",\n \"name\": \"disputeinfo.pdf\",\n \"type\": \"application/pdf\",\n \"size\": 245311\n}"}],"_postman_id":"6922be66-fde5-44d9-a96e-4257bfeeef2f"},{"name":"Create a Dispute","id":"641b0719-9d81-4e24-89f1-3cbd8684eaa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback//dispute//create","description":"

After uploading the file/files you need to create the dispute by assigning all the temporary attachment.id to the case.id.

\n","urlObject":{"path":["api","reporting","chargeback","","dispute","","create"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"52865580-0a51-4e02-863f-e209732c26e3","name":"Create a Dispute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\"47c2fd1ebac89e2d5244b847c9b869fb\"]","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback/5545/dispute/6233665/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"disputeId\": \"2023101033545_20230516123226\"\n}"}],"_postman_id":"641b0719-9d81-4e24-89f1-3cbd8684eaa6"},{"name":"Preview","id":"d13559e2-2d0b-4551-95dc-cfac7cb6be5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback//dispute//preview/","description":"

Use this endpoint if you want to preview your dispute before submitting it.

\n","urlObject":{"path":["api","reporting","chargeback","","dispute","","preview",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"0c9c7183-0c4a-4e04-864c-8ea88faadf3f","name":"Preview","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback/5545/dispute/6233665/preview/2023101033545_20230516123226"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d13559e2-2d0b-4551-95dc-cfac7cb6be5e"},{"name":"Submit","id":"408cfbce-d584-4232-9be2-a4f74ad354be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback//dispute//submit/","description":"

Use this endpoint to submit your dispute

\n","urlObject":{"path":["api","reporting","chargeback","","dispute","","submit",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"f154fa75-91d9-411e-973d-f8e12d66469d","name":"Submit","originalRequest":{"method":"POST","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback/5545/dispute/6233665/submit/2023101033545_20230516123226"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5336147,\n \"name\": \"IN_5671_CASES_2023101033545_20230516123226.pdf\",\n \"type\": \"application/pdf\",\n \"size\": 16616,\n \"createdOn\": \"2023-05-16 12:34:37\"\n}"}],"_postman_id":"408cfbce-d584-4232-9be2-a4f74ad354be"}],"id":"0fb9e10b-9d57-49ca-8bcd-13a5291d42b9","description":"

By utilizing this endpoint you can dispute specific chargeback cases.

The process is as follows:

First, use our standard Attachments endpoint but you need to pass an additional URL parameter temporary. This will return a unique id.
After you have your temporary file id you can create the Dispute for a specific chargeback.id and the desired case.id.

You can see the examples below

\n","_postman_id":"0fb9e10b-9d57-49ca-8bcd-13a5291d42b9"},{"name":"List","id":"43ba5f86-b6b4-4c27-bf4a-07df32c8a709","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargebacks","description":"

You can utilize this endpoint to list all chargebacks

\n","urlObject":{"path":["api","reporting","chargebacks"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"ddccc17c-f436-4b10-955a-311d1b2fc5d7","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargebacks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 5545,\n \"dba\": {\n \"id\": 9\n },\n \"type\": \"Chargeback\",\n \"amount\": \"39.00\",\n \"card\": {\n \"number\": \"434257******9716\",\n \"brand\": \"Visa\"\n },\n \"date\": {\n \"posted\": \"2023-04-06\",\n \"loaded\": \"2023-04-12\",\n \"lastLoaded\": \"2023-04-12\",\n \"disputed\": \"2023-04-13 17:44:59\"\n },\n \"fraud\": \"Yes\",\n \"attention\": \"Yes\",\n \"status\": \"Lost\"\n },\n {\n \"id\": 5528,\n \"dba\": {\n \"id\": 9\n },\n \"type\": \"Chargeback\",\n \"amount\": \"39.00\",\n \"card\": {\n \"number\": \"402347******9171\",\n \"brand\": \"Visa\"\n },\n \"date\": {\n \"posted\": \"2023-04-09\",\n \"loaded\": \"2023-04-12\",\n \"lastLoaded\": \"2023-04-12\",\n \"disputed\": \"2023-04-13 17:49:00\"\n },\n \"fraud\": \"Yes\",\n \"attention\": \"Yes\",\n \"status\": \"Lost\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com//api/reporting/chargebacks?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com//api/reporting/chargebacks?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com//api/reporting/chargebacks?page=1\"\n },\n \"next\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com//api/reporting/chargebacks?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"43ba5f86-b6b4-4c27-bf4a-07df32c8a709"},{"name":"View","id":"dd53a8cf-9d53-4c4c-9c14-71d9327abc2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback/","description":"

By utilizing this endpoint you can view detailed information for a specific chargeback

Fields	Description	Type
id	The unique ID that is assigned by our system to every case.	Integer
dba	Object	Object
dba.id	The ID of the DBA	Integer
mid	The Merchant Identification Number (MID)	Integer
merchantRefId	A reference number provided by the merchant or their vendor for this transaction.	String
merchantEmail	Merchant email address	String
type	`Chargeback` or `Retrieval`	ENUM
visaRDR	`Yes` or `No` - Identifies if the chargeback is Visa RDR	ENUM
authCode	The authorization code passed with the settlement record	String
acquirerReferenceNumber	An identification number for a credit card transaction assigned by the acquirer.	Object
gateway	Object	Object
gateway.id	If using our internal gateway this is the unique payment ID that is assigned to every transaction	Integer
gateway.externalID	If using our internal gateway this is the externalID of the transaction	Integer
amount	The amount of the retrieval or chargeback. This is not always equal to the amount of the transaction.	Number
transaction	Object	Object
transaction.id	The unique payment ID that is assigned per transaction from the system.	String
transaction.amount	The original transaction amount or case amount if unable to find the original transaction	Number
transaction.date	Transaction Date	Date
transaction.card	Object	Object
transaction.card.brand	Card Brand	String
transaction.card.number	Card Number	String
transaction.reason	Object	Object
transaction.reason.code	Transaction Auth reason code	String
transaction.reason.description	Transaction Auth reason description	String
date	Object	Object
date.posted	The post date as reported by the issuer.	Date
date.loaded	The date the retrieval request or chargeback was loaded in the system.	Date
date.lastLoaded	The date of the last case loaded in the system for the chargeback.	Date
date.disputed	Date when the dispute was submitted.	Date
date.receivedDate	Date the retrieval request or chargeback was submitted by the Issuer.	Date
date.lastActionDate	Date the case needs to be resolved.	Date
reason	Object	Object
reason.code	Chargeback reason code	String
reason.description	Chargeback reason description	String
fraud	`Yes` or `No`	ENUM
attention	`Yes` or `No` If the merchant's attention is required	ENUM
cases	Array of objects	Array
cases.id	Unique case ID assigned by our system	Integer
cases.type	`Chargeback` or `Retrieval`	ENUM
cases.number	Unique case number assigned by the external system(bank)	Integer
cases.description	Case description	String
cases.date	Object	Object
cases.date.loaded	The date the case was loaded in the system.	Date
cases.date.disputed	The date and time of the last dispute uploaded to the case	Datetime
cases.fraud	`Yes` or `No` if the case is considered fraud	ENUM
cases.attention	`Yes` or `No` if the case requires merchants' attention	ENUM
cases.status	`Processed`, `Won`, `Lost`	ENUM
cases.attachments	Array of objects listing information for the last uploaded dispute	Array
status	`Processed`, `Won`, `Lost`	ENUM

","urlObject":{"path":["api","reporting","chargeback",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"90dab0f4-de75-4e46-9a88-fb2e3c1479b1","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/chargeback/5545"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5545,\n \"dba\": {\n \"id\": 9\n },\n \"mid\": 40111950369,\n \"merchantRefId\": \"SSS-2023040518402732\",\n \"merchantEmail\": \"\",\n \"type\": \"Chargeback\",\n \"visaRDR\": \"No\",\n \"authCode\": \"049684\",\n \"acquirerReferenceNumber\": \"12345063096900012627661\",\n \"gateway\": {\n \"id\": null,\n \"externalId\": null\n },\n \"amount\": \"39.00\",\n \"transaction\": {\n \"id\": \"445595672279437\",\n \"amount\": \"39.00\",\n \"date\": \"2023-04-06\",\n \"card\": {\n \"number\": \"434257******9716\",\n \"brand\": \"Visa\"\n },\n \"reason\": null\n },\n \"date\": {\n \"posted\": \"2023-04-06\",\n \"loaded\": \"2023-04-12\",\n \"lastLoaded\": \"2023-04-12\",\n \"disputed\": \"2023-04-13 17:44:59\",\n \"receivedDate\": \"2023-04-11\",\n \"lastActionDate\": \"2023-05-07\"\n },\n \"reason\": {\n \"code\": \"10.4\",\n \"description\": \"Fraud Card Absent Environment\"\n },\n \"fraud\": \"Yes\",\n \"attention\": \"Yes\",\n \"cases\": [\n {\n \"id\": 6233665,\n \"type\": \"Chargeback\",\n \"number\": 2023102015720,\n \"description\": \"Visa Allocation case loaded into the system\",\n \"reason\": {\n \"code\": \"10.4\",\n \"description\": \"Fraud Card Absent Environment\"\n },\n \"date\": {\n \"loaded\": \"2023-04-12\",\n \"disputed\": null,\n \"receivedDate\": \"2023-04-11\",\n \"lastActionDate\": \"2023-05-07\"\n },\n \"fraud\": \"Yes\",\n \"attention\": \"Yes\",\n \"status\": \"Lost\",\n \"attachments\": []\n }\n ],\n \"status\": \"Lost\"\n}"}],"_postman_id":"dd53a8cf-9d53-4c4c-9c14-71d9327abc2e"}],"id":"e9df78d2-c281-42c8-a0c8-fa2e0abd84d9","description":"

You can use this endpoint to manage all chargeback-related information.

You can do the following:

List all chargebacks for a specific dba.id
View specific chargeback information for chargeback.id
Dispute a case.id for a specific chargeback.id

How to use our Chargeback system

Our chargeback system is designed around chargeback cases. When the first case arrives we create a chargeback with an id.Every new case that arrives for a specific chargeback id updates the chargeback information and gets listed in the cases object.

\n
IMPORTANT A specific chargeback.id can have more than one cases associated with it, as new information can arrive.
\n

We suggest the current flow:

List your chargebacks. If a certain chargeback.id has attention=Yes, you can dispute it and upload evidence.
View the specific chargeback.id, this will list one or more cases associated with the chargeback. Make note of the case.id that has attention=Yes.
Use our Attachments and upload temporary file/files for the dispute.
Create a dispute to a case.id for a specific chargeback.id
Preview the created dispute if needed before submitting it.
Use the Dispute Submit endpoint to submit the dispute file to a specific chargeback.id

Chargeback Object

Fields	Description	Type
id	The unique ID that is assigned by our system to every chargeback	Integer
dba	Object	Object
dba.id	The ID of the DBA	Integer
type	`Chargeback` or `Retrieval`	ENUM
amount	The amount of the retrieval or chargeback. This is not always equal to the amount of the transaction.	Number
card	Object	Integer
card.brand	Card Brand	String
card.number	Card Number	String
date	Object	Object
date.posted	The post date as reported by the issuer.	Date
date.loaded	The date the retrieval request or chargeback was loaded in the system.	Date
date.lastLoaded	The date of the last case loaded in the system for the chargeback.	Date
date.disputed	Date when the dispute was submitted.	Date
reason	Object	Object
reason.code	Chargeback reason code	String
reason.description	Chargeback reason description	String
fraud	`Yes` or `No`	ENUM
attention	`Yes` or `No` If the merchant's attention is required.	ENUM
status	`Processed`, `Won`, `Lost`	ENUM

","_postman_id":"e9df78d2-c281-42c8-a0c8-fa2e0abd84d9"},{"name":"Statements","item":[{"name":"List","id":"80d195b1-9b99-4ada-b34a-c1a0497addde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/statements/","urlObject":{"path":["api","reporting","statements",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"5e3b1835-b9f0-448f-af70-034cb1c0f995","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/statements/9"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"122\",\n \"url\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/statement/122\",\n \"date\": \"2020-02-28\"\n },\n {\n \"id\": \"142\",\n \"url\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/statement/142\",\n \"date\": \"2020-01-31\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/statements/14?page=1\"\n },\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"80d195b1-9b99-4ada-b34a-c1a0497addde"},{"name":"Download","id":"cfe1e9db-242f-4f15-9269-9039dbf7c237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/statement/","description":"

To download a specific statement, use its corresponding id. All the statements are in pdf format.

\n","urlObject":{"path":["api","reporting","statement",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"420ac0c6-839b-481d-ab89-65a85214e6a9","name":"Download","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/statement/122"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cfe1e9db-242f-4f15-9269-9039dbf7c237"}],"id":"e8c30bdb-fe4b-4d8f-853f-0be3b4345c29","_postman_id":"e8c30bdb-fe4b-4d8f-853f-0be3b4345c29","description":""},{"name":"Reserve","item":[{"name":"List","id":"3c368dc8-785f-4727-b376-f400ff6b998c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/reserve/","urlObject":{"path":["api","reporting","reserve",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"422339b1-ac40-4150-a339-b335639ebfc2","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/reserve/9"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"1700\",\n \"type\": \"Credit\",\n \"amount\": \"293.65\",\n \"reserve\": \"89908.71\",\n \"description\": \"Calculated Reserve\",\n \"date\": \"2018-06-06 20:22:22\"\n },\n {\n \"id\": \"1673\",\n \"type\": \"Credit\",\n \"amount\": \"313.62\",\n \"reserve\": \"89615.06\",\n \"description\": \"Calculated Reserve\",\n \"date\": \"2018-06-05 20:24:00\"\n },\n {\n \"id\": \"1647\",\n \"type\": \"Credit\",\n \"amount\": \"243.70\",\n \"reserve\": \"89301.44\",\n \"description\": \"Calculated Reserve\",\n \"date\": \"2018-06-04 20:27:21\"\n },\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/reporting/reserve/1?page=1\"\n },\n },\n \"_meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"3c368dc8-785f-4727-b376-f400ff6b998c"}],"id":"9331a3ce-5f5b-496a-8eb7-2bebdc6ec452","description":"

You can use this endpoint to view reserve activity for a specific dba.id

Reserve Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Reserve id	Integer	No	No	Yes
type	Reserve amount activity type `Debit` or `Credit`	ENUM	No	No	Yes
amount	The amount that is either credited or debited to the reserve.	Number	No	No	Yes
reserve	Current accumulated reserve amount	Number	No	No	Yes
description	Reserve funding activity type	ENUM	No	No	Yes
date	Datetime of reserve activity	Datetime	No	No	Yes

Reserve Descriptions

Below you can find all the reserve descriptions that we return

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

Status	Description
Calculated Reserve	An amount has been withheld and added to the reserve
Calculated Release	An amount has been released from the reserve
One Time Reserve	One time amount has been withheld and added to the reserve
One Time Release	One time amount has been released from the reserve
Record Adjustment Reserve	One time adjustment amount has been withheld and added to the reserve (usually due to an accounting error)
Record Adjustment Release	One time adjustment amount has been released from the reserve (usually due to an accounting error)
Transfer Funds on Reserve	An amount has been transferred to the reserve. This is usually done when a merchant begins with a fixed reserve

","_postman_id":"9331a3ce-5f5b-496a-8eb7-2bebdc6ec452"},{"name":"Fraud Report","item":[{"name":"Generate","id":"36c3cd5e-e41c-4f30-8896-8d29444aa86b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/fraud//","urlObject":{"path":["api","reporting","fraud","",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"bc8d4b5d-331c-4476-a13a-09a24d8b7061","name":"Generate","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/fraud/9/2023-01"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"36c3cd5e-e41c-4f30-8896-8d29444aa86b"}],"id":"f28f87e2-55de-4e2e-8fbb-4dab4bc81018","description":"

At the end of each month, we create a customized and highly detailed fraud report for each merchant. To download it use the following endpoint by providing the dbaId and date for the desired fraud report pdf.

\n","_postman_id":"f28f87e2-55de-4e2e-8fbb-4dab4bc81018"},{"name":"Other Reports","item":[{"name":"Request a Report","id":"73618384-6158-4d28-a7b7-4aa2c63e9165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"ResidualExport\",\r\n \"params\": {\r\n \"format\": \"csv\",\r\n \"date\": \"2022-02\",\r\n \"isPublished\": \"Yes\",\r\n \"isHeld\": \"No\",\r\n \"dbaId\": 1,\r\n }\r\n"},"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/request","urlObject":{"path":["api","reporting","request"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"cf9272c4-f644-4267-94d1-70f95dbe02d8","name":"Request a Report","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"ResidualExport\",\n \"params\": {\n \"format\": \"csv\",\n \"date\": \"2022-02\",\n \"isPublished\": \"Yes\",\n \"isHeld\": \"No\",\n \"dbaId\": 1,\n \"branchId\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/request"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1\n}"}],"_postman_id":"73618384-6158-4d28-a7b7-4aa2c63e9165"},{"name":"Check Status","id":"7f70be37-fd3d-42ee-8154-a79a1409a8e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/status/","description":"

Use this endpoint to check the status of a specific requested report.

\n","urlObject":{"path":["api","reporting","status",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"3d8d765c-c7b9-4433-a2c3-6b19b20d8d8f","name":"Check Status","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/status/1"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Done\",\n \"message\": \"Your report is ready to be downloaded.\"\n}"}],"_postman_id":"7f70be37-fd3d-42ee-8154-a79a1409a8e9"},{"name":"Download","id":"afc9f847-7912-418e-a559-3d8c0455c2a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/download/","description":"

After checking the status of a requested report and when it is ready to be downloaded, you can utilize this endpoint.

\n","urlObject":{"path":["api","reporting","download",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"dc1201d2-20d2-428c-bf8e-f0c2c5ade85c","name":"Download","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/reporting/download/1"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"afc9f847-7912-418e-a559-3d8c0455c2a7"}],"id":"1182c408-114b-4467-907e-d6d490ef14f8","description":"

Based on the reports that are available to you, you can utilize this endpoint to export data-intensive reports from our system.

\n
IMPORTANT Reports are executed in background mode and you need to check the status of each report utilizing or Status Reports endpoint.
\n

Reporting Object

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

Fields	Description	Type	Filterable	Required	Readonly
name	Unique Name of the report	String	No	Yes	No
params	Report parameters	Object	No	Yes	No
params.format	File format of the report. Example: `csv`, `xlsx`	ENUM	No	Yes	No
params.xxx	Other report parameters	String	No	No	No

","_postman_id":"1182c408-114b-4467-907e-d6d490ef14f8"}],"id":"a19d5c28-3622-4d8b-aebf-861c275f064b","description":"

You can use this endpoint for all the available reports through our API.

\n","_postman_id":"a19d5c28-3622-4d8b-aebf-861c275f064b"},{"name":"Residuals","item":[{"name":"List","id":"f2b831bd-6b94-4226-a7a8-b657f87d80b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/residual","description":"

Use this endpoint to list all available residuals

\n","urlObject":{"path":["api","residual"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"60445cc5-2209-42bf-8bf3-3bb4f24fe1e3","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/residual"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"1\",\n \"mid\": \"1111111111\",\n \"date\": \"2022-02-28\",\n \"acquirer\": {\n \"id\": 1\n },\n \"merchant\": {\n \"id\": \"1\",\n \"dba\": {\n \"id\": \"1\"\n },\n \"sales\": {\n \"count\": 7,\n \"amount\": \"1000.50\"\n }\n },\n \"user\": {\n \"id\": \"1\"\n },\n \"split\": \"93.00\",\n \"revenue\": \"326.82\",\n \"expense\": \"210.85\",\n \"adjustment\": {\n \"amount\": \"1.00\",\n \"details\": [\n {\n \"amount\": \"1.00\",\n \"category\": \"equipment\",\n \"note\": \"Adjustment Note\"\n }\n ]\n },\n \"profit\": \"115.97\",\n \"publishedOn\": \"2022-03-01 14:55:00\",\n \"held\": {\n \"on\": null,\n \"note\": null,\n \"releasedOn\": null\n },\n \"residual\": {\n \"id\": 1\n },\n \"subAgent\": {\n \"user\": {\n \"id\": \"2\"\n },\n \"revenue\": \"210.85\",\n \"expense\": \"140.57\",\n \"profit\": \"70.28\",\n \"publishedOn\": \"2022-03-01 15:39:19\",\n \"held\": {\n \"on\": null,\n \"note\": null,\n \"releasedOn\": null\n }\n }\n }\n ],\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}\n"}],"_postman_id":"f2b831bd-6b94-4226-a7a8-b657f87d80b7"},{"name":"View","id":"91a9ee6a-ad12-4ac1-8e51-83fd9b07226c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/residual/","description":"

By utilizing this endpoint you can view details for a specific merchant residual.

\n","urlObject":{"path":["api","residual",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"43b70384-ca92-4f0a-8795-266a39a91374","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/residual/4455"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4455,\n \"mid\": 5011000000,\n \"date\": \"2023-03-31\",\n \"acquirer\": {\n \"id\": 4\n },\n \"merchant\": {\n \"id\": 123,\n \"dba\": {\n \"id\": 9\n },\n \"sales\": {\n \"count\": 0,\n \"amount\": \"0.00\"\n }\n },\n \"user\": {\n \"id\": 1\n },\n \"split\": \"70.00\",\n \"revenue\": \"0.00\",\n \"expense\": \"0.00\",\n \"adjustment\": {\n \"amount\": \"0.00\",\n \"details\": []\n },\n \"profit\": \"0.00\",\n \"publishedOn\": \"2023-04-12 22:19:40\",\n \"held\": {\n \"on\": null,\n \"note\": null,\n \"releasedOn\": null\n },\n \"residual\": {\n \"id\": 152330,\n \"income\": \"0.00\",\n \"expenses\": \"0.00\",\n \"adjustment\": {\n \"amount\": \"0.00\",\n \"details\": []\n },\n \"netRevenue\": \"0.00\"\n },\n \"subAgent\": {\n \"user\": {\n \"id\": 15\n },\n \"revenue\": \"0.00\",\n \"expense\": \"0.00\",\n \"profit\": \"0.00\",\n \"publishedOn\": \"2023-04-12 22:19:40\",\n \"held\": {\n \"on\": null,\n \"note\": null,\n \"releasedOn\": null\n }\n }\n}"}],"_postman_id":"91a9ee6a-ad12-4ac1-8e51-83fd9b07226c"}],"id":"4f62a7da-b925-4f21-a31b-831281c78ea3","description":"

You can utilize this endpoint to read all of your residual data.

Residuals Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the residual agent	Integer	No	No	Yes
mid	The merchant identification number	Integer	Yes	No	Yes
date	Date and time when the residual was processed	Datetime	Yes	No	Yes
acquirer	Acquirer Object	Object	No	No	Yes
acquirer.id	ID of the acquirer bank	Integer	No	No	Yes
merchant	Merchant Object	Object	No	No	Yes
merchant.id	Unique ID of the merchant	Integer	No	No	Yes
merchant.dba	Merchant DBA Object	Object	No	No	Yes
merchant.dba.id	DBA ID of the merchant	Integer	No	No	Yes
merchant.sales	Merchant Sales Object	Object	No	No	Yes
merchant.sales.count	The total merchant sales count	Integer	No	No	Yes
merchant.sales.amount	The total merchant sales amount	Decimal	No	No	Yes
user	User Object	Object	No	No	Yes
user.id	ID of the user	Integer	No	No	Yes
split	User split in percentage	Integer	No	No	Yes
revenue	User revenue	Decimal	No	No	Yes
expense	The expense of the user	Decimal	No	No	Yes
adjustment	Adjustment Object	Object	No	No	Yes
adjustment.amount	The total amount of adjusted funds	Decimal	No	No	Yes
adjustment.details	Array Of Adjustment Details Objects	Object	No	No	Yes
adjustment.details.amount	The amount of adjusted funds	Decimal	No	No	Yes
adjustment.details.category	The category of adjusted funds	String	No	No	Yes
adjustment.details.note	Note for the adjustment	String	No	No	Yes
profit	The profit of the user	Decimal	No	No	Yes
publishedOn	Date and time when the agent residual was published	Datetime	No	No	Yes
held	Held Object	Object	No	No	Yes
held.on	Date and time when the agent residual was held	Datetime	No	No	Yes
held.note	Note for the held	String	No	No	Yes
held.releasedOn	Date and time when the agent residual was released	Datetime	No	No	Yes
residual	Residual Object	Object	No	No	Yes
residual.id	Unique ID of the residual	Integer	No	No	Yes
subAgent	Subagent Object	Object	No	No	Yes
subAgent.user	Subagent User Object	Object	No	No	Yes
subAgent.user.id	ID of the subagent user	Integer	No	No	Yes
subAgent.revenue	The revenue of the subagent	Decimal	No	No	Yes
subAgent.expense	The expense of the subagent	Decimal	No	No	Yes
subAgent.profit	The profit of the subagent	Decimal	No	No	Yes
subAgent.publishedOn	Date and time when the subagent residual was published	Datetime	No	No	Yes
subAgent.held	Subagent Held Object	Object	No	No	Yes
subAgent.held.on	Date and time when the subagent residual was held	Datetime	No	No	Yes
subAgent.note	Note for the held	String	No	No	Yes
subAgent.releasedOn	Date and time when the subagent residual was held	Datetime	No	No	Yes

","_postman_id":"4f62a7da-b925-4f21-a31b-831281c78ea3"},{"name":"Tickets","item":[{"name":"Update Ticket Status","item":[{"name":"Close","id":"6f4338c1-e753-4716-9f8a-035d075381c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//close","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","close"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"0429e647-7cf1-42a2-8ae6-efe156fe4d13","name":"Close","originalRequest":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/close"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"6f4338c1-e753-4716-9f8a-035d075381c6"},{"name":"Re-Open","id":"95ec7571-ed19-4583-912e-e8c6939cc5b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//reopen","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","reopen"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"6dc0c7d3-87eb-4f8f-9773-121b17c37e52","name":"Re-Open","originalRequest":{"method":"PUT","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/reopen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"95ec7571-ed19-4583-912e-e8c6939cc5b4"}],"id":"b0530eec-46d5-4e74-b4f2-f0b6fe3c237a","description":"

You can use this endpoint to Close an existing ticket or Re-Open a closed ticket.

\n","_postman_id":"b0530eec-46d5-4e74-b4f2-f0b6fe3c237a","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}}},{"name":"Responses","item":[{"name":"List","id":"567092ed-0f25-480e-ad8e-a7b8109062b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//responses","description":"

Use this endpoint to list all responses for a specific ticket.

Create a response for a specific ticket

Use this endpoint to add attachments to a ticket response

\n
NOTE To create an attachment use our Attachemnts endpoint first.
\n

You can use this endpoint to:

Create ticket responses
List all responses for a specific ticket.id
Upload an attachment to a response.

\n","_postman_id":"3109608d-63ae-4b67-b59b-9f22eff05e03","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}}},{"name":"Attachments","item":[{"name":"List","id":"3a8b5f9d-d829-4478-805c-c51adccb56c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//documents","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","documents"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"3fff9724-fbe1-49e2-a431-50352b5873e8","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"attachment\": {\n \"id\": 1919,\n \"name\": \"someimage.png\",\n \"type\": \"image/png\",\n \"size\": 272670,\n \"createdOn\": \"2023-06-07 14:46:40\"\n },\n \"response\": {\n \"id\": null\n },\n \"note\": {\n \"id\": 13\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/documents?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/documents?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/documents?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"3a8b5f9d-d829-4478-805c-c51adccb56c9"},{"name":"View","id":"996233d8-849a-4578-bbcc-ec00ee8df06d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//document/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","document",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"3a2aa037-bf27-4523-a750-28c5645fb523","name":"View","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/document/1919"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"attachment\": {\n \"id\": 1919,\n \"name\": \"someimage.png\",\n \"type\": \"image/png\",\n \"size\": 272670,\n \"createdOn\": \"2023-06-07 14:46:40\"\n },\n \"response\": {\n \"id\": null\n },\n \"note\": {\n \"id\": 13\n }\n}"}],"_postman_id":"996233d8-849a-4578-bbcc-ec00ee8df06d"},{"name":"Create","id":"10b06d1f-6b82-4249-9835-153f2ea97e1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//document","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","document"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"6fcd81b6-48e3-4b77-b792-b8b0c165a135","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"attachment\": {\n \"id\": \"1920\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/document"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"attachment\": {\n \"id\": 1920\n },\n \"response\": {\n \"id\": null\n },\n \"note\": {\n \"id\": null\n }\n}"}],"_postman_id":"10b06d1f-6b82-4249-9835-153f2ea97e1c"},{"name":"Delete","id":"be266324-0725-44c0-9f42-2589cc710396","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//document/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","document",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"fbd51886-3bfe-4901-8fde-9caee23d1d05","name":"Delete","originalRequest":{"method":"DELETE","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/document/1920"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"be266324-0725-44c0-9f42-2589cc710396"}],"id":"304d5984-3c9d-4fca-8379-762d30e073be","description":"

You can use this endpoint to add an attachment to an existing ticket.

\n

NOTE You first need to create the ticket and then add an attachment to it.

\n","_postman_id":"304d5984-3c9d-4fca-8379-762d30e073be","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}}},{"name":"Categories","item":[{"name":"List","id":"6ab14c2d-5e11-4596-b90c-2802572db28a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/categories","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","categories"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"25cef91a-5a0a-4ce3-97d3-0e81283a22b8","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Other\",\n \"group\": \"Merchant\"\n },\n {\n \"id\": 2,\n \"name\": \"Account Changes\",\n \"group\": \"Merchant\"\n },\n {\n \"id\": 3,\n \"name\": \"Risk\",\n \"group\": \"Merchant\"\n },\n {\n \"id\": 4,\n \"name\": \"Chargeback Assistance\",\n \"group\": \"Merchant\"\n },\n {\n \"id\": 5,\n \"name\": \"Funding/Billing Inquiry\",\n \"group\": \"Merchant\"\n },\n {\n \"id\": 6,\n \"name\": \"Document Request\",\n \"group\": \"Merchant\"\n },\n {\n \"id\": 7,\n \"name\": \"Technical Support\",\n \"group\": \"Merchant\"\n },\n {\n \"id\": 8,\n \"name\": \"Residual Inquiry\",\n \"group\": \"Agent\"\n },\n {\n \"id\": 9,\n \"name\": \"Other\",\n \"group\": \"Agent\"\n }\n]"}],"_postman_id":"6ab14c2d-5e11-4596-b90c-2802572db28a"}],"id":"a45b8742-71d6-4120-8ad0-ec2ff72684a8","description":"

This endpoint is used to list all the available categories under which you can open a ticket.

\n","_postman_id":"a45b8742-71d6-4120-8ad0-ec2ff72684a8","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}}},{"name":"Notes","item":[{"name":"List","id":"b253ffe2-8b23-4170-8931-02fa429ee748","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//notes","description":"

Use this endpoint to list all the notes for a specific ticket.id

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","notes"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"c43c5b9a-72e4-40f8-b5a5-250f31e5cd95","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 13,\n \"note\": \"I am adding this note, please look into this matter\",\n \"creator\": {\n \"id\": 14\n },\n \"createdOn\": \"2023-05-17 09:25:54\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/notes?page=1\"\n },\n \"first\": {\n \"href\": https://dashboard.dashboard.paysecureonline.com/api/ticket/88/notes?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/notes?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"b253ffe2-8b23-4170-8931-02fa429ee748"},{"name":"View","id":"29302448-e896-4fbe-bc9f-02f62ac18caf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//note/","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","ticket","","note",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"1d23b846-3a66-4186-85b9-20e8c40b832b","name":"View","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket/88/note/13"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 13,\n \"note\": \"I am adding this note, please look into this matter\",\n \"creator\": {\n \"id\": 14\n },\n \"createdOn\": \"2023-05-17 09:25:54\"\n}"}],"_postman_id":"29302448-e896-4fbe-bc9f-02f62ac18caf"},{"name":"Create","id":"006bb1a2-a0fc-49b7-a527-9c0adcc58146","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"note\": \"I am adding a new note for this ticket\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket//note","description":"

This endpoint is used to add notes to a ticket.

You can use this endpoint to update/make corrections to an existing ticket note.

Use this endpoint to delete a ticket note.

You can use this endpoint to add an attachment to an existing ticket note.

\n
NOTE You first need to create the note and then add an attachment to it.
\n

In order to add an attachment you need to first use our Attachments endpoint to upload a file and get the file id

You can use this endpoint for notes that are associated with a ticket.

You can do the following:

List all notes in a ticket
View a specific note for a ticket
Create a ticket note
Update a ticket note
Add an attachment to a ticket note

Notes Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the note	Integer	No	No	Yes
note	The contents of the note	String	No	Yes	No
creator	Object	Object	No	No	No
creator.id	Unique ID of the user who created the note	Integer	No	No	No

","_postman_id":"698ad9ae-86ab-43cf-a84b-5d9810a52615","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}}},{"name":"List","id":"469db380-918f-4cb2-bfc9-d6b789f620bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/tickets","description":"

Use this endpoint to list all of your tickets.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d","id":"51159b90-d01b-4679-ab9c-79c17f17af0d","name":"Tickets","type":"folder"}},"urlObject":{"path":["api","tickets"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"64933051-c1b7-4a72-903c-608e5af02766","name":"List","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/tickets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 88,\n \"dba\": {\n \"id\": 2\n },\n \"category\": {\n \"id\": 4\n },\n \"title\": \"Charback Help\",\n \"text\": \"One of my merchants is inquiring about chargebacks. I need your clarification\",\n \"status\": \"Open\",\n \"notifyMerchant\": \"No\",\n \"attentionMerchant\": \"No\",\n \"createdBy\": {\n \"id\": 14\n },\n \"createdOn\": \"2023-05-16 13:39:45\",\n \"lastUpdatedOn\": \"2023-05-16 13:39:45\",\n \"agentLastUpdatedOn\": \"2023-05-16 13:39:45\"\n }\n] \n\"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/dashboard/web/api/tickets?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/dashboard/web/api/tickets?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/dashboard/web/api/tickets?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"469db380-918f-4cb2-bfc9-d6b789f620bb"},{"name":"Create","id":"00e41604-0b91-4ec5-a599-9583d5a7a8a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dba\": {\n \"id\": 2\n },\n \"category\": {\n \"id\": 4\n },\n \"title\": \"Charback Help\",\n \"text\": \"One of my merchants is inquiring about chargebacks. I need your clarification\",\n \"notifyMerchant\": \"No\",\n \"attentionMerchant\": \"No\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/ticket","description":"

Use this endpoint to create a new ticket.

View all the information for a specific ticket.id

You can utilize this endpoint for our ticketing system.

You can the following:

List all tickets
View a specific ticket
Create a new ticket
Close or re-open an existing ticket
Add a response to an existing ticket
*Add notes to an existing ticket
List all ticket categories

\n
*Only agent users can add notes to existing tickets.
\n

Ticket Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the ticket	Integer	Yes	No	Yes
dba	DBA Object	Object	No	No	No
dba.id	Unique ID of the DBA	Integer	Yes	No	No
category	Category Object	Object	No	No	No
category.id	Unique ID of the category	Integer	Yes	Yes	No
title	Title of the ticket	String	Yes	Yes	No
text	Content of the ticket	String	No	Yes	No
status	Status of the ticket `Open` `Closed` `Responded`	ENUM	Yes	No	No
notifyMerchant	Notify the merchant when the ticket is created/responded, `Yes` `No`	ENUM	No	No	No
attentionMerchant	Notify the merchant when the ticket is created/responded with a special header - attention is needed, `Yes` `No`	ENUM	No	No	No
createdBy	Created By Object	Object	No	No	No
createdBy.id	Unique ID of the user who created the ticket	Integer	No	No	No
lastResponse	Last Response Object	Object	No	No	No
lastResponse.id	Unique ID of the last ticket response	Integer	No	No	No
createdOn	Date and Time when the ticket was created	Datetime	No	No	Yes
lastUpdatedOn	Date and Time of last update on the tickets	Datetime	No	No	Yes
agentLastUpdatedOn	Date and Time of last update on the agent	Datetime	No	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"51159b90-d01b-4679-ab9c-79c17f17af0d"},{"name":"Attachments","item":[{"name":"Chunk Upload","item":[{"name":"Initialize","id":"35df01f1-d58a-4c7d-a212-35cde421936a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"forReview.png\",\r\n \"size\": 989,\r\n \"hash\": \"555347cd00852cbf81caaffeb995e388\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload","description":"

Initialize Object

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

Fields	Description	Type	Filterable	Required	Readonly
name	File name	String	No	Yes	No
size	File size in bytes	Number	No	Yes	No
hash	MD5 File Checksum	String	No	Yes	No

There are a couple of things to note here. Before sending an initialize request you need to have an MD5 checksum for the file that you wish to upload. The required parameters are listed in the Object table.

After successful initialization, we will return a unique id that needs to be provided when uploading the separated chunks/parts.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","name":"Attachments","type":"folder"}},"urlObject":{"path":["api","attachment","upload"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"e9c1d8d8-be63-4d5e-bad6-0c28aa718f5c","name":"Initialize the file","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"forReview.png\",\n \"size\": 989,\n \"hash\": \"555347cd00852cbf81caaffeb995e388\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"G54ZGHglW__X1Ex6bzLfAtwVzDgN6Xux\"\n}"}],"_postman_id":"35df01f1-d58a-4c7d-a212-35cde421936a"},{"name":"Upload Request 1/2","id":"d3b0fa04-969f-48b0-a5fd-4adeefffcfe7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload/","description":"

You need to separate the larger file into smaller chunks/parts no bigger than 16MB. After the separation, the files need to be uploaded with the correct sequence of parts.

\n
IMPORTANT The upload process remains in pending status until all the chunks have been uploaded. At the end if we detect that the checksum is not the same as the initialized we will return an error: The provided hash at the beginning does not match the hash of the uploaded file.
\n

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","name":"Attachments","type":"folder"}},"urlObject":{"path":["api","attachment","upload",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"c914ba9a-1b41-4850-9fcb-d3eaed959a17","name":"Upload Request 1/2","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"body":{"mode":"file","file":{}},"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload/G54ZGHglW__X1Ex6bzLfAtwVzDgN6Xux"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"size\": {\n \"current\": 500,\n \"claimed\": 989\n },\n \"status\": \"Pending\",\n \"progress\": \"50.56\"\n}"}],"_postman_id":"d3b0fa04-969f-48b0-a5fd-4adeefffcfe7"},{"name":"Upload Request 2/2","id":"46ba043e-62a1-4c85-b599-a828d2e6f828","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload/","description":"

You need to separate the larger file into smaller chunks/parts no bigger than 16MB. After the separation, the files need to be uploaded with the correct sequence of parts.

\n
IMPORTANT The upload process remains in pending status until all the chunks have been uploaded. At the end if we detect that the checksum is not the same as the initialized we will return an error: The provided hash at the beginning does not match the hash of the uploaded file.
\n

The chunk upload endpoints allow you to upload files larger than 16MB by uploading them into smaller chunks/parts. The overall process is as follows:

Initialize (providing file information)
Upload the divided chunks/parts of the file

\n","_postman_id":"b07e2466-954c-4c1d-bed6-32ea1f67cd71","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","name":"Attachments","type":"folder"}}},{"name":"Standard Upload","id":"0813c059-8442-4cc9-aa1d-3fd55b9a7103","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload","description":"

You can utilize the standard upload endpoint if your file is 16MB or less. Anything above 16MB you need to utilize the chunk upload endpoint.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","name":"Attachments","type":"folder"}},"urlObject":{"path":["api","attachment","upload"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"0526ae34-5e89-4e22-9807-2035557b25f3","name":"Standard Upload","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","value":null}]},"url":{"raw":"https://dashboard.dashboard.paysecureonline.com/api/attachment/upload?file","host":["https://dashboard.dashboard.paysecureonline.com"],"path":["api","attachment","upload"],"query":[{"key":"file","value":null,"type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1921,\n \"name\": \"file1.pdf\",\n \"type\": \"application/pdf\",\n \"size\": 245311\n}"}],"_postman_id":"0813c059-8442-4cc9-aa1d-3fd55b9a7103"},{"name":"List attachments","id":"28a0afe8-224a-47c4-a595-34ac13384d63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/attachments","description":"

List all of your attachments in the Dashboard's file system.

\n","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":true,"source":{"_postman_id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","id":"adc9469b-aebd-42c3-af16-01d2fa4279ce","name":"Attachments","type":"folder"}},"urlObject":{"path":["api","attachments"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"23b077ef-d817-4dca-bb48-d3e67b8e2cd6","name":"List attachments","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/attachments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1920,\n \"name\": \"disputeinfo.pdf\",\n \"type\": \"application/pdf\",\n \"size\": 245311,\n \"createdOn\": \"2023-05-17 13:05:42\"\n },\n {\n \"id\": 1919,\n \"name\": \"signature.pdf\",\n \"type\": \"application/pdf\",\n \"size\": 245311,\n \"createdOn\": \"2023-05-17 09:23:57\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/attachments?page=1\"\n },\n \"first\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/attachments?page=1\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/attachments?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"28a0afe8-224a-47c4-a595-34ac13384d63"},{"name":"View","id":"9ad039a8-8eb7-4cb4-a661-bbb11019f4ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/attachment/","description":"

View a specific attachment

View a specific attachment in browser

Download an attachment.

Deleting attachments can be achieved by utilizing this endpoint.

\n
IMPORTANT Any attachment that is already in use by one or more endpoint in the Dashboard cannot be deleted.
\n

This endpoint is used for the Dashboard's file system. Each attachment uploaded via this endpoint can be used in several endpoints, including but not limited to the Boarding Application, Tickets, Chargebacks and etc.

\n
NOTE We provide several upload methods for your convenience.
\n

Attachments Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	ID of the attached file	Integer	Yes	No	Yes
name	File name	String	No	No	Yes
type	File type	String	No	No	Yes
size	File size in bytes	Number	No	No	Yes
createdOn	Date and time of file creation	Datetime	No	No	Yes

","auth":{"type":"bearer","bearer":{"token":"XXX"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"adc9469b-aebd-42c3-af16-01d2fa4279ce"},{"name":"BIN Check","item":[{"name":"Get BIN Information","id":"50637218-4ec7-4f63-b957-83ccdbd5b783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/bin/","description":"

View information for a specific BIN record.

\n","urlObject":{"path":["api","bin",""],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"004be0dc-51de-4afd-adb8-fe5486c5b974","name":"Get BIN Information","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/bin/403647"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"bin\": 403647,\n \"brand\": \"Visa\",\n \"organization\": \"Bank Of America, National Association\",\n \"type\": \"Credit\",\n \"category\": \"Business\",\n \"country\": {\n \"name\": \"United States\",\n \"code\": \"US\"\n }\n}"}],"_postman_id":"50637218-4ec7-4f63-b957-83ccdbd5b783"}],"id":"5d63434f-e2d5-458f-859e-238ab309e590","description":"

You can use this endpoint to get detailed information on a BIN

BIN Object

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

Fields	Description	Type	Filterable	Required	Readonly
bin	Bank Identification Number	Integer	Yes	No	Yes
brand	Brand of the card	String	No	No	Yes
type	`Debit`, `Credit` or `ChargeCard`	ENUM	No	No	Yes
category	Category of the card	String	No	No	Yes
organization	Organization	String	No	No	Yes
country	Country	Object	No	No	Yes
country.name	Name of the country	String	No	No	Yes
country.code	ISO Code of the country	String	No	No	Yes

","_postman_id":"5d63434f-e2d5-458f-859e-238ab309e590"},{"name":"Address Checker","item":[{"name":"List Countries","id":"efbe9dfd-6298-4656-a662-03e4dddfb00b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/countries","description":"

Use this endpoint to list all countries and their corresponding code information

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the country	Integer	Yes	Yes	Yes
name	Full name of the county	String	Yes	No	Yes
code	Object	Object	Yes	No	Yes
code.alpha2	2 letter country code abbreviation	String	Yes	Yes	Yes
code.alpha3	3 letter country code abbreviation	String	Yes	Yes	Yes

","urlObject":{"path":["api","countries"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"31a0ad69-0c45-4c94-a0a2-cf212d95a9b4","name":"List Countries","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/countries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Bangladesh\",\n \"code\": {\n \"alpha2\": \"BD\",\n \"alpha3\": \"BGD\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Belgium\",\n \"code\": {\n \"alpha2\": \"BE\",\n \"alpha3\": \"BEL\"\n }\n },\n {\n \"id\": 3,\n \"name\": \"Burkina Faso\",\n \"code\": {\n \"alpha2\": \"BF\",\n \"alpha3\": \"BFA\"\n }\n },\n {\n \"id\": 4,\n \"name\": \"Bulgaria\",\n \"code\": {\n \"alpha2\": \"BG\",\n \"alpha3\": \"BGR\"\n }\n },\n {\n \"id\": 5,\n \"name\": \"Bosnia and Herzegovina\",\n \"code\": {\n \"alpha2\": \"BA\",\n \"alpha3\": \"BIH\"\n }\n },\n {\n \"id\": 6,\n \"name\": \"Barbados\",\n \"code\": {\n \"alpha2\": \"BB\",\n \"alpha3\": \"BRB\"\n }\n },\n {\n \"id\": 7,\n \"name\": \"Wallis and Futuna\",\n \"code\": {\n \"alpha2\": \"WF\",\n \"alpha3\": \"WLF\"\n }\n },\n {\n \"id\": 8,\n \"name\": \"Saint Barthelemy\",\n \"code\": {\n \"alpha2\": \"BL\",\n \"alpha3\": \"BLM\"\n }\n },\n {\n \"id\": 9,\n \"name\": \"Bermuda\",\n \"code\": {\n \"alpha2\": \"BM\",\n \"alpha3\": \"BMU\"\n }\n },\n {\n \"id\": 10,\n \"name\": \"Brunei\",\n \"code\": {\n \"alpha2\": \"BN\",\n \"alpha3\": \"BRN\"\n }\n },\n {\n \"id\": 11,\n \"name\": \"Bolivia\",\n \"code\": {\n \"alpha2\": \"BO\",\n \"alpha3\": \"BOL\"\n }\n },\n {\n \"id\": 12,\n \"name\": \"Bahrain\",\n \"code\": {\n \"alpha2\": \"BH\",\n \"alpha3\": \"BHR\"\n }\n },\n {\n \"id\": 13,\n \"name\": \"Burundi\",\n \"code\": {\n \"alpha2\": \"BI\",\n \"alpha3\": \"BDI\"\n }\n },\n {\n \"id\": 14,\n \"name\": \"Benin\",\n \"code\": {\n \"alpha2\": \"BJ\",\n \"alpha3\": \"BEN\"\n }\n },\n {\n \"id\": 15,\n \"name\": \"Bhutan\",\n \"code\": {\n \"alpha2\": \"BT\",\n \"alpha3\": \"BTN\"\n }\n },\n {\n \"id\": 16,\n \"name\": \"Jamaica\",\n \"code\": {\n \"alpha2\": \"JM\",\n \"alpha3\": \"JAM\"\n }\n },\n {\n \"id\": 17,\n \"name\": \"Bouvet Island\",\n \"code\": {\n \"alpha2\": \"BV\",\n \"alpha3\": \"BVT\"\n }\n },\n {\n \"id\": 18,\n \"name\": \"Botswana\",\n \"code\": {\n \"alpha2\": \"BW\",\n \"alpha3\": \"BWA\"\n }\n },\n {\n \"id\": 19,\n \"name\": \"Samoa\",\n \"code\": {\n \"alpha2\": \"WS\",\n \"alpha3\": \"WSM\"\n }\n },\n {\n \"id\": 20,\n \"name\": \"Bonaire, Saint Eustatius and Saba \",\n \"code\": {\n \"alpha2\": \"BQ\",\n \"alpha3\": \"BES\"\n }\n },\n {\n \"id\": 21,\n \"name\": \"Brazil\",\n \"code\": {\n \"alpha2\": \"BR\",\n \"alpha3\": \"BRA\"\n }\n },\n {\n \"id\": 22,\n \"name\": \"Bahamas\",\n \"code\": {\n \"alpha2\": \"BS\",\n \"alpha3\": \"BHS\"\n }\n },\n {\n \"id\": 23,\n \"name\": \"Jersey\",\n \"code\": {\n \"alpha2\": \"JE\",\n \"alpha3\": \"JEY\"\n }\n },\n {\n \"id\": 24,\n \"name\": \"Belarus\",\n \"code\": {\n \"alpha2\": \"BY\",\n \"alpha3\": \"BLR\"\n }\n },\n {\n \"id\": 25,\n \"name\": \"Belize\",\n \"code\": {\n \"alpha2\": \"BZ\",\n \"alpha3\": \"BLZ\"\n }\n },\n {\n \"id\": 26,\n \"name\": \"Russia\",\n \"code\": {\n \"alpha2\": \"RU\",\n \"alpha3\": \"RUS\"\n }\n },\n {\n \"id\": 27,\n \"name\": \"Rwanda\",\n \"code\": {\n \"alpha2\": \"RW\",\n \"alpha3\": \"RWA\"\n }\n },\n {\n \"id\": 28,\n \"name\": \"Serbia\",\n \"code\": {\n \"alpha2\": \"RS\",\n \"alpha3\": \"SRB\"\n }\n },\n {\n \"id\": 29,\n \"name\": \"East Timor\",\n \"code\": {\n \"alpha2\": \"TL\",\n \"alpha3\": \"TLS\"\n }\n },\n {\n \"id\": 30,\n \"name\": \"Reunion\",\n \"code\": {\n \"alpha2\": \"RE\",\n \"alpha3\": \"REU\"\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/countries?page=1\"\n },\n \"next\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/countries?page=2\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/countries?page=9\"\n }\n },\n \"_meta\": {\n \"totalCount\": 250,\n \"pageCount\": 9,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"efbe9dfd-6298-4656-a662-03e4dddfb00b"},{"name":"List States","id":"c9953e29-4534-4963-bab3-751d0be14da3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/country//states","description":"

Use this endpoint to list all available state information for a specific country code.

States Object

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

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the state	Integer	Yes	Yes	Yes
name	Full name of the state	String	Yes	No	Yes
code	2 letter state code abbreviation	String	Yes	No	Yes

","urlObject":{"path":["api","country","","states"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"7c897772-a0f7-43a6-8b43-93b0d62bc6dc","name":"List States","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/country/199/states"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Alabama\",\n \"code\": \"AL\"\n },\n {\n \"id\": 2,\n \"name\": \"Alaska\",\n \"code\": \"AK\"\n },\n {\n \"id\": 3,\n \"name\": \"Arizona\",\n \"code\": \"AZ\"\n },\n {\n \"id\": 4,\n \"name\": \"Arkansas\",\n \"code\": \"AR\"\n },\n {\n \"id\": 5,\n \"name\": \"California\",\n \"code\": \"CA\"\n },\n {\n \"id\": 6,\n \"name\": \"Colorado\",\n \"code\": \"CO\"\n },\n {\n \"id\": 7,\n \"name\": \"Connecticut\",\n \"code\": \"CT\"\n },\n {\n \"id\": 8,\n \"name\": \"Delaware\",\n \"code\": \"DE\"\n },\n {\n \"id\": 9,\n \"name\": \"District of Columbia\",\n \"code\": \"DC\"\n },\n {\n \"id\": 10,\n \"name\": \"Florida\",\n \"code\": \"FL\"\n },\n {\n \"id\": 11,\n \"name\": \"Georgia\",\n \"code\": \"GA\"\n },\n {\n \"id\": 12,\n \"name\": \"Hawaii\",\n \"code\": \"HI\"\n },\n {\n \"id\": 13,\n \"name\": \"Idaho\",\n \"code\": \"ID\"\n },\n {\n \"id\": 14,\n \"name\": \"Illinois\",\n \"code\": \"IL\"\n },\n {\n \"id\": 15,\n \"name\": \"Indiana\",\n \"code\": \"IN\"\n },\n {\n \"id\": 16,\n \"name\": \"Iowa\",\n \"code\": \"IA\"\n },\n {\n \"id\": 17,\n \"name\": \"Kansas\",\n \"code\": \"KS\"\n },\n {\n \"id\": 18,\n \"name\": \"Kentucky\",\n \"code\": \"KY\"\n },\n {\n \"id\": 19,\n \"name\": \"Louisiana\",\n \"code\": \"LA\"\n },\n {\n \"id\": 20,\n \"name\": \"Maine\",\n \"code\": \"ME\"\n },\n {\n \"id\": 21,\n \"name\": \"Maryland\",\n \"code\": \"MD\"\n },\n {\n \"id\": 22,\n \"name\": \"Massachusetts\",\n \"code\": \"MA\"\n },\n {\n \"id\": 23,\n \"name\": \"Michigan\",\n \"code\": \"MI\"\n },\n {\n \"id\": 24,\n \"name\": \"Minnesota\",\n \"code\": \"MN\"\n },\n {\n \"id\": 25,\n \"name\": \"Mississippi\",\n \"code\": \"MS\"\n },\n {\n \"id\": 26,\n \"name\": \"Missouri\",\n \"code\": \"MO\"\n },\n {\n \"id\": 27,\n \"name\": \"Montana\",\n \"code\": \"MT\"\n },\n {\n \"id\": 28,\n \"name\": \"Nebraska\",\n \"code\": \"NE\"\n },\n {\n \"id\": 29,\n \"name\": \"Nevada\",\n \"code\": \"NV\"\n },\n {\n \"id\": 30,\n \"name\": \"New Hampshire\",\n \"code\": \"NH\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/country/199/states?page=1\"\n },\n \"next\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/country/199/states?page=2\"\n },\n \"last\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com/api/country/199/states?page=3\"\n }\n },\n \"_meta\": {\n \"totalCount\": 62,\n \"pageCount\": 3,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"c9953e29-4534-4963-bab3-751d0be14da3"},{"name":"List Cities and Zip Codes","id":"83b320f9-2bd9-40cc-8c78-d0dfbfc3bc1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/country//state//zip","description":"

Use this endpoint to list all available cities and their zip code information for a specific state code.

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the zip code	Integer	No	No	Yes
zip	Object	Object	No	No	Yes
zip.code	Zip code	String	Yes	Yes	Yes
zip.type	`Standard`, `Acceptable`	ENUM	Yes	No	Yes
city	Object	Object	No	No	Yes
city.name	Full name of the city	String	Yes	Yes	Yes
city.type	`Standard`, `Acceptable`	ENUM	Yes	No	Yes
county	Full name of the county	String	Yes	No	Yes
state	Object	Object	No	No	Yes
state.id	The ID of the state	Integer	Yes	No	Yes
timezone	Object	Object	No	No	Yes
timezone.value	Name of timezone	String	No	No	Yes
timezone.utc	Timezone (UTC12)	ENUM	No	No	Yes
timezone.dst	`Yes`, `No`	ENUM	No	No	Yes

","urlObject":{"path":["api","country","","state","","zip"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[],"variable":[]}},"response":[{"id":"d9d5029f-c77c-423c-8c9f-aa50ea8dd491","name":"List Cities and Zip Codes","originalRequest":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/country/199/state/5/zip"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"72801\",\n \"zip\": {\n \"code\": 90001,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Firestone Park\",\n \"type\": \"Acceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72802\",\n \"zip\": {\n \"code\": 90001,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Firestone Pk\",\n \"type\": \"Acceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72803\",\n \"zip\": {\n \"code\": 90001,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Default\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72804\",\n \"zip\": {\n \"code\": 90002,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Default\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72805\",\n \"zip\": {\n \"code\": 90002,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Watts\",\n \"type\": \"Acceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72806\",\n \"zip\": {\n \"code\": 90003,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Broadway Manchester\",\n \"type\": \"NotAcceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72807\",\n \"zip\": {\n \"code\": 90003,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Default\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72808\",\n \"zip\": {\n \"code\": 90004,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Default\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72809\",\n \"zip\": {\n \"code\": 90004,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Oakwood\",\n \"type\": \"Acceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72810\",\n \"zip\": {\n \"code\": 90005,\n \"type\": \"Standard\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Default\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72811\",\n \"zip\": {\n \"code\": 90005,\n \"type\": \"standard\"\n },\n \"city\": {\n \"name\": \"Sanford\",\n \"type\": \"Acceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72812\",\n \"zip\": {\n \"code\": 90006,\n \"type\": \"standard\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Default\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72813\",\n \"zip\": {\n \"code\": 90006,\n \"type\": \"standard\"\n },\n \"city\": {\n \"name\": \"Pico Heights\",\n \"type\": \"NotAcceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72814\",\n \"zip\": {\n \"code\": 90007,\n \"type\": \"standard\"\n },\n \"city\": {\n \"name\": \"Dockweiler\",\n \"type\": \"Acceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n },\n {\n \"id\": \"72815\",\n \"zip\": {\n \"code\": 90007,\n \"type\": \"standard\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Default\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/country/199/state/5/zip?page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 4348,\n \"pageCount\": 145,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"83b320f9-2bd9-40cc-8c78-d0dfbfc3bc1d"},{"name":"Filter by City and State","id":"aa1e4536-f7de-4181-bef5-82afeab2fa7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dashboard.dashboard.paysecureonline.com/api/country/199/state/5/zip?filter[city.name]=Los Angeles&filter[zip.code]=90069","description":"

Keep in mind that you can use filters to list only specific cities or list cities for a specific zip code. We validate state, city, and zip code combinations on the Boarding Application, so make sure you are providing the correct information.

\n","urlObject":{"path":["api","country","199","state","5","zip"],"host":["https://dashboard.dashboard.paysecureonline.com"],"query":[{"key":"filter[city.name]","value":"Los Angeles"},{"key":"filter[zip.code]","value":"90069"}],"variable":[]}},"response":[{"id":"1e8faff5-95d2-40d4-b52d-e9e91f831640","name":"Filter by City and State","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dashboard.dashboard.paysecureonline.com/api/country/199/state/5/zip?filter[city.name]=Los Angeles&filter[zip.code]=90069","host":["https://dashboard.dashboard.paysecureonline.com"],"path":["api","country","199","state","5","zip"],"query":[{"key":"filter[city.name]","value":"Los Angeles"},{"key":"filter[zip.code]","value":"90069"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"72963\",\n \"zip\": {\n \"code\": 90069,\n \"type\": \"Standart\"\n },\n \"city\": {\n \"name\": \"Los Angeles\",\n \"type\": \"Acceptable\"\n },\n \"county\": \"Los Angeles\",\n \"state\": {\n \"id\": 5\n },\n \"timezone\": {\n \"value\": \"Pacific\",\n \"utc\": \"-8.0\",\n \"dst\": \"Yes\"\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://dashboard.dashboard.paysecureonline.com//api/country/199/state/5/zip?filter%5Bcity.name%5D=Los+Angeles&filter%5Bzip.code%5D=90069&page=1\"\n }\n },\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 30\n }\n}"}],"_postman_id":"aa1e4536-f7de-4181-bef5-82afeab2fa7c"}],"id":"d6f368e2-0ef2-4fca-acd4-c2ebaf250e1f","description":"

We have created a zip code database to validate all the city, state, and zip code information on the application. Use this endpoint to get the necessary ids that need to be provided in the corresponding fields on the Boarding Application.

\n","_postman_id":"d6f368e2-0ef2-4fca-acd4-c2ebaf250e1f"}],"id":"33bacea8-f930-43d8-b58b-f035e5108a84","_postman_id":"33bacea8-f930-43d8-b58b-f035e5108a84","description":""}],"id":"128fb6f7-2f16-4134-817a-4205b56ad336","_postman_id":"128fb6f7-2f16-4134-817a-4205b56ad336","description":""},{"name":"Webhooks","item":[{"name":"Signatures","item":[],"id":"557058f9-69a1-4bde-98f9-c178a3c7757d","description":"

We sign the webhook events that are sent to your endpoints. We do so by including a signature in each event's Webhook-Signature header. This allows you to verify that the events were sent by us, not by a third party.

\n
IMPORTANT You are not required to implement this kind of signature check, but it's strongly recommended.
\n

Webhook-Signature is a SHA-512 sum of following fields <webhookSignature><id><module><action><date>

You can view and manage your Webhook Signature in your Dashboard. Keep in mind that every Webhook URL has its own <webhookSignature>

\n","_postman_id":"557058f9-69a1-4bde-98f9-c178a3c7757d"},{"name":"Events","item":[{"name":"Boarding Application","item":[],"id":"0bb7bbb1-14ee-4407-a265-7059247f06a9","description":"

Notifications related to our Boarding Applications.

This webhook will be triggered when a new Boarding Applicaiton is created and when there are status change events related to the Application.

{\n  \"id\": 1763,\n  \"module\": \"boardingApplication\",\n  \"action\": \"statusChanged\",\n  \"date\": \"2023-08-18 11:08:06\",\n  \"data\": {\n    \"id\": 246146,\n    \"processingMethod\": \"Acquiring\",\n    \"mcc\": \"1750\",\n    \"campaign\": {\n      \"id\": 19859\n    },\n    \"company\": {\n      \"name\": \"Auto Application - Axiom ACQ - a4b3f\",\n      \"type\": \"Corporation\",\n      \"federalTaxId\": \"123456789\",\n      \"address\": {\n        \"street\": \"451 99e29 Street\",\n        \"city\": \"Anchorage\",\n        \"zip\": \"99502\",\n        \"state\": {\n          \"id\": 2\n        },\n        \"country\": {\n          \"id\": 199\n        }\n      },\n      \"founded\": \"2021-01-21\"\n    },\n    \"dba\": {\n      \"id\": 102510,\n      \"sameAsCompany\": \"Yes\",\n      \"name\": null,\n      \"address\": {\n        \"street\": null,\n        \"city\": null,\n        \"zip\": null,\n        \"state\": {\n          \"id\": null\n        },\n        \"country\": {\n          \"id\": 199\n        }\n      }\n    },\n    \"merchant\": {\n      \"id\": 89890\n    },\n    \"website\": \"http://en.wikipedia.org/wiki/Carpentry\",\n    \"serviceDescription\": \"We sell carpentry\",\n    \"mailingAddress\": \"legal\",\n    \"businessLocation\": {\n      \"buildingType\": \"Office Building\",\n      \"numberOfLocations\": \"9\",\n      \"buildingOwnership\": \"Owns\",\n      \"areaZoned\": \"Industrial\",\n      \"squareFootage\": \"0-501\"\n    },\n    \"customerServiceContact\": {\n      \"phone\": \"+1 202-555-0174\",\n      \"email\": \"email@email.com\"\n    },\n    \"corporateContact\": {\n      \"phone\": \"+1 202-555-0174\",\n      \"fax\": \"+1 202-555-0114\",\n      \"email\": \"email@email.com\"\n    },\n    \"bankruptcy\": {\n      \"hasBankruptcy\": \"Business Bankruptcy\",\n      \"description\": \"Bankrupted once in 1982 due to mismanagement\"\n    },\n    \"principals\": [\n      {\n        \"id\": 296046,\n        \"title\": \"Director\",\n        \"name\": {\n          \"first\": \"John\",\n          \"last\": \"Doe\"\n        },\n        \"dayOfBirth\": \"2020-01-21\",\n        \"ssn\": \"123-45-6781\",\n        \"nationalId\": null,\n        \"nationality\": {\n          \"id\": 199\n        },\n        \"driverLicense\": {\n          \"number\": \"13371337\",\n          \"expiration\": \"2024-01-21\",\n          \"state\": {\n            \"id\": 2\n          }\n        },\n        \"address\": {\n          \"street\": \"346 26923 Street\",\n          \"city\": \"Anchorage\",\n          \"zip\": \"99502\",\n          \"state\": {\n            \"id\": 2\n          },\n          \"country\": {\n            \"id\": 199\n          }\n        },\n        \"phone\": \"+1 202-555-0103\",\n        \"email\": \"1da6a29@email.com\",\n        \"ownershipPercentage\": 52,\n        \"isManagement\": \"Yes\"\n      }\n    ],\n    \"processing\": {\n      \"bank\": {\n        \"accountNumber\": \"31337\",\n        \"routingNumber\": \"1337\"\n      },\n      \"volumes\": {\n        \"monthlyTransactionAmount\": 25000,\n        \"avgTransactionAmount\": 400,\n        \"maxTransactionAmount\": 500\n      },\n      \"sales\": {\n        \"swiped\": 50,\n        \"mail\": 25,\n        \"internet\": 25\n      },\n      \"alreadyProcessing\": {\n        \"isProcessing\": \"Yes\",\n        \"processor\": \"PayPal\"\n      },\n      \"terminated\": {\n        \"isTerminated\": \"Yes\",\n        \"description\": \"text\"\n      },\n      \"customers\": {\n        \"type\": {\n          \"individual\": 0,\n          \"business\": 100,\n          \"government\": 0\n        },\n        \"location\": {\n          \"local\": 0,\n          \"national\": 100,\n          \"international\": 0\n        }\n      },\n      \"fulfillmentPolicy\": {\n        \"fulfillment\": \"2-days\",\n        \"fulfillmentOther\": null,\n        \"delivery\": \"24-hours\",\n        \"deliveryOther\": null\n      },\n      \"recurringPayments\": {\n        \"hasRecurring\": \"No\",\n        \"description\": null\n      },\n      \"intendedUsage\": {\n        \"creditCards\": \"Yes\",\n        \"pinDebit\": \"No\",\n        \"ebt\": \"Yes\",\n        \"fns\": \"4454\",\n        \"notes\": \"notes\"\n      },\n      \"seasonalBusiness\": {\n        \"isSeasonal\": \"No\",\n        \"months\": []\n      },\n      \"inventory\": {\n        \"onSite\": \"Yes\",\n        \"offSite\": \"No\",\n        \"offSiteAddress\": null,\n        \"thirdParty\": \"No\",\n        \"serviceOnly\": \"No\"\n      },\n      \"retailLocation\": \"18A Testing Lane blvd.\",\n      \"externalFulfillment\": \"No\",\n      \"customerCharged\": \"time-offer-order\",\n      \"equipmentUsed\": \"We have an old PoS Terminal\",\n      \"advertise\": \"Adsense and physical billboards\",\n      \"refundPolicy\": \"NO REFUNDS!\",\n      \"feeSchedule\": {\n        \"fees\": [\n          {\n            \"id\": 6062030,\n            \"type\": {\n              \"id\": 1\n            },\n            \"value\": \"1.00000\"\n          },\n          {\n            \"id\": 6062031,\n            \"type\": {\n              \"id\": 2\n            },\n            \"value\": \"2.00000\"\n          },\n          {\n            \"id\": 6062032,\n            \"type\": {\n              \"id\": 3\n            },\n            \"value\": \"3.00000\"\n          },\n          {\n            \"id\": 6062033,\n            \"type\": {\n              \"id\": 4\n            },\n            \"value\": \"4.00000\"\n          },\n          {\n            \"id\": 6062034,\n            \"type\": {\n              \"id\": 5\n            },\n            \"value\": \"5.00000\"\n          },\n          {\n            \"id\": 6062035,\n            \"type\": {\n              \"id\": 6\n            },\n            \"value\": \"6.00000\"\n          },\n          {\n            \"id\": 6062036,\n            \"type\": {\n              \"id\": 7\n            },\n            \"value\": \"7.00000\"\n          },\n          {\n            \"id\": 6062037,\n            \"type\": {\n              \"id\": 8\n            },\n            \"value\": \"8.00000\"\n          },\n          {\n            \"id\": 6062038,\n            \"type\": {\n              \"id\": 9\n            },\n            \"value\": \"9.00000\"\n          },\n          {\n            \"id\": 6062039,\n            \"type\": {\n              \"id\": 10\n            },\n            \"value\": \"10.00000\"\n          },\n          {\n            \"id\": 6062040,\n            \"type\": {\n              \"id\": 11\n            },\n            \"value\": \"11.00000\"\n          },\n          {\n            \"id\": 6062041,\n            \"type\": {\n              \"id\": 12\n            },\n            \"value\": \"12.00000\"\n          },\n          {\n            \"id\": 6062042,\n            \"type\": {\n              \"id\": 13\n            },\n            \"value\": \"13.00000\"\n          },\n          {\n            \"id\": 6062043,\n            \"type\": {\n              \"id\": 14\n            },\n            \"value\": \"14.00000\"\n          },\n          {\n            \"id\": 6062044,\n            \"type\": {\n              \"id\": 15\n            },\n            \"value\": \"15.00000\"\n          },\n          {\n            \"id\": 6062045,\n            \"type\": {\n              \"id\": 16\n            },\n            \"value\": \"16.00000\"\n          },\n          {\n            \"id\": 6062046,\n            \"type\": {\n              \"id\": 17\n            },\n            \"value\": \"17.00000\"\n          },\n          {\n            \"id\": 6062047,\n            \"type\": {\n              \"id\": 18\n            },\n            \"value\": \"0.00000\"\n          },\n          {\n            \"id\": 6062048,\n            \"type\": {\n              \"id\": 18\n            },\n            \"value\": \"0.00000\"\n          },\n          {\n            \"id\": 6062049,\n            \"type\": {\n              \"id\": 18\n            },\n            \"value\": \"0.00000\"\n          },\n          {\n            \"id\": 6062050,\n            \"type\": {\n              \"id\": 19\n            },\n            \"value\": \"19.00000\"\n          },\n          {\n            \"id\": 6062051,\n            \"type\": {\n              \"id\": 20\n            },\n            \"value\": \"20.00000\"\n          },\n          {\n            \"id\": 6062052,\n            \"type\": {\n              \"id\": 21\n            },\n            \"value\": \"21.00000\"\n          },\n          {\n            \"id\": 6062053,\n            \"type\": {\n              \"id\": 22\n            },\n            \"value\": \"22.00000\"\n          }\n        ],\n        \"note\": \"notes\"\n      }\n    },\n    \"ach\": null,\n    \"documents\": [\n      {\n        \"attachment\": {\n          \"id\": 5340728,\n          \"deletedOn\": null\n        },\n        \"about\": [\n          6\n        ],\n        \"principal\": {\n          \"id\": null\n        }\n      },\n      {\n        \"attachment\": {\n          \"id\": 5340735,\n          \"deletedOn\": null\n        },\n        \"about\": [\n          18\n        ],\n        \"principal\": {\n          \"id\": 296046\n        }\n      },\n      {\n        \"attachment\": {\n          \"id\": 5340744,\n          \"deletedOn\": null\n        },\n        \"about\": [\n          33\n        ],\n        \"principal\": {\n          \"id\": null\n        }\n      },\n      {\n        \"attachment\": {\n          \"id\": 5340791,\n          \"deletedOn\": null\n        },\n        \"about\": [\n          21\n        ],\n        \"principal\": {\n          \"id\": null\n        }\n      },\n      {\n        \"attachment\": {\n          \"id\": 5340793,\n          \"deletedOn\": null\n        },\n        \"about\": [\n          309\n        ],\n        \"principal\": {\n          \"id\": null\n        }\n      },\n      {\n        \"attachment\": {\n          \"id\": 5340794,\n          \"deletedOn\": null\n        },\n        \"about\": [\n          51\n        ],\n        \"principal\": {\n          \"id\": null\n        }\n      }\n    ],\n    \"agent\": {\n      \"id\": 109689\n    },\n    \"signature\": {\n      \"status\": \"Signed\",\n      \"via\": \"eSign\"\n    },\n    \"auto\": {\n      \"sign\": \"Yes\",\n      \"underwriting\": \"Yes\"\n    },\n    \"status\": \"Approved\",\n    \"updatedOn\": \"2023-08-18 11:08:06\",\n    \"createdOn\": \"2023-06-03 15:29:29\"\n  }\n}\n\n

\n","_postman_id":"0bb7bbb1-14ee-4407-a265-7059247f06a9"},{"name":"Merchant","item":[{"name":"Account","item":[{"name":"New Acquiring Account","item":[],"id":"1ad0207b-ef6b-4e5c-a5ce-8b736bd455c2","description":"

Notification when a new Acquiring Merchant is created.

{\n    \"id\": 7428,\n    \"module\": \"merchant\",\n    \"action\": \"acqCreate\",\n    \"date\": \"2023-08-18 11:00:12\",\n    \"data\": {\n        \"id\": 117038,\n        \"mid\": 123456789000,\n        \"bank\": {\n            \"name\": \"Axiom Bank\",\n            \"accountNumber\": \"6965\"\n        },\n        \"mcc\": \"8099\",\n        \"riskLevel\": \"High\",\n        \"status\": \"Live\",\n        \"boardedOn\": \"2023-07-19 17:02:47\",\n        \"volumes\": {\n            \"monthlyTransactionAmount\": 50000,\n            \"avgTransactionAmount\": 5000,\n            \"maxTransactionAmount\": 25000\n        },\n        \"sales\": {\n            \"swiped\": 0,\n            \"mail\": 100,\n            \"internet\": 0\n        },\n        \"feeSchedule\": {\n            \"fees\": [\n                {\n                    \"id\": 2785016,\n                    \"type\": {\n                        \"id\": 1\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785019,\n                    \"type\": {\n                        \"id\": 2\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785022,\n                    \"type\": {\n                        \"id\": 3\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785025,\n                    \"type\": {\n                        \"id\": 4\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785028,\n                    \"type\": {\n                        \"id\": 5\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785031,\n                    \"type\": {\n                        \"id\": 6\n                    },\n                    \"value\": \"0.05000\"\n                },\n                {\n                    \"id\": 2785034,\n                    \"type\": {\n                        \"id\": 7\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785037,\n                    \"type\": {\n                        \"id\": 8\n                    },\n                    \"value\": \"0.10000\"\n                },\n                {\n                    \"id\": 2785040,\n                    \"type\": {\n                        \"id\": 9\n                    },\n                    \"value\": \"0.10000\"\n                },\n                {\n                    \"id\": 2785043,\n                    \"type\": {\n                        \"id\": 10\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785046,\n                    \"type\": {\n                        \"id\": 11\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785049,\n                    \"type\": {\n                        \"id\": 12\n                    },\n                    \"value\": \"50.00000\"\n                },\n                {\n                    \"id\": 2785052,\n                    \"type\": {\n                        \"id\": 13\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785055,\n                    \"type\": {\n                        \"id\": 14\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785058,\n                    \"type\": {\n                        \"id\": 15\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785061,\n                    \"type\": {\n                        \"id\": 16\n                    },\n                    \"value\": \"25.00000\"\n                },\n                {\n                    \"id\": 2785064,\n                    \"type\": {\n                        \"id\": 17\n                    },\n                    \"value\": \"5.00000\"\n                },\n                {\n                    \"id\": 2785067,\n                    \"type\": {\n                        \"id\": 18\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785070,\n                    \"type\": {\n                        \"id\": 18\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785073,\n                    \"type\": {\n                        \"id\": 18\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785076,\n                    \"type\": {\n                        \"id\": 19\n                    },\n                    \"value\": \"0.00\"\n                },\n                {\n                    \"id\": 2785079,\n                    \"type\": {\n                        \"id\": 20\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785082,\n                    \"type\": {\n                        \"id\": 21\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 2785085,\n                    \"type\": {\n                        \"id\": 22\n                    },\n                    \"value\": \"0.00000\"\n                }\n            ],\n            \"note\": \"Additinal notes\"\n        }\n    }\n}\n\n

\n","_postman_id":"1ad0207b-ef6b-4e5c-a5ce-8b736bd455c2"},{"name":"New ACH Account","item":[],"id":"1a1c1aba-0ab9-48bb-bc23-dd460ce41185","description":"

Notification when a new ACH Merchant is created.

{\n    \"id\": 7431,\n    \"module\": \"merchant\",\n    \"action\": \"achCreate\",\n    \"date\": \"2023-08-18 11:02:34\",\n    \"data\": {\n        \"id\": 1565,\n        \"bank\": {\n            \"name\": \"UNITED COMMUNITY BANK\",\n            \"accountNumber\": \"9059\"\n        },\n        \"riskLevel\": \"High\",\n        \"status\": \"Inactive\",\n        \"boardedOn\": \"2023-07-05 19:40:54\",\n        \"volumes\": {\n            \"monthlyTransactions\": 30,\n            \"avgMonthlyTransactionAmount\": 50000,\n            \"avgTransactionAmount\": 900,\n            \"maxTransactionAmount\": 5000\n        },\n        \"feeSchedule\": {\n            \"fees\": [\n                {\n                    \"id\": 18710,\n                    \"type\": {\n                        \"id\": 25\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 18713,\n                    \"type\": {\n                        \"id\": 26\n                    },\n                    \"value\": \"0.75000\"\n                },\n                {\n                    \"id\": 18716,\n                    \"type\": {\n                        \"id\": 27\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18719,\n                    \"type\": {\n                        \"id\": 28\n                    },\n                    \"value\": \"1.50000\"\n                },\n                {\n                    \"id\": 18722,\n                    \"type\": {\n                        \"id\": 29\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18725,\n                    \"type\": {\n                        \"id\": 30\n                    },\n                    \"value\": \"0.75000\"\n                },\n                {\n                    \"id\": 18728,\n                    \"type\": {\n                        \"id\": 31\n                    },\n                    \"value\": \"15.00000\"\n                },\n                {\n                    \"id\": 18731,\n                    \"type\": {\n                        \"id\": 32\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18734,\n                    \"type\": {\n                        \"id\": 33\n                    },\n                    \"value\": \"15.00000\"\n                },\n                {\n                    \"id\": 18737,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"25.00000\"\n                },\n                {\n                    \"id\": 18740,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 18743,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"0.00000\"\n                }\n            ],\n            \"note\": null\n        }\n    }\n}\n\n

\n","_postman_id":"1a1c1aba-0ab9-48bb-bc23-dd460ce41185"},{"name":"Closed Acquiring Account","item":[],"id":"49dc6ae7-0cb9-4f7e-825e-f22f4b44616e","description":"

Notification when a new ACH Merchant is created.

{\n    \"id\": 7431,\n    \"module\": \"merchant\",\n    \"action\": \"achCreate\",\n    \"date\": \"2023-08-18 11:02:34\",\n    \"data\": {\n        \"id\": 1565,\n        \"bank\": {\n            \"name\": \"UNITED COMMUNITY BANK\",\n            \"accountNumber\": \"9059\"\n        },\n        \"riskLevel\": \"High\",\n        \"status\": \"Inactive\",\n        \"boardedOn\": \"2023-07-05 19:40:54\",\n        \"volumes\": {\n            \"monthlyTransactions\": 30,\n            \"avgMonthlyTransactionAmount\": 50000,\n            \"avgTransactionAmount\": 900,\n            \"maxTransactionAmount\": 5000\n        },\n        \"feeSchedule\": {\n            \"fees\": [\n                {\n                    \"id\": 18710,\n                    \"type\": {\n                        \"id\": 25\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 18713,\n                    \"type\": {\n                        \"id\": 26\n                    },\n                    \"value\": \"0.75000\"\n                },\n                {\n                    \"id\": 18716,\n                    \"type\": {\n                        \"id\": 27\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18719,\n                    \"type\": {\n                        \"id\": 28\n                    },\n                    \"value\": \"1.50000\"\n                },\n                {\n                    \"id\": 18722,\n                    \"type\": {\n                        \"id\": 29\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18725,\n                    \"type\": {\n                        \"id\": 30\n                    },\n                    \"value\": \"0.75000\"\n                },\n                {\n                    \"id\": 18728,\n                    \"type\": {\n                        \"id\": 31\n                    },\n                    \"value\": \"15.00000\"\n                },\n                {\n                    \"id\": 18731,\n                    \"type\": {\n                        \"id\": 32\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18734,\n                    \"type\": {\n                        \"id\": 33\n                    },\n                    \"value\": \"15.00000\"\n                },\n                {\n                    \"id\": 18737,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"25.00000\"\n                },\n                {\n                    \"id\": 18740,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 18743,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"0.00000\"\n                }\n            ],\n            \"note\": null\n        }\n    }\n}\n\n

\n","_postman_id":"49dc6ae7-0cb9-4f7e-825e-f22f4b44616e"},{"name":"Closed ACH Account","item":[],"id":"3c7591fe-0889-43f1-b57a-f85dc81889a5","description":"

Notification when an ACH Merchant is closed.

{\n    \"id\": 7431,\n    \"module\": \"merchant\",\n    \"action\": \"achClose\",\n    \"date\": \"2023-08-18 11:02:34\",\n    \"data\": {\n        \"id\": 1565,\n        \"bank\": {\n            \"name\": \"UNITED COMMUNITY BANK\",\n            \"accountNumber\": \"9059\"\n        },\n        \"riskLevel\": \"High\",\n        \"status\": \"Closed\",\n        \"boardedOn\": \"2023-07-05 19:40:54\",\n        \"volumes\": {\n            \"monthlyTransactions\": 30,\n            \"avgMonthlyTransactionAmount\": 50000,\n            \"avgTransactionAmount\": 900,\n            \"maxTransactionAmount\": 5000\n        },\n        \"feeSchedule\": {\n            \"fees\": [\n                {\n                    \"id\": 18710,\n                    \"type\": {\n                        \"id\": 25\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 18713,\n                    \"type\": {\n                        \"id\": 26\n                    },\n                    \"value\": \"0.75000\"\n                },\n                {\n                    \"id\": 18716,\n                    \"type\": {\n                        \"id\": 27\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18719,\n                    \"type\": {\n                        \"id\": 28\n                    },\n                    \"value\": \"1.50000\"\n                },\n                {\n                    \"id\": 18722,\n                    \"type\": {\n                        \"id\": 29\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18725,\n                    \"type\": {\n                        \"id\": 30\n                    },\n                    \"value\": \"0.75000\"\n                },\n                {\n                    \"id\": 18728,\n                    \"type\": {\n                        \"id\": 31\n                    },\n                    \"value\": \"15.00000\"\n                },\n                {\n                    \"id\": 18731,\n                    \"type\": {\n                        \"id\": 32\n                    },\n                    \"value\": \"00.00000\"\n                },\n                {\n                    \"id\": 18734,\n                    \"type\": {\n                        \"id\": 33\n                    },\n                    \"value\": \"15.00000\"\n                },\n                {\n                    \"id\": 18737,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"25.00000\"\n                },\n                {\n                    \"id\": 18740,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"0.00000\"\n                },\n                {\n                    \"id\": 18743,\n                    \"type\": {\n                        \"id\": 35\n                    },\n                    \"value\": \"0.00000\"\n                }\n            ],\n            \"note\": null\n        }\n    }\n}\n\n

\n","_postman_id":"3c7591fe-0889-43f1-b57a-f85dc81889a5"}],"id":"eaa25a56-5ec8-44f0-a989-0e38c3a6a126","_postman_id":"eaa25a56-5ec8-44f0-a989-0e38c3a6a126","description":""},{"name":"Terminal","item":[{"name":"New Terminal Record","item":[],"id":"a8012850-612a-4179-8e68-1e7df9d82a41","description":"

Notification when a new Merchant terminal is created

{\n  \"id\": 1722,\n  \"module\": \"merchantTerminal\",\n  \"action\": \"create\",\n  \"date\": \"2023-06-28 14:23:19\",\n  \"data\": {\n    \"id\": 154163,\n    \"dba\": {\n      \"id\": 98555,\n      \"name\": \"DBA Name\"\n    },\n    \"merchant\": {\n      \"id\": 85646,\n      \"name\": \"Merchant Demo\"\n    },\n    \"name\": \"Terminal name\",\n    \"tid\": 9990,\n    \"vNumber\": \"123\",\n    \"equipment\": null,\n    \"gateway\": {\n      \"provider\": \"Internal\",\n      \"activatedOn\": null,\n      \"3DsStatus\": \"Optional\"\n    },\n    \"feeTerminalId\": null,\n    \"website\": \"https://www.test.com\",\n    \"note\": \"\",\n    \"acceptVisa\": \"Yes\",\n    \"acceptMastercard\": \"Yes\",\n    \"acceptDiscover\": \"Yes\",\n    \"acceptAmericanExpress\": \"Yes\",\n    \"acceptPinDebit\": \"No\",\n    \"acceptEbt\": \"Yes\",\n    \"acceptGiftCard\": \"No\",\n    \"chain\": false,\n    \"agentBank\": false,\n    \"storeNumber\": \"0003\",\n    \"locationNumber\": \"00001\",\n    \"createdOn\": \"2023-06-28 17:23:19\"\n  }\n}\n\n

\n","_postman_id":"a8012850-612a-4179-8e68-1e7df9d82a41"},{"name":"Update Terminal Record","item":[],"id":"d0fdef4c-7d8b-478b-a1a9-9f2d5e22df41","description":"

Notification when a merchant terminal is updated

{\n  \"id\": 1717,\n  \"module\": \"merchantTerminal\",\n  \"action\": \"update\",\n  \"date\": \"2023-06-28 14:19:12\",\n  \"data\": {\n    \"id\": 154162,\n    \"dba\": {\n      \"id\": 98555,\n      \"name\": \"DBA Name\"\n    },\n    \"merchant\": {\n      \"id\": 85646,\n      \"name\": \"Merchant Name\"\n    },\n    \"name\": \"Terminal name\",\n    \"tid\": 9990,\n    \"vNumber\": \"123\",\n    \"equipment\": {\n      \"providedBy\": \"ISO\",\n      \"used\": \"test Equipment Used\",\n      \"note\": \"test Equipment Note\",\n      \"discountPeriod\": \"Monthly\",\n      \"fundingPeriod\": \"TwoBusinessDays\"\n    },\n    \"gateway\": {\n      \"provider\": \"Internal\",\n      \"activatedOn\": \"2023-06-28 17:18:31\",\n      \"3DsStatus\": \"Optional\"\n    },\n    \"feeTerminalId\": null,\n    \"website\": \"https://www.test.com\",\n    \"note\": \"\",\n    \"acceptVisa\": \"Yes\",\n    \"acceptMastercard\": \"Yes\",\n    \"acceptDiscover\": \"Yes\",\n    \"acceptAmericanExpress\": \"Yes\",\n    \"acceptPinDebit\": \"No\",\n    \"acceptEbt\": \"Yes\",\n    \"acceptGiftCard\": \"No\",\n    \"chain\": false,\n    \"agentBank\": false,\n    \"storeNumber\": \"0003\",\n    \"locationNumber\": \"00001\",\n    \"createdOn\": \"2023-06-28 17:18:12\"\n  }\n}\n\n

\n","_postman_id":"d0fdef4c-7d8b-478b-a1a9-9f2d5e22df41"},{"name":"Delete Terminal Record","item":[],"id":"4f04a356-db6f-443d-bc60-433d6799b560","description":"

Notification when a merchant terminal is deleted

{\n  \"id\": 1721,\n  \"module\": \"merchantTerminal\",\n  \"action\": \"delete\",\n  \"date\": \"2023-06-28 14:20:33\",\n  \"data\": {\n    \"id\": 154162,\n    \"dba\": {\n      \"id\": 98555,\n      \"name\": \"DBA Name\"\n    },\n    \"merchant\": {\n      \"id\": 85646,\n      \"name\": \"Merchant Name\"\n    },\n    \"name\": \"Terminal name\",\n    \"tid\": 9990,\n    \"vNumber\": \"123\",\n    \"equipment\": {\n      \"providedBy\": \"ISO\",\n      \"used\": \"test Equipment Used\",\n      \"note\": \"test Equipment Note\",\n      \"discountPeriod\": \"Monthly\",\n      \"fundingPeriod\": \"TwoBusinessDays\"\n    },\n    \"gateway\": {\n      \"provider\": \"Internal\",\n      \"activatedOn\": \"2023-06-28 17:19:32\",\n      \"3DsStatus\": \"Optional\"\n    },\n    \"feeTerminalId\": null,\n    \"website\": \"https://www.test.com\",\n    \"note\": \"\",\n    \"acceptVisa\": \"Yes\",\n    \"acceptMastercard\": \"Yes\",\n    \"acceptDiscover\": \"Yes\",\n    \"acceptAmericanExpress\": \"Yes\",\n    \"acceptPinDebit\": \"No\",\n    \"acceptEbt\": \"Yes\",\n    \"acceptGiftCard\": \"No\",\n    \"chain\": false,\n    \"agentBank\": false,\n    \"storeNumber\": \"0003\",\n    \"locationNumber\": \"00001\",\n    \"createdOn\": \"2023-06-28 17:18:12\"\n  }\n}\n\n

\n","_postman_id":"4f04a356-db6f-443d-bc60-433d6799b560"}],"id":"842e53e5-8375-4bb0-bb38-4a01cec70f52","description":"

Terminal information events you can subscribe to. This webhook group is helpful when you have newly approved MIDs or if there have been updates with their terminals.

\n","_postman_id":"842e53e5-8375-4bb0-bb38-4a01cec70f52"}],"id":"28ea4af5-6d6b-4437-8e56-260e01458a87","description":"

Merchant group of events you can subscribe to

\n","_postman_id":"28ea4af5-6d6b-4437-8e56-260e01458a87"},{"name":"ACH","item":[{"name":"New ACH Record","item":[],"id":"c1ec3f9a-6044-40a4-b524-11ded5bc0a6b","description":"

Notification when a new ACH record is created.

Event Identification

{\n    ...\n    \"module\": \"ach\",\n    \"action\": \"create\",\n    \"data\": achObject,\n    ...\n}\n\n

\n","_postman_id":"c1ec3f9a-6044-40a4-b524-11ded5bc0a6b"},{"name":"ACH Status Update","item":[],"id":"c59d461f-8c11-4d49-8b33-a7d4a03beb34","description":"

Notification when an ACH status is updated.

Event Identification

{\n    ...\n    \"module\": \"ach\",\n    \"action\": \"updateStatus\",\n    \"data\": achObject,\n    ...\n}\n

\n","_postman_id":"c59d461f-8c11-4d49-8b33-a7d4a03beb34"},{"name":"New ACH Customer","item":[],"id":"92478ae5-7005-4816-8c6c-715c2f35e796","description":"

Notification when a new ACH Customer has been successfully added.

{\n    ...\n    \"module\": \"ach\",\n    \"action\": \"createCustomer\",\n    \"data\": achObject,\n    ...\n}\n\n

\n","_postman_id":"92478ae5-7005-4816-8c6c-715c2f35e796"}],"id":"b1e79062-855b-4113-bf93-4bcca3a24f5a","description":"

All the ACH group of events you can subscribe to.

\n","_postman_id":"b1e79062-855b-4113-bf93-4bcca3a24f5a"},{"name":"Chargeback","item":[{"name":"New Chargeback Record","item":[],"id":"4f2c7627-315f-4ed9-a355-8555663070c1","description":"

Notification when a new Chargeback record is created.

Event Identification

{\n    ...\n    \"module\": \"chargeback\",\n    \"action\": \"create\",\n    \"data\": chargebackObject,\n    ...\n}\n

\n","_postman_id":"4f2c7627-315f-4ed9-a355-8555663070c1"},{"name":"Chargeback Update","item":[],"id":"c6a012fe-6c70-45ef-ae77-db3d28988089","description":"

Notification when a Chargeback is updated.

Event Identification

{\n    ...\n    \"module\": \"chargeback\",\n    \"action\": \"update\",\n    \"data\": chargebackObject,\n    ...\n}\n

\n","_postman_id":"c6a012fe-6c70-45ef-ae77-db3d28988089"}],"id":"78755bca-cf11-4d20-939b-f9e3912f4349","description":"

Chargeback group of events you can subscribe to.

Chargeback Object

Fields	Description	Type
id	The unique ID assigned by our system to every case.	Integer
dba	Object	Object
dba.id	The ID of the DBA	Integer
identifier	The Merchant Identification Number (MID)	Integer
disputeId	We assign a unique ID to the first case of a dispute. Every related case update will have a unique id and the same disputeId.	Integer
merchantRefId	A reference number provided by merchant or their vendor for this transaction.	String
merchantEmail	Merchant email address	String
number	The unique number assigned by the bank system to every case.	String
type	`Chargeback` or `Retrieval`	ENUM
visaRDR	`Yes` or `No` Identifies if the chargeback is Visa RDR	ENUM
authCode	The authorization code passed with the settlement record	String
acquirerReferenceNumber	Unique number assigned to a credit card transaction as it moves through the payment flow.	String
gatewayId	Unique ID of the Payment Gateway	Integer
gatewayExternalId	Unique record identifiers from a system outside of Payment Gateway	String
amount	The amount of the retrieval or chargeback. This is not always equal to the amount of the transaction.	Number
transaction	Object	Object
transaction.number	The unique payment ID that is assigned per transaction from the system.	String
transaction.amount	The original transaction amount.	Number
transaction.date	Transaction Date	Date
transaction.card	Object	Object
transaction.card.brand	Card Brand	String
transaction.card.number	Card Number	String
date	Object	Object
date.posted	The post date as reported by the issuer.	Date
date.loaded	The date the retrieval request or chargeback was loaded in the system.	Date
date.disputed	Date when the dispute was submitted.	Date
date.receivedDate	Date the retrieval request or chargeback was submitted by the Issuer.	Date
date.lastActionDate	Date the case needs to be resolved.	Date
description	Case information.	String
fraud	`Yes` or `No`	ENUM
attention	`Yes` or `No` If the merchant's attention is required	ENUM
status	`Processed`, `Won`, `Lost`	ENUM

Example

{\n    \"id\": \"200\",\n    \"dba\": {\n        \"id\": \"1217\"\n    },\n    \"identifier\": \"201100000000\",\n    \"disputeId\": \"100\",\n    \"merchantRefId\": \"0123456\",\n    \"merchantEmail\": \"jhon@example.com\",\n    \"number\": \"2019248118022\",\n    \"type\": \"Chargeback\",\n    \"visaRDR\": \"No\",\n    \"authCode\": \"1233123R\",\n    \"acquirerReferenceNumber\": null,\n    \"gateway\": {\n        \"id\": 24,\n        \"externalId\": null\n    },\n    \"amount\": 33.49,\n    \"transaction\": {\n        \"number\": \"111119380905678\",\n        \"amount\": 33.49,\n        \"date\": \"2019-12-01\",\n        \"card\": {\n            \"brand\": \"Visa\",\n            \"number\": \"412345XXXXXX1234\"\n        }\n    },\n    \"date\": {\n        \"posted\": \"2019-12-10\",\n        \"loaded\": \"2019-12-15\",\n        \"disputed\": \"2019-12-09\",\n        \"receivedDate\": \"2019-12-09\",\n        \"lastActionDate\": \"2019-12-19\"\n    },\n    \"description\": \"Cancelled Recurring Transaction\",\n    \"fraud\": \"No\",\n    \"attention\": \"Yes\",\n    \"status\": \"Lost\"\n}\n

\n","_postman_id":"78755bca-cf11-4d20-939b-f9e3912f4349"},{"name":"Connect","item":[{"name":"Access Granted","item":[],"id":"479064ae-0626-4b5a-ba56-5c6e508c1ee5","description":"

Notification when new access has been granted

{\n    \"id\": 8083,\n    \"module\": \"appConnect\",\n    \"action\": \"grantAccess\",\n    \"date\": \"2023-09-27 14:22:22\",\n    \"data\": {\n        \"appConnect\": {\n            \"id\": 13\n        },\n        \"user\": {\n            \"id\": 22,\n            \"name\": \"John Wick\"\n        },\n        \"scope\": [\n            3,\n            12,\n            28,\n            35\n        ]\n    }\n}\n\n

\n","_postman_id":"479064ae-0626-4b5a-ba56-5c6e508c1ee5"},{"name":"Access Updated","item":[],"id":"f956077c-53b0-4fd2-9bfe-5bfc04f90b2f","description":"

Notification when modifications have been made to existing granted access

{\n    \"id\": 8086,\n    \"module\": \"appConnect\",\n    \"action\": \"updateAccess\",\n    \"date\": \"2023-09-27 14:23:38\",\n    \"data\": {\n        \"appConnect\": {\n            \"id\": 98\n        },\n        \"user\": {\n            \"id\": 97,\n            \"name\": \"John Wick\"\n        },\n        \"scope\": [\n            6,\n            11,\n            26,\n            35\n        ]\n    }\n}\n\n

\n","_postman_id":"f956077c-53b0-4fd2-9bfe-5bfc04f90b2f"},{"name":"Access Revoked","item":[],"id":"be6147ee-d011-49be-8ae2-8690f05c669c","description":"

Notification when access has been revoked.

{\n    \"id\": 8089,\n    \"module\": \"appConnect\",\n    \"action\": \"revokeAccess\",\n    \"date\": \"2023-09-27 14:24:26\",\n    \"data\": {\n        \"appConnect\": {\n            \"id\": 89\n        },\n        \"user\": {\n            \"id\": 95,\n            \"name\": \"John Wick\"\n        },\n        \"scope\": [\n            3,\n            19,\n            25,\n            40\n        ]\n    }\n}\n\n

\n","_postman_id":"be6147ee-d011-49be-8ae2-8690f05c669c"}],"id":"cfb9e124-6b1e-4c42-bb9f-e04d8940b15f","description":"

All Connect events you can subscribe to.

\n","_postman_id":"cfb9e124-6b1e-4c42-bb9f-e04d8940b15f"}],"id":"cec2a001-e769-4611-9396-82f207f7cb7f","description":"

Groups of events you can subscribe to.

\n","_postman_id":"cec2a001-e769-4611-9396-82f207f7cb7f"}],"id":"b8d81eb3-447f-4c0d-ad39-b75845e8abae","description":"

Use webhooks to be notified about events that happen in your account.

Webhook Object

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

Fields	Description	Type
id	Unique ID of the event	Integer
module	Event group	String
action	Event identifier	String
date	Date of the event	Datetime
data	Event Data	Object

Example

{\n    \"id\": \"1\",\n    \"module\": \"ach\",\n    \"action\": \"create\",\n    \"date\": \"2019-08-03 19:31:55\",\n    \"data\": {...}\n}\n

\n","_postman_id":"b8d81eb3-447f-4c0d-ad39-b75845e8abae"}],"event":[{"listen":"prerequest","script":{"id":"114fcb7f-0462-4f32-9e2a-d6bee41bb3b2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1d9fb58a-24dc-489e-8011-ec16a0b0b1e5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"dashboard.url","value":"https://dashboard.dashboard.paysecureonline.com","type":"string"},{"key":"gateway.url","value":"https://gateway.dashboard.paysecureonline.com","type":"string"},{"key":"example.url","value":"https://dashboard.paysecureonline.com","type":"string"},{"key":"sandbox-gateway.url","value":"https://sandbox-gateway.paysecureonline.com/"},{"key":"sandbox-dashboard.url","value":"https://sandbox-dashboard.paysecureonline.com/"},{"key":"token.agent","value":"XXX","type":"string"},{"key":"token.merchant","value":"XXX","type":"string"},{"key":"token.appConnect","value":"XXX","type":"string"}]}