{"info":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","description":"

This API is a comprehensive and secure solution for financial management, facilitating critical operations for accounts, cards, and transactions, enabling seamless integration into modern digital banking platforms or financial services. Its modular structure and use of advanced patterns ensure that the system is flexible, scalable, and ready to meet industry standards and security regulations in the financial sector.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38009757","collectionId":"d0eae2e7-42cf-4299-893a-08b659298531","publishedId":"2sB3QFPXHi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-14T21:49:35.000Z"},"item":[{"name":"Card Functions","item":[{"name":"Status","item":[{"name":"Manage Status","item":[{"name":"/api/v1/card/manage-status","id":"ef93821c-5459-4c73-9379-75ab295c8de7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"newStatus\": \"\",\n \"reason\": \"\",\n \"generateNewCard\": \"\",\n \"externalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/card/manage-status","description":"

Manage Card Status

\n

This endpoint allows the user to manage the status of a card by updating various parameters. All fields are required.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDesciption
card IduuidThe unique identifier of the card.
new StatusintegerThe new status to be assigned to the card.
reasonstringThe reason for updating the card status.
generate New CardbooleanIndicates whether a new card should be generated.
external ReferencestringAn external reference associated with the card status update.
\n

Response

\n

If all is ok, the response will contain the ID of the card affected.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card","manage-status"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"59f4c949-6543-4c04-84bd-86acde85163f","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain"},{"key":"X-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"newStatus\": \"\",\n \"reason\": \"\",\n \"generateNewCard\": \"\",\n \"externalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"http://172.233.164.113:8440/api/v1/card/manage-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ef93821c-5459-4c73-9379-75ab295c8de7"}],"id":"3a6c7e93-10a7-4b42-ab6a-1213a9031acc","description":"

The method allows updating the status of a card through an HTTP POST request. Its main functionality is to manage card status changes based on the parameters provided in the request.

\n","_postman_id":"3a6c7e93-10a7-4b42-ab6a-1213a9031acc","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"/api/v1/card/status","id":"04b1d9d8-88d5-4fde-bfc7-b070f86cc68b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"isBlocked\": \"\",\n \"note\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/card/status","description":"

POST /api/v1/card/status

\n

This endpoint is used to update the status of a card. With this method you can block or unblock a card.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequired?Description
card IdstringrequiredThe unique identifier of the card.
is BlockedbooleanrequiredIndicates whether the card is blocked or not.
notestringoptionalAdditional notes or comments related to the status update.
\n

Response

\n

The response for this request is the ID of the card affected.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card","status"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"543e462b-9649-40ec-9c1d-344fa6dc5860","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"isBlocked\": \"\",\n \"note\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/card/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"04b1d9d8-88d5-4fde-bfc7-b070f86cc68b"}],"id":"29d70024-b8ae-4d97-bbc4-6e34b1644804","description":"

Allows changing the status of a card.

\n","_postman_id":"29d70024-b8ae-4d97-bbc4-6e34b1644804","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Entity","item":[{"name":"Id Card Plans","item":[{"name":"/api/v1/cardplan/entity/:id","id":"51d5ba15-d63a-4ec4-8490-ec4245d52fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/cardplan/entity/:id","description":"

This endpoint retrieves the card plan entity details based on the provided entityId.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://dev.viacarte.com:8440/api/v1/cardplan/entity/:id

    \n
    • \n
\n

Response

\n

The response will include an array of objects, where each object represents a card plan entity with the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDesciption
idstring
namestring
descriptionstring
codestring
currencyCodestring
maximumBalanceLimitstring
maximumBalanceLimitstring
limitstring
cardDesignIdstring
cardDesignobjectDetails of the card design including id, name, description, image paths, colors, and bank logo path
logoPathstring
entityobjectDetails of the entity including id, name, business name, legal id, description, logo, website, email, phone, address, country details, account parent id, settlement currency details, billing currency details, billing contact information, custom color, balance details, wallet pocket details, and total wallet balance
cardBrandobjectDetails of the card brand including id, name, description, logo path, card image path, and first digit
currencyobjectDetails of the currency including id, name, alpha code, decimal places, and activity status
headersstring
benefitsstring
ruleGroupsIdarrayArray of rule group IDs
ruleGroupsarrayArray of rule groups with details including id, name, description, type, and risk level
termsstring
isActiveboolean
programsarrayArray of programs associated with details including its ID, name, description, status and assigned flows for KYC verifications.
\n

Please note that the actual data values are intentionally masked for privacy.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","cardplan","entity",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"96209a62-d62a-4016-925f-28ed87615b6c","type":"any","value":"","key":"id"}]}},"response":[{"id":"75f97e6d-3f94-4888-b493-982779641a71","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/cardplan/entity/:id","protocol":"https","host":["dev","viacarte","com"],"port":"8440","path":["api","v1","cardplan","entity",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\",\n \"programs\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isActive\": \"\",\n \"assignedFlows\": [\"\", \"\", \"\"]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isActive\": \"\",\n \"assignedFlows\": [\"\", \"\", \"\"]\n }\n ]\n }\n]"}],"_postman_id":"51d5ba15-d63a-4ec4-8490-ec4245d52fbc"},{"name":"/api/v1/cardplan/program/:id","id":"21b5f79a-5d2b-46c5-bcd1-fddf049ac263","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/cardplan/program/:id","description":"

This endpoint retrieves the card plan program details based on the provided programId.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://dev.viacarte.com:8440/api/v1/cardplan/program/:id

    \n
    • \n
\n

Response

\n

The response will include an array of objects, where each object represents a card plan entity with the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDesciption
idstring
namestring
descriptionstring
codestring
currencyCodestring
maximumBalanceLimitstring
maximumBalanceLimitstring
limitstring
cardDesignIdstring
cardDesignobjectDetails of the card design including id, name, description, image paths, colors, and bank logo path
logoPathstring
entityobjectDetails of the entity including id, name, business name, legal id, description, logo, website, email, phone, address, country details, account parent id, settlement currency details, billing currency details, billing contact information, custom color, balance details, wallet pocket details, and total wallet balance
cardBrandobjectDetails of the card brand including id, name, description, logo path, card image path, and first digit
currencyobjectDetails of the currency including id, name, alpha code, decimal places, and activity status
headersstring
benefitsstring
ruleGroupsIdarrayArray of rule group IDs
ruleGroupsarrayArray of rule groups with details including id, name, description, type, and risk level
termsstring
isActiveboolean
\n

Please note that the actual data values are intentionally masked for privacy.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","cardplan","program",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"7621c7d6-9397-4ddc-9689-2aa2fe1dad5b","type":"any","value":"","key":"id"}]}},"response":[{"id":"0e019f5a-9d7e-4d5d-904f-2f17565e9a05","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/cardplan/program/:id","protocol":"https","host":["dev","viacarte","com"],"port":"8440","path":["api","v1","cardplan","program",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n }\n]"}],"_postman_id":"21b5f79a-5d2b-46c5-bcd1-fddf049ac263"}],"id":"d4f952b0-632d-4559-b374-12d6cf8beb38","description":"

This method retrieves a list of card plans associated with a specific entity using its identifier (entityId).

\n","_postman_id":"d4f952b0-632d-4559-b374-12d6cf8beb38","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Id Entity Cards","item":[{"name":"/api/v1/card/entity/:id","id":"2cec4271-3890-4008-b626-d85b10a0c964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/card/entity/:id","description":"

The endpoint performs an HTTP GET request to retrieve the cards associated to an specific entity by the entity ID.

\n

The response for this request is a JSON object containing details about the cards entity, including its ID, expiry date, emboss name, last four digits, card token, account parent ID, processor account ID, card type, card plan ID, network status, account ID, additional card status, card plan details, card design details, card brand details, entity information, currency details, headers, benefits, rule groups, terms, and activation status.

\n

The response also includes balance information, such as pending balance amount, actual balance amount, blocked balance amount, balance currency, and available balance amount.

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"expiry\": {\"type\": \"string\"},\n    \"embossName\": {\"type\": \"string\"},\n    \"lastFourDigit\": {\"type\": \"string\"},\n    \"cardToken\": {\"type\": \"string\"},\n    \"accountParentId\": {\"type\": \"string\"},\n    \"processorAccountId\": {\"type\": \"string\"},\n    \"cardType\": {\"type\": \"string\"},\n    \"cardPlanId\": {\"type\": \"string\"},\n    \"statusNetwork\": {\"type\": \"string\"},\n    \"accountId\": {\"type\": \"string\"},\n    \"isAdditionalCard\": {\"type\": \"string\"},\n    \"cardPlan\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\"type\": \"string\"},\n        \"name\": {\"type\": \"string\"},\n        \"description\": {\"type\": \"string\"},\n        \"code\": {\"type\": \"string\"},\n        \"currencyCode\": {\"type\": \"string\"},\n        \"maximumBalanceLimit\": {\"type\": \"string\"},\n        \"limit\": {\"type\": \"string\"},\n        \"cardDesignId\": {\"type\": \"string\"},\n        \"logoPath\": {\"type\": \"string\"},\n        \"entity\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"id\": {\"type\": \"string\"},\n            \"name\": {\"type\": \"string\"},\n            \"businessName\": {\"type\": \"string\"},\n            \"legalId\": {\"type\": \"string\"},\n            \"description\": {\"type\": \"string\"},\n            \"logo\": {\"type\": \"string\"},\n            \"website\": {\"type\": \"string\"},\n            \"email\": {\"type\": \"string\"},\n            \"phone\": {\"type\": \"string\"},\n            \"address\": {\"type\": \"string\"},\n            \"countryId\": {\"type\": \"string\"},\n            \"cardBrand\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"id\": {\"type\": \"string\"},\n                \"name\": {\"type\": \"string\"},\n                \"description\": {\"type\": \"string\"},\n                \"logoPath\": {\"type\": \"string\"},\n                \"cardImagePath\": {\"type\": \"string\"},\n                \"firstDigit\": {\"type\": \"string\"}\n              }\n            },\n            \"currency\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"id\": {\"type\": \"string\"},\n                \"name\": {\"type\": \"string\"},\n                \"alphaCode\": {\"type\": \"string\"},\n                \"decimalPlaces\": {\"type\": \"string\"},\n                \"isActive\": {\"type\": \"string\"}\n              }\n            },\n            \"balance\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"pendingBalanceAmount\": {\"type\": \"string\"},\n                \"actualBalanceAmount\": {\"type\": \"string\"},\n                \"blockedBalanceAmount\": {\"type\": \"string\"},\n                \"balanceCurrency\": {\"type\": \"string\"},\n                \"availableBalanceAmount\": {\"type\": \"string\"}\n              }\n            }\n          }\n        }\n      }\n    },\n    \"cardDesign\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\"type\": \"string\"},\n        \"name\": {\"type\": \"string\"},\n        \"description\": {\"type\": \"string\"},\n        \"imagePath\": {\"type\": \"string\"},\n        \"bankLogoPath\": {\"type\": \"string\"},\n        \"watermarkPath\": {\"type\": \"string\"},\n        \"cardColor\": {\"type\": \"string\"},\n        \"watermarkColor\": {\"type\": \"string\"}\n      }\n    },\n    \"cardBrand\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\"type\": \"string\"},\n        \"name\": {\"type\": \"string\"},\n        \"description\": {\"type\": \"string\"},\n        \"logoPath\": {\"type\": \"string\"},\n        \"cardImagePath\": {\"type\": \"string\"},\n        \"firstDigit\": {\"type\": \"string\"}\n      }\n    },\n    \"entity\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\"type\": \"string\"},\n        \"name\": {\"type\": \"string\"},\n        \"businessName\": {\"type\": \"string\"},\n        \"legalId\": {\"type\": \"string\"},\n        \"description\": {\"type\": \"string\"},\n        \"logo\": {\"type\": \"string\"},\n        \"website\": {\"type\": \"string\"},\n        \"email\": {\"type\": \"string\"},\n        \"phone\": {\"type\": \"string\"},\n        \"address\": {\"type\": \"string\"},\n        \"countryId\": {\"type\": \"string\"},\n        \"balance\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"pendingBalanceAmount\": {\"type\": \"string\"},\n            \"actualBalanceAmount\": {\"type\": \"string\"},\n            \"blockedBalanceAmount\": {\"type\": \"string\"},\n            \"balanceCurrency\": {\"type\": \"string\"},\n            \"availableBalanceAmount\": {\"type\": \"string\"}\n          }\n        }\n      }\n    }\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card","entity",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"93efda70-eca9-4da0-a898-3cfd2b13e44f","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ed6387a5-85f9-4960-8038-f3b3c3e3fa15","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/card/entity/:id","protocol":"https","host":["dev","viacarte","com"],"port":"8440","path":["api","v1","card","entity",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"expiry\": \"\",\n \"embossName\": \"\",\n \"lastFourDigit\": \"\",\n \"cardToken\": \"\",\n \"accountParentId\": \"\",\n \"processorAccountId\": \"\",\n \"cardType\": \"\",\n \"cardPlanId\": \"\",\n \"statusNetwork\": \"\",\n \"accountId\": \"\",\n \"isAdditionalCard\": \"\",\n \"cardPlan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"expiry\": \"\",\n \"embossName\": \"\",\n \"lastFourDigit\": \"\",\n \"cardToken\": \"\",\n \"accountParentId\": \"\",\n \"processorAccountId\": \"\",\n \"cardType\": \"\",\n \"cardPlanId\": \"\",\n \"statusNetwork\": \"\",\n \"accountId\": \"\",\n \"isAdditionalCard\": \"\",\n \"cardPlan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n }\n]"}],"_postman_id":"2cec4271-3890-4008-b626-d85b10a0c964"}],"id":"7e48090c-2bca-4424-b757-0964b8f6a96a","description":"

Retrieves all cards associated with a specific entity using the entity's identifier (id).

\n","_postman_id":"7e48090c-2bca-4424-b757-0964b8f6a96a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Id Entity Programs","item":[{"name":"/api/v1/program/entity/:id","id":"5ce553cd-be03-4e13-a09a-d77fadf6de0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/program/entity/:id","description":"

The endpoint performs an HTTP GET request to retrieve the programs associated to an specific entity by the entity ID.

\n

The response for this request is a JSON object containing details about the programs entity, including its ID, name, description, status and assigned flows for KYC verifications.

\n
{\n  \"id\": \"<uuid>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isActive\": \"<boolean>\",\n  \"assignedFlows\": [\"<string>\", \"<string>\", \"<string>\"]\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","program","entity",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"86ec7965-de0b-44e4-b3d4-03b0fa8c3e86","type":"any","value":"","key":"id"}]}},"response":[{"id":"babb3ca5-30bb-4361-b672-fb470220f861","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/program/entity/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","program","entity",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isActive\": \"\",\n \"assignedFlows\": [\"\", \"\", \"\"]\n }\n]"}],"_postman_id":"5ce553cd-be03-4e13-a09a-d77fadf6de0c"}],"id":"a1f66783-15ed-4db9-8a64-b61eab071114","_postman_id":"a1f66783-15ed-4db9-8a64-b61eab071114","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"501f2717-f612-49b0-a734-e1c60c750e10","_postman_id":"501f2717-f612-49b0-a734-e1c60c750e10","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Customer","item":[{"name":"{Id}","item":[{"name":"/api/v1/card/customer/:id","id":"15dc7215-b44c-42e6-ac75-0b3e80688f39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/card/customer/:id","description":"

The endpoint retrieves the card details for a specific customer identified by the provided ID.

\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n  \"type\": \"array\",\n  \"items\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"id\": {\"type\": \"string\"},\n      \"expiry\": {\"type\": \"string\"},\n      \"embossName\": {\"type\": \"string\"},\n      \"lastFourDigit\": {\"type\": \"string\"},\n      \"cardToken\": {\"type\": \"string\"},\n      \"accountParentId\": {\"type\": \"string\"},\n      \"processorAccountId\": {\"type\": \"string\"},\n      \"cardType\": {\"type\": \"string\"},\n      \"cardPlanId\": {\"type\": \"string\"},\n      \"statusNetwork\": {\"type\": \"string\"},\n      \"accountId\": {\"type\": \"string\"},\n      \"isAdditionalCard\": {\"type\": \"string\"},\n      \"cardPlan\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": {\"type\": \"string\"},\n          \"name\": {\"type\": \"string\"},\n          \"description\": {\"type\": \"string\"},\n          \"code\": {\"type\": \"string\"},\n          \"currencyCode\": {\"type\": \"string\"},\n          \"maximumBalanceLimit\": {\"type\": \"string\"},\n          \"limit\": {\"type\": \"string\"},\n          \"cardDesignId\": {\"type\": \"string\"},\n          \"cardDesign\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": {\"type\": \"string\"},\n              \"name\": {\"type\": \"string\"},\n              \"description\": {\"type\": \"string\"},\n              \"imagePath\": {\"type\": \"string\"},\n              \"bankLogoPath\": {\"type\": \"string\"},\n              \"watermarkPath\": {\"type\": \"string\"},\n              \"cardColor\": {\"type\": \"string\"},\n              \"watermarkColor\": {\"type\": \"string\"}\n            }\n          },\n          \"logoPath\": {\"type\": \"string\"},\n          \"entity\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": {\"type\": \"string\"},\n              \"name\": {\"type\": \"string\"},\n              \"businessName\": {\"type\": \"string\"},\n              \"legalId\": {\"type\": \"string\"},\n              \"description\": {\"type\": \"string\"},\n              \"logo\": {\"type\": \"string\"},\n              \"website\": {\"type\": \"string\"},\n              \"email\": {\"type\": \"string\"},\n              \"phone\": {\"type\": \"string\"},\n              \"address\": {\"type\": \"string\"},\n              \"countryId\": {\"type\": \"string\"},\n              \"country\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"id\": {\"type\": \"string\"},\n                  \"name\": {\"type\": \"string\"},\n                  \"alpha3Code\": {\"type\": \"string\"},\n                  \"numericCode\": {\"type\": \"string\"}\n                }\n              },\n              \"accountParentId\": {\"type\": \"string\"},\n              \"settlementCurrencyCode\": {\"type\": \"string\"},\n              \"settlementCurrency\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"id\": {\"type\": \"string\"},\n                  \"name\": {\"type\": \"string\"},\n                  \"alphaCode\": {\"type\": \"string\"},\n                  \"decimalPlaces\": {\"type\": \"string\"},\n                  \"isActive\": {\"type\": \"string\"}\n                }\n              },\n              \"billingCurrencyCode\": {\"type\": \"string\"},\n              \"billingCurrency\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"id\": {\"type\": \"string\"},\n                  \"name\": {\"type\": \"string\"},\n                  \"alphaCode\": {\"type\": \"string\"},\n                  \"decimalPlaces\": {\"type\": \"string\"},\n                  \"isActive\": {\"type\": \"string\"}\n                }\n              },\n              \"billingContactName\": {\"type\": \"string\"},\n              \"billingContactEmail\": {\"type\": \"string\"},\n              \"billingContactPhone\": {\"type\": \"string\"},\n              \"customColor\": {\"type\": \"string\"},\n              \"isActive\": {\"type\": \"string\"},\n              \"balance\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"pendingBalanceAmount\": {\"type\": \"string\"},\n                  \"actualBalanceAmount\": {\"type\": \"string\"},\n                  \"blockedBalanceAmount\": {\"type\": \"string\"},\n                  \"balanceCurrency\": {\"type\": \"string\"},\n                  \"availableBalanceAmount\": {\"type\": \"string\"}\n                }\n              },\n              \"walletPocket\": {\n                \"type\": \"array\",\n                \"items\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"id\": {\"type\": \"string\"},\n                    \"walletAccountId\": {\"type\": \"string\"},\n                    \"currencyId\": {\"type\": \"string\"},\n                    \"currencyName\": {\"type\": \"string\"},\n                    \"balance\": {\"type\": \"string\"},\n                    \"maxBalanceLimit\": {\"type\": \"string\"}\n                  }\n                }\n              },\n              \"totalWalletBalance\": {\"type\": \"string\"}\n            }\n          },\n          \"cardBrand\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": {\"type\": \"string\"},\n              \"name\": {\"type\": \"string\"},\n              \"description\": {\"type\": \"string\"},\n              \"logoPath\": {\"type\": \"string\"},\n              \"cardImagePath\": {\"type\": \"string\"},\n              \"firstDigit\": {\"type\": \"string\"}\n            }\n          },\n          \"currency\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": {\"type\": \"string\"},\n              \"name\": {\"type\": \"string\"},\n              \"alphaCode\": {\"type\": \"string\"},\n              \"decimalPlaces\": {\"type\": \"string\"},\n              \"isActive\": {\"type\": \"string\"}\n            }\n          },\n          \"headers\": {\"type\": \"string\"},\n          \"benefits\": {\"type\": \"string\"},\n          \"ruleGroupsId\": {\n            \"type\": \"array\",\n            \"items\": {\"type\": \"string\"}\n          },\n          \"ruleGroups\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"id\": {\"type\": \"string\"},\n                \"name\": {\"type\": \"string\"},\n                \"description\": {\"type\": \"string\"},\n                \"type\": {\"type\": \"string\"},\n                \"riskLevel\": {\"type\": \"string\"}\n              }\n            }\n          },\n          \"terms\": {\"type\": \"string\"},\n          \"isActive\": {\"type\": \"string\"}\n        }\n      },\n      \"cardDesign\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": {\"type\": \"string\"},\n          \"name\": {\"type\": \"string\"},\n          \"description\": {\"type\": \"string\"},\n          \"imagePath\": {\"type\": \"string\"},\n          \"bankLogoPath\": {\"type\": \"string\"},\n          \"watermarkPath\": {\"type\": \"string\"},\n          \"cardColor\": {\"type\": \"string\"},\n          \"watermarkColor\": {\"type\": \"string\"}\n        }\n      },\n      \"cardBrand\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": {\"type\": \"string\"},\n          \"name\": {\"type\": \"string\"},\n          \"description\": {\"type\": \"string\"},\n          \"logoPath\": {\"type\": \"string\"},\n          \"cardImagePath\": {\"type\": \"string\"},\n          \"firstDigit\": {\"type\": \"string\"}\n        }\n      },\n      \"entity\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": {\"type\": \"string\"},\n          \"name\": {\"type\": \"string\"},\n          \"businessName\": {\"type\": \"string\"},\n          \"legalId\": {\"type\": \"string\"},\n          \"description\": {\"type\": \"string\"},\n          \"logo\": {\"type\": \"string\"},\n          \"website\": {\"type\": \"string\"},\n          \"email\": {\"type\": \"string\"},\n          \"phone\": {\"type\": \"string\"},\n          \"address\": {\"type\": \"string\"},\n          \"countryId\": {\"type\": \"string\"},\n          \"country\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": {\"type\": \"string\"},\n              \"name\": {\"type\": \"string\"},\n              \"alpha3Code\": {\"type\": \"string\"},\n              \"numericCode\": {\"type\": \"string\"}\n            }\n          },\n          \"accountParentId\": {\"type\": \"string\"},\n          \"settlementCurrencyCode\": {\"type\": \"string\"},\n          \"settlementCurrency\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": {\"type\": \"string\"},\n              \"name\": {\"type\": \"string\"},\n              \"alphaCode\": {\"type\": \"string\"},\n              \"decimalPlaces\": {\"type\": \"string\"},\n              \"isActive\": {\"type\": \"string\"}\n            }\n          },\n          \"billingCurrencyCode\": {\"type\": \"string\"},\n          \"billingCurrency\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": {\"type\": \"string\"},\n              \"name\": {\"type\": \"string\"},\n              \"alphaCode\": {\"type\": \"string\"},\n              \"decimalPlaces\": {\"type\": \"string\"},\n              \"isActive\": {\"type\": \"string\"}\n            }\n          },\n          \"billingContactName\": {\"type\": \"string\"},\n          \"billingContactEmail\": {\"type\": \"string\"},\n          \"billingContactPhone\": {\"type\": \"string\"},\n          \"customColor\": {\"type\": \"string\"},\n          \"isActive\": {\"type\": \"string\"},\n          \"balance\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"pendingBalanceAmount\": {\"type\": \"string\"},\n              \"actualBalanceAmount\": {\"type\": \"string\"},\n              \"blockedBalanceAmount\": {\"type\": \"string\"},\n              \"balanceCurrency\": {\"type\": \"string\"},\n              \"availableBalanceAmount\": {\"type\": \"string\"}\n            }\n          },\n          \"walletPocket\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"id\": {\"type\": \"string\"},\n                \"walletAccountId\": {\"type\": \"string\"},\n                \"currencyId\": {\"type\": \"string\"},\n                \"currencyName\": {\"type\": \"string\"},\n                \"balance\": {\"type\": \"string\"},\n                \"maxBalanceLimit\": {\"type\": \"string\"}\n              }\n            }\n          },\n          \"totalWalletBalance\": {\"type\": \"string\"}\n        }\n      },\n      \"balance\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"pendingBalanceAmount\": {\"type\": \"string\"},\n          \"actualBalanceAmount\": {\"type\": \"string\"},\n          \"blockedBalanceAmount\": {\"type\": \"string\"},\n          \"balanceCurrency\": {\"type\": \"string\"},\n          \"availableBalanceAmount\": {\"type\": \"string\"}\n        }\n      }\n    }\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card","customer",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"2cf2380d-cf70-4ffe-9530-6cdde8f9d63b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"848ecfeb-44d0-45cd-b41b-e196116f08d6","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/card/customer/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","card","customer",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"expiry\": \"\",\n \"embossName\": \"\",\n \"lastFourDigit\": \"\",\n \"cardToken\": \"\",\n \"accountParentId\": \"\",\n \"processorAccountId\": \"\",\n \"cardType\": \"\",\n \"cardPlanId\": \"\",\n \"statusNetwork\": \"\",\n \"accountId\": \"\",\n \"isAdditionalCard\": \"\",\n \"cardPlan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"expiry\": \"\",\n \"embossName\": \"\",\n \"lastFourDigit\": \"\",\n \"cardToken\": \"\",\n \"accountParentId\": \"\",\n \"processorAccountId\": \"\",\n \"cardType\": \"\",\n \"cardPlanId\": \"\",\n \"statusNetwork\": \"\",\n \"accountId\": \"\",\n \"isAdditionalCard\": \"\",\n \"cardPlan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n }\n]"}],"_postman_id":"15dc7215-b44c-42e6-ac75-0b3e80688f39"}],"id":"96701b24-1c7d-4ce2-a7a7-4e693d22e54b","description":"

Retrieves all cards associated with a specific client using the client's identifier (id).

\n","_postman_id":"96701b24-1c7d-4ce2-a7a7-4e693d22e54b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"7ec3b156-1e7e-4994-9e54-d21039fccdf8","_postman_id":"7ec3b156-1e7e-4994-9e54-d21039fccdf8","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Balance","item":[{"name":"{Id}","item":[{"name":"/api/v1/card/balance/:id","id":"3e1ef3ce-03a7-4e37-82e1-3a5b17d1906b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/card/balance/:id","description":"

Get Card Balance

\n

This endpoint retrieves the balance details for a specific card.

\n

Request

\n

Path Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequired?Description
idstringrequiredThe ID of the card for which the balance details are to be retrieved.
\n

Response

\n

The response for this request is a JSON object with the following properties:\\

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
pendingBalanceAmountstringThe amount of pending balance for the card.
actualBalanceAmountstringThe actual balance amount for the card.
blockedBalanceAmountstringThe amount of balance that is blocked.
balanceCurrencystringThe currency in which the balance is denominated.
availableBalanceAmountstringThe amount of balance available for use.
\n

JSON Schema

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"pendingBalanceAmount\": { \"type\": \"string\" },\n    \"actualBalanceAmount\": { \"type\": \"string\" },\n    \"blockedBalanceAmount\": { \"type\": \"string\" },\n    \"balanceCurrency\": { \"type\": \"string\" },\n    \"availableBalanceAmount\": { \"type\": \"string\" }\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card","balance",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"09276bc2-69e7-41cb-9653-b024422274e2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/card/balance/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","card","balance",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n}"}],"_postman_id":"3e1ef3ce-03a7-4e37-82e1-3a5b17d1906b"}],"id":"b7302e8d-592d-404a-a11a-aa7c1c688f49","description":"

Retrieves the balance of a specific card using its identifier (id).

\n","_postman_id":"b7302e8d-592d-404a-a11a-aa7c1c688f49","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"14156704-bf54-4782-b7f6-26b2ba5aa47c","_postman_id":"14156704-bf54-4782-b7f6-26b2ba5aa47c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Card {Id}","item":[{"name":"/api/v1/card/:id","id":"c694d511-d067-4c2e-b40c-e0c3393adeb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/card/:id","description":"

The endpoint retrieves card details based on the provided card ID.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"adc0cf04-369f-4c99-99b2-5a6d66b34c62","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"88c94832-750c-42c5-8840-a46b858c7826","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/card/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","card",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"expiry\": \"\",\n \"embossName\": \"\",\n \"lastFourDigit\": \"\",\n \"cardToken\": \"\",\n \"accountParentId\": \"\",\n \"processorAccountId\": \"\",\n \"cardType\": \"\",\n \"cardPlanId\": \"\",\n \"statusNetwork\": \"\",\n \"accountId\": \"\",\n \"isAdditionalCard\": \"\",\n \"cardPlan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n}"}],"_postman_id":"c694d511-d067-4c2e-b40c-e0c3393adeb2"}],"id":"63f5f11a-d533-4730-b2f2-8cc926bf79d7","description":"

Retrieves the details of a specific card using its identifier (id).

\n","_postman_id":"63f5f11a-d533-4730-b2f2-8cc926bf79d7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Security Info","item":[{"name":"/api/v1/cardsecure/card-info/:id","id":"47fad06d-9ecd-475d-9706-8eb6389cccca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/cardsecure/card-info/:id","description":"

The endpoint retrieves card details based on the provided card ID.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","cardsecure","card-info",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"8901aff8-74c2-4a97-ae3a-ef8d031f1c16","type":"any","value":"","key":"id"}]}},"response":[{"id":"4bd35c0a-73bf-4634-a719-6c0e1f95390a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/card/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","card",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"cardNumber\": \"\",\n \"cardHolderName\": \"\",\n \"expiryDate\": \"\",\n \"cvv\": \"\"\n}"}],"_postman_id":"47fad06d-9ecd-475d-9706-8eb6389cccca"},{"name":"/api/v1/cardsecure/set-pin-encrypted","id":"e816fb8a-c737-4e85-9acf-898cc744ff2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"473a53e6-bc07-a230-7350-70fe43ec4121\",\n \"encryptedPinHex\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/cardsecure/set-pin-encrypted","description":"

Description

\n

Set or update a card’s PIN using a pre-encrypted PIN value. Intended for secure PIN provisioning without exposing the plaintext PIN.

\n

URL and Method

\n
    \n
  • POST https://dev.viacarte.com:8440/api/v1/cardsecure/set-pin-encrypted
    • \n
\n

Headers

\n
    \n

  • Content-Type: application/json

    \n
    • \n

  • Accept: text/plain

    \n
    • \n
\n

Common Error Codes

\n
    \n

  • 400 Bad Request: Missing or malformed body fields (e.g., invalid UUID, empty encryptedPinHex).

    \n
    • \n

  • 401 Unauthorized: Missing/invalid authentication.

    \n
    • \n

  • 403 Forbidden: Authenticated but not permitted to set the PIN.

    \n
    • \n

  • 5xx Server Errors: Unexpected server-side failure.

    \n
    • \n
\n

Notes

\n
    \n

  • Deprecated (temporary): This endpoint is temporary and will be replaced by a new “Set PIN” endpoint/flow. ViaCarte will notify clients in advance with a target date, transition window, and a migration guide. Until further notice, this endpoint remains available for backward compatibility.

    \n
    • \n

  • What encryptedPinHex must contain

    \n
      \n

    • encryptedPinHex is not an ISO PIN block (ISO-0/1/3). For this temporary endpoint, the value must be a hex string using the following format:

      \n
      • \n

    • Payload format: IV (hex) + CIPHERTEXT (hex) with no separators

      \n
      • \n

    • IV: 16 bytes (32 hex chars)

      \n
        \n

      • Recommended: generate a fresh random IV per request

        \n
        • \n

      • Must be prepended to the ciphertext

        \n
        • \n
      \n
      • \n

    • Algorithm: AES-256-CBC with PKCS7 padding

      \n
      • \n

    • Salt: not used (-nosalt)

      \n
      • \n
    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","cardsecure","set-pin-encrypted"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"1b9d887c-fc8c-45a3-ab7c-f73722fe88bd","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"473a53e6-bc07-a230-7350-70fe43ec4121\",\n \"encryptedPinHex\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/cardsecure/set-pin-encrypted"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"string"}],"_postman_id":"e816fb8a-c737-4e85-9acf-898cc744ff2f"}],"id":"eae68787-9c29-4cc7-a88f-56a1a50cb96b","description":"

Endpoint for obtaining secure card information.

\n","_postman_id":"eae68787-9c29-4cc7-a88f-56a1a50cb96b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"8a227b21-9bae-4894-8cf1-67b61bf569b4","description":"

These endpoints allow efficient card management:

\n
    \n

  1. Status This endpoint allows updating the status of a card, providing functionality to block or unblock it as needed.

    \n
    2. \n

  2. Entity

    \n
      \n

    1. Card Plans: This method retrieves a list of card plans associated with a specific entity, identified by its entityId.

      \n
      2. \n

    2. Entity Cards: This method retrieves all cards linked to a specific entity using its identifier (id).

      \n
      3. \n
    \n
    3. \n

  3. Cards Customer This endpoint retrieves details of the cards associated with a specific customer, identified by their ID.

    \n
    4. \n

  4. Balance This endpoint retrieves the balance details of a specific card.

    \n
    5. \n

  5. Card Details This endpoint fetches detailed information about a card using the provided card ID.

    \n
    6. \n
\n","_postman_id":"8a227b21-9bae-4894-8cf1-67b61bf569b4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Member To Member Transfer","item":[{"name":"Transfer-Card-To-Card","item":[{"name":"/api/v1/card/transfer-card-to-card","id":"e9e3e437-1d81-4782-9774-9026c18e77dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inputIdFrom\": \"\",\n \"inputIdTo\": \"\",\n \"clientNotes\": \"\",\n \"transferAmount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/card/transfer-card-to-card","description":"

This endpoint allows you to transfer funds from one card to another.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeRequired?Description
inputIdFromstringrequiredThe unique identifier of the card from which the transfer will be made.
inputIdTostringrequiredThe unique identifier of the card to which the transfer will be made.
clientNotesstringrequiredAny notes or comments related to the transfer.
transferAmountnumberrequiredThe amount to be transferred.
\n

Response

\n

This method returns the ID of the transaction associated to the source card.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card","transfer-card-to-card"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"8b47e94c-71b1-470e-9514-cc8ca0095be3","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inputIdFrom\": \"\",\n \"inputIdTo\": \"\",\n \"clientNotes\": \"\",\n \"transferAmount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/card/transfer-card-to-card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e9e3e437-1d81-4782-9774-9026c18e77dd"}],"id":"77bbc541-bc96-499f-b3b6-5db479d2540e","description":"

Allows performing a balance transfer from one card to another.

\n","_postman_id":"77bbc541-bc96-499f-b3b6-5db479d2540e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"61827e56-4136-4398-a7d7-3aad0528a785","description":"

These endpoints allow performing the following actions:

\n
    \n
  1. Transfer to member transfer This endpoint allows transferring funds from one card to another.
    2. \n
\n","_postman_id":"61827e56-4136-4398-a7d7-3aad0528a785","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Transfer Funds Self Account","item":[{"name":"Transfer-To-Entity","item":[{"name":"/api/v1/account/transfer-to-entity","id":"95d84b75-f9c7-405c-ad42-2d815dd274e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inputIdFrom\": \"\",\n \"inputIdTo\": \"\",\n \"clientNotes\": \"\",\n \"transferAmount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/account/transfer-to-entity","description":"

Account Transfer to Entity

\n

This endpoint allows you to transfer funds from one account to the entity (client account or TLF of the entity).

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData Typerequired?Description
inputIdFromstringrequiredThe unique identifier of the account from which the transfer will be made.
inputIdTostringrequiredThe unique identifier of the entity to which the transfer will be made.
clientNotesstringrequiredAny notes or comments provided by the client for the transfer.
transferAmountnumberrequiredThe amount to be transferred.
\n

Response

\n

The response for this request is the transaction ID.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","account","transfer-to-entity"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"67c8407d-6396-4e91-bd4a-923288531ab1","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inputIdFrom\": \"\",\n \"inputIdTo\": \"\",\n \"clientNotes\": \"\",\n \"transferAmount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/account/transfer-to-entity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"95d84b75-f9c7-405c-ad42-2d815dd274e2"}],"id":"784ac6f4-fa31-4bb4-bad3-abacb6e1fcba","description":"

This method allows performing a transfer from a customers account to an entity account.

\n","_postman_id":"784ac6f4-fa31-4bb4-bad3-abacb6e1fcba","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Transfer-To-Account","item":[{"name":"/api/v1/account/transfer-to-account","id":"9205fddd-5038-4cf4-86c9-149bdc27e935","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"entityId\": \"\",\n \"accountId\": \"\",\n \"notes\": \"\",\n \"amount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/account/transfer-to-account","description":"

Transfer to Account

\n

This endpoint allows you to transfer funds from wallet account to card account.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData Typerequired?Description
entityIdstringrequiredThe unique identifier of the entity initiating the transfer.
accountIdstringrequiredThe unique identifier of the account from which the funds will be transferred.
notesstringrequiredAny notes or comments related to the transfer.
amountnumberrequiredThe amount of funds to be transferred.
\n

Response Body

\n

The response will include the status of the transfer and any relevant details.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","account","transfer-to-account"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"0a11d270-5750-44e2-a39b-1ff63b0a4b90","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"entityId\": \"\",\n \"accountId\": \"\",\n \"notes\": \"\",\n \"amount\": \"\",\n \"transferFeeAmount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/account/transfer-to-account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9205fddd-5038-4cf4-86c9-149bdc27e935"}],"id":"73416125-75f0-4ba4-bb9b-9e183b0a5021","description":"

Transfers the funds from the entity's account to the customer's account and, consequently, to the card associated with that account.

\n","_postman_id":"73416125-75f0-4ba4-bb9b-9e183b0a5021","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"b97944b8-b459-4e6a-9e20-db94afabc08a","description":"

These endpoints allow performing the following actions:

\n
    \n

  1. Transfer to Entity This endpoint allows performing a transfer from the current account to an external entity.

    \n
    2. \n

  2. Transfer to Account This endpoint transfers funds from an entity's account to a customer's account and subsequently to the card associated with that account.

    \n
    3. \n
\n","_postman_id":"b97944b8-b459-4e6a-9e20-db94afabc08a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Card Lifecycle","item":[{"name":"Management","item":[{"name":"/api/v1/management","id":"d447b8d3-ba18-42f0-92d0-1f992c64a594","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://dev.viacarte.com:8440/api/v1/management","description":"

This endpoint retrieves the list of available card management actions for the specified entity.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://dev.viacarte.com:8440/api/v1/management

    \n
    • \n
\n

Response

\n

The response will include an array of objects, where each object represents a card management option available to the client. Each object contains the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
idinteger
codestring
namestring
descriptionstring
optionstring
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","management"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[],"_postman_id":"d447b8d3-ba18-42f0-92d0-1f992c64a594"},{"name":"api/v1/management","id":"355724cc-9ec6-49d7-96be-b9eff868bad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cardManagementId\": \"\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/management","description":"

Add card management

\n

This endpoint allows the user to assign a new management type to the entity. All fields in the request body are required.

\n

Request body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
cardManagementIdinteger
\n

Response

\n

If all is ok, the response will contain the ID of the card management added.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","management"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[],"_postman_id":"355724cc-9ec6-49d7-96be-b9eff868bad9"}],"id":"667312f4-264d-42a0-825b-7bdf0203b495","_postman_id":"667312f4-264d-42a0-825b-7bdf0203b495","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Instant Cards","item":[{"name":"Virtual","item":[{"name":"/api/v1/card/virtual","id":"14f3ca89-7d7e-4778-8966-b7a6c466207c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"embossName\": \"\",\n \"accountId\": \"\",\n \"settlementCurrency\": \"\",\n \"billingCurrency\": \"\",\n \"useCustomerInformation\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryId\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/card/virtual","description":"

Create Virtual Card

\n

This endpoint allows the creation of a virtual card with the provided details.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeDescription
Emboss Name*stringName to be embossed on the card.
AccountId*UUIDID of the account.
Settlement Currency*stringCurrency for settlement.
Billing Currency*stringCurrency for billing.
Use Customer Information*booleanIndicates whether to use customer information.
First NamestringFirst name of the cardholder
Last NamestringLast name of the cardholder
Address1stringAddress line 1.
Address2stringAddress line 2.
Postal CodestringPostal code.
CitystringCity
Country IdstringID of the country.
MobilestringMobile number of the cardholder
EmailstringEmail of the cardholder.
Date Of BirthdateTimeDate of birth of the cardholder.
\n

Response

\n

This method returns the ID of the created card.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","card","virtual"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"97e00820-77a8-4382-a89d-f92e58cfce79","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"imageFields\": [\n \"\",\n \"\"\n ],\n \"xmlFields\": [\n \"\",\n \"\"\n ],\n \"imageName\": \"\",\n \"cardManufacturerId\": \"\",\n \"embossName\": \"\",\n \"accountId\": \"\",\n \"processorAccountId\": \"\",\n \"settlementCurrency\": \"\",\n \"billingCurrency\": \"\",\n \"tokenFlags\": [\n \"\",\n \"\"\n ],\n \"imageDelivery\": \"\",\n \"useCustomerInformation\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryId\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/card/virtual"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"14f3ca89-7d7e-4778-8966-b7a6c466207c"}],"id":"20ce67cf-ec2c-4e0e-a0d2-855152ee7837","description":"

Allows the creation of a virtual card.

\n","_postman_id":"20ce67cf-ec2c-4e0e-a0d2-855152ee7837","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Customer","item":[{"name":"{Id}","item":[{"name":"/api/v1/customer/:id","id":"7d1343a7-56b2-4184-8425-1c66a7ac772f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/customer/:id","description":"

GET /api/v1/customer/:id

\n

This endpoint retrieves customer details based on the provided ID.

\n

Request

\n

No request body is required for this endpoint. The ID parameter should be included in the request URL.

\n
    \n
  • id (path parameter) : The unique identifier of the customer.
    • \n
\n

Response

\n

The response will be a JSON object with the following schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"title\": {\"type\": \"string\"},\n    \"firstName\": {\"type\": \"string\"},\n    \"lastName\": {\"type\": \"string\"},\n    \"countryId\": {\"type\": \"string\"},\n    \"city\": {\"type\": \"string\"},\n    \"address1\": {\"type\": \"string\"},\n    \"address2\": {\"type\": \"string\"},\n    \"postalCode\": {\"type\": \"string\"},\n    \"mobile\": {\"type\": \"string\"},\n    \"phoneHome\": {\"type\": \"string\"},\n    \"idType\": {\"type\": \"string\"},\n    \"idNumber\": {\"type\": \"string\"},\n    \"isMainCardHolder\": {\"type\": \"string\"},\n    \"passCode\": {\"type\": \"string\"},\n    \"nationality\": {\"type\": \"string\"},\n    \"gender\": {\"type\": \"string\"},\n    \"alternateEmail\": {\"type\": \"string\"},\n    \"email\": {\"type\": \"string\"},\n    \"dateOfBirth\": {\"type\": \"string\"},\n    \"buildingNumber\": {\"type\": \"string\"},\n    \"company\": {\"type\": \"string\"},\n    \"externalReference\": {\"type\": \"string\"},\n    \"entityId\": {\"type\": \"string\"}\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customer",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"a5def113-b88b-40b3-a055-8a58c05a82c2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0a3274e0-78e4-40e9-83dd-75cb500f5aa0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/customer/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","customer",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryId\": \"\",\n \"city\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"mobile\": \"\",\n \"phoneHome\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"isMainCardHolder\": \"\",\n \"passCode\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"alternateEmail\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\",\n \"externalReference\": \"\",\n \"entityId\": \"\"\n}"}],"_postman_id":"7d1343a7-56b2-4184-8425-1c66a7ac772f"}],"id":"534e1adc-5aac-475d-a762-dd96f6d4c23d","description":"

This method retrieves the details of a specific client using their identifier (id).

\n","_postman_id":"534e1adc-5aac-475d-a762-dd96f6d4c23d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"{externalReference}","item":[{"name":"/api/v1/customer/external-reference/:externalReference","id":"c4e90af2-a506-40ca-92ed-6796b212797d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/customer/external-reference/:externalReference","description":"

GET /api/v1/customer/external-reference/:externalReference

\n

This endpoint retrieves customer details based on the provided external reference.

\n

Request

\n

No request body is required for this endpoint. The external reference parameter should be included in the request URL.

\n
    \n
  • externalReference (path parameter) : The unique identifier of the customer per entity.
    • \n
\n

Response

\n

The response will be a JSON object with the following schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"title\": {\"type\": \"string\"},\n    \"firstName\": {\"type\": \"string\"},\n    \"lastName\": {\"type\": \"string\"},\n    \"countryId\": {\"type\": \"string\"},\n    \"city\": {\"type\": \"string\"},\n    \"address1\": {\"type\": \"string\"},\n    \"address2\": {\"type\": \"string\"},\n    \"postalCode\": {\"type\": \"string\"},\n    \"mobile\": {\"type\": \"string\"},\n    \"phoneHome\": {\"type\": \"string\"},\n    \"idType\": {\"type\": \"string\"},\n    \"idNumber\": {\"type\": \"string\"},\n    \"isMainCardHolder\": {\"type\": \"string\"},\n    \"passCode\": {\"type\": \"string\"},\n    \"nationality\": {\"type\": \"string\"},\n    \"gender\": {\"type\": \"string\"},\n    \"alternateEmail\": {\"type\": \"string\"},\n    \"email\": {\"type\": \"string\"},\n    \"dateOfBirth\": {\"type\": \"string\"},\n    \"buildingNumber\": {\"type\": \"string\"},\n    \"company\": {\"type\": \"string\"},\n    \"externalReference\": {\"type\": \"string\"},\n    \"entityId\": {\"type\": \"string\"}\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customer","external-reference",":externalReference"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"117554e6-8f5c-4070-8318-3916e0a42115","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"externalReference"}]}},"response":[{"id":"4bb6a1fa-cc0a-42d6-b10a-a4c54e5a3280","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"X-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/customer/external-reference/:externalReference","host":["https://dev.viacarte.com:8440"],"path":["api","v1","customer","external-reference",":externalReference"],"variable":[{"key":"externalReference","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryId\": \"\",\n \"city\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"mobile\": \"\",\n \"phoneHome\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"isMainCardHolder\": \"\",\n \"passCode\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"alternateEmail\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\",\n \"externalReference\": \"\",\n \"entityId\": \"\"\n}"}],"_postman_id":"c4e90af2-a506-40ca-92ed-6796b212797d"}],"id":"d1771710-b06b-40aa-bc6c-876835b8a980","_postman_id":"d1771710-b06b-40aa-bc6c-876835b8a980","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"/api/v1/customer","id":"cd4de3c6-d5df-4d13-9ee8-39a5e793603a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryId\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"phoneHome\": \"\",\n \"passCode\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"isMainCardHolder\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"alternateEmail\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\",\n \"entityId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customer","description":"

The endpoint allows you to create a new customer by sending a POST request to the specified URL.

\n

The request should include a JSON payload with various customer details such as title, first name, last name, address, contact information, identification details, and more.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeDescription
title*stringThe title of the customer.
firstName*stringThe first name of the customer.
middleNamestringMiddlename of the customer.
lastName*stringThe last name of the customer.
secondLastNamestringSecond last name of the customer.
suxfixstringSuxfix of the customer.
country Id*stringThe ID of the country where the customer resides.
city*stringThe city of the customer's address.
state*stringThe state of the customer's address.
address1*stringThe first line of the customer's address.
address2stringThe second line of the customer's address.
postalCode*stringThe postal code of the customer's address.
phone*stringThe mobile phone number of the customer.
phoneHomestringThe home phone number of the customer.
passCodestringThe passcode for the customer.
idType*stringThe type of identification document.
idNumber*stringThe identification number of the customer.
nationality*stringThe nationality of the customer.
gender*stringThe gender of the customer.
alternateEmailstringThe alternate email address of the customer.
email*stringThe email address of the customer.
dateOfBirth*dateTimeThe date of birth of the customer.
buildingNumberstringThe building number of the customer's address.
company*stringThe company of the customer.
externalReferencestringExternal reference identifier. If an external reference is provided, its uniqueness will be validated in relation to the entity.
entityId*uuidThe entity ID of the customer.
\n

Response

\n

The response of this request is the ID associated to the customer created.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customer"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"7a6f03ac-0cc0-4a71-b87d-5ef9e808b25f","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryId\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"phoneHome\": \"\",\n \"passCode\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"isMainCardHolder\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"alternateEmail\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\",\n \"entityId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cd4de3c6-d5df-4d13-9ee8-39a5e793603a"},{"name":"/api/v1/customer","id":"3237bf1e-0ffa-406c-8748-5d1722916c14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryId\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"phoneHome\": \"\",\n \"passCode\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"isMainCardHolder\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"alternateEmail\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customer","description":"

Update Customer Details

\n

This endpoint allows the client to update customer details.

\n

Request

\n
    \n

  • Method: PUT

    \n
    • \n

  • URL: https://dev.viacarte.com:8440/api/v1/customer

    \n
    • \n
\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeDescription
ID*stringThe unique identifier of the customer.
title*stringThe title of the customer.
firstName*stringThe first name of the customer.
lastName*stringThe last name of the customer.
country Id*stringThe ID of the country where the customer resides.
city*stringThe city of the customer's address.
state*stringThe state of the customer's address.
address1*stringThe first line of the customer's address.
address2stringThe second line of the customer's address.
postalCode*stringThe postal code of the customer's address.
phone*stringThe mobile phone number of the customer.
phoneHomestringThe home phone number of the customer.
passCodestringThe passcode for the customer.
idType*stringThe type of identification document.
idNumber*stringThe identification number of the customer.
isMainCardHolderstringIndicates if the customer is the main card holder (RFU)
nationality*stringThe nationality of the customer.
gender*stringThe gender of the customer.
alternateEmailstringThe alternate email address of the customer.
email*stringThe email address of the customer.
dateOfBirth*dateTimeThe date of birth of the customer.
buildingNumberstringThe building number of the customer's address.
company*stringThe company of the customer.
\n

Response

\n

The response of this request is the ID associated to the customer updated.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customer"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"336cba9e-6da6-49b6-9e12-d0ddcc1d190d","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryId\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"phone\": \"\",\n \"phoneHome\": \"\",\n \"passCode\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"isMainCardHolder\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"alternateEmail\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3237bf1e-0ffa-406c-8748-5d1722916c14"}],"id":"bb4295da-e43a-44d5-a0b8-9ed632622364","_postman_id":"bb4295da-e43a-44d5-a0b8-9ed632622364","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Account","item":[{"name":"{Id}","item":[{"name":"/api/v1/account/:id","id":"3a28f270-d972-4242-b8be-f39415a529b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/account/4e10c374-56f8-4beb-b838-17f7439410f6","description":"

The endpoint retrieves the account details for a specific account ID.

\n

The response is a JSON object containing various account information, including the account ID, processor account ID, name, parent ID, settlement currency, billing currency, card plan details, customer details, balance information, wallet pocket details, and more.

\n
{\n  \"id\": \"\",\n  \"processorAccountId\": \"\",\n  \"name\": \"\",\n  \"parentId\": \"\",\n  \"settlementCurrency\": \"\",\n  \"billingCurrency\": \"\",\n  \"externalReference\": \"\",\n  \"cardPlanId\": \"\",\n  \"cardPlan\": {\n    \"id\": \"\",\n    \"name\": \"\",\n    \"description\": \"\",\n    \"code\": \"\",\n    \"currencyCode\": \"\",\n    \"maximumBalanceLimit\": \"\",\n    \"limit\": \"\",\n    \"cardDesignId\": \"\",\n    \"cardDesign\": {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"description\": \"\",\n      \"imagePath\": \"\",\n      \"bankLogoPath\": \"\",\n      \"watermarkPath\": \"\",\n      \"cardColor\": \"\",\n      \"watermarkColor\": \"\"\n    },\n    \"logoPath\": \"\",\n    \"entity\": {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"businessName\": \"\",\n      \"legalId\": \"\",\n      \"description\": \"\",\n      \"logo\": \"\",\n      \"website\": \"\",\n      \"email\": \"\",\n      \"phone\": \"\",\n      \"address\": \"\",\n      \"countryId\": \"\",\n      \"country\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"alpha3Code\": \"\",\n        \"numericCode\": \"\"\n      },\n      \"accountParentId\": \"\",\n      \"settlementCurrencyCode\": \"\",\n      \"settlementCurrency\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"alphaCode\": \"\",\n        \"decimalPlaces\": \"\",\n        \"isActive\": \"\"\n      },\n      \"billingCurrencyCode\": \"\",\n      \"billingCurrency\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"alphaCode\": \"\",\n        \"decimalPlaces\": \"\",\n        \"isActive\": \"\"\n      },\n      \"billingContactName\": \"\",\n      \"billingContactEmail\": \"\",\n      \"billingContactPhone\": \"\",\n      \"customColor\": \"\",\n      \"isActive\": \"\",\n      \"balance\": {\n        \"pendingBalanceAmount\": \"\",\n        \"actualBalanceAmount\": \"\",\n        \"blockedBalanceAmount\": \"\",\n        \"balanceCurrency\": \"\",\n        \"availableBalanceAmount\": \"\"\n      },\n      \"walletPocket\": [\n        {\n          \"id\": \"\",\n          \"walletAccountId\": \"\",\n          \"currencyId\": \"\",\n          \"currencyName\": \"\",\n          \"balance\": \"\",\n          \"maxBalanceLimit\": \"\"\n        }\n      ],\n      \"totalWalletBalance\": \"\"\n    },\n    \"cardBrand\": {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"description\": \"\",\n      \"logoPath\": \"\",\n      \"cardImagePath\": \"\",\n      \"firstDigit\": \"\"\n    },\n    \"currency\": {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"alphaCode\": \"\",\n      \"decimalPlaces\": \"\",\n      \"isActive\": \"\"\n    },\n    \"headers\": \"\",\n    \"benefits\": \"\",\n    \"ruleGroupsId\": [\"\"],\n    \"ruleGroups\": [\n      {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"description\": \"\",\n        \"type\": \"\",\n        \"riskLevel\": \"\"\n      }\n    ],\n    \"terms\": \"\",\n    \"isActive\": \"\"\n  },\n  \"customerId\": \"\",\n  \"customer\": {\n    \"id\": \"\",\n    \"title\": \"\",\n    \"firstName\": \"\",\n    \"lastName\": \"\",\n    \"countryId\": \"\",\n    \"city\": \"\",\n    \"address1\": \"\",\n    \"address2\": \"\",\n    \"postalCode\": \"\",\n    \"mobile\": \"\",\n    \"phoneHome\": \"\",\n    \"idType\": \"\",\n    \"idNumber\": \"\",\n    \"isMainCardHolder\": \"\",\n    \"passCode\": \"\",\n    \"nationality\": \"\",\n    \"gender\": \"\",\n    \"alternateEmail\": \"\",\n    \"email\": \"\",\n    \"dateOfBirth\": \"\",\n    \"buildingNumber\": \"\",\n    \"company\": \"\",\n    \"entityId\": \"\"\n  },\n  \"balance\": {\n    \"pendingBalanceAmount\": \"\",\n    \"actualBalanceAmount\": \"\",\n    \"blockedBalanceAmount\": \"\",\n    \"balanceCurrency\": \"\",\n    \"availableBalanceAmount\": \"\"\n  },\n  \"walletPocket\": [\n    {\n      \"id\": \"\",\n      \"walletAccountId\": \"\",\n      \"currencyId\": \"\",\n      \"currencyName\": \"\",\n      \"balance\": \"\",\n      \"maxBalanceLimit\": \"\"\n    }\n  ],\n  \"totalWalletBalance\": \"\"\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","account","4e10c374-56f8-4beb-b838-17f7439410f6"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"e9565b31-dfad-414b-b635-e7bf048258f4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/account/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","account",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"processorAccountId\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"settlementCurrencyId\": \"\",\n \"billingCurrencyId\": \"\",\n \"externalReference\": \"\",\n \"cardPlanId\": \"\",\n \"cardPlan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n },\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"headers\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"terms\": \"\",\n \"isActive\": \"\"\n },\n \"customerId\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryId\": \"\",\n \"city\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"mobile\": \"\",\n \"phoneHome\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"isMainCardHolder\": \"\",\n \"passCode\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"alternateEmail\": \"\",\n \"email\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\",\n \"entityId\": \"\"\n },\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n}"}],"_postman_id":"3a28f270-d972-4242-b8be-f39415a529b9"}],"id":"bb24e5c0-046d-4362-a070-d936e784f3c7","description":"

This method retrieves the details of a specific account using its identifier (id).

\n","_postman_id":"bb24e5c0-046d-4362-a070-d936e784f3c7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Movements","item":[{"name":"{Account Id}","item":[{"name":"/api/v1/account/movements/:accountId","id":"40e63170-bb25-4c05-95c0-cae4af47e391","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/account/movements/:accountId","description":"

The endpoint retrieves account movements for a specific account ID.

\n

Response

\n

The response for this request can be represented as a JSON schema:

\n
{\n  \"type\": \"array\",\n  \"items\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"transactionType\": {\n        \"type\": \"string\"\n      },\n      \"transactionDescription\": {\n        \"type\": \"string\"\n      },\n      \"conceptCode\": {\n        \"type\": \"string\"\n      },\n      \"concept\": {\n        \"type\": \"string\"\n      },\n      \"amount\": {\n        \"type\": \"string\"\n      },\n      \"notes\": {\n        \"type\": \"string\"\n      },\n      \"transactionDate\": {\n        \"type\": \"string\"\n      }\n    }\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","account","movements",":accountId"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"72655797-e423-42eb-870c-001948669148","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"159c5199-cfd7-42ca-b97f-e261d2bc24ac","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/account/movements/:accountId","host":["https://dev.viacarte.com:8440"],"path":["api","v1","account","movements",":accountId"],"variable":[{"key":"accountId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"transactionType\": \"\",\n \"transactionDescription\": \"\",\n \"conceptCode\": \"\",\n \"concept\": \"\",\n \"amount\": \"\",\n \"notes\": \"\",\n \"transactionDate\": \"\"\n },\n {\n \"transactionType\": \"\",\n \"transactionDescription\": \"\",\n \"conceptCode\": \"\",\n \"concept\": \"\",\n \"amount\": \"\",\n \"notes\": \"\",\n \"transactionDate\": \"\"\n }\n]"}],"_postman_id":"40e63170-bb25-4c05-95c0-cae4af47e391"}],"id":"38098fbe-d019-42b6-ac45-b16b4667b62b","_postman_id":"38098fbe-d019-42b6-ac45-b16b4667b62b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"f579a027-478f-4080-b3d3-200d457657d0","description":"

This method allows searching for transactions in a specific account.

\n","_postman_id":"f579a027-478f-4080-b3d3-200d457657d0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"/api/v1/account","id":"a95c21f4-9097-4ff6-aa30-905d5085fb44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"settlementCurrency\": \"\",\n \"billingCurrency\": \"\",\n \"programId\": \"\",\n \"cardPlanId\": \"\",\n \"customerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/account","description":"

This endpoint allows you to create a new account for an specific customer. The request should be sent as an HTTP POST to the specified URL.

\n

The request body should be in raw JSON format and include the following parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeDescription
name*stringThe name of the account.
settlementCurrency*stringThe currency for settlement.
billingCurrency*stringThe currency for billing.
externalReferencestringExternal reference identifier. If an external reference is provided, its uniqueness will be validated in relation to the customer.
programId*uuidThe ID of the program associated with the entity.
cardPlanId*uuidThe ID of the card plan associated with the account.
customerId*uuidThe ID of the customer associated with the account.
\n

The response of this request is documented as a JSON schema.

\n

This method returns the account ID associated to the account created.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","account"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"641f51cf-d77a-4355-bf3a-a342093133cc","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"settlementCurrency\": \"\",\n \"billingCurrency\": \"\",\n \"programId\": \"\",\n \"cardPlanId\": \"\",\n \"customerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a95c21f4-9097-4ff6-aa30-905d5085fb44"}],"id":"4bd11a34-da23-4da5-b9e1-130112a5b547","_postman_id":"4bd11a34-da23-4da5-b9e1-130112a5b547","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Bulk Cards","item":[{"name":"Assign Card","id":"d8bd4237-b96f-4307-917f-dc2a43c8e870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"76711bb1-c77f-40d2-d0b5-c98923c5f942\",\n \"bulkCardDetailId\": \"5037019b-a5f6-5e20-4b3f-36220e0a8d3b\",\n \"embossName\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/bulkcard/assign-card","description":"

Assigns a bulk card detail (a 3DSecure and Tokenizable card) to a customer as a main card.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","bulkcard","assign-card"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"c9fe228f-8f6f-4ec8-bb56-0b1180c99046","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"76711bb1-c77f-40d2-d0b5-c98923c5f942\",\n \"bulkCardDetailId\": \"5037019b-a5f6-5e20-4b3f-36220e0a8d3b\",\n \"embossName\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/bulkcard/assign-card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"012e5ea9-1bba-00d0-abcf-6d7be0e9e7f2"}],"_postman_id":"d8bd4237-b96f-4307-917f-dc2a43c8e870"},{"name":"Bulk Card Details","id":"70643196-f3ae-4e4a-a338-e56f862c07f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/bulkcard/detail/:id","description":"

Gets bulk card details; when id is provided, filters to that batch.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","bulkcard","detail",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"558b483d-37e8-40e3-92ad-b96fb4e1eba9","type":"any","value":"012e5ea9-1bba-00d0-abcf-6d7be0e9e7f2","key":"id"}]}},"response":[{"id":"910ca64b-9888-46c6-8c8f-914e525eb407","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/bulkcard/detail/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","bulkcard","detail",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"b4b61f3d-83c5-7aaf-deab-8334de124ce0\",\n \"bulkCardId\": \"0ce9ae19-e40b-d713-1dee-d15c9ce86c07\",\n \"expiry\": \"string\",\n \"token\": 5573,\n \"lastFourDigits\": \"string\",\n \"assigned\": false,\n \"assignedOn\": \"2024-01-13T10:31:39.931Z\",\n \"cardId\": \"86f8aa29-7c42-17b8-f58e-03f0a33182a5\"\n },\n {\n \"id\": \"d3f3a0ff-b72e-3ddd-84cb-5b8cef8337e9\",\n \"bulkCardId\": \"6f33bd22-cb94-d711-f086-d9936ed729df\",\n \"expiry\": \"string\",\n \"token\": 344,\n \"lastFourDigits\": \"string\",\n \"assigned\": true,\n \"assignedOn\": \"2012-03-02T22:53:50.335Z\",\n \"cardId\": \"2b9fd11a-063c-8091-eb16-cd78986cd6e4\"\n }\n]"}],"_postman_id":"70643196-f3ae-4e4a-a338-e56f862c07f0"},{"name":"Batches by Entity","id":"c3f8ca9b-82ec-436f-8589-b261cada607d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/bulkcard/entity/:entityId/batches","description":"

Lists all bulk card batches (headers) associated with the given entity. The X-API-KEY must belong to the same entity; otherwise the request is forbidden.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","bulkcard","entity",":entityId","batches"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"type":"any","value":"012e5ea9-1bba-00d0-abcf-6d7be0e9e7f2","key":"entityId"}]}},"response":[{"id":"fbe37992-95cb-4f2a-810e-ac51654db18b","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/bulkcard/entity/:entityId/batches","host":["https://dev.viacarte.com:8440"],"path":["api","v1","bulkcard","entity",":entityId","batches"],"variable":[{"key":"entityId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"bulkCardId\": \"f9eac0c8-1733-3f0b-920a-410dc9ed6281\",\n \"entityId\": \"fcd04987-26e6-9b0f-2e3f-dbdd853cb0ba\",\n \"batchName\": \"string\",\n \"totalCards\": 5130,\n \"programId\": \"770f58e4-2a55-a5f0-3775-f4ead4381151\",\n \"programName\": \"string\",\n \"cardArrayId\": \"534e2911-67c4-cd92-d488-cede74a63641\",\n \"statusNetwork\": 7458,\n \"cardArrayName\": \"string\",\n \"requestedCards\": 7649,\n \"assignedCards\": 8827,\n \"availableCards\": 5115,\n \"createdBy\": \"7ba17a7a-9fc4-23ca-3a05-1757cfe54b41\",\n \"createdOn\": \"1991-01-11T15:43:39.535Z\",\n \"lastModifiedOn\": \"2023-11-23T11:25:51.310Z\"\n },\n {\n \"bulkCardId\": \"6ee54d3b-6ecb-ae14-da3d-85049d85be0b\",\n \"entityId\": \"8768b18c-196e-26dd-775c-66c4546d922f\",\n \"batchName\": \"string\",\n \"totalCards\": 1568,\n \"programId\": \"aba3b84d-46fa-28de-babd-98cc797819c1\",\n \"programName\": \"string\",\n \"cardArrayId\": \"2b1fc4e0-7f7b-6ec4-5044-edcd4bfa6673\",\n \"statusNetwork\": 646,\n \"cardArrayName\": \"string\",\n \"requestedCards\": 2804,\n \"assignedCards\": 5097,\n \"availableCards\": 6802,\n \"createdBy\": \"962ae549-c230-ef6c-da78-04a38855a241\",\n \"createdOn\": \"2014-03-18T17:11:19.943Z\",\n \"lastModifiedOn\": \"1983-11-17T19:26:41.577Z\"\n }\n]"}],"_postman_id":"c3f8ca9b-82ec-436f-8589-b261cada607d"}],"id":"94200919-8f6a-45b0-b8b8-3e44ff498257","description":"

This folder groups endpoints for managing Bulk Card batches: assigning a bulk card to a customer, retrieving bulk card details, and listing batches for a specific entity. All endpoints are versioned and require an API key

\n","_postman_id":"94200919-8f6a-45b0-b8b8-3e44ff498257","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"5c50fe57-90bf-4074-a628-633fc2df0cca","description":"

These endpoints allow performing the following actions:

\n
    \n

  1. Create Virtual Card: Allows generating a virtual card using the provided details.

    \n
    2. \n

  2. Customer:

    \n
      \n

    1. Create Customer: Enables registering a new customer via a POST request.

      \n
      2. \n

    2. Retrieve Customer: Fetches detailed information about a customer using their ID.

      \n
      3. \n

    3. Update Customer: Allows modifying the details of an existing customer.

      \n
      4. \n
    \n
    3. \n

  3. Account:

    \n
      \n

    1. Create Account: Registers a new account associated with a customer.

      \n
      2. \n

    2. Retrie ve Details: Retrieves detailed information about a specific account by ID.

      \n
      3. \n

    3. Retrieve Movements: Obtains the transaction history of a specific account by ID.

      \n
      4. \n
    \n
    4. \n

  4. Bulk Cards:

    \n
      \n

    1. Assign Card: Assigns a card to a customer.

      \n
      2. \n

    2. Bulk Card Details: Gets bulk card details; when id is provided, filters to that batch.

      \n
      3. \n

    3. Batches by Entity: Lists all bulk card batches (headers) associated with the given entity.

      \n
      4. \n
    \n
    5. \n
\n","_postman_id":"5c50fe57-90bf-4074-a628-633fc2df0cca","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"59b92374-9153-4f65-97bd-d276f3e73457","_postman_id":"59b92374-9153-4f65-97bd-d276f3e73457","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"New Functions","item":[{"name":"Transaction","item":[{"name":"Float-Transactions","item":[{"name":"/api/v1/transaction/float-transactions","id":"8cbeabd0-c10f-449b-a3d4-ef7827be9eb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/transaction/float-transactions","description":"

Float Transactions

\n

This method allows you to obtain all the floating transactions of a card by its identifier and a date range.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeDescription
cardIdstringThe unique identifier for the card.
startDatestringThe start date for the transaction query.
endDatestringThe end date for the transaction query.
\n

Response

\n

The response will be a JSON array containing objects with the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeDescription
primaryAccountNumberstringThe primary account number associated with the transaction.
cardTokenstringThe tokenized representation of the card used for the transaction.
transactionAmountstringThe amount of the transaction.
transactionCurrencystringThe currency of the transaction amount.
billingAmountstringThe billed amount for the transaction.
billingCurrencystringThe currency of the billed amount.
spendTypestringThe type of spending for the transaction.
spendLocationstringThe location where the transaction took place
merchantCategorystringThe category of the merchant involved in the transaction.
authorizationCodestringThe authorization code for the transaction.
responseCodestringThe response code for the transaction.
responseReasonCodestringThe reason code for the transaction response.
totalFeeBillstringThe total fee billed for the transaction.
reversedstringIndicates if the transaction has been reversed.
transactionDateTimestringThe date and time of the transaction.
\n

Example

\n
[\n  {\n    \"primaryAccountNumber\": \"\",\n    \"cardToken\": \"\",\n    \"transactionAmount\": \"\",\n    \"transactionCurrency\": \"\",\n    \"billingAmount\": \"\",\n    \"billingCurrency\": \"\",\n    \"spendType\": \"\",\n    \"spendLocation\": \"\",\n    \"merchantCategory\": \"\",\n    \"authorizationCode\": \"\",\n    \"responseCode\": \"\",\n    \"responseReasonCode\": \"\",\n    \"totalFeeBill\": \"\",\n    \"reversed\": \"\",\n    \"transactionDateTime\": \"\"\n  }\n]\n\n
\n","urlObject":{"path":["api","v1","transaction","float-transactions"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"9a3a8cce-74a3-4f12-baf0-126c602d1b89","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/transaction/float-transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"primaryAccountNumber\": \"\",\n \"cardToken\": \"\",\n \"transactionAmount\": \"\",\n \"transactionCurrency\": \"\",\n \"billingAmount\": \"\",\n \"billingCurrency\": \"\",\n \"spendType\": \"\",\n \"spendLocation\": \"\",\n \"merchantCategory\": \"\",\n \"authorizationCode\": \"\",\n \"responseCode\": \"\",\n \"responseReasonCode\": \"\",\n \"totalFeeBill\": \"\",\n \"reversed\": \"\",\n \"transactionDateTime\": \"\"\n },\n {\n \"primaryAccountNumber\": \"\",\n \"cardToken\": \"\",\n \"transactionAmount\": \"\",\n \"transactionCurrency\": \"\",\n \"billingAmount\": \"\",\n \"billingCurrency\": \"\",\n \"spendType\": \"\",\n \"spendLocation\": \"\",\n \"merchantCategory\": \"\",\n \"authorizationCode\": \"\",\n \"responseCode\": \"\",\n \"responseReasonCode\": \"\",\n \"totalFeeBill\": \"\",\n \"reversed\": \"\",\n \"transactionDateTime\": \"\"\n }\n]"}],"_postman_id":"8cbeabd0-c10f-449b-a3d4-ef7827be9eb9"}],"id":"b28e8c07-05fa-4463-b50e-74cabbce8886","description":"

Floating transactions (or held transactions) are financial operations performed in a payment system that, although authorized by the issuing entity, have not yet been settled or definitively posted to the customer's account. These transactions typically remain in this state until the confirmation or settlement process is completed.

\n","_postman_id":"b28e8c07-05fa-4463-b50e-74cabbce8886","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Transactions","item":[{"name":"/api/v1/transaction/transactions","id":"9bb2d59e-8e26-4ff5-831f-409ae03d3653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/transaction/transactions","description":"

POST /api/v1/transaction/transactions

\n

This endpoint is used to retrieve transactions based on the provided criteria.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData TypeRequired?Description
cardIdstringrequiredThe unique identifier of the card for which transactions are being retrieved.
startDatestringrequiredThe start date for the transaction search in the format \"YYYY-MM-DD\".
endDatestringThe end date for the transaction search in the format \"YYYY-MM-DD\".
\n

Response

\n

The response is an array of transaction objects, each containing the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
DateData TypeDescription
maskedPanstringThe masked primary account number of the card used for the transaction.
transactionDescriptionstringDescription of the transaction.
conceptstringConcept of the transaction.
settlementAmountstringThe settlement amount of the transaction.
settlementCurrencystringThe currency of the settlement amount.
billingAmountstringThe billing amount of the transaction.
billingCurrencystringThe currency of the billing amount.
notesstringAdditional notes related to the transaction.
transactionDatestringDate of the transaction
entryDatestringDate of entry for the transaction.
merchantNamestringName of the merchant
merchantLocationstringLocation of the merchant.
exchangeRatestringThe exchange rate for the transaction.
authorizationCodestringAuthorization code for the transaction.
referenceNumberstringReference number for the transaction.
isReversalstringndicates if the transaction is a reversal.
feeAmountstringThe fee amount associated with the transaction.
originalTransactionIdstringThe original transaction ID, if applicable.
merchantCategoryCodestringThe merchant category code.
transactionDateTimestringDate and time of the transaction.
\n
[\n  {\n    \"maskedPan\": \"\",\n    \"transactionDescription\": \"\",\n    \"concept\": \"\",\n    \"settlementAmount\": \"\",\n    \"settlementCurrency\": \"\",\n    \"billingAmount\": \"\",\n    \"billingCurrency\": \"\",\n    \"notes\": \"\",\n    \"transactionDate\": \"\",\n    \"entryDate\": \"\",\n    \"merchantName\": \"\",\n    \"merchantLocation\": \"\",\n    \"exchangeRate\": \"\",\n    \"authorizationCode\": \"\",\n    \"referenceNumber\": \"\",\n    \"isReversal\": \"\",\n    \"feeAmount\": \"\",\n    \"originalTransactionId\": \"\",\n    \"merchantCategoryCode\": \"\",\n    \"transactionDateTime\": \"\"\n  }\n]\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","transaction","transactions"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"855bd32c-944c-4717-852d-2426ec2bec83","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/transaction/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"maskedPan\": \"\",\n \"transactionDescription\": \"\",\n \"concept\": \"\",\n \"settlementAmount\": \"\",\n \"settlementCurrency\": \"\",\n \"billingAmount\": \"\",\n \"billingCurrency\": \"\",\n \"notes\": \"\",\n \"transactionDate\": \"\",\n \"entryDate\": \"\",\n \"merchantName\": \"\",\n \"merchantLocation\": \"\",\n \"exchangeRate\": \"\",\n \"authorizationCode\": \"\",\n \"referenceNumber\": \"\",\n \"isReversal\": \"\",\n \"feeAmount\": \"\",\n \"originalTransactionId\": \"\",\n \"merchantCategoryCode\": \"\",\n \"transactionDateTime\": \"\"\n },\n {\n \"maskedPan\": \"\",\n \"transactionDescription\": \"\",\n \"concept\": \"\",\n \"settlementAmount\": \"\",\n \"settlementCurrency\": \"\",\n \"billingAmount\": \"\",\n \"billingCurrency\": \"\",\n \"notes\": \"\",\n \"transactionDate\": \"\",\n \"entryDate\": \"\",\n \"merchantName\": \"\",\n \"merchantLocation\": \"\",\n \"exchangeRate\": \"\",\n \"authorizationCode\": \"\",\n \"referenceNumber\": \"\",\n \"isReversal\": \"\",\n \"feeAmount\": \"\",\n \"originalTransactionId\": \"\",\n \"merchantCategoryCode\": \"\",\n \"transactionDateTime\": \"\"\n }\n]"}],"_postman_id":"9bb2d59e-8e26-4ff5-831f-409ae03d3653"}],"id":"70ea71bb-7357-4451-acd7-86ae27cce6cf","description":"

Transactions (or charged transactions) represent financial operations that have been fully processed and settled in the customer's account. These transactions imply that funds have been debited or credited from the customer's available balance and transferred to the merchant or corresponding entity.

\n","_postman_id":"70ea71bb-7357-4451-acd7-86ae27cce6cf","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"97afe834-1f34-4781-b52b-dc03524d970d","description":"

Allows querying transactions, specifically \"float\" type transactions, associated with a card.

\n","_postman_id":"97afe834-1f34-4781-b52b-dc03524d970d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Currency","item":[{"name":"{Id}","item":[{"name":"/api/currency/:id","id":"0aaf4bd9-ce1a-4aec-a460-00ff16ca21f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/currency/:id","description":"

This endpoint retrieves currency details based on the provided ID. The response for this request can be documented as a JSON schema as follows:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"name\": {\"type\": \"string\"},\n    \"alphaCode\": {\"type\": \"string\"},\n    \"decimalPlaces\": {\"type\": \"integer\"},\n    \"isActive\": {\"type\": \"boolean\"}\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","currency",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"25734864-964e-484c-855e-7b93f71accee","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d4503b64-7ca2-4af5-b244-526d80305653","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/currency/:id","host":["https://dev.viacarte.com:8440"],"path":["api","currency",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n}"}],"_postman_id":"0aaf4bd9-ce1a-4aec-a460-00ff16ca21f2"}],"id":"508465e3-e8b9-4a92-8e7a-b1707fa611eb","description":"

Retrieves the details of a specific currency using its identifier (id).

\n","_postman_id":"508465e3-e8b9-4a92-8e7a-b1707fa611eb","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Search","item":[{"name":"/api/currency/search","id":"c35352b7-6a31-4dad-9368-a2491282de7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"advancedSearch\": {\n \"fields\": [\n \"\",\n \"\"\n ],\n \"keyword\": \"\"\n },\n \"keyword\": \"\",\n \"advancedFilter\": {\n \"logic\": \"\",\n \"filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"\",\n \"value\": {\n \"nullable\": true\n }\n },\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"orderBy\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/currency/search","description":"

API Request Description

\n

This API endpoint allows you to search for currency data based on specified criteria. The request should be sent as an HTTP POST to https://dev.viacarte.com:8440/api/currency/search.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
advancesSearchObjectAn object containing advanced search criteria.
keywordStringThe keyword to search for.
advancedFilterObjectAn advanced filter for the search.
pageNumberIntegerThe page number for paginated results.
pageSizeIntegerThe page number for paginated results.
orderBy[String]An array of fields to order the results by.
\n

Advanced Search Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
fields[Object]An array of fields to search within.
keywordStringThe keyword to search for.
\n

Advanced Filter Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
logicstringThe logical operator for the filter.
filters[Object]An array of filter objects.
\n

Filter [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
FieldData typeDescription
valuestringThe value to filter by.
field[Object]The field to apply the filter on.
operatorstringThe operator for the filter.
\n

Value string

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
nullablebooleanIndicates if the value can be null.
\n
    \n

  • advancedSearch (object): An object containing advanced search criteria.

    \n
      \n

    • fields (array of strings): An array of fields to search within.

      \n
      • \n

    • keyword (string): The keyword to search for.

      \n
      • \n
    \n
    • \n

  • keyword (string): The keyword to search for.

    \n
    • \n

  • advancedFilter (object): An advanced filter for the search.

    \n
      \n

    • logic (string): The logical operator for the filter.

      \n
      • \n

    • filters (array of objects): An array of filter objects.

      \n
        \n

      • value (string): The value to filter by.

        \n
        • \n

      • field (string): The field to apply the filter on.

        \n
        • \n

      • operator (string): The operator for the filter.

        \n
        • \n
      \n
      • \n

    • value (object): The value for the filter.

      \n
        \n
      • nullable (boolean): Indicates if the value can be null.
        • \n
      \n
      • \n
    \n
    • \n

  • pageNumber (integer): The page number for paginated results.

    \n
    • \n

  • pageSize (integer): The number of results per page.

    \n
    • \n

  • orderBy (array of strings): An array of fields to order the results by.

    \n
    • \n
\n

Response

\n

The response will be in the form of a JSON schema, with the following structure:

\n
{\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"alphaCode\": \"\",\n      \"decimalPlaces\": \"\",\n      \"isActive\": \"\"\n    }\n  ],\n  \"currentPage\": \"\",\n  \"totalPages\": \"\",\n  \"totalCount\": \"\",\n  \"pageSize\": \"\",\n  \"hasPreviousPage\": \"\",\n  \"hasNextPage\": \"\"\n}\n\n
\n

The data array contains currency objects with properties such as id, name, alphaCode, decimalPlaces, and isActive. The response also includes pagination information like currentPage, totalPages, totalCount, pageSize, hasPreviousPage, and hasNextPage.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","currency","search"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"ae1b56a3-5e26-4aee-9eb6-afc0a49bbb94","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"advancedSearch\": {\n \"fields\": [\n \"\",\n \"\"\n ],\n \"keyword\": \"\"\n },\n \"keyword\": \"\",\n \"advancedFilter\": {\n \"logic\": \"\",\n \"filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"\",\n \"value\": {\n \"nullable\": true\n }\n },\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"orderBy\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/currency/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n }\n ],\n \"currentPage\": \"\",\n \"totalPages\": \"\",\n \"totalCount\": \"\",\n \"pageSize\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n}"}],"_postman_id":"c35352b7-6a31-4dad-9368-a2491282de7c"}],"id":"338570c9-8997-47f1-bd85-b0b14ecd196f","description":"

Allows searching for currencies using specific criteria.

\n","_postman_id":"338570c9-8997-47f1-bd85-b0b14ecd196f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"/api/currency","id":"8d89ae31-61f2-4ddf-90a6-c66ca07e211e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/currency","description":"

Retrieve Currency Information

\n

This endpoint allows you to retrieve currency information.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • Endpoint: https://dev.viacarte.com:8440/api/currency

    \n
    • \n
\n

Response

\n

The response for this request follows the JSON schema below:

\n
{\n  \"type\": \"array\",\n  \"items\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"id\": {\n        \"type\": \"string\"\n      },\n      \"name\": {\n        \"type\": \"string\"\n      },\n      \"alphaCode\": {\n        \"type\": \"string\"\n      },\n      \"decimalPlaces\": {\n        \"type\": \"string\"\n      },\n      \"isActive\": {\n        \"type\": \"boolean\"\n      }\n    }\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","currency"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"df897f97-d7f8-420c-98c9-3ab17877dbf3","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/currency"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n }\n]"}],"_postman_id":"8d89ae31-61f2-4ddf-90a6-c66ca07e211e"}],"id":"91a00a12-fbec-485d-8497-1915f297e3d0","description":"

Enables managing and retrieving detailed currency information in the system. It provides functionalities to retrieve all currencies, search for a specific currency by its ID, and perform advanced searches with specific criteria and paginated results.

\n","_postman_id":"91a00a12-fbec-485d-8497-1915f297e3d0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Country","item":[{"name":"{Id}","item":[{"name":"/api/country/:id","id":"844bfdde-c491-4135-b5b8-382710143fbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/country/:id","description":"

This endpoint retrieves country information based on the provided country ID. The response for this request follows the JSON schema below:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"name\": {\"type\": \"string\"},\n    \"alpha3Code\": {\"type\": \"string\"},\n    \"numericCode\": {\"type\": \"string\"}\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","country",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"cd9ceb14-ed27-46c6-8762-0006a6399abd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"081d2b8b-601b-4932-9586-9de7734cde08","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/country/:id","host":["https://dev.viacarte.com:8440"],"path":["api","country",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n}"}],"_postman_id":"844bfdde-c491-4135-b5b8-382710143fbb"}],"id":"e28e9a6c-1c6a-43ef-a26c-3b6b48ff3a98","description":"

Retrieves the details of a specific country using its identifier (id).

\n","_postman_id":"e28e9a6c-1c6a-43ef-a26c-3b6b48ff3a98","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Search","item":[{"name":"/api/country/search","id":"a7f60052-9892-4fc7-85be-ab23e929756f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"advancedSearch\": {\n \"fields\": [\n \"\",\n \"\"\n ],\n \"keyword\": \"\"\n },\n \"keyword\": \"\",\n \"advancedFilter\": {\n \"logic\": \"\",\n \"filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"\",\n \"value\": {\n \"nullable\": true\n }\n },\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"orderBy\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/country/search","description":"

API Request Description

\n

This endpoint allows the client to search for countries using advanced search and filtering criteria.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
advancesSearchObjectAn object containing advanced search criteria.
keywordStringThe keyword to search for.
advancedFilterObjectAn advanced filter for the search.
pageNumberIntegerThe page number for paginated results.
pageSizeIntegerThe number of items per page.
orderBy[String]Specify the order of the results.
\n

Advanced Search Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
fields[Object]Specify the fields to be included in the advanced search.
keywordStringThe keyword to be used for the advanced search.
\n

Advanced Filter Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
logicstringThe logical operator to be used for filtering.
filters[Object]Contains the filter criteria.
\n

Filter [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
FieldData typeDescription
valuestringThe value to be used for filtering.
field[Object]The field on which the filter is to be applied.
operatorstringThe operator to be used for filtering.
\n

Value string

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
nullablebooleanNullable value for filtering.
\n
    \n

  • advancedSearch (object):

    \n
      \n

    • fields (array of strings): Specify the fields to be included in the advanced search.

      \n
      • \n

    • keyword (string): The keyword to be used for the advanced search.

      \n
      • \n
    \n
    • \n

  • keyword (string): The keyword for the search.

    \n
    • \n

  • advancedFilter (object):

    \n
      \n

    • logic (string): The logical operator to be used for filtering.

      \n
      • \n

    • filters (array of objects): Contains the filter criteria.

      \n
        \n

      • value (string): The value to be used for filtering.

        \n
        • \n

      • field (string): The field on which the filter is to be applied.

        \n
        • \n

      • operator (string): The operator to be used for filtering.

        \n
        • \n

      • value (object): Nullable value for filtering.

        \n
        • \n
      \n
      • \n
    \n
    • \n

  • pageNumber (integer): The page number for paginated results.

    \n
    • \n

  • pageSize (integer): The number of items per page.

    \n
    • \n

  • orderBy (array of strings): Specify the order of the results.

    \n
    • \n
\n

Response

\n

The response will be in the form of a JSON schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": { \"type\": \"string\" },\n          \"name\": { \"type\": \"string\" },\n          \"alpha3Code\": { \"type\": \"string\" },\n          \"numericCode\": { \"type\": \"string\" }\n        }\n      }\n    },\n    \"currentPage\": { \"type\": \"string\" },\n    \"totalPages\": { \"type\": \"string\" },\n    \"totalCount\": { \"type\": \"string\" },\n    \"pageSize\": { \"type\": \"string\" },\n    \"hasPreviousPage\": { \"type\": \"string\" },\n    \"hasNextPage\": { \"type\": \"string\" }\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","country","search"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"99b60cde-445b-473c-8943-e8d6bdee2406","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"advancedSearch\": {\n \"fields\": [\n \"\",\n \"\"\n ],\n \"keyword\": \"\"\n },\n \"keyword\": \"\",\n \"advancedFilter\": {\n \"logic\": \"\",\n \"filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"field\": \"\",\n \"operator\": \"\",\n \"value\": {\n \"nullable\": true\n }\n },\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"orderBy\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/country/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n }\n ],\n \"currentPage\": \"\",\n \"totalPages\": \"\",\n \"totalCount\": \"\",\n \"pageSize\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n}"}],"_postman_id":"a7f60052-9892-4fc7-85be-ab23e929756f"}],"id":"aab310b1-2f37-4f3a-bdb9-7da89cea0a42","description":"

Allows searching for countries with specified criteria.

\n","_postman_id":"aab310b1-2f37-4f3a-bdb9-7da89cea0a42","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"/api/country","id":"298d6351-d1a9-4246-86ad-2050cf08d54e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/country","description":"

This endpoint makes an HTTP GET request to retrieve a list of countries.

\n

The response is a JSON array containing objects with the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
idstringThe unique identifier of the country.
namestringThe name of the country.
alpha3CodestringThe alpha-3 code of the country.
numericCodestringThe numeric code of the country.
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","country"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"b57fab69-8a3a-4848-ba31-a959f438b61c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/country"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n }\n]"}],"_postman_id":"298d6351-d1a9-4246-86ad-2050cf08d54e"}],"id":"46553ba4-155f-41e2-bdd0-5049fd83fb0e","description":"

This controller allows managing and searching detailed information about countries in the system, providing functionalities to retrieve all countries, search for a specific one by its ID, and perform advanced searches with pagination.

\n","_postman_id":"46553ba4-155f-41e2-bdd0-5049fd83fb0e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Entity","item":[{"name":"{Id}","item":[{"name":"/api/entity/:id","id":"8f5273cb-27e5-4a9c-8a4c-555d767f0fb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/entity/:id","description":"

GET /api/entity/:id

\n

This endpoint retrieves information about a specific entity identified by its ID.

\n

Request

\n

No request body is required for this endpoint.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldData typeDescription
idpath parameterThe unique identifier of the entity.
\n

Response

\n

The response will be a JSON object with the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescription
idThe unique identifier of the entity.
nameThe name of the entity.
businessNameThe business name of the entity.
legalIdThe legal identifier of the entity.
descriptionA description of the entity.
logoThe logo of the entity.
websiteThe website of the entity.
emailThe email address of the entity.
phoneThe phone number of the entity.
addressThe address of the entity.
countryIdThe ID of the country where the entity is located.
countryIdThe ID of the country where the entity is located.
countryAn object containing information about the country, including its ID, name, alpha3Code, and numericCode.
accountParentIdThe ID of the parent account of the entity.
settlementCurrencyCodeThe code of the settlement currency used by the entity.
billingCurrencyCodeThe code of the billing currency used by the entity.
billingCurrencyAn object containing information about the billing currency, including its ID, name, alphaCode, decimalPlaces, and isActive.
billingContactNameThe name of the billing contact for the entity.
billingContactEmailThe email address of the billing contact for the entity.
billingContactPhoneThe phone number of the billing contact for the entity.
customColorThe custom color associated with the entity.
isActiveIndicates whether the entity is active
balanceAn object containing information about the balance, including pendingBalanceAmount, actualBalanceAmount, blockedBalanceAmount, balanceCurrency, and availableBalanceAmount.
walletPocketAn array of objects, each containing information about a wallet pocket, including its ID, walletAccountId, currencyId, currencyName, balance, and maxBalanceLimit.
totalWalletBalanceThe total balance across all wallets associated with the entity.
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","entity",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"adc6010e-53e2-490f-aa21-d97f4bfd6a48","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"90485c40-67bf-44ff-a217-4ffe19c77bb8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/entity/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","entity",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"accountParentId\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"walletPocket\": [\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n },\n {\n \"id\": \"\",\n \"walletAccountId\": \"\",\n \"currencyId\": \"\",\n \"currencyName\": \"\",\n \"balance\": \"\",\n \"maxBalanceLimit\": \"\"\n }\n ],\n \"totalWalletBalance\": \"\"\n}"}],"_postman_id":"8f5273cb-27e5-4a9c-8a4c-555d767f0fb1"}],"id":"398ad744-e014-4c79-bfcd-73bad35b3213","description":"

This method allows retrieving the details of a specific entity using its identifier (id).

\n","_postman_id":"398ad744-e014-4c79-bfcd-73bad35b3213","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Transaction Limit","item":[{"name":"{id}","item":[{"name":"/api/v1/cardtransactionlimit/:id","id":"3651dd03-a608-407b-a69a-17e5885652f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/cardtransactionlimit/:id","description":"

Get Card Transaction Limit

\n

This endpoint retrieves the transaction limit details for a specific card.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://dev.viacarte.com:8440/api/v1/cardtransactionlimit/:id

    \n
    • \n
\n

Response

\n

The response for this request can be represented as a JSON schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"description\": {\n      \"type\": \"string\"\n    },\n    \"transactionType\": {\n      \"type\": \"string\"\n    },\n    \"timeRange\": {\n      \"type\": \"string\"\n    },\n    \"amount\": {\n      \"type\": \"string\"\n    },\n    \"cardPlanId\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","cardtransactionlimit",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"9278dd3b-5e73-4fe6-878c-a93f122f02a2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ce35bb3f-51d7-4095-907c-5db756351f94","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/cardtransactionlimit/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","cardtransactionlimit",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"description\": \"\",\n \"transactionType\": \"\",\n \"timeRange\": \"\",\n \"amount\": \"\",\n \"cardPlanId\": \"\"\n}"}],"_postman_id":"3651dd03-a608-407b-a69a-17e5885652f1"}],"id":"3eabaea4-ecfe-4b7a-a829-34bad2de8687","description":"

Retrieves the list of transaction limits associated with a specific card plan.

\n","_postman_id":"3eabaea4-ecfe-4b7a-a829-34bad2de8687","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"By Card Plan","item":[{"name":"{id}","item":[{"name":"/api/v1/cardtransactionlimit/card-plan/:id","id":"46ea2c7e-2d6a-4c4d-98de-aec3bee64b43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/cardtransactionlimit/card-plan/:id","description":"

Get Card Transaction Limit by Card Plan ID

\n

This endpoint retrieves the card transaction limit based on the provided card plan ID.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://dev.viacarte.com:8440/api/v1/cardtransactionlimit/card-plan/:id

    \n
    • \n
\n

Response

\n

The response will include an array of objects, each containing the following attributes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
teTypeDescription
IdUUIDThe unique identifier of the transaction limit.
descriptionStringA description for the transaction limit.
\n
    \n

  • id (string): The ID of the transaction limit

    \n
    • \n

  • description (string): Description of the transaction limit

    \n
    • \n

  • transactionType (string): Type of transaction

    \n
    • \n

  • timeRange (string): Time range for the transaction limit

    \n
    • \n

  • amount (string): The transaction amount limit

    \n
    • \n

  • cardPlanId (string): The ID of the associated card plan

    \n
    • \n
\n

Example response:

\n
[\n    {\n        \"id\": \"\",\n        \"description\": \"\",\n        \"transactionType\": \"\",\n        \"timeRange\": \"\",\n        \"amount\": \"\",\n        \"cardPlanId\": \"\"\n    }\n]\n\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","cardtransactionlimit","card-plan",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"e1069a9d-4c0f-40e4-8de2-7d275df46ccf","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"cdbb872d-3781-42ca-b6fd-2836b34158d8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/cardtransactionlimit/card-plan/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","cardtransactionlimit","card-plan",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"description\": \"\",\n \"transactionType\": \"\",\n \"timeRange\": \"\",\n \"amount\": \"\",\n \"cardPlanId\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"transactionType\": \"\",\n \"timeRange\": \"\",\n \"amount\": \"\",\n \"cardPlanId\": \"\"\n }\n]"}],"_postman_id":"46ea2c7e-2d6a-4c4d-98de-aec3bee64b43"}],"id":"9ceba0e0-297b-4e15-a16e-e9d7e99b45c0","description":"

Retrieves the details of a specific transaction limit.

\n","_postman_id":"9ceba0e0-297b-4e15-a16e-e9d7e99b45c0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"48ae24cd-6ed6-4210-b02e-6013c1163cef","_postman_id":"48ae24cd-6ed6-4210-b02e-6013c1163cef","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"/api/v1/cardtransactionlimit","id":"22171b1f-17ab-47bc-9ac9-837ca577fa2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"description\": \"\",\n \"transactionType\": \"\",\n \"timeRange\": \"\",\n \"amount\": \"\",\n \"cardPlanId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/cardtransactionlimit","description":"

This endpoint allows you to update the transaction limit for a card. The HTTP PUT request should be made to https://dev.viacarte.com:8440/api/v1/cardtransactionlimit. The request body should be in raw format and include the following parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
DateTypeDescription
IdUUIDThe unique identifier of the transaction limit.
descriptionStringA description for the transaction limit.
transactionTypeStringThe type of transaction for which the limit is being set.
timeRangeStringThe time range for the transaction limit.
amountDoubleThe maximum amount allowed for the transaction limit.
cardPlanIdUUIDThe unique identifier of the card plan to which the transaction limit applies.
\n

The response will include the updated transaction limit details.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","cardtransactionlimit"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"5724f1c5-457d-4ac7-a9e6-c2502906378d","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"description\": \"\",\n \"transactionType\": \"\",\n \"timeRange\": \"\",\n \"amount\": \"\",\n \"cardPlanId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/cardtransactionlimit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"22171b1f-17ab-47bc-9ac9-837ca577fa2f"}],"id":"55236454-7ffe-46b8-aa39-edf723661a2d","description":"

The service provides an API for managing transaction limits associated with cards, allowing for their consultation and updating. Its goal is to enable the efficient management of limits applied to user transactions, whether at the card plan level or for a specific limit.

\n

Key functionalities:

\n
    \n

  • Transaction limit query by card plan
    Allows retrieving all transaction limits associated with a specific card plan.

    \n
    • \n

  • Transaction limit query by ID
    Retrieves the details of a specific transaction limit.

    \n
    • \n

  • Transaction limit update
    Modifies the configuration of an existing transaction limit.

    \n
    • \n
\n

Security:
All endpoints require authentication (Authorize), ensuring that only authorized users can access or modify the transaction limit information.

\n

Main benefit:
Facilitates the management of card usage restrictions by allowing transaction limits to be established and modified in a centralized and secure manner.

\n","_postman_id":"55236454-7ffe-46b8-aa39-edf723661a2d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"afbbe20c-4c65-4322-8784-6cbd4cb5bbed","_postman_id":"afbbe20c-4c65-4322-8784-6cbd4cb5bbed","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Health Check","item":[{"name":"/api/health","id":"1e4d9cb3-a385-4481-8bc2-c601e50d3e2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/health","description":"

GET /api/health

\n

Returns the current health status of the system including database connectivity, memory usage, and external services.

\n","urlObject":{"path":["api","health"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"03f11056-2150-4ba9-a100-a2a424af0609","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"http://172.233.164.113:8440/api/v1/entity/:id","protocol":"http","host":["172","233","164","113"],"port":"8440","path":["api","v1","entity",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": \"\",\n \"HealthChecks\": [\n {\n \"Status\": \"\",\n \"Component\": \"\",\n \"Description\": \"\"\n },\n {\n \"Status\": \"\",\n \"Component\": \"\",\n \"Description\": \"\"\n },\n {\n \"Status\": \"\",\n \"Component\": \"\",\n \"Description\": \"\"\n }\n ],\n \"HealthCheckDuration\": \"\"\n}\n"}],"_postman_id":"1e4d9cb3-a385-4481-8bc2-c601e50d3e2b"}],"id":"48d40f6a-007c-4368-82e2-c2726e52670a","description":"

Basic system Health Check.

\n","_postman_id":"48d40f6a-007c-4368-82e2-c2726e52670a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Simulator","item":[{"name":"Send Transaction","id":"c7aba91f-01c9-43dc-8380-74b5bd771e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"transactionType\": 1,\n \"cardId\": \"uuid-guid-here\",\n \"amountTransaction\": 100.00,\n \"cardholderBillingAmount\": 100.00,\n \"stan\": \"123456\",\n \"localTime\": \"143000\",\n \"localDate\": \"0625\",\n \"merchantCategoryCode\": \"5999\",\n \"acquiringInstitutionCountryCode\": \"840\",\n \"posEntryMode\": \"0100\",\n \"posConditionCode\": \"59\",\n \"retrievalReferenceNumber\": \"123456789012\",\n \"cardAcceptorTerminalId\": \"TERM0001\",\n \"cardAcceptorIdentifier\": \"123456789012345\",\n \"cardAcceptorNameAndLocation\": \"ViaCarte SimTest MNG NI\",\n \"currencyCodeTransaction\": \"840\",\n \"currencyCodeCardholderBilling\": \"840\",\n \"acquiringInstitutionIdentificationCode\": \"409377\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/simulator/send-transaction","description":"

Sends an ISO8583 message over TCP/IP to a predefined host for simulation purposes. Supports Authorization, Financial, Reversal, and Echo Test transaction types.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueTypeRequired Fields
1Authorization (0100)All fields (except those marked as Echo-only)
2Financial (0200)Same as above
3Reversal (0400)Same as above
4Echo Test (0800)Only these: transactionType, acquiringInstitutionIdentificationCode, cardAcceptorTerminalId, cardAcceptorIdentifier
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","simulator","send-transaction"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"5487348e-2d71-49ff-abfa-393e1977a46d","name":"Send Transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"76c03395-eb21-4ef1-a142-b501e3f27767\",\n \"cardId\": \"8d240000-2ec2-6045-0733-08dda710295a\",\n \"transactionType\": 1,\n \"amountTransaction\": 100,\n \"cardholderBillingAmount\": 100,\n \"stan\": \"734127\",\n \"localTime\": \"204449\",\n \"localDate\": \"0622\",\n \"merchantCategoryCode\": \"5999\",\n \"acquiringInstitutionCountryCode\": \"840\",\n \"posEntryMode\": \"0100\",\n \"posConditionCode\": \"59\",\n \"acquiringInstitutionIdentificationCode\": \"409377\",\n \"retrievalReferenceNumber\": \"671104166660\",\n \"cardAcceptorTerminalId\": \"TERM0001\",\n \"cardAcceptorIdentifier\": \"123456789012345\",\n \"cardAcceptorNameAndLocation\": \"ViaCarteSimulator Managua NI\",\n \"currencyCodeTransaction\": \"840\",\n \"currencyCodeCardholderBilling\": \"840\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/simulator/send-transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"internalTransactionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"mti\": \"0110\",\n \"responseCode\": \"TE\",\n \"requestMessage\": \"009060600000000100763C658108E0A00009092939482800000000000001000000000001000006230246094409822029450622290659990840010040937759064093773333393531313434303534315445524D30303031313233343536373839303132333435566961436172746553696D756C61746F72202020202020204D616E61677561202020202020204E4908400840\",\n \"responseMessage\": \"60600000000110763C65810AC00000090929394828000000000000010000000000010000062302460944098220294506222906599908400100409377590640937733333935313134343035343154453030524D30303031313233343536373839303132333435116A0000\",\n \"parsedRequestMessage\": \"[[[<----TPDU Content---->]]]: \\nTPDU:\\nH[001] [60]\\nH[002] [6000]\\nH[003] [0000]\\n[[[<----ISO Message Content---->]]]: \\nF[000] [0100]\\nF[002] [929394828]\\nF[003] [000000]\\n [00 - Goods/Service Purchase POS transaction only] [Type of cardholder transaction or center function being processed]\\n [00 - Not Applicable or Not Specified] [Account type affected by this transaction]\\n [00 - Not Applicable or Not Specified] [Account type to which an account transfer is made]\\nF[004] [000000010000]\\nF[006] [000000010000]\\nF[007] [0623024609]\\nF[011] [440982]\\nF[012] [202945]\\nF[013] [0622]\\nF[014] [2906]\\nF[018] [5999]\\nF[019] [840]\\nF[022] [0100]\\n [01 - Manual key entry] [PAN and Date Entry Mode]\\n [0 - Unknown] [PIN Entry Capability]\\n [0 - Unused] [Fill (RFU)]\\nF[024] [409377]\\nF[025] [59]\\nF[032] [409377]\\nF[037] [339511440541]\\nF[041] [TERM0001]\\nF[042] [123456789012345]\\nF[043] [ViaCarteSimulator Managua NI]\\nF[049] [840]\\nF[051] [840]\\n\",\n \"parsedResponseMessage\": \"[[[<----TPDU Content---->]]]: \\nTPDU:\\nH[001] [60]\\nH[002] [6000]\\nH[003] [0000]\\n[[[<----ISO Message Content---->]]]: \\nF[000] [0110]\\nF[002] [929394828]\\nF[003] [000000]\\n [00 - Goods/Service Purchase POS transaction only] [Type of cardholder transaction or center function being processed]\\n [00 - Not Applicable or Not Specified] [Account type affected by this transaction]\\n [00 - Not Applicable or Not Specified] [Account type to which an account transfer is made]\\nF[004] [000000010000]\\nF[006] [000000010000]\\nF[007] [0623024609]\\nF[011] [440982]\\nF[012] [202945]\\nF[013] [0622]\\nF[014] [2906]\\nF[018] [5999]\\nF[019] [840]\\nF[022] [0100]\\n [01 - Manual key entry] [PAN and Date Entry Mode]\\n [0 - Unknown] [PIN Entry Capability]\\n [0 - Unused] [Fill (RFU)]\\nF[024] [409377]\\nF[025] [59]\\nF[032] [409377]\\nF[037] [339511440541]\\nF[039] [TE]\\nF[041] [00RM0001]\\nF[042] [123456789012345]\\n\",\n \"applySettlement\": true\n}"}],"_postman_id":"c7aba91f-01c9-43dc-8380-74b5bd771e59"},{"name":"Generate Settlement","id":"80277d92-7a06-4eac-9c92-81db4e7bfb20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://dev.viacarte.com:8440/api/v1/simulator/simulate/settlement/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","simulator","simulate","settlement",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"de848580-a5fb-45c6-accc-1853144a9766","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"80277d92-7a06-4eac-9c92-81db4e7bfb20"}],"id":"d79a8c38-c611-4945-b664-34d064428a94","_postman_id":"d79a8c38-c611-4945-b664-34d064428a94","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"8447690d-43ad-475f-896c-067ebf8d2751","description":"

StartFragment

\n
    \n

  1. Transactions
    Allows retrieving transactions, including \"float\" transactions and charged transactions, associated with a specific card.

    \n
    2. \n

  2. Currencies
    Provides tools to manage and retrieve detailed information about the currencies available in the system. Includes functionalities to:
    - Retrieve the complete list of currencies.
    - Search for a specific currency by its ID.
    - Perform advanced searches with custom criteria and paginated results.

    \n
    3. \n

  3. Countries
    Enables the management and querying of detailed information about countries in the system. Functionalities include:

    \n
      \n

    • Retrieve the complete list of countries.

      \n
      • \n

    • Search for a specific country by its ID.

      \n
      • \n

    • Perform advanced searches with paginated results.

      \n
      • \n
    \n
    4. \n

  4. Entity
    This endpoint allows retrieving detailed information about a specific entity using its ID as an identifier.

    \n
    5. \n
\n","_postman_id":"8447690d-43ad-475f-896c-067ebf8d2751","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"KYC fuctions","item":[{"name":"Files","item":[{"name":"/api/v1/customerpreregistration/save-file","id":"3621cdcf-a876-4cd3-805d-fbaaf51d4a4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"idType\": \"\",\n \"languageId\": \"\",\n \"issueDate\": \"\",\n \"issueBy\": \"\",\n \"file\": {\n \"name\": \"\",\n \"extension\": \"\",\n \"type\": \"\",\n \"data\": \"\"\n } ,\n \"verificationType\": \"string\",\n \"languageOther\": \"string\",\n \"customerPreRegistrationId\":\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n\n \n ","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/save-file","description":"

Purpose

\n

This endpoint allows you to upload and save a file associated with a customer pre-registration. It is typically used to submit identification documents or other required files as part of the customer onboarding or KYC (Know Your Customer) process.

\n

Request URL

\n

POST https://dev.viacarte.com:8440/api/v1/customerpreregistration/save-file

\n

Required Headers

\n
    \n

  • Content-Type: application/json — The request body must be in JSON format.

    \n
    • \n

  • Accept: text/plain — The response will be returned as plain text.

    \n
    • \n
\n

Request Body

\n

The request body must be a JSON object with the following structure:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequired?Description
idTypestringYesType of identification document.
Possible values depend on the verification type:
• If VerificationType = IDENTITY, allowed values are: PASSPORT, CITIZENSHIPNUMBER, DRIVERLICENSE, OTHER.
• If VerificationType = ADDRESS, allowed values are: UTILITYBILL, CREDITCARDSTATEMENT, BANKSTATEMENT, BANKLETTER, POSTOFFICEBALANCECERTIFICATE, INSURANCEPOLICY, GOVERNMENTISSUEDPHOTOID, OTHER.
languageIdintegerYesIdentifier of the document’s language (numeric code).
issueDatedateTimeYesDate when the document was issued (ISO 8601 format).
issueBystringYesAuthority or entity that issued the document.
fileobjectYesObject containing details about the uploaded file.
├── namestringYesName of the file (e.g., document.pdf).
├── extensionstringYesFile extension (e.g., pdf, jpg).
├── typestringYesMIME type of the file (e.g., application/pdf).
└── datastringYesBase64-encoded file content.
verificationTypestringYesType of verification being performed.
Possible values:
-IDENTITY: Identity verification.
-ADDRESS: Address verification.
languageOtherstringNoOptional field for specifying a language not covered by languageId.
It is required when the language ID is 0.
customerPreRegistrationIdstring (UUID)YesUnique identifier for the customer pre-registration record.
\n

Field Details

\n
    \n

  • idType: Type of identification document.
    Possible values depend on the verification type:
    • If VerificationType = IDENTITY, allowed values are: PASSPORT, CITIZENSHIPNUMBER, DRIVERLICENSE, OTHER.
    • If VerificationType = ADDRESS, allowed values are: UTILITYBILL, CREDITCARDSTATEMENT, BANKSTATEMENT, BANKLETTER, POSTOFFICEBALANCECERTIFICATE, INSURANCEPOLICY, GOVERNMENTISSUEDPHOTOID, OTHER.

    \n
    • \n

  • languageId: Numeric code representing the language of the document or customer.

    \n
    • \n

  • issueDate: The date when the document was issued.

    \n
    • \n

  • issueBy: The authority or organization that issued the document.

    \n
    • \n

  • file: An object containing details about the file being uploaded:

    \n
      \n

    • name: The filename, including extension.

      \n
      • \n

    • extension: The file's extension (e.g., pdf, jpg).

      \n
      • \n

    • type: The MIME type of the file.

      \n
      • \n

    • data: The file content, encoded as a Base64 string.

      \n
      • \n
    \n
    • \n

  • verificationType: Indicates the type of verification for which the file is being submitted. Possible values:

    \n
    • \n
\n

-IDENTITY: Identity verification.

\n

-ADDRESS: Address verification.

\n
    \n

  • languageOther: If the language is not represented by languageId, specify it here as a string. It is required when the language ID is 0.

    \n
    • \n

  • customerPreRegistrationId: The unique identifier for the customer pre-registration process.

    \n
    • \n
\n

Example Request Body

\n
{\n  \"idType\": \"passport\",\n  \"languageId\": 1,\n  \"issueDate\": \"2023-01-01T00:00:00Z\",\n  \"issueBy\": \"Government Authority\",\n  \"file\": {\n    \"name\": \"passport.pdf\",\n    \"extension\": \"pdf\",\n    \"type\": \"application/pdf\",\n    \"data\": \"<Base64-encoded string>\"\n  },\n  \"verificationType\": \"identity\",\n  \"languageOther\": \"\",\n  \"customerPreRegistrationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}\n\n

Possible Response

\n
    \n
  • Status 200 OK: File saved successfully. The response may include a confirmation message or an object with details about the saved file.
    • \n
\n

Example Response

\n
{\n  \"name\": \"OK\",\n  \"id\": \"<unique-file-id>\",\n  \"status\": \"OK\"\n}\n\n
    \n

  • Status 400/422: Validation error (e.g., missing required fields, invalid file format).

    \n
    • \n

  • Status 500: Internal server error.

    \n
    • \n
\n

Notes

\n
    \n

  • Ensure the file.data field contains a valid Base64-encoded string of the file content.

    \n
    • \n

  • The customerPreRegistrationId must correspond to an existing pre-registration record.

    \n
    • \n
\n
\n

For more details, refer to the ViaCarte Client API collection.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customerpreregistration","save-file"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"3487ec0b-3159-434d-ac61-0acfbe4e99e1","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"languageId\": \"\",\n \"countryId\": \"\",\n \"issueDate\": \"\",\n \"expiryDate\": \"\",\n \"issueBy\": \"\",\n \"file\": {\n \"name\": \"\",\n \"extension\": \"\",\n \"type\": \"\",\n \"data\": \"\"\n },\n \"verificationType\": \"\",\n \"languageOther\": \"\",\n \"customerPreRegistrationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/save-file"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3621cdcf-a876-4cd3-805d-fbaaf51d4a4b"}],"id":"7bb4c3a3-816b-49a6-9b30-758ff29d031b","description":"

Manages files associated with the customer pre-registration, allowing retrieval and upload.

\n","_postman_id":"7bb4c3a3-816b-49a6-9b30-758ff29d031b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Send-Invitation","item":[{"name":"/api/v1/customerpreregistration/kyc/send-invitation","id":"6f5d744d-2a51-4de7-a1e0-ed07b155b9b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"username\": \"string\",\n \"email\": \"string\",\n \"countryId\": \"string\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"programId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"userEmail\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/send-invitation","description":"

This endpoint is used to send a KYC (Know Your Customer) invitation to a customer as part of the pre-registration process. It initiates the KYC workflow by sending an invitation email to the specified user, allowing them to complete their KYC verification.

\n

Request Body Parameters:
The request body must be a JSON object with the following fields:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
firstNamestringYesCustomer's first name.
lastNamestringYesCustomer's last name.
usernamestringoptionalUnique username for the customer.
emailstringYesCustomer's email address where the invitation will be sent.
countryIdstringYesIdentifier for the customer's country.
entityIdstring (UUID)YesUnique identifier for the entity (organization or business context).
programIdstring (UUID)YesUnique identifier for the program under which the invitation is sent.
userEmailstringYesRequesting user’s email.
\n

Usage Notes:

\n
    \n

  • All fields are required and must be provided in the request body.

    \n
    • \n

  • The entityId and programId should be valid UUIDs corresponding to existing entities and programs in your system.

    \n
    • \n

  • The endpoint will send an invitation email to the specified email address. Ensure the email is correct and accessible by the customer.

    \n
    • \n

  • The response will typically indicate whether the invitation was sent successfully or if there were any errors (e.g., invalid parameters, user already invited).

    \n
    • \n
\n

Related Collection: ViaCarte Client API

\n

For more details on error codes and possible responses, refer to the collection-level documentation or saved examples.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customerpreregistration","send-invitation"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"27071541-3877-44c7-8ec6-4fcce21cda28","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"username\": \"string\",\n \"email\": \"string\",\n \"countryId\": \"string\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"programId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"userEmail\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/kyc/send-invitation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6f5d744d-2a51-4de7-a1e0-ed07b155b9b8"}],"id":"0e540e65-81e8-490d-8914-ab22cf1070cb","description":"

Sends a KYC verification invitation to the customer via email.

\n","_postman_id":"0e540e65-81e8-490d-8914-ab22cf1070cb","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"{Id}","item":[{"name":"files","item":[{"name":"/api/v1/customerpreregistration/:id/files","id":"caf7b3d3-741d-4a53-8834-a06a8c134220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/:id/files","description":"

Retrieves the list of files associated with a specific customer pre-registration.

\n
    \n

  • Purpose:
    Fetch all files uploaded or linked to a customer pre-registration record.

    \n
    • \n

  • Path Variable:

    \n
      \n
    • id (UUID): The unique identifier of the customer pre-registration. Required to specify which pre-registration's files to retrieve.
      • \n
    \n
    • \n

  • Response:
    Returns a plain text response containing the list or details of files for the specified pre-registration. The exact structure depends on the API implementation.

    \n
    • \n

  • Usage Notes:

    \n
      \n

    • Ensure the id provided is valid and corresponds to an existing customer pre-registration.

      \n
      • \n

    • The endpoint requires appropriate authentication and authorization.

      \n
      • \n

    • This endpoint is read-only and does not modify any data.

      \n
      • \n
    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customerpreregistration",":id","files"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"1195156b-7a4c-42d4-adbf-1d3b72e52172","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"520d34b5-8958-4bce-b5a3-380fe66f7b37","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/:id/files","host":["https://dev.viacarte.com:8440"],"path":["api","v1","customerpreregistration",":id","files"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"languageId\": \"\",\n \"countryId\": \"\",\n \"issueDate\": \"\",\n \"expiryDate\": \"\",\n \"issueBy\": \"\",\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"fileType\": \"\",\n \"notes\": \"\",\n \"status\": \"\",\n \"verificationType\": \"\",\n \"languageOther\": \"\",\n \"customerPreRegistrationId\": \"\",\n \"createdBy\": \"\",\n \"createdOn\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedOn\": \"\"\n },\n {\n \"id\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"languageId\": \"\",\n \"countryId\": \"\",\n \"issueDate\": \"\",\n \"expiryDate\": \"\",\n \"issueBy\": \"\",\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"fileType\": \"\",\n \"notes\": \"\",\n \"status\": \"\",\n \"verificationType\": \"\",\n \"languageOther\": \"\",\n \"customerPreRegistrationId\": \"\",\n \"createdBy\": \"\",\n \"createdOn\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedOn\": \"\"\n }\n]"}],"_postman_id":"caf7b3d3-741d-4a53-8834-a06a8c134220"}],"id":"662527bd-bce2-4453-bd17-0912abc4fb67","_postman_id":"662527bd-bce2-4453-bd17-0912abc4fb67","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"/api/v1/customerpreregistration/:id","id":"126251dc-f5bd-4e40-9bdb-f5532a7c6b5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/:id","description":"

Get Customer Pre-Registration Details

\n

This endpoint retrieves the details of a specific customer pre-registration using their unique identifier.

\n

Request Parameters

\n
    \n
  • id (path parameter): The unique identifier of the customer pre-registration record you wish to retrieve. This value must be provided in the URL.
    • \n
\n

Response

\n

On a successful request, the API will return a response containing the details of the specified customer pre-registration. The response will include relevant information such as customer name, email, registration status, and any other associated metadata.

\n

Notes

\n
    \n

  • Ensure that the id provided in the request is valid and corresponds to an existing customer pre-registration record.

    \n
    • \n

  • The response will be in JSON format, and you should handle any potential errors that may arise from invalid IDs or server issues.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customerpreregistration",":id"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[{"id":"a7769d39-c7d8-4d45-9001-17b2bb109645","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8b94a8ff-f4b7-4e30-932d-9fdfef32bc1f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.viacarte.com:8440/api/v1/customerpreregistration/:id","host":["https://dev.viacarte.com:8440"],"path":["api","v1","customerpreregistration",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"title\": \"\",\n \"clientId\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"secondLastName\": \"\",\n \"suxfix\": \"\",\n \"userName\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"postalCode\": \"\",\n \"mobile\": \"\",\n \"phoneHome\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"passCode\": \"\",\n \"nationality\": \"\",\n \"gender\": \"\",\n \"email\": \"\",\n \"alternateEmail\": \"\",\n \"dateOfBirth\": \"\",\n \"buildingNumber\": \"\",\n \"company\": \"\",\n \"externalReference\": \"\",\n \"additionalDocument\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"fileKeys\": [\n \"\",\n \"\"\n ],\n \"additionalData\": \"\",\n \"authorized\": \"\",\n \"authorizedBy\": \"\",\n \"cardholderName\": \"\",\n \"invitation\": \"\",\n \"instantIssueAccountCard\": \"\",\n \"automaticallyApplyForCard\": \"\",\n \"programId\": \"\",\n \"cardPlanId\": \"\",\n \"includeKYCVerification\": \"\",\n \"receivedFiles\": \"\",\n \"identityDocumentLoaded\": \"\",\n \"isComplete\": \"\",\n \"isFailed\": \"\",\n \"createdOn\": \"\",\n \"createdBy\": \"\",\n \"lastModifiedOn\": \"\",\n \"lastModifiedBy\": \"\",\n \"countryId\": \"\",\n \"transactionFrequency\": \"\",\n \"transactionVolume\": \"\",\n \"mainTransactionCountries\": [\n \"\",\n \"\"\n ],\n \"occupation\": \"\",\n \"referenceLetterFile\": [\n \"\",\n \"\"\n ],\n \"incomeProofFile\": [\n \"\",\n \"\"\n ],\n \"entityId\": \"\",\n \"customerId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"subdomain\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"processorAccountId\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"state\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"schemeBalances\": [\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n },\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n }\n ],\n \"totalWalletBalance\": \"\",\n \"languageId\": \"\",\n \"language\": {\n \"id\": \"\",\n \"languageName\": \"\"\n },\n \"primaryContactFirstName\": \"\",\n \"primaryContactLastName\": \"\",\n \"primaryContactName\": \"\",\n \"primaryContactEmail\": \"\",\n \"primaryContactPhone\": \"\",\n \"redirectUrl\": \"\",\n \"autoKycApproval\": \"\",\n \"kycWaiverEnabled\": \"\",\n \"activeAuthorization\": \"\"\n },\n \"customer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"subdomain\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"processorAccountId\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"state\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"schemeBalances\": [\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n },\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n }\n ],\n \"totalWalletBalance\": \"\",\n \"languageId\": \"\",\n \"language\": {\n \"id\": \"\",\n \"languageName\": \"\"\n },\n \"primaryContactFirstName\": \"\",\n \"primaryContactLastName\": \"\",\n \"primaryContactName\": \"\",\n \"primaryContactEmail\": \"\",\n \"primaryContactPhone\": \"\",\n \"redirectUrl\": \"\",\n \"autoKycApproval\": \"\",\n \"kycWaiverEnabled\": \"\",\n \"activeAuthorization\": \"\"\n },\n \"program\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isActive\": \"\",\n \"assignedFlows\": [\n \"\",\n \"\"\n ],\n \"shippingAddressSource\": \"\",\n \"shippingMethod\": \"\",\n \"physicalCardLimit\": \"\",\n \"virtualCardLimit\": \"\",\n \"instantCardLimit\": \"\",\n \"workflowId\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalance\": \"\",\n \"pendingBalance\": \"\",\n \"availableBalance\": \"\",\n \"cardPlansCount\": \"\",\n \"walletArraysCount\": \"\",\n \"entityId\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"subdomain\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"processorAccountId\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"state\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"schemeBalances\": [\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n },\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n }\n ],\n \"totalWalletBalance\": \"\",\n \"languageId\": \"\",\n \"language\": {\n \"id\": \"\",\n \"languageName\": \"\"\n },\n \"primaryContactFirstName\": \"\",\n \"primaryContactLastName\": \"\",\n \"primaryContactName\": \"\",\n \"primaryContactEmail\": \"\",\n \"primaryContactPhone\": \"\",\n \"redirectUrl\": \"\",\n \"autoKycApproval\": \"\",\n \"kycWaiverEnabled\": \"\",\n \"activeAuthorization\": \"\"\n }\n },\n \"cardPlan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"currencyCode\": \"\",\n \"maximumBalanceLimit\": \"\",\n \"limit\": \"\",\n \"cardDesignId\": \"\",\n \"cardDesign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"imagePath\": \"\",\n \"bankLogoPath\": \"\",\n \"watermarkPath\": \"\",\n \"cardColor\": \"\",\n \"watermarkColor\": \"\"\n },\n \"logoPath\": \"\",\n \"cardBrand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"logoPath\": \"\",\n \"cardImagePath\": \"\",\n \"firstDigit\": \"\"\n },\n \"currency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"header\": \"\",\n \"subheader\": \"\",\n \"benefits\": \"\",\n \"ruleGroupsId\": [\n \"\",\n \"\"\n ],\n \"ruleGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"riskLevel\": \"\"\n }\n ],\n \"cardTransactionLimits\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"transactionType\": \"\",\n \"timeRange\": \"\",\n \"amount\": \"\",\n \"cardPlanId\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"transactionType\": \"\",\n \"timeRange\": \"\",\n \"amount\": \"\",\n \"cardPlanId\": \"\"\n }\n ],\n \"terms\": \"\",\n \"annualMembershipFee\": \"\",\n \"monthlyMembershipFee\": \"\",\n \"cardActivationFee\": \"\",\n \"personToPersonTransferFee\": \"\",\n \"cardApplicationFee\": \"\",\n \"cardReserveFee\": \"\",\n \"chargeType\": \"\",\n \"cardLoadFlatAmountFee\": \"\",\n \"cardLoadPercentageFee\": \"\",\n \"isActive\": \"\",\n \"cardType\": \"\",\n \"programs\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isActive\": \"\",\n \"assignedFlows\": [\n \"\",\n \"\"\n ],\n \"shippingAddressSource\": \"\",\n \"shippingMethod\": \"\",\n \"physicalCardLimit\": \"\",\n \"virtualCardLimit\": \"\",\n \"instantCardLimit\": \"\",\n \"workflowId\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalance\": \"\",\n \"pendingBalance\": \"\",\n \"availableBalance\": \"\",\n \"cardPlansCount\": \"\",\n \"walletArraysCount\": \"\",\n \"entityId\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"subdomain\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"processorAccountId\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"state\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"schemeBalances\": [\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n },\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n }\n ],\n \"totalWalletBalance\": \"\",\n \"languageId\": \"\",\n \"language\": {\n \"id\": \"\",\n \"languageName\": \"\"\n },\n \"primaryContactFirstName\": \"\",\n \"primaryContactLastName\": \"\",\n \"primaryContactName\": \"\",\n \"primaryContactEmail\": \"\",\n \"primaryContactPhone\": \"\",\n \"redirectUrl\": \"\",\n \"autoKycApproval\": \"\",\n \"kycWaiverEnabled\": \"\",\n \"activeAuthorization\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isActive\": \"\",\n \"assignedFlows\": [\n \"\",\n \"\"\n ],\n \"shippingAddressSource\": \"\",\n \"shippingMethod\": \"\",\n \"physicalCardLimit\": \"\",\n \"virtualCardLimit\": \"\",\n \"instantCardLimit\": \"\",\n \"workflowId\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalance\": \"\",\n \"pendingBalance\": \"\",\n \"availableBalance\": \"\",\n \"cardPlansCount\": \"\",\n \"walletArraysCount\": \"\",\n \"entityId\": \"\",\n \"entity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"businessName\": \"\",\n \"legalId\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"subdomain\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"processorAccountId\": \"\",\n \"countryId\": \"\",\n \"country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alpha3Code\": \"\",\n \"numericCode\": \"\"\n },\n \"state\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"settlementCurrencyCode\": \"\",\n \"settlementCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingCurrencyCode\": \"\",\n \"billingCurrency\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alphaCode\": \"\",\n \"decimalPlaces\": \"\",\n \"isActive\": \"\"\n },\n \"billingContactName\": \"\",\n \"billingContactEmail\": \"\",\n \"billingContactPhone\": \"\",\n \"customColor\": \"\",\n \"isActive\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n },\n \"schemeBalances\": [\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n },\n {\n \"schemeCode\": \"\",\n \"processorAccountId\": \"\",\n \"balance\": {\n \"pendingBalanceAmount\": \"\",\n \"actualBalanceAmount\": \"\",\n \"blockedBalanceAmount\": \"\",\n \"balanceCurrency\": \"\",\n \"availableBalanceAmount\": \"\"\n }\n }\n ],\n \"totalWalletBalance\": \"\",\n \"languageId\": \"\",\n \"language\": {\n \"id\": \"\",\n \"languageName\": \"\"\n },\n \"primaryContactFirstName\": \"\",\n \"primaryContactLastName\": \"\",\n \"primaryContactName\": \"\",\n \"primaryContactEmail\": \"\",\n \"primaryContactPhone\": \"\",\n \"redirectUrl\": \"\",\n \"autoKycApproval\": \"\",\n \"kycWaiverEnabled\": \"\",\n \"activeAuthorization\": \"\"\n }\n }\n ]\n }\n}"}],"_postman_id":"126251dc-f5bd-4e40-9bdb-f5532a7c6b5c"}],"id":"7ec3dade-63b0-40b4-acb5-7b22f7dd204c","description":"

Retrieves the pre-registration details of a specific customer based on their clientId.

\n","_postman_id":"7ec3dade-63b0-40b4-acb5-7b22f7dd204c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Manual verification","item":[{"name":"Customer Preregistration (manual)","id":"a916eb09-9fd0-4030-ae5f-e51a53f70a11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"programId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"secondLastName\": \"string\",\n \"userName\": \"string\",\n \"suxfix\": \"string\",\n \"email\": \"string\",\n \"alternateEmail\": \"string\",\n \"dateOfBirth\": \"2025-10-09T20:20:25.117Z\",\n \"gender\": 0,\n \"nationality\": \"string\",\n \"address1\": \"string\",\n \"address2\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"countryId\": \"string\",\n \"phoneFormatted\": {\n \"area\": \"string\",\n \"number\": \"string\"\n },\n \"phoneHomeFormatted\": {\n \"area\": \"string\",\n \"number\": \"string\"\n },\n \"externalReference\": \"string\",\n \"occupation\": \"string\",\n \"instantIssueAccountCard\": false,\n \"automaticallyApplyForCard\": false,\n \"cardPlanId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"cardholderName\": \"string\",\n \"assignWallet\": false,\n \"walletArrayId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"userEmail\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration","description":"

Purpose

\n

This endpoint is used to pre-register a customer in the system. It collects detailed personal, contact, and identification information required for onboarding and compliance (such as KYC/AML). The endpoint supports uploading identification and proof of address documents as part of the registration process.

\n

Request Body Structure

\n

The request body must be a JSON object with the following fields:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequired?Description
entityIduuidNoEntity identifier.
programIduuidNoProgram identifier.
titlestringYesCustomer’s title (e.g., Mr, Ms, Dr).
firstNamestringYesCustomer’s first name.
middleNamestringoptionalCustomer’s middle name.
lastNamestringYesCustomer’s last name.
secondLastNamestringoptionalCustomer’s second last name.
userNamestringoptionalDesired username.
suxfixstringoptionalName suffix (e.g., Jr, Sr). (posible typo: “suffix”)
emailstringYesPrimary email address.
alternateEmailstringoptionalSecondary email address.
dateOfBirthdateTimeYesDate of birth (ISO 8601).
genderintegerYesGender code (system-defined).
nationalitystringoptionalNationality/country code.
address1stringYesPrimary address line.
address2stringoptionalSecondary address line.
postalCodestringoptionalPostal/ZIP code.
citystringYesCity name.
statestringYesState or province.
countryIdstringYesCountry identifier (ISO/internal).
phoneFormattedobjectYesMain phone number.
├── areastringYesArea/country code.
└── numberstringYesPhone number.
phoneHomeFormattedobjectoptionalHome phone (area/number). (No aparece en tus tablas anteriores; confirmar si aplica y si es opcional)
├── areastringYesArea/country code.
└── numberstringyesPhone home number.
externalReferencestringoptionalExternal reference ID.
occupationstringNoCustomer’s occupation.
instantIssueAccountCardbooleanNoWhether to issue the card instantly.
automaticallyApplyForCardbooleanNoWhether to automatically apply for a card.
cardPlanIduuidNo*Card plan identifier. (Requerido si _automaticallyApplyForCard_ = true)
cardholderNamestringNo*Name to print on card. (Requerido si _automaticallyApplyForCard_ = true)
assignWalletbooleanNoWhether to assign a wallet.
walletArrayIduuidNo*Wallet array identifier. (Requerido si _assignWallet_ = true)
userEmailstringNoRequesting user’s email.
\n

Usage Notes

\n
    \n

  • All required fields must be provided; optional fields can be omitted or set to null/empty.

    \n
    • \n

  • File uploads must be base64-encoded and included in the respective object fields.

    \n
    • \n

  • Ensure that date fields are in ISO 8601 format.

    \n
    • \n

  • The gender field may use integer codes; refer to the API documentation for the correct mapping.

    \n
    • \n

  • The endpoint may perform validation and return errors for missing or invalid data.

    \n
    • \n
\n

Response

\n
    \n

  • On success, the API returns a plain text confirmation or a customer registration reference.

    \n
    • \n

  • On error, the API returns an error message describing the issue.

    \n
    • \n
\n

For more details, refer to the ViaCarte Client API collection.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customerpreregistration"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"e31275de-67c7-4818-b29e-ab3e0cabc512","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"X-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"programId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"secondLastName\": \"string\",\n \"userName\": \"string\",\n \"suxfix\": \"string\",\n \"email\": \"string\",\n \"alternateEmail\": \"string\",\n \"dateOfBirth\": \"2025-10-09T20:20:25.117Z\",\n \"gender\": 0,\n \"nationality\": \"string\",\n \"address1\": \"string\",\n \"address2\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"countryId\": \"string\",\n \"phoneFormatted\": {\n \"area\": \"string\",\n \"number\": \"string\"\n },\n \"phoneHomeFormatted\": {\n \"area\": \"string\",\n \"number\": \"string\"\n },\n \"externalReference\": \"string\",\n \"occupation\": \"string\",\n \"instantIssueAccountCard\": false,\n \"automaticallyApplyForCard\": false,\n \"cardPlanId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"cardholderName\": \"string\",\n \"assignWallet\": false,\n \"walletArrayId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"userEmail\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerPreRegistrationId\": \"\",\n \"launchWorkflowUrl\": \"\"\n}"}],"_postman_id":"a916eb09-9fd0-4030-ae5f-e51a53f70a11"}],"id":"45465cdb-58a4-48ff-a2ed-d30ce930e2d6","_postman_id":"45465cdb-58a4-48ff-a2ed-d30ce930e2d6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}},{"name":"Trulioo verification","item":[{"name":"Customer Preregistration (trulioo)","id":"ced392d3-a4fd-4832-955f-094f67a9d6c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"occupation\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"entityId\": \"uuid\",\n \"programId\": \"uuid\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"nationality\": \"string\",\n \"countryId\": \"string\",\n \"dateOfBirth\": \"string(YYYY-MM-DD)\",\n \"address1\": \"string\",\n \"phoneFormatted\": {\n \"area\": \"string\",\n \"number\": \"string\"\n },\n \"instantIssueAccountCard\": \"true\",\n \"automaticallyApplyForCard\": \"false\",\n \"cardPlanId\": \"uuid\",\n \"cardholderName\": \"string\",\n \"assignWallet\": \"false\",\n \"walletArrayId\": \"uuid\",\n \"userEmail\": \"string\"\n}\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration","description":"

This POST request to the /api/v1/customerpreregistration endpoint is used to pre-register a new customer in the ViaCarte system. It collects essential personal and program-related information required to initiate the customer onboarding process.

\n

Purpose:
Initiates customer pre-registration by submitting user details, contact information, and program associations. This is typically the first step before full registration or KYC verification.

\n

Main JSON Body Fields:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequired?Description
emailstringYesCustomer’s email address.
occupationstringYesCustomer’s occupation or profession.
statestringYesState or province of residence.
citystringYesCity of residence.
entityIduuidYesIdentifier for the associated entity.
programIduuidYesIdentifier for the associated program.
firstNamestringYesCustomer’s first name.
lastNamestringYesCustomer’s last name.
nationalitystringYesCustomer’s nationality (e.g., “NI”).
countryIdstringYesCountry identifier or ISO code.
dateOfBirthstringYesDate of birth in YYYY-MM-DD format.
address1stringYesPrimary address line.
phoneFormattedobjectYesObject containing the customer’s phone details.
├── areastringYesCountry or area code (e.g., “+505”).
└── numberstringYesCustomer’s phone number.
instantIssueAccountCardbooleanNoIndicates whether an account card should be issued instantly.
automaticallyApplyForCardbooleanNoIndicates whether the system should automatically apply for a card.
cardPlanIduuidNoIdentifier for the card plan (required if automaticallyApplyForCard = true).
cardholderNamestringNoName to appear on the customer’s card (required if automaticallyApplyForCard = true).
assignWalletbooleanNoIndicates whether a wallet should be assigned to the customer.
walletArrayIduuidNoIdentifier for the associated wallet array (required if assignWallet = true).
userEmailstringNoEmail of the user performing the registration (if different from the customer).
\n

Important Headers:

\n
    \n

  • Content-Type: application/json (required)

    \n
    • \n

  • Accept: text/plain (optional, specifies response format)

    \n
    • \n

  • If the value of automaticallyApplyForCard is true, two additional fields must be displayed: cardholderName and cardPlanId.

    \n
    • \n

  • the value of assignWallet is true, the field walletArrayId must be displayed.

    \n
    • \n
\n

Ensure all required fields are provided and valid. This endpoint does not perform full registration or KYC; it only pre-registers the customer for further processing.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}},"urlObject":{"path":["api","v1","customerpreregistration"],"host":["https://dev.viacarte.com:8440"],"query":[],"variable":[]}},"response":[{"id":"e746a917-af55-4daf-8fea-6d3dd2451f85","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"secondLastName\": \"\",\n \"userName\": \"\",\n \"suxfix\": \"\",\n \"email\": \"\",\n \"alternateEmail\": \"\",\n \"dateOfBirth\": \"\",\n \"gender\": \"\",\n \"nationality\": \"\",\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"buildingNumber\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"countryId\": \"\",\n \"phoneFormatted\": {\n \"area\": \"\",\n \"number\": \"\"\n },\n \"phoneHomeFormatted\": {\n \"area\": \"\",\n \"number\": \"\"\n },\n \"passCode\": \"\",\n \"company\": \"\",\n \"externalReference\": \"\",\n \"file\": {\n \"name\": \"\",\n \"extension\": \"\",\n \"type\": \"\",\n \"data\": \"\"\n },\n \"proofOfAddressFile\": {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"languageId\": \"\",\n \"countryId\": \"\",\n \"issueDate\": \"\",\n \"expiryDate\": \"\",\n \"issueBy\": \"\",\n \"file\": {\n \"name\": \"\",\n \"extension\": \"\",\n \"type\": \"\",\n \"data\": \"\"\n },\n \"verificationType\": \"\",\n \"languageOther\": \"\"\n },\n \"proofOfIdentityFile\": {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"languageId\": \"\",\n \"countryId\": \"\",\n \"issueDate\": \"\",\n \"expiryDate\": \"\",\n \"issueBy\": \"\",\n \"file\": {\n \"name\": \"\",\n \"extension\": \"\",\n \"type\": \"\",\n \"data\": \"\"\n },\n \"verificationType\": \"\",\n \"languageOther\": \"\"\n },\n \"includeKYCVerification\": \"\",\n \"fileKeys\": [\n \"\",\n \"\"\n ],\n \"additionalData\": \"\",\n \"authorized\": \"\",\n \"authorizedBy\": \"\",\n \"cardholderName\": \"\",\n \"instantIssueAccountCard\": \"\",\n \"automaticallyApplyForCard\": \"\",\n \"assignWallet\": \"\",\n \"transactionFrequency\": \"\",\n \"transactionVolume\": \"\",\n \"mainTransactionCountries\": [\n \"\",\n \"\"\n ],\n \"occupation\": \"\",\n \"programId\": \"\",\n \"cardPlanId\": \"\",\n \"walletArrayId\": \"\",\n \"entityId\": \"\",\n \"userEmail\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.viacarte.com:8440/api/v1/customerpreregistration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerPreRegistrationId\": \"\",\n \"launchWorkflowUrl\": \"\"\n}"}],"_postman_id":"ced392d3-a4fd-4832-955f-094f67a9d6c6"}],"id":"172f52d0-ace4-4feb-b4a6-6b124896c695","_postman_id":"172f52d0-ace4-4feb-b4a6-6b124896c695","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"id":"4b517f93-c00f-423f-964b-5a3c173b5006","_postman_id":"4b517f93-c00f-423f-964b-5a3c173b5006","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"d0eae2e7-42cf-4299-893a-08b659298531","id":"d0eae2e7-42cf-4299-893a-08b659298531","name":"ViaCarte Client API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"9d9a445c-ea39-453b-89e9-582d3754f551","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"20731562-2eac-4589-9efd-b92459c1359d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://dev.viacarte.com:8440"},{"key":"version","value":"1"}]}