The following documentation describes the format of interaction between Altery systems and partners via API. It is applicable to any Altery client who wish to use Altery API for sending payments.
\nThese instructions should be used by API integrators and integrators’ representatives involved with the deployment and management of Altery API on the integrator’s side. It should also be read by any third-party companies who will interface with Altery API on behalf of the API integrator.
\nRevision History
\nAPI Integrator can test out Stage environment using the same API methods as for the Production with different Base URL.
\nBase URL for accessing Altery API methods:
\nStage (Sandbox): https://api.sandbox.altery.com
\nProduction: https://api.altery.com
\nBefore accessing Altery Production, an API integrator can test API methods on the Stage environment (Sandbox).
\nTo access Sandbox, an API Integrator must request access by following these steps:
\nVerify a corporate account in Altery system.
\nGenerate an Sandbox account by following these steps:
\nLogin to Altery using a verified production corporate account.
\nGo to Settings, then click API Keys and credentials
\nClick Access to sandbox
\nGenerate an Sandbox API Private key. Keys can be issued in Sandbox Altery personal area by following these steps:
\nLogin to Altery Sandbox using an account details from received email (point 2.c.i).
\nGo to Settings, then click API Keys and credentials.
\nClick + (add) button, then enter the API key name, add whitelist IP-addresses, and click Next.
\nConfirm the action, then click Next.
\nClick Download key to save the archived API Key.
\nUnzip folder
\n\n\nNote: The Access to Sandbox button won’t be available unless API integrator has at least one active API key. It also won’t be available if API integrator previously clicked the button.
\n
To access Altery API, an API Integrator must:
\nVerify a corporate account in Altery system.
\nGenerate an production API Private key. Keys can be issued in Altery personal area by following these steps:
\nLogin to Altery using a verified corporate account.
\nGo to Settings, then click API Keys and credentials.
\nClick + (add) button, then enter the API key name, add whitelist IP-addresses, and click Next.
\nConfirm the action, then click Next.
\nClick Download key to save the archived API Key.
\nUnzip folder
\n\n\nNote: Save and store API Private Key in a safe place. It is not possible to re-download once issued Private Key because Altery does not store private Keys on its side.
\n
API integrator can have several valid API Keys. If an API integrator loses a previously issued Key, they can deactivate it in the Settings area of their Altery account, and issue a new key.
\nAuthorisation require API integrator to have an active API Private Key.
\nEncrypt each API request using your API Private Key and the algorithm to receive the X-Signature.
\nInclude the encrypted string in the X-Signature header and Private Key name in the X-Key-Id header for each API request.
\nHeader format for Private Key authorisation:
\nX-Signature: encrypted request’s signature\nX-Key-Id: a key from your Altery account\n\nRequest signing with API keys requires a pmlib.rs library to be installed. Installation instruction available here or below:
To use the automatic install method and also for test the library there exist a ready to use collection in the repo, in this location, you just need to download and import.
\nThe collection is provided in two Postman versions:
\nVersion 2: PostmanUtilityLibv2.postman_collection.json
\nVersion 2.1: PostmanUtilityLibv21.postman_collection.json
\nInside the collection you will find the next requests:
\nLib install: A GET request to download the library source and put into a global variable. Is the automatic installation.
\nLib use example: In the “script” tabs you will find examples about how to use the library.
\nAfter importing Altery postman collection, you need to fill environment variables
\nApiKeyId - API key id
\nApiKeySecret - API key private key
\nAPI integrator must generate a unique authorisation X-Signature header for each API request.
\nGeneration of X-Signature depends on an API request:
\nIf it has a body, then X-Signature is generated using the request body.
\nIf it has no body, then X-Signature is generated using the request’s URI.
\nIf an API request has a body, then to generate an X-Signature you need:
\nTake the original request body in the JSON format {\"name\": \"value\"}.
\nRemove all spaces from the JSON.
\nTake the bytes in the Encoding.UTF8.GetBytes format from the resulting file.
\nEncrypt the resulting array using the RSA SHA-512 algorithm and the Private Key.
\nConvert the resulting array to a base64 string.
\nAdd the encrypted string to the request as X-Signature header value.
\nFor example, the following PEM certificate was generated:
\nAltery_63691a6c5a91f40001774621.pem
\n-----BEGIN RSA PRIVATE KEY-----\nMIICXAIBAAKBgQCuRfOoyxAdqbkqyRf7XTvXJmXnKlEenf92AZrmKRrxWK9KpxWz\n2dIFQ34qCYYP7Kk6q+gCVvLBfQa5Ys7toUsehviIi+5eSxsDFmqsQCIy5aCxsain\nzOuz6FlJw7HJMqbAx13F+JWscYNKOwsO2iO7Pkk+hp2a9kAP7fUNHm6RDwIDAQAB\nAoGARWKqgYDf2L+TbrqD5tuXELFED0ak54jGhkhbUNn61S6XFCT0GhhWaywVFk2W\nZ861DhwVkqDlpC3QOI1jj+8RBdzKzPHlcBxqQsiuYbiJx+s2CIZQYAxN/b3bbSIN\nX3Dz8rp+Quu06ou3sT1XmhGWGrh67X7uoy5kzzqoT8W33UECQQDkM2L7uGfIQ2hr\nDRR1U2xp+CrwotxBLA2Fv+waXHlE2MAkgPe4e49XelEKhYuALlQH+YneOw7VKz9A\nAxzHZBvhAkEAw4DLr+qYI9QH740EAk3Qc374JZZE6/IZE/O0ye4xcVj6sjeIx1HU\nBc/nIwhrBKPSObggAwInEK/m/DjjYRnK7wJBAKLuLZYcK71Io50LUbgTQCzJC5+U\nKD4//cepKCIKNGt7dnSZwETvs4B5zLL+doOmkEjBWjZZZFW+8wH5NusGBwECQAaj\nK8coLswgmbhfUECHxcj2CZS1GlfsWz+bKYslhBY2ECTWz9T8iTc9TLqawY9hxHRj\nNOsFOrBNWIk9oTKdvo8CQFRZNfFZWx3DS+HSBDEoth/Wn0kbNKiqC8Dpfeyx4nxh\n3BYs/Kch6W3G9iAAHArTEjlXrgDEJjPj7EeCm4IhxB8=\n-----END RSA PRIVATE KEY-----\n\nThe name of this certificate included the X-Key-Id that should be passed in the request’s Header. In this example, X-Key-Id = 63691a6c5a91f40001774621.
\nNext, you need to generate an X-Signature signature, which also needs to be passed in your request’s Header for successful authorisation. This document uses the payment API method as an example.
\nThe following parameters are passed in the request body:
\n{\n\"Take\": 10,\n\"From\": 1\n}\n\nTo encrypt an X-Signature signature, API integrator must
\nConvert the JSON to a string without spaces. For the example above, it will be the following string {\"Take\":10,\"From\":1}.
\nThis line must be signed using the algorithm, and a PEM certificate (see below an example on how to generate the signature for C # and PHP).
\nFor the example PEM certificate and the API method from the example above, the X-Signature signature will look like this:
\nLC9SPiMSWlxhr7FT/UG3GGBRX5lhIiaEcroxZ3Bk0dUP+KZR4u0hANVCe75pWk1G7s5ZmvC9KA/MeOkXVrynnv9r9Md+MpMOuNWR6zWsI5HeX1mzJQLKLX6QLgac+WgcIv+ECwr3FAyirubIQxDMCEgEj96d2daKK5Z+jqf0pzw=\n\nTo generate X-Signature for an API request without request body:
\nGet the full query string. For example: /v4/transactions
\nTake bytes in the Encoding.UTF8.GetBytes format from the resulting string.
\nEncrypt the array using the RSA SHA-512 algorithm and the Private Key.
\nConvert the resulting array to a base64 string.
\nAdd the encrypted string to the request as X-Signature header value.
\nFor example, the following PEM certificate was generated:
\nAltery_63691a6c5a91f40001774621.pem
\n-----BEGIN RSA PRIVATE KEY-----\nMIICXAIBAAKBgQCuRfOoyxAdqbkqyRf7XTvXJmXnKlEenf92AZrmKRrxWK9KpxWz\n2dIFQ34qCYYP7Kk6q+gCVvLBfQa5Ys7toUsehviIi+5eSxsDFmqsQCIy5aCxsain\nzOuz6FlJw7HJMqbAx13F+JWscYNKOwsO2iO7Pkk+hp2a9kAP7fUNHm6RDwIDAQAB\nAoGARWKqgYDf2L+TbrqD5tuXELFED0ak54jGhkhbUNn61S6XFCT0GhhWaywVFk2W\nZ861DhwVkqDlpC3QOI1jj+8RBdzKzPHlcBxqQsiuYbiJx+s2CIZQYAxN/b3bbSIN\nX3Dz8rp+Quu06ou3sT1XmhGWGrh67X7uoy5kzzqoT8W33UECQQDkM2L7uGfIQ2hr\nDRR1U2xp+CrwotxBLA2Fv+waXHlE2MAkgPe4e49XelEKhYuALlQH+YneOw7VKz9A\nAxzHZBvhAkEAw4DLr+qYI9QH740EAk3Qc374JZZE6/IZE/O0ye4xcVj6sjeIx1HU\nBc/nIwhrBKPSObggAwInEK/m/DjjYRnK7wJBAKLuLZYcK71Io50LUbgTQCzJC5+U\nKD4//cepKCIKNGt7dnSZwETvs4B5zLL+doOmkEjBWjZZZFW+8wH5NusGBwECQAaj\nK8coLswgmbhfUECHxcj2CZS1GlfsWz+bKYslhBY2ECTWz9T8iTc9TLqawY9hxHRj\nNOsFOrBNWIk9oTKdvo8CQFRZNfFZWx3DS+HSBDEoth/Wn0kbNKiqC8Dpfeyx4nxh\n3BYs/Kch6W3G9iAAHArTEjlXrgDEJjPj7EeCm4IhxB8=\n-----END RSA PRIVATE KEY-----\n\nThe name of this certificate includes the X-Key-Id that should be passed in the request’s header. In this example, X-Key-Id = 63691a6c5a91f40001774621.
\nNext, generate an X-Signature, which also needs to be passed in your request’s headers. We will use the GET /v4/transactions/ API method as an example without a request body.
\nFor the PEM certificate and the API method from the example above, the X-Signature will look like this:
\nSgmS1wx/j52Pn51F6OSZrvU5LzmYNiHMlERDnm6DeGcEEMYWSu1LH6bHAEg3T1kedag9/ThETkg9nVTtLovCsTjHJoaPxUyi1daXWrdL8zdZFJLL8FJ/RUVb+oOzcVjBeARIx+nMCvw8WnpfQl/S4utEjEatQBgRnImXdl7TT60=\n\nAll third-party systems require a special set of parameters to be sent in the to object when carrying out a mass transfer.
\nFor transfers to third-party systems, the to field is an object which contains information about the recipient.
\nFor transfers to bank accounts, the identity field is an object which contains information about the recipient. The list of transmitted fields in identity depends on a number of conditions, such as the country of the recipient bank, recipient type, currency and others.
\nBelow are the fields that are required for the identity and conditions for each of them:
\nIf you received an error code not from this list, please contact Customer Support or your designated Account Manager.
\nThe preflight method to get information about the possible result of a transaction before undertaking it. The preflight method does not check partner service availability and cannot predict approval of the transfer, yet it can:
\nCheck for possible errors in the transfer request.
\nCalculate the transfer fee and conversion rate where it could be applied.
\nThe method is not mandatory for conducting a mass payment, but we recommend using it before a transaction execution.
\nBase URL:
\nSandbox: https://api.sandbox.altery.com
\nProduction: https://api.altery.com
\nThe Altery customers with a corporate account can use the web application and the API for multiple payouts (hereinafter - mass payments).
\nAltery mass payments allow customers to run up to 500 simultaneous transfers from the sender’s AlterId to various types of recipients. It is also possible to send a single transfer to a single recipient, as API methods will remain the same.
\nThe mass payment details are transferred over in the request body of the methods by using JSON or CSV file.
\n\n\nNote: The number of simultaneous transfers within a mass payment request is limited to 100.
\n
If the required number of transfers exceeds this limit, it is recommended to send it over several sequential mass payments requests.
Transfer participants
\nWhen carrying out a mass payment, two types of entities are involved:
\nSender - the initiator of the transfer from AlterId.
\nRecipient - the owner of the other AlterId or account in other payment system which will receive funds from the sender.
\nTypes of recipients
\nMass payments allow the following types of recipients:
\nDebit and credit cards:
\nVISA – by the card number, cardholder name
\nMASTERCARD * – by the card number, cardholder name
* please check with your Account Manager to ensure its availability.
Bank accounts:
\nSEPA
\nTARGET
\nFaster Payments *
* please check with your Account Manager to ensure its availability.
Altery accounts using one of the following:
\nAlterId
\nPhone number
\nProspects* (Unregistered in Altery individuals and companies) using one of the following:
\nPhone number
* A Prospect must register with Altery using the corresponding phone number or email to receive your transfer.
If currency exchange is required, then the currency parameter should be filled for both request body objects – from and to, which are used in Preflight, Fees, and Payments methods.
\nIf the currency parameter is filled only in one of the objects, or currency values are the same, then the currency exchange will not take place.
\nIf currency exchange is not carried out, then the quote and rate response body parameters will have null value.
\nIf the currency exchange is requested, the exchangeFee response body object of Preflight, Fees, and Payments methods will include currency exchange fee details.
\nThe currencies exchange rates update every 5 minutes. All types of a transfer use the current exchange rate. For example:
\n\n\nAn API integrator has checked the currency exchange rate using the Preflight or Fees method at 01:01 pm, decided to continue the transfer, then created and confirmed your first operation at 1:03 pm. The operation will proceed with the expected currency exchange rate.
\n
\n\nNext, the integrator decided to create and confirm a second operation with the same currencies and transfer amount at 1:07 pm. The currency exchange rate differed from the one in the first operation at 1:03 pm, so the value of the transaction is not the same. This happened because operations were confirmed in different operational periods (first operation – 1:00-1:05 pm; second operation – 1.05-1:10 pm).
\n
We recommend checking and confirming transfers within the currencies exchange rates update period.
\n\n\nNote: The Preflight and Fees methods return the quote parameter in the response body, which can be used in Payments request body to prolong the currency exchange rate for the operation.
\n
The transfer fee is not included and not shown in the initial transfer amount. It is paid by the sender in addition to the transfer amount.
\nA fee is debited from the sender’s AlterId when each transfer is completed. The fee amount depends on the payment system via which the recipient will receive the payment.
\n\n\nNote: Use the Fees method to get the information about fees before the transfer.
\n
Date format
\nTime and date parameters accept string value.
\nThe start time and end time parameters of a transfer are recorded as following - yyyy-MM-ddTHH:mm:ss.fffZ.
\nyyyy – year.
\nMM – month.
\ndd – day of the month.
\nT – Latin symbol “T” in upper-case.
\nHH – hour (24-hour format, from 00 to 23).
\nmm – minutes (from 00 to 59).
\nss – seconds (from 00 to 59).
\nf – fractions of a second.
\nZ – UTC, symbol “Z” in upper-case.
\nExample: 2022-02-17T15:05:52.403607Z – 5 minutes and 52 seconds past 3 pm on the 17th of March 2022.
\nTransfer currencies
\nCurrency parameters in Preflight, Fees, and Payments methods accept string value.
\nFor the transfer’s currency parameters, use the ISO-4217 three-letter Alphabetic Codes.
\nOutgoing payment currency must match one of the currencies supported by the Altery:
\nUSD – United States dollar
\nEUR – Euro
\nGBP – British pound
\nIf currency exchange is required, it is carried out using Altery exchange rates.
\nBefore you start
\nTo start a mass payments transfer, you need to:
\nVerify your account in the Altery system.
\nGenerate and download the API key and generate the X-Signature for authorisation.
\nReceiving a transaction list is configured after confirmation with the integration technical team.
\n","_postman_id":"e6ca3764-d309-4d7d-b4c5-24e3e37aec40","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"List of balances","item":[{"name":"Balance checks","id":"45c69d97-5087-4e17-9e4c-80184facf3ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUri}}/v1/user/balance/total","description":"No expected values.
\nThis method returns a list of balances on the available purse sections.
\nTo find out the balance for all purse sections, you need to use the balanceFrom values for each currency.
\n","_postman_id":"24a9f012-4c19-4704-b483-20c156458b24","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"Bank cards tokens","item":[{"name":"Generate token (GenerateToken)","id":"456105b7-b221-45b2-bb03-c06b26e63287","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Sid\": \"262e93b28300\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUri}}/v3/payments/cards/token/session","description":"Before API integrators can access transfers to bank cards on a live environment, they must fill out the SAQ form:
\nThese forms are requested in accordance with the PCI DSS rules under which Altery operates. Official guidelines on how to fill out forms can be found on the PCI DSS website.
\nThe completed form should be sent by email at support@altery.com or to your Account Manager.
\n","_postman_id":"150826d4-97fa-45db-8ea0-51dd0a49e77f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"Cards","item":[{"name":"/v1/corporate-cards","item":[{"name":"GetCards","id":"5efd7a2c-26ef-4503-b6c8-9c1a0e647c7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUri}}/v1/corporate-cards?searchFields=&search=&sortBy=&start=0&limit=100","description":"Returns a list of cards with search, sorting, and pagination options.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards"],"host":["{{BaseUri}}"],"query":[{"description":{"content":"array[string] (optional) — fields to search, comma separated
\n","type":"text/plain"},"key":"searchFields","value":""},{"description":{"content":"string (optional) — search string
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"string (optional) — sort field, use '-' for descending
\n","type":"text/plain"},"key":"sortBy","value":""},{"description":{"content":"integer (required) — pagination start index
\n","type":"text/plain"},"key":"start","value":"0"},{"description":{"content":"integer (optional) — max records to return
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"54cd77a3-89e4-4059-aa4a-14040485ba63","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseUri}}/v1/corporate-cards?searchFields=&search=&sortBy=&start=0&limit=100","host":["{{BaseUri}}"],"path":["v1","corporate-cards"],"query":[{"key":"searchFields","value":"","description":"array[string] (optional) — fields to search, comma separated"},{"key":"search","value":"","description":"string (optional) — search string"},{"key":"sortBy","value":"","description":"string (optional) — sort field, use '-' for descending"},{"key":"start","value":"0","description":"integer (required) — pagination start index"},{"key":"limit","value":"100","description":"integer (optional) — max records to return"}]},"description":"Returns a list of cards with search, sorting, and pagination options."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": [],\n \"metadata\": {\n \"count\": 1,\n \"totalCount\": 1,\n \"totalPages\": 1,\n \"startIndex\": 0,\n \"endIndex\": 0,\n \"hasMore\": false\n },\n \"cards\": [\n {\n \"cardId\": \"b1e2d3f4-5678-1234-9876-abcdef012345\",\n \"idempotencyKey\": \"a1b2c3d4-5678-1234-9876-abcdef012345\",\n \"status\": \"Ready\",\n \"bin\": \"123456\",\n \"last4\": \"1234\",\n \"isActive\": true,\n \"currency\": \"USD\",\n \"dateEnteredUtc\": \"2025-09-02T12:00:00Z\",\n \"expMonth\": \"12\",\n \"expYear\": \"2027\",\n \"purseId\": 1001\n }\n ]\n}"}],"_postman_id":"5efd7a2c-26ef-4503-b6c8-9c1a0e647c7b"},{"name":"AddCard","id":"2362b5ee-9e6e-432b-824d-93edd54e4b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"","description":"string (uuid, optional) — idempotency key
\n"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USD\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"businessOrPersonal\": \"Business\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards","description":"Adds a new card. Required body parameters: currency (string), firstName (string), lastName (string), businessOrPersonal (string: Business/Personal).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"a2c905aa-fb7c-4e63-99b5-5194baaf64f2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Idempotency-Key","value":"","description":"string (uuid, optional) — idempotency key"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"USD\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"businessOrPersonal\": \"Business\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards","description":"Adds a new card. Required body parameters: currency (string), firstName (string), lastName (string), businessOrPersonal (string: Business/Personal)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": [],\n \"card\": {\n \"cardId\": \"b1e2d3f4-5678-1234-9876-abcdef012345\",\n \"idempotencyKey\": \"a1b2c3d4-5678-1234-9876-abcdef012345\",\n \"status\": \"Ready\",\n \"bin\": \"123456\",\n \"last4\": \"1234\",\n \"isActive\": true,\n \"currency\": \"USD\",\n \"dateEnteredUtc\": \"2025-09-02T12:00:00Z\",\n \"expMonth\": \"12\",\n \"expYear\": \"2027\",\n \"purseId\": 1001\n }\n}"}],"_postman_id":"2362b5ee-9e6e-432b-824d-93edd54e4b45"}],"id":"43547652-fe9a-4d63-87e3-17b620067075","_postman_id":"43547652-fe9a-4d63-87e3-17b620067075","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"/v1/corporate-cards/{cardId}","item":[{"name":"GetCard","id":"93a39bc1-4576-4446-9915-1050d92e7eed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUri}}/v1/corporate-cards/{{cardId}}","description":"Returns a card by its identifier. Parameters: cardId (string, uuid, required).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","{{cardId}}"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"d901a8e2-ec9b-43cf-94e4-4d7e233fcf67","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{{BaseUri}}/v1/corporate-cards/{{cardId}}","description":"Returns a card by its identifier. Parameters: cardId (string, uuid, required)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": [],\n \"card\": {\n \"cardId\": \"b1e2d3f4-5678-1234-9876-abcdef012345\",\n \"idempotencyKey\": \"a1b2c3d4-5678-1234-9876-abcdef012345\",\n \"status\": \"Ready\",\n \"bin\": \"123456\",\n \"last4\": \"1234\",\n \"isActive\": true,\n \"currency\": \"USD\",\n \"dateEnteredUtc\": \"2025-09-02T12:00:00Z\",\n \"expMonth\": \"12\",\n \"expYear\": \"2027\",\n \"purseId\": 1001\n }\n}"}],"_postman_id":"93a39bc1-4576-4446-9915-1050d92e7eed"},{"name":"DeleteCard","id":"352f7b9c-5a3e-48ad-9755-c0adbbb85ce0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{BaseUri}}/v1/corporate-cards/{{cardId}}?reason=Stolen","description":"Deletes a card by its identifier. Parameters: cardId (string, uuid, required), reason (string, required).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","{{cardId}}"],"host":["{{BaseUri}}"],"query":[{"description":{"content":"string (required) — reason: Stolen, Lost, DontNeed, FeesTooHigh, MissedSomeFeatures, Other
\n","type":"text/plain"},"key":"reason","value":"Stolen"}],"variable":[]}},"response":[{"id":"f988f1ca-0204-473e-bd16-af39be8528b2","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{BaseUri}}/v1/corporate-cards/{{cardId}}?reason=Stolen","host":["{{BaseUri}}"],"path":["v1","corporate-cards","{{cardId}}"],"query":[{"key":"reason","value":"Stolen","description":"string (required) — reason: Stolen, Lost, DontNeed, FeesTooHigh, MissedSomeFeatures, Other"}]},"description":"Deletes a card by its identifier. Parameters: cardId (string, uuid, required), reason (string, required)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": []\n}"}],"_postman_id":"352f7b9c-5a3e-48ad-9755-c0adbbb85ce0"},{"name":"UpdateCard","id":"613a17f6-017b-44e1-a95f-001ba910e597","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/{{cardId}}","description":"Updates card parameters. Parameters: cardId (string, uuid, required), request body (fields to update).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","{{cardId}}"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"011b805e-503e-4a16-b40c-357ed0d2c675","name":"Success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/{{cardId}}","description":"Updates card parameters. Parameters: cardId (string, uuid, required), request body (fields to update)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": []\n}"}],"_postman_id":"613a17f6-017b-44e1-a95f-001ba910e597"}],"id":"c7867dd5-07e4-411d-9e7e-27a935340c2a","_postman_id":"c7867dd5-07e4-411d-9e7e-27a935340c2a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"/v1/corporate-cards/{cardId}/frozen","item":[{"name":"SetCardFrozen","id":"98d4c0df-606c-40d8-9d4d-692e5dd36397","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"frozen\": true\n}"},"url":"{{BaseUri}}/v1/corporate-cards/{{cardId}}/frozen","description":"Freezes or unfreezes a card. Parameters: cardId (string, uuid, required), frozen (boolean, required).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","{{cardId}}","frozen"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"a4564312-a9c2-47f8-84f2-bfa469653bc9","name":"Success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"frozen\": true\n}"},"url":"{{BaseUri}}/v1/corporate-cards/{{cardId}}/frozen","description":"Freezes or unfreezes a card. Parameters: cardId (string, uuid, required), frozen (boolean, required)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": []\n}"}],"_postman_id":"98d4c0df-606c-40d8-9d4d-692e5dd36397"}],"id":"2f74713a-d5b6-48f9-938c-e8c91c58c33f","_postman_id":"2f74713a-d5b6-48f9-938c-e8c91c58c33f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"/v1/corporate-cards/clearing","item":[{"name":"Return the clearing report","id":"98b09b36-fc55-4078-8e39-4e6a064bfbf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUri}}/v1/corporate-cards/clearing?from=2025-01-01T00:00:00Z","description":"Returns the clearing report. Parameters: from (string, date-time, required).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","clearing"],"host":["{{BaseUri}}"],"query":[{"description":{"content":"string (date-time, required) — report start date
\n","type":"text/plain"},"key":"from","value":"2025-01-01T00:00:00Z"}],"variable":[]}},"response":[{"id":"dbaa9019-7bf6-4648-a931-5d730da0e377","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseUri}}/v1/corporate-cards/clearing?from=2025-01-01T00:00:00Z","host":["{{BaseUri}}"],"path":["v1","corporate-cards","clearing"],"query":[{"key":"from","value":"2025-01-01T00:00:00Z","description":"string (date-time, required) — report start date"}]},"description":"Returns the clearing report. Parameters: from (string, date-time, required)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": [],\n \"clearings\": [\n {\n \"clearingId\": \"c1e2d3f4-5678-1234-9876-abcdef012345\",\n \"cardId\": \"b1e2d3f4-5678-1234-9876-abcdef012345\",\n \"cardPaymentEvent\": \"Settlement\",\n \"debitOrCredit\": \"Debit\",\n \"transactionAmount\": 100.00,\n \"transactionCurrencyCode\": \"USD\",\n \"accountAmount\": 100.00,\n \"accountCurrencyCode\": \"USD\",\n \"createdAt\": \"2025-09-02T12:00:00Z\",\n \"merchantCategoryCode\": \"5411\",\n \"merchantCity\": \"New York\",\n \"merchantId\": \"m123456\",\n \"merchantName\": \"Test Store\"\n }\n ]\n}"}],"_postman_id":"98b09b36-fc55-4078-8e39-4e6a064bfbf5"}],"id":"ae46bcfa-9e7b-40d6-8a22-7c21d832e446","_postman_id":"ae46bcfa-9e7b-40d6-8a22-7c21d832e446","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"/v1/corporate-cards/account","item":[{"name":"GetAccount","id":"54c186e8-3241-40f0-9bf3-398ed1d05d10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseUri}}/v1/corporate-cards/account","description":"Returns account information.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","account"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"3c438e40-f9da-450d-b3cf-2b0ebe874e05","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{{BaseUri}}/v1/corporate-cards/account","description":"Returns account information."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": [],\n \"balanceByPurseSection\": [\n {\n \"purseId\": 1001,\n \"currency\": \"USD\",\n \"balance\": 1000.00\n }\n ]\n}"}],"_postman_id":"54c186e8-3241-40f0-9bf3-398ed1d05d10"}],"id":"50bbfffa-7b15-4d38-a997-df84af4bea50","_postman_id":"50bbfffa-7b15-4d38-a997-df84af4bea50","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"/v1/corporate-cards/webhooks/authorization-test","item":[{"name":"TriggerAuthorizationWebhook","id":"7d2e8b59-b220-449b-b691-559163393327","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"https://webhook.site/your-uri\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/webhooks/authorization-test","description":"Test call for authorization webhook. Parameters: webhookUri (string, optional).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","webhooks","authorization-test"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"2185d955-08e2-46f4-8833-38f60399f85d","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"https://webhook.site/your-uri\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/webhooks/authorization-test","description":"Test call for authorization webhook. Parameters: webhookUri (string, optional)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": []\n}"}],"_postman_id":"7d2e8b59-b220-449b-b691-559163393327"}],"id":"bb94776b-236b-4522-8906-1fbf26f102d9","_postman_id":"bb94776b-236b-4522-8906-1fbf26f102d9","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"/v1/corporate-cards/webhooks/transaction-test","item":[{"name":"TriggerTransactionWebhook","id":"6520e1f3-79e9-45bc-97ea-beaa4f4a69ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"https://webhook.site/your-uri\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/webhooks/transaction-test","description":"Test call for transaction webhook. Parameters: webhookUri (string, optional).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","webhooks","transaction-test"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"0f202dad-6f61-4f26-a5cd-413866cfaee0","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"https://webhook.site/your-uri\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/webhooks/transaction-test","description":"Test call for transaction webhook. Parameters: webhookUri (string, optional)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": []\n}"}],"_postman_id":"6520e1f3-79e9-45bc-97ea-beaa4f4a69ac"}],"id":"75de7c55-9330-435f-8cf8-d2aa6841cce2","_postman_id":"75de7c55-9330-435f-8cf8-d2aa6841cce2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"/v1/corporate-cards/webhooks/card-test","item":[{"name":"TriggerCardWebhook","id":"4cd482e1-dd72-4488-a972-17bcfd4d1c61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"https://webhook.site/your-uri\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/webhooks/card-test","description":"Test call for card webhook. Parameters: webhookUri (string, optional).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}},"urlObject":{"path":["v1","corporate-cards","webhooks","card-test"],"host":["{{BaseUri}}"],"query":[],"variable":[]}},"response":[{"id":"b590cec0-de15-4586-9cab-6cc9a85d1091","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"https://webhook.site/your-uri\"\n}"},"url":"{{BaseUri}}/v1/corporate-cards/webhooks/card-test","description":"Test call for card webhook. Parameters: webhookUri (string, optional)."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": []\n}"}],"_postman_id":"4cd482e1-dd72-4488-a972-17bcfd4d1c61"}],"id":"19555579-ed8a-4e86-b15b-5950ecba35e7","_postman_id":"19555579-ed8a-4e86-b15b-5950ecba35e7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}}],"id":"e2cf9231-88c5-4c87-bf59-8b64e26e2a1f","_postman_id":"e2cf9231-88c5-4c87-bf59-8b64e26e2a1f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Signature"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","id":"7faecf97-bd62-4a97-974b-5589df8d2ba0","name":"Altery API - Version 1.01","type":"collection"}}},{"name":"Сustomers","item":[{"name":"Create customer","id":"917fc9b2-0fc1-49b2-a4d7-4fbe74a78a69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"string\",\n \"sumSubImport\": {\n \"token\": \"string\"\n },\n \"agreements\": [\n {\n \"type\": 3882,\n \"acceptedAt\": \"1979-08-14T04:11:18.948Z\",\n \"ipAddress\": \"string\",\n \"userAgent\": \"string\"\n },\n {\n \"type\": 1932,\n \"acceptedAt\": \"1954-02-22T11:29:57.913Z\",\n \"ipAddress\": \"string\",\n \"userAgent\": \"string\"\n }\n ],\n \"personal\": {\n \"phone\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"dateOfBirth\": \"1950-10-09\",\n \"citizenshipCountry\": \"string\",\n \"residenceCountry\": \"string\",\n \"tin\": \"string\",\n \"nin\": \"string\"\n },\n \"address\": {\n \"postcode\": \"string\",\n \"town\": \"string\",\n \"street\": \"string\",\n \"state\": \"string\",\n \"subStreet\": \"string\",\n \"apartment\": \"string\"\n },\n \"questionnaire\": {\n \"purposeOfOpeningAccount\": 6344,\n \"sourcesOfFunds\": [\n 9743,\n 518\n ],\n \"taxResidences\": [\n {\n \"countryIsoCodeAlpha3\": \"string\",\n \"taxIdNumber\": \"string\"\n },\n {\n \"countryIsoCodeAlpha3\": \"string\",\n \"taxIdNumber\": \"string\"\n }\n ],\n \"monthlyTurnover\": 5672\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{BaseUri}}/v1/corporate-customers","description":"Customer ID
\n","type":"text/plain"},"type":"any","value":"62ba2cbd-120f-076d-0290-2fced5f565cc","key":"customerId"}]}},"response":[{"id":"6926caf4-6f69-47bf-a073-f3741c105199","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/corporate-customers/:customerId","host":["{{baseUrl}}"],"path":["v1","corporate-customers",":customerId"],"variable":[{"key":"customerId","value":"62ba2cbd-120f-076d-0290-2fced5f565cc","description":"Customer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": [],\n \"id\": \"df340125-fd42-d369-1728-e199a8a96dd5\",\n \"status\": \"Closed\",\n \"verificationStatus\": \"Rejected\",\n \"externalId\": \"string\",\n \"statusReason\": \"string\",\n \"requiredIdDocs\": [\n {\n \"idDocSetType\": \"SELFIE\",\n \"types\": [\n \"DRIVERS\",\n \"UTILITY_BILL\"\n ]\n },\n {\n \"idDocSetType\": \"QUESTIONNAIRE\",\n \"types\": [\n \"ID_CARD\",\n \"PASSPORT\"\n ]\n }\n ],\n \"realTimeUserInput\": {\n \"sumSubExternalWebSdkLink\": \"string\",\n \"sumSubSdkAccessToken\": \"string\"\n },\n \"agreements\": [\n {\n \"id\": \"03c11d91-c039-27de-3917-d68c9973ef88\",\n \"type\": 1315,\n \"acceptedAt\": \"2008-03-04T22:17:02.861Z\",\n \"ipAddress\": \"string\",\n \"userAgent\": \"string\"\n },\n {\n \"id\": \"18efb06f-a592-b0fb-ed2c-d15b76aa7fc9\",\n \"type\": 1514,\n \"acceptedAt\": \"2025-02-10T13:06:53.831Z\",\n \"ipAddress\": \"string\",\n \"userAgent\": \"string\"\n }\n ],\n \"personal\": {\n \"phone\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"dateOfBirth\": \"1958-06-24\",\n \"citizenshipCountry\": \"string\",\n \"residenceCountry\": \"string\",\n \"tin\": \"string\",\n \"nin\": \"string\"\n },\n \"address\": {\n \"postcode\": \"string\",\n \"town\": \"string\",\n \"street\": \"string\",\n \"state\": \"string\",\n \"subStreet\": \"string\",\n \"apartment\": \"string\"\n },\n \"idDocs\": [\n {\n \"type\": \"ID_CARD\",\n \"subType\": \"BACK_SIDE\",\n \"country\": \"string\"\n },\n {\n \"type\": \"UTILITY_BILL\",\n \"subType\": \"FRONT_SIDE\",\n \"country\": \"string\"\n }\n ],\n \"questionnaire\": {\n \"purposeOfOpeningAccount\": 8770,\n \"sourcesOfFunds\": [\n 3487,\n 9226\n ],\n \"taxResidences\": [\n {\n \"countryIsoCodeAlpha3\": \"string\",\n \"taxIdNumber\": \"string\"\n },\n {\n \"countryIsoCodeAlpha3\": \"string\",\n \"taxIdNumber\": \"string\"\n }\n ],\n \"monthlyTurnover\": 3102\n }\n}"}],"_postman_id":"c2d5bab7-13b1-4a40-9f15-3846551d1a48"},{"name":"Get account details","id":"de71b428-04d7-45b6-8129-ad952ecaf5f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUri}}/v1/corporate-customers/:customerId/account-details","description":"Customer ID
\n","type":"text/plain"},"type":"any","value":"62ba2cbd-120f-076d-0290-2fced5f565cc","key":"customerId"}]}},"response":[{"id":"eb4b1f2f-9bac-4dcd-aec4-72c5ddfcf424","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/corporate-customers/:customerId/account-details","host":["{{baseUrl}}"],"path":["v1","corporate-customers",":customerId","account-details"],"variable":[{"key":"customerId","value":"62ba2cbd-120f-076d-0290-2fced5f565cc","description":"Customer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": 0,\n \"errorMsgs\": [],\n \"personalAccounts\": [\n {\n \"currency\": \"string\",\n \"swift\": \"string\",\n \"iban\": \"string\",\n \"routingCodeType\": \"TWNCC\",\n \"routingCodeValue\": \"string\",\n \"accountNumber\": \"string\",\n \"recipientName\": \"string\"\n },\n {\n \"currency\": \"string\",\n \"swift\": \"string\",\n \"iban\": \"string\",\n \"routingCodeType\": \"USABA\",\n \"routingCodeValue\": \"string\",\n \"accountNumber\": \"string\",\n \"recipientName\": \"string\"\n }\n ],\n \"fundForwardingLinks\": [\n {\n \"sourceCurrency\": \"string\",\n \"cryptoWallet\": {\n \"cryptoCurrency\": \"string\",\n \"cryptoWalletAddress\": \"string\"\n }\n },\n {\n \"sourceCurrency\": \"string\",\n \"cryptoWallet\": {\n \"cryptoCurrency\": \"string\",\n \"cryptoWalletAddress\": \"string\"\n }\n }\n ]\n}"}],"_postman_id":"de71b428-04d7-45b6-8129-ad952ecaf5f8"}],"id":"f9e49fa9-afc8-4a18-8bb1-96b3ba94fa9c","description":"See Authorisation section at https://developer.altery.com/#intro for the details on how to sign the requests using API key.
\nExecute request:
\nPOST /v1/corporate-customers
{\n \"externalId\": \"acb123\",\n \"agreements\": [\n { \"type\": 3, \"acceptedAt\": \"2025-10-10T13:01:02.003Z\" }\n ],\n \"personal\": {\n \"phone\": \"+442071234567\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"dateOfBirth\": \"1999-11-11\",\n \"citizenshipCountry\": \"GBR\",\n \"residenceCountry\": \"GBR\"\n },\n \"questionnaire\": {\n \"purposeOfOpeningAccount\": \"23\",\n \"sourcesOfFunds\": [\"14\"],\n \"monthlyTurnover\": \"110\",\n \"taxResidences\": [\n { \"CountryIsoCodeAlpha3\": \"GBR\" }\n ]\n }\n} \n\nexternalId - optional customer identifier in your system
agreements - a list of accepted agreement types, which can be looked-up in the catalog (see: operation GET /v1/corporate-catalog/values/AgreementType) or see below values:
3 - Altery LTD - mandatory agreement
2 - UAB Novaflow Digital - agreement to enable Crypto features, if available in customer's residence country
personal - all the fields of this section in the example request are required
questionnaire - this section is optional for the customer creation request but the data is mandatory for verification (if not submitted via API request, customer can fulfil the questionnaire online via SumSub SDK), possible answers for questions can be looked-up in the catalog (GET /v1/corporate-catalog/values/{catalogValueType} and GET /v1/corporate-catalog/tax-residences), below is description of values used in the example request:
purposeOfOpeningAccount = 23 - Shopping
sourcesOfFunds = 14 - Transfers from my other account
monthlyTurnover = 110 - Up to € 10,000
If all goes well the response will contain below fields:
\nid - the generated unique customer identifier
status - the current status of the customer will be Created
verificationStatus - the current verification status of the customer will be UserDataRequired, which means a customer should provide information for verification
realTimeUserInput.sumSubSdkAccessToken - SumSub SDK access token to be used to show SumSub SDK for the online customer data input - PoI (Proof of Identity) document, Liveness Check (selfie), PoA (Proof of Address) document and Questionnaire answers (if not gathered earlier and submitted via API)
See: https://docs.sumsub.com/reference/generate-share-token
\nExecute request:
\nPOST https://api.sumsub.com/resources/accessTokens/shareToken
{\n \"applicantId\": \"66fcec26092966193d7a99d3\",\n \"forClientId\": \"recary\",\n \"ttlInSecs\": \"1210000\"\n}\n\napplicantId - SumSum applicant identifier should be shared and used for the customer creation process
forClientId - should be equal to recary
ttlInSecs - token expiration duration, which should be enough to execute the next request for the customer creation.
Execute request:
\nPOST /v1/corporate-customers
{\n \"externalId\": \"acb123\",\n \"sumSubImport\": {\n \"token\": \"_act.......\"\n },\n \"agreements\": [\n { \"type\": 3, \"acceptedAt\": \"2025-10-10T13:01:02.003Z\" }\n { \"type\": 2, \"acceptedAt\": \"2025-10-10T13:01:02.003Z\" }\n ]\n}\n\nexternalId - optional customer identifier in your system
sumSubImport.token - the shared token create for an applicant that should be imported
agreements - a list of accepted agreement types, which can be looked-up in the catalog (see: operation GET /v1/corporate-catalog/values/AgreementType) or see below values:
3 - Altery LTD - mandatory agreement
2 - UAB Novaflow Digital - agreement to enable Crypto features, if available in customer's residence country
If all goes well the response will contain below fields:
\nid - the generated unique customer identifier
status - the current status of the customer will be Created
verificationStatus - the current verification status of the customer will be InVerification
Note: SumSub applicant level should be configured as per Altery guidelines to ensure the import process goes smoothly and all the required data for verification is fully available.
\nExecute request:
\nGET /v1/corporate-customers/{customerId}
customerId - the unique customer identifier generated during customer creationE.g. when the verification is completed successfully the response shows the corresponding statuses:
\nstatus - Active
verificationStatus - Verified
A webhook event is sent when a client's status changes.
\nE.g. when the verification is completed successfully the webhook event looks like the example below:
\n{\n \"eventId\": \"d1d3ff91-8aba-403c-930c-3dea9863b56a\"\n \"eventType\": \"CustomerStatusChanged\",\n \"eventTimestamp\": \"2025-08-29T17:16:11Z\",\n \"customerId\": \"7a941c46-d6fa-47b7-999b-2d318e8d926a\",\n \"customerExternalId\": \"abc123\",\n \"customerStatus\": \"Active\",\n \"customerVerificationStatus\" : \"Verified\"\n}\n\nA webhook event is sent when a client adds a new verification document.
\nExample:
\n{\n \"eventId\": \"d1d3ff91-8aba-403c-930c-3dea9863b56a\"\n \"eventType\" : \"CustomerIdDocumentAdded\",\n \"eventTimestamp\": \"2025-08-29T17:16:11Z\",\n \"customerId\": \"7a94146-d6fa-47b7-999b-2d318e8d926a\",\n \"customerExternalId\" : \"abc123\",\n \"idDocId\": \"1234567890\",\n \"idDocType\": \"ID_CARD\",\n \"idDocSubType\": \"FRONT_SIDE\",\n \"idDocContentUrl\": \"https://api.altery.com/v1/corporate-customers/7a94146-d6fa-47b7-999b-2d318e8d926a/id-docs/1234567890/content\"\n}\n\nA webhook event is sent when a client verification process is completed.
\nExample of a webhook event when SumSub check has failed:
\n{\n \"eventId\": \"d1d3ff91-8aba-403c-930c-3dea9863b56a\"\n \"eventType\" : \"CustomerVerificationProcessed\",\n \"eventTimestamp\": \"2025-08-29T17:16:11Z\",\n \"customerId\": \"7a94146-d6fa-47b7-999b-2d318e8d926a\",\n \"customerExternalId\" : \"abc123\",\n \"verificationOutcome\": \"Rejected\",\n \"verificationChecks\": {\n \"sumSubCheck\": \"Failed\",\n \"duplicatesAndBlacklistCheck\": \"NotPerformed\",\n \"sanctionsCheck\": \"NotPerformed\",\n \"riskAssessment\": \"NotPerformed\"\n },\n \"sumSubCheckDetails\": {\n \"riskLabels\": {\n \"crossCheck\": [ \"manyAccountDuplicates\" ]\n },\n \"rejectLabels\": [ \"FORGERY\", GRAPHIC_EDITOR\", \"UNSATISFACTORY_PHOTOS\" ]\n }\n}\n\nAll possible values for riskLabels and sumSubCheckDetails:
https://docs.sumsub.com/reference/expression-attributes#applicantrisklabels
\nhttps://docs.sumsub.com/reference/expression-attributes#rejectlabels
\nA webhook event is sent when a personal bank account is created for a client after verification process is completed.
\nExample of a webhook event for a bank account with UK Sort Code:
\n{\n \"eventId\": \"d1d3ff91-8aba-403c-930c-3dea9863b56a\"\n \"eventType\" : \"CustomerPersonalBankAccountCreated\",\n \"eventTimestamp\": \"2025-08-29T17:16:11Z\",\n \"customerId\": \"7a94146-d6fa-47b7-999b-2d318e8d926a\",\n \"customerExternalId\" : \"abc123\",\n \"currency\": \"GBP\",\n \"routingCodeType\": \"GBDSC\",\n \"routingCodeValue\": \"04-14-04\",\n \"accountNumber\": \"10938594\",\n \"recipientName\": \"John Smith\"\n}\n\nExample of a webhook event for a bank account with IBAN:
\n{\n \"eventId\": \"d1d3ff91-8aba-403c-930c-3dea9863b56a\"\n \"eventType\" : \"CustomerPersonalBankAccountCreated\",\n \"eventTimestamp\": \"2025-08-29T17:16:11Z\",\n \"customerId\": \"7a94146-d6fa-47b7-999b-2d318e8d926a\",\n \"customerExternalId\" : \"abc123\",\n \"currency\": \"EUR\",\n \"swift\": \"TCCLGB3L\",\n \"iban\": \"GB12TCCL12345610938594\",\n \"recipientName\": \"Adam-ac SumSubACSGBRRCGBR\"\n}\n\n