1 line
73 KiB
JSON
1 line
73 KiB
JSON
{"openapi":"3.0.1","info":{"title":"Profee WaaS integration API","description":"<h1>Welcome to the Profee wallet-as-a-service API documentation.</h1>\n<p>Our API allow you to embed financial services into your product: enable your users to hold funds, manage cash flow,\n issue virtual card and make payments.</p>\n<p>\n This documentation provides you with the following information divided into sections:\n</p>\n<ul>\n <li>Authentication: procedure we use for verifying clients connecting to API;\n We use basic authorization, which works quite simple: just encode in base64 the following\n 'your login':'password' and put the result under authorization header.\n </li>\n <li>Wallets: creation of user wallet, getting information about wallet state and upgrading to verified level that\n increases wallet available limits;\n </li>\n <li>Payments: obtain information about available payment methods, checking availability and charges applied to\n specific payment, payment creation;\n </li>\n <li>Cards: creation of virtual card for your user and obtaining card details, balance, transaction history,\n getting\n </li>\n</ul>\n<p>\n list of tokenized cards issued in other banks available for user to make transfers.\n</p>\n<p>\n This is a living document to be updated regularly with new functionality. To access our sandbox or address questions\n to our developers please contact: <a href=\"mailto:waasteam@profeelab.net\">waasteam@profeelab.net</a>\n</p>","license":{"name":"Profee","url":"http://profee.com"},"version":"v0.0.1"},"servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"tags":[{"name":"Payments","description":"We provide the list of payments methods for registered users. For each payment method, we give you a unique `methodId`.\n\nPayment methods are divided by types, provided in `methodType`.\n\n### Method types:\n\n- `Wallet to wallet` - a payment between users and their wallets.\n- `Wallet to partner` - a payment from user's wallet to partner.\n- `Paysafecash to wallet` - a topping up user’s wallet via Paysafecash. Give the opportunity to up user’s wallet with cash.\n- `Shift to card`- a payment from user's wallet to card issued via Profee.\n- `Shift to wallet` - a payment from card issued via Profee to user's wallet.\n\n\n\nOverview of steps:\n\n"},{"name":"Wallets","description":"We create a wallet for each User of our partner, which is the registration of users.\nIt is the starting point for interacting with our service\n\nWe have several critical restrictions for registering clients creating wallets:\n\n- The User must be over 18 years old\n- Unique phone number\n- Unique email\n\nOverview of steps:\n\n"},{"name":"Cards","description":"Our service allows you to issue bank cards for users. We can issue virtual and plastic cards. We also have a partner who will deliver plastic cards. Check the list of countries supported for cards delivery.\n\nWe will provide you different `productId` in order to issue plastic and virtual card on stage and product environments.\n\n> 💡 Сard issuing is available only for verified users and users with level PLUS or PREMIUM. You can check it via request `/get-wallet`\n\nOverview of steps:\n\n"}],"paths":{"/wallet/get-wallet":{"post":{"tags":["Wallets"],"summary":"Get wallet","description":"Returns current limit and wallet status.","operationId":"getWallet","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerGetWalletRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerWalletDto"}}}}}}},"/wallet/get-verification-token":{"post":{"tags":["Wallets"],"summary":"Getting the token to document verification SDK","description":"Get token to open our know your customer service vendor SDK\n\nFully provides document upload functions, including initial photo verification. \nUsing the SDK greatly simplifies the document upload process for both the user and the development team. \nThis is especially important for uploading video selfies.\nAfter getting this token, you need to use one of the SDKs provided by our partners: mobile or WEB.\nToken unique for each wallet.More information in the partner documentation:\nhttps://developers.sumsub.com/api-reference/\n","operationId":"getVerificationToken","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerVerificationTokenRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerVerificationTokenDto"}}}}}}},"/wallet/get-documents-status":{"post":{"tags":["Wallets"],"summary":"Getting the status of added documents","description":"Get the status of all added documents for verification with a single request. \n\nTo understand what is happening with customer's documents, you should look at the status of each added document in response.\n\n### Warnings\n\nFirst, you need to look at is `documentStatusDTO/warnings`. It will show the precheck result. You can ignore it, or communicate to the customer and ask him to re-upload a particular `documentType`. \n\n### Review answers\n\nGeneral answer on screening of particular document and `documentType` you can find in `documentStatusDTO/reviewResult/reviewAnswer`. \n\n- GREEN - The `documentType`can be accepted and successfully verified. You can upload more then one document for each `documentType`, if you get one `GREEN` for one of them it means this `documentType` approved and you can ignore other documents with the same `documentType`.\n- RED - The document for a particular `documentType` has been rejected.\n\n### Reject types of review answers\n\nYou need to look in `documentStatusDTO/reviewResult/reviewRejectType` to quickly understand is it final or not.\nIf you got `reviewAnswer` RED- `reviewAnswer` we have to understand is it Final or not. \n\n- `Final` - means that document finally rejected, and customer also rejected and will not be approved with another document.\n- `Retry` - The \"retry\" rejection means that customer needs to re-upload a document. For example, by uploading a better quality image. More information about the reason and what to suggest to the customer you can find in the `rejectLabels`.\n\n## Errors and warnings. \nErrors and warnings means that is uploaded document are not OK. If errors or warnings is present user should be able upload another photo. \n#### Errors list \n\n- `FORBIDDEN_DOCUMENT`\tUnsupported or unacceptable type/country of document.\n- `DIFFERENT_DOC_TYPE_OR_COUNTRY`\tDocument type or country mismatches ones that was sent with metadata.\n- `MISSING_IMPORTANT_INFO`\tNot all required document data can be recognized.\n- `DATA_NOT_READABLE`\tThere is no available data to recognize from image.\n- `EXPIRED_DOC`\tDocument validity date is expired.\n- `DOCUMENT_WAY_TOO_MUCH_OUTSIDE`\tNot all parts of the documents are visible.\n- `GRAYSCALE`\tBlack and white image.\n- `NO_ID_DOC_FACE_PHOTO`\tFace is not clearly visible on the document.\n- `SELFIE_FACE_BAD_QUALITY`\tFace is not clearly visible on the selfie.\n- `SCREEN_RECAPTURE`\tImage might be a photo of screen.\n- `SCREENSHOT`\tImage is a screenshot.\n- `SAME_SIDES`\tImage of the same side of document was uploaded as front and back sides.\n- `SHOULD_BE_MRZ_DOCUMENT`\tSent document type should have an MRZ, but there is no readable MRZ on the image.\n- `SHOULD_BE_DOUBLE_SIDED`\tTwo sides of the sent document should be presented.\n- `SHOULD_BE_DOUBLE_PAGED`\tThe full double-page of the document are required.\n- `DOCUMENT_DECLINED_BEFORE`\tThe same image was uploaded and declined earlier.\n- `UNEXPECTED_DOCUMENT_VERIFICATION_ERROR`\tUnexpected error occurred.\n#### Warnings list \n\n- `BAD_SELFIE`\tMake sure that your face and the photo in the document are clearly visible.\n- `DATA_READABILITY`\tPlease make sure that the information in the document is easy to read.\n- `INCONSISTENT_DOCUMENT`\tPlease ensure that all uploaded photos are of the same document.\n- `MAYBE_EXPIRED_DOC`\tYour document appears to be expired.\n- `DOCUMENT_TOO_MUCH_OUTSIDE`\tPlease ensure that the document completely fits the photo.\n- `UNEXPECTED_DOCUMENT_VERIFICATION_WARNING`\tUnexpected warning occurred.\n#","operationId":"getDocumentsStatus","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerDocumentsStatusRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerDocumentsStatusDto"}}}}}}},"/wallet/create-wallet":{"post":{"tags":["Wallets"],"summary":"Create wallet","description":"Creates a wallet to register your users in our system. Specify all the necessary data for new wallet registration.","operationId":"createWallet","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerCreateWalletRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerWalletDto"}}}}}}},"/wallet/add-document":{"post":{"tags":["Wallets"],"summary":"Add verification document","description":"To verify a User’s identity with Profee, we need to receive documentation:\n\n- A document to confirm the User’s identity.\n- A separate document to confirm the User’s place of residence\n- A selfie holding the document provided in the previous point","operationId":"addDocument","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerAddDocumentRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerAddDocumentResponseDto"}}}}}}},"/payment/get-payment":{"post":{"tags":["Payments"],"summary":"Get payment","description":"Returns current information about the payment and its status.","operationId":"getPayment","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerGetPaymentRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerBasePaymentResponseDto"}}}}}}},"/payment/get-history":{"post":{"tags":["Payments"],"summary":"Get payments history","description":"Returns wallet payments history","operationId":"getHistory","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerGetPaymentHistoryRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerPaymentHistoryResponseDto"}}}}}}},"/payment/create-payment":{"post":{"tags":["Payments"],"summary":"Create payment","description":"Creates a payment on a pre-placed payment order. ","operationId":"createPayment","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerCreatePaymentRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerBasePaymentResponseDto"}}}}}}},"/payment/create-payment-order":{"post":{"tags":["Payments"],"summary":"Create payment order","description":"Creates an order to make a payment for registered users.\n\nIt is the first step of making payment. Here we check the possibility to process a payment and calculate fees.\n\nWhen checking the possibility of making payments, we check:\n\n- balance of payment sender\n- daily and monthly limits of wallet\n- availability of another wallet for `Wallet to wallet` payment type\n\n> 💡 You can set up`/to/amount` for many payment methods and `/from/amount`. You should use only one of them: `/to/amount` OR `/from/amount.` This functionality makes it possible to calculate the missing amount by direct or reverse calculation, and we will do it ourselves.\n","operationId":"createPaymentOrder","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerBasePaymentOrderRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerBasePaymentOrderResponseDto"}}}}}}},"/card/get-card":{"post":{"tags":["Cards"],"summary":"Get Profee card information","description":"Get general information about the issued card and its current status.","operationId":"getCard","parameters":[{"name":"WAAS_CLIENT_IP","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerGetCardRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerCardDto"}}}}}}},"/card/get-card-operations":{"post":{"tags":["Cards"],"summary":"Get Profee card operation history","description":"Returns the history of operations by one card for any 31 days. You just need to specify two parameters :\n\n- `fromDate` - starting date in the past which you want to get transactions from. Format is `YYYY-MM-DD`\n- `daysCount` - days from starting date to the future\n\nExamples:\n\n- if you want to see history for January 2022, you should specify `\"fromDate\": \"2022-01-01\"` with `\"daysCount\": \"31\"` days\n- If you want to see history for the current day, you should specify `\"fromDate\": [Current date]` with `\"daysCount\": \"1\"` days\n","operationId":"getCardOperations","parameters":[{"name":"WAAS_CLIENT_IP","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerCardOperationsRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerCardOperationsDto"}}}}}}},"/card/get-card-details":{"post":{"tags":["Cards"],"summary":"Get Profee card details","description":"Returns sensitive card details. We use the RSA algorithm to encrypt sensitive data in response. To operate request `/get-card-details`, you need to generate for us a public RSA key with 4096-bit size. Please keep private key in safe. Better to prepare two couples of keys at once: one couple for testing and another one for production.\n\nWe encrypt a few fields in the response: pan, CVV, expiry date. For decryption, you need to use your private keys.","operationId":"getCardDetails","parameters":[{"name":"WAAS_CLIENT_IP","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerGetCardDetailsRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerCardSecureDto"}}}}}}},"/card/get-card-balance":{"post":{"tags":["Cards"],"summary":"Get Profee card balance","description":"Returns the current balance of the card and the amount of active holds.\n\n- For details:\n\n> balance - available balance\n> \n> authorizedBalance - total amount of active holds","operationId":"getCardBalance","parameters":[{"name":"WAAS_CLIENT_IP","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerGetCardBalanceRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerCardBalanceDto"}}}}}}},"/card/create-card":{"post":{"tags":["Cards"],"summary":"Create Profee card","description":"Issue new Profee card.","operationId":"createCard","parameters":[{"name":"waas-client-ip","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerCreateCardRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerCardDto"}}}}}}},"/card/change-card-status":{"post":{"tags":["Cards"],"summary":"Freeze/Unfreeze Profee card","operationId":"changeCardStatus","parameters":[{"name":"WAAS_CLIENT_IP","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerChangeCardStatusRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerChangeCardStatusResponseDto"}}}}}}},"/card/activate-plastic-card":{"post":{"tags":["Cards"],"summary":"Plactic Profee card activation","description":"In the case of issuing the plastic card, we deliver a postal envelope to the customer with plastic card and approval code. Customer need to activate the card with an approval code.","operationId":"activatePlasticCard","parameters":[{"name":"WAAS_CLIENT_IP","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRequestContainerPlasticCardActivationRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseContainerCardDto"}}}}}}}},"components":{"schemas":{"ApiRequestContainerGetWalletRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/GetWalletRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"GetWalletRequestDto":{"required":["walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"}},"description":"Request model to Get Wallet"},"ApiResponseContainerWalletDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/WalletDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"BalanceDto":{"required":["money"],"type":"object","properties":{"money":{"$ref":"#/components/schemas/MoneyDto"}},"description":"Balance"},"LimitDto":{"required":["sum","type"],"type":"object","properties":{"sum":{"$ref":"#/components/schemas/MoneyDto"},"type":{"type":"string","description":"Limit type","enum":["DAILY_TO","DAILY_FROM","MONTHLY_TO","MONTHLY_FROM","YEARLY_TO","YEARLY_FROM","GAMBLE"]}},"description":"Limit information"},"MoneyDto":{"required":["currency"],"type":"object","properties":{"amount":{"type":"number","description":"Amount of money. Can be null."},"currency":{"type":"string","description":"Currency represented in alpha codes ISO 4217"}},"description":"Amount and currency"},"ResponseStatus":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","description":"Response code (for machine)","enum":["OK","CREATED","BAD_REQUEST","RESIDENT_COUNTRY_FORBIDDEN","UNEXPECTED_ERROR","CONFLICT","EMAIL_IS_NOT_VERIFIED","PRODUCT_NOT_FOUND","WRONG_PRODUCT","CARD_NOT_FOUND","WALLET_NOT_FOUND","MAX_CARD_COUNT_REACHED","WAAS_PARTNER_NOT_CONFIGURED","VERIFICATION_LEVEL_NOT_ENOUGH","WRONG_CARD_STATUS","FAILED_TO_ACTIVATE_PLASTIC_CARD","WRONG_WALLET_IDENT_STATUS","PAYMENT_ALREADY_EXISTS","INVALID_DAYS_COUNT","CHANGE_CARD_STATUS_FAILED","INAPPROPRIATE_CARD_STATUS","CARD_DETAILS_DELIVERY_FAILED","VALIDATION_ERROR","CLIENT_IP_NOT_VALID","UNAUTHORIZED","FAILED_TO_GET_SDK_TOKEN"]},"message":{"type":"string","description":"Response message (for developer)"}},"description":"Response status"},"WalletDto":{"required":["balances","externalId","limits","status","verificationLevel","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"balances":{"type":"array","description":"Balances in all available currencies","items":{"$ref":"#/components/schemas/BalanceDto"}},"limits":{"type":"array","description":"Limits information in all available currencies","items":{"$ref":"#/components/schemas/LimitDto"}},"verificationLevel":{"type":"string","description":"User's Wallet verification level (KYC)","enum":["UNVERIFIED","BASIC","PLUS","PREMIUM"]},"status":{"type":"string","description":"Wallet Status","enum":["ACTIVE","LOCKED","BLOCKED"]},"externalId":{"type":"string","description":"External ID - Wallet ID in Merchant system"}},"description":"Wallet information"},"ApiRequestContainerVerificationTokenRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/VerificationTokenRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"VerificationTokenRequestDto":{"required":["walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"}},"description":"Request to get verification token"},"ApiResponseContainerVerificationTokenDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/VerificationTokenDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"VerificationTokenDto":{"required":["verificationToken","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"verificationToken":{"type":"string","description":"Token to open SDK"}},"description":"Token to open SDK"},"ApiRequestContainerDocumentsStatusRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/DocumentsStatusRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"DocumentsStatusRequestDto":{"required":["walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"}},"description":"Request to get the status of added user documents"},"ApiResponseContainerDocumentsStatusDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/DocumentsStatusDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"DocumentStatusDto":{"type":"object","properties":{"id":{"type":"string","description":"Document ID, generated when adding a document"},"documentType":{"type":"string","description":"Document type","enum":["ID_CARD","PASSPORT","DRIVERS","BANK_CARD","UTILITY_BILL","BANK_STATEMENT","SELFIE","VIDEO_SELFIE","PROFILE_IMAGE","ID_DOC_PHOTO","AGREEMENT","CONTRACT","RESIDENCE_PERMIT","EMPLOYMENT_CERTIFICATE","DRIVERS_TRANSLATION","INVESTOR_DOC","VEHICLE_REGISTRATION_CERTIFICATE","INCOME_SOURCE","PAYMENT_METHOD","OTHER"]},"documentSubType":{"type":"string","description":"Document sub type","enum":["FRONT_SIDE","BACK_SIDE"]},"proofSubject":{"type":"string","description":"Proof subject of document. Can be proof of residence, proof of identity or selfie","enum":["POI","SELFIE","POR"]},"reviewResult":{"$ref":"#/components/schemas/ReviewResult"},"errors":{"type":"array","description":"Errors, encountered during document verification","items":{"type":"string","description":"Errors, encountered during document verification","enum":["FORBIDDEN_DOCUMENT","DIFFERENT_DOC_TYPE_OR_COUNTRY","MISSING_IMPORTANT_INFO","DATA_NOT_READABLE","EXPIRED_DOC","DOCUMENT_WAY_TOO_MUCH_OUTSIDE","GRAYSCALE","NO_ID_DOC_FACE_PHOTO","SELFIE_FACE_BAD_QUALITY","SCREEN_RECAPTURE","SCREENSHOT","SAME_SIDES","SHOULD_BE_MRZ_DOCUMENT","SHOULD_BE_DOUBLE_SIDED","SHOULD_BE_DOUBLE_PAGED","DOCUMENT_DECLINED_BEFORE","UNEXPECTED_DOCUMENT_VERIFICATION_ERROR"]}},"warnings":{"type":"array","description":"Warnings, encountered during document verification","items":{"type":"string","description":"Warnings, encountered during document verification","enum":["BAD_SELFIE","DATA_READABILITY","INCONSISTENT_DOCUMENT","MAYBE_EXPIRED_DOC","DOCUMENT_TOO_MUCH_OUTSIDE","UNEXPECTED_DOCUMENT_VERIFICATION_WARNING"]}}},"description":"Status of added document"},"DocumentsStatusDto":{"required":["documentsStatus","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"documentsStatus":{"type":"array","description":"Added documents status","items":{"$ref":"#/components/schemas/DocumentStatusDto"}}},"description":"Added documents status"},"ReviewResult":{"type":"object","properties":{"moderationComment":{"type":"string","description":"Moderation comment"},"clientComment":{"type":"string","description":"Client comment"},"reviewAnswer":{"type":"string","description":"The overall result of the test. Green means the document was successfully verified, red - violations detected.","enum":["GREEN","RED"]},"rejectLabels":{"type":"array","description":"A list of violation codes found during document verification.\n\n|Value|Default| reviewRejectTypeDescription|\n|-----|--------|-------------------------------|\n|FORGERY|FINAL|Forgery attempt has been made|\n|DOCUMENT_TEMPLATE|FINAL|Documents supplied are templates, downloaded from internet|\n|LOW_QUALITY|RETRY|Documents have low-quality that does not allow definitive conclusions to be made|\n|SPAM|FINAL|An applicant has been created by mistake or is just a spam user (irrelevant images were supplied)|\n|NOT_DOCUMENT|RETRY|Documents supplied are not relevant for the verification procedure|\n|SELFIE_MISMATCH|FINAL|A user photo (profile image) does not match a photo on the provided documents|\n|ID_INVALID|RETRY|A document that identifies a person (like a passport or an ID card) is not valid|\n|FOREIGNER|FINAL|When a client does not accept applicants from a different country or e.g. without a residence permit|\n|DUPLICATE|FINAL|This applicant was already created for this client, and duplicates are not allowed by the regulations|\n|BAD_AVATAR|RETRY|When avatar does not meet the client's requirements|\n|WRONG_USER_REGION|FINAL|When applicants from certain regions/countries are not allowed to be registered|\n|INCOMPLETE_DOCUMENT|RETRY|Some information is missing from the document, or it's partially visible|\n|BLACKLIST|FINAL|User is blacklisted|\n|UNSATISFACTORY_PHOTOS|RETRY|There were problems with the photos, like poor quality or masked information|\n|DOCUMENT_PAGE_MISSING|RETRY|Some pages of a document are missing (if applicable)|\n|DOCUMENT_DAMAGED|RETRY|Document is damaged|\n|REGULATIONS_VIOLATIONS|FINAL|Regulations violations|\n|INCONSISTENT_PROFILE|FINAL|Data or documents of different persons were uploaded to one applicant|\n|PROBLEMATIC_APPLICANT_DATA|RETRY|Applicant data does not match the data in the documents|\n|ADDITIONAL_DOCUMENT_REQUIRED|RETRY|Additional documents required to pass the check|\n|AGE_REQUIREMENT_MISMATCH|FINAL|Age requirement is not met (e.g. cannot rent a car to a person below 25yo)|\n|EXPERIENCE_REQUIREMENT_MISMATCH|FINAL|Not enough experience (e.g. driving experience is not enough)|\n|CRIMINAL|FINAL|The user is involved in illegal actions|\n|WRONG_ADDRESS|RETRY|The address from the documents doesn't match the address that the user entered|\n|GRAPHIC_EDITOR|RETRY|The document has been edited by a graphical editor|\n|DOCUMENT_DEPRIVED|RETRY|The user has been deprived of the document|\n|COMPROMISED_PERSONS|FINAL|The user does not correspond to Compromised Person Politics|\n|PEP|FINAL|The user belongs to the PEP category|\n|ADVERSE_MEDIA|FINAL|The user was found in the adverse media|\n|FRAUDULENT_PATTERNS|FINAL|Fraudulent behavior was detected|\n|SANCTIONS|FINAL|The user was found on sanction lists|\n|NOT_ALL_CHECKS_COMPLETED|RETRY|All checks were not completed|\n|FRONT_SIDE_MISSING|RETRY|Front side of the document is missing|\n|BACK_SIDE_MISSING|RETRY|Back side of the document is missing|\n|SCREENSHOTS|RETRY|The user uploaded screenshots|\n|BLACK_AND_WHITE|RETRY|The user uploaded black and white photos of documents|\n|INCOMPATIBLE_LANGUAGE|RETRY|The user should upload translation of his document|\n|EXPIRATION_DATE|RETRY|The user uploaded expired document|\n|UNFILLED_ID|RETRY|The user uploaded the document without signatures and stamps|\n|BAD_SELFIE|RETRY|The user uploaded a bad selfie|\n|BAD_VIDEO_SELFIE|RETRY|The user uploaded a bad video selfie|\n|BAD_FACE_MATCHING|RETRY|Face check between document and selfie failed|\n|BAD_PROOF_OF_IDENTITY|RETRY|The user uploaded a bad ID document|\n|BAD_PROOF_OF_ADDRESS|RETRY|The user uploaded a bad proof of address|\n|BAD_PROOF_OF_PAYMENT|RETRY|The user uploaded a bad proof of payment|\n|SELFIE_WITH_PAPER|RETRY|The user should upload a special selfie (e.g. selfie with paper and date on it)|\n|FRAUDULENT_LIVENESS|FINAL|There was an attempt to bypass liveness check|\n|OTHER|RETRY|Some unclassified reason|\n|REQUESTED_DATA_MISMATCH|RETRY|Provided info doesn't match with recognized from document data|\n|OK|RETRY|Custom reject label|\n|COMPANY_NOT_DEFINED_STRUCTURE|RETRY|Could not establish the entity's control structure|\n|COMPANY_NOT_DEFINED_BENEFICIARIES|RETRY|Could not identify and duly verify the entity's beneficial owners|\n|COMPANY_NOT_VALIDATED_BENEFICIARIES|RETRY|Beneficiaries are not validated|\n|COMPANY_NOT_DEFINED_REPRESENTATIVES|RETRY|Representatives are not defined|\n|COMPANY_NOT_VALIDATED_REPRESENTATIVES|RETRY|Representatives are not validated|\n","items":{"type":"string","description":"A list of violation codes found during document verification.\n\n|Value|Default| reviewRejectTypeDescription|\n|-----|--------|-------------------------------|\n|FORGERY|FINAL|Forgery attempt has been made|\n|DOCUMENT_TEMPLATE|FINAL|Documents supplied are templates, downloaded from internet|\n|LOW_QUALITY|RETRY|Documents have low-quality that does not allow definitive conclusions to be made|\n|SPAM|FINAL|An applicant has been created by mistake or is just a spam user (irrelevant images were supplied)|\n|NOT_DOCUMENT|RETRY|Documents supplied are not relevant for the verification procedure|\n|SELFIE_MISMATCH|FINAL|A user photo (profile image) does not match a photo on the provided documents|\n|ID_INVALID|RETRY|A document that identifies a person (like a passport or an ID card) is not valid|\n|FOREIGNER|FINAL|When a client does not accept applicants from a different country or e.g. without a residence permit|\n|DUPLICATE|FINAL|This applicant was already created for this client, and duplicates are not allowed by the regulations|\n|BAD_AVATAR|RETRY|When avatar does not meet the client's requirements|\n|WRONG_USER_REGION|FINAL|When applicants from certain regions/countries are not allowed to be registered|\n|INCOMPLETE_DOCUMENT|RETRY|Some information is missing from the document, or it's partially visible|\n|BLACKLIST|FINAL|User is blacklisted|\n|UNSATISFACTORY_PHOTOS|RETRY|There were problems with the photos, like poor quality or masked information|\n|DOCUMENT_PAGE_MISSING|RETRY|Some pages of a document are missing (if applicable)|\n|DOCUMENT_DAMAGED|RETRY|Document is damaged|\n|REGULATIONS_VIOLATIONS|FINAL|Regulations violations|\n|INCONSISTENT_PROFILE|FINAL|Data or documents of different persons were uploaded to one applicant|\n|PROBLEMATIC_APPLICANT_DATA|RETRY|Applicant data does not match the data in the documents|\n|ADDITIONAL_DOCUMENT_REQUIRED|RETRY|Additional documents required to pass the check|\n|AGE_REQUIREMENT_MISMATCH|FINAL|Age requirement is not met (e.g. cannot rent a car to a person below 25yo)|\n|EXPERIENCE_REQUIREMENT_MISMATCH|FINAL|Not enough experience (e.g. driving experience is not enough)|\n|CRIMINAL|FINAL|The user is involved in illegal actions|\n|WRONG_ADDRESS|RETRY|The address from the documents doesn't match the address that the user entered|\n|GRAPHIC_EDITOR|RETRY|The document has been edited by a graphical editor|\n|DOCUMENT_DEPRIVED|RETRY|The user has been deprived of the document|\n|COMPROMISED_PERSONS|FINAL|The user does not correspond to Compromised Person Politics|\n|PEP|FINAL|The user belongs to the PEP category|\n|ADVERSE_MEDIA|FINAL|The user was found in the adverse media|\n|FRAUDULENT_PATTERNS|FINAL|Fraudulent behavior was detected|\n|SANCTIONS|FINAL|The user was found on sanction lists|\n|NOT_ALL_CHECKS_COMPLETED|RETRY|All checks were not completed|\n|FRONT_SIDE_MISSING|RETRY|Front side of the document is missing|\n|BACK_SIDE_MISSING|RETRY|Back side of the document is missing|\n|SCREENSHOTS|RETRY|The user uploaded screenshots|\n|BLACK_AND_WHITE|RETRY|The user uploaded black and white photos of documents|\n|INCOMPATIBLE_LANGUAGE|RETRY|The user should upload translation of his document|\n|EXPIRATION_DATE|RETRY|The user uploaded expired document|\n|UNFILLED_ID|RETRY|The user uploaded the document without signatures and stamps|\n|BAD_SELFIE|RETRY|The user uploaded a bad selfie|\n|BAD_VIDEO_SELFIE|RETRY|The user uploaded a bad video selfie|\n|BAD_FACE_MATCHING|RETRY|Face check between document and selfie failed|\n|BAD_PROOF_OF_IDENTITY|RETRY|The user uploaded a bad ID document|\n|BAD_PROOF_OF_ADDRESS|RETRY|The user uploaded a bad proof of address|\n|BAD_PROOF_OF_PAYMENT|RETRY|The user uploaded a bad proof of payment|\n|SELFIE_WITH_PAPER|RETRY|The user should upload a special selfie (e.g. selfie with paper and date on it)|\n|FRAUDULENT_LIVENESS|FINAL|There was an attempt to bypass liveness check|\n|OTHER|RETRY|Some unclassified reason|\n|REQUESTED_DATA_MISMATCH|RETRY|Provided info doesn't match with recognized from document data|\n|OK|RETRY|Custom reject label|\n|COMPANY_NOT_DEFINED_STRUCTURE|RETRY|Could not establish the entity's control structure|\n|COMPANY_NOT_DEFINED_BENEFICIARIES|RETRY|Could not identify and duly verify the entity's beneficial owners|\n|COMPANY_NOT_VALIDATED_BENEFICIARIES|RETRY|Beneficiaries are not validated|\n|COMPANY_NOT_DEFINED_REPRESENTATIVES|RETRY|Representatives are not defined|\n|COMPANY_NOT_VALIDATED_REPRESENTATIVES|RETRY|Representatives are not validated|\n","enum":["FORGERY","DOCUMENT_TEMPLATE","LOW_QUALITY","SPAM","NOT_DOCUMENT","SELFIE_MISMATCH","ID_INVALID","FOREIGNER","DUPLICATE","BAD_AVATAR","WRONG_USER_REGION","INCOMPLETE_DOCUMENT","BLACKLIST","UNSATISFACTORY_PHOTOS","DOCUMENT_PAGE_MISSING","DOCUMENT_DAMAGED","REGULATIONS_VIOLATIONS","INCONSISTENT_PROFILE","PROBLEMATIC_APPLICANT_DATA","ADDITIONAL_DOCUMENT_REQUIRED","AGE_REQUIREMENT_MISMATCH","EXPERIENCE_REQUIREMENT_MISMATCH","CRIMINAL","WRONG_ADDRESS","GRAPHIC_EDITOR","DOCUMENT_DEPRIVED","COMPROMISED_PERSONS","PEP","ADVERSE_MEDIA","FRAUDULENT_PATTERNS","SANCTIONS","NOT_ALL_CHECKS_COMPLETED","FRONT_SIDE_MISSING","BACK_SIDE_MISSING","SCREENSHOTS","BLACK_AND_WHITE","INCOMPATIBLE_LANGUAGE","EXPIRATION_DATE","UNFILLED_ID","BAD_SELFIE","BAD_VIDEO_SELFIE","BAD_FACE_MATCHING","BAD_PROOF_OF_IDENTITY","BAD_PROOF_OF_ADDRESS","BAD_PROOF_OF_PAYMENT","SELFIE_WITH_PAPER","OTHER"]}},"reviewRejectType":{"type":"string","description":"Whether the rejection is final. The \"retry\" rejection can be corrected, for example, by uploading a better quality image (more information in the rejection labels)","enum":["FINAL","RETRY","EXTERNAL"]}},"description":"The results of the document verification"},"ApiRequestContainerCreateWalletRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/CreateWalletRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"CreateWalletRequestDto":{"required":["citizenship","dateOfBirth","email","externalId","firstName","lastName","phone","residence"],"type":"object","properties":{"phone":{"type":"integer","description":"User's phone number (must be verified before performing request)","format":"int64"},"email":{"type":"string","description":"User's email"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"dateOfBirth":{"pattern":"yyyy-MM-dd","type":"string","description":"User's date of birth","format":"date"},"citizenship":{"maxLength":3,"minLength":3,"pattern":"[a-zA-Z]{3}","type":"string","description":"User's citizenship Alpha-3 code"},"residence":{"maxLength":3,"minLength":3,"pattern":"[a-zA-Z]{3}","type":"string","description":"User's residence Alpha-3 code"},"externalId":{"type":"string","description":"External ID - Wallet ID in Merchant system"}},"description":"Request model to Create Wallet"},"AddDocumentRequestDto":{"required":["countryCode","documentContent","documentType","proofSubject","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"documentType":{"type":"string","description":"Personal document type","enum":["ID_CARD","PASSPORT","DRIVERS","BANK_CARD","UTILITY_BILL","BANK_STATEMENT","SELFIE","VIDEO_SELFIE","PROFILE_IMAGE","ID_DOC_PHOTO","AGREEMENT","CONTRACT","RESIDENCE_PERMIT","EMPLOYMENT_CERTIFICATE","DRIVERS_TRANSLATION","INVESTOR_DOC","VEHICLE_REGISTRATION_CERTIFICATE","INCOME_SOURCE","PAYMENT_METHOD","OTHER"]},"documentSubType":{"type":"string","description":"Personal document sub-type","enum":["FRONT_SIDE","BACK_SIDE"]},"proofSubject":{"type":"string","description":"Proof subject of document. Can be proof of residence, proof of identity or selfie","enum":["POI","SELFIE","POR"]},"countryCode":{"maxLength":3,"minLength":0,"type":"string","description":"3-letter country code"},"firstName":{"type":"string","description":"First name"},"middleName":{"type":"string","description":"Middle name"},"lastName":{"type":"string","description":"Last name"},"issuedDate":{"type":"string","description":"Issued date (format YYYY-mm-dd, e.g. 2001-09-25)","format":"date"},"validUntil":{"type":"string","description":"Valid until date (format YYYY-mm-dd, e.g. 2001-09-26)","format":"date"},"number":{"type":"string","description":"Document number"},"dateOfBirth":{"type":"string","description":"Date of birth (format YYYY-mm-dd, e.g. 2001-09-27)","format":"date"},"placeOfBirth":{"type":"string","description":"Place of birth"},"documentContent":{"type":"string","description":"Personal document content (Base64 encoded file image content)"}},"description":"Request model to Upgrade User's wallet"},"ApiRequestContainerAddDocumentRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/AddDocumentRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"AddDocumentResponseDto":{"required":["countryCode","documentType","id","proofSubject","walletId"],"type":"object","properties":{"id":{"type":"string","description":"Document ID in Profee storage"},"walletId":{"type":"string","description":"User's Wallet ID"},"documentType":{"type":"string","description":"Personal document type","enum":["ID_CARD","PASSPORT","DRIVERS","BANK_CARD","UTILITY_BILL","BANK_STATEMENT","SELFIE","VIDEO_SELFIE","PROFILE_IMAGE","ID_DOC_PHOTO","AGREEMENT","CONTRACT","RESIDENCE_PERMIT","EMPLOYMENT_CERTIFICATE","DRIVERS_TRANSLATION","INVESTOR_DOC","VEHICLE_REGISTRATION_CERTIFICATE","INCOME_SOURCE","PAYMENT_METHOD","OTHER"]},"documentSubType":{"type":"string","description":"Personal document sub-type","enum":["FRONT_SIDE","BACK_SIDE"]},"proofSubject":{"type":"string","description":"Proof subject of document. Can be proof of residence, proof of identity or selfie","enum":["POI","SELFIE","POR"]},"countryCode":{"maxLength":3,"minLength":0,"type":"string","description":"3-letter country code"},"firstName":{"type":"string","description":"First name"},"middleName":{"type":"string","description":"Middle name"},"lastName":{"type":"string","description":"Last name"},"issuedDate":{"type":"string","description":"Issued date (format YYYY-mm-dd, e.g. 2001-09-25)","format":"date"},"validUntil":{"type":"string","description":"Valid until date (format YYYY-mm-dd, e.g. 2001-09-26)","format":"date"},"number":{"type":"string","description":"Document number"},"dateOfBirth":{"type":"string","description":"Date of birth (format YYYY-mm-dd, e.g. 2001-09-27)","format":"date"},"placeOfBirth":{"type":"string","description":"Place of birth"}},"description":"Request model to Upgrade User's wallet"},"ApiResponseContainerAddDocumentResponseDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/AddDocumentResponseDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"ApiRequestContainerGetPaymentRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/GetPaymentRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"GetPaymentRequestDto":{"type":"object","properties":{"paymentId":{"type":"string","description":"Payment ID obtained from Create payment request"},"externalId":{"type":"string","description":"Operation ID in waas-partner system"}},"description":"Request model to get payment information and status. Either paymentId or externalId must be specified. If both are specified, the search will be performed by paymentId."},"ApiResponseContainerBasePaymentResponseDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/BasePaymentResponseDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"BasePaymentResponseDto":{"required":["creatorWalletId","datetime","externalId","feeSum","fromSum","id","lifetimeMinutes","methodId","methodType","state","toSum"],"type":"object","properties":{"id":{"type":"string","description":"Payment id"},"externalId":{"type":"string","description":"Payment UID in waas partner's system"},"paymentOrderId":{"type":"string","description":"Payment order id"},"methodId":{"type":"string","description":"Payment method id"},"methodType":{"type":"string","description":"Payment method type","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","PF2CARD","MERCH2CARD"]},"creatorWalletId":{"type":"string","description":"Wallet id of user, initiated payment"},"datetime":{"type":"string","description":"Date and time of payment","format":"date-time"},"state":{"$ref":"#/components/schemas/PaymentStateDto"},"lifetimeMinutes":{"type":"integer","description":"Payment lifetime. If lifetime is passed and payment is not complete, it will failed","format":"int32"},"fromSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"toSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"feeSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"comment":{"type":"string","description":"Comment by a user"}},"description":"Model of payment","oneOf":[{"$ref":"#/components/schemas/WalletToWalletPaymentResponseDto"},{"$ref":"#/components/schemas/WalletToPartnerPaymentResponseDto"},{"$ref":"#/components/schemas/PaySafeCashToWalletPaymentResponseDto"},{"$ref":"#/components/schemas/ShiftToCardPaymentResponseDto"},{"$ref":"#/components/schemas/ShiftToWalletPaymentResponseDto"}]},"MinorUnitMoneyDto":{"required":["currency"],"type":"object","properties":{"amount":{"type":"number","description":"Amount of money in minor units. Can be null."},"currency":{"type":"string","description":"Currency represented in alpha codes ISO 4217"}},"description":"Amount in minor units and currency"},"PaySafeCashToWalletPaymentResponseDto":{"required":["creatorWalletId","datetime","externalId","feeSum","fromSum","id","lifetimeMinutes","methodId","methodType","state","toSum"],"type":"object","properties":{"id":{"type":"string","description":"Payment id"},"externalId":{"type":"string","description":"Payment UID in waas partner's system"},"paymentOrderId":{"type":"string","description":"Payment order id"},"methodId":{"type":"string","description":"Payment method id"},"methodType":{"type":"string","description":"Payment method type","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","PF2CARD","MERCH2CARD"]},"creatorWalletId":{"type":"string","description":"Wallet id of user, initiated payment"},"datetime":{"type":"string","description":"Date and time of payment","format":"date-time"},"state":{"$ref":"#/components/schemas/PaymentStateDto"},"lifetimeMinutes":{"type":"integer","description":"Payment lifetime. If lifetime is passed and payment is not complete, it will failed","format":"int32"},"fromSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"toSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"feeSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"comment":{"type":"string","description":"Comment by a user"},"redirectUrl":{"type":"string","description":"Redirect url to the Paysafecash payment panel"}},"description":"Top up wallet from PaySafeCash system"},"PaymentStateDto":{"type":"object","properties":{"code":{"type":"string","enum":["CONFIRMATION_REQUIRED","PAYMENT_IN_PROGRESS","EXTERNAL_PAYMENT","PAID","ERROR_GENERAL"]},"isFinal":{"type":"boolean"}},"description":"Payment actual state"},"ShiftToCardPaymentResponseDto":{"required":["creatorWalletId","datetime","externalId","feeSum","fromSum","id","lifetimeMinutes","methodId","methodType","state","toSum"],"type":"object","properties":{"id":{"type":"string","description":"Payment id"},"externalId":{"type":"string","description":"Payment UID in waas partner's system"},"paymentOrderId":{"type":"string","description":"Payment order id"},"methodId":{"type":"string","description":"Payment method id"},"methodType":{"type":"string","description":"Payment method type","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","PF2CARD","MERCH2CARD"]},"creatorWalletId":{"type":"string","description":"Wallet id of user, initiated payment"},"datetime":{"type":"string","description":"Date and time of payment","format":"date-time"},"state":{"$ref":"#/components/schemas/PaymentStateDto"},"lifetimeMinutes":{"type":"integer","description":"Payment lifetime. If lifetime is passed and payment is not complete, it will failed","format":"int32"},"fromSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"toSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"feeSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"comment":{"type":"string","description":"Comment by a user"}}},"ShiftToWalletPaymentResponseDto":{"required":["creatorWalletId","datetime","externalId","feeSum","fromSum","id","lifetimeMinutes","methodId","methodType","state","toSum"],"type":"object","properties":{"id":{"type":"string","description":"Payment id"},"externalId":{"type":"string","description":"Payment UID in waas partner's system"},"paymentOrderId":{"type":"string","description":"Payment order id"},"methodId":{"type":"string","description":"Payment method id"},"methodType":{"type":"string","description":"Payment method type","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","PF2CARD","MERCH2CARD"]},"creatorWalletId":{"type":"string","description":"Wallet id of user, initiated payment"},"datetime":{"type":"string","description":"Date and time of payment","format":"date-time"},"state":{"$ref":"#/components/schemas/PaymentStateDto"},"lifetimeMinutes":{"type":"integer","description":"Payment lifetime. If lifetime is passed and payment is not complete, it will failed","format":"int32"},"fromSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"toSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"feeSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"comment":{"type":"string","description":"Comment by a user"}}},"WalletToPartnerPaymentResponseDto":{"required":["creatorWalletId","datetime","externalId","feeSum","fromSum","id","lifetimeMinutes","methodId","methodType","state","toSum"],"type":"object","properties":{"id":{"type":"string","description":"Payment id"},"externalId":{"type":"string","description":"Payment UID in waas partner's system"},"paymentOrderId":{"type":"string","description":"Payment order id"},"methodId":{"type":"string","description":"Payment method id"},"methodType":{"type":"string","description":"Payment method type","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","PF2CARD","MERCH2CARD"]},"creatorWalletId":{"type":"string","description":"Wallet id of user, initiated payment"},"datetime":{"type":"string","description":"Date and time of payment","format":"date-time"},"state":{"$ref":"#/components/schemas/PaymentStateDto"},"lifetimeMinutes":{"type":"integer","description":"Payment lifetime. If lifetime is passed and payment is not complete, it will failed","format":"int32"},"fromSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"toSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"feeSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"comment":{"type":"string","description":"Comment by a user"}}},"WalletToWalletPaymentResponseDto":{"required":["creatorWalletId","datetime","externalId","feeSum","fromSum","id","lifetimeMinutes","methodId","methodType","state","toSum"],"type":"object","properties":{"id":{"type":"string","description":"Payment id"},"externalId":{"type":"string","description":"Payment UID in waas partner's system"},"paymentOrderId":{"type":"string","description":"Payment order id"},"methodId":{"type":"string","description":"Payment method id"},"methodType":{"type":"string","description":"Payment method type","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","PF2CARD","MERCH2CARD"]},"creatorWalletId":{"type":"string","description":"Wallet id of user, initiated payment"},"datetime":{"type":"string","description":"Date and time of payment","format":"date-time"},"state":{"$ref":"#/components/schemas/PaymentStateDto"},"lifetimeMinutes":{"type":"integer","description":"Payment lifetime. If lifetime is passed and payment is not complete, it will failed","format":"int32"},"fromSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"toSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"feeSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"comment":{"type":"string","description":"Comment by a user"},"toWalletId":{"type":"string"}}},"ApiRequestContainerGetPaymentHistoryRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/GetPaymentHistoryRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"GetPaymentHistoryRequestDto":{"required":["pageNumber","pageSize","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"Profee Wallet ID"},"paymentId":{"maxItems":1000,"minItems":0,"uniqueItems":true,"type":"array","description":"Profee Payment ID","items":{"type":"string","description":"Profee Payment ID"}},"pageNumber":{"minimum":0,"type":"integer","description":"Page number","format":"int32"},"pageSize":{"maximum":500,"minimum":1,"type":"integer","description":"Page size","format":"int32"},"fromDate":{"pattern":"Date '2011-12-03T10:15:30+01:00'","type":"string","description":"From date in format '2011-12-03T10:15:30+01:00'","format":"date-time"},"toDate":{"pattern":"Date '2011-12-03T10:15:30+01:00'","type":"string","description":"To date in format '2011-12-03T10:15:30+01:00'","format":"date-time"}},"description":"Request model to get payment history information."},"ApiResponseContainerPaymentHistoryResponseDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/PaymentHistoryResponseDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"PageDto":{"required":["hasNext","hasPrevious","numberOfElements","pageNumber","pageSize","totalElements","totalPages"],"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"numberOfElements":{"type":"integer","format":"int32"},"hasNext":{"type":"boolean"},"hasPrevious":{"type":"boolean"}}},"PaymentHistoryResponseDto":{"required":["entities","page"],"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageDto"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/BasePaymentResponseDto"}}},"description":"Response content"},"ApiRequestContainerCreatePaymentRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/CreatePaymentRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"CreatePaymentRequestDto":{"required":["paymentOrderId"],"type":"object","properties":{"paymentOrderId":{"type":"string","description":"Payment order ID obtained from Create payment order request"},"comment":{"type":"string","description":"User comment for a payment"}},"description":"Request model to Create payment"},"ApiRequestContainerBasePaymentOrderRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"oneOf":[{"$ref":"#/components/schemas/CardIssuingPaymentOrderRequestDto"},{"$ref":"#/components/schemas/PartnerToWalletPaymentOrderRequestDto"},{"$ref":"#/components/schemas/PaysafecashToWalletPaymentOrderRequestDto"},{"$ref":"#/components/schemas/ProfeeToCardPaymentOrderRequestDto"},{"$ref":"#/components/schemas/ShiftToCardPaymentOrderRequestDto"},{"$ref":"#/components/schemas/ShiftToWalletPaymentOrderRequestDto"},{"$ref":"#/components/schemas/WalletToPartnerPaymentOrderRequestDto"},{"$ref":"#/components/schemas/WalletToSwiftPaymentOrderRequestDto"},{"$ref":"#/components/schemas/WalletToWalletPaymentOrderRequestDto"}]},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"BasePaymentOrderRequestDto":{"required":["externalId","from","methodId","methodType","to","walletId"],"type":"object","properties":{"externalId":{"type":"string","description":"Operation ID in waas-partner system"},"walletId":{"type":"string","description":"Payment order creator wallet id"},"methodId":{"type":"string","description":"Payment method ID"},"methodType":{"type":"string","description":"Payment method type","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","P2P","PF2CARD","MERCH2CARD"]},"from":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"to":{"$ref":"#/components/schemas/MinorUnitMoneyDto"}},"description":"Model of payment order","discriminator":{"propertyName":"methodType"},"oneOf":[{"$ref":"#/components/schemas/WalletToWalletPaymentOrderRequestDto"},{"$ref":"#/components/schemas/WalletToPartnerPaymentOrderRequestDto"},{"$ref":"#/components/schemas/PaysafecashToWalletPaymentOrderRequestDto"},{"$ref":"#/components/schemas/ShiftToCardPaymentOrderRequestDto"},{"$ref":"#/components/schemas/ShiftToWalletPaymentOrderRequestDto"},{"$ref":"#/components/schemas/PartnerToWalletPaymentOrderRequestDto"}]},"CardIssuingPaymentOrderRequestDto":{"required":["externalId","from","methodId","methodType","to","walletId"],"type":"object","description":"Order issue a card","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"},{"type":"object","properties":{"cardId":{"type":"string"}}}]},"PartnerToWalletPaymentOrderRequestDto":{"required":["externalId","from","methodId","methodType","to","walletId"],"type":"object","description":"Order to payment from waas partner to wallet","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"}]},"PaysafecashToWalletPaymentOrderRequestDto":{"required":["externalId","from","methodId","methodType","to","walletId"],"type":"object","description":"Order to top up wallet from Paysafecash system","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"},{"type":"object","properties":{"redirectSuccessUrl":{"type":"string","description":"Payment recipient wallet URLs to redirect after successful authorization in PaySafeCash system"},"redirectFailUrl":{"type":"string","description":"Payment recipient wallet URLs to redirect after failed authorization in PaySafeCash system"}}}]},"ProfeeToCardPaymentOrderRequestDto":{"required":["cardToken","externalId","from","methodId","methodType","to","walletId"],"type":"object","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"},{"type":"object","properties":{"cardToken":{"type":"string","description":"Card to top up"}}}]},"ShiftToCardPaymentOrderRequestDto":{"required":["cardId","externalId","from","methodId","methodType","to","walletId"],"type":"object","description":"Order to shift money from client wallet to card","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"},{"type":"object","properties":{"cardId":{"type":"string","description":"Card to be top upped"}}}]},"ShiftToWalletPaymentOrderRequestDto":{"required":["cardId","externalId","from","methodId","methodType","to","walletId"],"type":"object","description":"Order to shift money from client card to wallet","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"},{"type":"object","properties":{"cardId":{"type":"string","description":"Card to withdraw"}}}]},"WalletToPartnerPaymentOrderRequestDto":{"required":["externalId","from","methodId","methodType","to","walletId"],"type":"object","description":"Order to payment from wallet to waas partner","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"}]},"WalletToSwiftPaymentOrderRequestDto":{"required":["beneficiaryBicCode","beneficiaryName","externalId","from","methodId","methodType","to","walletId"],"type":"object","description":"Order to payment from wallet to SWIFT","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"},{"type":"object","properties":{"beneficiaryBicCode":{"type":"string","description":"BIK code of beneficiary bank"},"beneficiaryAccount":{"type":"string","description":"Beneficiary bank account"},"beneficiaryName":{"type":"string","description":"Beneficiary name"},"beneficiaryAddress":{"type":"string","description":"Beneficiary address"}}}]},"WalletToWalletPaymentOrderRequestDto":{"required":["externalId","from","methodId","methodType","to","toWalletId","walletId"],"type":"object","description":"Order to payment from wallet to another wallet","allOf":[{"$ref":"#/components/schemas/BasePaymentOrderRequestDto"},{"type":"object","properties":{"toWalletId":{"type":"string","description":"Payment recipient wallet ID"}}}]},"ApiResponseContainerBasePaymentOrderResponseDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/BasePaymentOrderResponseDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"BasePaymentOrderResponseDto":{"required":["externalId","feeSum","fromSum","methodId","methodType","paymentOrderId","toSum"],"type":"object","properties":{"externalId":{"type":"string","description":"Operation ID in waas-partner system"},"methodType":{"type":"string","enum":["WALLET_TO_WALLET","WALLET_TO_PARTNER","PARTNER_TO_WALLET","PAYSAFECASH_TO_WALLET","WAAS_SHIFT_TO_CARD","WAAS_SHIFT_TO_WALLET","WAAS_CARD_ISSUING","WALLET_TO_SWIFT","SWIFT_TO_WALLET","PF2CARD","MERCH2CARD"]},"fromSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"toSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"feeSum":{"$ref":"#/components/schemas/MinorUnitMoneyDto"},"paymentOrderId":{"type":"string"},"methodId":{"type":"string"}},"description":"Response model of payment order"},"ApiRequestContainerGetCardRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/GetCardRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"GetCardRequestDto":{"required":["cardId","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"}},"description":"Request model to get Profee card information"},"ApiResponseContainerCardDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/CardDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"CardDto":{"required":["cardId","cardStatus","currency","paymentSystem","productId","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"},"cardStatus":{"type":"string","description":"Profee card status","enum":["INIT","ISSUED","EXPIRED","FAILED","CLOSED","FROZEN","DELIVERY","BLOCKED"]},"currency":{"type":"string","description":"Profee card currency"},"paymentSystem":{"type":"string","description":"Profee card payment system","enum":["VISA"]},"productId":{"type":"string","description":"Profee payment product ID"},"maskedPan":{"type":"string","description":"Profee card masked pan"}},"description":"Model Profee card"},"ApiRequestContainerCardOperationsRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/CardOperationsRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"CardOperationsRequestDto":{"required":["cardId","daysCount","fromDate","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"},"fromDate":{"pattern":"yyyy-MM-dd","type":"string","description":"From this date the history of operations will be returned","format":"date"},"daysCount":{"type":"integer","description":"The number of days which the history of operations will be provided for. For technical reasons we restricted this value in 31 days","format":"int32"}},"description":"Request model to get Profee card operations history"},"ApiResponseContainerCardOperationsDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/CardOperationsDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"CardOperationDto":{"type":"object","properties":{"state":{"type":"string","description":"Card operation state, available values are:\n\n| State | Description |\n|----------------|---------------------------------------------|\n| AUTH_DECLINE | Operation declined |\n| AUTH_REVERSAL | Operation was reversed |\n| AUTH_APPROVE | Operation approved |\n| TRANSACTION_A | Operation by acquirer with authorization |\n| TRANSACTION_AS | Operation by acquirer without authorization |\n| TRANSACTION_M | Operation by merchant with authorisation |\n| TRANSACTION_MS | Operation by merchant without authorisation |","enum":["AUTH_DECLINE","AUTH_REVERSAL","AUTH_APPROVE","TRANSACTION_A","TRANSACTION_AS","TRANSACTION_M","TRANSACTION_MS"]},"type":{"$ref":"#/components/schemas/CardOperationType"},"mcc":{"type":"string","description":"Card operation MCC"},"authDate":{"type":"string","description":"Card operation authorization date"},"authTime":{"type":"string","description":"Card operation authorization time"},"authTimeZone":{"type":"string","description":"Card operation authorization timezone"},"authDateTimeZoned":{"type":"string","description":"Card operation authorization datetime in ISO_ZONED_DATE_TIME format"},"postingDate":{"type":"string","description":"Card operation posting date"},"authCode":{"type":"string","description":"Card operation authorization code"},"rrn":{"type":"string","description":"Card operation RRN (Reference Retrieval Number)"},"merchantId":{"type":"string","description":"Card operation merchant ID"},"terminalId":{"type":"string","description":"Card operation terminal ID"},"merchantName":{"type":"string","description":"Card operation merchant name"},"merchantCity":{"type":"string","description":"Card operation merchant city"},"merchantCountry":{"type":"string","description":"Card operation merchant country"},"merchantSum":{"$ref":"#/components/schemas/MoneyDto"},"cardSum":{"$ref":"#/components/schemas/MoneyDto"},"authDescription":{"type":"string","description":"Card operation description of authorization"}},"description":"Card operation"},"CardOperationType":{"type":"object","properties":{"code":{"type":"string"},"direction":{"type":"string","enum":["DEBIT","CREDIT"]},"description":{"type":"string"}},"description":"Card operation type, available values are:\n\n| State | Direction | Description |\n|-------|-----------|-----------------------------|\n| AUTH | DEBIT | Debit Authorisation |\n| ATHP | CREDIT | Credit Authorisation |\n| SALK | DEBIT | Debit Transaction |\n| REFK | CREDIT | Credit Transaction |\n| AJDC | DEBIT | Debit Adjustment |\n| AJCC | CREDIT | Credit Adjustment |\n| VSAK | CREDIT | Reversal Debit Transaction |\n| VREK | DEBIT | Reversal Credit Transaction |\n| VAJC | CREDIT | Reversal Debit Adjustment |\n| VACC | DEBIT | Reversal Credit Adjustment |\n\n> 💡 In card terminology:\n> - DEBIT is withdrawal funds from card\n> - CREDIT is card top up with funds\n"},"CardOperationsDto":{"required":["cardId","daysCount","fromDate","operations","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"},"fromDate":{"pattern":"yyyy-MM-dd","type":"string","description":"From this date the history of operations will was requested","format":"date"},"daysCount":{"type":"integer","description":"The number of days which the history of operations was requested for.","format":"int32"},"operations":{"type":"array","description":"Profee card operations history","items":{"$ref":"#/components/schemas/CardOperationDto"}}},"description":"Model Profee card operations history"},"ApiRequestContainerGetCardDetailsRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/GetCardDetailsRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"GetCardDetailsRequestDto":{"required":["cardId","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"}},"description":"Request model to get Profee card information"},"ApiResponseContainerCardSecureDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/CardSecureDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"CardSecureDto":{"required":["cardHolder","cardId","cvv","expiryDate","pan","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"},"pan":{"type":"string","description":"Profee card pan"},"cvv":{"type":"string","description":"Profee card cvv"},"expiryDate":{"type":"string","description":"Profee card expiry date"},"cardHolder":{"type":"string","description":"Cardholder name"}},"description":"Model Profee card details. May be unavailable due to PCI DSS compliance"},"ApiRequestContainerGetCardBalanceRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/GetCardBalanceRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"GetCardBalanceRequestDto":{"required":["cardId","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"}},"description":"Request to get Profee card balance"},"ApiResponseContainerCardBalanceDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/CardBalanceDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"CardBalanceDto":{"required":["authorizedBalance","balance","cardId","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"},"balance":{"$ref":"#/components/schemas/MoneyDto"},"authorizedBalance":{"$ref":"#/components/schemas/MoneyDto"}},"description":"Model Profee card balance"},"ApiRequestContainerCreateCardRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/CreateCardRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"CreateCardRequestDto":{"required":["productId","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"productId":{"type":"string","description":"Profee Card product ID"}},"description":"Request model to create Profee card"},"ApiRequestContainerChangeCardStatusRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/ChangeCardStatusRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"ChangeCardStatusRequestDto":{"required":["cardId","status","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"},"status":{"type":"string","description":"New card status ('FROZEN' for freeze, 'ISSUED' for unfreeze)","enum":["FROZEN","ISSUED"]}},"description":"Request to freeze/unfreeze Profee card"},"ApiResponseContainerChangeCardStatusResponseDto":{"required":["signature","status"],"type":"object","properties":{"response":{"$ref":"#/components/schemas/ChangeCardStatusResponseDto"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"signature":{"type":"string","description":"Signature of response content"}},"description":"Response wrapper"},"ChangeCardStatusResponseDto":{"type":"object","properties":{"cardId":{"type":"string","description":"Card ID hash"},"cardStatus":{"type":"string","description":"Card status after success operation"},"status":{"type":"string","description":"Operation result status","enum":["SUCCESS","FAILED"]},"description":{"type":"string","description":"Error description"}},"description":"Response to request to freeze/unfreeze Profee Card"},"ApiRequestContainerPlasticCardActivationRequestDto":{"required":["request","signature"],"type":"object","properties":{"request":{"$ref":"#/components/schemas/PlasticCardActivationRequestDto"},"signature":{"type":"string","description":"Signature of request content"}},"description":"Request wrapper"},"PlasticCardActivationRequestDto":{"required":["approvalCode","cardId","walletId"],"type":"object","properties":{"walletId":{"type":"string","description":"User's Wallet ID"},"cardId":{"type":"string","description":"Profee card ID"},"approvalCode":{"type":"string","description":"Approval code, received by Post"}},"description":"Request for Plastic Profee card activation"}},"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}}} |