API Docs collection for Cal Platform services.
\nThis collection documents various backend services and flows exposed by the Cal Platform. Each request includes:
\nHTTP method and URL
\nDescription and usage notes
\nParameters (path, query, headers)
\nExample responses
\nUse the folders to navigate by domain (e.g., Partners, Consumers, Issuing) and open individual requests to see detailed per-endpoint documentation in the Docs tab.
\nAuthentication, environments, and common variables are defined at the collection or environment level; refer to those sections for setup details.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"51227300","collectionId":"bb870320-dda8-4633-af0f-60da7a9f44f9","publishedId":"2sBXqRjcWc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-19T10:22:06.000Z"},"item":[{"name":"Authorization","item":[{"name":"SignIn - B2B","event":[{"listen":"test","script":{"exec":["const jsonResponse = pm.response.json();","pm.globals.set(\"CognitoToken\", jsonResponse.data.idToken);"],"type":"text/javascript","packages":{},"requests":{},"id":"b3d89933-9d99-4442-a30d-4bddc1064529"}}],"id":"e25882b7-e84e-4cd4-85d1-be49937c8073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\" : \"john_doe\",\n \"password\" : \"********\"\n}"},"url":"https://api.stage.cal-platform.com/api/signin","description":"Authenticates a B2B user against AWS Cognito and returns JWT tokens for use in subsequent API calls. Submit credentials in the request body; the response shape depends on the user's MFA status:
\nidToken, accessToken, and refreshTokenqrCodeUrl for the user to scan and complete TOTP setupidToken, accessToken, refreshToken, tokenType, and ExpiresInNo result data returned.
\n","urlObject":{"protocol":"https","path":["api","signin"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"1d7f698a-616e-4827-9955-cf56f4250a56","name":"SignIn","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\" : \"john_doe\",\n \"password\" : \"********\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/api/signin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"message\": \"user signed in successfully \",\n \"data\": {\n \"idToken\": \"idToken\",\n \"accessToken\": \"accessToken\",\n \"refreshToken\": \"refreshToken\"\n }\n}"},{"id":"ef573ed9-3f40-4195-8932-105b3e6339aa","name":"SignIn - MFA Setup Required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\" : \"john_doe\",\n \"password\" : \"********\"\n}"},"url":"https://api.stage.cal-platform.com/api/signin","description":"Authenticates a B2B user against AWS Cognito and returns JWT tokens for use in subsequent API calls. Submit credentials in the request body; the response shape depends on the user's MFA status:\n\n- **Standard sign-in** — returns `idToken`, `accessToken`, and `refreshToken`\n- **MFA setup required** — returns a `qrCodeUrl` for the user to scan and complete TOTP setup\n- **MFA sign-in** — returns `idToken`, `accessToken`, `refreshToken`, `tokenType`, and `ExpiresIn`\n\n### **Parameters**\n\n| Parameter Name | Required/Optional | Type | Description | Example Value |\n| --- | --- | --- | --- | --- |\n| username | Required | String | User's Cognito username — UUID for B2B pools, email address for email-based pools | `00000000-0000-0000-0000-000000000000` |\n| password | Required | String | The user's password | `Password1234` |\n| usertotpcode | Optional | String | TOTP code from authenticator app — required when MFA is enforced for the pool | `123456` |\n\n---\n\n### Response Fields\n\n_No result data returned._"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\\n \"status\": 1,\\n \"message\": \"user signed in successfully\",\\n \"data\": {\\n \"qrCodeUrl\": \"otpauth://totp/cal-platform:username?secret=XXXXXXXXXXXXXXXX&issuer=cal-platform\"\\n }\\n}"},{"id":"04f38c7d-afd8-48ef-9149-5cacdacdeef3","name":"SignIn - MFA","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\" : \"john_doe\",\n \"password\" : \"********\"\n}"},"url":"https://api.stage.cal-platform.com/api/signin","description":"Authenticates a B2B user against AWS Cognito and returns JWT tokens for use in subsequent API calls. Submit credentials in the request body; the response shape depends on the user's MFA status:\n\n- **Standard sign-in** — returns `idToken`, `accessToken`, and `refreshToken`\n- **MFA setup required** — returns a `qrCodeUrl` for the user to scan and complete TOTP setup\n- **MFA sign-in** — returns `idToken`, `accessToken`, `refreshToken`, `tokenType`, and `ExpiresIn`\n\n### **Parameters**\n\n| Parameter Name | Required/Optional | Type | Description | Example Value |\n| --- | --- | --- | --- | --- |\n| username | Required | String | User's Cognito username — UUID for B2B pools, email address for email-based pools | `00000000-0000-0000-0000-000000000000` |\n| password | Required | String | The user's password | `Password1234` |\n| usertotpcode | Optional | String | TOTP code from authenticator app — required when MFA is enforced for the pool | `123456` |\n\n---\n\n### Response Fields\n\n_No result data returned._"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \"status\": 1,\\n \"message\": \"user signed in successfully\",\\n \"data\": {\\n \"idToken\": \"idToken\",\\n \"accessToken\": \"accessToken\",\\n \"refreshToken\": \"refreshToken\",\\n \"tokenType\": \"Bearer\",\\n \"ExpiresIn\": 3600\\n }\\n}"},{"id":"8fe19d61-a6fd-422e-8f18-7d0bb09cf49f","name":"SignIn - MFA","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"john_doe\",\n \"password\": \"********\",\n \"usertotpcode\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/api/signin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{ \n \"status\": 1,\n \"message\": \"user signed in successfully\", \n \"data\": { \n \"idToken\": \"idToken\",\n \"accessToken\": \"accessToken\",\n \"refreshToken\": \"refreshToken\",\n \"tokenType\": \"Bearer\", \n \"ExpiresIn\": 3600 \n } \n}"}],"_postman_id":"e25882b7-e84e-4cd4-85d1-be49937c8073"}],"id":"a761bec2-b1d7-4553-8708-9b729bb3fdfa","_postman_id":"a761bec2-b1d7-4553-8708-9b729bb3fdfa","description":""},{"name":"Card Issuance","item":[{"name":"InitWizardProcedure","event":[{"listen":"test","script":{"id":"48c2fd21-9686-4808-a4f8-53bb8e650410","exec":["const jsonResponse = pm.response.json();","const url = jsonResponse.result.url;","const wizardProcedureRefId = url.split('=')[1];","pm.globals.set(\"WizardProcedureRefId\", wizardProcedureRefId);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"fce8a14a-3362-4863-9920-d018b4bb82c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n\n \"product\": {\n \"refId\": \"string\"\n },\n \"webhookEvents\": [\n {\n \"eventName\": \"cardSuccessfulIssuance\",\n \"serviceName\": \"string\"\n }\n ],\n \"employee\": {\n \"refId\": \"string\",\n \"employeePaymentAccountManagerId\": \"string\"\n },\n \"wizardData\": {\n \"verifyIdentity\": {\n \"data\": {\n \"identifier\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": {}\n },\n \"identifierType\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"id\"\n },\n \"firstName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"lastName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"dateOfBirth\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"2026-05-04T10:39:28.086Z\"\n },\n \"gender\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"male\"\n }\n }\n },\n \"verifyIdentityBeneficiary\": {\n \"data\": {\n \"identifier\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": {}\n },\n \"identifierType\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"id\"\n },\n \"firstName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"lastName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"dateOfBirth\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"2026-05-04T10:39:28.086Z\"\n },\n \"gender\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"male\"\n }\n }\n },\n \"strictVerifyIdentity\": {\n \"data\": {\n \"identifier\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": {}\n },\n \"identifierType\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"id\"\n },\n \"firstName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"lastName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"dateOfBirth\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"2026-05-04T10:39:28.086Z\"\n },\n \"gender\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"male\"\n },\n \"idIssueDate\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"2026-05-04T10:39:28.086Z\"\n }\n }\n },\n \"strictVerifyIdentityBeneficiary\": {\n \"data\": {\n \"identifier\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": {}\n },\n \"identifierType\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"id\"\n },\n \"firstName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"lastName\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"dateOfBirth\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"2026-05-04T10:39:28.086Z\"\n },\n \"gender\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"male\"\n },\n \"idIssueDate\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"2026-05-04T10:39:28.086Z\"\n }\n }\n },\n \"contactDetails\": {\n \"data\": {\n \"email\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"email@domain.com\"\n },\n \"phoneNumber\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"0505000000\"\n }\n }\n },\n \"contactDetailsBeneficiary\": {\n \"data\": {\n \"email\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"email@domain.com\"\n },\n \"phoneNumber\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"0505000000\"\n }\n }\n },\n \"nameOnCard\": {\n \"data\": {\n \"firstNameOnCard\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"lastNameOnCard\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n }\n }\n },\n \"nameOnCardBeneficiary\": {\n \"data\": {\n \"firstNameOnCard\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n },\n \"lastNameOnCard\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"Latin or hebrew name\"\n }\n }\n },\n \"address\": {\n \"data\": {\n \"street\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"string\"\n },\n \"buildingNumber\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": 0\n },\n \"entrance\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"string\"\n },\n \"apartment\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": 0\n },\n \"poBox\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"string\"\n },\n \"city\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"string\"\n },\n \"state\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"string\"\n },\n \"zipCode\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"1234567\"\n },\n \"country\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"string\"\n }\n }\n },\n \"cardDesign\": {\n \"data\": {\n \"catalogNumber\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"string\"\n }\n }\n },\n \"cardPhysicalitySelection\": {\n \"data\": {\n \"cardPhysicality\": {\n \"isReadOnly\": false,\n \"isHiddenOnScreen\": false,\n \"isRequired\": true,\n \"isDisplayOptionalLabel\": false,\n \"isInputVerification\": false,\n \"value\": \"physicalAndVirtual\"\n }\n }\n }\n },\n \"issuingData\": {\n \"contractorCode\": \"string\",\n \"businessPartnerCode\": \"string\",\n \"creditCardBrand\": \"visa\"\n },\n \"termsData\": {\n \"summarize\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"approvals\": [\n \"string\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/issuing-backend/api/InitWizardProcedure","description":"Initiates a card issuance wizard procedure. Returns a URL to the cardholder-facing wizard for completing the issuance flow.
\nSee InitWizardProcedure HybridFlow for the hybrid debit-method variant (requires termsData.approvals).
Each wizardData command field supports these property flags:
Same endpoint as InitWizardProcedure — used for products with debitMethod: hybrid. The flow type is determined by the product's debit method, not by the endpoint itself.
See InitWizardProcedure for the full parameter reference.
\nReturns the current status of a wizard procedure by its ref ID.
\nUpdates the UI metadata of an existing wizard procedure. Use this to customize the look, feel, language, and redirect URLs of the cardholder-facing wizard after it has been initialized.
\nRetrieves issuance data for a completed wizard procedure. Returns the last four digits of the issued card.
\nThe wizard procedure ref ID
\n","type":"text/plain"},"key":"wizardProcedureRefId","value":"00000000-0000-0000-0000-000000000000"}],"variable":[]}},"response":[{"id":"f8235658-85af-4f19-a074-f5f838d75675","name":"GetIssuanceData","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"url":{"raw":"https://api.stage.cal-platform.com/issuing-backend/api/GetIssuanceData?wizardProcedureRefId=3fa85f64-5717-4562-b3fc-2c963f66afa6","protocol":"https","host":["api","stage","cal-platform","com"],"path":["issuing-backend","api","GetIssuanceData"],"query":[{"key":"wizardProcedureRefId","value":"3fa85f64-5717-4562-b3fc-2c963f66afa6","description":"The wizard procedure ref ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {\n \"wizardProcedureRefId\": \"string\"\n }\n}"}],"_postman_id":"9daea8a3-92f9-4ebf-aa62-ba9272b33a4c"},{"name":"EnrichIssuanceDataFromIssuer","id":"d292d120-c1d3-48a3-8e4d-c6c8aaf26752","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"wizardProcedureRefId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/issuing-backend/api/EnrichIssuanceDataFromIssuer","description":"Enriches the issuance data of a wizard procedure by fetching additional cardholder data from the issuer (before-login enrichment). Called to supplement pre-filled wizard data before card issuance is finalized.
\nReturns the standard response envelope with no content — result is null.
Starts a card issuance wizard for the logged-in user (B2C flow). Unlike InitWizardProcedure, the caller does not build the wizard payload: the service loads the product's stored payload template, fills the cardholder identity from the request or the session, applies the issuance quota check, and returns the wizard URL.
\nRequires the InitWizardProcedure scope. The productRefId must be one of the products in the user's session (see partners-backend GetProducts).
Endpoints to initiate and manage the card issuance wizard procedure.
\n","_postman_id":"9f913545-5f21-4118-9c94-0872092534dd"},{"name":"Card Managment","item":[{"name":"CancelCard","id":"2160e2f1-7928-45d4-b4b9-e07afb61cada","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"123456789\",\n \"cardStatusCode\": \"contractDestroyed\",\n \"causeCode\": \"canceledZeroCard\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/ConsumerCards/CancelCard","description":"Cancels a consumer card by setting its security status and dispatching a card-cancellation message downstream.
\nReturns the standard response envelope with no content — result is null.
Retrieves consumer cards for a specific consumer, optionally filtered by product or card status.
\nAll parameters are passed as URL query parameters — this is a GET request, nothing is sent in the body. You must provide either cardIssuerInternalId or the pair clientId + identifierType. Results are always scoped to the products the calling partner is authorized for.
Detaches a credit card from its current payment account pairing.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-backend","api","ConsumerCards","DetachedCardPairing"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"ee905ae3-f09d-4080-937b-df1dbb172ee5","name":"DetachedCard","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"cardIssuerInternalId\": \"string\",\r\n \"businessPartnerCode\": \"string\"\r\n}"},"url":"https://api.stage.cal-platform.com/consumers-backend/api/ConsumerCards/DetachedCardPairing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"40eb872d-57f4-4f1f-a1f1-137692774b8f"},{"name":"CardInWallet","id":"733589b3-42d8-4f80-88a9-18b745690c73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"00000000\",\n \"walletProvider\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/ConsumerCards/CardInWallet","description":"Checks whether a card has been provisioned into a digital wallet (Google Pay or Apple Pay).
\nUpdates the isLockedByPaymentAccountManager status of a consumer card.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"url":"https://api.stage.cal-platform.com/consumers-backend/api/ConsumerCards/GetConsumerByIdentifierAndIdentifierType?identifier=123456789&identifierType=id","description":"Retrieves consumer card information by identifier and identifier type. Used to look up a consumer's cards when the card reference ID is not known — typically called during authorization flows.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"string\",\n \"paymentAccountManager\": \"platform\",\n \"businessPartnerCode\": \"string\",\n \"paymentAccountManagerCode\": \"string\",\n \"brand\": \"visa\",\n \"physicality\": \"physicalAndVirtual\",\n \"issuer\": \"cal\",\n \"debitMethod\": \"paymentAccount\",\n \"consumerPaymentAccountManagerId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/ConsumerCards/UpdateConsumerPaymentAccountManager","description":"Updates or assigns a payment account manager to a consumer card. Used to associate a card with a specific payment platform after issuance.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"url":"https://api.stage.cal-platform.com/consumers-backend/api/CardAllocations/GetAllocationsAndBalance","description":"Retrieves all budget allocations and current balance for a card.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"url":"https://api.stage.cal-platform.com/consumers-backend/api/CardAllocations/GetMonthlyAllocationsTotal?budgetCategoryType=grocery&cardRefId=card-ref-id-123","description":"Returns the total amount allocated to a card within the current month for a specific budget category.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"cardRefId\": \"string\",\n \"cardIssuerInternalId\": \"string\",\n \"budgetCategoryType\": \"string\",\n \"allocation\": {\n \"actionDate\": \"2026-05-04T11:29:31.984Z\",\n \"fromCardLastFourDigits\": \"string\",\n \"amount\": 0,\n \"currency\": \"string\",\n \"description\": \"string\",\n \"initiator\": \"string\",\n \"currencySymbol\": \"string\",\n \"issuerTransactionInternalId\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/CardAllocations/CreatePendingAllocationToCard","description":"Creates a pending budget allocation for a specific card.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"identifier\": \"string\",\n \"identifierType\": \"id\",\n \"cardRefId\": \"string\",\n \"cardIssuerInternalId\": \"string\",\n \"allocationRefId\": \"string\",\n \"budgetCategoryType\": \"string\",\n \"allocationStatus\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/CardAllocations/UpdateAllocationStatusAndBalance","description":"Updates the status of an existing allocation and recalculates the card balance.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"url":"https://api.stage.cal-platform.com/consumers-card-management/api/Beneficiary/Get?cardIssuerInternalId=88588228&nameFieldsEncoding=hex","description":"Retrieves the beneficiary linked to a card, identified by the card issuer's internal ID. Name fields can be returned in a specific encoding when the underlying data is stored in a non-UTF-8 format.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"88588228\",\n \"beneficiary\": {\n \"identifier\": \"300000000\",\n \"identifierType\": \"id\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"1988-06-22T00:00:00.000Z\",\n \"gender\": \"male\",\n \"phoneNumber\": \"0505000000\",\n \"email\": \"john.doe@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-card-management/api/Beneficiary/Create","description":"Adds a beneficiary to an existing card. If the card already has a beneficiary, the operation will not overwrite it — a card can hold only one beneficiary at a time.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"88588228\",\n \"beneficiary\": {\n \"identifier\": \"300000000\",\n \"identifierType\": \"id\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"0505000000\",\n \"email\": \"john.doe@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-card-management/api/Beneficiary/Update","description":"Updates the details of an existing beneficiary on a card. The card must already have a beneficiary set. Only identifier and identifierType are required — all other beneficiary fields are optional and only updated when provided.
Request body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"88588228\",\n \"identifier\": \"300000000\",\n \"identifierType\": \"id\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-card-management/api/Beneficiary/Remove","description":"Removes the beneficiary from a card. The card must already have a beneficiary set. Optionally, identifier and identifierType can be provided to target a specific beneficiary — both must be supplied together if used.
Endpoints related to managing beneficiaries linked to a card.
\n","_postman_id":"8159b4da-b518-4905-ad1e-82c35d372839"},{"name":"Budget Management","item":[{"name":"GetAllocationBalance","id":"af6f83e8-2a65-4b1d-925c-b1747cf0b800","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Request body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"url":"https://api.stage.cal-platform.com/consumers-card-management/api/BudgetAllocations/GetAllocationBalance?cardIssuerInternalId=73377346&budgetCategoryType=*","description":"Retrieves the current allocation balance for a card. An optional budget category type can be specified to filter to a specific allocation bucket.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\r\n \"cardIssuerInternalId\": \"string\",\r\n \"budgetCategoryType\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-card-management/api/BudgetAllocations/ClearAllocationBalance","description":"Clears (zeroes out) the allocation balance for a card. Returns the amount that was subtracted and its currency.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"string\",\n \"budgetCategoryType\": \"string\",\n \"amount\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-card-management/api/BudgetAllocations/AddToAllocation","description":"Adds a specified amount to a card's allocation balance. The amount must be non-zero.
Request body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"string\",\n \"budgetCategoryType\": \"string\",\n \"aggregateTargetCurrency\": 0,\n \"filterCurrency\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-card-management/api/BudgetAllocations/GetAllocationsBalances","description":"Retrieves all allocation balances for a given card. Unlike GetAllocationBalance which returns a single balance, this endpoint returns an array of balances and supports aggregating the total into a target currency.
Endpoints related to managing budget allocations for the cards.
\n","_postman_id":"01e12012-d4b6-4a76-8906-e81f2c3604f7"},{"name":"Webhook","item":[{"name":"HMAC Signature","id":"43c70a82-8475-434e-9290-c926fdb95ed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-hmac-signature","value":"0fd7d9984c28d3e61683171f5a1766df34350124fcc4a1047f9b60bd52cb402b","description":"A Base16-encoded HMAC-SHA256 hash of the raw response body, generated using a shared secret key for verifying data integrity. The key is securely provided by the server and must remain confidential.
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"HMAC Signature","description":"THIS IS NOT REQUEST IS JUST A DOC TO USE
\nThe x-hmac-signature header is designed as a lightweight alternative to OAuth 2.0 authentication for verifying the integrity of responses when registering and handling webhooks. Instead of requiring token-based authentication, this approach leverages a shared secret key to generate a Base16-encoded HMAC-SHA256 hash of the raw response body. The header ensures that the webhook payload has not been altered during transmission, providing a simple yet secure mechanism for validating data integrity without the overhead of full OAuth 2.0 authentication flows.
This webhook is triggered when a card is successfully issued. It is the endpoint model a partner must publish and register in order to receive this event.
\nThis webhook is triggered when a card approval or decline event occurs, providing detailed information about the approval status, transaction details, and associated allocations. It enables seamless communication between systems to update or finalize approval-related processes in real-time.
\nThis webhook is triggered when a card authorization request being made at the POS for a transaction. It provides details about the transaction, merchant, and additional metadata.
\n0001 (Authorization)0002 (Reversal / Cancellation)The 0002 request has a different structure from 0001: it carries no merchant object and no cardNetwork field, its timestamp is ISO 8601 (yyyy-MM-ddTHH:mm:ss±hh:mm) rather than yyyyMMddHHmmss, and its numeric fields are sent as numbers.
Applies to both _0001_ and _0002_ request types — the response schema is identical.
This webhook notifies the partner about a card replacement (swap) event, providing details of both the old (replaced) card and the new card, plus the cardholder's name. The old card is terminated and a new card is issued in its place.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8f2b42d9-a807-42bf-b999-4e775fe7b99f"},{"name":"NotifyUpdateCardStatus","id":"5b7175d0-d22b-458c-bfc5-27bcc410dc48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"card\": {\n \"cardIssuerInternalId\": \"00000000\",\n \"lastFourDigits\": \"0000\",\n \"status\": \"active\"\n },\n \"consumer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This webhook notifies the partner about a status change for a specific card. It includes the card's internal issuer identifier, its last four digits, the updated status, and the cardholder's name — allowing the partner to update their records and act on the card's new status.
\nactive — the card is active and usable.
unactivated — applies to physical cards pending embossing before being shipped to the customer.
suspended — the card is temporarily suspended (e.g. lost, damaged, or stolen); an intermediate status before permanent cancellation.
canceled — the card is canceled and can no longer be used.
This document provides a detailed specification for the External Account Manager batch file.
\nThe file contains transactions that have been approved by the external account manager (TPA – third party approval) and subsequently processed by Cal (ICC).
\nThe file includes three record types:
\nHeader
\nContent
\nSummary
\nReturns the expenses for a given card, filtered by budget category type.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"companyCode\": \"string\",\n \"amount\": 0,\n \"tranAmountBilling\": 0,\n \"transactionStatus\": \"string\",\n \"channelType\": \"string\",\n \"mcc\": \"string\",\n \"tpaBusinessPartnerCode\": \"string\",\n \"merchantName\": \"string\",\n \"trnId\": \"string\",\n \"tpaApprovalAmount\": \"string\",\n \"finalAnswerCode\": \"string\",\n \"customerId\": \"string\",\n \"j5Ind\": \"string\",\n \"currencyCode\": \"string\",\n \"cardAcceptIdent\": \"string\",\n \"cardNumber\": \"string\",\n \"cardInternalId\": \"string\",\n \"timestamp\": \"string\",\n \"terminal\": \"string\",\n \"acquirerCode\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/Transactions/AddTransaction","description":"Records a new card transaction in the system. Called by the card issuer to notify the platform of a new authorization or settlement event. All fields are optional and map to issuer-specific transaction data.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-backend","api","Transactions","AddTransaction"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"782610af-0ada-46c3-99b0-961e9902aad6","name":"AddTransaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Request body format"},{"key":"Accept","value":"application/json","description":"Expected response format"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token"}],"body":{"mode":"raw","raw":"{\n \"companyCode\": \"string\",\n \"amount\": 0,\n \"tranAmountBilling\": 0,\n \"transactionStatus\": \"string\",\n \"channelType\": \"string\",\n \"mcc\": \"string\",\n \"tpaBusinessPartnerCode\": \"string\",\n \"merchantName\": \"string\",\n \"trnId\": \"string\",\n \"tpaApprovalAmount\": \"string\",\n \"finalAnswerCode\": \"string\",\n \"customerId\": \"string\",\n \"j5Ind\": \"string\",\n \"currencyCode\": \"string\",\n \"cardAcceptIdent\": \"string\",\n \"cardNumber\": \"string\",\n \"cardInternalId\": \"string\",\n \"timestamp\": \"string\",\n \"terminal\": \"string\",\n \"acquirerCode\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/Transactions/AddTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"052c2b65-ba62-4ca5-88e4-90d549454c93"}],"id":"f658b126-93ce-4543-8e58-02c9f968f5f3","_postman_id":"f658b126-93ce-4543-8e58-02c9f968f5f3","description":""},{"name":"Payments","item":[{"name":"1. InitZCreditPaymentPage","event":[{"listen":"test","script":{"exec":["const jsonData = JSON.parse(pm.request.body);","const arrayOfObject = jsonData.data;","const userId = arrayOfObject.find(obj => {"," return obj.key === \"userId\"","});","const receiverPhoneNumber = arrayOfObject.find(obj => {"," return obj.key === \"receiverPhoneNumber\"","});","let totalAmount = 0;","jsonData.cartItems.forEach(cartItem => {"," totalAmount = totalAmount + parseInt(cartItem.amount);","})","pm.globals.set(\"MelisronUserId\", userId.value);","pm.globals.set(\"MelisronReceiverPhoneNumber\", receiverPhoneNumber.value);","pm.globals.set(\"MelisronTotalAmount\", totalAmount);","var template = `","","","| Field Name | ","Type | ","Description | ","Example | ","
|---|---|---|---|
| New Balance | ","Number | ","Current balance after payment | ","{{response.result.newBalance}} | ","
| Currency | ","String | ","Currency type | ","{{response.result.currency}} | ","
| Status Description | ","String | ","Description of status | ","{{response.statusDescription}} | ","
| Status Code | ","Number | ","Status code | ","{{response.statusCode}} | ","
| Session ID | ","String | ","Unique session identifier | ","{{response.sessionId}} | ","
| HTTP Status | ","Number | ","HTTP status code | ","{{response.httpStatus}} | ","
Initializes a Z-Credit payment page session and returns a URL to redirect the customer to complete payment.
\nRequest body format
\n"},{"key":"Accept","value":"application/json","description":"Expected response format
\n"},{"key":"Authorization","value":"{{CognitoToken}}","description":"JWT access token
\n"}],"body":{"mode":"raw","raw":"{\n \"remoteFolderPath\": \"string\",\n \"remoteFileName\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-backend/api/Payments/ExecuteBulkPayments","description":"Processes a bulk payment file from remote storage. Reads the file and executes J5 and money charge transactions for each entry in sequence.
\nRefunds a previously processed transaction.
\nSwaps a consumer credit card with a substitute card, updating the card assignment and associated metadata.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-issuer-services","api","ConsumerCards","SwapCard"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"551e9aee-70f4-4d72-b2ba-57c954040503","name":"SwapCard","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"string\",\n \"customerId\": \"string\",\n \"cardId\": \"string\",\n \"substituteCardId\": \"string\",\n \"substituteCardPan\": \"string\",\n \"blocked\": true,\n \"cardStatus\": \"string\",\n \"statusTimestamp\": \"string\",\n \"cardType\": \"string\",\n \"isVirtual\": true,\n \"linkedToWallet\": true,\n \"cardProduct\": \"string\",\n \"cardHolderName\": \"string\",\n \"cardHolderNameHebrew\": \"string\",\n \"last4\": \"string\",\n \"substituteCardLast4\": \"string\",\n \"expiration\": \"string\",\n \"partialAuth\": true,\n \"businessPartnerCode\": \"string\",\n \"employeeId\": \"string\",\n \"actionCode\": 0,\n \"isGov\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/ConsumerCards/SwapCard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"cf3d8fe2-9f64-40fb-a894-29519d301283"},{"name":"UpdateCardStatus","id":"4591cbbb-7c69-4b47-bffa-93632140238c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"string\",\n \"blocked\": true,\n \"cardStatus\": \"string\",\n \"actionCode\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/ConsumerCards/UpdateCardStatus","description":"Updates the blocked flag and status of a consumer card.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-issuer-services","api","ConsumerCards","UpdateCardStatus"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"7afba830-344e-4941-964c-04eb1e7f80b7","name":"UpdateCardStatus","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardId\": \"string\",\n \"blocked\": true,\n \"cardStatus\": \"string\",\n \"actionCode\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/ConsumerCards/UpdateCardStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"4591cbbb-7c69-4b47-bffa-93632140238c"},{"name":"AddApproval","id":"769c5980-7e3c-4e0d-ac26-56dcee70a4c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"companyCode\": \"string\",\n \"amount\": 0,\n \"tranAmountBilling\": 0,\n \"transactionStatus\": \"string\",\n \"channelType\": \"string\",\n \"mcc\": \"string\",\n \"tpaBusinessPartnerCode\": \"string\",\n \"merchantName\": \"string\",\n \"trnId\": \"string\",\n \"tpaApprovalAmount\": \"string\",\n \"finalAnswerCode\": \"string\",\n \"customerId\": \"string\",\n \"j5Ind\": \"string\",\n \"currencyCode\": \"string\",\n \"cardAcceptIdent\": \"string\",\n \"cardNumber\": \"string\",\n \"cardInternalId\": \"string\",\n \"timestamp\": \"string\",\n \"terminal\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/Approvals/AddApproval","description":"Records a payment approval event for a consumer card transaction.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-issuer-services","api","Approvals","AddApproval"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"cfeb6be3-a410-4320-9f61-c12cc2f33e3a","name":"AddApproval","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"companyCode\": \"string\",\n \"amount\": 0,\n \"tranAmountBilling\": 0,\n \"transactionStatus\": \"string\",\n \"channelType\": \"string\",\n \"mcc\": \"string\",\n \"tpaBusinessPartnerCode\": \"string\",\n \"merchantName\": \"string\",\n \"trnId\": \"string\",\n \"tpaApprovalAmount\": \"string\",\n \"finalAnswerCode\": \"string\",\n \"customerId\": \"string\",\n \"j5Ind\": \"string\",\n \"currencyCode\": \"string\",\n \"cardAcceptIdent\": \"string\",\n \"cardNumber\": \"string\",\n \"cardInternalId\": \"string\",\n \"timestamp\": \"string\",\n \"terminal\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/Approvals/AddApproval"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"769c5980-7e3c-4e0d-ac26-56dcee70a4c2"},{"name":"SendSms","id":"393214db-3eaa-4d35-9d00-a55bc7bda77b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"customerIdentifier\": \"string\",\n \"identifierType\": \"id\",\n \"content\": \"string\",\n \"sender\": \"string\",\n \"phoneNumber\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/Communication/SendSms","description":"Sends an SMS message to a consumer identified by the given identifier type.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-issuer-services","api","Communication","SendSms"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"37441896-a907-432f-b8d1-a6ad4095af79","name":"SendSms","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"customerIdentifier\": \"string\",\n \"identifierType\": \"id\",\n \"content\": \"string\",\n \"sender\": \"string\",\n \"phoneNumber\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/Communication/SendSms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"393214db-3eaa-4d35-9d00-a55bc7bda77b"}],"id":"f6c2e776-9acb-468e-8c87-6b02c36fa899","_postman_id":"f6c2e776-9acb-468e-8c87-6b02c36fa899","description":""},{"name":"Fc Wallet","item":[{"name":"GetAllocationsBalances","id":"36604931-dc72-48c4-acf8-7af4c3b40b7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"string\",\n \"budgetCategoryType\": \"string\",\n \"aggregateTargetCurrency\": 0,\n \"filterCurrency\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-card-management/api/BudgetAllocations/GetAllocationsBalances","description":"Retrieves all allocation balances for a given card, with optional filtering by currency and aggregation into a target currency.
\nCreates a new consumer card with the specified cardholder information, product type, and payment account manager details.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-issuer-services","api","ConsumerCards","CreateCard"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"03e1507c-7ab8-4e74-84c1-de529c0597a1","name":"CreateCard","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"customerExternalId\": \"string\",\n \"email\": \"string\",\n \"cellularAreaCode\": \"string\",\n \"cellularNumber\": \"string\",\n \"cardFullNumber\": \"string\",\n \"customerId\": \"string\",\n \"cardId\": \"string\",\n \"cardHolderName\": \"string\",\n \"cardHolderNameHebrew\": \"string\",\n \"last4\": \"string\",\n \"expiration\": \"string\",\n \"cardNetwork\": \"1\",\n \"cardProduct\": \"string\",\n \"businessPartnerCode\": \"string\",\n \"paymentAccountManagerCode\": \"string\",\n \"partialAuth\": true,\n \"custodiaUserId\": \"string\",\n \"isGov\": true,\n \"paymentAccountManagerEnvironment\": \"string\",\n \"isPlatformIssuance\": true,\n \"isVirtual\": true,\n \"paymentAccountManager\": \"string\",\n \"cardStatus\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-issuer-services/api/ConsumerCards/CreateCard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"54b1375e-9707-463f-accf-fc48ad6b0107"},{"name":"CalculateRate","event":[{"listen":"test","script":{"exec":["const jsonResponse = pm.response.json();"],"type":"text/javascript","packages":{},"requests":{},"id":"3bf03001-003e-43dc-8ee3-a8725721d7ae"}}],"id":"24b0763b-bdba-4471-85f9-cd769836361c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"buyCurrency\": 0,\n \"sellCurrency\": 0,\n \"amount\": 0,\n \"fixed\": \"buy\",\n \"cardIssuerInternalId\": \"string\",\n \"businessPartnerCode\": \"string\",\n \"customerRate\": \"Silver\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-foreign-currency/api/ForeignCurrency/CalculateRate","description":"Calculates the exchange rate between two currencies for a given amount, based on the fixed side and optional customer pricing tier.
\nTriggers the charge step of a foreign currency transaction for the specified card issuer.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-foreign-currency","api","ForeignCurrency","Charge"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"deb3f956-9642-41d7-8cfb-e5eb25ff65da","name":"Charge","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-foreign-currency/api/ForeignCurrency/Charge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"aa5f3ad8-f83c-4904-89ff-78573dba92b4"},{"name":"Sale","id":"a0582064-ec4e-4f08-9897-ee2b87aeca26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-foreign-currency/api/ForeignCurrency/Sale","description":"Triggers the sale step of a previously charged foreign currency transaction for the specified card issuer.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["consumers-foreign-currency","api","ForeignCurrency","Sale"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"5a14495c-e946-443c-a638-3a8659deb012","name":"Sale","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardIssuerInternalId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-foreign-currency/api/ForeignCurrency/Sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"a0582064-ec4e-4f08-9897-ee2b87aeca26"},{"name":"VerifyPaymentAccountManager","id":"13e16676-d996-4af9-b33a-78406b8626cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"paymentAccountManager\": \"platform\",\n \"cardIssuerInternalId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/consumers-foreign-currency/api/ForeignCurrency/VerifyPaymentAccountManager","description":"Verifies whether a given payment account manager is configured and active for the specified card issuer.
\nReturns pockets based on filter criteria such as initiative, period type, status, payment device, or user.
\nfilter.userIds is enforced against the caller's own user scope:
userIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 20).Returns pockets for the given list of customer IDs.
\nuserIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 20).Returns pockets associated with the given list of payment device IDs.
\nuserIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 20).Creates a single pocket definition for one or more related parties (users and/or customers), and links it to an initiative, budget and organization.
\nWhen pocket.initiativeId is sent, missing pocket fields are inherited from the initiative and tags are merged with the initiative tags. name, balance, currency, authorizationPriority and tags must therefore either be sent explicitly or be resolvable from the initiative — otherwise the request is rejected.
Related parties whose user is not active are skipped rather than failing the whole call: they are returned in failures, and the request fails only when every related party is skipped. The acting user must be active.
If an approval workflow matches the action, the created pocket is returned with usageControl = pendingApproval and stays locked until it is approved.
Updates one or more pockets. At least one optional field per pocket must be provided.
\nAdds to or subtracts from pocket balances. Every change is recorded in the pocket's balance history (see GetBalanceHistories) together with the optional comment and additionalInfo.
If an approval workflow template for updateBalance matches the action, the balance change is suspended as a pending approval workflow instance and applied only when approved. Pockets whose related users are not active are skipped and reported in failures; the acting user must be active.
amountToAdd and amountToSubtract, or with neither, is rejected.instructions are rejected.BudgetExceedsMaximumAmount, status 2).Deletes one or more pockets by ID.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["payment-account-pockets","api","Pockets","DeletePockets"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"135c7a98-5f11-4911-9bf7-4716a21ee537","name":"DeletePockets","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-organization-id","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"string\"\n ],\n \"budgetInstructions\": [\n {\n \"id\": \"string\",\n \"amountToAdd\": 0,\n \"amountToSubtract\": 0,\n \"field\": \"usedAmount\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-pockets/api/Pockets/DeletePockets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"ccc256c7-a5f8-468b-a99b-9f091387c1af"},{"name":"AttachPocketsToBudget","id":"bc83007d-a3f2-4b78-a1eb-a5530c429234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"pocketIds\": [\n null\n ],\n \"budgetId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-pockets/api/Pockets/AttachPocketsToBudget","description":"Attaches one or more pockets to a budget.
\nExports pocket data to a file. Returns a binary file stream with Content-Disposition and Content-Length headers.
\nThe export runs through the same lookup as GetPockets, so filter.userIds is enforced against the caller's own user scope:
userIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 20).Returns the balance history of one or more pockets: every balance change (manual update, schedule application, settlement, expiry) with who initiated it, the amount, the balance before the change and, for periodic pockets, the period it belongs to.
\nPurpose: Manage virtual accounts (“pockets”) to control balances, spending, and enforce rules defined by policies and initiatives.
\nISO 4217 Currency Codes
\nThe ISO 4217 standard defines three-letter alphabetic and three-digit numeric codes for each currency. These codes are widely used to represent currencies in financial transactions and APIs.
\nReference:
\n• ISO 4217 Currency Codes on Wikipedia
\n","_postman_id":"0199ae17-34cc-4d25-81a9-41049348fd04"},{"name":"PaymentDevices","item":[{"name":"UpdatePaymentDevices","id":"6030a295-134b-42f3-ac47-b3d421b89967","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"paymentDevices\": [\n {\n \"id\": \"string\",\n \"usageControl\": \"lockedByAdmin\",\n \"profileId\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-pockets/api/PaymentDevices/UpdatePaymentDevices","description":"Update payment device metadata and usage control.
\nRetrieve payment devices associated with specific users.
\nuserIds are applied as sent.userIds and the token's own users.InsufficientPermissions (status 20).Retrieve pending pockets associated with specific users.
\nuserIds are applied as sent.userIds and the token's own users.InsufficientPermissions (status 20).Retrieve pocket balance schedules by schedule IDs or pocket IDs.
\nuserIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 20).Create balance schedules for pockets. A schedule grants amount to the pocket every period; each application is recorded in the pocket's balance history (GetBalanceHistories) with periodicAmount, rolloverAmount, periodStart and periodEnd.
The acting user must be active, and pockets whose related users are not active are skipped and reported in failures.
Update existing pocket balance schedules. The renewal terms of a schedule are frozen once created: periodType and periodValue cannot be changed — delete and recreate the schedule instead.
Purpose: Retrieve the pocket balance schedule
\n","_postman_id":"a4399aaa-d808-4b5a-9580-2a73fb5f7d06"}],"id":"716d13dc-0304-49ee-bc16-b93a2170b2ba","_postman_id":"716d13dc-0304-49ee-bc16-b93a2170b2ba","description":""},{"name":"Policies Api","item":[{"name":"mccGroups","item":[{"name":"GetMccGroups","id":"629791b1-724e-4fac-b5ce-4dd3eb79cc72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"pagination\": {\r\n \"id\": \"string\",\r\n \"createdAt\": \"2026-05-03T08:06:54.121Z\",\r\n \"limit\": 0\r\n },\r\n \"filter\": {\r\n \"groupId\": \"string\",\r\n \"freeText\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-policies/api/Mccs/GetMccGroups","description":"Retrieve a paginated list of MCC (Merchant Category Code) groups. MCC groups are named collections of MCC codes used to define merchant-category-based authorization policies.
\nCreate a new MCC (Merchant Category Code) group under the organization. An MCC group is a named collection of 4-digit MCC codes that can be referenced in authorization policies to allow or block entire merchant categories at once.
\nAttach the current organization to an existing MCC group that was created by another organization (e.g., the platform or a partner). This allows sharing MCC group definitions across organizations without duplicating them.
\nUpdate the MCC codes in an existing MCC group. You can add new codes or remove existing ones.
\nRemove specific MCC codes from an existing MCC group. Only the provided values are removed; the group itself remains intact.
\nExport MCC group data to a file. Returns a download URL for the exported file containing all MCC groups and their codes for the organization.
\nRetrieves merchant groups for the organization. A merchant group is a named collection of specific merchant identifiers that can be referenced in authorization policies to allow or block specific merchants.
\nCreate a new merchant group under the organization. A merchant group is a named collection of specific merchant identifiers (e.g., MIDs or merchant names) that can be referenced in authorization policies.
\nUpdate an existing merchant group. You can modify the list of merchant identifiers.
\nRemove specific merchant IDs from an existing Merchant group. Only the provided values are removed; the group itself remains intact.
\nAttach the current organization to an existing merchant group created by another organization. This allows sharing merchant group definitions across organizations.
\nExport merchant group data to a file. Returns a download URL for the exported file containing all merchant groups and their members for the organization.
\nRetrieves POS (Point of Sale) groups for the organization. A POS group is a named collection of specific POS terminal identifiers that can be referenced in authorization policies.
\nCreate a new POS group under the organization. A POS group is a named collection of POS terminal identifiers that can be referenced in authorization policies to allow or restrict spending at specific terminals.
\nUpdate an existing POS group. You can modify the list of POS terminal identifiers.
\nRemove specific POS terminal IDs from an existing POS group. Only the provided values are removed; the group itself remains intact.
\nAttach the current organization to an existing POS group created by another organization. This allows sharing POS group definitions across organizations.
\nExport POS group data to a file. Returns a download URL for the exported file containing all POS groups and their terminal identifiers for the organization.
\nRetrieves authorization policies for the organization. Policies define spending rules — which merchant categories, specific merchants, or POS terminals are allowed or blocked, and what spending limits apply.
\nuserIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 5).Creates or updates one or more authorization policies. Each policy defines a set of spending rules including allowed/blocked MCC groups, merchant groups, POS groups, and spending limits. Provide a refId to update an existing policy; omit it to create a new one.
Deletes one or more policies by their IDs.
\nRetrieves the policy assigned at the partner level. The partner policy applies as a base set of spending rules that all organizations under the partner inherit unless overridden by organization-level policies.
\nNo request parameters — the partner is identified from the authorization token context.
\nReturns a paginated list of transactions for a given date range and filter criteria. Supports filtering by clearance status, account type, card status, pocket IDs, payment device IDs, user IDs, merchant name, and free text.
\nNote: includeTotalCount is a top-level field, a sibling of pagination — not part of filter.
userIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 12).Retrieves the ledger (accounting entries) for a pocket or the organization. The ledger contains all credit and debit entries including transactions, balance loads, and adjustments. Supports cursor-based pagination. At least one of transactionIds, pocketIds, issuerPaymentDeviceIds, paymentDeviceIds, customerIds, or the fromDate+toDate pair is required.
userIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 12).GetLedger returns the raw ledger entries as stored, without the presentation-layer enrichment applied by GetTransactions. Fields such as mccName, user, pocketName, customerName and hasReceipt are not part of this response — use GetTransactions when you need them.
Exports transaction data to a downloadable file. Returns a pre-signed URL to download the exported file in the requested format. Supports the same filtering options as GetTransactions.
Exportable fields include everything in GetTransactions items[], including mccName, the user.* identifiers (identifier, externalId, passport, email, phoneNumber, driversLicense), personalCreditLineDebitAmount / personalCreditLineDebitCurrency, hasReceipt, comment, glCode and glName.
filter.userIds is enforced exactly as in GetTransactions:
userIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 12).Simulates a card transaction for testing purposes. Creates a synthetic transaction record that goes through the full authorization and settlement flow without an actual payment network interaction. Use this in non-production environments to test pocket balance changes, policy enforcement, and transaction workflows.
\nSimulates a transaction for reclassification, using an existing transaction as the basis.
\nReclassifies an existing transaction to a different pocket.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["payment-account-transactions","api","Reclassify","ReclassifyTransaction"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"83da1efd-da25-4d7d-b1c6-258d65eba459","name":"ReclassifyTransaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"transactionId\": \"string\",\n \"pocketId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-transactions/api/Reclassify/ReclassifyTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"9142f948-388f-4e20-badf-ab04e76bd246"},{"name":"SettleBlockedTransaction","id":"babcaa56-d310-4d8f-9958-c5446d59f6a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"transactionId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-transactions/api/Transactions/SettleBlockedTransaction","description":"Settles a blocked transaction by triggering debit processing for the specified transaction.
\nRetrieves incomplete transaction data for a given authorization event, used to reconstruct transaction details before clearing.
\nUploads a receipt file and attaches it to a transaction. The fileId is obtained from a prior UploadImageFile call. Only image receipts are accepted; the file is then processed by OCR (see GetReceiptsOcrData).
TransactionReceiptAlreadyExists (status 9); a fileId that was never uploaded returns ReceiptFileNotFoundInStorage (status 10).Downloads the receipt file attached to a transaction. Provide either transactionId or fileId (at least one is required). The receipt is returned as a binary file download, not a JSON body.
\n\n* At least one of
\ntransactionIdorfileIdmust be provided.
userIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 12).Returns the receipt file as a binary attachment (StreamableFile). There is no JSON body.
Body: the raw receipt file bytes (the PDF/JPG/PNG originally uploaded).
\n","urlObject":{"protocol":"https","path":["payment-account-transactions","api","Receipt","GetReceipt"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"77f064f1-729a-b5ed-6cf1-8223c8c90169","name":"GetReceipt","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"transactionId\": \"string\",\n \"fileId\": \"string\",\n \"userIds\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-transactions/api/Receipt/GetReceipt","description":"Downloads the receipt file attached to a transaction. Provide either `transactionId` or `fileId` (at least one is required). The receipt is returned as a binary file download, not a JSON body.\n\n## Request Parameters\n\n| Field Name | Required/Optional | Type | Description | Example |\n|---|---|---|---|---|\n| `transactionId` | Optional\\* | string | ID of the transaction whose receipt to fetch | `8a1f2c3d-4b5e-6f70-8190-a1b2c3d4e5f6` |\n| `fileId` | Optional\\* | string | ID of the specific receipt file to fetch | `f3b9c2e1-7a4d-4e2b-9c1a-2d6f8b0e5a31` |\n| `userIds` | Optional | string[] | Restrict the lookup to these user IDs. Subject to caller scope — see User Scoping below | `[\"usr-001\"]` |\n\n> \\* At least one of `transactionId` or `fileId` must be provided.\n\n---\n\n### User Scoping\n\n- Unscoped caller (admin / B2B token): the requested `userIds` are applied as sent; omit them and no user filter is applied.\n- User-scoped caller (B2C token): the lookup is limited to the **intersection** of the requested `userIds` and the token's own users; omit them and the token's own users are used.\n- If the intersection is empty, the request is rejected with `InsufficientPermissions` (status `12`).\n\n---\n\n### Response\n\nReturns the receipt file as a **binary attachment** (`StreamableFile`). There is no JSON body.\n\n| Header | Type | Description | Example |\n|---|---|---|---|\n| `Content-Disposition` | string | Marks the response as a file download and carries the file name | `attachment; filename=\"grocery-receipt.pdf\"` |\n| `Content-Type` | string | MIME type of the streamed file (defaults to octet-stream) | `application/octet-stream` |\n\n**Body:** the raw receipt file bytes (the PDF/JPG/PNG originally uploaded)."},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Disposition","value":"attachment; filename=\"grocery-receipt.pdf\""},{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"[binary file content — the receipt file is returned as a download attachment, not text]"}],"_postman_id":"ee8be1ce-266b-e89d-b1ad-0eb171399fe4"},{"name":"DeleteReceipt","id":"50e5ae5d-f26d-78d0-6542-01345aecaceb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"transactionId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-transactions/api/Receipt/DeleteReceipt","description":"Deletes the receipt attached to a transaction — removes the file from storage and the receipt record. Returns an error if no receipt exists for the transaction.
\nUploads an image file (multipart/form-data) and returns a fileId used to attach the file to a transaction via UploadReceipt. Only image types are accepted, up to 60 MB.
Constraints
\ntiff, jpg, jpeg, png, heic, dng, webp (heic is stored as jpeg, dng as tiff). Other types are rejected with NotValidFileType (statusCode 7).Updates one or more receipts with their corresponding receipt numbers and company registration numbers.
\nPOST /payment-account-transactions/api/Receipt/UpdateReceipt
Content-Type: application/json
{\n \"items\": [\n {\n \"id\": \"string\",\n \"receiptNumber\": \"string\",\n \"companyRegistrationNumber\": \"string\"\n }\n ]\n}\n\nRetrieves OCR (Optical Character Recognition) data for one or more receipts associated with a specific transaction.
\n{\n \"transactionId\": \"string\",\n \"userIds\": [\n \"string\"\n ]\n}\nuserIds are applied as sent; omit them and no user filter is applied.userIds and the token's own users; omit them and the token's own users are used.InsufficientPermissions (status 12).Sets or clears the free-text comment on one or more transactions (ledger rows). Send null to clear an existing comment.
The update runs through the user-scoped core client:
\nTransactionNotFound (status 2).transactions — the updated ledger rows, in the same shape as GetLedger's transactions[]. Commonly used fields:
\n\n","urlObject":{"protocol":"https","path":["payment-account-transactions","api","Transactions","UpdateTransactionComment"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8bb461c-66a2-d9a0-7f08-0f76a679eca0"},{"name":"GetGLCodes","id":"7cea7225-b8ca-0cf1-212a-c02ee74941d5","request":{"method":"POST","header":[{"value":"application/json","key":"Content-Type"},{"value":"application/json","key":"Accept"},{"value":"{{CognitoToken}}","key":"Authorization"},{"value":"{{OrganizationId}}","key":"X-Organization-Id"}],"body":{"mode":"raw","raw":"{\n \"pagination\": {\n \"id\": \"string\",\n \"createdAt\": \"2026-09-01T00:00:00.000Z\",\n \"limit\": 50\n },\n \"includeTotalCount\": true,\n \"filter\": {\n \"glCodeIds\": [\"string\"],\n \"codes\": [\"4000\"],\n \"names\": [\"Travel\"],\n \"statuses\": [\"active\"],\n \"freeText\": \"trav\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-transactions/api/GLCodes/GetGLCodes","description":"See
\nGetLedgerfor the full ledger field list. The updatedcommentis also returned byGetTransactionsasitems[].comment.
Returns the organization's GL (general ledger) codes, paginated. Each GL code carries a code, a display name and a status. Merchant values (POS ids, merchant ids, MCCs) attached to a code are read separately with GetGLMerchantRelations; entity attachments (initiatives, organization) with GetGLEntityRelations.
\nX-Organization-Id organization.Creates one or more GL codes for the organization and attaches merchant values to each. A merchant value (POS id, merchant id or MCC) is what maps a transaction to a GL code: when a ledger transaction settles, its glCode / glName are resolved from the first attached value found, in the order POS → merchantId → MCC.
code may not appear twice in one request, and may not already exist as an active GL code in the organization.Updates one or more GL codes: rename, change the code, and add or remove merchant values as a delta. Only the fields sent are changed.
\ncode, name, valuesToAdd or valuesToRemove is rejected (nothing to update).valuesToAdd and valuesToRemove of one item.Returns the entity attachments of GL codes: which GL code is the default for an initiative, or for the whole organization. An entity relation is used when a transaction has no merchant-value match (POS / merchantId / MCC) — the transaction's initiative relation applies first, then the organization-level relation.
\nSets the default GL code of an initiative, or of the organization. One entity holds at most one relation: sending a relation for an entity that already has one replaces it. The same GL code may be attached to several entities in one request.
\nrelatedEntityId may equal the X-Organization-Id only when relatedEntityType is organization; an organization relation must name the caller's own organization.Removes the default GL code from the given entities (initiatives, or the organization itself). Transactions on those entities fall back to merchant-value matching only.
\nEmpty result on success (statusCode: 1). Entities without a relation are ignored.
Returns the merchant values attached to GL codes: one row per (GL code, type, value). Use it to see which POS ids, merchant ids and MCCs map to a GL code, or to find which GL code a given value belongs to. Values are written through CreateGLCodes / UpdateGLCodes (valuesToAdd / valuesToRemove).
Assigns a GL code to specific ledger transactions, overriding the value resolved automatically from merchant values or entity relations. The transaction's glCode and glName are set from the GL code.
This is the user-scoped variant: the caller may only update transactions of pockets they are related to (B2C token scope). Administrators use UpdateTransactionGLByAdmin.
\nInsufficientPermissions (status 12).GLCodeNotFound, status 18).Administrator variant of UpdateTransactionGL: assigns a GL code to any ledger transaction of the organization, without user-scope restriction. Requires the UpdateTransactionGLByAdmin scope.
Retrieves initiatives for the organization. An initiative is a named spending program that groups multiple pockets under a common purpose (e.g., \"Meal Allowance Q1 2024\"). Supports pagination and filtering by initiative ref IDs.
\nCreates one or more new initiatives. Each initiative defines a spending program with a name, description, and associated pockets or policies.
\nUpdates one or more existing initiatives. Only the fields sent are changed. Pockets created from the initiative inherit its values at creation time and are not updated retroactively.
\nForbiddenAction (status 4). An unknown initiative returns NotFound (status 3).Retrieves spend accounts. Spend accounts hold the actual funds used for card transactions.
\nUpdates one or more existing spend accounts. You can modify the account name and configuration settings.
\nCreates one or more new spend accounts for the organization. Each spend account requires a name and currency configuration.
\nDeletes one or more spend accounts for the authenticated organization.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["payment-account-onboarding","api","SpendAccounts","DeleteSpendAccounts"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"5b8ae921-ce90-4991-8462-3fb040c91406","name":"DeleteSpendAccounts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n null\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-onboarding/api/SpendAccounts/DeleteSpendAccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"cba5a1f2-0f02-4f6b-88cb-c36324f04873"}],"id":"c6526623-10fb-47fc-b90a-b1f55098b9a6","_postman_id":"c6526623-10fb-47fc-b90a-b1f55098b9a6","description":""},{"name":"CreditLines","item":[{"name":"GetCreditLine","id":"8f857548-0994-4bfc-8c93-e496e7ef29f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"url":"https://api.stage.cal-platform.com/payment-account-onboarding/api/CreditLines/GetCreditLine","description":"Retrieves a specific credit line by its reference ID. A credit line defines the credit facility configuration for an organization, including the credit limit and repayment terms.
\nRetrieves credit lines. A credit line defines the credit limit and terms extended to an organization or cardholder.
\nCreates a new credit line for the organization. Defines the credit facility parameters including the credit limit, currency, repayment schedule, and associated spend account.
\nUpdates an existing credit line. You can modify the credit limit and repayment configuration.
\nRetrieves budgets for the organization. A budget is a named allocation of funds within a spend account, used to track spending against a defined limit over a period.
\nCreates one or more new budgets for the organization. Each budget requires a name, amount, currency, and period configuration.
\nUpdates one or more existing budgets. You can change the budget name, amount, and period configuration.
\nDeletes one or more budgets for the authenticated organization.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["payment-account-onboarding","api","Budgets","DeleteBudgets"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"90140a08-e68f-4f23-9a51-9f402aeb7d83","name":"DeleteBudgets","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n null\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-onboarding/api/Budgets/DeleteBudgets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"6780704f-dfe7-4801-8883-033e4966e934"}],"id":"c6d69b2c-d355-42df-a34d-a4a0a98fbcf2","_postman_id":"c6d69b2c-d355-42df-a34d-a4a0a98fbcf2","description":""},{"name":"Organizations","item":[{"name":"GetOrganizations","id":"bb633b61-89d5-4f43-a28b-3b0d48fde2e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"issuerOrganizationIds\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/payment-account-onboarding/api/Organizations/GetOrganizations","description":"Retrieves organizations. An organization represents a company or entity that manages cardholders and spend accounts.
\nReturns the organization's payment-account users (the mirror of partners users kept in the payment account domain), optionally with their payment devices. Use it to resolve user IDs referenced by pockets, related parties and approval workflows.
\nX-Organization-Id organization and to the caller's user scope for B2C tokens.ForbiddenAction (status 4).Returns the organization's approval workflow templates. A template decides when an action needs approval (its conditions) and who approves it, phase by phase (its approvers). Templates are evaluated automatically by the pockets service when a pocket is created or its balance is updated.
Requires the ManageApprovalWorkflowTemplates or DecideApprovalWorkflowPhase scope.
Creates approval workflow templates. When a pocket is created or its balance updated, the pockets service evaluates the organization's templates for that actionType; if every condition of a template holds, the action is suspended as a pending approval workflow instance and released only after each approval phase is approved (see Approve / Decline).
Requires the ManageApprovalWorkflowTemplates scope.
Updates approval workflow templates. Only the fields sent are changed; conditions and approvers, when sent, replace the existing lists in full. actionType cannot be changed.
Requires the ManageApprovalWorkflowTemplates scope.
RequiredEntityNotFound (status 3).Soft-deletes approval workflow templates. Deleted templates are no longer evaluated for new actions; instances already pending are not affected.
\nRequires the ManageApprovalWorkflowTemplates scope.
Empty result on success (statusCode: 1). An unknown ID returns RequiredEntityNotFound (status 3).
Returns the pending approval workflow instances whose current phase the calling user is allowed to decide (by role, unit, segment, explicit user ID, or unit / segment ownership). This is the approver's inbox.
\nRequires the DecideApprovalWorkflowPhase scope. The caller must be an active user; a suspended, locked or terminated user gets ActingUserNotActive (status 9).
No body fields. Send an empty JSON object.
\nReturns the approval workflow instances created by the calling user — the requester's view of their own pending, approved, declined and canceled requests.
\nNo body fields. Send an empty JSON object.
\nApproves the current phase of a pending approval workflow instance. When the last phase is approved the instance becomes approved and the suspended action is executed asynchronously (the pocket is created, or its balance updated).
Requires the DecideApprovalWorkflowPhase scope.
Declines a pending approval workflow instance. The instance becomes declined, the suspended action is discarded, and any budget balance reserved for it is released.
Requires the DecideApprovalWorkflowPhase scope.
Same as Approve: 3 unknown instance, 4 not pending, 5 self-approval not allowed, 6 caller not an approver of the current phase, 9 caller not active.
Withdraws a pending approval workflow instance. Only the user who created the request may cancel it. The instance becomes canceled and the suspended action is discarded.
Getting Started – Setting Up Postman Environment for CAL Stage
\nTo ensure seamless integration with CAL Platform APIs, you’ll need to configure your Postman Environment Variables.
Follow the steps below to set up your environment for the Stage environment.
Open Postman.
\nIn the top-right corner, click the Environment Selector (gear icon).
\nSelect “Manage Environments”.
\nClick “Add” to create a new environment.
\nName the environment: CAL Stage.
\nClick “Add” or “Save” to confirm.
\nWith the CAL Stage environment selected, add the following variables:
\n📝 Tip: After adding all variables, click “Save” in the top-right corner of the environment editor.
\nIn the top-right corner of Postman, click on the Environment Selector dropdown.
\nChoose “CAL Stage”.
\nEnsure this environment is active before sending any requests.
\nRun the SignIn API to generate a valid token.
\nPostman scripts can automatically update the CognitoToken and TokenExpiry variables.
Once set, all requests using {{CognitoToken}} will automatically include authentication headers.
\n\n💡 Tip: All endpoints return these standard error codes when applicable.
\n
API Use Guide
\n💡 Tip:
Use “Get” APIs to fetch data, “Create” to define new records, “Update” to modify existing ones, and “Delete” to remove entries.
Cancels one or more cards belonging to employees under the partner's organizations. A cancelled card cannot be reactivated. Used for bulk card cancellation operations by partner administrators.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["partners-backend","api","Cards","CancelCards"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"903c1fdb-155b-441c-9d91-14196a7ed04a","name":"CancelCards","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardRefIds\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/partners-backend/api/Cards/CancelCards"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"result\": null,\n \"statusDescription\": \"Success\",\n \"statusCode\": 1,\n \"sessionId\": \"sessionId\",\n \"httpStatus\": 200\n}"}],"_postman_id":"bace14f9-bb84-4a40-be88-fd4783635dfb"},{"name":"DetachCards","id":"070150bd-df81-4319-992e-9f7ae9912708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"Proxy-Authorization","value":"{{CognitoToken}}"},{"key":"x-organization-id","value":"{{organizationId}}"}],"body":{"mode":"raw","raw":"{\n \"cardRefIds\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/partners-backend/api/Cards/DetachCards","description":"Detaches one or more cards from their current pairing (e.g., unlinks a card from a mobile wallet or NFC device). The card remains active and usable after detachment — only the device pairing is removed.
\nNo result data returned.
\n","urlObject":{"protocol":"https","path":["partners-backend","api","Cards","DetachCards"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"ccd56f6a-bf55-4c49-acc3-adafc3ac6aed","name":"DetachCards","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"{\n \"cardRefIds\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/partners-backend/api/Cards/DetachCards"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"result\": null,\n \"statusDescription\": \"Success\",\n \"statusCode\": 1,\n \"sessionId\": \"sessionId\",\n \"httpStatus\": 200\n}"}],"_postman_id":"070150bd-df81-4319-992e-9f7ae9912708"}],"id":"3b24a683-9df4-4d8a-8d13-e8d1597d0dc2","_postman_id":"3b24a683-9df4-4d8a-8d13-e8d1597d0dc2","description":""},{"name":"Employers","item":[{"name":"GetEmployer","event":[{"listen":"test","script":{"exec":["const jsonResponse = pm.response.json();",""],"type":"text/javascript","packages":{},"requests":{},"id":"7e0bcf97-77ec-4986-a0b7-6b28a33fd37e"}}],"id":"0fb8b703-afe5-4949-994a-ed87c7d9e7d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/partners-backend/api/Employers/GetEmployer?refId=00000000-0000-0000-0000-000000000000","description":"Retrieves a single employer by its reference ID. Returns full employer details including name, organization association, and configuration settings.
\nRetrieves all employers belonging to a specific partner. Used by system-level or partner admin users to list all employers under a given partner.
\nCreates or updates one or more employers. Provide a refId to update an existing employer; omit it to create a new one. Employers are organizations that issue cards to their employees via the platform.
Retrieves all employers in the system. This is a system-level operation available only to users with the GetAllEmployers scope. Used for platform-wide administration and reporting.
No result data returned.
\n","urlObject":{"protocol":"https","path":["partners-backend","api","Employers","GetAllEmployers"],"host":["api","stage","cal-platform","com"],"query":[],"variable":[]}},"response":[{"id":"9fdfa2b9-1582-4464-afa3-2c44e4ac0c0f","name":"GetAllEmployers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"url":"https://api.stage.cal-platform.com/partners-backend/api/Employers/GetAllEmployers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {}\n}"}],"_postman_id":"9a24740b-edc1-4572-b3ac-fbf14fff832a"}],"id":"617c8eeb-4211-43cf-ad56-456fccd0935c","_postman_id":"617c8eeb-4211-43cf-ad56-456fccd0935c","description":""},{"name":"OrganizationSegments","item":[{"name":"GetOrganizationSegments","id":"041d7770-cfec-457d-9887-1e23ab9e778f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-Organization-Id","value":"{{OrganizationId}}"}],"body":{"mode":"raw","raw":"{\n \"pagination\": {\n \"id\": \"string\",\n \"createdAt\": \"2026-05-04T06:01:26.103Z\",\n \"limit\": 0\n },\n \"refIds\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/partners-backend/api/OrganizationSegments/GetOrganizationSegments","description":"Retrieves organization segments for the current organization. Organization segments are sub-groupings within an organization used to classify users and apply differentiated policies or configurations. Supports pagination and filtering by segment ref IDs.
\nCreates or updates organization segments. Provide a refId to update an existing segment; omit it to create a new one. Segments are used to classify users within an organization for policy and configuration targeting.
Deletes one or more organization segments. Segments that are currently assigned to active users cannot be deleted.
\nCreates or updates organization units. All units in the request must belong to the same employer.
\nRetrieves organization units. You must provide either pagination details or a list of unit IDs. You can also filter by parent unit when paginating.
\nDeletes one or more organization units.
\nRetrieves users matching the given criteria. You must provide at least one of: pagination details, an identifier type and value together, a list of user IDs, or a list of identifier matches.
\nBy default only non-terminated users are returned; pass filter.statuses to include terminated users or to narrow to specific statuses.
Creates or updates users. All users in the request must belong to the same employer. Each user must have at least a phone number or an email address.
\nstatus is not writable here: new users are created as active, and status changes go through UpdateUsersStatus, DeleteUsers (terminate) and ActivateUsers. Assigning a terminated user to an organization unit or segment is rejected. The caller must be an active, non-terminated user.
hasFullOrganizationAccess: true grants the user every employer of the partner; false limits the user to employerRefIds (plus employerRefId).employerRefIds leaves the stored list unchanged; a hasFullOrganizationAccess flag without a list keeps the legacy behaviour where the flag decides the list.employerRefIds may only be set for roles that support multi-employer access. They are rejected for User, PartnerAdmin and System target roles, and the caller needs full-organization access, a role at or above the target role, and the same partner.organizationIds claim.Deletes one or more users.
\nCreates or updates a partner admin user. At least one of phoneNumber or email is required.
Route: /api/Users/CreateOrUpdatePartnerUser (the former CreateOrUpdatePartnerAdminUser path is not served). Requires the CreateOrUpdatePartnerUser scope. status is not writable; new users are created as active.
*At least one of phoneNumber or email must be provided.
Changes the status of one or more users. This is the only way to change status: it is not writable through CreateOrUpdateUsers. A status change is propagated to the payment account domain, where it locks or unlocks the user's pockets and cancels their pending approval workflows.
Requires the UpdateUsersStatus scope and write access to every user in the request.
A disallowed transition returns InvalidUserStatusTransition (status 12). Terminating a user is done with DeleteUsers.
Reinstates terminated users: sets their status back to active in a single write. This is the reverse of DeleteUsers. Users in any other status are rejected — use UpdateUsersStatus for those.
Requires the ActivateUsers scope and write access to every user in the request.
terminated status returns InvalidUserStatusTransition (status 12); an unknown refId returns InvalidRefId (status 3).Retrieves roles by their IDs.
\nRetrieves all available roles in the system.
\nThis endpoint takes no request parameters.
\nCreates a new partner in the platform.
\nRetrieves a list of partners. Optionally filtered by partner ref IDs.
\nFilter by partner ref IDs (repeat for multiple)
\n","type":"text/plain"},"key":"refIds[]","value":"00000000-0000-0000-0000-000000000000"}],"variable":[]}},"response":[{"id":"803c4b20-dbeb-48df-8376-4d5698331b13","name":"GetPartners","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"}],"url":{"raw":"https://api.stage.cal-platform.com/partners-backend/api/Partners/GetPartners","protocol":"https","host":["api","stage","cal-platform","com"],"path":["partners-backend","api","Partners","GetPartners"],"query":[{"key":"refIds[]","value":"3fa85f64-5717-4562-b3fc-2c963f66afa6","description":"Filter by partner ref IDs (repeat for multiple)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusDescription\": \"string\",\n \"statusCode\": 0,\n \"sessionId\": \"string\",\n \"httpStatus\": 0,\n \"result\": {\n \"partners\": [\n {\n \"name\": \"string\",\n \"address\": \"string\",\n \"contactNumber\": \"string\",\n \"email\": \"string\",\n \"industry\": \"string\",\n \"businessPartnerCode\": \"string\"\n }\n ]\n }\n}"}],"_postman_id":"b3055fa3-fa87-4b06-97e1-1dcafc619f84"},{"name":"CreateProduct","id":"da4c74f2-2244-41e5-b98b-9093ce0d62cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{CognitoToken}}"},{"key":"X-WebSite-Id","value":"X-WebSite-Id"},{"key":"x-organization-id","value":"{{organizationId}}"}],"body":{"mode":"raw","raw":"{\n \"employerRefId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"brand\": \"visa\",\n \"debitMethod\": \"paymentAccount\",\n \"optionalDebitDays\": [\n 0\n ],\n \"frameType\": \"zeroFrame\",\n \"cardPhysicality\": \"physicalAndVirtual\",\n \"deliveryMethod\": \"postOffice\",\n \"launchDate\": \"2026-05-04T10:34:48.118Z\",\n \"isDesignable\": true,\n \"isBeneficiary\": true,\n \"beneficiaryType\": \"kid\",\n \"executeRegistryForBeneficiary\": true,\n \"resetCommandsOnReEntry\": true,\n \"upsales\": [\n \"string\"\n ],\n \"paymentAccountManager\": \"platform\",\n \"isEmployeeRequiredForInit\": true,\n \"isIdentityDocumentRequired\": true,\n \"isOtpCommandRequired\": true,\n \"postIssuanceMobileMessageDelayInSeconds\": 0,\n \"isJoiningCibusAllowed\": true,\n \"custodiaCreateAndAssignCardProduct\": {\n \"businessPartnerCode\": \"string\",\n \"companyId\": \"string\",\n \"environment\": \"gov\",\n \"cardProductName\": \"string\",\n \"cardProductDescription\": \"string\",\n \"cardProductTypePrefix\": \"string\",\n \"getCardDetailsMethod\": \"platform\",\n \"cardProductCode\": \"string\",\n \"usePassport\": true\n },\n \"custodiaQueryAndAssignCardProduct\": {\n \"businessPartnerCode\": \"string\",\n \"companyId\": \"string\",\n \"environment\": \"gov\",\n \"cardProductTypePrefix\": \"string\"\n },\n \"commandsPreSaveActions\": [\n {\n \"commandName\": \"string\",\n \"actions\": [\n {\n \"actionName\": \"executeRegistry\",\n \"actionInputSources\": [\n {\n \"source\": \"currentClientRequest\",\n \"commandName\": \"string\",\n \"staticData\": {}\n }\n ]\n }\n ]\n }\n ],\n \"commandsPostSaveActions\": [\n {\n \"commandName\": \"string\",\n \"actions\": [\n {\n \"actionName\": \"executeRegistry\",\n \"actionInputSources\": [\n {\n \"source\": \"currentClientRequest\",\n \"commandName\": \"string\",\n \"staticData\": {}\n }\n ]\n }\n ]\n }\n ],\n \"isSelectCardPhysicality\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.cal-platform.com/partners-backend/api/Products/CreateProduct","description":"Creates a new card product for an employer.
\nReturns the products the calling user is currently eligible to issue a card for, after applying the issuance rules: per-product quota (maxActiveCardsPerUser, counted against the user's active cards) and, for products issued through Dolce, the Dolce eligibility check. Use it to build the product picker before calling the issuing service's InitUserWizardProcedure.
Requires the GetProducts scope. B2C (logged-in user) endpoint; no request body.
None. The user and organization are taken from the token and the X-Organization-Id header.
Tokenize a stored card via the specified payment provider and return an opaque card token. The full card data is decrypted on the platform side and passed to the provider; the partner never receives or holds the PAN.
\nMust be one of:
\nHypTranzila