{ "openapi": "3.0.0", "info": { "title": "Antaca Api Secure Documentation", "description": "\n\nThis documentation describes the capabilities of ANTACA API related to\naccount maintenance and card issuing.
\n
\n
\nAntaca has been designed to meet the Mastercard requirements of the\nDigital First program, which contains guidelines for payment and e-banking applications to maintain the highest level of security, convenience\nof use in terms of accessibility and payment solutions from the level of the\ntelephone and other devices.\n
\nThe standard flow for user → registration → KYC application → automatic\naccount creation → automatic creation of a virtual card, after which he\ngets the possibility to fully manage his card, view its data or pay online\n\n## Application Events\nEvents are on dedicated exchange, eg. quicko-prepaid-api\n| Routing | Payload |\n|--------------------|-------------|\n| thc_record.created | {\"id\\\":2958} |\n| | |\n\n\n
\n## Authorization\nThis API requires Mutual TLS authentication.\n
You can use the same certificate for all mTLS-secured APIs exposed by Verestro.\n
If you don't have one, follow this instruction: [Connecting to server-to-server APIs](https://developer.verestro.com/books/connecting-to-our-services/page/connecting-to-server-to-server-apis)\n\n## Idempotent Requests\nThe API supports idempotency for safely retrying requests without accidentally performing the same operation twice.\n
\nTo perform an idempotent request, provide an additional header to the request: `X-Idempotency-Key`: `uuid`\n
\nIdempotency key is valid for 24h\n
\nEach generated X-Idempotency-Key must be used only once. Do not reuse the same key for multiple requests—reusing may cause incorrect API behavior or request rejection.\n
\nEach next request return response identical to the first one that will be get from cache.\n\n## HTTP Headers\n\n### Request Headers\n\n| Header | Type | Description |\n|:-------|:-----|:------------|\n| `Application-Id` | String | Identifier of the application calling the API. |\n| `X-B3-TraceId` | String | Trace identifier for distributed logging (Zipkin/B3). |\n| `X-B3-SpanId` | String | Span identifier for distributed logging. |\n| `X-Idempotency-Key` | String | Key ensuring operation idempotency. Prevents re-processing of the same request. (POST/PATCH) |\n| `Encrypted-Request` | Boolean | Informs the API that the request body (payload) is encrypted in JWE format. |\n| `Encrypt-Response` | Boolean | Informs the API whether the response should be encrypted before sending. |\n| `Public-Key` | String | Client's public key (base64-encoded PEM) used by the API to encrypt the response. |\n| `Accept-Language` | String | Preferred language for the response. |\n| `X-Unique-TransactionId` | Boolean | Flag determining specific behavior when retrieving transactions. |\n| `ssl-client-cert` | String | URL-encoded X.509 client certificate. Used in mTLS communication. |\n| `Content-Type` | String | Content type of the sent request. |\n| `Accept` | String | Specifies the response format. |\n\n### Response Headers\n\n| Header | Description |\n|:-------|:------------|\n| `X-B3-TraceId` | Returned trace identifier associated with the request. |\n| `X-B3-SpanId` | Returned span identifier associated with the request. |\n| `Access-Control-*` | CORS (Cross-Origin Resource Sharing) headers. |\n| `Content-Type` | Response content type (usually `application/json`). |\n\n## Encryption\nAll endpoints in the Secure API support optional encryption (JWE).\n\n
\n
\n### Encryption Headers\nTo enable JWE encryption, use the following headers:\n
\n- **Public-Key** (string): Base64-encoded public key for response encryption. Required when Encrypt-Response is true.\n
\n- **Encrypted-Request** (boolean): Set to `true` to send encrypted request payload.\n
\n- **Encrypt-Response** (boolean): Set to `true` to receive encrypted response payload.\n
\n
\n### Public Key Validation\n- If `Encrypt-Response: true` is sent **without** a valid `Public-Key` header, the API returns **422 INVALID_PUBLIC_KEY**.\n
\n- If `Public-Key` contains an invalid or malformed key, the API returns **422 INVALID_PUBLIC_KEY**.\n
\n- Empty or missing `Public-Key` with `Encrypt-Response: false` (or not set) is allowed - no encryption occurs.\n
\n
\n### Error Codes\n| Code | Status | Description |\n|------|--------|-------------|\n| 422 | INVALID_PUBLIC_KEY | Public-Key header is missing, empty, or contains invalid key when Encrypt-Response is true |\n| 422 | CANT_DECRYPT_PAYLOAD | Request payload cannot be decrypted (invalid JWE token) |\n| 400 | INVALID_HEADER_VALUE | Encrypted-Request or Encrypt-Response header contains non-boolean value |\n
\n
\nFind out more using [this link](https://developer.verestro.com/books/card-management-system/page/overview#bkmrk-step-1.-configuratio-0)\n", "version": "1.0.0" }, "paths": { "/async_operations/{id}": { "get": { "tags": [ "Async Operation" ], "summary": "Endpoint for obtaining status of asynchronous operation", "description": "This endpoint is for checking status of asynchronous operation previously startted by different processes
\nKeep in mind that along with status this method can return Location header involving url path to created resource.", "operationId": "8d5f4eded096dd4ef99d7314e13e645a", "parameters": [ { "name": "id", "in": "path", "description": "Async operation in uuid format", "required": true, "schema": { "type": "string", "format": "uuid", "example": "d5f57a40-6de9-4547-bc33-77f42aa85cea" } } ], "responses": { "200": { "description": "Operation on IN_PROGRESS state", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "example": "0b8d6c51-5537-4923-a39d-ecbd6abe85e2" }, "status": { "type": "string", "example": "IN_PROGRESS" }, "errors": { "type": "string", "example": "[]" }, "progress": { "type": "integer", "example": "50" } }, "type": "object" } } } }, "303": { "description": "Operation has been completed. Always return Location header with url for created resource", "headers": { "Location": { "description": "url for created resurce eg. /customers/me/cards/123", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "example": "0b8d6c51-5537-4923-a39d-ecbd6abe85e2" }, "status": { "type": "string", "example": "COMPLETED" }, "errors": { "type": "string", "example": "[]" } }, "type": "object" } } } } } } }, "/secure/balances": { "get": { "tags": [ "Secure - Balances" ], "summary": "Get all balances secured endpoint.", "operationId": "0fd021a501b65f1b1a207a6128d76993", "parameters": [ { "name": "type", "in": "query", "description": "balance type [CUSTOMER | COMPANY | CREDIT | DEPOSIT | IBAN_TECHNICAL]", "required": true, "schema": { "type": "string", "example": "IBAN_TECHNICAL" } }, { "name": "currency", "in": "query", "description": "Currency in 3 letter ISO-4217", "schema": { "type": "string", "example": "PLN" } }, { "name": "dcUserId", "in": "query", "description": "DC User Id", "schema": { "type": "int", "example": "1337" } }, { "name": "dcCorporationId", "in": "query", "description": "DC Corporation Id", "schema": { "type": "string", "example": "0b8d6c51-5537-4923-a39d-ecbd6abe85e1" } }, { "name": "balanceId", "in": "query", "description": "balance Id", "schema": { "type": "string", "example": "0b8d6c51-5537-4923-a39d-ecbd6abe85e1" } }, { "name": "sort", "in": "query", "description": "Field to order list", "required": false, "schema": { "type": "string", "enum": [ "createdAt" ] } }, { "name": "order", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "limit", "in": "query", "description": "Limit of balances returned in a single chunk can be specified.", "required": false, "schema": { "type": "int", "example": 20 } }, { "name": "page", "in": "query", "description": "Page of paginated list", "required": false, "schema": { "type": "int", "example": 3 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceGetAll" } } } } } }, "post": { "tags": [ "Secure - Balances" ], "summary": "Create balance", "operationId": "createBalance", "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "currency": { "description": "User id from DataCore", "type": "string", "example": "PLN" }, "dcUserId": { "description": "Data Core user id", "type": "integer", "example": "1337" }, "dcCorporationId": { "description": "Data Core Corporation id", "type": "string", "example": "a271f0e9-065b-4e3c-be24-9bac54fbd550" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string", "example": "0b8d6c51-5537-4923-a39d-ecbd6abe85e2" }, "balance": { "type": "intager", "example": "89" }, "currency": { "type": "string", "example": "PLN" }, "dcUserId": { "type": "integer", "example": "1337" }, "dcCorporationId": { "type": "string", "example": "0b8d6c51-5537-4923-a39d-ecbd6abe85e2" } }, "type": "object" } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CustomerNotFound" }, "CorporationNotFound": { "$ref": "#/components/examples/CorporationNotFound" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCurrency": { "summary": "INVALID_CURRENCY", "value": { "status": "INVALID_CURRENCY" } }, "MaxCountBalancesLimit": { "summary": "MAX_COUNT_BALANCES_LIMIT", "value": { "status": "MAX_COUNT_BALANCES_LIMIT" } }, "InvalidBalanceOwner": { "summary": "INVALID_BALANCE_OWNER", "value": { "status": "INVALID_BALANCE_OWNER" } } } } } } } } }, "/secure/master_balances/{balanceId}": { "get": { "tags": [ "Secure - Master Balance" ], "summary": "Get master balance details.", "operationId": "getMasterBalance-Secure", "parameters": [ { "name": "balanceId", "in": "path", "description": "Id of balance", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterBalance" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "MASTER_BALANCE_NOT_FOUND" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/master_balances": { "get": { "tags": [ "Secure - Master Balance" ], "summary": "Get list of master balances", "operationId": "getMasterBalances-Secure", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MasterBalance" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/balances/iban_technical": { "get": { "tags": [ "Secure - Master Balance" ], "summary": "Get list of IBAN technical balances", "description": "Use this method to get all credit.", "operationId": "getIbanTechnicalBalances-Secure", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MasterBalance" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/balances/iban_technical/{balanceId}": { "get": { "tags": [ "Secure - Master Balance" ], "summary": "Get IBAN technical balance detail", "description": "Use this method to credit balance details.", "operationId": "getIbanTechnicalBalance-Secure", "parameters": [ { "name": "balanceId", "in": "path", "description": "Id of balance", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterBalance" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "MASTER_BALANCE_NOT_FOUND" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}/balances": { "get": { "tags": [ "Secure - Customer Balance" ], "summary": "Get customer balances secured endpoint.", "operationId": "1f8799f51c0c1ca5343398e044d4e43b", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } }, { "name": "nocards", "in": "query", "description": "Will not return cards associated to balances", "required": false, "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceEntity" } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerNotFound" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "post": { "tags": [ "Secure - Customer Balance" ], "summary": "Create customer balance", "operationId": "createCustomerBalance-Secure", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "currency": { "description": "Valid three letter ISO 4217 currency code.", "type": "string", "example": "PLN" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerBalanceBrief" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "CUSTOMER_NOT_FOUND" } }, "type": "object" } } } } } } }, "/secure/customers/{customerId}/balances/{balanceId}": { "get": { "tags": [ "Secure - Customer Balance" ], "summary": "Get customer balance", "operationId": "getCustomerBalance", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": 1125 } }, { "name": "balanceId", "in": "path", "description": "Id of balance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "nocards", "in": "query", "description": "Will not return cards associated to balances", "required": false, "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerBalanceEntity" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotFound": { "$ref": "#/components/examples/CustomerBalanceNotFound" }, "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "delete": { "tags": [ "Secure - Customer Balance" ], "summary": "Delete customer balance", "operationId": "deleteCustomerBalance", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } }, { "name": "balanceId", "in": "path", "description": "Id of balance", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } } ], "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotFound": { "$ref": "#/components/examples/CustomerBalanceNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotCleared": { "$ref": "#/components/examples/CustomerBalanceNotCleared" }, "CustomerAccountingBalanceNotCleared": { "$ref": "#/components/examples/CustomerAccountingBalanceNotCleared" }, "LastCustomerBalanceLeft": { "$ref": "#/components/examples/LastCustomerBalanceLeft" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/balances/{balanceId}": { "delete": { "tags": [ "Secure - Balance" ], "summary": "Delete balance", "operationId": "deleteBalance", "parameters": [ { "name": "balanceId", "in": "path", "description": "Id of balance", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } } ], "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotFound": { "$ref": "#/components/examples/CustomerBalanceNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotCleared": { "$ref": "#/components/examples/CustomerBalanceNotCleared" }, "CustomerAccountingBalanceNotCleared": { "$ref": "#/components/examples/CustomerAccountingBalanceNotCleared" }, "LastCustomerBalanceLeft": { "$ref": "#/components/examples/LastCustomerBalanceLeft" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/balances/types": { "get": { "tags": [ "Secure - Balances" ], "summary": "Get balances types", "operationId": "getBalancesTypes", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" }, "example": [ "CUSTOMER", "COMPANY", "CREDIT", "DEPOSIT", "IBAN_TECHNICAL" ] } } } } } }, "/secure/balances/{balanceId}/limits": { "get": { "tags": [ "Secure - Customer Balance" ], "summary": "Get all limits of a balance", "operationId": "7b8c8db1c78e8af3599043bb218ee4ef", "parameters": [ { "name": "balanceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceLimitCollection" } } } }, "404": { "description": "Balance not found" } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "post": { "tags": [ "Secure - Customer Balance" ], "summary": "Add limit for balance", "description": "Allows to add a balance usage limit. Available types: CASH_IN (limit for incoming transactions), CASH_OUT (limit for outgoing transactions).", "operationId": "dd4d1c2483edf52abdeeb02ff20b0a39", "parameters": [ { "name": "balanceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "type", "maxAmount", "period" ], "properties": { "type": { "type": "string", "enum": [ "CASH_IN", "CASH_OUT" ], "example": "CASH_IN" }, "maxAmount": { "type": "integer", "example": 50000 }, "period": { "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ], "example": "MONTHLY" }, "expiration": { "type": "string", "format": "date", "example": "2099-12-24" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceLimitResource" } } } }, "404": { "description": "Balance not found" }, "409": { "description": "Limit of given type and period already exists", "content": { "application/json": { "schema": {}, "examples": { "limit already exists": { "summary": "LIMIT_ALREADY_EXISTS", "value": { "status": "LIMIT_ALREADY_EXISTS" } } } } } }, "422": { "description": "Validation error" } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/balances/{balanceId}/limits/{limitId}": { "get": { "tags": [ "Secure - Customer Balance" ], "summary": "Get specific balance limit", "operationId": "1b5c3ee0d2606e6341788d7e9fb274e8", "parameters": [ { "name": "balanceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limitId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceLimitResource" } } } }, "404": { "description": "Balance or limit not found" } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "delete": { "tags": [ "Secure - Customer Balance" ], "summary": "Delete balance limit", "operationId": "2e0b888e942861911cf2ae82f8b8e6f3", "parameters": [ { "name": "balanceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limitId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Balance not found" } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "patch": { "tags": [ "Secure - Customer Balance" ], "summary": "Update balance limit", "operationId": "9b2c7ead24e358069512f6e2dec62231", "parameters": [ { "name": "balanceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limitId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "maxAmount": { "type": "integer", "example": 100000 }, "expiration": { "type": "string", "format": "date", "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Balance or limit not found" }, "422": { "description": "Validation error" } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/{cardId}/limits": { "get": { "tags": [ "Secure - Cards" ], "summary": "Get limits of given card", "description": "Allows to retrieve all limits for given card", "operationId": "acef1084e32ccd80f209cd31e4b003d0", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardLimitCollection" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } } } }, "post": { "tags": [ "Secure - Cards" ], "summary": "Add limits for card usage", "description": "Allows to add card usage limit. For all kinds of limit types, properties as 'maxAmount', 'maxLimit' or 'period' should be passed in the request to make the limit work properly.\n *\nTRX_ALL - limit for every kind of transaction. With this value, at least one of parameters: 'maxAmount' or 'maxAttempts' should be passed in the request.
\nFor example - I want to make no more than 10 transactions for a total amount of 5000 (minor value) per month:\n * type: TRX_ALL\n * maxAmount: 5000\n * maxAttempts: 10\n * period: monthly\nTRX_E_COM - limit for e-commerce transaction. All properties as maxAmount, maxAttempts will be checked only if it is e-commerce transaction.
\nFor example - I want to make no more than 5 e-commerce transaction for a total amount of 1000 (minor value) per day:\n * type: TRX_E_COM\n * maxAmount: 1000\n * maxAttempts: 5\n * period: daily\nTRX_ATM - limit for atm transaction. All properties as maxAmount, maxAttempts will be checked only if it is atm transaction.
\nFor example - I want to make no more than 2 ATM withdrawals for a total amount of 300 (minor value) per week:\n * type: TRX_ATM\n * maxAmount: 300\n * maxAttempts: 2\n * period: weekly\nFOREIGN_AMOUNT - limit for the value of transactions made in a different currency than the currency of a card.
\nFor example - I want to spent no more than 200 in foreign amount per month:\n * type: FOREIGN_AMOUNT\n * maxAmount: 200\n * period: monthly\nFOREIGN_QUANTITY - limit for the quantity of transactions made in different currency than the currency of a card. With this value, property 'maxAttempts' should be passed in the request.
\nFor example - I want to make no more than 3 transaction in foreign currency per day:\n * type: FOREIGN_QUANTITY\n * maxAttempts: 3\n * period: daily\nQUANTITY - limit for transaction quantity. With this value, property 'maxAttempts' should be passed.
\nFor example - I want to make no more than 100 transaction per day:\n * type: QUANTITY\n * maxAttempts: 100\n * period: daily\nAMOUNT_PLN - limit for value of transaction made in PLN currency. With this value, property 'maxAmount' should be passed.
\nFor example - I want to spent no more than 500 PLN (use the minor value in code) per week:\n * type: AMOUNT_PLN\n * maxAmount: 50000\n * period: weekly\nAMOUNT_EUR - limit for value of transaction made in EUR currency. With this value, property 'maxAmount' should be passed.
\nFor example - I want to spent no more than 200 EUR (use the minor value in code) per month:\n * type: AMOUNT_EUR\n * maxAmount: 20000\n * period: monthly\nMCC_BLACKLIST - limit for transaction made in terminal with specific merchant category code. With this value, property 'mcc_list' should be passed.\nFor example - I would not like to spend money in restaurants with this card:\n * type: MCC_BLACKLIST\n * mcc_list: [5812]\nMCC_WHITELIST - limit for transaction made in terminal without specific merchant category code. With this value, property 'mcc_list' should be passed.\nFor example - I would like to spend money only in restaurants with this card:\n * type: MCC_WHITELIST\n * mcc_list: [5812]\nMERCHANT_ID_BLACKLIST - limit for transaction made in terminal with specific merchant identifiers. With this value, property 'merchant_id_list' should be passed.\nFor example - I would not like to spend money at certain merchants with this card:\n * type: MERCHANT_ID_BLACKLIST\n * merchant_id_list: ['9AF3C2B1D4E5']\nMERCHANT_ID_WHITELIST - limit for transaction made in terminal without specific merchant identifiers. With this value, property 'merchant_id_list' should be passed.\nFor example - I would like to spend money at certain merchants with this card:\n * type: MERCHANT_ID_WHITELIST\n * merchant_id_list: ['9AF3C2B1D4E5']\n", "operationId": "e3dea13216172573185f2684b0076460", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "type": { "description": "Type of card limitation", "type": "string", "enum": [ "TRX_ALL", "TRX_E_COM", "POS", "TRX_ATM", "FOREIGN_AMOUNT", "QUANTITY", "AMOUNT_PLN", "MCC_BLACKLIST", "MCC_WHITELIST", "AMOUNT_EUR", "MERCHANT_ID_BLACKLIST", "MERCHANT_ID_WHITELIST" ], "example": "TRX_ALL" }, "maxAmount": { "description": "Maximum amount of money that can be spend by this card. Value in penny.", "type": "integer", "example": "10000000" }, "maxAttempts": { "description": "Number of transaction that can be handled with this card.", "type": "integer", "example": "99" }, "period": { "description": "Describes if limit is periodically. For example, if card can handle transactions for 100PLN per day, or maybe 100 transactions per week", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ], "example": "DAILY" }, "expiration": { "description": "Date of card limit expiration. After that, limit will be no longer checked", "type": "string", "format": "date", "example": "2099-12-24" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardLimitResource" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "CARD_NOT_FOUND" } }, "type": "object" } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidLimitParameters": { "$ref": "#/components/examples/InvalidLimitParameters" }, "InvalidMaxAmount": { "$ref": "#/components/examples/InvalidMaxAmount" }, "InvalidMaxAttempts": { "$ref": "#/components/examples/InvalidMaxAttempts" }, "CurrencyWithTypeMismatch": { "$ref": "#/components/examples/CurrencyWithTypeMismatch" }, "InvalidType": { "summary": "INVALID_TYPE", "value": { "status": "INVALID_TYPE", "errors": { "type": [ "INVALID_TYPE" ] } } }, "ValidationMultiFields": { "summary": "VALIDATION", "value": { "status": "INVALID_TYPE", "errors": { "type": [ "INVALID_TYPE" ], "period": [ "INVALID_PERIOD" ], "expiration": [ "DATE_IS_INVALID" ] } } } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/{cardId}/limits/{limitId}": { "delete": { "tags": [ "Secure - Cards" ], "summary": "Delete card limit", "description": "Allows to delete specific limit for given card", "operationId": "98a9e905eb6978af35076bf2dc6e52b8", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } }, { "name": "limitId", "in": "path", "description": "Card limit id", "required": true, "schema": { "type": "string", "format": "uuid", "example": "492ec5ee-7f66-11ec-a8a3-0242ac120002" } } ], "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" }, "CardLimitNotFound": { "$ref": "#/components/examples/CardLimitNotFound" } } } } } } }, "patch": { "tags": [ "Secure - Cards" ], "summary": "Update card limit", "description": "Allows to update parameters of specific limit for card", "operationId": "133b1ff5b8c446e140dde1be089c0c3d", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } }, { "name": "limitId", "in": "path", "description": "Card limit id", "required": true, "schema": { "type": "string", "format": "uuid", "example": "492ec5ee-7f66-11ec-a8a3-0242ac120002" } } ], "requestBody": { "description": "Input data", "content": { "application/json": { "schema": { "properties": { "maxAmount": { "description": "Maximum amount of money that can be spend by this card. Value in penny.", "type": "integer", "example": "10000000", "nullable": "true" }, "maxAttempts": { "description": "Number of transaction that can be handled with this card.", "type": "integer", "example": "99", "nullable": "true" }, "period": { "description": "Describes if limit is periodically. For example, if card can handle transactions for 100PLN per day, or maybe 100 transactions per week", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ], "example": "DAILY", "nullable": "true" }, "expiration": { "description": "Date of card limit expiration. After that, limit will be no longer checked", "type": "string", "format": "date", "example": "2099-12-24", "nullable": "true" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" }, "CardLimitNotFound": { "$ref": "#/components/examples/CardLimitNotFound" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidLimitParameters": { "$ref": "#/components/examples/InvalidLimitParameters" }, "InvalidMaxAmount": { "$ref": "#/components/examples/InvalidMaxAmount" }, "InvalidMaxAttempts": { "$ref": "#/components/examples/InvalidMaxAttempts" }, "InvalidType": { "summary": "INVALID_TYPE", "value": { "status": "INVALID_TYPE", "errors": { "type": [ "INVALID_TYPE" ] } } }, "ValidationMultiFields": { "summary": "VALIDATION", "value": { "status": "INVALID_TYPE", "errors": { "type": [ "INVALID_TYPE" ], "period": [ "INVALID_PERIOD" ], "expiration": [ "DATE_IS_INVALID" ] } } } } } } } } } }, "/secure/cards/virtual/async": { "post": { "tags": [ "Secure - Cards" ], "summary": "Create new virtual card secured endpoint. [Secured Endpoint], [Async Process]", "description": "\n## BE NOTIFIED\n- For this method is required to pass configuration **id** obtained from EP(**CustomerCards**): `GET /customers/me/cards/config`\n- This method initialize async process to follow current status of running process please use this EP(**Secure**): `GET /async_operations/{id}`\n", "operationId": "ba4006b5796038a5e61b63e9b77b073e", "requestBody": { "description": "Input data format", "required": true, "content": { "application/json": { "schema": { "properties": { "balanceId": { "title": "Customer balance id for which card should be linked", "type": "string", "example": "e1169e67-0ef3-4358-a4c2-14f793d8907c" }, "configId": { "description": "Configuration identifier obtained from method: /customers/me/cards/config", "type": "string", "example": "0013009713" }, "dcUserId": { "description": "User identifier from dataCore", "type": "integer", "example": "1337" }, "dcCorporationId": { "description": "Corporation identifier from dataCore", "type": "string", "format": "uuid", "example": "ec619acc-e21d-4b6d-9d96-9ac7e606294a" } }, "type": "object" } } } }, "responses": { "202": { "description": "Successful operation containing tracking url for obtaining operation status", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "IN_PROGRESS" }, "tracking": { "type": "string", "example": "/async_operations/1994b43d-8962-4e6e-9c9c-b1c67636b23e" } }, "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CorporationBalanceNotFound": { "$ref": "#/components/examples/CorporationBalanceNotFound" }, "CustomerBalanceNotFound": { "$ref": "#/components/examples/CustomerBalanceNotFound" }, "CorporationNotFound": { "$ref": "#/components/examples/CorporationNotFound" }, "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" }, "InvalidConfiguration": { "$ref": "#/components/examples/InvalidConfiguration" }, "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/{cardId}/activation": { "post": { "tags": [ "Secure - Cards" ], "summary": "Activate previously ordered card", "operationId": "80e99f4c6d11a14798af30270e3b9956", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "123" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "dcUserId": { "description": "DataCore user Id", "type": "integer", "example": "1337" }, "dcCorporationId": { "description": "DataCore corporation Id", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130007" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Cant find card with requested id or card does not belong to logged user", "type": "string", "example": "CARD_NOT_FOUND" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}/cards/{cardId}/pin": { "post": { "tags": [ "Secure - Customer Cards" ], "summary": "Change card pin", "description": "Method allows to update card pin", "operationId": "6bf2727a7f2f75c65aee080eb204f663", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": 1337 } }, { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "pin": { "description": "New pin", "type": "string", "example": "1337" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCard": { "$ref": "#/components/examples/InvalidCard" }, "ChangePinFailure": { "$ref": "#/components/examples/ChangePinFailure" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/{cardId}/budget": { "get": { "tags": [ "Secure - Cards" ], "summary": "Get card budget", "description": "\nThis method allows you to get card budget list.\n", "operationId": "12859d481712a699aa30823d5b4ec30f", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardLimit" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" }, "CardBudgetNotFound": { "$ref": "#/components/examples/CardBudgetNotFound" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "post": { "tags": [ "Secure - Cards" ], "summary": "Create card budget", "description": "\nThis method allows you create card budget.\n", "operationId": "createCardBudget", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "value": { "description": "Budget value", "type": "integer", "example": "1000" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardLimit" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "BudgetAlreadyExists": { "$ref": "#/components/examples/BudgetAlreadyExists" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "delete": { "tags": [ "Secure - Cards" ], "summary": "Delete card budget", "description": "\nThis method allows you to delete card budget.\n", "operationId": "deleteCardBudget", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "patch": { "tags": [ "Secure - Cards" ], "summary": "Update card budget", "description": "\nThis method allows you to change card budget. New value cannot be lower than amount already used.\n", "operationId": "updateCardBudget", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "schema": { "type": "string", "example": "a00ca5ef-c0c1-48c2-a147-6300f66dc6c8" } }, { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "value": { "description": "New budget value. It must be greater than already used budget value", "type": "integer", "example": "1000" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardBudgetNotFound": { "$ref": "#/components/examples/CardBudgetNotFound" }, "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CantUpdateBudget": { "$ref": "#/components/examples/CantUpdateBudget" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}/cards/virtual": { "post": { "tags": [ "Secure - Cards" ], "summary": "Create new virtual card for customer secured endpoint.", "operationId": "3d68dbc69a4c1a6c22ac541f92312018", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "balanceId": { "description": "Customer balance id for which card should be linked", "type": "string" }, "configId": { "description": "Configuration identifier obtained from method: /customers/me/cards/config", "type": "string", "example": "0013009713" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualCardResource" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotFound": { "$ref": "#/components/examples/CustomerBalanceNotFound" }, "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CantCreateLinkedCard": { "$ref": "#/components/examples/CantCreateLinkedCard" }, "StoreCardFailure": { "$ref": "#/components/examples/StoreCardFailure" }, "CardIssuerError": { "$ref": "#/components/examples/CardIssuerError" }, "InvalidConfiguration": { "$ref": "#/components/examples/InvalidConfiguration" }, "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "BalanceIdRequired": { "$ref": "#/components/examples/BalanceIdRequired" }, "ConfigIdRequired": { "$ref": "#/components/examples/ConfigIdRequired" } } } } } }, "deprecated": true, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/disposable": { "post": { "tags": [ "Secure - Cards" ], "summary": "Create new one-time virtual card (secure endpoint).", "description": "\nIssues a virtual card with a ONE_SHOT limit — valid for a single transaction.\nIt is deleted from the system after first use.\n ", "operationId": "076cebb9b57d09006016d4882f5dc118", "requestBody": { "description": "Input data format", "required": true, "content": { "application/json": { "schema": { "properties": { "balanceId": { "description": "Balance id for which the card should be linked", "type": "string", "example": "e1169e67-0ef3-4358-a4c2-14f793d8907c" }, "configId": { "description": "Configuration identifier obtained from method: /customers/me/cards/config", "type": "string", "example": "0013009713" }, "dcUserId": { "description": "User identifier from dataCore", "type": "integer", "example": "1337", "nullable": "true" }, "dcCorporationId": { "description": "Corporation identifier from dataCore", "type": "string", "format": "uuid", "example": "ec619acc-e21d-4b6d-9d96-9ac7e606294a", "nullable": "true" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualCardResource" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotFound": { "$ref": "#/components/examples/CustomerBalanceNotFound" }, "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" }, "CorporationNotFound": { "$ref": "#/components/examples/CorporationNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CantCreateLinkedCard": { "$ref": "#/components/examples/CantCreateLinkedCard" }, "StoreCardFailure": { "$ref": "#/components/examples/StoreCardFailure" }, "CardIssuerError": { "$ref": "#/components/examples/CardIssuerError" }, "InvalidConfiguration": { "$ref": "#/components/examples/InvalidConfiguration" }, "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "BalanceIdRequired": { "$ref": "#/components/examples/BalanceIdRequired" }, "ConfigIdRequired": { "$ref": "#/components/examples/ConfigIdRequired" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/virtual": { "post": { "tags": [ "Secure - Cards" ], "summary": "Create new virtual card secured endpoint.", "operationId": "1956b8e402faafe52def875677a52a6a", "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "balanceId": { "description": "Customer balance id for which card should be linked", "type": "string", "example": "e1169e67-0ef3-4358-a4c2-14f793d8907c" }, "configId": { "description": "Configuration identifier obtained from method: /customers/me/cards/config", "type": "string", "example": "0013009713" }, "dcUserId": { "description": "User identifier from dataCore", "type": "integer", "example": "1337", "nullable": "true" }, "dcCorporationId": { "description": "Corporation identifier from dataCore", "type": "string", "format": "uuid", "example": "ec619acc-e21d-4b6d-9d96-9ac7e606294a", "nullable": "true" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualCardResource" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerBalanceNotFound": { "$ref": "#/components/examples/CustomerBalanceNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CantCreateLinkedCard": { "$ref": "#/components/examples/CantCreateLinkedCard" }, "StoreCardFailure": { "$ref": "#/components/examples/StoreCardFailure" }, "CardIssuerError": { "$ref": "#/components/examples/CardIssuerError" }, "InvalidConfiguration": { "$ref": "#/components/examples/InvalidConfiguration" }, "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "BalanceIdRequired": { "$ref": "#/components/examples/BalanceIdRequired" }, "ConfigIdRequired": { "$ref": "#/components/examples/ConfigIdRequired" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/{cardId}": { "get": { "tags": [ "Secure - Cards" ], "summary": "Get card details", "description": "Method restricted only for internal use. To get card details for your user please use /secure/customers/{customerId}/cards/{cardId} method.", "operationId": "ccab381d1868290587831f8774c05068", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDetails" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" }, "InvalidConfiguration": { "$ref": "#/components/examples/InvalidConfiguration" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "delete": { "tags": [ "Secure - Cards" ], "summary": "Delete customer's card", "description": "Method delete prepaid card. Be careful, this card is deleted from all services (prepaid, dc, tutuka)", "operationId": "3df85fa60c99b4cd33a50d0d4315efaf", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "3098" } } ], "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } } } } }, "/secure/cards/{cardId}/cvv": { "post": { "tags": [ "Secure - Cards" ], "summary": "Generate new cvv for a virtual card", "description": "\n## Security\nROLE_GENERATE_CVV is required to access this method\n ", "operationId": "9ec09c196fd48d1ba9634b198dbcd4b2", "parameters": [ { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "cvv": { "type": "string", "example": "255" } }, "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } }, "409": { "description": "Cvv generation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "UpdateCvvFailure": { "$ref": "#/components/examples/UpdateCvvFailure" } } } } } } } }, "/secure/cards": { "get": { "tags": [ "Secure - Cards" ], "summary": "Get cards", "description": "", "operationId": "c7673f0bfa4ae2bd28b957be20722b9c", "parameters": [ { "name": "dcUserId", "in": "query", "description": "DataCore user id", "schema": { "type": "integer", "example": "1337" } }, { "name": "dcCorporationId", "in": "query", "description": "DataCore corporation id", "schema": { "format": "string", "example": "492ec5ee-7f66-11ec-a8a3-0242ac120002" } }, { "name": "sort", "in": "query", "description": "Field to order list", "required": false, "schema": { "type": "string", "enum": [ "createdAt" ] } }, { "name": "order", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "limit", "in": "query", "description": "Limit of cards returned in a single chunk can be specified.", "required": false, "schema": { "type": "int", "example": 20 } }, { "name": "page", "in": "query", "description": "Page of paginated list", "required": false, "schema": { "type": "int", "example": 3 } }, { "name": "balanceId", "in": "query", "description": "Filter by balanceId", "required": false, "schema": { "format": "string", "example": "492ec5ee-7f66-11ec-a8a3-0242ac120002" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardGetAll" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}/cards/{cardId}": { "get": { "tags": [ "Secure - Customer Cards" ], "summary": "Get customer card details", "description": "Returns details of customer card", "operationId": "51503dd5f42afd5dfe84ebbe967e4942", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1337" } }, { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDetails" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" }, "InvalidConfiguration": { "$ref": "#/components/examples/InvalidConfiguration" }, "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}/cards/{cardId}/lock": { "post": { "tags": [ "Secure - Customer Cards" ], "summary": "Lock customer's card.", "description": "\nMethod locks the card. Card is also locked in processor side (card issuer) and DataCore (card storage).\n\nNote: Some lock reasons are irreversible. For more details see [Developer Zone - Card Issuing Overview](https://developer.verestro.com/books/card-issuing-and-core-banking/page/overview#bkmrk-lock)\n", "operationId": "abc465edfca1579393aed0588b9f30c4", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": 1125 } }, { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "reason": { "description": "Reason for locking the card", "type": "string", "enum": [ "CARD_LOST", "CARD_STOLEN", "PENDING_QUERY", "CARD_CONSOLIDATION", "CARD_INACTIVE", "PIN_TRIES_EXCEEDED", "SUSPECTED_FRAUD", "CARD_REPLACED" ], "example": "CARD_STOLEN" }, "note": { "description": "A note / reason about stopping the card", "type": "string", "example": "Some note about stopping the card" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCard": { "$ref": "#/components/examples/InvalidCard" }, "LockCardFailure": { "$ref": "#/components/examples/LockCardFailure" }, "CardIssuerError": { "$ref": "#/components/examples/CardIssuerError" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Validation status", "type": "string", "example": "INVALID_REASON" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/physical": { "post": { "tags": [ "Secure - Cards" ], "summary": "Order new physical card. This method starts order process.", "operationId": "dc3f5778376eea5fe845f5457729956b", "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "operationId": { "description": "Identifier of card order operation", "type": "string", "format": "uuid", "example": "39927556-7848-4dff-a0d2-24c23915bfa9", "nullable": "true" }, "dcUserId": { "description": "DataCore user Id", "type": "integer", "example": "1337" }, "firstName": { "description": "First name of card holder
Only uppercase letters, no special characters, no spaces and no more than 20 characters", "type": "string", "example": "Jane" }, "lastName": { "description": "Last name of card holder
Only uppercase letters, no special characters, no spaces and no more than 20 characters", "type": "string", "example": "Doe" }, "city": { "description": "City of card holder. Also this is part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "Lublin" }, "street": { "description": "Part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "Rusalka" }, "number": { "description": "House/appartment number. Also this is part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "17a" }, "postCode": { "description": "Postal code of city. Also this is part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "20-123" }, "state": { "description": "Optional state. Also this is part of address on which card will be send", "type": "string", "example": "Manchester" }, "country": { "description": "ISO 3166-1 alfa-3", "type": "string", "example": "POL" }, "balanceId": { "description": "Identifier of balance to which card will be attached", "type": "string", "example": "e31b76e0-21df-11ed-861d-0242ac120002" }, "configId": { "description": "Card configuration identifier. Could be obtained from 'GET /customers/me/cards/config'", "type": "string", "example": "0013009713" }, "visualId": { "description": "Optional card visualId", "type": "integer", "example": "17" }, "deliveryType": { "description": "Optional delivery type", "type": "string", "example": "1" }, "phone": { "description": "Phone number should be provided as local to the given delivery country. Remember to include prefix.", "type": "string", "example": "48500123123" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "enum": [ "INVALID_FIRST_NAME", "INVALID_LAST_NAME", "INVALID_CITY", "INVALID_STREET", "INVALID_NUMBER", "INVALID_POST_CODE", "INVALID_COUNTRY", "INVALID_BALANCE_ID", "CANNOT_MATCH_CONFIGURATION" ], "example": "INVALID_FIRST_NAME" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/physical_with_pin": { "post": { "tags": [ "Secure - Cards" ], "summary": "Order new physical card with PIN. This method starts order process.", "operationId": "bf472416fb884eba3029b39813d7866b", "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "operationId": { "description": "Identifier of card order operation", "type": "string", "format": "uuid", "example": "39927556-7848-4dff-a0d2-24c23915bfa9", "nullable": "true" }, "dcUserId": { "description": "DataCore user Id", "type": "integer", "example": "1337" }, "firstName": { "description": "First name of card holder
Only uppercase letters, no special characters, no spaces and no more than 20 characters", "type": "string", "example": "Jane" }, "lastName": { "description": "Last name of card holder
Only uppercase letters, no special characters, no spaces and no more than 20 characters", "type": "string", "example": "Doe" }, "city": { "description": "City of card holder. Also this is part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "Lublin" }, "street": { "description": "Part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "Rusałka" }, "number": { "description": "House/appartment number. Also this is part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "17a" }, "postCode": { "description": "Postal code of city. Also this is part of address on which card will be send
No special characters, no more than 27 characters", "type": "string", "example": "20-123" }, "state": { "description": "Optional state. Also this is part of address on which card will be send", "type": "string", "example": "Manchester" }, "country": { "description": "ISO 3166-1 alfa-3", "type": "string", "example": "POL" }, "balanceId": { "description": "Identifier of balance to which card will be attached", "type": "string", "example": "e31b76e0-21df-11ed-861d-0242ac120002" }, "pin": { "description": "Card PIN", "type": "string", "example": "4242" }, "configId": { "description": "Card configuration identifier. Could be obtained from 'GET /customers/me/cards/config'", "type": "string", "example": "0013009713" }, "visualId": { "description": "Optional card visualId", "type": "integer", "example": "17" }, "deliveryType": { "description": "Optional delivery type", "type": "string", "example": "1" }, "phone": { "description": "Phone number should be provided as local to the given delivery country. Remember to include prefix.", "type": "string", "example": "48500123123" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "enum": [ "INVALID_FIRST_NAME", "INVALID_LAST_NAME", "INVALID_CITY", "INVALID_STREET", "INVALID_NUMBER", "INVALID_POST_CODE", "INVALID_COUNTRY", "INVALID_BALANCE_ID", "CANNOT_MATCH_CONFIGURATION", "INVALID_PIN" ], "example": "INVALID_FIRST_NAME" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/orders/{id}": { "get": { "tags": [ "Secure - Cards" ], "summary": "Get single physical card order. This method allows to check order progress.", "operationId": "318ebdc02a76bceadc8c4edeb52bbdd6", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of card order operation", "required": true, "schema": { "type": "string", "format": "uuid", "example": "39927556-7848-4dff-a0d2-24c23915bfa9" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "description": "Identifier of card order operation", "type": "string", "format": "uuid", "example": "39927556-7848-4dff-a0d2-24c23915bfa9" }, "dcCardId": { "description": "DataCore card id. Null when ordered card is not created yet.", "type": "integer", "example": "1125" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/cards/{id}/shares": { "patch": { "tags": [ "Secure - Cards" ], "summary": "Share card with another user", "operationId": "dd1f4ea9a0d6ce318a2fe547e6685b12", "parameters": [ { "name": "id", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "dcUserId": { "description": "DataCore user id", "type": "string", "example": "133" } }, "type": "object" } } } }, "responses": { "204": { "description": "Card user updated successfully" }, "403": { "description": "Forbidden - target user does not belong to the card corporation", "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string", "example": "FORBIDDEN" }, "detail": { "type": "string", "example": "Target user does not belong to the card corporation." }, "title": { "type": "string", "example": "FORBIDDEN" } }, "type": "object" } } } }, "404": { "description": "Card not found", "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string", "example": "CARD_NOT_FOUND" }, "detail": { "type": "string", "example": "Card not found." }, "title": { "type": "string", "example": "CARD_NOT_FOUND" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}/cards/{cardId}/unlock": { "post": { "tags": [ "Secure - Customer Cards" ], "summary": "Unlock customer's card.", "description": "\nMethod unlocks prepaid card. Card is also unlocked in tutuka system (card issuer) and DataCore (card storage).\n", "operationId": "4bc0bfc93889f41c682f8acd67b897ed", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": 1125 } }, { "name": "cardId", "in": "path", "description": "DataCore card id", "required": true, "schema": { "type": "integer", "example": 1125 } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "note": { "description": "A note / reason about unstopping the card", "type": "string", "example": "Some note about unstopping the card" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCard": { "$ref": "#/components/examples/InvalidCard" }, "UnlockCardFailure": { "$ref": "#/components/examples/UnlockCardFailure" }, "CardIssuerError": { "$ref": "#/components/examples/CardIssuerError" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Validation status", "type": "string", "example": "INVALID_NOTE" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/corporations": { "post": { "tags": [ "Secure - Corporations" ], "summary": "Create new corporation", "description": "This method allows you to create new corporation admin", "operationId": "createNewCorporation-Secure", "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "customerId": { "description": "User id from DataCore", "type": "integer", "example": "1337" }, "firstName": { "description": "First name of corporation", "type": "string", "example": "Elon" }, "lastName": { "description": "Last name of corporation", "type": "string", "example": "Musk" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "example": "1337" } }, "type": "object" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "VerificationAlreadyExist": { "$ref": "#/components/examples/VerificationAlreadyExist" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "FieldIsRequired": { "$ref": "#/components/examples/FieldIsRequired" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "INTERNAL_SERVER_ERROR" } }, "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/corporations/{id}/cards/{cardId}": { "get": { "tags": [ "Secure - Corporation Cards" ], "summary": "Get corporation card details", "description": "Returns details of a single card belonging to the specified corporation.", "operationId": "db132675d850a1906406caacf507b05a", "parameters": [ { "name": "id", "in": "path", "description": "Corporation identifier", "required": true, "schema": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440001" } }, { "name": "cardId", "in": "path", "description": "DataCore card identifier (dcId)", "required": true, "schema": { "type": "integer", "example": "99001" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "description": "DC card id", "type": "integer", "example": 99001 }, "type": { "description": "Card type", "type": "string", "enum": [ "virtual", "physical" ], "example": "virtual" }, "balanceId": { "description": "UUID of the associated balance", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000", "nullable": true }, "exp": { "description": "Card expiration date. Format: Y-m-t (last day of month)", "type": "string", "format": "date", "example": "2026-03-31" }, "issuerCardId": { "description": "Card identifier at the issuer", "type": "string", "example": "ISS-99001" }, "dcUserId": { "description": "DC user id of the card owner", "type": "integer", "example": 12345, "nullable": true }, "dcCorporationId": { "description": "Corporation UUID", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440001", "nullable": true }, "cardHolder": { "description": "Card holder identifier", "type": "string", "example": null, "nullable": true } }, "type": "object" } } } }, "404": { "description": "Card not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CardNotFound": { "$ref": "#/components/examples/CardNotFound" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers_due_diligence": { "post": { "tags": [ "Secure - Customers Due Diligence" ], "summary": "Add new cdd record", "description": "[Due diligence] Confirm given customer was checked against given list by given person on given date.", "operationId": "d40e8fcb3713ad98f1560e118d70261f", "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "verificationId": { "description": "Checked who", "type": "string", "example": "5a5b253b-ac14-4566-a89f-8c5d26544c4e" }, "listName": { "description": "Checked where", "type": "string", "example": "known-list-published-on-1997-04-02-by-ACME" }, "sourceName": { "description": "Checked by whom", "type": "string", "example": "NAoP" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCdd": { "$ref": "#/components/examples/InvalidCdd" } } } } }, "500": { "description": "Server failed to store data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalServerError": { "$ref": "#/components/examples/InternalServerError" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}": { "get": { "tags": [ "Secure - Customer" ], "summary": "Get customer details including address", "operationId": "e99eb2aa5491039164d4100c3815b2ff", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResource" } } } }, "404": { "description": "CUSTOMER_NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "CUSTOMER_NOT_FOUND" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/upload": { "post": { "tags": [ "Secure - Documents" ], "summary": "Upload document", "description": "Method upload document and return file path", "operationId": "99cb472c38d2a4d7dc151e4e928665da", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "document" ], "properties": { "document": { "description": "Document, allowed formats: jpeg, jpg, png, pdf. Maximum file size - 2MB", "type": "string", "format": "binary" } }, "type": "object" }, "encoding": "form-data" } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "path": { "type": "string", "example": "vfBQAtG4uXIWMtTtYYRxvLhP6AaFuCY9nhUzaN1s.pdf" } }, "type": "object" } } } } } } }, "/secure/locks": { "post": { "tags": [ "Secure - Locks" ], "summary": "Create resource lock", "description": "Allows to add resource lock.", "operationId": "b74abd872103149c384ba3b92ccf6529", "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "resourceType": { "description": "Type of resource to be locked", "type": "string", "enum": [ "customer", "corporation", "verification" ], "example": "customer" }, "resourceId": { "description": "Resource identifier (verificationId when resourceType=verification)", "type": "string", "example": "1337" }, "reason": { "description": "reason of resource lock", "type": "string", "enum": [ "DOCUMENT_EXPIRED", "FRAUD_SUSPECTED", "SCREENING_DETECTED", "TEMPORARY_LOCKED", "PEKAO_LOCK", "ZEN_LOCK", "PROSECUTOR_LOCK", "FENIGE_LOCK", "POLICE_LOCK", "MANY_CARDS_LOCK", "NEGATIVE_VERIFICATION", "PRADO_VERIFICATION" ], "example": "DOCUMENT_EXPIRED" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LockResource" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "ResourceNotFound": { "$ref": "#/components/examples/ResourceNotFound" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidResourceType": { "$ref": "#/components/examples/InvalidResourceType" }, "InvalidResourceId": { "$ref": "#/components/examples/InvalidResourceId" }, "InvalidReason": { "$ref": "#/components/examples/InvalidReason" } } } } } } } }, "/secure/locks/{resourceId}": { "delete": { "tags": [ "Secure - Locks" ], "summary": "Remove resource lock", "description": "Allows to remove resource lock.", "operationId": "de280679843a1679bb5d74ef44bc56a6", "parameters": [ { "name": "resourceId", "in": "path", "description": "Customer id or verification id", "required": true, "schema": { "type": "string" } }, { "name": "resourceType", "in": "query", "description": "Resource type. If omitted, resourceId is treated as customer id.", "required": false, "schema": { "type": "string", "enum": [ "customer", "verification" ] } } ], "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "ResourceNotFound": { "$ref": "#/components/examples/ResourceNotFound" } } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidLockTypeException": { "$ref": "#/components/examples/InvalidLockTypeException" }, "NoActiveDocumentException": { "$ref": "#/components/examples/NoActiveDocumentException" }, "LockNotFound": { "$ref": "#/components/examples/ResourceNotFound" } } } } } } } }, "/secure/report/financial-institution": { "get": { "tags": [ "Secure - Financial Institution report" ], "summary": "Retrieve financial institution transactions report", "description": "Exports a list of successful transactions that were sent to the financial institution and resulted in a balance debit. Filtered by the date the notification was delivered to the financial institution.\n## Security\nROLE_REPORT_TRANSACTION is required to access this method", "operationId": "3b2034ad0a87ad5b5e64f81332ce2738", "parameters": [ { "name": "format", "in": "query", "description": "Report file format. Default is csv", "required": false, "schema": { "type": "string", "enum": [ "json", "csv" ], "example": "csv" } }, { "name": "from", "in": "query", "description": "Filter by delivered date. Get transactions delivered after specified date. Minimal value is three months back from TO date. Allowed format: Y-m-d H:i:s", "required": true, "schema": { "type": "string", "example": "2025-01-01 00:00:00" } }, { "name": "to", "in": "query", "description": "Filter by delivered date. Get transactions delivered before specified date. Allowed format: Y-m-d H:i:s", "required": true, "schema": { "type": "string", "example": "2025-01-31 23:59:59" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportedReport" } } } } } } }, "/secure/report/transactions": { "get": { "tags": [ "Secure - Transactions report" ], "summary": "Retrive transactions report file", "description": "Allows to export list of transactions. Query filters are allowed to narrow down results.\n## Security\nROLE_REPORT_TRANSACTION is required to access this method", "operationId": "e22805c31753e5fc74c7e1827febf35f", "parameters": [ { "name": "format", "in": "query", "description": "Report file format. Default is csv", "required": false, "schema": { "type": "string", "enum": [ "json", "csv" ], "example": "csv" } }, { "name": "from", "in": "query", "description": "Filter by transaction date. Get transactions performed after specified date. Minimal value is three months back from TO date. Allowed format: Y-m-d H:i:s", "required": true, "schema": { "type": "string", "format": "date", "example": "2020-01-01 12:00:00" } }, { "name": "to", "in": "query", "description": "Filter by transaction date. Get transactions performed before specified date. Allowed format: Y-m-d H:i:s", "required": true, "schema": { "type": "string", "format": "date", "example": "2020-01-01 12:30:00" } }, { "name": "cardId", "in": "query", "description": "Filter by DataCore card id", "required": false, "schema": { "type": "int", "example": "7" } }, { "name": "configId", "in": "query", "description": "Filter by configuration identifier (can be obtained from method: /customers/me/cards/config).", "required": false, "schema": { "type": "string", "example": "0013009713" } }, { "name": "customerId", "in": "query", "description": "Filter by DataCore user id", "required": false, "schema": { "type": "int", "example": "10181" } }, { "name": "eventType", "in": "query", "description": "Filter by transaction event type", "required": false, "schema": { "type": "string", "enum": [ "Deduct", "DeductAdjustment", "LoadAdjustment" ], "example": "Deduct" } }, { "name": "type", "in": "query", "description": "Filter by transaction type", "required": false, "schema": { "type": "string", "enum": [ "cashback", "commission", "creditIbanTransfer", "fee", "funding", "interest", "loan", "payment", "topUp", "withdrawal", "companyCredit", "companyDebit", "collateralCredit", "collateralDebit", "collateralForcedDebit", "ibanTechnicalCredit", "ibanTechnicalDebit", "forexDebit", "forexCredit", "interchangeDebit", "interchangeCredit" ], "example": "fee" } }, { "name": "status", "in": "query", "description": "Filter by status of transaction", "required": false, "schema": { "type": "string", "enum": [ "AUTHORIZED", "CLEARED", "REVERSED", "ERROR" ], "example": "AUTHORIZED" } }, { "name": "balanceId", "in": "query", "description": "Filter by balanceId", "required": false, "schema": { "type": "string", "example": "f7285bb5-b7f2-4478-b3b9-f6fb4cddd9b6" } }, { "name": "onlyCleared", "in": "query", "description": "Filter by only cleared transactions", "required": false, "schema": { "type": "boolean", "format": "boolean" } }, { "name": "sort", "in": "query", "description": "Field to order list by. Transactions are ordered by id by default.", "required": false, "schema": { "type": "string", "enum": [ "transactionDate", "clearingOrder" ] } }, { "name": "order", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportedReport" } } } } } } }, "/secure/transactions/batch": { "post": { "tags": [ "Secure - Transactions" ], "summary": "Create a batch of transactions", "description": "Executes a batch of transactions (currently limited to 2), in the exact order they are provided in the request.\n\n## Content Negotiation\nThis endpoint supports content negotiation through the Accept header:\n- `application/json`: Returns standard response with transaction ID only\n- `application/vnd.aml.v1+json`: Returns extended response with AML verification data\n\n## Caution\nThe operation is atomic: if any transaction within the batch fails, none of the transactions will be executed.", "operationId": "92b9de861c905343d70d2849b9da9199", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "schema": { "type": "string", "example": "a00ca5ef-c0c1-48c2-a147-6300f66dc6c8" } }, { "name": "Accept", "in": "header", "description": "Media type(s) that is/are acceptable for the response", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/vnd.aml.v1+json" ], "example": "application/vnd.aml.v1+json" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "transactions": { "type": "array", "items": { "required": [ "amount", "currency", "transactionType", "resource", "resourceId" ], "properties": { "transactionId": { "description": "Transaction unique identifier (optional)", "type": "string", "example": "f4f98e6b-2241-4780-827a-42f219e5b36c" }, "amount": { "description": "Value of transaction in minor units", "type": "integer", "example": 10000 }, "currency": { "description": "Valid three letter ISO 4217 currency code", "type": "string", "example": "EUR" }, "description": { "description": "Description (optional)", "type": "string", "example": "credit transaction" }, "transactionType": { "description": "Type of transaction", "type": "string", "enum": [ "commission", "fee", "funding", "interest", "withdrawal", "collateralDebit", "collateralForcedDebit", "cashback", "creditIbanTransfer", "loan", "payment", "topUp", "collateralCredit", "ibanTechnicalCredit" ], "example": "payment" }, "resource": { "description": "Resource name related for increase balance an account", "type": "string", "enum": [ "card", "balance", "ibanTechnicalBalance" ], "example": "balance" }, "resourceId": { "description": "ID of the resource (e.g. balance ID or card ID)", "type": "string", "example": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86" }, "referenceTransactionId": { "description": "Reference transactionId (optional)", "type": "string", "example": "207cda94-8d10-4e0f-a341-239d5cf3b5df" } }, "type": "object" } } }, "type": "object", "example": { "transactions": [ { "transactionId": "f4f98e6b-2241-4780-827a-42f219e5b36c", "amount": 10000, "currency": "EUR", "description": "credit transaction", "transactionType": "payment", "resource": "balance", "resourceId": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86", "referenceTransactionId": "207cda94-8d10-4e0f-a341-239d5cf3b5df" }, { "transactionId": "10a92285-e734-4122-8eff-3c3abb42933b", "amount": 10000, "currency": "EUR", "description": "debit transaction", "transactionType": "funding", "resource": "balance", "resourceId": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86", "referenceTransactionId": "9405cb31-94ec-4b7a-b1fc-ee026a42f0c0" } ] } } } } }, "responses": { "201": { "description": "Successful operation", "headers": { "Content-Type": { "description": "Response content type based on Accept header", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "description": "Standard response (Accept: application/json)", "type": "array", "items": { "properties": { "id": { "type": "string", "example": "uuid-transaction-id" }, "type": { "type": "string", "enum": [ "credit", "debit" ], "example": "credit" } }, "type": "object" } }, { "description": "AML v1 response (Accept: application/vnd.aml.v1+json)", "type": "array", "items": { "properties": { "id": { "type": "string", "example": "uuid-transaction-id" }, "type": { "type": "string", "enum": [ "credit", "debit" ], "example": "credit" }, "amlVerification": { "properties": { "verificationId": { "type": "string", "example": "aml-verification-123" }, "result": { "type": "string", "example": "PASSED" }, "actions": { "type": "array", "items": { "type": "string" }, "example": [ "MONITOR", "REVIEW" ] } }, "type": "object" } }, "type": "object" } } ] } } } }, "406": { "description": "Not Acceptable - Unsupported Accept header", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Not Acceptable" }, "message": { "type": "string", "example": "Supported media types: application/json, application/vnd.aml.v1+json" } }, "type": "object" } } } }, "409": { "description": "Transaction Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InsufficientFunds": { "$ref": "#/components/examples/InsufficientFunds" }, "CardLimitExceeded": { "$ref": "#/components/examples/CardLimitExceeded" }, "CurrencyDifferenceError": { "$ref": "#/components/examples/CurrencyDifferenceError" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" }, "InvalidAmount": { "$ref": "#/components/examples/InvalidAmount" }, "InvalidTransactionType": { "$ref": "#/components/examples/InvalidTransactionType" }, "InvalidDescription": { "$ref": "#/components/examples/InvalidDescription" }, "InvalidResourceId": { "$ref": "#/components/examples/InvalidResourceId" }, "InvalidTransactionId": { "$ref": "#/components/examples/InvalidTransactionId" } } } } } }, "deprecated": true } }, "/secure/transactions/clear_authorization": { "post": { "tags": [ "Secure - Transactions" ], "summary": "Method to clear authorized transaction by ID", "operationId": "99a6fedaf6fd7d6df5248859a23f6c55", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "schema": { "type": "string", "example": "a00ca5ef-c0c1-48c2-a147-6300f66dc6c8" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "transactionId": { "description": "TransactionId", "type": "string", "example": "3aea9c27-d30f-4b25-8482-39a3ee6abc53" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "TransactionNotFound": { "$ref": "#/components/examples/TransactionNotFound" } } } } }, "409": { "description": "Transaction Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InsufficientFunds": { "$ref": "#/components/examples/TransactionAlreadyCleared" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidTransactionId": { "$ref": "#/components/examples/InvalidTransactionId" } } } } } } } }, "/secure/transactions/credit": { "post": { "tags": [ "Secure - Transactions" ], "summary": "Method to credit customer balance", "description": "Method made credit transaction on customer balance and saving it on transaction list of customer transactions. Also allows to make transactions on security account which arent visible on customer transaction list.\n\n## Content Negotiation\nThis endpoint supports content negotiation through the Accept header:\n- `application/json`: Returns standard response with transaction ID only\n- `application/vnd.aml.v1+json`: Returns extended response with AML verification data\n\n
The following example is provided for the default configuration", "operationId": "846f5695fcc5f7939b38d1c32c382771", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "schema": { "type": "string", "example": "a00ca5ef-c0c1-48c2-a147-6300f66dc6c8" } }, { "name": "Accept", "in": "header", "description": "Media type(s) that is/are acceptable for the response", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/vnd.aml.v1+json" ], "example": "application/vnd.aml.v1+json" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "required": [ "transactionType", "amount", "resource", "resourceId", "currency" ], "properties": { "transactionType": { "description": "Type of credit transaction [topUp]", "type": "string", "enum": [ "cashback", "creditIbanTransfer", "loan", "payment", "topUp", "collateralCredit", "ibanTechnicalCredit" ], "example": "topUp" }, "transactionId": { "description": "Identifier of the transaction sent by the API client. This may not be a unique value.", "type": "string", "example": "3aea9c27-d30f-4b25-8482-39a3ee6abc53" }, "amount": { "description": "Value of transaction in minor value", "type": "integer", "example": "1234" }, "currency": { "description": "Valid three letter ISO 4217 currency code.", "type": "string", "example": "PLN" }, "description": { "description": "Description of transaction", "type": "string", "example": "Card transaction *1234 of 24.12.2024" }, "resource": { "description": "Resource name related for increase balance an account [card or balance]", "type": "string", "enum": [ "card", "balance", "creditBalance", "depositBalance", "ibanTechnicalBalance" ], "example": "balance" }, "resourceId": { "description": "Card Id or Balance Id", "type": "string", "example": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86" }, "referenceTransactionId": { "description": "Reference transactionId", "type": "string", "example": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86" }, "transactionCustomData": { "description": "Additional data about transaction", "type": "string", "example": "XYZ:123", "nullable": "true" }, "customData": { "description": "Additional custom data about transaction", "properties": { "key1": { "description": "Custom data about transaction", "type": "string", "example": "some value-123", "nullable": "true" } }, "type": "object" }, "contrahent": { "description": "Contrahent data", "properties": { "name": { "description": "Contrahent name", "type": "string", "example": "John Smith" }, "iban": { "description": "Contrahent iban number", "type": "string", "example": "PL12109024027243667461166868" }, "bic": { "description": "Contrahent bic code", "type": "string", "example": "BPKOPLPW" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful operation", "headers": { "Content-Type": { "description": "Response content type based on Accept header", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "description": "Standard response (Accept: application/json)", "properties": { "id": { "type": "string", "example": "uuid-transaction-id" } }, "type": "object" }, { "description": "AML v1 response (Accept: application/vnd.aml.v1+json)", "properties": { "id": { "type": "string", "example": "uuid-transaction-id" }, "amlVerification": { "properties": { "verificationId": { "type": "string", "example": "aml-verification-123" }, "result": { "type": "string", "example": "PASSED" }, "actions": { "type": "array", "items": { "type": "string" }, "example": [ "MONITOR", "REVIEW" ] } }, "type": "object" } }, "type": "object" } ] } } } }, "406": { "description": "Not Acceptable - Unsupported Accept header", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Not Acceptable" }, "message": { "type": "string", "example": "Supported media types: application/json, application/vnd.aml.v1+json" } }, "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" }, "ResourceNotFound": { "$ref": "#/components/examples/ResourceNotFound" } } } } }, "409": { "description": "Transaction Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InsufficientFunds": { "$ref": "#/components/examples/InsufficientFunds" }, "CardLimitExceeded": { "$ref": "#/components/examples/CardLimitExceeded" }, "CurrencyDifferenceError": { "$ref": "#/components/examples/CurrencyDifferenceError" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" }, "InvalidAmount": { "$ref": "#/components/examples/InvalidAmount" }, "InvalidTransactionType": { "$ref": "#/components/examples/InvalidTransactionType" }, "InvalidDescription": { "$ref": "#/components/examples/InvalidDescription" }, "InvalidResource": { "$ref": "#/components/examples/InvalidResource" }, "InvalidTransactionId": { "$ref": "#/components/examples/InvalidTransactionId" }, "InvalidContrahentData": { "$ref": "#/components/examples/InvalidContrahentData" } } } } } } } }, "/secure/transactions/debit": { "post": { "tags": [ "Secure - Transactions" ], "summary": "Method to charge customer balance", "description": "Method made debit transaction on customer balance and saving it on transaction list of customer transactions. Also allows to make transactions on security account which arent visible on customer transaction list.\n\n## Content Negotiation\nThis endpoint supports content negotiation through the Accept header:\n- `application/json`: Returns standard response with transaction ID only\n- `application/vnd.aml.v1+json`: Returns extended response with AML verification data\n\n
The following example is provided for the default configuration", "operationId": "de1532e1eea4923616837250ab548655", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "schema": { "type": "string", "example": "a00ca5ef-c0c1-48c2-a147-6300f66dc6c8" } }, { "name": "Accept", "in": "header", "description": "Media type(s) that is/are acceptable for the response", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/vnd.aml.v1+json" ], "example": "application/vnd.aml.v1+json" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "required": [ "transactionType", "amount", "resource", "resourceId", "currency" ], "properties": { "transactionType": { "description": "Type of debit transaction [fee]", "type": "string", "enum": [ "commission", "fee", "funding", "interest", "withdrawal", "collateralDebit", "collateralForcedDebit" ], "example": "fee" }, "transactionId": { "description": "Identifier of the transaction sent by the API client. This may not be a unique value.", "type": "string", "example": "3aea9c27-d30f-4b25-8482-39a3ee6abc53" }, "amount": { "description": "Value of transaction in minor value", "type": "integer", "example": "1234" }, "currency": { "description": "Valid three letter ISO 4217 currency code.", "type": "string", "example": "PLN" }, "description": { "description": "Description of transaction", "type": "string", "example": "Card transaction *1234 of 24.12.2024" }, "resource": { "description": "Resource name related for charge balance an account", "type": "string", "enum": [ "card", "balance", "ibanTechnicalBalance" ], "example": "balance" }, "resourceId": { "description": "Card Id or Balance Id", "type": "string", "example": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86" }, "referenceTransactionId": { "description": "Reference transactionId", "type": "string", "example": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86" }, "transactionCustomData": { "description": "Additional data about transaction", "type": "string", "example": "XYZ:123", "nullable": "true" }, "customData": { "description": "Additional custom data about transaction", "properties": { "key1": { "description": "Custom data about transaction", "type": "string", "example": "some value-123", "nullable": "true" } }, "type": "object" }, "contrahent": { "description": "Contrahent data", "properties": { "name": { "description": "Contrahent name", "type": "string", "example": "John Smith" }, "iban": { "description": "Contrahent iban number", "type": "string", "example": "PL12109024027243667461166868" }, "bic": { "description": "Contrahent bic code", "type": "string", "example": "BPKOPLPW" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful operation", "headers": { "Content-Type": { "description": "Response content type based on Accept header", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "description": "Standard response (Accept: application/json)", "properties": { "id": { "type": "string", "example": "uuid-transaction-id" } }, "type": "object" }, { "description": "AML v1 response (Accept: application/vnd.aml.v1+json)", "properties": { "id": { "type": "string", "example": "uuid-transaction-id" }, "amlVerification": { "properties": { "verificationId": { "type": "string", "example": "aml-verification-123" }, "result": { "type": "string", "example": "PASSED" }, "actions": { "type": "array", "items": { "type": "string" }, "example": [ "MONITOR", "REVIEW" ] } }, "type": "object" } }, "type": "object" } ] } } } }, "406": { "description": "Not Acceptable - Unsupported Accept header", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Not Acceptable" }, "message": { "type": "string", "example": "Supported media types: application/json, application/vnd.aml.v1+json" } }, "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" }, "ResourceNotFound": { "$ref": "#/components/examples/ResourceNotFound" } } } } }, "409": { "description": "Transaction Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InsufficientFunds": { "$ref": "#/components/examples/InsufficientFunds" }, "CardLimitExceeded": { "$ref": "#/components/examples/CardLimitExceeded" }, "CurrencyDifferenceError": { "$ref": "#/components/examples/CurrencyDifferenceError" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" }, "InvalidAmount": { "$ref": "#/components/examples/InvalidAmount" }, "InvalidTransactionType": { "$ref": "#/components/examples/InvalidTransactionType" }, "InvalidDescription": { "$ref": "#/components/examples/InvalidDescription" }, "InvalidResource": { "$ref": "#/components/examples/InvalidResource" }, "InvalidTransactionId": { "$ref": "#/components/examples/InvalidTransactionId" }, "InvalidContrahentData": { "$ref": "#/components/examples/InvalidContrahentData" } } } } } } } }, "/secure/transactions/{transactionId}": { "get": { "tags": [ "Secure - Transactions" ], "summary": "Retrive transaction details", "description": "Allows to get details of transaction and all coresponding transactionEvents.", "operationId": "b6013868d98329571971eeb438080b11", "parameters": [ { "name": "transactionId", "in": "path", "description": "Transaction internal identifier", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5a5b253b-ac14-4566-a89f-8c5d26544c4e" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetails" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "TransactionNotFound": { "$ref": "#/components/examples/TransactionNotFound" } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] }, "patch": { "tags": [ "Secure - Transactions" ], "summary": "Update transaction", "description": "This method allows you to update transaction. By updating transaction status you may change it's state\nto cleared or reversed.\n", "operationId": "58488f49562bcb8a6b034b0b0cab8d90", "parameters": [ { "name": "transactionId", "in": "path", "description": "transaction id", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "properties": { "status": { "description": "Transaction status (base status is AUTHORIZED, you may change it to CLEARED/REVERSED)", "type": "string", "example": "CLEARED" } }, "type": "object" } } } }, "responses": { "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidStatus": { "$ref": "#/components/examples/InvalidStatus" } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "TransactionNotFound": { "$ref": "#/components/examples/TransactionNotFound" } } } } }, "204": { "description": "Transaction updated." }, "202": { "description": "Request accepted but will be processed later." } } } }, "/secure/transactions": { "get": { "tags": [ "Secure - Transactions" ], "summary": "Retrive list of transactions", "description": "Allows to get paginated list of transactions. Query filters are allowed to narrow down results. If **from** parameter is not provided, transactions from today's date will be displayed by default.", "operationId": "ac8b9b4a9177f952bf21c654267882b3", "parameters": [ { "name": "from", "in": "query", "description": "Filter by transaction date. Get transactions performed after specified date. **If this parameter is not provided, transactions from today's date will be displayed by default.** Allowed format: Y-m-d H:i:s", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-01-01 12:00:00" } }, { "name": "to", "in": "query", "description": "Filter by transaction date. Get transactions performed before specified date. Allowed format: Y-m-d H:i:s", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-01-01 12:30:00" } }, { "name": "cardId", "in": "query", "description": "Filter by DataCore card id", "required": false, "schema": { "type": "int", "example": "7" } }, { "name": "configId", "in": "query", "description": "Filter by configuration identifier (can be obtained from method: /customers/me/cards/config).", "required": false, "schema": { "type": "string", "example": "0013009713" } }, { "name": "externalId", "in": "query", "description": "Transaction external id.", "required": false, "schema": { "type": "string", "example": "53929234022" } }, { "name": "customerId", "in": "query", "description": "Filter by DataCore user id", "required": false, "schema": { "type": "int", "example": "10181" } }, { "name": "eventType", "in": "query", "description": "Filter by transaction type", "required": false, "schema": { "type": "string", "enum": [ "Deduct", "DeductAdjustment", "LoadAdjustment", "credit", "debit" ], "example": "Deduct" } }, { "name": "status", "in": "query", "description": "Filter by status of transaction", "required": false, "schema": { "type": "string", "enum": [ "AUTHORIZED", "CLEARED", "REVERSED" ], "example": "AUTHORIZED" } }, { "name": "balanceId", "in": "query", "description": "Filter by balanceId", "required": false, "schema": { "type": "string", "example": "f7285bb5-b7f2-4478-b3b9-f6fb4cddd9b6" } }, { "name": "currency", "in": "query", "description": "Currency in 3 letter ISO-4217", "schema": { "type": "string", "example": "PLN" } }, { "name": "amount", "in": "query", "description": "Transaction amount", "required": false, "schema": { "type": "int", "example": 100 } }, { "name": "merchantName", "in": "query", "description": "Merchant name", "required": false, "schema": { "type": "string", "example": "Stonka" } }, { "name": "sort", "in": "query", "description": "Field to order list by. Transactions are ordered by id by default.", "required": false, "schema": { "type": "string", "enum": [ "transactionDate" ] } }, { "name": "order", "in": "query", "description": "Sorting order", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "limit", "in": "query", "description": "Limit of transactions returned in a single chunk can be specified.", "required": false, "schema": { "type": "int", "example": 20 } }, { "name": "page", "in": "query", "description": "Page of paginated list", "required": false, "schema": { "type": "int", "example": 3 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionCollection" } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DateFormatIsInvalid": { "$ref": "#/components/examples/DateFormatIsInvalid" }, "ValueHasToBeString": { "summary": "VALUE_HAS_TO_BE_STRING", "value": { "status": "VALUE_HAS_TO_BE_STRING" } }, "ValueMustBeIntegerType": { "summary": "VALUE_MUST_BE_INTEGER_TYPE", "value": { "status": "VALUE_MUST_BE_INTEGER_TYPE" } }, "ValueIsNotAllowed": { "summary": "VALUE_IS_NOT_ALLOWED", "value": { "status": "VALUE_IS_NOT_ALLOWED" } } } } } } } } }, "/secure/transactions/transfer": { "post": { "tags": [ "Secure - Transactions" ], "summary": "Method to create transfer transaction", "description": "Method makes transfer transaction on balance found by given resource.\n\n## Content Negotiation\nThis endpoint supports content negotiation through the Accept header:\n- `application/json`: Returns standard response with transaction ID only\n- `application/vnd.aml.v1+json`: Returns extended response with AML verification data\n\n
The following example is provided for the default configuration", "operationId": "9b62148f1c4c2a00f161bbe678f47cce", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "schema": { "type": "string", "example": "a00ca5ef-c0c1-48c2-a147-6300f66dc6c8" } }, { "name": "Accept", "in": "header", "description": "Media type(s) that is/are acceptable for the response", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/vnd.aml.v1+json" ], "example": "application/vnd.aml.v1+json" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "application/json": { "schema": { "required": [ "amount" ], "properties": { "transactionId": { "description": "TransactionId", "type": "string", "example": "3aea9c27-d30f-4b25-8482-39a3ee6abc53", "deprecated": "true" }, "transferId": { "description": "Identifier of the transaction transfer", "type": "string", "example": "3aea9c27-d30f-4b25-8482-39a3ee6abc53" }, "amount": { "description": "Value of transaction in minor value", "type": "integer", "example": "1234" }, "currency": { "description": "Valid three letter ISO 4217 currency code.", "type": "string", "example": "PLN" }, "description": { "description": "Description of transaction", "type": "string", "example": "Card transaction *1234 of 24.12.2024" }, "sender": { "required": [ "resource", "resourceId", "transactionType" ], "properties": { "transactionId": { "description": "Identifier of the transaction. This must be a unique value", "type": "string", "example": "3aea9c27-d30f-4b25-8482-39a3ee6abc87" }, "transactionType": { "description": "Type of sender transaction", "type": "string", "enum": [ "commission", "fee", "funding", "interest", "withdrawal", "collateralDebit", "collateralForcedDebit" ], "example": "funding" }, "resource": { "description": "Resource name related for charge balance an account]", "type": "string", "enum": [ "card", "balance", "ibanTechnicalBalance" ], "example": "balance" }, "resourceId": { "description": "Card Id or Balance Id", "type": "string", "example": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d86" }, "transactionCustomData": { "description": "Additional data about transaction", "type": "string", "example": "XYZ:123", "nullable": "true" }, "customData": { "description": "Additional custom data about transaction", "properties": { "key1": { "description": "Custom data about transaction", "type": "string", "example": "some value-123", "nullable": "true" } }, "type": "object" }, "contrahent": { "description": "Contrahent data", "properties": { "name": { "description": "Contrahent name", "type": "string", "example": "John Smith" }, "iban": { "description": "Contrahent iban number", "type": "string", "example": "PL12109024027243667461166868" }, "bic": { "description": "Contrahent bic code", "type": "string", "example": "BPKOPLPW" } }, "type": "object" } }, "type": "object" }, "receiver": { "required": [ "resource", "resourceId", "transactionType" ], "properties": { "transactionId": { "description": "Identifier of the transaction. This must be a unique value", "type": "string", "example": "3aea9c27-d30f-4b25-8482-39a3ee6abc88" }, "transactionType": { "description": "Type of receiver transaction", "type": "string", "enum": [ "cashback", "loan", "payment", "topUp", "collateralCredit" ], "example": "payment" }, "resource": { "description": "Resource name related for charge balance an account]", "type": "string", "enum": [ "card", "balance", "companyBalance", "creditBalance", "depositBalance", "ibanTechnicalBalance" ], "example": "balance" }, "resourceId": { "description": "Card Id or Balance Id", "type": "string", "example": "0cbc4f1b-92ea-4b4d-b19b-18fc0fcb6d87" }, "transactionCustomData": { "description": "Additional data about transaction", "type": "string", "example": "XYZ:123", "nullable": "true" }, "customData": { "description": "Additional custom data about transaction", "properties": { "key1": { "description": "Custom data about transaction", "type": "string", "example": "some value-123", "nullable": "true" } }, "type": "object" }, "contrahent": { "description": "Contrahent data", "properties": { "name": { "description": "Contrahent name", "type": "string", "example": "Jane Doe" }, "iban": { "description": "Contrahent iban number", "type": "string", "example": "PL121090240272436231412124" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful operation", "headers": { "Content-Type": { "description": "Response content type based on Accept header", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "description": "Standard response (Accept: application/json)", "properties": { "credit": { "type": "string", "example": "uuid-credit-id" }, "debit": { "type": "string", "example": "uuid-debit-id" } }, "type": "object" }, { "description": "AML v1 response (Accept: application/vnd.aml.v1+json)", "properties": { "credit": { "properties": { "id": { "type": "string", "example": "uuid-credit-id" }, "amlVerification": { "properties": { "verificationId": { "type": "string", "example": "aml-verification-123" }, "result": { "type": "string", "example": "PASSED" }, "actions": { "type": "array", "items": { "type": "string" }, "example": [ "MONITOR", "REVIEW" ] } }, "type": "object" } }, "type": "object" }, "debit": { "properties": { "id": { "type": "string", "example": "uuid-debit-id" }, "amlVerification": { "properties": { "verificationId": { "type": "string", "example": "aml-verification-124" }, "result": { "type": "string", "example": "PASSED" }, "actions": { "type": "array", "items": { "type": "string" }, "example": [ "MONITOR" ] } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] } } } }, "406": { "description": "Not Acceptable - Unsupported Accept header", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Not Acceptable" }, "message": { "type": "string", "example": "Supported media types: application/json, application/vnd.aml.v1+json" } }, "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" }, "ResourceNotFound": { "$ref": "#/components/examples/ResourceNotFound" } } } } }, "409": { "description": "Transaction Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InsufficientFunds": { "$ref": "#/components/examples/InsufficientFunds" }, "CardLimitExceeded": { "$ref": "#/components/examples/CardLimitExceeded" }, "CurrencyDifferenceError": { "$ref": "#/components/examples/CurrencyDifferenceError" }, "IdConflict": { "$ref": "#/components/examples/TransactionIdConflict" } } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidCurrency": { "$ref": "#/components/examples/InvalidCurrency" }, "InvalidAmount": { "$ref": "#/components/examples/InvalidAmount" }, "InvalidTransactionType": { "$ref": "#/components/examples/InvalidTransactionType" }, "InvalidDescription": { "$ref": "#/components/examples/InvalidDescription" }, "InvalidSenderResourceId": { "$ref": "#/components/examples/InvalidSenderResourceId" }, "InvalidReceiverResourceId": { "$ref": "#/components/examples/InvalidReceiverResourceId" }, "InvalidTransactionId": { "$ref": "#/components/examples/InvalidTransactionId" }, "InvalidContrahentData": { "$ref": "#/components/examples/InvalidContrahentData" } } } } } }, "deprecated": true } }, "/secure/verifications/{verificationId}/documents/{documentPath}/attach": { "post": { "tags": [ "Secure - Verification Documents" ], "summary": "Attach uploaded document to verification", "description": "Method attach uploaded document to verification and return information about document
You can use this method after uploading a document", "operationId": "a017d81925dff5438bed88afaa741a6b", "parameters": [ { "name": "verificationId", "in": "path", "description": "Uuid of verification", "required": true, "schema": { "type": "string", "example": "5a5b253b-ac14-4566-a89f-8c5d26544c4e" } }, { "name": "documentPath", "in": "path", "description": "Document path", "required": true, "schema": { "type": "string", "example": "vfBQAtG4uXIWMtTtYYRxvLhP6AaFuCY9nhUzaN1s.pdf" } } ], "requestBody": { "description": "Input data", "content": { "application/json": { "schema": { "properties": { "documentExpirationDate": { "description": "Document expiration date", "type": "string", "format": "date", "example": "2025-01-28" }, "type": { "description": "type", "type": "string", "enum": [ "idCard", "passport", "other", "proofOfAddress", "residenceCard", "paymentMethod", "sourceOfFunds", "sourceOfWealth", "registerEntry", "declaration", "video" ], "example": "other" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationDocument" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "VerificationNotFound": { "$ref": "#/components/examples/VerificationNotFound" }, "VerificationDocumentNotExist": { "$ref": "#/components/examples/VerificationDocumentNotExist" } } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "verificationDocumentAlreadyAttachedToOtherVerification": { "$ref": "#/components/examples/verificationDocumentAlreadyAttachedToOtherVerification" } } } } } } } }, "/secure/customers/{customerId}/verification": { "post": { "tags": [ "Secure - Verifications" ], "summary": "Create verification for existing customer", "description": "Use this method to create verification for an existing customer, requiring essential personal details and document uploads. It is possible to set the required fields depending on the implementation\n", "operationId": "6825a3bf57518bf6794c7a360a3db552", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "firstName", "lastName", "birthDate", "city", "street", "postCode", "country", "documentType", "imageFace", "imageFront", "identityCardNo", "documentExpirationDate", "nationality", "riskLvl", "number", "utilityBill", "phone" ], "properties": { "firstName": { "description": "First name of user for verification", "type": "string", "example": "Jane" }, "lastName": { "description": "Last name of user for verification", "type": "string", "example": "Doe" }, "birthDate": { "description": "Customer birth date in format: Y-m-d", "type": "string", "format": "date", "example": "1970-01-01" }, "city": { "description": "City of customer", "type": "string", "example": "Lublin" }, "street": { "description": "Customer street", "type": "string", "example": "Rusałka" }, "number": { "description": "Customer house number.", "type": "string", "example": "17a" }, "apartment": { "description": "Customer apartment number.", "type": "string", "example": "2" }, "postCode": { "description": "Customer post code", "type": "string", "example": "20-128" }, "country": { "description": "Alpha-2 code in ISO-3166", "type": "string", "example": "PL" }, "identityCardNo": { "description": "Number of identity card. This field is required if customer has no pesel", "type": "string", "example": "ARG691869" }, "pesel": { "description": "Customer pesel number", "type": "string", "example": "70010155587", "nullable": "true" }, "nationality": { "description": "Customer nationality. Alpha-2 code in ISO-3166", "type": "string", "example": "PL" }, "imageFace": { "description": "Customer face photo. Allowed formats: jpeg, jpg, png. Maximum file size - 2MB", "type": "string", "format": "binary" }, "imageFront": { "description": "Front photo of document passed in request. Allowed formats: jpeg, jpg, png. Maximum file size - 2MB", "type": "string", "format": "binary" }, "documentType": { "description": "Type of document passed in request. Allowed formats: passport,idCard", "type": "string", "example": "passport" }, "documentExpirationDate": { "description": "Document expiration Date", "type": "string", "format": "date", "example": "2025-01-30" }, "riskLvl": { "description": "Risk level of customer. Allowed values: HIGH, NORMAL, LOW, NOT_ACCEPTABLE", "type": "string", "example": "LOW" }, "imageBack": { "description": "Back photo of document passed in request. Required only if document type is idCard. Allowed formats: jpeg, jpg, png. Maximum file size - 2MB", "type": "string", "format": "binary" }, "utilityBill": { "description": "Utility bill document for address verification. Allowed formats: jpeg, jpg, png, pdf. Maximum file size - 2MB", "type": "string", "format": "binary" }, "usaResident": { "description": "Customer is tax resident in USA

true=1

false=0", "type": "boolean", "format": "boolean", "nullable": "true" }, "taxResident": { "description": "Client's tax residency list

exampaleRequest:

\n| Body Key | Body Value |\n|:-------------:|------:|\n| taxResident[0] | DE |", "format": "array", "nullable": "true" }, "sourceOfFunds": { "description": "\nArray of customer's funds sources:\n

business_activity: Nip (VAT number) or/and REGON (National Business Registry Number) is required when you send business_activity field

\n

salary: Profession is required when salary is send.

\n\n| SourceOfFunds | Body Key | Body Value |\n|----------|:-------------:|------:|\n| business_activity | sourceOfFunds[business_activity][0][nip] | NIP_NUMBER |\n| |sourceOfFunds[business_activity][0][regon] | REGON_NUMBER |\n| salary| sourceOfFunds[salary][0][profession] | whatever about profession |\n| other | sourceOfFunds[other][0] | some_value |\n| maintained_by_family | sourceOfFunds[maintained_by_family][0] | some_value |\n| investments | sourceOfFunds[investments][0] | some_value |\n| social_benefits | sourceOfFunds[social_benefits][0] | some_value |\n| tenancy | sourceOfFunds[tenancy][0] | some_value |\n\n", "format": "array", "nullable": "true" }, "kycLevel": { "description": "Customer KYC level.", "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "EXTENDED" ], "nullable": "true" }, "phone": { "description": "Customer phone number in E.164 format.", "type": "string", "example": "+48600123456" }, "extendedVerificationDeclaration": { "description": "Flag indicating the user declares they would like to spend more than a defined threshold.", "type": "boolean", "nullable": "true" }, "customData": { "description": "Optional object for custom verification data.

Clients can send any additional data using custom keys in camelCase notation (e.g., customerHeight, locationOfBirth).

For date values, we suggest using ISO 8601 format (e.g., 2025-12-31T23:59:59Z) or Y-m-d format (e.g., 2020-01-15).

Maximum 256 key-value pairs.

Keys must be 1-64 alphanumeric characters and contain at least one letter.

Values must be 1-512 characters.

example request:

\n | Body Key | Body Value |\n |-------------|:------:|\n | customData[locationOfBirth] | Lublin |\n | customData[customerHeight] | 180cm |\n | customData[issueDate] | 2020-01-15 |\n | customData[registrationDate] | 2024-03-15T10:30:00Z |\n | customData[nationalIdentificationNumber] | 12345678901 |\n | customData[anyOtherYouNeed] | some_value |\n ", "type": "object", "nullable": "true" } }, "type": "object" }, "encoding": "form-data" } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "description": "Verification identifier in uuid format", "type": "integer", "format": "int64", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } }, "type": "object" } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" }, "examples": { "FIELD_IS_REQUIRED": { "summary": "FIELD_IS_REQUIRED", "value": { "status": "FIELD_IS_REQUIRED", "errors": { "fieldName": [ "FIELD_IS_REQUIRED" ] } } }, "CustomerNotFound": { "$ref": "#/components/examples/CustomerNotFound" }, "CustomerAlreadyRegistered": { "$ref": "#/components/examples/CustomerAlreadyRegistered" }, "HasPendingVerifications": { "$ref": "#/components/examples/HasPendingVerifications" }, "PermanentlyLocked": { "$ref": "#/components/examples/PermanentlyLocked" }, "DateIsInvalid": { "$ref": "#/components/examples/DateIsInvalid" }, "DateFormatIsInvalid": { "$ref": "#/components/examples/DateFormatIsInvalid" }, "InvalidFileSize": { "summary": "INVALID_FILE_SIZE", "value": { "status": "INVALID_FILE_SIZE" } }, "InvalidFileFormat": { "summary": "INVALID_FILE_FORMAT", "value": { "status": "INVALID_FILE_FORMAT" } } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/customers/{customerId}/verifications/{verificationId}": { "get": { "tags": [ "Secure - Verifications" ], "summary": "Get details of verification", "description": "Method returns information about verification with all documents and reletaed customer (only if verification is accepted)", "operationId": "70850ca3c23f37598f19aa04c149f27f", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": 1125 } }, { "name": "verificationId", "in": "path", "description": "Uuid of verification", "required": true, "schema": { "type": "string", "example": "5a5b253b-ac14-4566-a89f-8c5d26544c4e" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationDetails" } } } } } } }, "/secure/customers/{customerId}/status": { "get": { "tags": [ "Secure - Customer Registration" ], "summary": "Obtain verification status secured endpoint.", "operationId": "cd18b8bc37360c4ca1546857a2a240ec", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Verification status", "type": "string", "enum": [ "rejected", "accepted", "in_progress" ], "example": "rejected" }, "reasons": { "description": "Verification status reasons", "type": "object", "example": [ "INVALID_CUSTOMER_DATA", "BLURRED_DOCUMENT_PHOTO", "INVALID_DOCUMENT_PHOTO", "BLURRED_SELFIE", "INVALID_SELFIE", "RESTRICTED_PESEL", "INCORRECT_PESEL", "UNDERAGE", "ILLEGAL_DOCUMENT", "EXPIRED_DOCUMENT", "MISSING_ENTIRE_DOCUMENT", "SELFIE_WITHOUT_DOCUMENT", "FACE_COVERED", "PAYMENT_CARD_NOT_DOCUMENT", "MISSING_DIACRITICAL_MARKS", "NON_LATIN_ALPHABET", "OUTSIDE_EEA", "ILLEGAL_EMAIL", "NOT_MATCH_PREFIX" ] } }, "type": "object" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Cant find verification for requested id", "type": "string", "example": "VERIFICATION_NOT_FOUND" } }, "type": "object" } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/verifications": { "get": { "tags": [ "Secure - Verifications" ], "summary": "Retrive list of verifications", "description": "Allows to get paginated list of verifications. Query filter are allowed along with SortBy, OrderBy", "operationId": "a53cf577e5cf0b6f1d0350a67f589b71", "parameters": [ { "name": "status", "in": "query", "description": "Status to filter by", "required": false, "schema": { "type": "string", "example": "accepted" } }, { "name": "createdAt", "in": "query", "description": "Date of customer registration registration. Allowed format Y-m-d H:i:s ", "required": false, "schema": { "type": "string", "example": "2020-01-01 12:00:00" } }, { "name": "from", "in": "query", "description": "Filter by registration date started by value. Allowed format Y-m-d H:i:s", "required": false, "schema": { "type": "string", "example": "2020-01-01 12:00:00" } }, { "name": "to", "in": "query", "description": "Filter by registration date end by value. Allowed format Y-m-d H:i:s", "required": false, "schema": { "type": "string", "example": "2020-01-01 12:00:00" } }, { "name": "customerId", "in": "query", "description": "customerId to filter by", "required": false, "schema": { "type": "int", "example": "1125" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationCollection" } } } } } } }, "/secure/customers/{customerId}/register": { "post": { "tags": [ "Secure - Customer Registration" ], "summary": "Initialize customer verification process secured endpoint.", "description": "Method is first step for customer registration. After this step, admin should accept or reject verification request\n ", "operationId": "d4796c3ab020bcfbc7a1df324a343f2d", "parameters": [ { "name": "customerId", "in": "path", "description": "DataCore user id", "required": true, "schema": { "type": "integer", "example": "1125" } } ], "requestBody": { "description": "Input data", "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "firstName", "lastName", "birthDate", "city", "street", "postCode", "country", "documentType", "imageFace", "imageFront", "utilityBill", "phone" ], "properties": { "firstName": { "description": "First name of user for verification", "type": "string", "example": "Jane" }, "lastName": { "description": "Last name of user for verification", "type": "string", "example": "Doe" }, "birthDate": { "description": "Customer birth date in format: Y-m-d", "type": "string", "format": "date", "example": "1970-01-01" }, "city": { "description": "City of custmer", "type": "string", "example": "Lublin" }, "street": { "description": "Customer street", "type": "string", "example": "Rusałka" }, "number": { "description": "Customer house number. Required only if apartment has not been sent", "type": "string", "example": "17a" }, "apartment": { "description": "Customer apartment number. Required only if number has not been sent", "type": "string", "example": "2" }, "postCode": { "description": "Customer post code", "type": "string", "example": "20-128" }, "country": { "description": "Alpha-2 code in ISO-3166", "type": "string", "example": "PL" }, "identityCardNo": { "description": "Number of identity card. This field is required if customer has no pesel", "type": "string", "example": "ARG691869", "nullable": "true" }, "pesel": { "description": "Customer pesel number", "type": "string", "example": "70010155587", "nullable": "true" }, "nationality": { "description": "Customer nationality", "type": "string", "example": "polish", "nullable": "true" }, "imageFace": { "description": "Customer face photo. Allowed formats: jpeg, jpg, png. Maximum file size - 2MB", "type": "string", "format": "binary" }, "imageFront": { "description": "Front photo of document passed in request. Allowed formats: jpeg, jpg, png. Maximum file size - 2MB", "type": "string", "format": "binary" }, "documentType": { "description": "Type of document passed in request. Allowed formats: passport,idCard", "type": "string", "enum": [ "passport", "idCard" ], "example": "passport" }, "documentExpirationDate": { "description": "Document expiration Date", "type": "string", "format": "date", "example": "2025-01-30" }, "imageBack": { "description": "Back photo of document passed in request. Required only if document type is idCard. Allowed formats: jpeg, jpg, png. Maximum file size - 2MB", "type": "string", "format": "binary" }, "utilityBill": { "description": "Utility bill document for address verification. Allowed formats: jpeg, jpg, png, pdf. Maximum file size - 2MB", "type": "string", "format": "binary" }, "usaResident": { "description": "Customer is tax resident in USA

true=1

false=0", "type": "boolean", "format": "boolean", "nullable": "true" }, "taxResident": { "description": "Client's tax residency list

exampaleRequest:

\n | Body Key | Body Value |\n |:-------------:|------:|\n | taxResident[0] | DE |", "format": "array", "nullable": "true" }, "sourceOfFunds": { "description": "\n Array of customer's funds sources:\n

business_activity: Nip (VAT number) or/and REGON (National Business Registry Number) is required when you send business_activity field

\n

salary: Profession is required when salary is send.

\n\n | SourceOfFunds | Body Key | Body Value |\n |----------|:-------------:|------:|\n | business_activity | sourceOfFunds[business_activity][0][nip] | NIP_NUMBER |\n | |sourceOfFunds[business_activity][0][regon] | REGON_NUMBER |\n | salary| sourceOfFunds[salary][0][profession] | whatever about profession |\n | other | sourceOfFunds[other][0] | some_value |\n | maintained_by_family | sourceOfFunds[maintained_by_family][0] | some_value |\n | investments | sourceOfFunds[investments][0] | some_value |\n | social_benefits | sourceOfFunds[social_benefits][0] | some_value |\n | tenancy | sourceOfFunds[tenancy][0] | some_value |\n\n ", "format": "array", "nullable": "true" }, "kycLevel": { "description": "Customer KYC level.", "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "EXTENDED" ], "nullable": "true" }, "phone": { "description": "Customer phone number in E.164 format.", "type": "string", "example": "+48600123456" }, "extendedVerificationDeclaration": { "description": "Flag indicating the user declares they would like to spend more than a defined threshold.", "type": "boolean", "nullable": "true" }, "customData": { "description": "Optional object for custom verification data.

Clients can send any additional data using custom keys in camelCase notation (e.g., customerHeight, locationOfBirth).

For date values, we suggest using ISO 8601 format (e.g., 2025-12-31T23:59:59Z) or Y-m-d format (e.g., 2020-01-15).

Maximum 256 key-value pairs.

Keys must be 1-64 alphanumeric characters and contain at least one letter.

Values must be 1-512 characters.

example request:

\n | Body Key | Body Value |\n |-------------|:------:|\n | customData[locationOfBirth] | Lublin |\n | customData[customerHeight] | 180cm |\n | customData[issueDate] | 2020-01-15 |\n | customData[registrationDate] | 2024-03-15T10:30:00Z |\n | customData[nationalIdentificationNumber] | 12345678901 |\n | customData[anyOtherYouNeed] | some_value |\n ", "type": "object", "nullable": "true" } }, "type": "object" }, "encoding": "form-data" } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "description": "Verification identifier in uuid format", "type": "integer", "format": "int64", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } }, "type": "object" } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" }, "examples": { "FIELD_IS_REQUIRED": { "summary": "FIELD_IS_REQUIRED", "value": { "status": "FIELD_IS_REQUIRED", "errors": { "fieldName": [ "FIELD_IS_REQUIRED" ] } } }, "CustomerAlreadyRegistered": { "$ref": "#/components/examples/CustomerAlreadyRegistered" }, "HasPendingVerifications": { "$ref": "#/components/examples/HasPendingVerifications" }, "PermanentlyLocked": { "$ref": "#/components/examples/PermanentlyLocked" }, "DateIsInvalid": { "$ref": "#/components/examples/DateIsInvalid" }, "DateFormatIsInvalid": { "$ref": "#/components/examples/DateFormatIsInvalid" }, "InvalidFileSize": { "summary": "INVALID_FILE_SIZE", "value": { "status": "INVALID_FILE_SIZE" } }, "InvalidFileFormat": { "summary": "INVALID_FILE_FORMAT", "value": { "status": "INVALID_FILE_FORMAT" } } } } } } }, "servers": [ { "url": "https://prepaidapi-secure.upaidtest.pl", "description": "Endpoint secured with client certificate (x509)" } ] } }, "/secure/verifications/{verificationId}": { "patch": { "tags": [ "Secure - Verifications" ], "summary": "Update customer verification", "description": "Method update customer verification", "operationId": "084e4760e37bdfbd39c1eba5805038f1", "parameters": [ { "name": "verificationId", "in": "path", "description": "Verification identifier in uuid format", "required": true, "schema": { "type": "string", "example": "3dc88ad5-7053-454b-bcb8-e067c436f17d" } } ], "requestBody": { "description": "Input data format", "content": { "application/json": { "schema": { "required": [], "properties": { "firstName": { "description": "First name of user for verification", "type": "string", "example": "Jane" }, "lastName": { "description": "Last name of user for verification", "type": "string", "example": "Doe" }, "birthDate": { "description": "Customer birth date in format: Y-m-d", "type": "string", "format": "date", "example": "1970-01-01" }, "identityCardNo": { "description": "Number of identity card. This field is required if customer has no pesel", "type": "string", "example": "ARG691869", "nullable": "true" }, "pesel": { "description": "Customer pesel number", "type": "string", "example": "70010155587", "nullable": "true" }, "riskLvl": { "description": "Risk level", "type": "string", "enum": [ "LOW", "NORMAL", "HIGH", "NOT_ACCEPTABLE" ], "example": "NORMAL" }, "nationality": { "description": "Customer nationality", "type": "string", "example": "polish", "nullable": "true" }, "city": { "description": "City of custmer", "type": "string", "example": "Lublin" }, "street": { "description": "Customer street", "type": "integer", "example": "Rusałka" }, "number": { "description": "Customer house number. Required only if apartment has not been sent", "type": "string", "example": "17a" }, "apartment": { "description": "Customer apartment number. Required only if number has not been sent", "type": "string", "example": "2" }, "postCode": { "description": "Customer post code", "type": "string", "example": "20-128" }, "country": { "description": "Alpha-2 code in ISO-3166", "type": "string", "example": "PL" }, "usaResident": { "description": "Customer is tax resident in USA

true=1

false=0", "type": "boolean", "format": "boolean", "nullable": "true" }, "taxResident": { "description": "Client's tax residency list

exampaleRequest:

\n * | Body Key | Body Value |\n * |:-------------:|------:|\n * | taxResident[0] | DE |", "format": "array", "nullable": "true" }, "sourceOfFunds": { "description": "\n * Array of customer's funds sources:\n *

business_activity: Nip (VAT number) or/and REGON (National Business Registry Number) is required when you send business_activity field

\n *

salary: Profession is required when salary is send.

\n *\n * | SourceOfFunds | Body Key | Body Value |\n * |----------|:-------------:|------:|\n * | business_activity | sourceOfFunds[business_activity][0][nip] | NIP_NUMBER |\n * | |sourceOfFunds[business_activity][0][regon] | REGON_NUMBER |\n * | salary| sourceOfFunds[salary][0][profession] | whatever about profession |\n * | other | sourceOfFunds[other][0] | some_value |\n * | maintained_by_family | sourceOfFunds[maintained_by_family][0] | some_value |\n * | investments | sourceOfFunds[investments][0] | some_value |\n * | social_benefits | sourceOfFunds[social_benefits][0] | some_value |\n * | tenancy | sourceOfFunds[tenancy][0] | some_value |\n *\n * ", "format": "array", "nullable": "true" }, "kycLevel": { "description": "Customer KYC level.", "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "EXTENDED" ], "nullable": "true" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful operation" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "VERIFICATION_NOT_FOUND" } }, "type": "object" } } } }, "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DateIsInvalid": { "$ref": "#/components/examples/DateIsInvalid" }, "DateFormatIsInvalid": { "$ref": "#/components/examples/DateFormatIsInvalid" } } } } } } } }, "/secure/public_key": { "get": { "tags": [ "Secure - Public Key" ], "summary": "Get public key for encryption", "operationId": "getPublicKey", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "publicKey": { "description": "b64 encoded public key (PEM format)", "type": "string", "example": "QSBwdWJsaWMga2V5IHNob3VsZCBiZSBoZXJlIGhvd2V2ZXIgaXQgd2FzIHRvbyBsb25nIDoo" } }, "type": "object" } } } } } } } }, "components": { "schemas": { "CustomerBalanceDto": { "title": "Customer Balance", "description": "Customer Balance", "properties": { "id": { "type": "string", "format": "uuid" }, "balance": { "type": "number", "format": "float" }, "currency": { "description": "Currency code ISO 4217", "type": "string", "example": "PLN" }, "description": { "description": "Description of the balance", "type": "string", "example": "My account", "nullable": true }, "accountingBalance": { "type": "integer", "nullable": true }, "customerId": { "type": "integer", "nullable": true }, "dcCorporationId": { "format": "uuid", "nullable": true } }, "type": "object" }, "CustomerDocumentDto": { "title": "Customer Document", "description": "Customer Document", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "path": { "type": "string" }, "expirationDate": { "type": "string", "format": "Y-m-d", "nullable": true } }, "type": "object" }, "DocumentDto": { "title": "Document", "description": "Document", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "path": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "VerificationDocumentDto": { "title": "VerificationDocumentDto", "description": "Verification document", "properties": { "id": { "title": "Document identifier", "description": "id", "type": "string", "format": "uuid", "example": "70f91efb-3989-4289-916c-db4eed741a4e" }, "type": { "title": "Type of document", "description": "type", "type": "string", "format": "string", "example": "idCard" }, "url": { "title": "Document URL", "description": "url", "type": "string", "format": "url", "example": "https://example.com/example.png" }, "expirationDate": { "title": "Document expiration date", "description": "Document expiration date", "type": "string", "format": "date", "example": "2025-01-29", "nullable": true } }, "type": "object" }, "CardEntity": { "title": "CardEntity", "description": "CardEntity", "properties": { "id": { "title": "DataCore card id", "description": "Id", "type": "integer", "format": "int", "example": "7", "nullable": true }, "exp": { "title": "Card expiration date in format YYYY-MM-DD", "description": "exp", "type": "string", "format": "DateTime", "example": "2026-01-31", "nullable": true }, "type": { "title": "Card type", "description": "Card type", "type": "string", "format": "string", "example": "VIRTUAL", "nullable": true }, "activationDate": { "title": "Card activation date in format YYYY-MM-DD", "description": "activationDate", "type": "string", "format": "DateTime", "example": "2026-01-31", "nullable": true }, "configId": { "title": "configuration identifier", "description": "configId", "type": "string", "format": "string", "example": "0013009713" }, "dcCorporationId": { "title": "Corporation", "description": "corporation", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130007" } }, "type": "object" }, "CustomerBalanceEntity": { "title": "CustomerBalanceEntity", "description": "CustomerBalanceEntity", "properties": { "id": { "title": "id", "description": "id", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130002" }, "balance": { "title": "Balance in gross", "description": "balance", "type": "integer", "format": "int", "example": "1567" }, "currency": { "description": "Currency code ISO 4217", "type": "string", "format": "string", "example": "PLN" }, "description": { "description": "Name of balance", "type": "string", "format": "string", "example": "My account", "nullable": true }, "accountingBalance": { "title": "Accounting balance in gross", "description": "accounting balance", "type": "integer", "format": "int", "example": "1567", "nullable": true }, "clearingCounter": { "title": "Clearing counter", "description": "clearing counter", "type": "integer", "format": "int", "example": "34", "nullable": true }, "customerId": { "title": "customerId", "description": "DataCore user id", "format": "int", "example": "77777" }, "dcCorporationId": { "title": "Corporation", "description": "corporation", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130007" }, "cards": { "title": "CardEntity", "description": "CardEntity", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/CardEntity" } } }, "type": "object" }, "DocumentEntity": { "title": "Document model", "description": "Document model", "properties": { "id": { "title": "id", "description": "unique identifier", "format": "uuid" }, "type": { "title": "rejectReason", "description": "type of document", "type": "string", "format": "string", "enum": [ "passport", "idCard" ] } }, "type": "object", "xml": { "name": "Document" } }, "VerificationArchiveEntity": { "title": "Verification archive model", "description": "Verification archive model", "properties": { "id": { "title": "id", "description": "unique identifier", "format": "uuid" }, "customerStorageId": { "title": "customerStorageId", "description": "identifier of customer stored in DataCore", "type": "integer", "format": "int64" }, "status": { "title": "status", "description": "status of verification", "type": "string", "format": "string" }, "rejectReason": { "title": "rejectReason", "description": "reason of verification rejection", "type": "string", "format": "string", "nullable": true }, "customer": { "$ref": "#customer" }, "firstName": { "title": "firstName", "description": "customer first name of verrification", "type": "string", "format": "string" }, "lastName": { "title": "lastName", "description": "customer last name of verrification", "type": "string", "format": "string" }, "birthDate": { "title": "birthDate", "description": "customer birth date of verrification", "type": "string", "format": "string", "nullable": true }, "nationality": { "title": "nationality", "description": "nationality", "type": "string", "format": "string", "nullable": true }, "pesel": { "title": "pesel", "description": "pesel number of customer", "type": "string", "format": "string", "nullable": true }, "identityCardNo": { "title": "identityCardNo", "description": "identity card number", "type": "string", "format": "string", "nullable": true }, "riskLvl": { "title": "riskLvl", "description": "risk level", "type": "string", "format": "string", "nullable": true } }, "type": "object", "xml": { "name": "VerificationArchive" } }, "VerificationEntity": { "title": "Verification model", "description": "Verification model", "properties": { "id": { "title": "id", "description": "unique identifier", "format": "uuid" }, "customerStorageId": { "title": "customerStorageId", "description": "identifier of customer stored in DataCore", "type": "integer", "format": "int64" }, "status": { "title": "status", "description": "status of verification", "type": "string", "format": "string" }, "rejectReason": { "title": "rejectReason", "description": "reason of verification rejection", "type": "string", "format": "string", "nullable": true }, "documents": { "$ref": "#document" }, "customer": { "$ref": "#customer" }, "firstName": { "title": "firstName", "description": "customer first name of verrification", "type": "string", "format": "string" }, "lastName": { "title": "lastName", "description": "customer last name of verrification", "type": "string", "format": "string" }, "birthDate": { "title": "birthDate", "description": "customer birth date of verrification", "type": "string", "format": "string", "nullable": true }, "nationality": { "title": "nationality", "description": "nationality", "type": "string", "format": "string", "nullable": true }, "pesel": { "title": "pesel", "description": "pesel number of customer", "type": "string", "format": "string", "nullable": true }, "identityCardNo": { "title": "identityCardNo", "description": "identity card number", "type": "string", "format": "string", "nullable": true }, "riskLvl": { "title": "riskLvl", "description": "risk level", "type": "string", "format": "string", "nullable": true }, "sourceOfFounds": { "type": "array", "items": { "title": "sourceOfFunds", "description": "source of funds", "format": "json" }, "nullable": true }, "usaResident": { "title": "usaResident", "description": "usa tax resident", "type": "boolean", "format": "boolean", "nullable": true }, "taxResident": { "type": "array", "items": { "title": "countryResident", "description": "list of countries where customer is a resident", "format": "array" }, "nullable": true }, "dataHash": { "title": "dataHash", "description": "Hashed representation of all verification data", "type": "string", "format": "string", "nullable": true }, "kycLevel": { "title": "kycLevel", "description": "KYC level", "type": "string", "format": "string", "nullable": true }, "customData": { "type": "array", "items": { "title": "customData", "description": "Custom Data", "format": "json" }, "nullable": true }, "phone": { "title": "phone", "description": "Phone number in E.164 format (e.g. +48600123456). Must start with + followed by country calling code and subscriber number, digits only, no spaces or separators.", "type": "string", "format": "string", "example": "+48600123456", "nullable": true }, "isoCodePhone": { "title": "isoCodePhone", "description": "ISO 3166-1 alpha-2 country code associated with the phone number", "type": "string", "format": "string", "nullable": true }, "email": { "title": "email", "description": "Email address of the customer", "type": "string", "format": "string", "nullable": true }, "extendedVerificationDeclaration": { "title": "extendedVerificationDeclaration", "description": "Flag indicating the user declares they would like to spend more than a defined threshold.", "type": "boolean", "format": "boolean" }, "financialInstitutionsData": { "type": "array", "items": { "title": "financialInstitutions", "description": "financial istitution data", "format": "json" }, "nullable": true } }, "type": "object", "xml": { "name": "Verification" } }, "ErrorResponse": { "properties": { "status": { "type": "string" } }, "type": "object" }, "ApiActionCollection": { "title": "ApiActionCollection", "description": "Api Action resource collection", "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ApiActionResource" } } }, "type": "object" }, "ApiActionResource": { "title": "ApiAction", "description": "Api Action resource", "properties": { "name": { "title": "Action name", "description": "name", "type": "string", "example": "getCustomerVerification" }, "method": { "title": "Http method", "description": "method", "type": "string", "example": "GET" }, "uri": { "title": "Action uri", "description": "uri", "type": "string", "example": "/admin/customers/{customerId}/verifications/{verificationId}" } }, "type": "object" }, "CardDetailsAdmin": { "title": "CardDetailsAdmin", "description": "CardDetailsAdmin", "properties": { "id": { "title": "DataCore card id", "description": "Id", "type": "integer", "format": "int", "example": "1125" }, "exp": { "title": "card expiration date. Format: Y-m-d ", "description": "card expiration date. Format: Y-m-d ", "type": "string", "format": "date", "example": "2026-01-31" }, "type": { "title": "Card type", "description": "type", "type": "string", "format": "string", "enum": [ "real", "virtual" ], "example": "1125" }, "activationDate": { "title": "Card activation date in format YYYY-MM-DD", "description": "activationDate", "type": "string", "format": "DateTime", "example": "2026-01-31", "nullable": true }, "configId": { "title": "Configuration identifier", "description": "configId", "type": "string", "format": "string", "example": "0013009713" }, "externalCardId": { "title": "External card id", "description": "externalCardId", "type": "string", "format": "string", "example": "283744800001390" }, "dcCorporationId": { "title": "DC corporation id", "description": "dcCorporationId", "type": "string", "format": "string", "example": "29bacfc2-124d-433a-a9cf-8c7a9bcbdbed" }, "balanceId": { "title": "Customer balance ID", "description": "balanceId", "type": "string", "format": "string", "example": "29bacfc2-124d-433a-a9cf-8c7a9bcbdbed" } }, "type": "object" }, "CardLimit": { "title": "CardLimit", "description": "Card Limit resource", "properties": { "initialValue": { "title": "initialValue", "description": "Initial limit value.", "type": "integer", "example": "7" }, "currentValue": { "title": "currentValue", "description": "Current(actual) limit value.", "type": "integer", "example": "7" } }, "type": "object" }, "BalanceLimitCollection": { "title": "BalanceLimitCollection", "description": "Balance limit resource collection", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceLimitResource" } } }, "type": "object" }, "BalanceLimitResource": { "title": "BalanceLimitResource", "description": "BalanceLimitResource", "properties": { "id": { "description": "Unique id of the limit", "type": "string", "format": "uuid", "example": "492ec5ee-7f66-11ec-a8a3-0242ac120002" }, "type": { "type": "string", "enum": [ "CASH_IN", "CASH_OUT" ], "example": "CASH_IN" }, "maxAmount": { "description": "Maximum amount in minor units", "type": "integer", "example": 50000 }, "period": { "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ], "example": "MONTHLY", "nullable": true }, "expiration": { "description": "Limit expiration date", "type": "string", "format": "date-time", "example": "2099-12-24 00:00:00", "nullable": true }, "currency": { "type": "string", "example": "PLN" } }, "type": "object" }, "BalanceSummary": { "title": "BalanceSummary", "description": "Balance summary resource", "properties": { "currency": { "title": "Currency code ISO 4217", "description": "currency", "type": "string", "format": "string", "example": "PLN" }, "amount": { "title": "Amount in gross", "description": "balance", "type": "integer", "format": "string", "example": "1567" } }, "type": "object" }, "BalaceGetAllCollection": { "title": "BalancesGetAll", "description": "BalancesGetAll", "properties": { "id": { "title": "Balance id", "description": "id", "type": "integer", "format": "string", "example": "9ec5fbe0-3599-4ec0-8255-9c390cbea02a" }, "balance": { "title": "Balance", "description": "Balance in gross", "type": "integer", "format": "integer", "example": "9845" }, "currency": { "title": "Currency", "description": "Currency code ISO 4217", "type": "string", "format": "string", "example": "PLN" }, "description": { "title": "Description", "description": "Name of balance", "type": "string", "format": "string", "example": "My account" }, "dcUserId": { "title": "DC user id", "description": "dcUserId", "type": "string", "format": "int", "example": "1337" }, "dcCorporationId": { "title": "DC corporation id", "description": "dcCorporationId", "type": "string", "format": "string", "example": "a271f0e9-065b-4e3c-be24-9bac54fbd550" } }, "type": "object" }, "BalanceDetails": { "title": "BalanceDetails", "description": "Balance details resource", "properties": { "id": { "title": "Balance id", "description": "id", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130002" }, "balance": { "title": "Balance in gross", "description": "balance", "type": "integer", "format": "int", "example": "1567" }, "currency": { "title": "Currency code ISO 4217", "description": "currency", "type": "string", "format": "string", "example": "PLN" }, "description": { "title": "description", "description": "Description of balance", "type": "string", "format": "string", "example": "My account", "nullable": true }, "dcUserId": { "title": "dcUserId", "description": "DC Id of user", "type": "string", "format": "int", "example": "1337", "nullable": true }, "dcCorporationId": { "title": "dcCorporationId", "description": "DC Id of corporation", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac137777", "nullable": true }, "cards": { "title": "cards", "description": "Cards", "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceCard" } } }, "type": "object" }, "BalanceGetAll": { "title": "BalancesGetAll", "description": "Balances get all", "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/BalaceGetAllCollection" } } }, "type": "object" } ] }, "CardLimitCollection": { "title": "CardLimitCollection", "description": "Card limit resource collection", "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/CardLimitResource" } } }, "type": "object" }, "CardLimitResource": { "title": "CardLimitResource", "description": "CardLimitResource", "properties": { "id": { "title": "Unique id of created resource", "description": "id", "format": "uuid", "example": "492ec5ee-7f66-11ec-a8a3-0242ac120002" }, "type": { "title": "Card limit type", "description": "Type of card limitation", "type": "string", "enum": [ "TRX_ALL", "TRX_E_COM", "TRX_ATM", "FOREIGN_QUANTITY", "FOREIGN_AMOUNT", "QUANTITY", "AMOUNT_PLN", "AMOUNT_EUR" ], "example": "TRX_ALL" }, "maxAmount": { "title": "maxAmount", "description": "Maximum amount to spend", "format": "int", "example": "4555555552" }, "maxAttempts": { "title": "maxAttempts", "description": "Maximum number of transactions", "format": "int", "example": "99" }, "period": { "title": "period", "description": "Period for card limit", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ], "example": "DAILY" }, "expiration": { "title": "expiration", "description": "Date of limit expiration", "format": "date", "example": "2024-12-24 12:00:00" }, "currency": { "title": "currency", "description": "Currency of a card", "format": "string", "example": "PLN" }, "mcc_list": { "title": "mcc_list", "description": "Merchant cartegory codes of black/white list", "format": "array", "example": [ "4821", "4822" ] }, "merchant_id_list": { "title": "merchant_id_list", "description": "Merchant ids of black/white list", "format": "array", "example": [ "9AD2C6F1D4A2", "A9F3C2B1D4E5" ] } }, "type": "object" }, "CustomerResource": { "title": "CustomerResource", "description": "CustomerResource", "properties": { "id": { "description": "Id", "type": "integer", "example": 1125 }, "firstName": { "description": "First name", "type": "string", "example": "Jane" }, "lastName": { "description": "Last name", "type": "string", "example": "Doe" }, "birthDate": { "description": "Birth date", "type": "string", "format": "date", "example": "1970-01-01" }, "address": { "$ref": "#/components/schemas/VerificationAddress" } }, "type": "object" }, "CustomerBalance": { "title": "CustomerBalanceResource", "description": "CustomerBalanceResource" }, "CustomerBalanceBrief": { "title": "CustomerBalanceBrief", "description": "Customer balance resource", "properties": { "id": { "title": "Balance id", "description": "id", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130002" }, "balance": { "title": "Balance in gross", "description": "balance", "type": "integer", "format": "int", "example": "1567" }, "currency": { "title": "Currency code ISO 4217", "description": "currency", "type": "string", "format": "string", "example": "PLN" }, "description": { "title": "description", "description": "Description of balance", "type": "string", "format": "string", "example": "My account", "nullable": true }, "dcUserId": { "title": "dcUserId", "description": "DC Id of user", "type": "string", "format": "int", "example": "1337", "nullable": true }, "dcCorporationId": { "title": "dcCorporationId", "description": "DC Id of corporation", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac137777", "nullable": true } }, "type": "object" }, "CustomerBalanceCard": { "title": "CustomerBalanceCard", "description": "Customer balance card resource", "properties": { "id": { "title": "DataCore card id", "description": "id", "type": "integer", "format": "int", "example": 7 }, "exp": { "title": "Card expiration date in format YYYY-MM-DD", "description": "exp", "type": "integer", "format": "DateTime", "example": "2026-01-31" }, "type": { "title": "Card type", "description": "type", "type": "string", "format": "string", "example": "VIRTUAL" }, "activationDate": { "title": "Card activation date in format YYYY-MM-DD", "description": "activationDate", "type": "string", "format": "DateTime", "example": "2026-01-31", "nullable": true }, "configId": { "title": "Configuration identifier", "description": "configId", "type": "string", "format": "string", "example": "0013009713" }, "externalCardId": { "title": "External card id", "description": "externalCardId", "type": "string", "format": "string", "example": "283744800001390" } }, "type": "object" }, "CustomerBalanceDetails": { "title": "CustomerBalanceDetails", "description": "Customer balance details resource", "type": "object", "allOf": [ { "$ref": "#/components/schemas/CustomerBalanceBrief" }, { "properties": { "cards": { "title": "cards", "description": "Cards", "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceCard" } } }, "type": "object" } ] }, "Card": { "title": "CardDetails", "description": "CardDetails", "properties": { "id": { "title": "DataCore card id", "description": "id", "type": "integer", "format": "int", "example": 7 }, "exp": { "title": "Card expiration date in format YYYY-MM-DD", "description": "exp", "type": "integer", "format": "DateTime", "example": "2026-01-31" }, "type": { "title": "Card type", "description": "type", "type": "string", "format": "string", "enum": [ "REAL", "VIRTUAL" ], "example": "VIRTUAL" }, "activationDate": { "title": "Card activation date in format YYYY-MM-DD", "description": "activationDate", "type": "string", "format": "DateTime", "example": "2026-01-31", "nullable": true }, "configId": { "title": "Configuration identifier", "description": "configId", "type": "string", "format": "string", "example": "0013009713" }, "externalCardId": { "title": "External card id", "description": "externalCardId", "type": "string", "format": "string", "example": "283744800001390" }, "dcUserId": { "title": "DC user id", "description": "dcUserId", "type": "string", "format": "int", "example": "1337" }, "dcCorporationId": { "title": "DC corporation id", "description": "dcCorporationId", "type": "string", "format": "string", "example": "a271f0e9-065b-4e3c-be24-9bac54fbd550" }, "balanceId": { "title": "Customer balance ID", "description": "balanceId", "type": "string", "format": "string", "example": "29bacfc2-124d-433a-a9cf-8c7a9bcbdbed" } }, "type": "object" }, "CardAllowedConfig": { "title": "CardAllowedConfig", "description": "CardAllowedConfig Resource", "properties": { "id": { "title": "Id", "description": "Id", "type": "string", "format": "string", "example": "0013009713" }, "name": { "title": "name", "description": "name", "type": "string", "format": "string", "example": "Debit Standard" }, "currency": { "title": "Array of currency codes in ISO 4217 format", "description": "currency", "type": "array", "format": "array", "items": { "type": "string", "example": "PLN" }, "example": "['PLN', 'EUR']" }, "bin": { "title": "bin of a card (Bank Identification Number", "description": "bin", "type": "string", "format": "string", "example": "538406" }, "type": { "title": "name", "description": "type of card", "type": "string", "format": "string", "enum": [ "VIRTUAL", "REAL" ], "example": "VIRTUAL" }, "visualId": { "title": "visualId", "description": "id of visual for this card", "type": "string", "format": "string", "example": "17" } }, "type": "object" }, "CardCollection": { "title": "CardCollection", "description": "Card collection" }, "CardDetails": { "title": "CardDetails", "description": "CardDetails", "properties": { "id": { "title": "DataCore card id", "description": "Id", "type": "integer", "format": "int", "example": "1125" }, "type": { "title": "Card type", "description": "type", "type": "string", "format": "string", "enum": [ "REAL", "VIRTUAL" ], "example": "VIRTUAL" }, "cvv": { "title": "cvv", "description": "card security code", "type": "string", "format": "string", "example": "573" }, "cardNo": { "title": "card number", "description": "card full pan number", "type": "string", "format": "string", "example": "5227128362110426" }, "exp": { "title": "card expiration date. Format: Y-m-d ", "description": "card expiration date. Format: Y-m-d ", "type": "string", "format": "date", "example": "2026-01-31" }, "issuerCardId": { "title": "Issuer card id", "description": "Id from card issuer", "type": "string", "format": "string", "example": "704144800000021" }, "dcCorporationId": { "title": "DC corporation id", "description": "dcCorporationId", "type": "string", "format": "string", "example": "29bacfc2-124d-433a-a9cf-8c7a9bcbdbed" }, "balanceId": { "title": "Customer balance ID", "description": "balanceId", "type": "string", "format": "string", "example": "29bacfc2-124d-433a-a9cf-8c7a9bcbdbed" } }, "type": "object" }, "CardGetAll": { "title": "CardCollection", "description": "Card collection", "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/Card" } } }, "type": "object" } ] }, "VirtualCardResource": { "title": "VirtualCardResource", "description": "VirtualCardResource", "properties": { "id": { "title": "DataCore card id", "description": "Id", "type": "integer", "format": "int", "example": "1125" }, "cardNo": { "title": "card number", "description": "card full pan number", "type": "string", "format": "string", "example": "5227128362110426" }, "exp": { "title": "card expiration date. Format: Y-m-d ", "description": "card expiration date. Format: Y-m-d ", "type": "string", "format": "date", "example": "2026-01-31" }, "cvv": { "title": "cvv", "description": "card security code", "type": "string", "format": "string", "example": "573" }, "issuerCardId": { "title": "Issuer card id", "description": "Id from card issuer", "type": "string", "format": "string", "example": "704144800000021" } }, "type": "object" }, "CDD": { "title": "CDD", "description": "Customer Due Diligence object", "properties": { "id": { "description": "Id of CDD", "type": "string", "format": "uuid", "example": "9d52da25-76ce-474a-a379-a66ac07ea8f6" }, "verificationId": { "description": "Id of Verification", "type": "string", "format": "uuid", "example": "900a18b5-ca04-4bb2-8403-b2fdeeb0e084" }, "listName": { "description": "Checked where", "type": "string", "example": "known-list-published-on-1997-04-02-by-ACME" }, "sourceName": { "description": "Checked by whom", "type": "string", "example": "Elizabeth" }, "date": { "description": "Checked when", "type": "string", "format": "date-time", "example": "2021-05-06T20:08:33+00:00" } }, "type": "object" }, "CddCollection": { "title": "CddCollection", "description": "Cdd collection", "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/CDD" } } }, "type": "object" } ] }, "Verification": { "title": "Verification", "description": "Verification Resource", "properties": { "id": { "title": "Id", "description": "Id", "type": "string", "format": "string", "example": "e389e2c2-f99d-11ea-adc1-0242ac120002" }, "status": { "title": "status", "description": "status", "type": "string", "format": "string", "example": "accepted" }, "customerId": { "title": "customerId", "description": "customerId", "type": "integer", "format": "int", "example": "7" }, "firstName": { "title": "firstName", "description": "firstName", "type": "string", "format": "string", "example": "John" }, "lastName": { "title": "lastName", "description": "lastName", "type": "string", "format": "string", "example": "Doe" }, "birthDate": { "title": "birthDate", "description": "birthDate", "type": "string", "format": "date", "example": "1970-01-01" }, "nationality": { "title": "nationality", "description": "nationality", "type": "string", "format": "string", "example": "polish" }, "riskLvl": { "title": "rislLvl", "description": "riskLvl", "type": "string", "format": "string", "enum": [ "HIGH", "NORMAL", "LOW", "NOT_ACCEPTABLE" ], "example": "LOW" }, "nextVerificationDate": { "title": "nextVerificationDate", "description": "nextVerificationDate", "type": "string", "format": "date", "example": "2020-01-20 12:03:45" }, "createdAt": { "title": "createdAt", "description": "createdAt", "type": "string", "format": "date", "example": "2020-01-20 12:03:45", "nullable": true }, "updatedAt": { "title": "updatedAt", "description": "updatedAt", "type": "string", "format": "date", "example": "2020-01-20 12:03:45" }, "usaResident": { "title": "usaResident", "description": "Is USA tax resident", "type": "boolean", "format": "boolean", "example": "true", "nullable": true }, "taxResident": { "description": "Is list of countries customer tax residentIs", "type": "array", "items": { "type": "string", "example": "DEU" }, "nullable": true }, "rejectReason": { "title": "rejectReason", "description": "Reasons for verification rejection", "type": "array", "items": { "type": "string", "enum": [ "INVALID_CUSTOMER_DATA", "BLURRED_DOCUMENT_PHOTO", "INVALID_DOCUMENT_PHOTO", "BLURRED_SELFIE", "INVALID_SELFIE", "RESTRICTED_PESEL", "INCORRECT_PESEL", "UNDERAGE", "ILLEGAL_DOCUMENT", "EXPIRED_DOCUMENT", "MISSING_ENTIRE_DOCUMENT", "SELFIE_WITHOUT_DOCUMENT", "FACE_COVERED", "PAYMENT_CARD_NOT_DOCUMENT", "MISSING_DIACRITICAL_MARKS", "NON_LATIN_ALPHABET", "OUTSIDE_EEA", "ILLEGAL_EMAIL", "NOT_MATCH_PREFIX" ], "example": "EXPIRED_DOCUMENT" } }, "sourceOfFounds": { "description": "All sources of founds customer set in JSON", "properties": { "business_activity": { "schema": "objectArray", "type": "array", "items": { "properties": { "nip": { "description": "VAT number", "type": "string", "example": "5934273049" }, "regon": { "description": "National Business Registry Number", "type": "string", "example": "DSD-5492/44004" } }, "type": "object" }, "nullable": true }, "maintained_by_family": { "schema": "objectArray", "type": "array", "items": { "properties": { "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Smith" }, "birth_date": { "type": "string", "format": "date", "example": "22-12-1950" } }, "type": "object" }, "nullable": true } }, "type": "object", "nullable": "true" }, "customData": { "title": "customData", "description": "Custom verification data provided by client", "type": "object", "example": { "customerHeight": "180cm", "locationOfBirth": "Lagos, Nigeria", "nin": "12345678901" }, "nullable": "true" }, "address": { "$ref": "#/components/schemas/VerificationAddress" } }, "type": "object" }, "VerificationAddress": { "properties": { "city": { "title": "City", "description": "city", "type": "string", "example": "Lublin" }, "street": { "title": "Street", "description": "street", "type": "string", "example": "Rusałka" }, "number": { "title": "House number", "description": "number", "type": "string", "example": "17a", "nullable": true }, "apartment": { "title": "Apartment number", "description": "apartment", "type": "string", "example": "2", "nullable": true }, "postCode": { "title": "Post code", "description": "postCode", "type": "string", "example": "20-128" }, "province": { "title": "Province", "description": "province", "type": "string", "example": "Mazowieckie", "nullable": true }, "country": { "title": "Country Alpha-2 code in ISO-3166", "description": "country", "type": "string", "example": "PL" } }, "type": "object" }, "VerificationCollection": { "title": "VerificationCollection", "description": "Verification Resource", "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/Verification" } }, "links": { "$ref": "#/components/schemas/PaginatorLinks" }, "meta": { "$ref": "#/components/schemas/PaginatorMeta" } }, "type": "object" }, "VerificationCustomer": { "properties": { "id": { "title": "DataCore user id", "description": "id", "type": "integer", "example": "7", "nullable": true }, "firstName": { "title": "First name", "description": "firstName", "type": "string", "example": "John" }, "lastName": { "title": "Last name", "description": "lastName", "type": "string", "example": "Doe" }, "birthDate": { "title": "Birth date", "description": "birthDate", "type": "string", "format": "date", "example": "1970-01-01" } }, "type": "object" }, "VerificationDetails": { "title": "VerificationDetails", "description": "VerificationDetailsResource", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Verification" }, { "properties": { "pesel": { "title": "pesel", "description": "Customer PESEL", "type": "string", "example": "70010155587", "nullable": true }, "identityCardNo": { "title": "identityCardNo", "description": "Number of identity card", "type": "string", "example": "ARG691869", "nullable": true }, "kycLevel": { "title": "kycLevel", "description": "KYC Level", "type": "string", "example": "LOW,MEDIUM,HIGH,EXTENDED", "nullable": true }, "customer": { "$ref": "#/components/schemas/VerificationCustomer" }, "address": { "$ref": "#/components/schemas/VerificationAddress" }, "documents": { "title": "documents", "description": "Verification documents", "type": "array", "items": { "$ref": "#/components/schemas/VerificationDocument" } } }, "type": "object" } ] }, "VerificationDocument": { "title": "VerificationDocument", "description": "Verification document resource", "properties": { "id": { "title": "Document identifier", "description": "id", "type": "string", "format": "uuid", "example": "70f91efb-3989-4289-916c-db4eed741a4e" }, "type": { "title": "Type of document", "description": "type", "type": "string", "format": "string", "example": "idCard" }, "url": { "title": "Document URL", "description": "url", "type": "string", "format": "url", "example": "https://example.com/example.png" }, "documentExpirationDate": { "description": "Document expiration Date", "type": "string", "format": "date", "example": "2025-01-30" } }, "type": "object" }, "LockCollection": { "title": "LockCollection", "description": "Resource locks collection", "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/LockResource" } } }, "type": "object" } ] }, "LockResource": { "title": "Lock", "description": "Resource lock object", "properties": { "id": { "description": "unique identifier", "format": "uuid", "example": "492ec5ee-7f66-11ec-a8a3-0242ac120002" }, "resourceType": { "description": "Type of resource to be locked", "type": "string", "enum": [ "customer", "corporation" ], "example": "customer" }, "resourceId": { "description": "Resource identifier", "type": "string", "example": "1337" }, "reason": { "description": "reason of resource lock", "type": "string", "enum": [ "DOCUMENT_EXPIRED", "FRAUD_SUSPECTED", "SCREENING_DETECTED", "TEMPORARY_LOCKED", "PEKAO_LOCK", "ZEN_LOCK", "PROSECUTOR_LOCK", "FENIGE_LOCK", "POLICE_LOCK", "MANY_CARDS_LOCK", "NEGATIVE_VERIFICATION", "PRADO_VERIFICATION" ], "example": "DOCUMENT_EXPIRED" } }, "type": "object" }, "MasterBalance": { "title": "MasterBalance", "description": "Master Balance", "properties": { "id": { "title": "Master Balance Identifier", "description": "id", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130002" }, "currency": { "title": "Currency code ISO 4217", "description": "currency", "type": "string", "format": "string", "example": "PLN" }, "balance": { "title": "Balance in gross", "description": "balance", "type": "integer", "format": "int", "example": "1567" }, "type": { "title": "Type of Balance", "description": "balance", "type": "string", "format": "string", "example": "[CREDIT / DEPOSIT]" }, "dcCorporationId": { "title": "dcCorporationId", "description": "DC Id of corporation", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac137777", "nullable": true }, "createdAt": { "title": "createdAt", "description": "createdAt", "type": "string", "format": "date", "example": { "date": "2023-03-02 13:21:37.000000", "timezone_type": 3, "timezone": "UTC" } }, "updatedAt": { "title": "updatedAt", "description": "updatedAt", "type": "string", "format": "date", "example": { "date": "2023-09-02 13:21:37.000000", "timezone_type": 3, "timezone": "UTC" } } }, "type": "object" }, "PaginatedCollection": { "title": "PaginatedCollection", "description": "Paginated resource collection", "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": {} }, "links": { "$ref": "#/components/schemas/PaginatorLinks" }, "meta": { "$ref": "#/components/schemas/PaginatorMeta" } }, "type": "object" }, "DailySettlement": { "title": "DailySettlement", "description": "Daily Settlement object", "properties": { "id": { "title": "Daily Settlement identifier", "description": "Internal settlement identifier", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130002" }, "transactionDate": { "title": "Transaction date", "description": "Date and time related transaction was performed", "type": "string", "format": "date-time", "example": "2020-01-20 12:03:45" }, "transactionId": { "title": "Transaction external identifier", "description": "External identifier of related transaction", "type": "string", "example": "00812304" }, "amount": { "title": "Transaction amount", "description": "Amount expressed in currency fractional unit", "type": "integer", "example": "350" }, "currency": { "title": "Transaction currency", "description": "Currency code ISO 4217", "type": "string", "example": "PLN" }, "cardId": { "title": "Card identifier", "description": "DataCore card id", "type": "integer", "example": "10181" }, "type": { "title": "Transaction event type", "description": "Event type, one of: DEDUCT, LOAD", "type": "string", "example": "Deduct" }, "configId": { "title": "Configuration identifier", "description": "Card configuration identifier", "type": "string", "example": "0013009713" }, "processedAt": { "title": "Processed at", "description": "Date and time settlement has been processed. Null if not processed yet.", "type": "string", "format": "date-time", "example": null, "nullable": true }, "description": { "title": "description", "description": "Description of daily settlement.", "type": "string", "example": "AE Sklep POLPOL" } }, "type": "object" }, "DailySettlementCollection": { "title": "DailySettlementCollection", "description": "Daily Settlement resource collection", "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/DailySettlement" } } }, "type": "object" } ] }, "DailySettlementDetails": { "title": "DailySettlementDetails", "description": "Detailed Daily Settlement object", "type": "object", "allOf": [ { "$ref": "#/components/schemas/DailySettlement" }, { "properties": { "settlementAmount": { "title": "Settlement amount", "description": "Amount expressed in currency fractional unit", "type": "integer", "example": "350" }, "transactionNarrative": { "title": "Transaction Narrative", "description": "Transaction description consists of MerchantName followed by three digit country code ISO 3166-1", "type": "string", "example": "MariuszPol POL" }, "transactionType": { "title": "Transaction type", "description": "2 character string identifying the type of transaction: 00 => POS, 01 => ATM, 02 => Adjustment, 09 => Cashback at POS, 21 => Deposit", "type": "string", "example": "00" }, "systemDate": { "title": "System date", "description": "Date and time transaction was performed", "type": "string", "format": "date-time", "example": "2020-01-20 12:03:45" }, "sequenceNumber": { "title": "Sequence Number", "description": "Sequence Number", "type": "string", "example": "13" }, "trackingNumber": { "title": "Tracking Number", "description": "Tracking Number", "type": "string", "example": "213142400000013" }, "interchangeAmount": { "title": "Interchange amount", "description": "Interchange amount expressed in currency fractional unit", "type": "integer", "example": "350" } }, "type": "object" } ] }, "ExportedReport": { "title": "ExportedReport", "description": "Exported report resource", "properties": { "url": { "title": "Report URL", "description": "url", "type": "string", "format": "url", "example": "https://example.com/example.png" } }, "type": "object" }, "CollateralBalanceTransaction": { "title": "CollateralBalanceTransaction", "description": "Transaction object", "properties": { "id": { "title": "Transaction identifier", "description": "Internal transaction identifier", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130002" }, "externalId": { "title": "Transaction external identifier", "description": "Transaction external identifier", "type": "string", "example": "97eee13e-9439-11eb-7669-0242ac130002" }, "transactionDate": { "title": "Transaction date", "description": "Date and time transaction was performed", "type": "string", "format": "date-time", "example": "2020-01-20 12:03:45" }, "amount": { "title": "Transaction amount", "description": "Initial amount expressed in currency fractional unit", "type": "integer", "example": "350" }, "currency": { "title": "Transaction currency", "description": "Currency code ISO 4217", "type": "string", "example": "PLN" }, "type": { "title": "Transaction type", "description": "Transaction type, one of: collateralCredit, collateralDebit, collateralForcedDebit", "type": "string", "example": "collateralDebit" }, "status": { "title": "Transaction status", "description": "Status of transaction, one of: AUTHORIZED, CLEARED, REVERSED, ERROR", "type": "string", "example": "AUTHORIZED" }, "description": { "title": "Transaction description", "description": "", "type": "string", "example": "service fee" } }, "type": "object" }, "CollateralBalanceTransactionCollection": { "title": "CollateralBalanceTransactionCollection", "description": "CollateralBalanceTransaction resource collection", "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/CollateralBalanceTransaction" } } }, "type": "object" } ] }, "Transaction": { "title": "Transaction", "description": "Transaction object", "properties": { "id": { "title": "Transaction identifier", "description": "Internal transaction identifier", "type": "string", "format": "uuid", "example": "97eee13e-7669-11eb-9439-0242ac130002" }, "externalId": { "title": "Transaction external identifier", "description": "Transaction external identifier", "type": "string", "example": "97eee13e-9439-11eb-7669-0242ac130002" }, "transactionDate": { "title": "Transaction date", "description": "Date and time transaction was performed", "type": "string", "format": "date-time", "example": "2020-01-20 12:03:45" }, "amount": { "title": "Transaction amount", "description": "Initial amount expressed in currency fractional unit", "type": "integer", "example": "350" }, "finalAmount": { "title": "Transaction final amount", "description": "Final amount of transaction. Equals to amount + adjustmentAmount - reversalAmount", "type": "integer", "example": "160" }, "currency": { "title": "Transaction currency", "description": "Currency code ISO 4217", "type": "string", "example": "PLN" }, "eventType": { "title": "Transaction event type", "description": "Event type, one of: Deduct, DeductAdjustment, LoadAdjustment", "type": "string", "example": "Deduct" }, "customerId": { "title": "Customer identifier", "description": "DataCore user id", "type": "integer", "example": "7" }, "cardId": { "title": "Card identifier", "description": "DataCore card id", "type": "integer", "example": "10181" }, "configId": { "title": "Configuration identifier", "description": "Card configuration identifier", "type": "string", "example": "0013009713" }, "status": { "title": "Transaction status", "description": "Status of transaction, one of: AUTHORIZED, CLEARED, REVERSED, ERROR", "type": "string", "example": "AUTHORIZED" }, "description": { "title": "Transaction description", "description": "", "type": "string", "example": "Audioteka WARSZAWA" }, "type": { "title": "Transaction type", "description": "", "type": "string", "example": "forexCredit" } }, "type": "object" }, "TransactionCollection": { "title": "TransactionCollection", "description": "Transaction resource collection", "type": "object", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "properties": { "data": { "title": "data", "description": "data", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/Transaction" } } }, "type": "object" } ] }, "TransactionDetails": { "title": "TransactionDetails", "description": "Detailed transaction object", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Transaction" }, { "properties": { "adjustmentAmount": { "title": "Transaction adjustment amount", "description": "Summarised amount of adjustments related to transaction", "type": "integer", "example": "10" }, "reversalAmount": { "title": "Transaction reversal amount", "description": "Summarised amount of reversals related to transaction", "type": "integer", "example": "200" }, "finalAmount": { "title": "Transaction final amount", "description": "Final amount of transaction. Equals to amount + adjustmentAmount - reversalAmount", "type": "integer", "example": "160" }, "type": { "title": "Type of transaction", "description": "2 character string identifying the type of transaction: 00 => POS, 01 => ATM, 02 => Adjustment, 09 => Cashback at POS, 21 => Deposit", "type": "string", "example": "00", "nullable": true }, "captureMode": { "title": "Capture mode", "description": "Identify type of MDES transaction", "type": "string", "example": "ECOM", "nullable": true }, "area": { "title": "Area of transaction", "description": "Area of transaction, specific per project to distinguish transaction from many company areas like P2P, UCP etc.", "type": "string", "example": "PREPAID", "nullable": true }, "transactionEvents": { "title": "Transaction Events", "description": "Collection of events related to transaction", "type": "array", "items": { "$ref": "#/components/schemas/TransactionEvent" } } }, "type": "object" } ] }, "TransactionEvent": { "title": "TransactionEvent", "description": "Transaction Event object", "properties": { "id": { "title": "Transaction Event Identifier", "description": "Transaction Event Identifier", "type": "string", "format": "uuid", "example": "f661b8d8-3587-4642-a43d-42837e174044" }, "type": { "title": "Transaction Event type", "description": "Event type, one of: Deduct, DeductAdjustment, LoadAdjustment", "type": "string", "example": "Deduct" }, "transactionExternalId": { "title": "Transaction Event external identifier", "description": "Transaction Event external identifier", "type": "string", "format": "uuid", "example": "79b97b81-52de-4ef6-b781-39b873ee6752" }, "referenceTransactionExternalId": { "title": "Reference Transaction external identifier", "description": "External identifier of referenced Transaction", "type": "string", "example": null, "nullable": true }, "cardId": { "title": "Card identifier", "description": "DataCore card id", "type": "integer", "example": "10181" }, "customerId": { "title": "Customer identifier", "description": "DataCore user id", "type": "integer", "example": "7" }, "amount": { "title": "Transaction Event amount", "description": "Event amount expressed in currency fractional unit", "type": "integer", "example": "350" }, "originalAmount": { "title": "Original Amount", "description": "Original Amount", "type": "integer", "example": null, "nullable": true }, "originalCurrency": { "title": "Original Currency", "description": "Original Currency", "type": "string", "example": null, "nullable": true }, "description": { "title": "Description", "description": "Transaction description consists of MerchantName followed by three digit country code ISO 3166-1", "type": "string", "example": "MariuszPol POL", "nullable": true }, "transactionType": { "title": "Type of transaction", "description": "2 character string identifying the type of transaction: 00 => POS, 01 => ATM, 02 => Adjustment, 09 => Cashback at POS, 21 => Deposit", "type": "string", "example": "00", "nullable": true }, "adjustmentReason": { "title": "Adjustment reason", "description": "Adjustment reason", "type": "string", "example": null, "nullable": true }, "additionalData": { "title": "Additional Data", "description": "Additional data in KLV format", "type": "string", "example": null, "nullable": true }, "transactionDate": { "title": "Transaction date", "description": "Date and time transaction was performed", "type": "string", "format": "date", "example": "2020-01-20 12:03:45" }, "referenceTransactionDate": { "title": "Referenced Transaction date", "description": "Date and time referenced transaction was performed", "type": "string", "format": "date", "example": null, "nullable": true }, "cardTrackingNumber": { "title": "Card tracking number", "description": "Card tracking number", "type": "string", "example": null, "nullable": true }, "configId": { "title": "Configuration identifier", "description": "Card configuration identifier", "type": "string", "example": "0013009713" }, "status": { "title": "Transaction status", "description": "Status of transaction, one of: AUTHORIZED, CLEARED, REVERSED, ERROR", "type": "string", "example": "AUTHORIZED" }, "declineReason": { "title": "Decline reason", "description": "Decline reason", "type": "string", "example": null, "nullable": true } }, "type": "object" }, "CardLimitEntity": { "title": "Card limit", "description": "Card Limit", "properties": { "maxAmount": { "title": "Maximum amount for spend", "description": "maxAmount", "type": "integer", "format": "int", "example": "7", "nullable": true }, "timePeriod": { "title": "Time validity of card limit.", "description": "timePeriod", "type": "string", "format": "DateTime", "example": "daily", "nullable": true }, "maxAttempts": { "title": "Maximum allowed number of transactions", "description": "maxAttempts", "type": "integer", "format": "int", "example": "7", "nullable": true }, "type": { "title": "Card limit type", "description": "type", "type": "string", "format": "string" }, "expiration": { "title": "Time after limit will expire.", "description": "expiration", "type": "string", "format": "DateTime", "example": "2023-01-01 12:00:00", "nullable": true } }, "type": "object" }, "Address": { "title": "Address", "description": "Address", "properties": { "id": { "title": "Address identifier in uuid format", "description": "id", "type": "string", "format": "string", "example": "d415805e-028a-4578-9012-f0844346b230" }, "city": { "title": "City name", "description": "city", "type": "string", "format": "string", "example": "Lublin" }, "number": { "title": "Number", "description": "Number", "type": "string", "format": "string", "example": "17a" }, "apartment": { "title": "Apartment", "description": "Apartment", "type": "string", "format": "string", "example": "44" }, "postCode": { "title": "Post Code", "description": "Post code", "type": "string", "format": "string", "example": "20-103" }, "country": { "title": "Country code in format: Alpha-2 code ISO-3166-1", "description": "Country code", "type": "string", "format": "string", "example": "PL" } }, "type": "object" }, "Customer": { "title": "CustomerResource", "description": "Customer", "properties": { "id": { "title": "DataCore user identifier", "description": "id", "type": "integer", "format": "integer", "example": "1124" }, "firstName": { "title": "firstName", "description": "firstName", "type": "string", "format": "string", "example": "John" }, "lastName": { "title": "lastName", "description": "lastName", "type": "string", "format": "string", "example": "Doe" }, "birthDate": { "title": "BirthDate", "description": "BirthDate", "type": "string", "format": "string", "example": "1970-01-01" } }, "type": "object" }, "Document": { "title": "Document", "description": "DocumentEntity", "properties": { "id": { "title": "id", "description": "id", "type": "string", "format": "string", "example": "c331758b-9f7c-4808-81e6-72f342fc0c79" }, "type": { "title": "type of document", "description": "type", "type": "string", "format": "string", "example": "passport" }, "path": { "title": "file path", "description": "path", "type": "string", "format": "string", "example": "documents/3796/5a5b253b-ac14-4566-a89f-8c5d26544c4e/IEoETVaFOF1Qx4AuKN8YBBUB8Y9lOanAU2Izato3.jpeg" } }, "type": "object" }, "PaginatorLinks": { "title": "PaginatorLinks", "description": "Paginator Links", "properties": { "first": { "title": "first", "description": "first", "type": "string", "format": "string", "example": "/?page=1" }, "last": { "title": "last", "description": "last", "type": "string", "format": "string", "example": "/?page=4" }, "prev": { "title": "prev", "description": "prev", "type": "string", "format": "string", "example": "null" }, "next": { "title": "next", "description": "next", "type": "string", "format": "string", "example": "/?page=2" } }, "type": "object" }, "PaginatorMeta": { "title": "PaginatorLinks", "description": "Paginator Links", "properties": { "currentPage": { "title": "current_page", "description": "current_page", "type": "integer", "format": "int", "example": "1" }, "from": { "title": "from", "description": "from", "type": "integer", "format": "int", "example": "4" }, "last_page": { "title": "last_page", "description": "last_page", "type": "integer", "format": "int", "example": "4" }, "path": { "title": "path", "description": "path", "type": "string", "format": "string", "example": "/" }, "per_page": { "title": "per_page", "description": "per_page", "type": "integer", "format": "int", "example": "20" }, "to": { "title": "to", "description": "to", "type": "integer", "format": "int", "example": "4" }, "total": { "title": "total", "description": "total", "type": "integer", "format": "int", "example": "4" } }, "type": "object" }, "ResourceNotFound": { "properties": { "status": { "type": "string", "example": "RESOURCE_NOT_FOUND" } }, "type": "object" }, "CustomerNotFound": { "properties": { "status": { "type": "string", "example": "CANT_FIND_CUSTOMER" } }, "type": "object" } }, "responses": { "422": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidType": { "summary": "INVALID_TYPE", "value": { "status": "INVALID_TYPE" } }, "InvalidCurrency": { "summary": "INVALID_CURRENCY", "value": { "status": "INVALID_CURRENCY" } }, "InvalidDcUser": { "summary": "INVALID_DC_USER_ID", "value": { "status": "INVALID_DC_USER_ID" } }, "InvalidDcCorporationId": { "summary": "INVALID_DC_CORPORATION_ID", "value": { "status": "INVALID_DC_CORPORATION_ID" } } } } } } }, "examples": { "InvalidLockTypeException": { "summary": "RESOURCE_NOT_FOUND", "value": { "status": "INVALID_LOCK_TYPE" } }, "NoActiveDocumentException": { "summary": "NO_ACTIVE_DOCUMENTS", "value": { "status": "NO_ACTIVE_DOCUMENTS" } }, "ResourceNotFound": { "summary": "RESOURCE_NOT_FOUND", "value": { "status": "RESOURCE_NOT_FOUND" } }, "CustomerNotFound": { "summary": "CUSTOMER_NOT_FOUND", "value": { "status": "CUSTOMER_NOT_FOUND" } }, "CorporationNotFound": { "summary": "CORPORATION_NOT_FOUND", "value": { "status": "CORPORATION_NOT_FOUND" } }, "CustomerBalanceNotFound": { "summary": "CUSTOMER_BALANCE_NOT_FOUND", "value": { "status": "CUSTOMER_BALANCE_NOT_FOUND" } }, "CorporationBalanceNotFound": { "summary": "CORPORATION_BALANCE_NOT_FOUND", "value": { "status": "CORPORATION_BALANCE_NOT_FOUND" } }, "CardNotFound": { "summary": "CARD_NOT_FOUND", "value": { "status": "CARD_NOT_FOUND" } }, "CardInvalid": { "summary": "INVALID_CARD", "value": { "status": "INVALID_CARD" } }, "CardLimitNotFound": { "summary": "CARD_LIMIT_NOT_FOUND", "value": { "status": "CARD_LIMIT_NOT_FOUND" } }, "BalanceLimitNotFound": { "summary": "BALANCE_LIMIT_NOT_FOUND", "value": { "status": "BALANCE_LIMIT_NOT_FOUND" } }, "CardBudgetNotFound": { "summary": "CARD_BUDGET_NOT_FOUND", "value": { "status": "CARD_BUDGET_NOT_FOUND" } }, "InvalidConfiguration": { "summary": "CANNOT_MATCH_CONFIGURATION", "value": { "status": "CANNOT_MATCH_CONFIGURATION" } }, "WpinNotFound": { "summary": "CANT_FIND_WPIN", "value": { "status": "CANT_FIND_WPIN" } }, "VerificationNotFound": { "summary": "VERIFICATION_NOT_FOUND", "value": { "status": "VERIFICATION_NOT_FOUND" } }, "VerificationDocumentNotExist": { "summary": "VERIFICATION_DOCUMENT_NOT_EXIST", "value": { "status": "VERIFICATION_DOCUMENT_NOT_EXIST" } }, "verificationDocumentAlreadyAttachedToOtherVerification": { "summary": "VERIFICATION_DOCUMENT_ALREADY_ATTACHED_TO_OTHER_VERIFICATION", "value": { "status": "VERIFICATION_DOCUMENT_ALREADY_ATTACHED_TO_OTHER_VERIFICATION" } }, "BalanceSummaryNotFound": { "summary": "CANT_FIND_BALANCE_SUMMARY", "value": { "status": "CANT_FIND_BALANCE_SUMMARY" } }, "OperationNotFound": { "summary": "OPERATION_NOT_FOUND", "value": { "status": "OPERATION_NOT_FOUND" } }, "CantCreateLinkedCard": { "summary": "CANT_CREATE_LINKED_CARD", "value": { "status": "CANT_CREATE_LINKED_CARD" } }, "InvalidCard": { "summary": "INVALID_CARD", "value": { "status": "INVALID_CARD" } }, "ChangePinFailure": { "summary": "CANT_CHANGE_PIN", "value": { "status": "CANT_CHANGE_PIN" } }, "LockCardFailure": { "summary": "CANT_LOCK_CARD", "value": { "status": "CANT_LOCK_CARD" } }, "UnlockCardFailure": { "summary": "CANT_UNLOCK_CARD", "value": { "status": "CANT_UNLOCK_CARD" } }, "LinkCardFailure": { "summary": "CANT_LINK_CARD", "value": { "status": "CANT_LINK_CARD" } }, "ActivateCardFailure": { "summary": "CANT_ACTIVATE_CARD", "value": { "status": "CANT_ACTIVATE_CARD" } }, "UpdateCvvFailure": { "summary": "CANT_UPDATE_CVV", "value": { "status": "CANT_UPDATE_CVV" } }, "DeleteSourceCardFailure": { "summary": "CANT_DELETE_SOURCE_CARD", "value": { "status": "CANT_DELETE_SOURCE_CARD" } }, "StoreCardFailure": { "summary": "CANT_STORE_CARD", "value": { "status": "CANT_STORE_CARD" } }, "CantAcceptVerification": { "summary": "CANT_ACCEPT_VERIFICATION", "value": { "status": "CANT_ACCEPT_VERIFICATION" } }, "CantUpdateBudget": { "summary": "CANT_UPDATE_BUDGET", "value": { "status": "CANT_UPDATE_BUDGET" } }, "CustomerBalanceNotCleared": { "summary": "CUSTOMER_BALANCE_NOT_CLEARED", "value": { "status": "CUSTOMER_BALANCE_NOT_CLEARED" } }, "CustomerAccountingBalanceNotCleared": { "summary": "CUSTOMER_ACCOUNTING_BALANCE_NOT_CLEARED", "value": { "status": "CUSTOMER_ACCOUNTING_BALANCE_NOT_CLEARED" } }, "LastCustomerBalanceLeft": { "summary": "CANT_DELETE_LAST_CUSTOMER_BALANCE", "value": { "status": "CANT_DELETE_LAST_CUSTOMER_BALANCE" } }, "InvalidCurrency": { "summary": "INVALID_CURRENCY", "value": { "status": "INVALID_CURRENCY" } }, "InvalidBalance": { "summary": "INVALID_BALANCE", "value": { "status": "INVALID_BALANCE" } }, "BalanceDisabled": { "summary": "BALANCE_DISABLED", "value": { "status": "BALANCE_DISABLED" } }, "InvalidAmount": { "summary": "INVALID_AMOUNT", "value": { "status": "INVALID_AMOUNT" } }, "InvalidCdd": { "summary": "INVALID_CDD", "value": { "status": "INVALID_CDD", "details": "List name cannot be empty." } }, "CantDeleteCustomer": { "summary": "CANT_DELETE_CUSTOMER", "value": { "status": "CANT_DELETE_CUSTOMER" } }, "CantActivateCard": { "summary": "MAC_ALREADY_ACTIVATED", "value": { "status": "MAC_ALREADY_ACTIVATED" } }, "CantDecryptPayload": { "summary": "CANT_DECRYPT_PAYLOAD", "value": { "status": "CANT_DECRYPT_PAYLOAD" } }, "CustomerAlreadyRegistered": { "summary": "CUSTOMER_ALREADY_REGISTERED", "value": { "status": "CUSTOMER_ALREADY_REGISTERED" } }, "HasPendingVerifications": { "summary": "CUSTOMER_VERIFICATION_IN_PROGRESS", "value": { "status": "CUSTOMER_VERIFICATION_IN_PROGRESS" } }, "PermanentlyLocked": { "summary": "CUSTOMER_PERMANENTLY_LOCKED", "value": { "status": "CUSTOMER_PERMANENTLY_LOCKED" } }, "InvalidCountryCode": { "summary": "INVALID_COUNTRY_CODE", "value": { "status": "INVALID_COUNTRY_CODE" } }, "BudgetAlreadyExists": { "summary": "BUDGET_ALREADY_EXISTS", "value": { "status": "BUDGET_ALREADY_EXISTS" } }, "InsufficientFunds": { "summary": "INSUFFICIENT_FUNDS", "value": { "status": "INSUFFICIENT_FUNDS" } }, "MasterBalanceNotFound": { "summary": "MASTER_BALANCE_NOT_FOUND", "value": { "status": "MASTER_BALANCE_NOT_FOUND" } }, "CurrencyDifferenceError": { "summary": "CURRENCY_DIFFERENCE_ERROR", "value": { "status": "CURRENCY_DIFFERENCE_ERROR" } }, "TransactionAmountExceeded": { "summary": "TRANSACTION_AMOUNT_EXCEEDED", "value": { "status": "TRANSACTION_AMOUNT_EXCEEDED" } }, "TransactionIdConflict": { "summary": "TRANSACTION_ID_CONFLICT", "value": { "status": "TRANSACTION_ID_CONFLICT" } }, "TransactionAlreadyCleared": { "summary": "TRANSACTION_ALREADY_CLEARED", "value": { "status": "TRANSACTION_ALREADY_CLEARED" } }, "TransactionAlreadyReversed": { "summary": "TRANSACTION_ALREADY_REVERSED", "value": { "status": "TRANSACTION_ALREADY_REVERSED" } }, "FraudSuspected": { "summary": "FRAUD_SUSPECTED", "value": { "status": "FRAUD_SUSPECTED" } }, "CardIssuerError": { "summary": "CARD_ISSUER_ERROR", "value": { "status": "CARD_ISSUER_ERROR" } }, "EncryptionRequired": { "summary": "ENCRYPTION_REQUIRED", "value": { "status": "ENCRYPTION_REQUIRED" } }, "InvalidHeaderValue": { "summary": "INVALID_HEADER_VALUE", "value": { "status": "INVALID_HEADER_VALUE" } }, "InvalidPublicKey": { "summary": "INVALID_PUBLIC_KEY", "value": { "status": "INVALID_PUBLIC_KEY" } }, "InvalidParameter": { "summary": "INVALID_PARAMETER", "value": { "status": "INVALID_PARAMETER", "0": "description" } }, "InvalidPayload": { "summary": "INVALID_PAYLOAD", "value": { "status": "INVALID_PAYLOAD" } }, "CustomerLocked": { "summary": "CUSTOMER_LOCKED", "value": { "status": "CUSTOMER_LOCKED" } }, "CardExpired": { "summary": "CARD_EXPIRED", "value": { "status": "CARD_EXPIRED" } }, "CardLocked": { "summary": "CARD_LOCKED", "value": { "status": "CARD_LOCKED" } }, "AlreadyExists": { "summary": "ALREADY_EXISTS", "value": { "status": "ALREADY_EXISTS" } }, "InvalidTransactionType": { "summary": "INVALID_TRANSACTION_TYPE", "value": { "status": "INVALID_TRANSACTION_TYPE" } }, "InvalidTransactionStatus": { "summary": "INVALID_TRANSACTION_STATUS", "value": { "status": "INVALID_TRANSACTION_STATUS" } }, "InvalidDescription": { "summary": "INVALID_DESCRIPTION", "value": { "status": "INVALID_DESCRIPTION" } }, "InvalidResource": { "summary": "INVALID_RESOURCE", "value": { "status": "INVALID_RESOURCE" } }, "TransactionNotFound": { "summary": "TRANSACTION_NOT_FOUND", "value": { "status": "TRANSACTION_NOT_FOUND" } }, "InvalidTransactionReference": { "summary": "INVALID_TRANSACTION_REFERENCE", "value": { "status": "INVALID_TRANSACTION_REFERENCE" } }, "SettlementNotFound": { "summary": "SETTLEMENT_NOT_FOUND", "value": { "status": "SETTLEMENT_NOT_FOUND" } }, "InvalidStatus": { "summary": "INVALID_STATUS", "value": { "status": "INVALID_STATUS" } }, "InvalidSettlementId": { "summary": "INVALID_SETTLEMENT_ID", "value": { "status": "INVALID_SETTLEMENT_ID" } }, "InvalidTransactionId": { "summary": "INVALID_TRANSACTION_ID", "value": { "status": "INVALID_TRANSACTION_ID" } }, "InvalidExternalTransactionId": { "summary": "INVALID_EXTERNAL_TRANSACTION_ID", "value": { "status": "INVALID_EXTERNAL_TRANSACTION_ID" } }, "InvalidLimitParameters": { "summary": "INVALID_LIMIT_PARAMETERS", "value": { "status": "INVALID_LIMIT_PARAMETERS" } }, "InvalidMaxAmount": { "summary": "INVALID_MAX_AMOUNT", "value": { "status": "INVALID_MAX_AMOUNT" } }, "InvalidMaxAttempts": { "summary": "INVALID_MAX_ATTEMPTS", "value": { "status": "INVALID_MAX_ATTEMPTS" } }, "InvalidMccList": { "summary": "INVALID_MCC_LIST", "value": { "status": "INVALID_MCC_LIST" } }, "CurrencyWithTypeMismatch": { "summary": "CURRENCY_WITH_TYPE_MISMATCH", "value": { "status": "CURRENCY_WITH_TYPE_MISMATCH" } }, "InvalidResourceType": { "summary": "INVALID_RESOURCE_TYPE", "value": { "status": "INVALID_RESOURCE_TYPE" } }, "InvalidResourceId": { "summary": "INVALID_RESOURCE_ID", "value": { "status": "INVALID_RESOURCE_ID" } }, "InvalidSenderResourceId": { "summary": "INVALID_SENDER_RESOURCE", "value": { "status": "INVALID_SENDER_RESOURCE" } }, "InvalidReceiverResourceId": { "summary": "INVALID_RECEIVER_RESOURCE", "value": { "status": "INVALID_RECEIVER_RESOURCE" } }, "InvalidReason": { "summary": "INVALID_REASON", "value": { "status": "INVALID_REASON" } }, "CardLimitError": { "summary": "CARD_LIMIT_ERROR", "value": { "status": "CARD_LIMIT_ERROR" } }, "CardLimitExceeded": { "summary": "CARD_LIMIT_EXCEEDED", "value": { "status": "CARD_LIMIT_EXCEEDED" } }, "DepositBalanceNotFound": { "summary": "DEPOSIT_BALANCE_NOT_FOUND", "value": { "status": "DEPOSIT_BALANCE_NOT_FOUND" } }, "InsufficientFundsOnDeposit": { "summary": "INSUFFICIENT_FUNDS_ON_DEPOSIT_BALANCE", "value": { "status": "INSUFFICIENT_FUNDS_ON_DEPOSIT_BALANCE" } }, "AmlException": { "summary": "AML_EXCEPTION", "value": { "status": "AML_EXCEPTION" } }, "InternalServerError": { "summary": "INTERNAL_SERVER_ERROR", "value": { "status": "INTERNAL_SERVER_ERROR" } }, "BadGateway": { "summary": "BAD_GATEWAY", "value": { "status": "BAD_GATEWAY" } }, "VerificationAlreadyExist": { "summary": "VERIFICATION_ALREADY_EXIST", "value": { "status": "VERIFICATION_ALREADY_EXIST" } }, "KycNotVerified": { "summary": "KYC_NOT_VERIFIED", "value": { "status": "KYC_NOT_VERIFIED" } }, "MethodNotAllowed": { "summary": "METHOD_NOT_ALLOWED", "value": { "status": "METHOD_NOT_ALLOWED" } }, "NotFound": { "summary": "NOT_FOUND", "value": { "status": "NOT_FOUND" } }, "NotImplemented": { "summary": "NOT_IMPLEMENTED", "value": { "status": "NOT_IMPLEMENTED" } }, "ConfigIdRequired": { "summary": "CONFIG_ID_REQUIRED", "value": { "status": "CONFIG_ID_REQUIRED" } }, "InvalidBalanceId": { "summary": "INVALID_BALANCE_ID", "value": { "status": "INVALID_BALANCE_ID" } }, "BalanceIdRequired": { "summary": "BALANCE_ID_REQUIRED", "value": { "status": "BALANCE_ID_REQUIRED" } }, "BalanceNotFound": { "summary": "BALANCE_NOT_FOUND", "value": { "status": "BALANCE_NOT_FOUND" } }, "InvalidCustomerId": { "summary": "INVALID_CUSTOMER_ID", "value": { "status": "INVALID_CUSTOMER_ID" } }, "InvalidRangeFrom": { "summary": "INVALID_RANGE_FROM", "value": { "status": "INVALID_RANGE_FROM" } }, "InvalidRangeTo": { "summary": "INVALID_RANGE_TO", "value": { "status": "INVALID_RANGE_TO" } }, "FieldIsRequired": { "summary": "FIELD_IS_REQUIRED", "value": { "status": "FIELD_IS_REQUIRED" } }, "DateIsInvalid": { "summary": "DATE_IS_INVALID", "value": { "status": "DATE_IS_INVALID" } }, "DateFormatIsInvalid": { "summary": "DATE_FORMAT_IS_INVALID", "value": { "status": "DATE_FORMAT_IS_INVALID" } }, "InvalidBalanceOwner": { "summary": "INVALID_BALANCE_OWNER", "value": { "status": "INVALID_BALANCE_OWNER" } }, "InvalidContrahentData": { "summary": "INVALID_CONTRAHENT_DATA", "value": { "status": "INVALID_CONTRAHENT_DATA" } }, "InvalidId": { "summary": "INVALID_ID_FORMAT", "value": { "status": "INVALID_ID_FORMAT" } }, "create error": { "summary": "CANNOT_CREATE", "value": { "status": "CANNOT_CREATE" } }, "invalid limit currency": { "summary": "INVALID_LIMIT_CURRENCY", "value": { "status": "INVALID_LIMIT_CURRENCY" } }, "limit already exists": { "summary": "LIMIT_ALREADY_EXISTS", "value": { "status": "LIMIT_ALREADY_EXISTS" } } }, "securitySchemes": { "bearerAuth": { "type": "http", "description": "Depending on methods you're calling two types of tokens are supported. Admin methods - JWT from admin panel. Customer methods - session token obtained from DataCore (eg. after pair device).", "name": "Authorization", "in": "header", "scheme": "bearer" } } }, "tags": [ { "name": "Async Operation", "description": "Async Operation" }, { "name": "Secure - Balances", "description": "Secure - Balances" }, { "name": "Secure - Master Balance", "description": "Secure - Master Balance" }, { "name": "Secure - Customer Balance", "description": "Secure - Customer Balance" }, { "name": "Secure - Balance", "description": "Secure - Balance" }, { "name": "Secure - Cards", "description": "Secure - Cards" }, { "name": "Secure - Customer Cards", "description": "Secure - Customer Cards" }, { "name": "Secure - Corporations", "description": "Secure - Corporations" }, { "name": "Secure - Corporation Cards", "description": "Secure - Corporation Cards" }, { "name": "Secure - Customers Due Diligence", "description": "Secure - Customers Due Diligence" }, { "name": "Secure - Customer", "description": "Secure - Customer" }, { "name": "Secure - Documents", "description": "Secure - Documents" }, { "name": "Secure - Locks", "description": "Secure - Locks" }, { "name": "Secure - Financial Institution report", "description": "Secure - Financial Institution report" }, { "name": "Secure - Transactions report", "description": "Secure - Transactions report" }, { "name": "Secure - Transactions", "description": "Secure - Transactions" }, { "name": "Secure - Verification Documents", "description": "Secure - Verification Documents" }, { "name": "Secure - Verifications", "description": "Secure - Verifications" }, { "name": "Secure - Customer Registration", "description": "Secure - Customer Registration" }, { "name": "Secure - Public Key", "description": "Secure - Public Key" } ], "security": [ { "bearerAuth": [] } ] }