"swagger: '2.0'\n\n## Sprint 85\n\n################################################################################\n# API Information #\n################################################################################\ninfo:\n title: API catalog\n version: \"1.0\"\n description: |\n In this catalog you can find all nCore platform APIs. In case you need nFront APIs, please refer to this catalog https://nymcard.com/docs/api_nfront.\n\n\n **Note, that all parameters without \"required\" tag are optional.**\nbasePath: /\nhost: api.sand.platform.nymcard.com\nschemes:\n - https\nconsumes:\n - application/json\nproduces:\n - application/json;charset=UTF-8\nsecurityDefinitions:\n apikey:\n type: apiKey\n in: header\n name: apikey\n description: The Core API applies standard authorization, which means that the authorization field in the message header is used to hold the API key. Authentication refers to proving the APIs user’s correct identity. API key is used for authentication, there is no username and password.\nsecurity:\n - apikey: []\ntags:\n - name: Tenant Settings\n description: NymCard offers the flexibility to host a customer's private partition on its multi-tenant secure platform where only physical resources are shared with other tenants with all features supported. Another option is having a standalone single tenant platform dedicated for a single customer that could be used for managing customer's Card Program. NymCard offers for its customers the ability to choose between these 2 options based on their requirements. Test\n - name: Card Products\n description: Our nCore platform offers the concept of a card product - it acts as a template to define features, rules and behaviors applicable to the cards belonging to that product. Whenever a new card is created, card product is required to be mentioned so that the card is created using the card product template. Each card product has a unique token, the token can be provided by the user creating the card product or the system can auto generate it if not provided by the user. The user also provides a name for the card product which is a mandatory free text value of appropriate length.\n - name: Users\n description: Our nCore platform gives a capability to register a new user. This user is an individual to whom cards can be issued, and who can maintain funds in the platform. The system captures information for user identification documents. The supported identification documents are dynamically defined at each tenant level. Such information as ID number, expiration date, and other dynamic fields are captured. The system also provides an option to upload the identification document scanned images. All the user demographic information (like name, email, mobile, DOB etc.) and the identification document information is inherently optional in the 'Create user' API. However, it is defined at the tenant level which demographic and identification document information is mandatory to create a new user profile. The uniqueness criteria for a user is defined dynamically at the tenant level. The uniqueness check is defined on one field (e.g. mobile number) or more than one field (e.g. mobile number and email address).\n - name: User documents\n description: Our nCore platform gives an opportunity to upload and manage user identification documents.\n - name: User KYC\n description: Know Your Customer (KYC) is the mandatory process of identifying and verifying the client's identity when opening an account and periodically over time. KYC process helps to establish customer identity and understand the nature of customers’ activities in order to qualify that the source of funds is legitimate. nCore platform offers two KYC policies - individual primary (for a parent user) and individual secondary (for a child user).\n - name: User IDV\n description: Identity verification (IDV) is the mandatory process of identifying and verifying the client's identity when opening an account and periodically over time. IDV policies help to establish customer identity and understand the nature of customers’ activities in order to qualify that the source of funds is legitimate. nCore platform offers two IDV policies - individual primary (for users without parent user ID or with parent user ID other than individual) and individual secondary (for users with parent user ID of an individual user).\n - name: Accounts\n description: Our nCore platform gives a possibility to create and manage an account. It is typically a general ledger account that keeps track of the account transactions and its balances. Whenever a new prepaid card is issued a GL account is created and linked to the card. Also the platform supports three types of account statuses - Active, Suspended, Terminated. The card account when created is in Active status. While in Active status the account is used for loading/unloading of funds and to process card authorizations and clearings. The account status can be changed from Active to Suspended status. When in Suspended status the account does not allow loading/unloading of funds and to process card authorizations. However, clearings coming from the scheme are processed. The account status can be changed to Terminated status. This is a permanent status; the account status is changed to Terminated status only when card account closure operation is explicitly performed. You can update account status to Terminated if account has no balance or account has no pending authorizations.\n - name: Fund Transfers\n description: There is an opportunity to transfer funds from one account to another account so that you can move funds between your own accounts or perform a peer transfer to any other user.\n - name: Orders\n description: nCore platform provides capability to load into Nymcard card account from external funding source so that you can top-up your card account balance using a third-party payment card. For this we have integrated a payment gateway. At the moment we offer such loading method as HOSTED_CHECKOUT.\n - name: Cards\n description: Using our nCore platform you can issue a physical card or a virtual card for a registered user. The card is created for a card product already defined in the system. The card inherits features/rules applied on the card product level. It is possible to issue a personalized physical card (that is a card personalized with the user name on it) for a registered user. The personalized card can be delivered to the cardholder selected shipment address or it can be delivered to a centralized location (e.g. a branch or a retail outlet) from where the cardholder can collect his/her card. You can also create a virtual card for a registered user. The user can retrieve virtual card details (card number, expiry date, CVV2) so that he/she can use the virtual card for online payments.\n - name: Card Bulk Issuances\n description: Nymcard offers the possibility to create cards in bulk by providing the card product and the number of cards to be created in that bulk request. The bulk can be delivered to a centralized location (e.g. a branch or a retail outlet). Amount can optionally be provided when creating the bulk card request, and created cards will have this value as the initial amount. A walk-in customer can be enrolled as a user and a non-personalized card taken from the bulk can be assigned to the newly registered user.\n - name: Velocity Limits\n description: The velocity limit defines the cumulative amount and the number of transactions that can be performed within a period of time which can be daily, monthly, yearly, or for the lifetime. The calculation of period (daily, monthly, yearly, lifetime) is based on the local time of the tenant which can be identified using the time zone offset defined in the tenant settings. Another variation of the velocity limit is the per transaction amount limit. The per transaction amount limit gives the maximum amount or minimum amount (or both) a single transaction can have. Frequency is irrelevant in case of per transaction amount limit. Note, that 'type' = `PER_TRANSACTION` and `PER_USER` work well with all 'transaction_scope' values. But 'type' = `PER_CARD` works well only with 'transaction_scope' = `WITHDRAWALS`, `PURCHASES`, `PURCHASES_CONTACTLESS_NO_PIN`, `QUASHI_CASH`, `SCHEME_CREDITS`, `SCHEME_ACCOUNT_FUNDING`. And 'type' = `PER_ACCOUNT` works well only with 'transaction_scope' = `INCOMING_TRANSFERS`, `OUTGOING_TRANSFERS`, `LOADS`, `UNLOADS`.\n - name: Advanced velocity limits\n description: This section contains advanced velocity limits APIs.\n - name: Balance Limits\n description: The balance limit defines the maximum balance or the minimum balance (or both) the account can hold. The balance limit is checked whenever a change in balance is to happen, for instance during scheme authorizations (purchases, withdrawals etc.). The balance limit is checked on an individual account of the user or it is possible to check the balance limit across all the accounts of the user. In order to define the maximum balance limit at tenant level, please approach to your NymCard assigned project manager. Maximum balance limit at tenant level is only applicable at account level and for currency of priority = 1 of the card product.\n - name: Fees\n description: Our nCore platform supports defining various types of fees charged on transactions and other functions/events. A fee can be linked to one or more card products. We have multiple types of fees, such as flat, percentage, range etc.. Fee can be marked as 'Active/Inactive'. If a fee is marked as 'Inactive' then this fee shall not be charged until it is set to 'Active' again. The applied fee details are recorded with the other transaction details so that complete financial information related to the transaction is available.\n - name: Advanced Fees\n description: These APIs allows you to configure fees along with the dynamic conditions.\n - name: Charges\n description: Our system supports various types of charges so that it can be applied, for example, when physical or virtual cards are issued to cardholder for the first time.\n - name: Notification Templates\n description: The notification template APIs are used to create and manage SMS templates for the authentication methods like 3D secure OTP (Three Domain Secure One Time PIN) in multiple languages. By using these notification APIs, SMS templates can be created in multiple languages for each card product. Note, that the strings <CARD_LAST4_DIGITS>, <MERCHANT_NAME>, <TRANSACTION_AMOUNT> and <OTP> should be uppercase in SMS template body.\n - name: Webhooks\n description: Webhooks help to keep you aware of what's happening in your card program. nCore uses webhooks to notify you when events occur so that you can take required actions. Our platform sends these notifications to an endpoint hosted on customer’s environment and configured to receive and process them.\n - name: Transactions\n description: Our platform provides a set of APIs, through which transactions that are being processed by the platform can be retrieved by the platform API user.\n - name: Allowed Lists\n description: Our platform supports the functionality to create and manage lists of allowed countries and MCCs (merchant category codes). These lists of allowed countries and MCCs can be used during authorization to check if the merchant country or MCC coming in authorization is allowed (whitelisted) or restricted (blacklisted).\n - name: VTS Tokens\n description: nCore platform gives a possibility to store the payment card for future purchases and usage via VISA tokenization service. Tokenization protects card data by substituting a card's PAN with a unique, randomly-generated sequence of numbers called token. The generated number is the same length and format as the original PAN.\n - name: MDES Tokens\n description: nCore platform gives a possibility to store the payment card for future purchases and usage via MDES tokenization service. Tokenization protects card data by substituting a card's PAN with a unique, randomly-generated sequence of numbers called token. The generated number is the same length and format as the original PAN.\n - name: FX rates\n description: nCore platform gives a possibility to define custom FX rate providers, groups and quotes, which are used for multi-currency functionality. You can find more info about multi-currency feature in the following GSG document https://docs.nymcard.com/get-started/product-management/multi-currency.\n - name: Remittance - Western Union\n description: nCore platform gives a possibility to integrate with Western Union to conduct remittances.\n\n\n\n\n\n################################################################################\n# Paths #\n################################################################################\n\nparameters:\n after:\n name: after\n in: query\n description: This is the cursor that points to the `end` of the page of data that has been returned.\n required: false\n type: string\n limit:\n name: limit\n in: query\n description: This is the maximum number of objects that may be returned. A query may return fewer than the value of `limit` once reached the end of the list of data.\n required: false\n type: integer\n format: int32\n sort_by:\n name: sort_by\n in: query\n description: Using this parameter you can sort by field name.\n required: false\n type: string\n order_by:\n name: order_by\n in: query\n type: string\n description: Using this parameter you can make ascending or descending order.\n enum:\n - ASC\n - DESC\n limitInfoType:\n name: type\n in: query\n type: string\n description: The type of limit.\n enum:\n - ADVANCED_VELOCITY_LIMIT\n - VELOCITY_LIMITS\n - BALANCE_LIMITS\n\npaths:\n /v1/tenantsettings:userVerificationSettings:\n get:\n tags:\n - Tenant Settings\n operationId: getUserVerificationSettings\n summary: Get user verification settings\n description: This API is used to get user verification settings.\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/UserVerificationSettings'\n\n /v1/fees:\n get:\n tags:\n - Fees\n summary: Get list of fees\n description: This API is used to get the list of all fees.\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n responses:\n 200:\n description: Returns all fees\n schema:\n $ref: \"#/definitions/FeesCollection\"\n\n post:\n tags:\n - Fees\n summary: Create fee\n description: This API is used to create a new fee.\n parameters:\n - name: fee_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/FeeCreateRequest\"\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/Fee\"\n\n /v1/fees/{fee_id}:\n get:\n tags:\n - Fees\n summary: Get a specific fee\n description: This API is used to return a specific fee using its ID.\n parameters:\n - name: fee_id\n in: path\n type: string\n description: The unique identifier of the fee. This token id is referred to as an existing fee.\n required: true\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/Fee\"\n\n put:\n tags:\n - Fees\n summary: Update fee\n description: This API is used to update parameters of a specific fee.\n parameters:\n - name: fee_id\n in: path\n type: string\n description: The unique identifier of the fee. This token id is referred to as an existing fee.\n required: true\n - name: fee_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/FeeUpdateRequest\"\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/Fee\"\n\n /v1/advancedfees:\n get:\n tags:\n - Advanced Fees\n summary: Get list of advanced fees\n description: This API is used to get the list of all advanced fees.\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n responses:\n 200:\n description: Returns all advanced fees.\n schema:\n $ref: \"#/definitions/AdvancedFeesCollection\"\n\n post:\n tags:\n - Advanced Fees\n summary: Create advanced fee\n description: This API is used to create a new advanced fee.\n parameters:\n - name: fee_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AdvancedFeeCreateRequest\"\n responses:\n 200:\n description: OK.\n schema:\n $ref: \"#/definitions/AdvancedFee\"\n\n /v1/advancedfees/{fee_id}:\n get:\n tags:\n - Advanced Fees\n summary: Get specific advanced fee\n description: This API is used to return a specific advanced fee using its ID.\n parameters:\n - name: fee_id\n in: path\n type: string\n description: The unique identifier of the advanced fee. This token ID is referred to as an existing advanced fee.\n required: true\n responses:\n 200:\n description: OK.\n schema:\n $ref: \"#/definitions/AdvancedFee\"\n\n put:\n tags:\n - Advanced Fees\n summary: Update advanced fee\n description: This API is used to update parameters of a specific advanced fee.\n parameters:\n - name: fee_id\n in: path\n type: string\n description: The unique identifier of the advanced fee. This token ID is referred to as an existing advanced fee.\n required: true\n - name: fee_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AdvancedFeeUpdateRequest\"\n responses:\n 200:\n description: OK.\n schema:\n $ref: \"#/definitions/AdvancedFee\"\n\n\n\n /v1/velocitylimits:\n post:\n tags:\n - Velocity Limits\n summary: Create velocity limit\n description: This API is used to create a velocity limit.\n parameters:\n - name: velocitylimit\n in: body\n required: true\n schema:\n $ref: \"#/definitions/VelocityLimitCreateRequest\"\n responses:\n 200:\n description: Created velocity limit\n schema:\n $ref: \"#/definitions/VelocityLimit\"\n get:\n tags:\n - Velocity Limits\n summary: Get list of all velocity limits\n description: This API is used to get the list of all velocity limits.\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n operationId: listVelocityLimits\n responses:\n 200:\n description: List of velocity limits\n schema:\n $ref: \"#/definitions/VelocityLimitCollection\"\n\n\n /v1/velocitylimits/{id}:\n put:\n tags:\n - Velocity Limits\n summary: Update velocity limit\n description: This API is used to update parameters of a specific velocity limit.\n operationId: updateVelocityLimit\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the velocity limit. This token id is referred to as an existing velocity limit.\n - name: velocitylimit\n in: body\n required: true\n schema:\n $ref: \"#/definitions/VelocityLimitUpdateRequest\"\n responses:\n 200:\n description: Updated velocity limit\n schema:\n $ref: \"#/definitions/VelocityLimit\"\n get:\n tags:\n - Velocity Limits\n summary: Get velocity limit\n description: This API is used to return a specific velocity limit using its ID.\n operationId: getVelocityLimit\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the velocity limit. This token id is referred to as an existing velocity limit.\n responses:\n 200:\n description: Retrieved velocity limit\n schema:\n $ref: \"#/definitions/VelocityLimit\"\n\n /v1/advancedlimits:\n post:\n tags:\n - Advanced velocity limits\n summary: Create advanced velocity limit\n description: This API is used to create an advanced velocity limit.\n operationId: createAdvancedVelocityLimit\n parameters:\n - name: advancedVelocityLimit\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AdvancedVelocityLimitCreateRequest\"\n responses:\n 200:\n description: Created Advanced Velocity Limit.\n schema:\n $ref: \"#/definitions/AdvancedVelocityLimit\"\n get:\n tags:\n - Advanced velocity limits\n summary: Get list of advanced velocity limits\n description: This API is used to retrieve a list of advanced velocity limits.\n operationId: getAdvancedVelocityLimits\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n responses:\n 200:\n description: List of Advanced Velocity Limits.\n schema:\n $ref: \"#/definitions/AdvancedVelocityLimitCollection\"\n\n /v1/advancedlimits/{id}:\n get:\n tags:\n - Advanced velocity limits\n summary: Get specific advanced velocity limit\n description: This API is used to retrieve details of specific advanced velocity limit.\n operationId: getAdvancedVelocityLimit\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the advanced velocity limit.\n responses:\n 200:\n description: Retrieved Advanced Velocity limit.\n schema:\n $ref: \"#/definitions/AdvancedVelocityLimit\"\n put:\n tags:\n - Advanced velocity limits\n summary: Update advanced velocity limit\n description: This API is used to update specific advanced velocity limit.\n operationId: updateAdvancedVelocityLimit\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the advanced velocity limit.\n - name: advancedVelocityLimit\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AdvancedVelocityLimitUpdateRequest\"\n responses:\n 200:\n description: Retrieved Velocity limit.\n schema:\n $ref: \"#/definitions/AdvancedVelocityLimit\"\n\n /v1/balancelimits:\n post:\n tags:\n - Balance Limits\n summary: Create balance limit\n description: This API is used to create a new balance limit.\n operationId: createBalanceLimit\n parameters:\n - name: balanceLimit\n in: body\n required: true\n schema:\n $ref: \"#/definitions/BalanceLimitCreateRequest\"\n responses:\n 200:\n description: Created balance limit\n schema:\n $ref: \"#/definitions/BalanceLimit\"\n get:\n tags:\n - Balance Limits\n summary: Get list of all balance limits\n description: This API is used to get the list of all balance limits.\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n operationId: listBalanceLimits\n responses:\n 200:\n description: List of balance limits\n schema:\n $ref: \"#/definitions/BalanceLimitCollection\"\n\n /v1/balancelimits/{id}:\n put:\n tags:\n - Balance Limits\n summary: Update balance limit\n description: This API is used to edit parameters of a specific balance limit.\n operationId: updateBalanceLimit\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the balance limit. This token id is referred to as an existing balance limit.\n - name: balancelimit\n in: body\n required: true\n schema:\n $ref: \"#/definitions/BalanceLimitUpdateRequest\"\n responses:\n 200:\n description: Updated balance limit\n schema:\n $ref: \"#/definitions/BalanceLimit\"\n get:\n tags:\n - Balance Limits\n summary: Get balance limit\n description: This API is used to return a specific balance limit using its ID.\n operationId: getBalanceLimit\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the balance limit. This token id is referred to as an existing balance limit.\n responses:\n 200:\n description: Retrieved balance limit\n schema:\n $ref: \"#/definitions/BalanceLimit\"\n\n /v1/cardproducts/:\n post:\n tags:\n - Card Products\n operationId: Create card product\n summary: Create card product\n description: This API is used to create a new card product.\n parameters:\n - name: cardProductRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardProductCreateRequest\"\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/CardProduct\"\n get:\n tags:\n - Card Products\n summary: Get list of all card products\n description: This API is used to get the list of all card products.\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n operationId: listCardProducts\n responses:\n 200:\n description: List of card products\n schema:\n $ref: \"#/definitions/CardProductCollection\"\n\n /v1/cardproducts/{id}:\n get:\n tags:\n - Card Products\n summary: Get card product\n description: This API is used to return a specific card product using its ID.\n operationId: getCardProduct\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n responses:\n 200:\n description: Retrieved card product\n schema:\n $ref: \"#/definitions/CardProduct\"\n put:\n tags:\n - Card Products\n summary: Update card product\n description: This API is used to update parameters of a specific card product. You can check what parameters cannot be updated for an ACTIVE/SUSPENDED card product in this doc - https://docs.nymcard.com/get-started/product-management/card-product#update-a-card-product.\n operationId: updateCardProduct\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n - name: cardProduct\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardProductUpdateRequest\"\n responses:\n 200:\n description: Created card product\n schema:\n $ref: \"#/definitions/CardProduct\"\n\n /v1/cardproducts/{id}/velocitylimits:\n get:\n tags:\n - Card Products\n summary: Get list of velocity limits related to the card product\n description: This API is used to get the list of velocity limits related to a specific card product.\n operationId: getVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n responses:\n 200:\n description: Retrieved the linked velocity limit IDs\n schema:\n type: array\n items:\n type: string\n description: Velocity Limit Id\n maxLength: 36\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/velocitylimits:link:\n post:\n tags:\n - Card Products\n summary: Link velocity limits to the card product\n description: This API is used to link an array of velocity limits to a specific card product.\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n - name: velocityLimits\n in: body\n required: true\n description: An array of velocity limits IDs which require to be linked.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 200:\n description: Linked velocity limits to the card product\n schema:\n type: array\n items:\n type: string\n description: Velocity Limit Id\n maxLength: 36\n example: \"velocitylimit04\"\n\n /v1/cardproducts/{id}/velocitylimits:unlink:\n post:\n tags:\n - Card Products\n summary: Unlink velocity limits from the card product\n description: This API is used to unlink a specific velocity limit from a specific card product.\n operationId: unlinkVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n - name: velocityLimitIds\n in: body\n required: true\n description: An array of velocity limits IDs which require to be unlinked.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 202:\n description: The remaining linked Velocity Limit IDs.\n schema:\n type: array\n items:\n type: string\n description: Velocity Limit Id\n maxLength: 36\n example: \"velocitylimit04\"\n\n /v1/cardproducts/{id}/advancedvelocitylimits:\n get:\n tags:\n - Card Products\n summary: Get advanced velocity limits related to card product\n description: This API is used to retrieve the list of advanced velocity limits related to specific card product.\n operationId: getAdvancedVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product.\n responses:\n 200:\n description: Retrieved the linked advanced velocity limit IDs.\n schema:\n type: array\n description: An array of data.\n items:\n type: string\n description: The unique identifier of advanced velocity Limit.\n example: \"advancedlimit04\"\n\n /v1/cardproducts/{id}/advancedvelocitylimits:link:\n post:\n tags:\n - Card Products\n summary: Link advanced velocity limits to card product\n description: This API is used to link an array of advanced velocity limits to a specific card product.\n operationId: linkAdvancedVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The card product ID.\n - name: advancedVelocityLimits\n in: body\n required: true\n description: The advanced velocity limit ID list to be linked with card product.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 200:\n description: Linked advanced velocity limits to the card product.\n schema:\n type: array\n items:\n type: string\n description: Advanced velocity limit ID.\n maxLength: 36\n example: \"advancedlimit04\"\n\n /v1/cardproducts/{id}/advancedvelocitylimits:unlink:\n post:\n tags:\n - Card Products\n summary: Unlink advanced velocity limits from card product\n description: This API is used to unlink a specific advanced velocity limit from a specific card product.\n operationId: unlinkAdvancedVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The card product ID.\n - name: advancedVelocityLimitIds\n in: body\n required: true\n description: The velocity limit ID list to be unlinked from card product.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 202:\n description: The remaining linked advanced velocity limit IDs.\n schema:\n type: array\n items:\n type: string\n description: Advanced velocity limit ID.\n example: \"advancedlimit04\"\n maxLength: 36\n\n /v1/cardproducts/{id}/balancelimits:\n get:\n tags:\n - Card Products\n summary: Get list of balance limits related to the card product\n description: This API is used to get the list of balance limits related to a specific card product.\n operationId: getBalanceLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n responses:\n 200:\n description: Retrieved the linked balance limit IDs.\n schema:\n type: array\n items:\n type: string\n description: Balance Limit Id\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/balancelimits:link:\n post:\n tags:\n - Card Products\n summary: Link balance limits to the card product\n description: This API is used to link an array of balance limits to a specific card product.\n operationId: linkBalanceLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n - name: balanceLimitIds\n in: body\n required: true\n description: An array of balance limits IDs which require to be linked.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 200:\n description: The linked Balance Limit IDs with the Card Product.\n schema:\n type: array\n items:\n type: string\n description: Balance Limit Id\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/balancelimits:unlink:\n post:\n tags:\n - Card Products\n summary: Unlink balance limits from the card product\n description: This API is used to unlink an array of balance limits from a specific card product.\n operationId: unlinkBalanceLimits\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n - name: balanceLimitIds\n in: body\n required: true\n description: An array of balance limits IDs which require to be unlinked.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 202:\n description: The remaining linked Balance Limit IDs.\n schema:\n type: array\n items:\n type: string\n description: Balance Limit Id\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/fees:\n get:\n tags:\n - Card Products\n summary: Get list of fees related to the card product\n description: This API is used to get the list of fees related to a specific card product.\n operationId: getFees\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n responses:\n 200:\n description: Retrieved the linked fee IDs.\n schema:\n type: array\n items:\n type: string\n description: Fee Id\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/fees:link:\n post:\n tags:\n - Card Products\n summary: Link fees to the card product\n description: This API is used to link an array of fees to a specific card product.\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n - name: feeIds\n in: body\n required: true\n description: An array of fees IDs which require to be linked.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 200:\n description: The linked Fee IDs with the Card Product.\n schema:\n type: array\n items:\n type: string\n description: Fee Id\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/fees:unlink:\n post:\n tags:\n - Card Products\n summary: Unlink fees from the card product\n description: This API is used to unlink a specific fee from a specific card product.\n operationId: unlinkFees\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n - name: feeIds\n in: body\n required: true\n description: An array of fees IDs which require to be unlinked.\n schema:\n $ref: \"#/definitions/CardProductLinkIds\"\n responses:\n 202:\n description: The remaining linked Fee IDs.\n schema:\n type: array\n items:\n type: string\n description: Fee Id\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/charges:link:\n post:\n tags:\n - Card Products\n summary: Link charge to card product\n description: This API is used to link an array of charges to a specific card product.\n operationId: linkCharges\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product.\n - name: chargesIds\n in: body\n required: true\n description: The charges ID list to be linked with card product.\n schema:\n $ref: \"#/definitions/CardProductLinkChargesIds\"\n responses:\n 200:\n description: The linked charges IDs with the card product.\n schema:\n type: array\n items:\n type: string\n description: The unique identifier of the charge.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n\n /v1/cardproducts/{id}/charges:unlink:\n post:\n tags:\n - Card Products\n summary: Unlink charge from card product\n description: This API is used to unlink charges from a specific card product.\n operationId: unlinkCharges\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product.\n - name: chargesIds\n in: body\n required: true\n description: The charges ID list to be unlinked from card product.\n schema:\n $ref: \"#/definitions/CardProductLinkChargesIds\"\n responses:\n 202:\n description: The remaining linked Charges IDs.\n schema:\n type: array\n items:\n type: string\n description: The unique identifier of the charge.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c3eddd6\"\n\n /v1/cardproducts/{id}/charges:\n get:\n tags:\n - Card Products\n summary: Get list of charges related to card product\n description: This API is used to retrieve a list of charges related to specific card product.\n operationId: getCharges\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product.\n responses:\n 200:\n description: Retrieved the linked charges IDs.\n schema:\n type: array\n items:\n type: string\n description: The unique identifier of the charge.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c3eddd6\"\n\n /v1/cardproducts/{id}/advancedfees:\n get:\n tags:\n - Card Products\n summary: Get advanced fees linked to card product\n description: This API is used to retrieve a list of advanced fees related to specific card product.\n operationId: getCardProductAdvancedFees\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product.\n responses:\n 200:\n description: All advanced fees linked to a card product.\n schema:\n type: array\n items:\n type: string\n description: Advanced fee IDs.\n example: \"5b4eabfc-f839-4e51-9dc1-3dc25c3eddd6\"\n\n /v1/cardproducts/{id}/advancedfees:link:\n post:\n tags:\n - Card Products\n summary: Link advanced fees to card product\n description: This API is used to link advanced fees to a specific card product.\n operationId: linkAdvancedFees\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product.\n - name: advancedFeeIds\n in: body\n required: true\n description: Advanced fee ID list to be linked to a card product.\n schema:\n $ref: \"#/definitions/CardProductAdvancedFeeIds\"\n responses:\n 200:\n description: Linked advanced fee IDs for a card product.\n schema:\n type: array\n items:\n type: string\n description: Advanced fee IDs.\n example: \"5b4eabfc-f839-4e51-9dc1-3dc25c3eddd6\"\n\n /v1/cardproducts/{id}/advancedfees:unlink:\n post:\n tags:\n - Card Products\n summary: Unlink advanced fees from card product\n description: This API is used to unlink advanced fees from a specific card product.\n operationId: unlinkAdvancedFees\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card product.\n - name: advancedFeeIds\n in: body\n required: true\n description: Advanced fee ID list to be unlinked from a card product.\n schema:\n $ref: \"#/definitions/CardProductAdvancedFeeIds\"\n responses:\n 200:\n description: Remaining linked advanced fee IDs for a card product.\n schema:\n type: array\n items:\n type: string\n description: Advanced fee IDs.\n example: \"5b4eabfc-f839-4e51-9dc1-3dc25c3eddd6\"\n\n /v1/fxrates:\n get:\n tags:\n - Card Products\n summary: Get list of card product FX rates\n description: This API is used to retrieve FX rates of a specific card product.\n operationId: loadFxRates\n parameters:\n - name: card_product_id\n in: query\n type: string\n required: true\n description: Card product ID for which FX rates are fetched.\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n - name: from_currency\n in: query\n type: string\n required: false\n example: \"USD\"\n description: 3-letter ISO_4217 code representing the currency, from which we are converting.\n pattern: \"^[A-Z]{3}\"\n - name: to_currency\n in: query\n type: string\n required: false\n example: \"EUR\"\n description: 3-letter ISO_4217 code representing the currency, to which we are converting.\n pattern: \"^[A-Z]{3}\"\n responses:\n 200:\n description: Returns card product FX rates.\n schema:\n $ref: \"#/definitions/FxRatesResponse\"\n\n put:\n tags:\n - Card Products\n summary: Update FX rates for card product\n description: This API is used to update FX rates for a specific card product.\n operationId: upsertFxRates\n parameters:\n - name: fxrates\n in: body\n required: true\n schema:\n $ref: \"#/definitions/FxRatesUpsertRequest\"\n responses:\n 200:\n description: Returns FX rates.\n schema:\n $ref: \"#/definitions/FxRatesResponse\"\n\n\n /v1/users:\n get:\n tags:\n - Users\n summary: Get list of all users\n description: This API is used to retrieve all existing users.\n operationId: listUsers\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - name: parent_user_id\n in: query\n description: Parent user ID to retrieve child users.\n required: false\n type: string\n responses:\n 200:\n description: Returns list of users.\n schema:\n $ref: \"#/definitions/UserCollection\"\n\n post:\n tags:\n - Users\n summary: Create user\n description: This API is used to create a new user. You can find all necessary fields for creation of each user type in this GSG doc - https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type.\n operationId: createUser\n parameters:\n - name: create_request\n description: User information\n in: body\n required: true\n schema:\n $ref: \"#/definitions/UserCreateRequest\"\n responses:\n 200:\n description: Returns saved user\n schema:\n $ref: \"#/definitions/User\"\n\n /v1/users/{id}:\n get:\n tags:\n - Users\n summary: Get user details\n description: This API is used to get the details of a specific user.\n operationId: getUser\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the user\n responses:\n 200:\n description: Returns single user.\n schema:\n $ref: \"#/definitions/User\"\n\n put:\n tags:\n - Users\n summary: Update a specific user\n description: Using this API you can update details of a specific user.\n operationId: updateUser\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the user.\n - in: body\n name: user\n required: true\n schema:\n $ref: \"#/definitions/UserUpdateRequest\"\n responses:\n 200:\n description: |\n Returns updated user.\n schema:\n $ref: \"#/definitions/User\"\n\n /v1/users/{id}:changeStatus:\n put:\n tags:\n - Users\n summary: Change user status\n description: This API is used to change user status.\n operationId: changeStatus\n parameters:\n - name: id\n in: path\n description: The unique identifier of the user.\n required: true\n type: string\n - name: statusChange\n in: body\n required: true\n schema:\n $ref: \"#/definitions/UserStatusChangeRequest\"\n responses:\n 200:\n description: Returns single user.\n schema:\n $ref: \"#/definitions/User\"\n\n /v1/users/{id}:getLinkedRelationships:\n get:\n tags:\n - Users\n summary: Get user linked relationships\n description: This API is used to retrieve relationships linked to a specific user.\n operationId: getLinkedRelationships\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the user.\n responses:\n 200:\n description: Returns user linked relationships.\n schema:\n $ref: \"#/definitions/LinkedRelationships\"\n\n /v1/users:search:\n post:\n tags:\n - Users\n summary: Search for users\n description: This API is used to search for users by name, mobile number, and email.\n operationId: search\n parameters:\n - name: criteria\n in: body\n required: true\n schema:\n $ref: \"#/definitions/UserFilter\"\n responses:\n 200:\n description: Returns the list of user objects.\n schema:\n $ref: \"#/definitions/UserCollection\"\n\n /v1/users/{user_id}/identifications:\n post:\n tags:\n - User documents\n summary: Create identification\n description: This API is used to create user identification.\n operationId: createIdentification\n parameters:\n - name: user_id\n description: Unique identifier of the user.\n in: path\n required: true\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_create_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/IdentificationCreateRequest\"\n responses:\n 200:\n description: Returns single identification.\n schema:\n $ref: \"#/definitions/Identification\"\n\n get:\n tags:\n - User documents\n summary: Get user identification\n description: This API is used to get user identification information.\n operationId: getIdentifications\n parameters:\n - name: user_id\n description: Unique identifier of the user.\n in: path\n required: true\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n responses:\n 200:\n description: Returns single identification.\n schema:\n type: array\n items:\n $ref: \"#/definitions/Identification\"\n\n /v1/users/{user_id}/identifications/{identification_id}:\n get:\n tags:\n - User documents\n summary: Get specific identification\n operationId: getIdentification\n description: This API is used to get identification info.\n parameters:\n - name: user_id\n in: path\n type: string\n description: Unique identifier of the user.\n required: true\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_id\n in: path\n type: string\n required: true\n description: Identification ID.\n example: 76dcc374-3763-4472-881c-c29bc2398e97\n responses:\n 200:\n description: Returns single identification.\n schema:\n $ref: \"#/definitions/Identification\"\n\n put:\n tags:\n - User documents\n summary: Update user identification\n description: This API is used to update user identification.\n operationId: updateIdentification\n parameters:\n - name: user_id\n description: Unique identifier of the user.\n in: path\n type: string\n required: true\n - name: identification_id\n in: path\n type: string\n description: Identification ID.\n required: true\n - name: identification_update_request\n description: User identification data\n in: body\n required: true\n schema:\n $ref: \"#/definitions/IdentificationUpdateRequest\"\n responses:\n 200:\n description: Returns updated identification.\n schema:\n $ref: \"#/definitions/Identification\"\n\n /v1/users/identifications:search:\n post:\n tags:\n - User documents\n summary: Search for user identifications\n description: This API is used to search for user identifications.\n operationId: searchIdentification\n parameters:\n - name: criteria\n in: body\n required: true\n schema:\n $ref: '#/definitions/SearchCriteria'\n responses:\n 200:\n description: Identification Collection\n schema:\n $ref: \"#/definitions/UserIdentificationCollection\"\n\n /v1/users/{user_id}/identifications/{identification_id}/files:\n post:\n tags:\n - User documents\n summary: Upload single image of identification\n description: This API is used to upload a single identification file. Max file size - 128Mb. Allowed extensions - pdf, jpg, jpeg, png, bmp, doc, docx.. One user identification can consist of maximum 10 files. For this API to work well, you need to send key-value pair and specify the content type. Key is \"file\". Content type is \"file\".\n operationId: uploadSingleFile\n parameters:\n - name: user_id\n in: path\n type: string\n required: true\n description: Unique identifier of the user.\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_id\n in: path\n type: string\n required: true\n description: Identification ID.\n example: 76dcc374-3763-4472-881c-c29bc2398e97\n - name: file\n in: formData\n type: file\n required: true\n description: The file to be uploaded.\n - name: file_identification_type\n in: formData\n type: string\n required: true\n description: The identification type of file to be uploaded. Possible values [PASSPORT, VISA, NATIONAL_ID,TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT, ADDITIONAL]\n - name: file_identification_document_type\n in: formData\n type: string\n description: The identification document type of file to be uploaded. Possible values [NATIONAL_ID_FRONT, NATIONAL_ID_BACK, PASSPORT_PAGE1, PASSPORT_PAGE2, VISA, ADDITIONAL_PAGE_1, ADDITIONAL_PAGE_2]\n\n responses:\n 200:\n description: Returns uploaded file data.\n schema:\n $ref: \"#/definitions/FileRef\"\n\n put:\n tags:\n - User documents\n summary: Upload user identification\n description: This API is used to upload identification files. Max file size - 128Mb. Allowed extensions - pdf, jpg, jpeg, png, bmp, doc, docx.. One user identification can consist of maximum 10 files (5 files per upload). For this API to work well, you need to send key-value pair(s) and specify the content type. Keys are file1, file2, file3, file4, file5, file6, file7, file8, file9 and file10. Value is the actual file to upload. Content type is \"file\".\n operationId: UploadIdentification\n consumes:\n - multipart/form-data\n parameters:\n - name: user_id\n in: path\n type: string\n required: true\n description: Unique identifier of the user.\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_id\n in: path\n type: string\n required: true\n description: Identification ID.\n example: 76dcc374-3763-4472-881c-c29bc2398e97\n\n - name: file1\n in: formData\n type: file\n required: true\n description: The file to be uploaded.\n - name: file1_identification_type\n in: formData\n type: string\n required: true\n description: The identification type of file to be uploaded. Possible values [PASSPORT, VISA, NATIONAL_ID,TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT, ADDITIONAL]\n - name: file1_identification_document_type\n in: formData\n type: string\n description: The identification document type of file to be uploaded. Possible values [NATIONAL_ID_FRONT, NATIONAL_ID_BACK, PASSPORT_PAGE1, PASSPORT_PAGE2, VISA, ADDITIONAL_PAGE_1, ADDITIONAL_PAGE_2]\n\n - name: file2\n in: formData\n type: file\n description: The file to be uploaded.\n - name: file2_identification_type\n in: formData\n type: string\n description: The identification type of file to be uploaded. Possible values [PASSPORT, VISA, NATIONAL_ID,TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT, ADDITIONAL]\n - name: file2_identification_document_type\n in: formData\n type: string\n description: The identification document type of file to be uploaded. Possible values [NATIONAL_ID_FRONT, NATIONAL_ID_BACK, PASSPORT_PAGE1, PASSPORT_PAGE2, VISA, ADDITIONAL_PAGE_1, ADDITIONAL_PAGE_2]\n\n - name: file3\n in: formData\n type: file\n description: The file to be uploaded.\n - name: file3_identification_type\n in: formData\n type: string\n description: The identification type of file to be uploaded. Possible values [PASSPORT, VISA, NATIONAL_ID,TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT, ADDITIONAL]\n - name: file3_identification_document_type\n in: formData\n type: string\n description: The identification document type of file to be uploaded. Possible values [NATIONAL_ID_FRONT, NATIONAL_ID_BACK, PASSPORT_PAGE1, PASSPORT_PAGE2, VISA, ADDITIONAL_PAGE_1, ADDITIONAL_PAGE_2]\n\n - name: file4\n in: formData\n type: file\n description: The file to be uploaded.\n - name: file4_identification_type\n in: formData\n type: string\n description: The identification type of file to be uploaded. Possible values [PASSPORT, VISA, NATIONAL_ID,TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT, ADDITIONAL]\n - name: file4_identification_document_type\n in: formData\n type: string\n description: The identification document type of file to be uploaded. Possible values [NATIONAL_ID_FRONT, NATIONAL_ID_BACK, PASSPORT_PAGE1, PASSPORT_PAGE2, VISA, ADDITIONAL_PAGE_1, ADDITIONAL_PAGE_2]\n\n - name: file5\n in: formData\n type: file\n description: The file to be uploaded.\n - name: file5_identification_type\n in: formData\n type: string\n description: The identification type of file to be uploaded. Possible values [PASSPORT, VISA, NATIONAL_ID,TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT, ADDITIONAL]\n - name: file5_identification_document_type\n in: formData\n type: string\n description: The identification document type of file to be uploaded. Possible values [NATIONAL_ID_FRONT, NATIONAL_ID_BACK, PASSPORT_PAGE1, PASSPORT_PAGE2, VISA, ADDITIONAL_PAGE_1, ADDITIONAL_PAGE_2]\n responses:\n 200:\n description: Returns uploaded file data.\n schema:\n $ref: \"#/definitions/Identification\"\n\n /v1/users/{user_id}/identifications/{identification_id}/files/{file_id}:\n get:\n tags:\n - User documents\n summary: Return file metadata\n description: This API is used to get file metadata.\n operationId: getFile\n parameters:\n - name: user_id\n in: path\n type: string\n description: Unique identifier of the user.\n required: true\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_id\n in: path\n type: string\n description: Identification ID.\n required: true\n example: 76dcc374-3763-4472-881c-c29bc2398e97\n - name: file_id\n in: path\n type: string\n description: Unique identifier of the file.\n required: true\n example: 624969e5-1ca2-4a11-b1c2-533eab96fd97\n responses:\n 200:\n description: Returns single file metadata.\n schema:\n $ref: \"#/definitions/FileUploadContent\"\n\n delete:\n tags:\n - User documents\n summary: Delete file\n description: This API is used to delete an identification file.\n operationId: deleteFile\n parameters:\n - name: user_id\n in: path\n type: string\n description: Unique identifier of the user.\n required: true\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_id\n in: path\n type: string\n required: true\n description: Identification ID.\n example: 76dcc374-3763-4472-881c-c29bc2398e97\n - name: file_id\n in: path\n description: Unique identifier of the file.\n type: string\n required: true\n example: 624969e5-1ca2-4a11-b1c2-533eab96fd97\n responses:\n 200:\n description: File deleted.\n\n /v1/users/{user_id}/identifications/{identification_id}/files/{file_id}:browse:\n get:\n tags:\n - User documents\n summary: Return file\n description: This API is used to browse file.\n operationId: browseFile\n parameters:\n - name: user_id\n in: path\n description: Unique identifier of the user.\n type: string\n required: true\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_id\n in: path\n type: string\n required: true\n description: Identification ID.\n example: 76dcc374-3763-4472-881c-c29bc2398e97\n - name: file_id\n in: path\n type: string\n description: Unique identifier of the file.\n required: true\n example: 624969e5-1ca2-4a11-b1c2-533eab96fd97\n responses:\n 200:\n description: Returns single file.\n\n /v1/users/{user_id}/identifications/{identification_id}/files/{file_id}:download:\n get:\n tags:\n - User documents\n summary: Download file\n description: This API is used to download file.\n operationId: downloadFile\n parameters:\n - name: user_id\n in: path\n type: string\n description: Unique identifier of the user.\n required: true\n example: 4ba3028b-0e38-4113-a90e-5a8cd3fb27a6\n - name: identification_id\n in: path\n type: string\n description: Identification ID.\n required: true\n example: 76dcc374-3763-4472-881c-c29bc2398e97\n - name: file_id\n in: path\n type: string\n description: Unique identifier of the file.\n required: true\n example: 624969e5-1ca2-4a11-b1c2-533eab96fd97\n responses:\n 200:\n description: Download single file.\n\n /v1/users/{id}/kyc:\n post:\n tags:\n - User KYC\n summary: Perform KYC of user\n operationId: performKyc\n description: This API is used to perform KYC (know your customer) process of a user.\n parameters:\n - name: id\n in: path\n type: string\n description: Unique identifier of the user. If this information is not present in the request, the system generates one automatically.\n required: true\n - name: perform_kyc_create_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/PerformKycCreateRequest\"\n responses:\n 200:\n description: Performs KYC response.\n schema:\n $ref: \"#/definitions/Kyc\"\n\n /v1/users/{user_id}/externalbankdetails:\n post:\n tags:\n - Users\n summary: Link user external bank details\n description: This API is used to link user external bank account details so that these details can be used to execute the external transfers.\n operationId: linkExternalBankDetailsToUser\n parameters:\n - name: user_id\n in: path\n required: true\n type: string\n description: Unique identifier of the user.\n example: \"a34b6c8e-28e5-4370-8234-aeca2b58c48d\"\n - name: link_external_bank_details_user_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/UserExternalBankAccountDetailsRequest\"\n responses:\n 200:\n description: Links external bank details to the user.\n schema:\n $ref: \"#/definitions/UserExternalBankAccountDetailsResponse\"\n\n /v1/users/{user_id}/externalbankdetails/{bank_details_id}:\n get:\n tags:\n - Users\n summary: Get user specific external bank details\n description: This API is used to retrieve user external bank details by its ID.\n operationId: getExternalBankAccountDetails\n parameters:\n - name: user_id\n in: path\n type: string\n required: true\n description: Unique identifier of the user.\n example: \"a34b6c8e-28e5-4370-8234-aeca2b58c48d\"\n - name: bank_details_id\n in: path\n type: string\n required: true\n description: Unique identifier of the bank details.\n example: \"c5cebaf4-9b16-4e50-bae6-dca00210283c\"\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/UserExternalBankAccountDetailsResponse\"\n put:\n tags:\n - Users\n summary: Update user external bank details\n description: This API is used to update user external bank details.\n operationId: updateExternalBankAccountDetails\n parameters:\n - name: user_id\n in: path\n type: string\n required: true\n description: Unique identifier of the user.\n example: \"a34b6c8e-28e5-4370-8234-aeca2b58c48d\"\n - name: bank_details_id\n in: path\n type: string\n required: true\n description: Unique identifier of the bank details.\n example: \"c5cebaf4-9b16-4e50-bae6-dca00210283c\"\n - name: user_external_bank_account_details_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/UserExternalBankAccountDetailsUpdateRequest\"\n responses:\n 200:\n description: Returns updated user external bank account details.\n schema:\n $ref: \"#/definitions/UserExternalBankAccountDetailsResponse\"\n delete:\n tags:\n - Users\n summary: Unlink user external bank details\n description: This API is used to to unlink user external bank account details so that irrelevant information can be removed from user.\n operationId: unlinkExternalBankAccountDetails\n parameters:\n - name: user_id\n in: path\n type: string\n required: true\n description: Unique identifier of the user.\n example: \"a34b6c8e-28e5-4370-8234-aeca2b58c48d\"\n - name: bank_details_id\n in: path\n type: string\n required: true\n description: Unique identifier of the bank details.\n example: \"c5cebaf4-9b16-4e50-bae6-dca00210283c\"\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/UserExternalBankAccountDetailsResponse\"\n\n /v1/users/kyc/{id}:\n get:\n tags:\n - User KYC\n summary: Get KYC by ID\n description: This API is used to get a specific KYC request by its ID.\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: Unique identifier of the KYC request.\n responses:\n 200:\n description: KYC response.\n schema:\n $ref: \"#/definitions/Kyc\"\n\n /v1/users/kyc:search:\n post:\n tags:\n - User KYC\n summary: Search for KYC requests\n description: This API is used to search for KYC requests by different criteria.\n parameters:\n - name: criteria\n in: body\n required: true\n schema:\n $ref: '#/definitions/SearchCriteria'\n responses:\n 200:\n description: List of KYC objects.\n schema:\n $ref: \"#/definitions/UserKycCollection\"\n\n /v1/cards:\n post:\n tags:\n - Cards\n summary: Create card\n operationId: createCard\n description: This API is used to create a card.\n parameters:\n - name: x-nymos-idempotency-key\n in: header\n required: true\n type: string\n description: Unique transaction identification number, also referred as a Retrieval Reference Number (RRN). This number is used to uniquely identify the transaction. A resource created with a unique RRN can not be created twice.\n maxLength: 36\n - name: details\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardCreateRequest\"\n responses:\n 200:\n description: Returns card issuance info.\n schema:\n $ref: \"#/definitions/Card\"\n get:\n tags:\n - Cards\n summary: Get list of cards\n description: This API can be used to retrieve a list of cards. The nCore platform provides you various card retrieval options like to retrieve all cards existing for a tenant, all cards which belong to a single user and all cards that created in a bulk issuance request.\n operationId: listCards\n parameters:\n - name: user_id\n in: query\n type: string\n description: The unique identifier of the user. If included then cards will be retrieved by user id.\n example: \"22ed2f6c-9312-4780-8cf7-a2e75f749543\"\n - name: bulk_issuance_id\n in: query\n type: string\n description: The unique identifier of the bulk issuance. If included then cards will be retrieved by the bulk issuance id.\n example: \"9ea50adf-b70a-4df2-b3a4-83d3cb0a7f9d\"\n - name: proxy_number\n in: query\n type: string\n description: If included then cards will be filtered by Proxy Number\n example: \"0000123456\"\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: Returns a list of cards.\n schema:\n $ref: \"#/definitions/CardCollection\"\n\n /v1/cards:link:\n post:\n tags:\n - Cards\n summary: Link bulk card to user\n description: This API is used to link bulk card to a user. There are 2 possible scenarios when you want to link bulk card to a user.\n\n * `1)` It is requested to pass **'user_id'** and **'activation_token'** parameters in the request to link bulk card to a user and the card will be automatically **activated**.\n\n * `2)` It is requested to pass **'user_id'**, **'card_id'** OR **'proxy_number'** and **'activate_card'** parameters in the request to link bulk card to a user and the card status will be either **ACTIVE** or **INACTIVE** depending on the value given to 'activate_card' parameter.\n operationId: linkCard\n parameters:\n - name: cardLinkRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardLinkRequest\"\n responses:\n 200:\n description: Returns an issued card.\n schema:\n $ref: \"#/definitions/Card\"\n\n /v1/cards/{id}:\n get:\n tags:\n - Cards\n summary: Get card details\n description: This API can be used to retrieve a single card by providing a card id to check the card details.\n operationId: getCard\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier or the proxy number of the card. This identified is required in this API to retrieve the card details.\n\n responses:\n 200:\n description: Returns card details.\n schema:\n $ref: \"#/definitions/Card\"\n put:\n tags:\n - Cards\n summary: Update card\n operationId: updateCard\n description: This API can be used to update card details like bulk issuance id, name on the card, and shipping details.\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier or the proxy number of the card. This identified is required in this API to update the card details.\n\n - name: update_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardUpdateRequest\"\n responses:\n 200:\n description: Returns updated card details.\n schema:\n $ref: \"#/definitions/Card\"\n\n /v1/cards/{id}/authsettings:\n get:\n tags:\n - Cards\n summary: Get card authorization settings data\n description: This API is used to get authorization settings data of a specific card.\n operationId: getCardAuthSettings\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier or the proxy number of the card.\n responses:\n 200:\n description: Returns auth settings regarding card\n schema:\n $ref: \"#/definitions/CardAuthSettings\"\n put:\n tags:\n - Cards\n summary: Update card authorization settings data\n description: This API is used to update authorization settings data of a specific card.\n operationId: upsertCardAuthSettings\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier or the proxy number of the card.\n - name: update_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/UpdateCardAuthSettings\"\n responses:\n 200:\n description: Returns updated authorization settings data.\n schema:\n $ref: \"#/definitions/CardAuthSettings\"\n\n /v1/cards/{id}:showinfo:\n get:\n tags:\n - Cards\n summary: Show card secret data\n operationId: getCardInfo\n description: This API can be used to retrieve and see card's secret data, e.g. PAN (Primary Account Number), CVV2 (Card Verification Value 2), Card expiry date, and Pin retries. This API can be used by a PCI Compliant user, if a non-complaint user is calling this API, then request error 403 (Forbidden) will appear.\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier or the proxy number of the card. This identifier is required in this API to retrieve the card's secret data.\n - name: show_cvv2\n in: query\n type: boolean\n description: This query parameter is used to decide whether to see a clear CVV2 (Card Verification Value) or not. Applicable values are true/false.\n\n responses:\n 200:\n description: Returns card's sensitive data.\n schema:\n $ref: \"#/definitions/CardInfo\"\n\n /v1/cards/{id}:replace:\n post:\n tags:\n - Cards\n summary: Replace card to non-personalized bulk card\n description: This API is used to replace a terminated card (physical or virtual) to a non-personalized physical bulk card so that you can use the replaced card to perform transactions. The replaced card should have status “TERMINATED”.\n operationId: replaceCard\n parameters:\n - name: id\n in: path\n required: true\n type: string\n pattern: '^[a-zA-Z\\-0-9]+$'\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: Card ID from bulk to replace referenced card.\n - name: cardReplaceRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardReplaceRequest\"\n responses:\n 200:\n description: Returns new card.\n schema:\n $ref: \"#/definitions/Card\"\n\n /v1/cards/{id}:createLut:\n post:\n tags:\n - Cards\n summary: Create LUT for requested operation\n description: This API is used to create a LUT (Limited Usage Token) for operations like view clear card details, retrieve clear card PIN, change a card PIN or activate a card. LUT has a timeout of 5 minutes before getting used. If the user does not use the LUT within 5 minutes, it will get expired. Each LUT is for one time use.\n operationId: createLut\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier or the proxy number of the card. The card identifier is required in this API to create LUT for the specific secure card operations provided in field 'operation'.\n - name: lutCreateRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/LutCreateRequest\"\n responses:\n 200:\n description: Returns created Limited Usage Token.\n schema:\n $ref: \"#/definitions/LutResponse\"\n\n /v1/cards/{id}:statuschange:\n put:\n tags:\n - Cards\n summary: Change card status\n description: This API is used to change a card status.\n operationId: changeCardStatus\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier or the proxy number of the card. The card identifier is required in this API to change the card status.\n - name: statusChangeRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/StatusChangeRequest\"\n responses:\n 200:\n description: Returns card details with updated status.\n schema:\n $ref: \"#/definitions/Card\"\n\n /v1/cards/{id}:soft-expiry:\n put:\n tags:\n - Cards\n summary: Set card soft expiry\n description: This API is used to change a card soft expiry.\n operationId: updateSoftExpiry\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier or the proxy number of the card.\n - name: updateSoftExpiryRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardSoftExpiryChangeRequest\"\n responses:\n 200:\n description: Returns card details with updated soft expiry.\n schema:\n $ref: \"#/definitions/Card\"\n\n /v1/cards/{id}/accounts:\n get:\n tags:\n - Cards\n summary: Get accounts related to card\n description: This API is used to retrieve accounts which are linked to the card.\n operationId: getCardAccounts\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier or the proxy number of the card. The card identifier is required in this API to retrieve the linked accounts.\n responses:\n 200:\n description: Returns the accounts linked to the card.\n schema:\n description: The list of accounts, linked to the card.\n type: array\n items:\n type: string\n example: \"b6822247-052d-4bb1-ad49-5e46f7c8fdd0\"\n\n /v1/cards/{id}:getPin:\n get:\n tags:\n - Cards\n operationId: getCardPin\n description: This API is used to retrieve the card secure PIN.\n summary: Get card PIN\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier or the proxy number of the card. The card identifier is required in this API to retrieve the card PIN.\n responses:\n 200:\n description: Returns encrypted card PIN.\n schema:\n $ref: \"#/definitions/CardPinResponse\"\n\n /v1/cards/{id}:changePin:\n put:\n tags:\n - Cards\n operationId: changeCardPin\n description: This API is used to change the card PIN.\n summary: Change card PIN\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier or the proxy number of the card. The card identifier is required in this API to change the card PIN.\n - name: pinChangeRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardPinChangeRequest\"\n responses:\n 204:\n description: Card PIN changed successfully.\n\n /v1/cards/{id}:validatePin:\n post:\n tags:\n - Cards\n summary: Validate card PIN\n description: This API is used to validate the card PIN.\n operationId: validatePin\n parameters:\n - name: id\n in: path\n required: true\n type: string\n pattern: '^[a-zA-Z\\-0-9]+$'\n description: The unique identifier or the proxy number of the card. The card identifier is required in this API to validate the card PIN.\n - name: pin\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardPinChangeRequest\"\n responses:\n 204:\n description: Card PIN is valid.\n\n /v1/cards/{id}:limitInfo:\n get:\n tags:\n - Cards\n summary: Get card limits info\n description: This API is used to fetch all limits associated with card.\n operationId: getCardLimitInfo\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier or the proxy number of the card.\n required: true\n - $ref: \"#/parameters/limitInfoType\"\n responses:\n 200:\n description: Returns list of card limits.\n schema:\n $ref: \"#/definitions/CardsLimitsSearchResponse\"\n\n /v1/bulkissuances:\n get:\n tags:\n - Card Bulk Issuances\n summary: List all bulk issuance card requests\n description: This API is used to retrieve all the existing bulk issuance card requests.\n operationId: listBulkIssuances\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: List bulk issuance card requests.\n schema:\n $ref: \"#/definitions/CardBulkIssuanceCollection\"\n post:\n tags:\n - Card Bulk Issuances\n summary: Create bulk issuance card request\n description: This API is used to create more than one non-personalized physical cards in a single request.\n operationId: createBulkIssuance\n parameters:\n - name: bulkCreateRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardBulkIssuanceCreateRequest\"\n responses:\n 200:\n description: Returns created bulk issuance card request.\n schema:\n $ref: \"#/definitions/CreateCardBulkIssuance\"\n\n /v1/bulkissuances/{id}:\n get:\n tags:\n - Card Bulk Issuances\n summary: Get specific bulk issuance card request\n description: This API is used to retrieve a specific bulk issuance card request.\n operationId: getBulkIssuance\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the bulk issuance card request. This identified is required in this API to retrieve the specific bulk issuance cards details.\n example: \"639d0cb5-45df-4898-903b-dbaa389224bf\"\n responses:\n 200:\n description: Returns a specific bulk issuance card request.\n schema:\n $ref: \"#/definitions/CardBulkIssuance\"\n\n put:\n tags:\n - Card Bulk Issuances\n summary: Update bulk issuance card request\n description: This API is used to update a specific bulk issuance card request.\n operationId: updateBulkIssuance\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the bulk issuance card. This identifier is required in this API to update the existing bulk issuance request details.\n example: \"639d0cb5-45df-4898-903b-dbaa389224bf\"\n - name: bulkUpdateRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardBulkIssuanceUpdateRequest\"\n responses:\n 200:\n description: Returns an updated bulk issuance card request.\n schema:\n $ref: \"#/definitions/UpdateCardBulkIssuance\"\n\n /v1/accounts:\n post:\n tags:\n - Accounts\n summary: Create account\n description: This API is used to create a new account.\n operationId: createAccount\n parameters:\n - name: account\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AccountCreateRequest\"\n responses:\n 200:\n description: Returns newly created account.\n schema:\n $ref: \"#/definitions/Account\"\n get:\n tags:\n - Accounts\n summary: Get list of accounts\n description: This API is used to retrieve all existitng accounts.\n operationId: listAccounts\n parameters:\n - name: user_id\n in: query\n type: string\n description: The unique identifier of the user\n example: \"3392abea-4ef6-4645-b254-d8ace60281af\"\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: Returns list of accounts.\n schema:\n $ref: \"#/definitions/AccountsCollection\"\n\n /v1/accounts/{id}:\n get:\n tags:\n - Accounts\n summary: Get account details\n description: This API is used to retrieve a specific account details.\n operationId: getAccount\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account. This identifier is required in this API to retrieve the account details.\n responses:\n 200:\n description: Returns specific account details.\n schema:\n $ref: \"#/definitions/Account\"\n\n put:\n tags:\n - Accounts\n summary: Update account\n operationId: updateAccount\n description: This API is used to update a specific account. It is applicable when 'is_multi_currency_product'=true for related card product.\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account.\n - name: wallet_details\n in: body\n required: true\n description: Wallet details.\n schema:\n $ref: \"#/definitions/UpdateAccountRequest\"\n responses:\n 200:\n description: Returns account.\n schema:\n $ref: \"#/definitions/UpdateAccountResponse\"\n\n /v1/accounts/{id}:changeStatus:\n put:\n tags:\n - Accounts\n summary: Change account status\n description: This API is used to change the account status.\n operationId: changeAccountStatus\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account. The account identifier is required in this API to change the account status.\n - name: changeAccountStatusRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/ChangeAccountStatusRequest\"\n responses:\n 200:\n description: Returns updated account details.\n schema:\n $ref: \"#/definitions/Account\"\n\n /v1/accounts/{id}/cards:link:\n post:\n tags:\n - Accounts\n summary: Link cards to account\n description: This API is used to link cards to the specific account.\n operationId: linkCardsToAccount\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account.\n - name: details\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardsLinkToAccountRequest\"\n responses:\n 200:\n description: Returns the list of card IDs linked to the account.\n schema:\n type: array\n items:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n\n /v1/accounts/{id}/balancelimits:link:\n post:\n tags:\n - Accounts\n summary: Link balance limit to account\n description: This API is used to link balance limit to the specific account.\n operationId: linkBalanceLimit\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account.\n - name: details\n in: body\n required: true\n schema:\n $ref: \"#/definitions/BalanceLimitObject\"\n responses:\n 200:\n description: Returns the linked balance limit of the account.\n schema:\n type: string\n $ref: \"#/definitions/BalanceLimitObject\"\n\n /v1/accounts/{id}/balancelimits:unlink:\n post:\n tags:\n - Accounts\n summary: Unlink balance limit from account\n description: This API is used to unlink balance limit from the specific account.\n operationId: unlinkBalanceLimit\n parameters:\n - name: id\n in: path\n required: true\n description: The unique identifier of the account.\n type: string\n - name: details\n in: body\n required: true\n schema:\n $ref: \"#/definitions/BalanceLimitObject\"\n responses:\n 200:\n description: Returns the unlinked balance limit of the account.\n schema:\n type: string\n $ref: \"#/definitions/BalanceLimitObject\"\n\n /v1/accounts/{id}/balancelimits:\n get:\n tags:\n - Accounts\n description: This API is used to fetch balance limit from the specific account.\n summary: Get balance limits linked to account\n operationId: getBalanceLimitsByAccountId\n parameters:\n - name: id\n in: path\n required: true\n description: The unique identifier of the account.\n type: string\n responses:\n 200:\n description: Returns the list of balance limits IDs linked to the account.\n schema:\n type: array\n items:\n type: string\n example: \"91fd885d-9db5-48a9-9cfb-c9adbb4f5475\"\n\n\n /v1/accounts/{id}:loadFunds:\n post:\n tags:\n - Accounts\n summary: Load account funds\n description: This API can be used to load funds into the account.\n operationId: loadAccountFunds\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account. The account identifier is required in this API to load funds into the account.\n - name: X-Nymos-Idempotency-Key\n in: header\n type: string\n required: true\n description: Unique transaction identification number, also referred as a Retrieval Reference Number (RRN). This number is used to uniquely identify the transaction. A resource created with a unique RRN can not be created twice.\n maxLength: 36\n - name: loadAccountFundsRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AccountFundsRequest\"\n responses:\n 200:\n description: Returns account funds transaction.\n schema:\n $ref: \"#/definitions/AccountFundsTransaction\"\n\n /v1/accounts/{id}:unloadFunds:\n post:\n tags:\n - Accounts\n summary: Unload account funds\n operationId: unloadAccountFunds\n description: This API can be used to unload funds from the account.\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account. The account identifier is required in this API to unload funds from the account.\n - name: X-Nymos-Idempotency-Key\n in: header\n type: string\n required: true\n description: Unique transaction identification number, also referred as a Retrieval Reference Number (RRN). This number is used to uniquely identify the transaction. A resource created with a unique RRN can not be created twice.\n maxLength: 36\n - name: unloadAccountFundsRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AccountFundsRequest\"\n responses:\n 200:\n description: Returns account funds transaction.\n schema:\n $ref: \"#/definitions/AccountFundsTransaction\"\n /v1/accounts/{id}:initialLoadFunds:\n post:\n tags:\n - Accounts\n summary: Load initial funds\n operationId: initialLoadFunds\n description: This API is used to perform initial load funds.\n parameters:\n - name: id\n in: path\n required: true\n description: The unique identifier of the account.\n type: string\n - name: X-Nymos-Idempotency-Key\n in: header\n type: string\n required: true\n description: Unique transaction ID.\n maxLength: 36\n - name: loadAccountFundsRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AccountFundsRequest\"\n responses:\n 200:\n description: Returns account funds transaction.\n schema:\n $ref: \"#/definitions/AccountFundsTransaction\"\n\n /v1/accounts/{id}/cards:\n get:\n tags:\n - Accounts\n summary: Get cards related to account\n description: This API is used to retrieve cards which are linked to the account.\n operationId: getAccountCards\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the account. The account identifier is required in this API to retrieve the linked cards.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n responses:\n 200:\n description: Returns the list of card IDs linked to the account.\n schema:\n type: array\n description: The list of card IDs linked to the account.\n items:\n type: string\n example: \"f9dc8fb0-ba5b-4d61-83df-7ab821fd02d5\"\n\n /v1/accounts/{id}:token:\n post:\n tags:\n - Accounts\n summary: Create account token\n description: This API is used to create an account token for external transactions that are initiated from third parties.\n operationId: createAccountToken\n parameters:\n - name: id\n in: path\n description: The unique identifier of the account.\n required: true\n type: string\n - name: details\n in: body\n required: true\n description: The details of the token request.\n schema:\n $ref: \"#/definitions/CreateTokenRequest\"\n responses:\n 200:\n description: Returns newly created account token.\n schema:\n $ref: \"#/definitions/AccountTokenResponse\"\n\n /v1/notificationtemplates:\n get:\n tags:\n - Notification Templates\n operationId: listTemplates\n summary: Get list of templates\n description: This API is used to retrieve the list of all existing notification templates.\n parameters:\n - name: language\n in: query\n type: string\n description: The language used in the template.\n - name: card_product_id\n in: query\n type: string\n description: The notification template is linked with the card product id shared in this parameter.\n - name: category\n in: query\n type: string\n description: The type of event to which the template is associated.\n enum:\n - THREE_D_SECURE_OTP\n - ITSP_OTP\n - name: walletProvider\n in: query\n type: string\n description: Wallet provider field applicable for ITSP_OTP category.\n enum:\n - APPLEPAY\n - SAMSUNGPAY\n - GOOGLEPAY\n responses:\n 200:\n description: Returns all templates.\n schema:\n type: array\n items:\n $ref: \"#/definitions/NotificationTemplates\"\n post:\n tags:\n - Notification Templates\n operationId: createTemplate\n summary: Create template\n description: This API is used to create a SMS notification template.\n parameters:\n - name: template\n in: body\n required: true\n schema:\n $ref: \"#/definitions/NotificationTemplatesCreateRequest\"\n responses:\n 200:\n description: Returns created template.\n schema:\n $ref: \"#/definitions/NotificationTemplates\"\n\n /v1/notificationtemplates/{template_id}:\n get:\n tags:\n - Notification Templates\n operationId: getTemplate\n summary: Get specific template\n description: This API is used to retrieve a specific notification template.\n parameters:\n - name: template_id\n in: path\n required: true\n type: string\n description: ID of the template\n responses:\n 200:\n description: Returns a specific template.\n schema:\n $ref: \"#/definitions/NotificationTemplates\"\n put:\n tags:\n - Notification Templates\n operationId: updateTemplate\n summary: Update template\n description: This API is used to update the existing notification template.\n parameters:\n - name: template_id\n in: path\n required: true\n type: string\n description: ID of the template\n - name: template\n in: body\n required: true\n schema:\n $ref: \"#/definitions/NotificationTemplatesUpdateRequest\"\n responses:\n 200:\n description: Returns an updated template.\n schema:\n $ref: \"#/definitions/NotificationTemplates\"\n delete:\n tags:\n - Notification Templates\n operationId: deleteTemplate\n summary: Delete template\n description: This API is used to delete the existing notification template.\n parameters:\n - name: template_id\n in: path\n required: true\n type: string\n description: ID of the template\n responses:\n 204:\n description: Deletes a specific template.\n\n /v1/transfers/:\n post:\n tags:\n - Fund Transfers\n summary: Transfer funds between accounts\n description: This API is used to transfer funds from one account to another account.\n operationId: transfer\n parameters:\n - name: X-Nymos-Idempotency-Key\n in: header\n type: string\n required: true\n description: Unique transaction identification number, also referred as a Retrieval Reference Number (RRN). This number is used to uniquely identify the transaction. A resource created with a unique RRN can not be created twice.\n maxLength: 36\n - name: transferAccountFundsRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/AccountTransferRequest\"\n responses:\n 200:\n description: Returns account funds transaction.\n schema:\n $ref: \"#/definitions/AccountTransferTransaction\"\n\n get:\n tags:\n - Fund Transfers\n summary: Get list of transfers\n description: This API is used to retrieve the list of transfers.\n operationId: getTransfers\n parameters:\n - name: sender_account_id\n type: string\n description: Sender account Identifier\n in: query\n - name: recipient_account_id\n type: string\n description: Recipient account Identifier\n in: query\n - name: transfer_date_time_start\n type: string\n format: date-time\n description: Date and time of a transfer, starting with which you want to filter a list of transfer. This parameter is displayed in the following format \"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'\".\n in: query\n - name: transfer_date_time_end\n type: string\n format: date-time\n description: Date and time of a transfer, ending with which you want to filter a list of transfer. This parameter is displayed in the following format \"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'\".\n in: query\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: Returns account funds transactions.\n schema:\n $ref: \"#/definitions/TransfersCollection\"\n\n /v1/transfers/{id}:\n get:\n tags:\n - Fund Transfers\n summary: Get specific transfer\n description: This API is used to retrieve a specific transfer details.\n operationId: getTransfer\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the transfer. This identifier is required in this API to retrieve the transfer details.\n responses:\n 200:\n description: Returns account funds transaction.\n schema:\n $ref: \"#/definitions/AccountTransferTransaction\"\n\n /v1/webhooks:\n post:\n tags:\n - Webhooks\n summary: Create webhook\n description: This API is used to create a webhook.\n operationId: createWebhookNotification\n parameters:\n - name: webhook\n in: body\n required: true\n schema:\n $ref: \"#/definitions/WebhookCreateRequest\"\n responses:\n 200:\n schema:\n $ref: \"#/definitions/Webhook\"\n description: Returns created webhook.\n\n\n get:\n tags:\n - Webhooks\n summary: Get list of webhooks\n description: This API is used to get list of webhooks.\n operationId: listWebhookNotifications\n responses:\n 200:\n description: Returns the list of webhooks notifications.\n schema:\n type: array\n items:\n $ref: \"#/definitions/Webhook\"\n\n /v1/webhooks/{id}:\n get:\n tags:\n - Webhooks\n summary: Get specific webhook\n description: This API is used to return a specific webhook.\n operationId: getWebhook\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: Unique identifier for the webhook.\n responses:\n 200:\n description: Returns a specific webhook.\n schema:\n $ref: \"#/definitions/Webhook\"\n\n put:\n tags:\n - Webhooks\n summary: Update webhook\n description: This API is used to update a webhook.\n operationId: updateWebhookNotification\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: Unique identifier for the webhook.\n - name: update_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/WebhookCreateRequest\"\n responses:\n 200:\n description: Returns an updated webhook.\n schema:\n $ref: \"#/definitions/Webhook\"\n\n delete:\n tags:\n - Webhooks\n summary: Delete webhook\n description: This API is used to delete a webhook.\n operationId: deleteWebhook\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: Unique identifier for the webhook.\n responses:\n 204:\n description: Webhook notification deleted successfully.\n\n /v1/webhooks/{id}:ping:\n post:\n tags:\n - Webhooks\n summary: Ping webhook\n description: This API is used to ping webhook for testing purposes.\n operationId: pingWebhook\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: Unique identifier for the webhook.\n - name: payload\n in: body\n required: true\n schema:\n type: string\n responses:\n 200:\n description: Webhook notification is sent successfully.\n\n\n /v1/webhooks:sendExpired:\n post:\n tags:\n - Webhooks\n summary: Trigger expired webhooks\n description: This API is used to trigger expired webhook notifications. It is also possible to send just one\n notification by ID.\n operationId: sendWebhooksExpired\n parameters:\n - name: notification_id\n in: query\n required: false\n type: string\n description: Unique identifier for the webhook notification.\n responses:\n 200:\n description: Expired webhook notifications sent successfully.\n\n /v1/webhooks:search:\n post:\n tags:\n - Webhooks\n summary: Search webhooks\n operationId: searchWebhooks\n description: This API is used to search webhooks by different criteria.\n parameters:\n - name: criteria\n in: body\n required: true\n description: Search criteria.\n schema:\n $ref: '#/definitions/SearchCriteria'\n responses:\n 200:\n description: Returns the list of webhooks notifications.\n schema:\n $ref: \"#/definitions/WebhooksIndexCollection\"\n\n /v1/transactions/{id}:\n get:\n tags:\n - Transactions\n summary: Get transaction details\n description: This API is used to retrieve details of a specific transaction.\n operationId: getTransactionById\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier of the transaction.\n required: true\n responses:\n 200:\n description: Returns details of a specific transaction.\n schema:\n $ref: \"#/definitions/NymcardTransactionCallback\"\n\n /v1/transactions:search:\n post:\n tags:\n - Transactions\n summary: Search for transactions\n description: This API is used to search for transactions by different criteria.\n operationId: searchNymcardTransactions\n parameters:\n - name: criteria\n in: body\n required: true\n schema:\n $ref: '#/definitions/SearchCriteria'\n responses:\n 200:\n description: Returns the list of transactions.\n schema:\n $ref: \"#/definitions/NymcardTransactionIndexCollection\"\n\n /v1/cards/{id}/velocitylimits:link:\n post:\n tags:\n - Cards\n summary: |\n Set velocity limits for card\n description: This API is used to set velocity limits for a specific card.\n operationId: linkVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier or the proxy number of the card.\n required: true\n pattern: '^[a-zA-Z\\-0-9]+$'\n - name: ids\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardVelocityLimitsLinkRequest\"\n responses:\n 200:\n description: Returns linked velocity limits.\n schema:\n type: array\n items:\n type: string\n description: Velocity limit ID.\n example: \"velocitylimit02\"\n\n /v1/cards/{id}/velocitylimits:unlink:\n post:\n tags:\n - Cards\n summary: |\n Remove velocity limits for card\n description: This API is used to remove velocity limits from a specific card.\n operationId: unlinkCardVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier or the proxy number of the card.\n required: true\n pattern: '^[a-zA-Z\\-0-9]+$'\n - name: ids\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CardVelocityLimitsUnlinkRequest\"\n responses:\n 200:\n description: Returns unlinked velocity limits.\n schema:\n type: array\n items:\n type: string\n description: Velocity limit ID.\n example: \"velocitylimit02\"\n\n /v1/cards/{id}/velocitylimits:\n get:\n tags:\n - Cards\n summary: Get velocity limits linked to card\n description: This API is used to retrieve the list of velocity limits linked to a specific card.\n operationId: getCardVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier or the proxy number of the card.\n pattern: '^[a-zA-Z\\-0-9]+$'\n required: true\n responses:\n 200:\n description: Returns linked velocity limits.\n schema:\n type: array\n items:\n type: string\n description: Velocity limit ID.\n example: \"velocitylimit02\"\n\n /v1/cards/{id}/advancedvelocitylimits:\n get:\n tags:\n - Cards\n summary: Get advanced velocity limits linked to card\n description: This API is used to retrieve the list of advanced velocity limits linked to a specific card.\n operationId: getAdvancedCardVelocityLimits\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier or the proxy number of the card.\n pattern: '^[a-zA-Z\\-0-9]+$'\n required: true\n responses:\n 200:\n description: Returns linked advanced velocity limits.\n schema:\n type: array\n items:\n type: string\n description: Advanced velocity limit ID.\n example: \"advancedlimit04\"\n\n /v1/cards/{id}/advancedvelocitylimits:link:\n post:\n tags:\n - Cards\n summary: |\n Link advanced velocity limits to card\n operationId: linkCardAdvancedVelocityLimits\n description: This API is used to link an array of advanced velocity limits to a specific card.\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier of the card.\n required: true\n pattern: '^[a-zA-Z\\-0-9]+$'\n - name: ids\n in: body\n required: true\n description: The advanced velocity limit ID list to be linked with the card.\n schema:\n $ref: \"#/definitions/CardVelocityLimitsLinkRequest\"\n responses:\n 200:\n description: Returns linked advanced velocity limits.\n schema:\n type: array\n items:\n type: string\n description: Advanced velocity limit ID.\n example: \"advancedlimit04\"\n\n /v1/cards/{id}/advancedvelocitylimits:unlink:\n post:\n tags:\n - Cards\n summary: |\n Unlink advanced velocity limits from card\n operationId: unlinkCardAdvancedVelocityLimits\n description: This API is used to unlink an array of advanced velocity limits from a specific card.\n parameters:\n - name: id\n in: path\n type: string\n required: true\n description: The unique identifier of the card.\n pattern: '^[a-zA-Z\\-0-9]+$'\n - name: ids\n in: body\n required: true\n description: The advanced velocity limit ID list to be unlinked from the card.\n schema:\n $ref: \"#/definitions/CardVelocityLimitsUnlinkRequest\"\n responses:\n 202:\n description: Returns unlinked advanced velocity limits.\n schema:\n type: array\n items:\n type: string\n description: Advanced velocity limit ID.\n example: \"advancedlimit04\"\n\n /v1/allowedcountries:\n post:\n tags:\n - Allowed Lists\n operationId: createAllowedCountries\n summary: Create list of allowed countries\n parameters:\n - name: allowedCountries\n in: body\n required: true\n schema:\n $ref: '#/definitions/AllowedCountriesRequest'\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedCountries'\n get:\n tags:\n - Allowed Lists\n operationId: listAllowedCountries\n summary: Get list of allowed countries\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedCountriesCollection'\n\n\n /v1/allowedcountries/{id}:\n get:\n tags:\n - Allowed Lists\n operationId: getAllowedCountries\n summary: Get allowed countries list by ID\n parameters:\n - name: id\n in: path\n description: The unique identifier of the allowed countries list\n type: string\n required: true\n pattern: '^[a-zA-Z\\-0-9]+$'\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedCountries'\n put:\n tags:\n - Allowed Lists\n operationId: updateAllowedCountries\n summary: Update allowed countries list by ID\n parameters:\n - name: id\n in: path\n type: string\n required: true\n pattern: '^[a-zA-Z\\-0-9]+$'\n description: The unique identifier of the allowed countries list\n - name: allowedCountriesUpdateRequest\n in: body\n required: true\n schema:\n $ref: '#/definitions/AllowedCountriesUpdateRequest'\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedCountries'\n\n\n /v1/allowedmccs:\n post:\n tags:\n - Allowed Lists\n operationId: createAllowedMccs\n summary: Create list of allowed MCCs\n parameters:\n - name: allowedMccs\n in: body\n required: true\n schema:\n $ref: '#/definitions/AllowedMccsRequest'\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedMccs'\n get:\n tags:\n - Allowed Lists\n operationId: listAllowedMccs\n summary: Get list of allowed MCCs\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedMccsCollection'\n\n\n /v1/allowedmccs/{id}:\n get:\n tags:\n - Allowed Lists\n operationId: getAllowedMccs\n summary: Get allowed MCCs list by ID\n parameters:\n - name: id\n in: path\n description: The unique identifier of the allowed MCCs list\n type: string\n required: true\n pattern: '^[a-zA-Z\\-0-9]+$'\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedMccs'\n put:\n tags:\n - Allowed Lists\n operationId: updateAllowedMccs\n summary: Update allowed MCCs list by ID\n description: This API is used to update allowed MCCs list.\n parameters:\n - name: id\n in: path\n type: string\n required: true\n pattern: '^[a-zA-Z\\-0-9]+$'\n description: The unique identifier of the allowed MCCs list\n - name: allowedMccsUpdateRequest\n in: body\n required: true\n schema:\n $ref: '#/definitions/AllowedMccsUpdateRequest'\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/AllowedMccs'\n\n /v1/orders:\n post:\n tags:\n - Orders\n summary: Create order\n operationId: createOrder\n description: This API is used to create an order.\n parameters:\n - name: order\n in: body\n required: true\n schema:\n $ref: \"#/definitions/OrderCreateRequest\"\n responses:\n 200:\n description: Returns newly created order session.\n schema:\n $ref: \"#/definitions/OrderResponse\"\n\n /v1/orders/{id}:\n get:\n tags:\n - Orders\n summary: Get order\n description: This API is used to retrieve details of a specific order.\n operationId: getOrder\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of the order.\n responses:\n 200:\n description: Returns an order.\n schema:\n $ref: \"#/definitions/OrderResponse\"\n\n /v1/orders/token:\n post:\n tags:\n - Orders\n summary: Create temporary user token\n operationId: createDapiToken\n description: This API is used to create temporary user token for orders in the standard NymCard widget and MPGS.\n parameters:\n - name: createOrdersTokenRequest\n in: body\n required: true\n schema:\n $ref: \"#/definitions/CreateOrderTokenRequest\"\n responses:\n 200:\n description: Returns newly created token.\n schema:\n $ref: \"#/definitions/OrderTokenResponse\"\n\n /v1/digitalwallets/tokens:\n get:\n tags:\n - VTS Tokens\n summary: Get all digital wallet tokens\n description: This API is used to get the list of all tokens.\n parameters:\n - name: token_reference_id\n in: query\n type: string\n description: If included then tokens will be filtered by token reference ID.\n - name: card_id\n in: query\n type: string\n description: If included then tokens will be filtered by card ID.\n - name: pan_reference_id\n in: query\n type: string\n description: If included then tokens will be filtered by PAN reference ID.\n - name: token_requestor_id\n in: query\n type: string\n description: If included then tokens will be filtered by token requestor ID.\n - name: wallet_provider\n in: query\n type: string\n description: If included then information of all the digital wallet tokens will be returned\n - name: token_type\n in: query\n type: string\n description: If included then tokens will be filtered by token type.\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: Returns the list of tokens.\n schema:\n $ref: \"#/definitions/VtsTokenCollection\"\n /v1/digitalwallets/tokens/{id}:\n get:\n tags:\n - VTS Tokens\n summary: Get token by ID\n description: This API is used to get the specific token by its ID.\n parameters:\n - name: id\n required: true\n in: path\n type: string\n description: The unique identifier of the token.\n responses:\n 200:\n description: Returns data of the specific token.\n schema:\n $ref: \"#/definitions/VtsToken\"\n /v1/digitalwallets/tokens/{id}:statuschange:\n put:\n tags:\n - VTS Tokens\n summary: Change token status\n description: This API is used to change the status of the token.\n operationId: statusChangeToken\n parameters:\n - name: id\n required: true\n in: path\n type: string\n description: The unique identifier of the token.\n - name: statusChangeRequest\n required: true\n in: body\n schema:\n $ref: \"#/definitions/TokenStatusChangeRequest\"\n responses:\n 200:\n description: Returns token information.\n schema:\n $ref: \"#/definitions/VtsToken\"\n\n /v1/digitalwallets/tokens/mdes/{id}:statuschange:\n put:\n tags:\n - MDES Tokens\n summary: Change token status\n description: This API is used to change token status.\n operationId: changeStatusMdesToken\n parameters:\n - name: id\n required: true\n in: path\n type: string\n description: The unique identifier of the token.\n - name: statusChangeMdesRequest\n required: true\n in: body\n schema:\n $ref: \"#/definitions/MdesTokenStatusChangeRequest\"\n responses:\n 200:\n description: Returns token information.\n schema:\n $ref: \"#/definitions/MdesApiLog\"\n\n /v1/digitalwallets/tokens/card/{id}:encryptedCardDetails:\n get:\n tags:\n - VTS Tokens\n summary: Get encrypted card details\n description: This API is used to get encrypted card details, which will be used when calling SDK.\n operationId: encryptCardDetails\n parameters:\n - name: id\n in: path\n type: string\n pattern: '^[a-zA-Z\\-0-9]+$'\n required: true\n description: The unique identifier or the proxy number of the card.\n - name: nonce_jws\n in: query\n type: string\n maxLength: 256\n required: true\n description: Base64 encoded payload of signed nonce. It is generated with the help of SDK.\n responses:\n 200:\n description: Returns encrypted card details.\n schema:\n $ref: \"#/definitions/EncryptCardDetailsResponse\"\n\n /simulate/transaction:\n post:\n tags:\n - Transactions\n summary: Simulate authorization transaction\n operationId: simulateTransaction\n description: This API is used to simulate authorization transaction. Below you can find prerequisite steps -\n\n * create a card (for 'Simulate authorization transaction' API to return successful response, BIN used in card product needs to be defined at NymCard's side first so we can route the transaction to your own tenant. If the network scheme is \"VISA\", then BIN should start from 4. In case it is \"MASTERCARD\", then BIN should start from 5 or 2);\n\n * activate card (if not active by default);\n\n * load the corresponding card account with funds;\n\n * use \"Show card secret data\" API to reveal card info;\n\n * use card info (PAN, EXPIRY [YYMM], CVV2) in simulate transaction request.\n parameters:\n - name: simulateTransactionRequest\n in: body\n required: true\n schema:\n $ref: '#/definitions/SimulateTransactionRequest'\n responses:\n 200:\n description: OK\n schema:\n $ref: '#/definitions/SimulateTransactionResponse'\n\n /v1/idvpolicies:\n get:\n tags:\n - User IDV\n summary: Get all IDV policies\n operationId: getIdvPolicies\n description: This API is used to get the list of all IDV policies.\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/IdvPolicyCollection\"\n\n /v1/idvpolicies/{id}:\n get:\n tags:\n - User IDV\n summary: Get IDV policy by ID\n operationId: getIdvPolicy\n description: This API is used to get specific IDV policy by its ID.\n parameters:\n - name: id\n in: path\n type: string\n description: The unique identifier of IDV policy.\n required: true\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/IdvPolicyResponse\"\n\n /v1/users/{user_id}/identityverificationsdetail:\n get:\n tags:\n - User IDV\n summary: Get user's IDV report details\n description: This API is used to get user’s identification report details. In case the user has more than one report, then all reports will be retrieved.\n operationId: getIdentityVerificationsDetail\n parameters:\n - name: user_id\n in: path\n description: The unique identifier of the user.\n type: string\n required: true\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/UserDocumentReportCollection\"\n\n /v1/users/{user_id}/identityverificationsdetail/{id}:\n get:\n tags:\n - User IDV\n summary: Get user verification by reportID\n description: This API is used to get user’s identification report by report_id.\n operationId: getIdentityVerification\n parameters:\n - name: user_id\n in: path\n type: string\n description: The unique identifier of the user.\n required: true\n - name: id\n in: path\n type: string\n description: The unique identifier of the report.\n required: true\n responses:\n 200:\n description: OK\n schema:\n $ref: \"#/definitions/UserDocumentReportResponse\"\n\n /v1/fxrates/groups:\n get:\n tags:\n - FX rates\n summary: Get list of FX rate groups\n description: This API is used to get the list of FX rate groups.\n operationId: getFxRateGroups\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n responses:\n 200:\n description: Returns FX rate groups.\n schema:\n $ref: \"#/definitions/FxRateGroupsResponse\"\n\n /v1/fxrates/groups/{id}:\n get:\n tags:\n - FX rates\n summary: Get specific FX rate group\n description: This API is used to retrieve the details of a specific FX rate group.\n operationId: getFxRateGroupById\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of FX rate group.\n responses:\n 200:\n description: Returns FX rate group details.\n schema:\n $ref: \"#/definitions/FxRateGroupResponse\"\n\n /v1/fxrates/providers:\n get:\n tags:\n - FX rates\n summary: Get list of FX rate providers\n description: This API is used to get the list of FX rate providers.\n operationId: getFxRateProviders\n responses:\n 200:\n description: Returns FX rate providers.\n schema:\n $ref: \"#/definitions/FxRateProvidersResponse\"\n\n /v1/fxrateproviders/{id}:\n get:\n tags:\n - FX rates\n summary: Get specific FX rate provider\n description: This API is used to retrieve the details of a specific FX rate provider.\n operationId: findFxRateProviderById\n parameters:\n - name: id\n in: path\n description: The unique identifier of FX rate provider.\n type: string\n required: true\n responses:\n 200:\n description: Returns FX rate provider details.\n schema:\n $ref: \"#/definitions/FxRateProvider\"\n\n\n /v1/fxrates/quotes:\n get:\n tags:\n - FX rates\n summary: Get list of FX rate quotes\n description: This API is used to get the list of FX rate quotes.\n operationId: getFxRatesQuotes\n parameters:\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n responses:\n 200:\n description: Returns all FX rate quotes.\n schema:\n $ref: \"#/definitions/FxRatesQuotesCollection\"\n\n /v1/fxrates/quotes/{id}:\n get:\n tags:\n - FX rates\n summary: Get specific FX rate quote\n description: This API is used to retrieve the details of a specific FX rate quote.\n operationId: getFxRatesQuoteById\n parameters:\n - name: id\n in: path\n required: true\n type: string\n description: The unique identifier of FX rate quote.\n responses:\n 200:\n description: Returns FX rate quote details.\n schema:\n $ref: \"#/definitions/FxRatesQuotes\"\n\n\n /v1/fxrates:quote:\n post:\n tags:\n - FX rates\n summary: Request FX rate quote\n description: This API is used to request FX rate quote.\n operationId: getFxRatesQuote\n parameters:\n - name: quote\n in: body\n required: true\n schema:\n $ref: \"#/definitions/QuoteCreateRequest\"\n responses:\n 200:\n description: Returns fx rate provider.\n schema:\n $ref: \"#/definitions/QuoteCreateResponse\"\n\n /v1/fxrates/{quoteId}:book:\n put:\n tags:\n - FX rates\n summary: Book FX rate quote\n description: This API is used to book a FX rate quote.\n operationId: bookFxRate\n parameters:\n - name: quoteId\n in: path\n required: true\n type: string\n description: The unique identifier of FX rate quote.\n responses:\n 200:\n description: Returns FX rates.\n schema:\n $ref: \"#/definitions/BookFxRateQuoteResponse\"\n\n\n\n /v1/charges:\n get:\n tags:\n - Charges\n summary: Get list of charges\n description: This API is used to get the list of card issuance charges.\n operationId: listCharges\n parameters:\n - name: charge_type\n in: query\n type: string\n description: The type of the charge.\n example: \"PHYSICAL_CARD_ISSUANCE\"\n - name: ids\n in: query\n type: string\n description: The list of the charge unique identifiers.\n - $ref: \"#/parameters/limit\"\n - $ref: \"#/parameters/after\"\n - $ref: \"#/parameters/sort_by\"\n - $ref: \"#/parameters/order_by\"\n responses:\n 200:\n description: Returns all charges.\n schema:\n $ref: \"#/definitions/ChargesCollection\"\n\n post:\n tags:\n - Charges\n summary: Create charge\n description: This API is used to create card issuance charge.\n operationId: createCharges\n parameters:\n - name: charges_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/ChargesCreateRequest\"\n responses:\n 200:\n description: Returns created charge.\n schema:\n $ref: \"#/definitions/Charges\"\n\n /v1/charges/{charges_id}:\n get:\n tags:\n - Charges\n summary: Get a specific charge\n description: This API is used to get specific card issuance charge by ID.\n operationId: getCharges\n parameters:\n - name: charges_id\n in: path\n type: string\n required: true\n description: The unique identifier of the charge.\n responses:\n 200:\n description: Returns specific charge.\n schema:\n $ref: \"#/definitions/Charges\"\n\n put:\n tags:\n - Charges\n summary: Update charge\n description: This API is used to update card issuance charge.\n operationId: updateCharges\n parameters:\n - name: charges_id\n in: path\n type: string\n required: true\n description: The unique identifier of the charge.\n - name: charges_request\n in: body\n required: true\n schema:\n $ref: \"#/definitions/ChargesUpdateRequest\"\n responses:\n 200:\n description: Returns updated charge.\n schema:\n $ref: \"#/definitions/Charges\"\n\n /v1/remittances/originationcurrencies:\n get:\n tags:\n - Remittance - Western Union\n summary: Get origination currencies\n description: This API is used to get list of possible origination currencies.\n operationId: getOriginationCurrencies\n responses:\n 200:\n description: Returns list of origination currencies.\n schema:\n type: array\n items:\n $ref: \"#/definitions/OriginationCurrency\"\n\n /v1/remittances/partnerstatuses:\n get:\n tags:\n - Remittance - Western Union\n summary: Get partner statuses\n description: This API is used to get list of possible partner statuses.\n operationId: getPartnerStatuses\n responses:\n 200:\n description: Returns list of partner statuses.\n schema:\n type: array\n items:\n $ref: \"#/definitions/PartnerStatus\"\n\n /v1/remittances/countrycurrencies:\n get:\n tags:\n - Remittance - Western Union\n summary: Get country and currencies for specific origination country\n description: This API is used to get possible country and currencies for specific origination country.\n operationId: getCountryCurrencies\n parameters:\n - name: originationCurrency\n description: Origination currency.\n in: query\n required: true\n type: string\n responses:\n 200:\n description: Returns list of destination countries and currencies.\n schema:\n type: array\n items:\n $ref: \"#/definitions/DestinationCountry\"\n\n /v1/remittances/deliveryservices:\n get:\n tags:\n - Remittance - Western Union\n summary: Get delivery services\n description: This API is used to get possible delivery services between given countries and currencies.\n operationId: getDeliveryServices\n parameters:\n - name: originationCurrency\n description: Origination currency.\n in: query\n required: true\n type: string\n - name: destinationCountry\n description: Destination country.\n in: query\n required: true\n type: string\n - name: destinationCurrency\n description: Destination currency.\n in: query\n required: true\n type: string\n responses:\n 200:\n description: Returns list of possible delivery services between given countries and currencies.\n schema:\n type: array\n items:\n $ref: \"#/definitions/DeliveryService\"\n\n /v1/remittances/deliveryoptiontemplate:\n get:\n tags:\n - Remittance - Western Union\n summary: Get delivery option template\n description: This API is used to get possible delivery option template for destination country and currency.\n operationId: getDeliveryOptionTemplate\n parameters:\n - name: destinationCountry\n description: Destination country.\n in: query\n required: true\n type: string\n - name: destinationCurrency\n description: Destination currency.\n in: query\n required: true\n type: string\n - name: templateId\n description: Delivery service template ID.\n in: query\n required: true\n type: string\n responses:\n 200:\n description: Returns the list of possible delivery option templates for destination country and currency.\n schema:\n type: array\n items:\n $ref: \"#/definitions/DeliveryOptionTemplate\"\n\n /v1/remittances/getcascadelist:\n get:\n tags:\n - Remittance - Western Union\n summary: Get cascade list values\n description: This API is used to get cascade list values.\n operationId: getCascadeList\n parameters:\n - name: cmbCode\n description: CMB code for selected country.\n in: query\n required: true\n type: string\n - name: firstLevelValue\n description: Value from 'Get combo first level' API response. You can find more info in this document https://docs.nymcard.com/get-started/funding-and-transfers/western-union-apis#get-cascade-list-values-api.\n in: query\n required: false\n type: string\n - name: secondLevelValue\n description: Value from 'Get combo second level' API response. You can find more info in this document https://docs.nymcard.com/get-started/funding-and-transfers/western-union-apis#get-cascade-list-values-api.\n in: query\n required: false\n type: string\n responses:\n 200:\n description: Returns list of cascade values.\n schema:\n type: array\n items:\n $ref: \"#/definitions/CascadeNode\"\n\n /v1/remittances/getreversalreasons:\n get:\n tags:\n - Remittance - Western Union\n summary: Get reversal reasons\n description: This API is used to get list of reversal reasons.\n operationId: getReversalReasons\n parameters:\n - name: reversalType\n description: The type of reversal.\n in: query\n required: true\n schema:\n $ref: \"#/definitions/ReversalType\"\n responses:\n 200:\n description: Returns list of reversal reasons.\n schema:\n type: array\n items:\n $ref: \"#/definitions/ReversalReason\"\n\n /v1/remittances/getstates:\n get:\n tags:\n - Remittance - Western Union\n summary: Get list of states\n description: This API is used to get list of states.\n operationId: getStates\n parameters:\n - name: countryCode\n description: The country code.\n in: query\n required: true\n schema:\n $ref: \"#/definitions/CountryCode\"\n responses:\n 200:\n description: Returns list of states.\n schema:\n type: array\n items:\n $ref: \"#/definitions/StateInfo\"\n\n /v1/remittances/feeinquire:\n post:\n tags:\n - Remittance - Western Union\n summary: Create fee inquiry\n description: This API is used to create a fee inquiry.\n operationId: getFeeInquire\n parameters:\n - name: feeInquireRequest\n description: Fee inquiry request.\n in: body\n required: true\n schema:\n $ref: \"#/definitions/FeeInquireRequest\"\n responses:\n 200:\n description: Returns fee inquiry.\n schema:\n $ref: \"#/definitions/FeeInquireResponse\"\n\n /v1/remittances/refundtransaction:\n post:\n tags:\n - Remittance - Western Union\n summary: Refund transaction\n description: This API is used to refund transaction.\n operationId: refundTransaction\n parameters:\n - name: refundTransactionRequest\n description: Refund transaction request.\n in: body\n required: true\n schema:\n $ref: \"#/definitions/RefundTransactionRequest\"\n responses:\n 200:\n description: Refund transaction after it was processed.\n schema:\n $ref: \"#/definitions/RefundTransactionResponse\"\n\n /v1/remittances/sendmoneyvalidate:\n post:\n tags:\n - Remittance - Western Union\n summary: Send money validation request to Western Union\n description: This API is used to send money validation request to Western Union.\n operationId: sendMoneyValidate\n parameters:\n - name: sendMoneyValidateRequest\n in: body\n description: Send money validation request.\n required: true\n schema:\n $ref: \"#/definitions/SendMoneyValidateRequest\"\n responses:\n 200:\n description: Returns response of send money validation request.\n schema:\n $ref: \"#/definitions/SendMoneyValidateResponse\"\n\n /v1/remittances/sendmoneystore:{transactionAction}:\n post:\n tags:\n - Remittance - Western Union\n summary: Send money store request to Western Union\n description: This API is used to send money store request to Western Union.\n operationId: sendMoneyStore\n parameters:\n - name: sendMoneyStoreRequest\n in: body\n description: Send money store request.\n required: true\n schema:\n $ref: \"#/definitions/SendMoneyStoreRequest\"\n - name: transactionAction\n description: Transaction action.\n in: path\n required: true\n schema:\n $ref: \"#/definitions/TransactionAction\"\n\n responses:\n 200:\n description: Returns response of send money store request.\n schema:\n $ref: \"#/definitions/SendMoneyStoreResponse\"\n\n /v1/remittances/canceltransaction:\n post:\n tags:\n - Remittance - Western Union\n summary: Send cancel transaction request to Western Union\n description: This API is used to send cancel transaction request to Western Union.\n operationId: cancelTransaction\n parameters:\n - name: cancelTransactionRequest\n in: body\n description: Cancel transaction request.\n required: true\n schema:\n $ref: \"#/definitions/CancelTransactionRequest\"\n responses:\n 200:\n description: Returns response of cancel transaction.\n schema:\n $ref: \"#/definitions/CancelTransactionResponse\"\n\n /v1/remittances/generateotp:\n post:\n tags:\n - Remittance - Western Union\n summary: Generate OTP and send it to customer\n description: This API is used to generate OTP and send it to customer.\n operationId: generateOtp\n parameters:\n - name: generateOtpRequest\n in: body\n description: Generate OTP request.\n required: true\n schema:\n $ref: \"#/definitions/GenerateOtpRequest\"\n responses:\n 200:\n description: Returns unique identifier of the OTP verification.\n schema:\n $ref: \"#/definitions/GenerateOtpResponse\"\n\n\ndefinitions:\n\n NymcardTransactionCallback:\n type: object\n properties:\n id:\n type: string\n description: The unique identifier of the transaction.\n example: \"LoadTransaction01\"\n transaction_timestamp:\n type: string\n format: date-time\n example: \"2021-12-16T14:04:24.593Z\"\n description: The date and time when transaction was performed.\n parent_transaction_id:\n type: string\n description: The unique identifier of the parent transaction.\n example: \"5efss08-0558-47ac-b722-4e45r176fb4f\"\n network:\n type: object\n $ref: \"#/definitions/Network\"\n message_type:\n type: object\n $ref: \"#/definitions/MessageType\"\n transaction_type:\n type: object\n $ref: \"#/definitions/TransactionExtendedType\"\n transaction_description:\n type: string\n description: Additional description of the transaction if required.\n example: \"Wallet Credit\"\n transmission_date_time:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time of the transaction when it is submitted to the network by the acquirer.\n date_time_acquirer:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date of the transaction at the acquirer end when this transaction was performed.\n card_id:\n type: string\n description: The unique identifier of the card.\n example: \"45678912314567891231456789123121\"\n card_first_6_digits:\n type: string\n pattern: '^[0-9]{6}$'\n description: The first six digits of the card.\n example: \"494964\"\n card_last_4_digits:\n type: string\n pattern: '^[0-9]{4}$'\n description: The last four digits of the card.\n example: \"6404\"\n card_expiry_date:\n type: string\n pattern: '^(0[1-9]|1[0-2])\\/?([0-9]{4}|[0-9]{2})$'\n description: Expiry date of the card.\n example: \"052022\"\n user_id:\n type: string\n description: The unique identifier of the user related to this transaction.\n example: \"5c0afa53-6ec0-4b08-a180-199352385c9b\"\n account_id1:\n type: string\n description: The unique identifier of the first account which is involved in the transaction.\n example: \"5c0sds53-6ec0-4b08-a180-199352385c9b\"\n card_product_1:\n type: string\n description: Name of the card product related to Account ID 1.\n example: \"dfgafa53-6ec0-4b08-a180-199352385c9b\"\n account_id2:\n type: string\n description: The unique identifier of the second account which is involved in the transaction.\n example: \"thfafa53-6ec0-4b08-a180-199352385c9b\"\n card_product_2:\n type: string\n description: Name of the card product related to Account ID 2.\n example: \"8uhafa53-6ec0-4b08-a180-199352385c9b\"\n acquirer_id:\n type: string\n description: The unique identifier of the acquiring institution.\n example: \"12345678901\"\n merchant_id:\n type: string\n description: The unique identifier of the merchant.\n example: \"CARD ACCEPTOR\"\n mcc:\n type: string\n pattern: '^[0-9]{4}$'\n description: The merchant category code.\n example: \"5947\"\n merchant_name:\n type: string\n description: The merchant name.\n example: \"ACQUIRER NAME\"\n merchant_city:\n type: string\n description: The merchant city.\n example: \"CITY NAME\"\n merchant_country:\n type: string\n description: The merchant country in 3 digit ISO Alpha country code format.\n example: \"USA\"\n terminal_id:\n type: string\n description: The unique identifier of the merchant's terminal.\n example: \"TERMID01\"\n stan:\n type: string\n description: The system trace audit number of the transaction.\n example: \"000042\"\n rrn:\n type: string\n description: The retrieval reference number of the transaction.\n example: \"13501404242y\"\n auth_id_response:\n type: string\n description: The Auth ID response of the transaction.\n example: \"476628\"\n network_transaction_id:\n type: string\n description: The unique transaction ID filled by the Network/Scheme.\n example: \"234551234561008\"\n transaction_amount:\n type: number\n description: The amount of the transaction at the merchant side.\n format: decimal\n example: 500.00\n transaction_currency:\n type: string\n description: The currency of the transaction at the merchant side.\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n billing_amount:\n type: number\n format: decimal\n description: The amount of the transaction billed by the network to the issuer.\n example: 4.00\n billing_currency:\n type: string\n format: iso-4217\n example: \"USD\"\n description: The currency in which the network billed the transaction to the issuer.\n pattern: \"^[A-Z]{3}$\"\n billing_amount_account:\n type: number\n format: decimal\n description: The account amount of the transaction billed by the network to the issuer.\n example: 4.00\n billing_currency_account:\n type: string\n format: iso-4217\n description: The account currency in which the network billed the transaction to the issuer.\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n conversion_rate_billing_account:\n type: number\n format: decimal\n example: 4.00\n description: The account conversion rate used by the network/scheme in converting the 'account transaction amount' to 'account billing amount'.\n acquirer_fee_amount:\n type: number\n format: decimal\n example: 2.00\n description: The transaction fee amount charged by the merchant, it is represented in 'transaction currency'.\n conversion_rate_billing:\n type: string\n example: \"61000000\"\n description: The conversion rate used by the network/scheme in converting the 'transaction amount' to 'billing amount'.\n fee_amount:\n type: number\n example: 2.00\n description: The transaction fee amount charged by the issuer. In case of partial reversal this parameter contains the new fee amount charged by the issuer.\n format: decimal\n fee_details:\n type: array\n description: The list of fees applied to transaction by the issuer.\n items:\n $ref: \"#/definitions/TransactionFeeDetail\"\n original_amount:\n type: number\n example: 2.00\n description: In case of partial reversal this parameter contains the new amount charged by the merchant, it is represented in 'transaction currency'.\n format: decimal\n original_amount_billing:\n type: string\n example: \"4\"\n description: In case of partial reversal this parameter contains the new amount charged by the merchant in 'billing currency'.\n status_code:\n type: string\n example: \"0000\"\n description: The internal response code providing the status of this transaction. The full list of status codes you can find in the GSG guide using the following link https://docs.nymcard.com/get-started/transactions/transaction-endpoints-scenarios#transaction-status-codes .\n status_description:\n type: string\n example: \"Transaction approved\"\n description: >\n The textual description of the internal response code. The full list of status codes you can find in the GSG guide using the following link https://docs.nymcard.com/get-started/transactions/transaction-endpoints-scenarios#transaction-status-codes .\n sender_user_id:\n type: string\n description: The unique ID of the sender user. It is applicable only for 'WALLET_TRANSFER' transactions.\n example: \"hkuser282\"\n transfer_id:\n type: string\n example: \"234551234561008\"\n description: The unique ID of the transfer, filled only in case if transaction type is a transfer.\n load_id:\n type: string\n example: \"LoadTransaction01\"\n description: The unique ID of the load, filled only in case if transaction type is a load.\n unload_id:\n type: string\n example: \"234551234561008\"\n description: The unique ID of the unload, filled only in case if transaction type is an unload.\n eci:\n type: string\n example: \"05\"\n description: The e-commerce indicator of the transaction.\n ecommerce_security_level:\n type: string\n example: \"3DS1\"\n description: The e-commerce security level. Possible values are non-secure, 3DS1, 3DS2, 3DS2.2.\n card_entry:\n type: string\n example: \"Physical entry\"\n description: This parameter indicates how the card was acquired on the merchant side. Possible values are UNKNOWN, MANUAL_ENTRY, MAGNETIC_STRIPE, ICC, CARD_ON_FILE.\n pos_environment:\n type: string\n example: \"E-Commerce\"\n description: This parameter gives an info on the type of POS used. Possible values are UNKNOWN (in case merchant is not sending additional information), ATTENDED_POS (POS terminal where a person/cashier is involved), ECOMMERCE (purchase made in the internet).\n fallback:\n type: boolean\n example: false\n description: The fallback transaction, possible values are true/false.\n pin_present:\n type: boolean\n example: false\n description: The PIN present in transaction, possible values are true/false.\n moto:\n type: boolean\n example: false\n description: MOTO transaction, possible values are true/false.\n recurring:\n type: boolean\n example: false\n description: The recurring transaction, possible values are true/false.\n installment_transaction:\n type: boolean\n example: false\n description: The installment transaction, possible values are true/false.\n auth_expired_at:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The auth expired date of the transaction.\n auth_expired_by:\n type: string\n example: \"AUTO\"\n $ref: \"#/definitions/AuthExpiredType\"\n is_reversed:\n type: string\n example: \"YES\"\n $ref: \"#/definitions/ConfirmationType\"\n is_settled:\n type: string\n example: \"NO\"\n $ref: \"#/definitions/ConfirmationType\"\n source_channel:\n type: string\n example: \"DAPI\"\n $ref: \"#/definitions/TransferSourceChannel\"\n notes:\n type: string\n example: \"Performing operation for 12.50 USD\"\n description: Notes about performed transaction.\n reference_number:\n type: string\n example: \"04a466da-cbab-11ed-afa1-0242ac120002\"\n description: The reference number of the transaction.\n sweep_details:\n type: array\n description: An array of sweeping details. Sweeping is performed upon insufficient funds - they are pulled from the other wallets and are credited to the wallet on which transaction is received.\n items:\n $ref: \"#/definitions/SweepDetails\"\n type:\n $ref: \"#/definitions/LoadTransactionType\"\n quote_id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of FX rate quote.\n receiver_user_id:\n type: string\n description: The unique identifier of receiver user.\n example: \"g157a80f-e641-7745-8a80-99841e4a1234\"\n\n LoadTransactionType:\n type: string\n description: Load transaction type.\n example: \"HOLD\"\n enum:\n - \"HOLD\"\n - \"POST\"\n - \"RELEASE\"\n\n SweepDetails:\n type: object\n description: An array of sweeping details. Sweeping is performed upon insufficient funds - they are pulled from the other wallets and are credited to the wallet on which transaction is received.\n properties:\n debit_from_currency:\n type: string\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: A currency of wallet from which funds are pulled.\n debit_from_amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount pulled from the wallet.\n credit_to_currency:\n type: string\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: A currency of wallet on which funds are credited.\n credit_to_amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount credited to the wallet.\n exchange_rate:\n type: number\n format: decimal\n example: \"100.01\"\n description: An exchange rate used to convert the 'debit_from_amount' into 'credit_to_amount'.\n\n SimulateTransactionSweepDetails:\n type: object\n description: An array of sweeping details. Sweeping is performed upon insufficient funds - they are pulled from the other wallets and are credited to the wallet on which transaction is received.\n properties:\n debit_from_currency:\n type: string\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: A currency of wallet from which funds are pulled.\n debit_from_amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount pulled from the wallet.\n credit_to_currency:\n type: string\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: A currency of wallet on which funds are credited.\n credit_to_amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount credited to the wallet.\n exchange_rate:\n type: number\n format: decimal\n example: \"100.01\"\n description: An exchange rate used to convert the 'debit_from_amount' into 'credit_to_amount'.\n\n AuthExpiredType:\n type: string\n description: The auth expired type of the transaction, can be either MANUAL or AUTO.\n enum:\n - \"AUTO\"\n - \"MANUAL\"\n example: \"AUTO\"\n\n ConfirmationType:\n type: string\n description: The confirmation type value.\n enum:\n - \"YES\"\n - \"NO\"\n example: \"YES\"\n\n TransferSourceChannel:\n type: string\n description: Source channel.\n enum:\n - \"API\"\n - \"DAPI\"\n - \"MPGS\"\n - \"LEAN\"\n example: \"DAPI\"\n\n Network:\n type: string\n description: The network scheme.\n enum:\n - \"VISA\"\n example: \"VISA\"\n\n MessageType:\n type: string\n description: The type of the message.\n example: \"API\"\n enum:\n - \"AUTHORIZATION\"\n - \"AUTHORIZATION_ADVICE\"\n - \"REVERSAL\"\n - \"FINANCIAL\"\n - \"FINANCIAL_ADVICE\"\n - \"REVERSAL_ADVICE\"\n - \"CLEARING\"\n - \"CLEARING_REVERSAL\"\n - \"API\"\n\n TransactionFeeDetail:\n type: object\n properties:\n fee_id:\n type: string\n example: \"ed2e2ddb-c028-470d-b08b-7f28bd84fbfe\"\n description: The unique identifier of the fee.\n description:\n type: string\n example: \"Some description\"\n description: The description of the applied fee.\n amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount of the applied fee.\n x-nymos-currency: currency\n currency:\n type: string\n format: iso-4217\n example: \"USD\"\n description: The currency of the applied fee.\n pattern: \"^[A-Z]{3}$\"\n\n TransactionExtendedType:\n type: string\n description: The type of transaction.\n\n * `PURCHASE` Any kind of card purchase, which can be identified in more detail via the 'pos_environment' field.\n\n * `CASH_WITHDRAWAL` Cardholder performed the withdrawal of cash at the ATM.\n\n * `REFUND` A credit note on the card which can happen in case the customer bought something and gave it back, for example.\n\n * `BALANCE_INQUIRY` Checking the account balance on the ATM.\n\n * `ACCOUNT_VERIFICATION` Adding the card on a payment gateway portal. Gateway will generate a transaction just to verify that the account is valid (0 amount trx).\n\n * `WALLET_DEBIT` Unloads related transaction.\n\n * `WALLET_CREDIT` Loads related transaction.\n\n * `WALLET_TRANSFER` Account to account transfer.\n\n * `QUASI_CASH` Quasi cash transaction.\n\n * `OCT` Original Credit Transaction.\n\n * `AFT` Account Funding Transaction.\n\n example: \"WALLET_CREDIT\"\n enum:\n - \"PURCHASE\"\n - \"CASH_WITHDRAWAL\"\n - \"REFUND\"\n - \"BALANCE_INQUIRY\"\n - \"ACCOUNT_VERIFICATION\"\n - \"WALLET_DEBIT\"\n - \"WALLET_CREDIT\"\n - \"WALLET_TRANSFER\"\n - \"QUASI_CASH\"\n - \"OCT\"\n - \"AFT\"\n\n\n NymcardTransactionIndex:\n type: object\n properties:\n id:\n type: string\n description: The unique identifier of the transaction.\n example: \"5efbb708-0558-47ac-b722-4e30b176fb4f\"\n transaction_timestamp:\n type: string\n description: The date and time when transaction was performed.\n example: \"2021-06-17T13:56:48.000Z\"\n parent_transaction_id:\n type: string\n description: The unique identifier of the parent transaction.\n example: \"5efss708-0458-47ac-b722-4e30b1744b4f\"\n network:\n type: string\n description: The network scheme.\n example: \"VISA\"\n message_type:\n type: string\n description: The type of the message.\n example: \"AUTHORIZATION\"\n transaction_type:\n type: string\n description: The type of the transaction.\n example: \"PURCHASE\"\n transaction_description:\n type: string\n description: Additional description of the transaction if required.\n example: \"Purchase\"\n transmission_date_time:\n type: string\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time of the transaction when it is submitted to the network by the acquirer.\n date_time_acquirer:\n type: string\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date of the transaction at the acquirer end when this transaction was performed.\n card_id:\n type: string\n description: The unique identifier of the card.\n example: \"45678912314567891231456789123121\"\n card_first_6_digits:\n type: string\n description: The first six digits of the card.\n example: \"494964\"\n card_last_4_digits:\n type: string\n description: The last four digits of the card.\n example: \"6404\"\n card_expiry_date:\n type: string\n description: Expiry date of the card.\n example: \"052022\"\n user_id:\n type: string\n description: The unique identifier of the user related to this transaction.\n example: \"5c0afa53-6ec0-4b08-a180-199352385c9b\"\n account_id1:\n type: string\n example: \"5c0sds53-6ec0-4b08-a180-199352385c9b\"\n description: The unique identifier of the first account which is involved in the transaction.\n card_product_1:\n type: string\n example: \"dfgafa53-6ec0-4b08-a180-199352385c9b\"\n description: Name of the card product related to Account ID 1.\n account_id2:\n type: string\n example: \"thfafa53-6ec0-4b08-a180-199352385c9b\"\n description: The unique identifier of the second account which is involved in the transaction.\n card_product_2:\n type: string\n example: \"8uhafa53-6ec0-4b08-a180-199352385c9b\"\n description: Name of the card product related to Account ID 2.\n acquirer_id:\n type: string\n example: \"12345678901\"\n description: The unique identifier of the acquiring institution.\n merchant_id:\n type: string\n description: The unique identifier of the merchant.\n example: \"CARD ACCEPTOR\"\n mcc:\n type: string\n example: \"5947\"\n description: The merchant category code.\n merchant_name:\n type: string\n description: The merchant name.\n example: \"ACQUIRER NAME\"\n merchant_city:\n type: string\n description: The merchant city.\n example: \"CITY NAME\"\n merchant_country:\n type: string\n description: The merchant country in 3 digit ISO Alpha country code format.\n example: \"USA\"\n terminal_id:\n type: string\n example: \"TERMID01\"\n description: The unique identifier of the merchant's terminal.\n stan:\n type: string\n example: \"000042\"\n description: The system trace audit number of the transaction.\n rrn:\n type: string\n example: \"116813000042\"\n description: The retrieval reference number of the transaction.\n auth_id_response:\n type: string\n example: \"476628\"\n description: The Auth ID response of the transaction.\n network_transaction_id:\n type: string\n example: \"234551234561008\"\n description: The unique transaction ID filled by the Network/Scheme.\n transaction_amount:\n type: number\n example: 4.00\n description: The amount of the transaction at the merchant side.\n transaction_currency:\n type: string\n example: \"USD\"\n description: The currency of the transaction at the merchant side.\n billing_amount:\n type: number\n example: 4.00\n description: The amount of the transaction billed by the network to the issuer.\n billing_currency:\n type: string\n example: \"USD\"\n description: The currency in which the network billed the transaction to the issuer.\n billing_amount_account:\n type: number\n description: The account amount of the transaction billed by the network to the issuer.\n example: 4.00\n billing_currency_account:\n type: string\n description: The account currency in which the network billed the transaction to the issuer.\n example: \"USD\"\n conversion_rate_billing_account:\n type: number\n format: decimal\n example: 4.00\n description: The account conversion rate used by the network/scheme in converting the 'account transaction amount' to 'account billing amount'.\n acquirer_fee_amount:\n type: number\n example: 2.00\n description: The transaction fee amount charged by the merchant, it is represented in 'transaction currency'.\n conversion_rate_billing:\n type: string\n example: \"61000000\"\n description: The conversion rate used by the network/scheme in converting the 'transaction amount' to 'billing amount'.\n fee_amount:\n type: number\n example: 2.00\n description: The transaction fee amount charged by the issuer. In case of partial reversal this parameter contains the new fee amount charged by the issuer.\n fee_details:\n type: array\n description: The list of fees applied to transaction by the issuer.\n items:\n $ref: \"#/definitions/NymcardTransactionFeeDetail\"\n original_amount:\n type: number\n example: 2.00\n description: In case of partial reversal this parameter contains the new amount charged by the merchant, it is represented in 'transaction currency'.\n original_amount_billing:\n type: string\n example: \"4\"\n description: In case of partial reversal this parameter contains the new amount charged by the merchant in 'billing currency'.\n status_code:\n type: string\n example: \"0000\"\n description: The internal response code providing the status of this transaction.\n status_description:\n type: string\n example: \"Transaction approved\"\n description: The textual description of the internal response code.\n transfer_id:\n type: string\n example: \"234551234561008\"\n description: The unique ID of the transfer, filled only in case if transaction type is a transfer.\n load_id:\n type: string\n example: \"234556734561008\"\n description: The unique ID of the load, filled only in case if transaction type is a load.\n unload_id:\n type: string\n example: \"234551234561008\"\n description: The unique ID of the unload, filled only in case if transaction type is an unload.\n eci:\n type: string\n example: \"05\"\n description: The e-commerce indicator of the transaction.\n ecommerce_security_level:\n type: string\n example: \"3DS1\"\n description: The e-commerce security level. Possible values are non-secure, 3DS1, 3DS2, 3DS2.2.\n card_entry:\n type: string\n example: \"Physical entry\"\n description: This parameter indicates how the card was acquired on the merchant side. Possible values are UNKNOWN, MANUAL_ENTRY, MAGNETIC_STRIPE, ICC, CARD_ON_FILE.\n pos_environment:\n type: string\n example: \"E-Commerce\"\n description: This parameter gives an info on the type of POS used. Possible values are UNKNOWN (in case merchant is not sending additional information), ATTENDED_POS (POS terminal where a person/cashier is involved), ECOMMERCE (purchase made in the internet).\n fallback:\n type: boolean\n example: false\n description: The fallback transaction, possible values are true/false.\n pin_present:\n type: boolean\n example: false\n description: The PIN present in transaction, possible values are true/false.\n moto:\n type: boolean\n example: false\n description: MOTO transaction, possible values are true/false.\n recurring:\n type: boolean\n example: false\n description: The recurring transaction, possible values are true/false.\n installment_transaction:\n type: boolean\n example: false\n description: The installment transaction, possible values are true/false.\n auth_expired_at:\n type: string\n example: \"2018-01-02T19:42:32.987Z\"\n description: The auth expired date of the transaction.\n auth_expired_by:\n type: string\n example: \"AUTO\"\n description: The auth expired type of the transaction, can be either MANUAL or AUTO.\n is_reversed:\n type: string\n example: \"YES\"\n description: The confirmation type value got based on the reversal_count field information.\n is_settled:\n type: string\n example: \"NO\"\n description: The confirmation type value got based on the clearing_count field information.\n source_channel:\n type: string\n example: \"DAPI\"\n description: Type of source channel.\n notes:\n type: string\n example: \"Performing operation for 12.50 USD\"\n description: Notes about performed transfer request.\n sender_user_id:\n type: string\n description: The unique ID of the sender user. It is applicable only for 'WALLET_TRANSFER' transactions.\n example: \"hkuser282\"\n reference_number:\n type: string\n example: \"04a466da-cbab-11ed-afa1-0242ac120002\"\n description: The reference number of the transaction.\n sweep_details:\n type: array\n description: An array of sweeping details. Sweeping is performed upon insufficient funds - they are pulled from the other wallets and are credited to the wallet on which transaction is received.\n items:\n $ref: \"#/definitions/NymcardTransactionSweepDetails\"\n type:\n type: string\n description: Load transaction type.\n example: \"HOLD\"\n quote_id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of FX rate quote.\n receiver_user_id:\n type: string\n description: The unique identifier of receiver user.\n example: \"g157a80f-e641-7745-8a80-99841e4a1234\"\n x-nymos-document-field-type: ATOM\n\n NymcardTransactionFeeDetail:\n type: object\n properties:\n fee_id:\n type: string\n example: \"ed2e2ddb-c028-470d-b08b-7f28bd84fbfe\"\n description: The unique identifier of the fee.\n description:\n type: string\n example: \"Some description\"\n description: The description of the applied fee.\n amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount of the applied fee.\n x-nymos-currency: currency\n currency:\n type: string\n format: iso-4217\n example: \"USD\"\n description: The currency of the applied fee.\n pattern: \"^[A-Z]{3}$\"\n\n NymcardTransactionSweepDetails:\n type: object\n description: An array of sweeping details. Sweeping is performed upon insufficient funds - they are pulled from the other wallets and are credited to the wallet on which transaction is received.\n properties:\n debit_from_currency:\n type: string\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: A currency of wallet from which funds are pulled.\n debit_from_amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount pulled from the wallet.\n credit_to_currency:\n type: string\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: A currency of wallet on which funds are credited.\n credit_to_amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount credited to the wallet.\n exchange_rate:\n type: number\n format: decimal\n example: \"100.01\"\n description: An exchange rate used to convert the 'debit_from_amount' into 'credit_to_amount'.\n\n NymcardTransactionIndexCollection:\n allOf:\n - $ref: '#/definitions/Pageable'\n - type: object\n properties:\n data:\n type: array\n items:\n $ref: \"#/definitions/NymcardTransactionIndex\"\n\n Fee:\n type: object\n properties:\n id:\n type: string\n description: Fee ID.\n maxLength: 36\n example: 4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\n description:\n type: string\n description: Fee description.\n example: \"Withdrawal Fee\"\n maxLength: 50\n active:\n type: boolean\n description: Fee status.\n example: true\n type:\n $ref: \"#/definitions/FeeType\"\n description: Fee type, either it is fixed value or percentage.\n example: percentage\n currency:\n type: string\n description: Currency code or ***. Value *** is only applicable for transaction types 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.\n example: \"USD\"\n pattern: \"^([\\\\*]{3}|[A-Z]{3})$\"\n amount:\n type: number\n description: Fee amount. It is applicable if fee type includes flat option.\n example: 2\n minimum: 0\n percentage:\n type: number\n description: Fee percentage. It is applicable if fee type includes percentage option.\n example: 5\n minimum: 0\n maximum: 100\n range:\n type: array\n description: Array of ranges where fee is applicable.\n items:\n $ref: \"#/definitions/Range\"\n transaction_type:\n description: Type of transaction.\n example: \"WITHDRAWALS\"\n $ref: \"#/definitions/TransactionType\"\n transaction_origin:\n description: Origin of transaction. This field is applicable for transaction types 'WITHDRAWALS', 'PURCHASES', 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.\n example: ANY\n $ref: \"#/definitions/TransactionOrigin\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2018-01-02T19:42:32.987Z\"\n source_channel:\n description: Type of source channel only applicable for transaction_type = TRANSFERS. Default value is \"ANY\".\n example: MPGS\n $ref: \"#/definitions/SourceChannel\"\n\n FeeCreateRequest:\n type: object\n required:\n - description\n - type\n - currency\n - transaction_type\n properties:\n id:\n type: string\n description: The unique identifier of the fee. If this information is not present in the request, the system generates one automatically.\n maxLength: 36\n example: 4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\n description:\n type: string\n description: The name of the fee. We recommend using a unique string.\n example: \"Withdrawal Fee\"\n maxLength: 50\n type:\n description: Fee type, either it is fixed value or percentage.\n example: percentage\n $ref: \"#/definitions/FeeType\"\n currency:\n description: Currency code or ***. Value *** is only applicable for transaction types 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.\n example: \"USD\"\n type: string\n pattern: \"^([\\\\*]{3}|[A-Z]{3})$\"\n amount:\n description: Fee amount. It is applicable if fee type includes flat option.\n example: 2\n type: number\n minimum: 0\n percentage:\n type: number\n description: Fee percentage. It is applicable if fee type includes percentage option.\n example: 5\n minimum: 0\n maximum: 100\n range:\n type: array\n description: Array of ranges where fee is applicable.\n items:\n $ref: \"#/definitions/Range\"\n transaction_type:\n description: Type of transaction.\n example: \"WITHDRAWALS\"\n $ref: \"#/definitions/TransactionType\"\n transaction_origin:\n description: Origin of transaction. This field is applicable for transaction types 'WITHDRAWALS', 'PURCHASES', 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.\n example: ANY\n $ref: \"#/definitions/TransactionOrigin\"\n source_channel:\n description: Type of source channel only applicable for transaction_type = TRANSFERS. Default value is \"ANY\".\n example: MPGS\n default: ANY\n $ref: \"#/definitions/SourceChannel\"\n\n FeeUpdateRequest:\n type: object\n properties:\n description:\n type: string\n description: Fee description.\n example: \"Withdrawal Fee\"\n maxLength: 50\n active:\n type: boolean\n description: Fee status.\n example: true\n type:\n description: Fee type, either it is fixed value or percentage.\n example: percentage\n $ref: \"#/definitions/FeeType\"\n currency:\n description: Currency code or ***. Value *** is only applicable for transaction types 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.\n example: \"USD\"\n type: string\n pattern: \"^([\\\\*]{3}|[A-Z]{3})$\"\n amount:\n description: Fee amount. It is applicable if fee type includes flat option.\n example: 2\n type: number\n minimum: 0\n percentage:\n type: number\n description: Fee percentage. It is applicable if fee type includes percentage option.\n example: 5\n minimum: 0\n maximum: 100\n range:\n type: array\n description: Array of ranges where fee is applicable.\n items:\n $ref: \"#/definitions/Range\"\n transaction_type:\n description: Type of transaction.\n example: \"WITHDRAWALS\"\n $ref: \"#/definitions/TransactionType\"\n transaction_origin:\n description: Origin of transaction. This field is applicable for transaction types 'WITHDRAWALS', 'PURCHASES', 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.\n example: ANY\n $ref: \"#/definitions/TransactionOrigin\"\n source_channel:\n description: Type of source channel only applicable for transaction_type = TRANSFERS. Default value is \"ANY\".\n example: MPGS\n $ref: \"#/definitions/SourceChannel\"\n\n Range:\n type: object\n properties:\n greater_than:\n type: number\n description: The 'greater than' range where fee is applicable.\n minimum: 0\n less_than_equal_to:\n type: number\n description: The 'less than equal to' range where fee is applicable.\n minimum: 0\n amount:\n type: number\n description: The 'amount' range where fee is applicable.\n minimum: 0\n percentage:\n type: number\n description: The 'percentage' range where fee is applicable.\n minimum: 0\n maximum: 100\n\n FeesCollection:\n type: object\n properties:\n has_more:\n type: boolean\n description: This parameter indicates whether there are more data to load\n after:\n type: string\n description: Durable version of current results that can be used on the next sync.\n example: \"MjAxOC0wMS0wMlQxOTo0MjozMi45ODda\"\n data:\n type: array\n description: An array of fees.\n items:\n $ref: \"#/definitions/Fee\"\n\n\n TransactionType:\n type: string\n description: The type of transaction. 'PURCHASE_FOREIGN_CURRENCY' is only applicable to 'PURCHASES' in foreign currencies. 'WITHDRAWAL_FOREIGN_CURRENCY' is only applicable to 'WITHDRAWALS' in foreign currencies.\n enum:\n - WITHDRAWALS\n - PURCHASES\n - BALANCE_INQUIRIES\n - TRANSFERS\n - LOADS\n - UNLOADS\n - PURCHASE_FOREIGN_CURRENCY\n - WITHDRAWAL_FOREIGN_CURRENCY\n\n TransactionOrigin:\n type: string\n description: Origin of transaction. This field is applicable for transaction types 'WITHDRAWALS', 'PURCHASES', 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.\n enum:\n - DOMESTIC\n - FOREIGN\n - ANY\n\n FeeType:\n type: string\n description: >\n Fee types:\n * `FLAT`: A flat fee refers to a fixed amount a cardholder pays for performing a transaction regardless of a transaction amount.In case of single currency products, the currency of the flat fee is the one supported by the card product.\n * `PERCENTAGE`: A percentage fee applied on the transaction amount a cardholder pays for performing a transaction. The fee is calculated by applying the percentage to ISO field 6 billing amount coming in authorization from the payment scheme.\n * `MAX_PERC_OR_FLAT`: A maximum fee selects between an applied percentage fee and flat fee a cardholder pays for performing a transaction.\n * `MIN_PERC_OR_FLAT`: A minimum fee selects between an applied percentage fee and flat fee a cardholder pays for performing a transaction.\n * `MAX_PERC_OR_FLAT_W_CAP`: A maximum fee selects between an applied percentage fee and a flat fee. Note that the configured maximum cap limit fee will be applied if the selected fee is greater than the configured cap limit fee.\n * `MIN_PERC_OR_FLAT_W_CAP`: A minimum fee selects between an applied percentage fee and a flat fee. Note that the configured miminum cap limiy fee will be applied if the selected fee is lesser than the configured cap limit fee.\n * `RANGE`: Transaction amount based fee slabs where each slab has a configured flat fee or a percentage fee.\n * `RANGE_FLAT`: Transaction amount based fee slabs where each slab has a configured flat fee.\n * `RANGE_PERCENTAGE`: Transaction amount based fee slabs where each slab has a configured percentage fee.\n * `RANGE_MAX_PERC_OR_FLAT`: Transaction amount based fee slabs where each slab has a flat fee and a percentage fee configured and the the maximum fee between the two is applied.\n * `RANGE_MIN_PERC_OR_FLAT`: Transaction amount based fee slabs where each slab has a flat fee and a percentage fee configured and the the minimum fee between the two is applied.\n * `RANGE_MAX_PERC_OR_FLAT_W_CAP`: A maximum fee selects between an applied percentage fee and a flat fee based on transaction amount range. Note that the configured maximum cap limit fee will be applied if the selected fee is greater than the configured cap limit fee.\n * `RANGE_MIN_PERC_OR_FLAT_W_CAP`: A minimum fee selects between an applied percentage fee and a flat fee based on transaction amount range. Note that the configured minimum cap limit fee will be applied if the selected fee is lesser than the configured cap limit fee.\n enum:\n - FLAT\n - PERCENTAGE\n - MAX_PERC_OR_FLAT\n - MIN_PERC_OR_FLAT\n - MAX_PERC_OR_FLAT_W_CAP\n - MIN_PERC_OR_FLAT_W_CAP\n - RANGE\n - RANGE_FLAT\n - RANGE_PERCENTAGE\n - RANGE_MAX_PERC_OR_FLAT\n - RANGE_MIN_PERC_OR_FLAT\n - RANGE_MAX_PERC_OR_FLAT_W_CAP\n - RANGE_MIN_PERC_OR_FLAT_W_CAP\n\n\n\n AdvancedFee:\n type: object\n x-nymos-entity: fees_advanced_fees\n required:\n - id\n - name\n - type\n - description\n - currency\n - transaction_type\n - active\n properties:\n id:\n type: string\n description: The unique identifier of the advanced fee.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n x-nymos-key: true\n maxLength: 36\n name:\n type: string\n description: Advanced fee name.\n example: \"withdrawal-fee\"\n maxLength: 100\n type:\n $ref: \"#/definitions/FeeType\"\n description: Type of fee (whether it is fixed value or percentage).\n example: \"PERCENTAGE\"\n description:\n type: string\n description: Fee description.\n example: \"Withdrawal Fee\"\n maxLength: 400\n currency:\n type: string\n description: Currency code or ***. *** is applicable for transaction types PURCHASE_FOREIGN_CURRENCY, WITHDRAWAL_FOREIGN_CURRENCY.\n example: \"USD\"\n pattern: \"^([\\\\*]{3}|[A-Z]{3})$\"\n transaction_type:\n description: Type of transaction.\n example: \"WITHDRAWALS\"\n $ref: \"#/definitions/AdvancedTransactionTypeValue\"\n active:\n type: boolean\n description: Fee status (whether it is active or not). Default value is \"true\".\n example: true\n amount:\n type: number\n description: Fee amount (applicable if fee type includes flat option).\n example: 2\n minimum: 0\n percentage:\n type: number\n description: Fee percentage (applicable if fee type includes percentage option).\n example: 5\n minimum: 0\n maximum: 100\n range:\n type: array\n description: An array of ranges where fee is applicable.\n items:\n $ref: \"#/definitions/Range\"\n conditions:\n type: array\n description: An array of conditions.\n items:\n $ref: \"#/definitions/AdvancedCondition\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n x-nymos-index: desc\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2018-01-02T19:42:32.987Z\"\n is_forex_fee:\n type: boolean\n description: Is forex fee flag.\n\n AdvancedCondition:\n type: object\n required:\n - type\n - values\n properties:\n type:\n type: string\n description: Condition type.\n\n * \"PURCHASE_TYPE\" has such enums as PURCHASE and ECOMMERCE.\n\n * \"TRANSACTION_ORIGIN\" has such enums as DOMESTIC and FOREIGN.\n\n * \"API_CHANNEL\" has such enums as API, MPGS, DAPI, LEAN.\n\n * \"SCHEME_SCOPE\" has such enums as VISA, MASTERCARD, MERCURY, UNIONPAY.\n\n example: \"TRANSACTION_ORIGIN\"\n enum:\n - \"MCC\"\n - \"MERCHANT_ID\"\n - \"ACQUIRER_COUNTRY\"\n - \"SCHEME_SCOPE\"\n - \"API_CHANNEL\"\n - \"KYC_LEVEL\"\n - \"TRANSACTION_ORIGIN\"\n - \"TRANSFER_TYPE\"\n - \"PURCHASE_TYPE\"\n\n operator:\n $ref: \"#/definitions/ConditionOperator\"\n description: Condition operator.\n values:\n type: array\n description: An array of values.\n x-nymos-default-value: null\n items:\n type: string\n description: Some value.\n example: \"DOMESTIC\"\n active:\n type: boolean\n description: Condition status (whether it is active or not). Default value is \"true\".\n example: true\n\n AdvancedFeeCreateRequest:\n type: object\n required:\n - name\n - type\n - description\n - currency\n - transaction_type\n properties:\n id:\n type: string\n maxLength: 36\n description: The unique identifier of the advanced fee.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n name:\n type: string\n description: Advanced fee name.\n example: \"withdrawal-fee\"\n maxLength: 100\n type:\n $ref: \"#/definitions/FeeType\"\n description: Type of fee (whether it is fixed value or percentage).\n example: \"PERCENTAGE\"\n description:\n type: string\n description: Fee description.\n example: \"Withdrawal Fee\"\n maxLength: 400\n currency:\n type: string\n description: Currency code or ***. *** is applicable for transaction types PURCHASE_FOREIGN_CURRENCY, WITHDRAWAL_FOREIGN_CURRENCY\n example: \"USD\"\n pattern: \"^([\\\\*]{3}|[A-Z]{3})$\"\n transaction_type:\n description: Type of transaction.\n example: \"WITHDRAWALS\"\n $ref: \"#/definitions/AdvancedTransactionTypeValue\"\n active:\n type: boolean\n description: Fee status (whether it is active or not). Default value is \"true\".\n example: true\n amount:\n type: number\n description: Fee amount (applicable if fee type includes flat option).\n example: 2\n minimum: 0\n percentage:\n type: number\n description: Fee percentage (applicable if fee type includes percentage option).\n example: 5\n minimum: 0\n maximum: 100\n range:\n type: array\n description: An array of ranges where fee is applicable.\n items:\n $ref: \"#/definitions/Range\"\n conditions:\n type: array\n description: An array of conditions.\n items:\n $ref: \"#/definitions/AdvancedCondition\"\n is_forex_fee:\n type: boolean\n description: Indicates whether fee is a forex fee.\n\n AdvancedFeeUpdateRequest:\n type: object\n properties:\n name:\n type: string\n description: Unique advanced fee name.\n example: \"withdrawal-fee\"\n maxLength: 100\n type:\n $ref: \"#/definitions/FeeType\"\n description: Type of fee (whether it is fixed value or percentage).\n example: \"PERCENTAGE\"\n description:\n type: string\n description: Fee description.\n example: \"Withdrawal Fee\"\n maxLength: 400\n currency:\n type: string\n description: Currency code or ***. *** is applicable for transaction types PURCHASE_FOREIGN_CURRENCY, WITHDRAWAL_FOREIGN_CURRENCY\n example: \"USD\"\n pattern: \"^([\\\\*]{3}|[A-Z]{3})$\"\n transaction_type:\n description: Type of transaction.\n example: \"WITHDRAWALS\"\n $ref: \"#/definitions/AdvancedTransactionTypeValue\"\n active:\n type: boolean\n description: Fee status (whether it is active or not). Default value is \"true\".\n example: true\n amount:\n type: number\n description: Fee amount (applicable if fee type includes flat option).\n example: 2\n minimum: 0\n percentage:\n type: number\n description: Fee percentage (applicable if fee type includes percentage option).\n example: 5\n minimum: 0\n maximum: 100\n range:\n type: array\n description: An array of ranges where fee is applicable.\n x-nymos-default-value: null\n items:\n $ref: \"#/definitions/Range\"\n conditions:\n type: array\n description: An array of conditions.\n x-nymos-default-value: null\n items:\n $ref: \"#/definitions/AdvancedCondition\"\n is_forex_fee:\n type: boolean\n description: Indicates whether fee is a forex fee.\n\n AdvancedFeesCollection:\n type: object\n properties:\n has_more:\n type: boolean\n description: This parameter indicates whether there are more data to load.\n after:\n type: string\n description: Durable version of current results that can be used on the next sync.\n data:\n type: array\n description: An array of data.\n items:\n $ref: \"#/definitions/AdvancedFee\"\n\n AdvancedTransactionTypeValue:\n type: string\n description: Advanced transaction type.\n example: \"WITHDRAWALS\"\n enum:\n - WITHDRAWALS\n - PURCHASES\n - BALANCE_INQUIRIES\n - TRANSFERS\n - LOADS\n - UNLOADS\n\n ConditionOperator:\n type: string\n description: Condition operator. Default value is \"any_of\".\n example: \"any_of\"\n enum:\n - any_of\n - all_of\n - none_of\n - less_than\n - less_or_equal\n - greater_than\n - greater_or_equal\n\n AdvancedFeeSortBy:\n type: string\n description: This parameter indicates by which parameter you want to sort an advanced fee.\n example: \"id\"\n enum:\n - id\n - name\n - description\n - active\n - type\n - currency\n - amount\n - percentage\n - range\n - transaction_type\n - created\n - modified\n\n VelocityLimitCreateRequest:\n type: object\n required:\n - type\n - description\n - currency\n - transaction_scope\n properties:\n id:\n type: string\n description: |\n The unique identifier of the velocity limit. If this information is not present in the request, the system generates one automatically.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n maxLength: 36\n description:\n type: string\n description: |\n The name of the velocity limit. We recommend using a unique string.\n example: \"Some description of the velocity Limit\"\n maxLength: 40\n active:\n type: boolean\n description: |\n This parameter defines whether the velocity limits are going to be activated or not at the time of its creation. By default the velocity limit is activated on its creation.\n type:\n $ref: \"#/definitions/VelocityLimitType\"\n min_amount:\n type: number\n description: |\n The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.\n format: decimal\n example: 1500.10\n minimum: 0\n maximum: 999999999999\n max_amount:\n type: number\n description: |\n The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.\n format: decimal\n example: 1500.10\n minimum: 0\n maximum: 999999999999\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: \"3-letter ISO_4217 code representing the currency.\"\n frequency:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n It restricts a number of transactions a user can perform within a specified period of time.\n period:\n $ref: \"#/definitions/Period\"\n num_of_days:\n type: integer\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’.\n example: 15\n minimum: 0\n maximum: 999999999\n transaction_scope:\n type: array\n description: This parameter is to define a transaction scope for this velocity limit.\n items:\n $ref: \"#/definitions/TransactionScope\"\n minItems: 1\n channel_scope:\n description: This parameter is used to create a velocity limit for the channels defined in the system, e.g. Visa.\n $ref: \"#/definitions/ChannelScopeValues\"\n\n VelocityLimitUpdateRequest:\n type: object\n properties:\n description:\n type: string\n description: |\n Velocity limit description\n example: \"Some description of the velocity Limit\"\n maxLength: 40\n active:\n type: boolean\n description: |\n This parameter describes if velocity limit is activated or not.\n type:\n $ref: \"#/definitions/VelocityLimitType\"\n min_amount:\n type: number\n minimum: 0\n maximum: 999999999999\n description: |\n The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.\n format: decimal\n example: 1500.10\n max_amount:\n type: number\n minimum: 0\n maximum: 999999999999\n description: |\n The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.\n format: decimal\n example: 1500.10\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: \"3-letter ISO_4217 code representing the currency\"\n frequency:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n It restricts a number of transactions a user can perform within a specified period of time.\n period:\n $ref: \"#/definitions/Period\"\n num_of_days:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’’\n example: 15\n transaction_scope:\n type: array\n description: This parameter array contains the transaction scope for this velocity limit.\n items:\n $ref: \"#/definitions/TransactionScope\"\n minItems: 1\n channel_scope:\n $ref: \"#/definitions/ChannelScopeValues\"\n\n VelocityLimit:\n type: object\n properties:\n id:\n type: string\n description: |\n Unique ID for the velocity Limit.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n maxLength: 36\n description:\n type: string\n description: |\n Velocity Description.\n example: \"Some description of the velocity Limit\"\n maxLength: 40\n active:\n type: boolean\n description: |\n This parameter describes if velocity limit is activated or not.\n type:\n $ref: \"#/definitions/VelocityLimitType\"\n min_amount:\n type: number\n description: |\n Minimum amount.\n format: decimal\n example: 100\n max_amount:\n type: number\n description: |\n Maximum amount.\n format: decimal\n example: 1000\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n frequency:\n type: integer\n description: |\n Frequency.\n period:\n $ref: \"#/definitions/Period\"\n num_of_days:\n type: integer\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’’\n example: 15\n transaction_scope:\n type: array\n items:\n $ref: \"#/definitions/TransactionScope\"\n channel_scope:\n $ref: \"#/definitions/ChannelScopeValues\"\n program_level:\n type: boolean\n description: |\n This parameter describes if velocity limit is activated on program level or not.\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n\n CardVelocityLimit:\n type: object\n properties:\n id:\n type: string\n description: |\n Unique ID for the velocity Limit.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n maxLength: 36\n description:\n type: string\n description: |\n Velocity Description.\n example: \"Some description of the velocity Limit\"\n maxLength: 40\n active:\n type: boolean\n description: |\n This parameter describes if velocity limit is activated or not.\n consumed_limit:\n type: number\n minimum: 0\n maximum: 999999999999\n example: 883.05\n description: |\n Consumed limit.\n consumed_frequency:\n type: number\n minimum: 0\n maximum: 999999999999\n example: 2.10\n description: |\n Consumed frequency.\n type:\n $ref: \"#/definitions/VelocityLimitType\"\n min_amount:\n type: number\n description: |\n Minimum amount.\n format: decimal\n example: 100\n max_amount:\n type: number\n description: |\n Maximum amount.\n format: decimal\n example: 1000\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n frequency:\n type: integer\n description: |\n Frequency.\n period:\n $ref: \"#/definitions/Period\"\n num_of_days:\n type: integer\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’’\n example: 15\n transaction_scope:\n type: array\n items:\n $ref: \"#/definitions/TransactionScope\"\n channel_scope:\n $ref: \"#/definitions/ChannelScopeValues\"\n program_level:\n type: boolean\n description: |\n This parameter describes if velocity limit is activated on program level or not.\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n\n AdvancedVelocityLimitCreateRequest:\n type: object\n required:\n - name\n - type\n - currency\n - transaction_scope\n properties:\n id:\n type: string\n description: |\n Unique ID for the advanced velocity limit.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n maxLength: 36\n name:\n type: string\n description: The name of advanced velocity limit.\n example: \"limit1\"\n minLength: 1\n maxLength: 100\n type:\n $ref: \"#/definitions/AdvancedVelocityLimitType\"\n description:\n type: string\n description: The additional information.\n example: \"Some description\"\n minLength: 1\n maxLength: 400\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n transaction_scope:\n type: array\n description: The transaction scope.\n items:\n $ref: \"#/definitions/TransactionScope\"\n active:\n type: boolean\n default: true\n description: |\n This parameter describes if advanced velocity limit is activated or not.\n amount:\n type: number\n description: |\n The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.\n format: decimal\n example: 1500.10\n minimum: 0\n maximum: 999999999999\n frequency:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n It restricts a number of transactions a user can perform within a specified period of time.\n period:\n $ref: \"#/definitions/AdvancedVelocityLimitPeriod\"\n description: The period of advanced velocity limit.\n example: \"Some period\"\n num_of_days:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘num_of_days’\n example: 15\n effective_from:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time from which the limit is effective.\n effective_to:\n type: string\n format: date-time\n description: The date and time to which the limit is effective.\n default: \"2099-12-31T11:59:59.999Z\"\n example: \"2018-01-02T19:42:32.987Z\"\n conditions:\n type: array\n description: An array of conditions.\n x-nymos-default-value: null\n items:\n $ref: \"#/definitions/Conditions\"\n group:\n $ref: \"#/definitions/Group\"\n default: \"SINGLE\"\n description: The advanced velocity limit group.\n\n Group:\n type: string\n example: \"SINGLE\"\n description: The advanced velocity limit group.\n enum:\n - SINGLE\n\n AdvancedVelocityLimitUpdateRequest:\n type: object\n properties:\n name:\n type: string\n minLength: 1\n maxLength: 100\n description: The name of advanced velocity limit.\n example: \"limit1\"\n type:\n $ref: \"#/definitions/AdvancedVelocityLimitType\"\n description:\n type: string\n minLength: 1\n maxLength: 400\n description: The additional information.\n example: \"Some description\"\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n transaction_scope:\n type: array\n description: The transaction scope.\n x-nymos-default-value: null\n items:\n $ref: \"#/definitions/TransactionScope\"\n active:\n type: boolean\n default: true\n description: |\n This parameter describes if advanced velocity limit is activated or not.\n amount:\n type: number\n description: |\n The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.\n format: decimal\n example: 1500.10\n minimum: 0\n maximum: 999999999999\n frequency:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n It restricts a number of transactions a user can perform within a specified period of time.\n period:\n $ref: \"#/definitions/AdvancedVelocityLimitPeriod\"\n description: The period of advanced velocity limit.\n example: \"Some period\"\n num_of_days:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘num_of_days’\n example: 15\n effective_from:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time from which the limit is effective.\n effective_to:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time to which the limit is effective.\n conditions:\n type: array\n description: An array of conditions.\n x-nymos-default-value: null\n items:\n $ref: \"#/definitions/Conditions\"\n group:\n $ref: \"#/definitions/Group\"\n description: The advanced velocity limit group.\n default: \"SINGLE\"\n\n AdvancedVelocityLimit:\n type: object\n x-nymos-entity: limits_advanced_limits\n required:\n - name\n - type\n - currency\n - transaction_scope\n properties:\n id:\n type: string\n description: |\n Unique ID for the advanced velocity limit.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n x-nymos-key: true\n maxLength: 36\n name:\n type: string\n minLength: 1\n maxLength: 100\n description: The name of advanced velocity limit.\n example: \"limit1\"\n type:\n $ref: \"#/definitions/AdvancedVelocityLimitType\"\n description:\n type: string\n minLength: 1\n maxLength: 400\n description: The additional information.\n example: \"Some description\"\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n transaction_scope:\n type: array\n description: The transaction scope.\n items:\n $ref: \"#/definitions/TransactionScope\"\n active:\n type: boolean\n default: true\n description: |\n This parameter describes if advanced velocity limit is activated or not.\n amount:\n type: number\n description: |\n The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.\n format: decimal\n example: 1500.10\n minimum: 0\n maximum: 999999999999\n frequency:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n It restricts a number of transactions a user can perform within a specified period of time.\n period:\n $ref: \"#/definitions/AdvancedVelocityLimitPeriod\"\n description: The period of advanced velocity limit.\n example: \"Some period\"\n num_of_days:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘num_of_days’\n example: 15\n effective_from:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time from which the limit is effective.\n effective_to:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time to which the limit is effective.\n program_level:\n type: boolean\n default: false\n description: |\n This parameter describes if advanced velocity limit is activated on program level or not.\n conditions:\n type: array\n description: An array of conditions.\n x-nymos-default-value: null\n items:\n $ref: \"#/definitions/Conditions\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n x-nymos-index: desc\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n group:\n $ref: \"#/definitions/Group\"\n description: The advanced velocity limit group.\n default: \"SINGLE\"\n \n CardAdvancedVelocityLimit:\n type: object\n x-nymos-entity: limits_advanced_limits\n required:\n - name\n - type\n - currency\n - transaction_scope\n properties:\n id:\n type: string\n description: |\n Unique ID for the advanced velocity limit.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n x-nymos-key: true\n maxLength: 36\n name:\n type: string\n minLength: 1\n maxLength: 100\n description: The name of advanced velocity limit.\n example: \"limit1\"\n type:\n $ref: \"#/definitions/AdvancedVelocityLimitType\"\n description:\n type: string\n minLength: 1\n maxLength: 400\n description: The additional information.\n example: \"Some description\"\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n transaction_scope:\n type: array\n description: The transaction scope.\n items:\n $ref: \"#/definitions/TransactionScope\"\n active:\n type: boolean\n default: true\n description: |\n This parameter describes if advanced velocity limit is activated or not.\n consumed_limit:\n type: number\n minimum: 0\n maximum: 999999999999\n example: 883.05\n description: |\n Consumed limit.\n consumed_frequency:\n type: number\n minimum: 0\n maximum: 999999999999\n example: 2.10\n description: |\n Consumed frequency.\n amount:\n type: number\n description: |\n The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.\n format: decimal\n example: 1500.10\n minimum: 0\n maximum: 999999999999\n frequency:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n It restricts a number of transactions a user can perform within a specified period of time.\n period:\n $ref: \"#/definitions/AdvancedVelocityLimitPeriod\"\n description: The period of advanced velocity limit.\n example: \"Some period\"\n num_of_days:\n type: integer\n minimum: 0\n maximum: 999999999\n description: |\n During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’\n and apply the limit accordingly. This field will only be used when ‘period’ = ‘num_of_days’\n example: 15\n effective_from:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time from which the limit is effective.\n effective_to:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time to which the limit is effective.\n program_level:\n type: boolean\n default: false\n description: |\n This parameter describes if advanced velocity limit is activated on program level or not.\n conditions:\n type: array\n description: An array of conditions.\n x-nymos-default-value: null\n items:\n $ref: \"#/definitions/Conditions\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n x-nymos-index: desc\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n group:\n $ref: \"#/definitions/Group\"\n description: The advanced velocity limit group.\n default: \"SINGLE\"\n\n AdvancedVelocityLimitCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next sync\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load\"\n data:\n type: array\n description: An array of data.\n items:\n $ref: \"#/definitions/AdvancedVelocityLimit\"\n\n VelocityLimitCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next sync.\"\n example: 4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\n has_more:\n type: boolean\n description: This parameter indicates whether there are more data to load.\n data:\n type: array\n description: An array of velocity limits.\n items:\n $ref: \"#/definitions/VelocityLimit\"\n\n ChannelScopeValues:\n type: string\n description: This parameter is used to create a velocity limit for the channels defined in the system.\n enum:\n - VISA\n - MASTERCARD\n - WESTERNUNION\n\n VelocityLimitType:\n type: string\n description: |\n Type of velocity limit.\n enum:\n - PER_TRANSACTION\n - PER_CARD\n - PER_ACCOUNT\n - PER_USER\n\n AdvancedVelocityLimitType:\n type: string\n description: |\n Type of advanced velocity limit.\n enum:\n - PER_CARD\n - PER_ACCOUNT\n - PER_USER\n\n Period:\n type: string\n description: |\n It specifies the time period of the velocity limit for the transaction frequency.\n enum:\n - DAILY\n - MONTHLY\n - YEARLY\n - ALL_TIME\n - NUM_OF_DAYS\n\n AdvancedVelocityLimitPeriod:\n type: string\n description: |\n It specifies the time period of the advanced velocity limit for the transaction frequency.\n enum:\n - DAILY\n - WEEKLY\n - MONTHLY\n - YEARLY\n - ALL_TIME\n - NUM_OF_DAYS\n\n TransactionScope:\n type: string\n description: |\n Transaction Scope. Two or more items from transaction scope can share the same limit in case it will be a group based limit.\n enum:\n - WITHDRAWALS\n - PURCHASES\n - OUTGOING_TRANSFERS\n - UNLOADS\n - SCHEME_ACCOUNT_FUNDING\n - QUASI_CASH\n - PURCHASES_CONTACTLESS_NO_PIN\n - LOADS\n - INCOMING_TRANSFERS\n - SCHEME_CREDITS\n - INITIAL_LOAD\n\n BalanceLimitCreateRequest:\n type: object\n required:\n - type\n - description\n - min_amount\n - max_amount\n - currency\n properties:\n id:\n type: string\n description: |\n The unique identifier of the balance limit. If this information is not present in the request, the system generates one automatically.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n description:\n type: string\n description: |\n The name of the balance limit. We recommend using a unique string.\n example: \"Some description of the balance limit\"\n active:\n type: boolean\n description: |\n This parameter defines whether the balance limits are going to be activated or not at the time of its creation. By default the balance limit is activated on its creation.\n type:\n $ref: \"#/definitions/BalanceLimitType\"\n min_amount:\n type: number\n description: |\n The minimum balance an account can hold.\n format: decimal\n minimum: 0\n example: 1500.10\n max_amount:\n type: number\n description: |\n The maximum balance an account can hold.\n format: decimal\n minimum: 0\n example: 1500.10\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: \"3-letter ISO_4217 code representing the currency\"\n\n BalanceLimitUpdateRequest:\n type: object\n properties:\n description:\n type: string\n description: |\n The name of the balance limit. We recommend using a unique string.\n example: \"Some description of the balance limit\"\n active:\n type: boolean\n description: |\n This parameter defines whether the balance limits are going to be activated or not at the time of its creation. By default the balance limit is activated on its creation.\n type:\n $ref: \"#/definitions/BalanceLimitType\"\n min_amount:\n type: number\n description: |\n The minimum balance an account can hold.\n format: decimal\n minimum: 0\n example: 1500.10\n max_amount:\n type: number\n description: |\n The maximum balance an account can hold.\n format: decimal\n minimum: 0\n example: 1500.10\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: \"3-letter ISO_4217 code representing the currency\"\n\n BalanceLimit:\n type: object\n properties:\n id:\n type: string\n description: |\n The unique identifier of the balance limit.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n description:\n type: string\n description: |\n The name of the balance limit. We recommend using a unique string.\n example: \"Some description of the balance limit\"\n active:\n type: boolean\n description: |\n This parameter defines whether the balance limits are going to be activated or not at the time of its creation. By default the balance limit is activated on its creation.\n type:\n $ref: \"#/definitions/BalanceLimitType\"\n min_amount:\n type: number\n description: |\n The minimum balance an account can hold.\n format: decimal\n example: 1500.10\n max_amount:\n type: number\n description: |\n The maximum balance an account can hold.\n format: decimal\n example: 1500.10\n currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: \"3-letter ISO_4217 code representing the currency\"\n program_level:\n type: boolean\n description: |\n This parameter describes if the balance limit is activated on program level or not.\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n\n BalanceLimitCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next sync.\"\n example: 4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\n has_more:\n type: boolean\n description: This parameter indicates whether there are more data to load.\n data:\n type: array\n description: An array of balance limits.\n items:\n $ref: \"#/definitions/BalanceLimit\"\n\n BalanceLimitType:\n type: string\n description: |\n Type of balance limit.\n enum:\n - PER_ACCOUNT\n\n CardProduct:\n type: object\n properties:\n id:\n type: string\n description: Unique ID for the Card Product.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n maxLength: 36\n description:\n type: string\n description: |\n The name of the card product. We recommend using a unique string.\n example: \"Some description of the card product\"\n maxLength: 40\n status:\n $ref: \"#/definitions/CardProductStatus\"\n currency_settings:\n type: array\n description: An array of currency settings to define the related characteristics such as supported currencies, settlement currencies, priority, currency status, etc. for the card product.\n items:\n $ref: \"#/definitions/CurrencySettings\"\n card_settings:\n description: An array of card settings to define the related characteristics such as bin, pan length, pan range, card validity code, etc. for the card product.\n $ref: \"#/definitions/CardSettings\"\n account_settings:\n $ref: \"#/definitions/AccountSettings\"\n description: An array of account settings to define the related characteristics such as link account to card, number of cards per account etc. for the card product.\n pin_settings:\n description: An array of PIN settings to define the related characteristics such as PIN type, PIN length, and PIN retries for the card product.\n $ref: \"#/definitions/PinSettings\"\n auth_settings:\n description: An array of authorization settings to define the related characteristics such as transaction controlling (enabling/disabling), authorization aging, etc. for the card product. Note that auth settings cannot be updated for an ACTIVE card product.\n $ref: \"#/definitions/CardProductAuthSettings\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n pan_format_token:\n type: string\n description: Identifier for the Pan Format Token. If not provided then default PAN format will be used.\n example: \"default_pan_format\"\n maxLength: 36\n track_format_token:\n type: string\n description: Identifier for the Track Format. If not provided then default Track format will be used.\n example: \"default_track_format\"\n maxLength: 36\n proxy_format_token:\n type: string\n description: Identifier for Proxy format. If not provided then default Track format will be used.\n example: \"default_proxy_format\"\n maxLength: 36\n type:\n $ref: \"#/definitions/CardProductType\"\n is_multi_currency_product:\n type: boolean\n description: Indicates whether the product is single currency or multi currency supported.\n example: true\n wallet_settings:\n $ref: \"#/definitions/WalletSettings\"\n description: Wallet settings.\n fxrates_settings:\n type: array\n description: An array of FX rates settings.\n items:\n $ref: \"#/definitions/FxRatesSettings\"\n\n CardProductCreateRequest:\n type: object\n required:\n - description\n - currency_settings\n - card_settings\n properties:\n id:\n type: string\n description: The unique identifier of the card product. If this information is not present in the request, the system generates one automatically.\n example: \"cardproduct1\"\n pattern: \"^[a-zA-Z\\\\-0-9]+$\"\n maxLength: 36\n description:\n type: string\n description: |\n The name of the card product. We recommend using a unique string.\n example: \"Some description of the cardproduct1\"\n maxLength: 40\n status:\n $ref: \"#/definitions/CreateCardProductStatus\"\n currency_settings:\n type: array\n description: An array of currency settings to define the related characteristics such as supported currencies, settlement currencies, priority, currency status, etc. for the card product.\n minItems: 1\n items:\n $ref: \"#/definitions/CurrencySettings\"\n card_settings:\n description: An array of card settings to define the related characteristics such as bin, pan length, pan range, card validity code, etc. for the card product.\n $ref: \"#/definitions/CardSettings\"\n account_settings:\n $ref: \"#/definitions/AccountSettings\"\n description: An array of account settings to define the related characteristics such as link account to card, number of cards per account etc. for the card product.\n pin_settings:\n description: An array of PIN settings to define the related characteristics such as PIN type, PIN length, and PIN retries for the card product.\n $ref: \"#/definitions/PinSettings\"\n auth_settings:\n description: An array of authorization settings to define the related characteristics such as transaction controlling (enabling/disabling), authorization aging, etc. for the card product. Note that auth settings cannot be updated for an ACTIVE card product.\n $ref: \"#/definitions/AuthSettings\"\n pan_format_token:\n type: string\n description: Identifier for the Pan Format Token. If not provided then default PAN format will be used.\n example: \"default_pan_format\"\n maxLength: 36\n track_format_token:\n type: string\n description: Identifier for the Track Format. If not provided then default Track format will be used.\n example: \"default_track_format\"\n maxLength: 36\n proxy_format_token:\n type: string\n description: Identifier for Proxy format\n example: \"default_proxy_format\"\n maxLength: 36\n type:\n $ref: \"#/definitions/CardProductType\"\n is_multi_currency_product:\n type: boolean\n description: Indicates whether the product is single currency or multi currency supported.\n example: true\n default: false\n wallet_settings:\n $ref: \"#/definitions/WalletSettings\"\n description: Wallet settings.\n fxrates_settings:\n type: array\n description: An array of FX rates settings.\n items:\n $ref: \"#/definitions/FxRatesSettings\"\n\n CardProductUpdateRequest:\n type: object\n properties:\n description:\n type: string\n description: |\n The name of the card product. We recommend using a unique string.\n example: \"Some description of the card product\"\n status:\n $ref: \"#/definitions/UpdateCardProductStatus\"\n currency_settings:\n type: array\n description: |\n An array of currency settings to define the related characteristics such as supported currencies, settlement currencies, priority, currency status, etc. for the card product.\n Already added currencies cannot be deleted but can be marked as inactive.\n When product status is active then currency fields can't be modified for currency with priority = 1.\n items:\n $ref: \"#/definitions/CurrencySettings\"\n card_settings:\n description: An array of card settings to define the related characteristics such as bin, pan length, pan range, card validity code, etc. for the card product.\n $ref: \"#/definitions/CardSettingsUpdateRequest\"\n account_settings:\n $ref: \"#/definitions/AccountSettings\"\n description: An array of account settings to define the related characteristics such as link account to card, number of cards per account etc. for the card product.\n pin_settings:\n description: An array of PIN settings to define the related characteristics such as PIN type, PIN length, and PIN retries for the card product.\n $ref: \"#/definitions/PinSettings\"\n auth_settings:\n description: An array of authorization settings to define the related characteristics such as transaction controlling (enabling/disabling), authorization aging, etc. for the card product. Note that auth settings cannot be updated for an ACTIVE card product.\n $ref: \"#/definitions/AuthSettings\"\n pan_format_token:\n type: string\n description: Identifier for the Pan Format Token. If not provided then default PAN format will be used.\n example: \"default_pan_format\"\n maxLength: 36\n track_format_token:\n type: string\n description: Identifier for the Track Format. If not provided then default Track format will be used.\n example: \"default_track_format\"\n maxLength: 36\n proxy_format_token:\n type: string\n description: Identifier for Proxy format\n example: \"default_proxy_format\"\n maxLength: 36\n type:\n $ref: \"#/definitions/CardProductType\"\n is_multi_currency_product:\n type: boolean\n description: Indicates whether the product is single currency or multi currency supported.\n example: true\n wallet_settings:\n $ref: \"#/definitions/WalletSettings\"\n description: Wallet settings.\n fxrates_settings:\n type: array\n description: An array of FX rates settings.\n items:\n $ref: \"#/definitions/FxRatesSettings\"\n\n WalletSettings:\n type: object\n description: Wallet settings. If 'is_multi_currency_product' = true, then it becomes mandatory.\n properties:\n initial_num_of_wallets_offered:\n type: integer\n format: int32\n description: It is optional field. If provided, then value should be >=2 and <= number of supported currencies.\n maximum_active_wallets_allowed:\n type: integer\n format: int32\n description: It is optional field. If provided, then value should be >=2 and <= number of supported currencies\n maximum_wallets_allowed_in_sweep:\n type: integer\n format: int32\n description: If user provides this value, then it is stored. Otherwise default value [1] is used.\n\n FxRatesSettings:\n type: object\n required:\n - transaction_type\n - rate_group_id\n properties:\n transaction_type:\n $ref: \"#/definitions/FxRateTransactionType\"\n rate_group_id:\n type: string\n description: The unique identifier of custom FX rate group.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n maxLength: 36\n\n InitialVirtualCardStatus:\n type: string\n description: |\n Initial Card status. Default value is ACTIVE.\n default: ACTIVE\n enum:\n - INACTIVE\n - ACTIVE\n\n InitialPhysicalCardStatus:\n type: string\n description: |\n Initial Card status. Default value is INACTIVE.\n default: INACTIVE\n enum:\n - INACTIVE\n - ACTIVE\n\n CardProductStatus:\n type: string\n description: |\n This is the card product status. When card product is created, it has status 'INACTIVE'. Once a card is issued for the card product, the status will become 'ACTIVE'.\n enum:\n - INACTIVE\n - ACTIVE\n - TERMINATED\n\n CreateCardProductStatus:\n type: string\n description: |\n This is the card product status. When card product is created, it has status 'INACTIVE'. Once a card is issued for the card product, the status will become 'ACTIVE'.\n enum:\n - INACTIVE\n - ACTIVE\n\n UpdateCardProductStatus:\n type: string\n description: |\n This is the card product status. When card product is created, it has status 'INACTIVE'. Once a card is issued for the card product, the status will become 'ACTIVE'.\n enum:\n - ACTIVE\n\n CurrencySettings:\n type: object\n required:\n - supported_currency\n - settlement_currency\n properties:\n supported_currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: |\n This is the currency that is supported by the card product, funds shall be allowed to be maintained for this currency.\n The format should be 3-letter ISO_4217 code representing the currency.\n Must not repeat.\n settlement_currency:\n type: string\n format: iso-4217\n example: \"EUR\"\n pattern: \"^[A-Z]{3}$\"\n description: |\n This is the currency in which the supported currency transactions shall be settled with the payment scheme.\n The format should be 3-letter ISO_4217 code representing the currency.\n May repeat.\n priority:\n type: integer\n format: int32\n example: 1\n description: |\n For a multi-currency product this field gives the priority in which the currency wallets are used in funds sweeping.\n * This is an incremental number and shall start from 1.\n * Field is mandatory if there are more than one currencies.\n * `allow_xxx` fields must be true when `priority` = 1.\n * `status` must be active when `priority` = 1.\n status:\n $ref: \"#/definitions/CurrencyStatus\"\n allow_loads:\n type: boolean\n description: |\n This parameter governs whether loading funds to this currency wallet is allowed or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_unloads:\n type: boolean\n description: |\n This parameter governs whether unloading funds from this currency wallet is allowed or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_scheme_debit_txn:\n type: boolean\n description: |\n This parameter governs whether debit transactions from payment schemes (like purchase, withdrawal etc.)\n are allowed to be authorized using the funds in this currency or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_scheme_credit_txn:\n type: boolean\n description: |\n This parameter governs whether credit transactions from payment schemes (like OCT, MoneySend)\n are allowed to be credited to the funds held in this currency or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_incoming_transfer:\n type: boolean\n description: |\n This parameter governs whether incoming transfers (peer transfers or currency exchange transfers)\n are allowed to this currency or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_outgoing_transfer:\n type: boolean\n description: |\n This parameter governs whether outgoing transfers (peer transfers or currency exchange transfers)\n are allowed from this currency or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_incoming_sweeps:\n type: boolean\n description: |\n This parameter governs whether incoming sweeps are allowed to this currency or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_outgoing_sweeps:\n type: boolean\n description: |\n This parameter governs whether outgoing sweeps are allowed from this currency or not. For multi-currency card product, it should be set to 'true' for currency of priority = 1.\n example: true\n default: true\n allow_initial_load:\n type: boolean\n description: This field indicates whether initial load is allowed or not. The default value is 'false'.\n default: false\n\n CurrencyStatus:\n type: string\n description: For a multi-currency product, if this field is set to 'INACTIVE' then the wallets of this currency cannot be used in any transactions. Default value is 'ACTIVE'.\n enum:\n - INACTIVE\n - ACTIVE\n\n CardSettings:\n type: object\n description: An array of card settings to define the related characteristics such as bin, pan length, pan range, card validity code, etc. for the card product.\n required:\n - bin\n - pan_range\n properties:\n bin:\n type: string\n description: This is the Bank Identification Number assigned by the payment schemes.\n pattern: \"^([0-9]{6}|[0-9]{8})$\"\n example: \"450002\"\n pan_length:\n type: integer\n format: int32\n example: 16\n default: 16\n minimum: 16\n maximum: 19\n description: This is the length of the PAN (card number) that is to be generated.\n pan_range:\n type: array\n description: >\n Primary account number range. Within a BIN there is an allowed range of PANs from which a PAN can be generated. The following conditions must be true to pass validations -\n * start_range and end_range are >= 0;\n * start_range <= end_range;\n * Range intersections are not allowed when multiple ranges provided.\n\n The following maximum length is allowed for start_range and end_range -\n * BIN length = 6, PAN length = 16, maximum allowed length is 9 for start_range and end_range;\n * BIN length = 6, PAN length = 17, maximum allowed length is 10 for start_range and end_range;\n * BIN length = 6, PAN length = 18, maximum allowed length is 11 for start_range and end_range;\n * BIN length = 6, PAN length = 19, maximum allowed length is 12 for start_range and end_range;\n * BIN length = 8, PAN length = 16, maximum allowed length is 7 for start_range and end_range;\n * BIN length = 8, PAN length = 17, maximum allowed length is 8 for start_range and end_range;\n * BIN length = 8, PAN length = 18, maximum allowed length is 9 for start_range and end_range;\n * BIN length = 8, PAN length = 19, maximum allowed length is 10 for start_range and end_range.\n minItems: 1\n items:\n $ref: \"#/definitions/PanRange\"\n card_validity_term:\n type: number\n description: This is the term (in months) for which a newly created card will be valid for.\n format: int32\n minimum: 1\n maximum: 99\n example: 36\n default: 36\n service_code:\n type: string\n description: Service code is a 3-digit code with the values ranging from 000 to 999.\n pattern: '^[0-9]{3}$'\n example: \"201\"\n allow_new_card_creation:\n type: boolean\n description: |\n This parameter determines if new cards can be created for this card product.\n example: true\n default: true\n num_of_physical_cards_per_user:\n type: integer\n format: int32\n description: |\n Number of non-terminated physical cards allowed per user.\n example: 5\n default: 5\n minimum: 0\n maximum: 99\n num_of_virtual_cards_per_user:\n type: integer\n format: int32\n description: |\n Number of non-terminated virtual cards allowed per user.\n example: 5\n default: 5\n minimum: 0\n maximum: 99\n initial_status_of_physical_card:\n $ref: \"#/definitions/InitialPhysicalCardStatus\"\n initial_status_of_virtual_card:\n $ref: \"#/definitions/InitialVirtualCardStatus\"\n generate_proxy_number:\n type: boolean\n description: This parameter describes if the proxy number is generated when card is issued.\n example: false\n create_account_with_card:\n type: boolean\n default: true\n description: |\n If true - account will be created & linked when 'Create card' API is called; If false - account won't be created.\n design_code:\n type: string\n description: The identifier for card design.\n example: \"CD_01\"\n maxLength: 10\n pattern: '^[ A-Za-z0-9_@./#&+-]*$'\n soft_expiry_period:\n type: integer\n format: int32\n description: |\n Number of months for defining the soft expiry period.\n minimum: 1\n maximum: 99\n example: 1\n virtual_to_physical_expiry_duration:\n type: integer\n format: int32\n example: 3\n description: This parameter indicates card expiry duration while migrating it from virtual to physical. It is measured in months. The default value is 3 months.\n soft_expiry_update_allowed:\n type: boolean\n default: false\n description: This parameter indicates whether soft expiry update is allowed or not. The default value is false.\n soft_expiry_setting:\n $ref: \"#/definitions/SoftExpirySetting\"\n\n CardSettingsUpdateRequest:\n type: object\n description: An array of card settings to define the related characteristics such as bin, pan length, pan range, card validity code, etc. for the card product.\n properties:\n bin:\n type: string\n description: This is the Bank Identification Number assigned by the payment schemes. BIN should not be passed in the 'update card product' request.\n pattern: \"^([0-9]{6}|[0-9]{8})$\"\n example: \"999999\"\n pan_length:\n type: integer\n format: int32\n example: 16\n minimum: 16\n maximum: 19\n description: This is the length of the PAN (card number) that is to be generated.\n pan_range:\n type: array\n description: >\n Primary account number range. Within a BIN there is an allowed range of PANs from which a PAN can be generated. PAN range(s) cannot be updated. However, new PAN range(s) can be added. The following conditions must be true to pass validations -\n * start_range and end_range are >= 0;\n * start_range <= end_range;\n * Range intersections are not allowed when multiple ranges provided.\n\n The following maximum length is allowed for start_range and end_range -\n * BIN length = 6, PAN length = 16, maximum allowed length is 9 for start_range and end_range;\n * BIN length = 6, PAN length = 17, maximum allowed length is 10 for start_range and end_range;\n * BIN length = 6, PAN length = 18, maximum allowed length is 11 for start_range and end_range;\n * BIN length = 6, PAN length = 19, maximum allowed length is 12 for start_range and end_range;\n * BIN length = 8, PAN length = 16, maximum allowed length is 7 for start_range and end_range;\n * BIN length = 8, PAN length = 17, maximum allowed length is 8 for start_range and end_range;\n * BIN length = 8, PAN length = 18, maximum allowed length is 9 for start_range and end_range;\n * BIN length = 8, PAN length = 19, maximum allowed length is 10 for start_range and end_range.\n minItems: 1\n items:\n $ref: \"#/definitions/PanRange\"\n card_validity_term:\n type: number\n description: This is the term (in months) for which a newly created card will be valid for.\n format: int32\n minimum: 1\n maximum: 99\n example: 36\n service_code:\n type: string\n description: Service code is a 3-digit code with the values ranging from 000 to 999.\n pattern: '^[0-9]{3}$'\n example: \"201\"\n allow_new_card_creation:\n type: boolean\n description: |\n This parameter determines if new cards can be created for this card product.\n example: true\n num_of_physical_cards_per_user:\n type: integer\n format: int32\n description: |\n Number of non-terminated physical cards allowed per user.\n example: 5\n minimum: 0\n maximum: 99\n num_of_virtual_cards_per_user:\n type: integer\n format: int32\n description: |\n Number of non-terminated virtual cards allowed per user.\n example: 5\n minimum: 0\n maximum: 99\n initial_status_of_physical_card:\n $ref: \"#/definitions/InitialPhysicalCardStatus\"\n initial_status_of_virtual_card:\n $ref: \"#/definitions/InitialVirtualCardStatus\"\n generate_proxy_number:\n type: boolean\n description: This parameter describes if the proxy number is generated when card is issued.\n example: false\n create_account_with_card:\n type: boolean\n default: true\n description: |\n If true - account will be created & linked when 'Create card' API is called; If false - account won't be created.\n design_code:\n type: string\n description: The identifier for card design.\n example: \"CD_01\"\n maxLength: 10\n pattern: '^[ A-Za-z0-9_@./#&+-]*$'\n soft_expiry_period:\n type: integer\n format: int32\n description: |\n Number of months for defining the soft expiry period.\n minimum: 1\n maximum: 99\n example: 1\n virtual_to_physical_expiry_duration:\n type: integer\n format: int32\n example: 3\n description: This parameter indicates card expiry duration while migrating it from virtual to physical. It is measured in months. The default value is 3 months.\n soft_expiry_update_allowed:\n type: boolean\n default: false\n description: This parameter indicates whether soft expiry update is allowed or not. The default value is false.\n soft_expiry_setting:\n $ref: \"#/definitions/SoftExpirySetting\"\n\n AccountSettings:\n type: object\n description: An array of account settings to define the related characteristics such as link account to card, number of cards per account etc. for the card product.\n properties:\n link_account_to_card:\n type: boolean\n default: true\n description: |\n If false - account will not be linked to the card; If true - account will be linked to the card.\n num_of_cards_per_account:\n type: integer\n format: int32\n default: 1\n description: |\n The max number of cards that can be linked to a single account.\n\n PanRange:\n type: object\n required:\n - start_range\n - end_range\n description: |\n Within a BIN there is an allowed range of PANs from which a PAN can be generated.\n\n The following conditions must be true to pass validations:\n * start_range and end_range are >= 0;\n * start_range <= end_range;\n * Range intersections are not allowed when multiple ranges provided.\n\n The following maximum length is allowed for start_range and end_range:\n * BIN length = 6, PAN length = 16, maximum allowed length is 9 for start_range and end_range;\n * BIN length = 6, PAN length = 17, maximum allowed length is 10 for start_range and end_range;\n * BIN length = 6, PAN length = 18, maximum allowed length is 11 for start_range and end_range;\n * BIN length = 6, PAN length = 19, maximum allowed length is 12 for start_range and end_range.\n\n\n properties:\n start_range:\n type: integer\n description: The first value of the PAN range. This is the part of the PAN after the BIN and excluding the last check digit.\n format: int64\n minimum: 0\n example: 111111111\n end_range:\n type: integer\n description: The last value of the PAN range. This is the part of the PAN after the BIN and excluding the last check digit.\n format: int64\n minimum: 0\n example: 999999999\n\n PinSettings:\n type: object\n description: An array of PIN settings to define the related characteristics such as PIN type, PIN length, and PIN retries for the card product.\n properties:\n pin_type:\n type: string\n example: ONLINE_PIN_ONLY\n description: This parameter indicates the type of PIN supported by the card product. Values can be \"ONLINE_PIN_ONLY\" and \"BOTH_ONLINE_OFFLINE\".\n pin_length:\n type: integer\n format: int32\n minimum: 4\n maximum: 12\n description: This is the length of the PIN to be supported. A PIN can have a length of 4 to 12 digits allowed by the payment schemes. Note that 'pin_length' parameter is for the first-time random PIN generation only.\n pin_retries:\n type: integer\n format: int32\n minimum: 3\n maximum: 5\n description: This is the number of successive bad PIN retries allowed for a card.\n\n CardProductAuthSettings:\n type: object\n description: An array of authorization settings to define the related characteristics such as transaction controlling (enabling/disabling), authorization aging, etc. for the card product. Note that auth settings cannot be updated for an ACTIVE card product.\n properties:\n allow_atm:\n type: boolean\n default: true\n description: This parameter indicates if ATM transactions are allowed or not.\n allow_pos:\n type: boolean\n default: true\n description: This parameter indicates if transactions originating from point of sales are allowed or not.\n allow_chip:\n type: boolean\n default: true\n description: This parameter indicates if chip transactions are allowed or not.\n allow_magstripe:\n type: boolean\n default: true\n description: This parameter indicates if magnetic stripe transactions are allowed or not.\n allow_chip_fallback:\n type: boolean\n default: true\n description: This parameter indicates if chip fallback to magnetic stripe transactions are allowed or not.\n allow_without_pin:\n type: boolean\n default: true\n description: This parameter indicates if authorization transactions without PIN are allowed or not.\n allow_ecommerce_non_3DS:\n type: boolean\n default: true\n description: This parameter indicates if Ecommerce non-3DS transactions are allowed or not.\n allow_ecommerce_3DS:\n type: boolean\n default: true\n description: This parameter indicates if Ecommerce 3DS transactions are allowed or not.\n allow_ecommerce_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if Ecommerce transactions without CVV2/CVN2 are allowed or not.\n allow_account_verification_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if Ecommerce account verification transactions without CVV2/CVN2 are allowed or not.\n allow_quasi_cash:\n type: boolean\n default: false\n description: This parameter indicates if a quasi cash transaction is allowed or not.\n allow_scheme_account_funding:\n type: boolean\n default: false\n description: This parameter indicates if a scheme account funding transaction is allowed or not.\n allow_scheme_credits:\n type: boolean\n default: false\n description: This parameter indicates if scheme credit transactions like Visa OCT or MC MoneySend are allowed or not.\n allow_contactless:\n type: boolean\n default: true\n description: This parameter indicates if contactless transactions are allowed or not.\n auth_aging:\n type: integer\n format: int32\n example: 10\n description: This parameter indicates the number of days for which a scheme authorization can continue to block the funds without receiving a clearing from the merchant (default = 30 days).\n atc_threshold:\n type: string\n pattern: '^[A-F0-9]{1,2}$'\n description: ATC (application transaction counter), is an EMV tag maintained at chip level which is incremented for every transaction.\n example: \"FF\"\n allowed_mccs_id:\n type: string\n maxLength: 36\n description: Allowed MCCS identifier.\n example: \"a8180db3-b2e9-4ae0-93cd-2a0b52a99737\"\n allowed_countries_id:\n type: string\n maxLength: 36\n description: Allowed countries identifier.\n example: \"8358c501-56a3-43b0-b2b3-a2c49f3c33ab\"\n allow_initial_load:\n type: boolean\n description: This field indicates whether initial load is allowed or not. The default value is 'false'.\n default: false\n\n AuthSettings:\n type: object\n description: An array of authorization settings to define the related characteristics such as transaction controlling (enabling/disabling), authorization aging, etc. for the card product. Note that auth settings cannot be updated for an ACTIVE card product.\n properties:\n allow_atm:\n type: boolean\n default: true\n description: This parameter indicates if ATM transactions are allowed or not.\n allow_pos:\n type: boolean\n default: true\n description: This parameter indicates if transactions originating from point of sales are allowed or not.\n allow_chip:\n type: boolean\n default: true\n description: This parameter indicates if chip transactions are allowed or not.\n allow_magstripe:\n type: boolean\n default: true\n description: This parameter indicates if magnetic stripe transactions are allowed or not.\n allow_chip_fallback:\n type: boolean\n default: true\n description: This parameter indicates if chip fallback to magnetic stripe transactions are allowed or not.\n allow_without_pin:\n type: boolean\n default: true\n description: This parameter indicates if authorization transactions without PIN are allowed or not.\n allow_ecommerce_non_3DS:\n type: boolean\n default: true\n description: This parameter indicates if Ecommerce non-3DS transactions are allowed or not.\n allow_ecommerce_3DS:\n type: boolean\n default: true\n description: This parameter indicates if Ecommerce 3DS transactions are allowed or not.\n allow_ecommerce_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if Ecommerce transactions without CVV2/CVN2 are allowed or not.\n allow_account_verification_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if Ecommerce account verification transactions without CVV2/CVN2 are allowed or not.\n allow_quasi_cash:\n type: boolean\n default: false\n description: This parameter indicates if a quasi cash transaction is allowed or not.\n allow_scheme_account_funding:\n type: boolean\n default: false\n description: This parameter indicates if a scheme account funding transaction is allowed or not.\n allow_scheme_credits:\n type: boolean\n default: false\n description: This parameter indicates if scheme credit transactions like Visa OCT or MC MoneySend are allowed or not.\n allow_contactless:\n type: boolean\n default: true\n description: This parameter indicates if contactless transactions are allowed or not.\n allow_initial_load:\n type: boolean\n description: This field indicates whether initial load is allowed or not. The default value is 'false'.\n default: false\n auth_aging:\n type: integer\n format: int32\n example: 10\n description: This parameter indicates the number of days for which a scheme authorization can continue to block the funds without receiving a clearing from the merchant (default = 30 days).\n atc_threshold:\n type: string\n pattern: '^[A-F0-9]{1,2}$'\n description: ATC (application transaction counter), is an EMV tag maintained at chip level which is incremented for every transaction.\n example: \"FF\"\n allowed_countries_id:\n type: string\n maxLength: 36\n description: Allowed countries identifier.\n example: \"8358c501-56a3-43b0-b2b3-a2c49f3c33ab\"\n\n CardProductCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load.\"\n has_more:\n type: boolean\n description: This parameter indicates whether there are more data to load.\n\n data:\n type: array\n description: An array of card products\n items:\n $ref: \"#/definitions/CardProduct\"\n\n CardProductLinkIds:\n type: object\n properties:\n ids:\n type: array\n description: An array of IDs.\n items:\n type: string\n example: \"velocitylimit04\"\n\n UserCollection:\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load.\"\n example: \"Durable version of current results\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load.\"\n data:\n type: array\n description: User data\n items:\n $ref: \"#/definitions/User\"\n\n UserFilter:\n type: object\n properties:\n name:\n type: string\n description: Filter by first, middle and last names of the user. Search works for complete or partial string.\n example: \"John\"\n mobile:\n type: string\n description: Filter by mobile number of the user. Search works for complete or partial string.\n example: \"+559999999995\"\n email:\n type: string\n description: Filter by user's email. Search works for complete or partial string.\n example: \"johndoe@example.com\"\n status:\n type: array\n items:\n type: string\n enum:\n - ACTIVE\n - PENDINGKYC\n - PENDINGKYB\n - PENDINGIDVERIFICATION\n - SUSPENDED\n - TERMINATED\n description: Filter by user's status.\n example: [ \"ACTIVE\" ]\n user_type:\n $ref: \"#/definitions/UserType\"\n description: Filter by user type.\n business_legal_name:\n type: string\n example: \"Insurance corporation\"\n description: Filter by business legal name, search for complete or partial string.\n business_dba_name:\n type: string\n example: \"John Smith insurance corporation\"\n description: Filter by business DBA name, search for complete or partial string.\n website:\n type: string\n example: \"example.com\"\n description: Filter by website, search for complete or partial string.\n created_from:\n type: string\n format: date-time\n description: Search users created on this date and onwards.\n example: 2012-05-04T19:42:32.987Z\n created_to:\n type: string\n format: date-time\n description: Search users created prior to this date.\n example: 2012-05-04T19:42:32.987Z\n modified_from:\n type: string\n format: date-time\n description: Search users modified on this date and onwards.\n example: 2012-05-04T19:42:32.987Z\n modified_to:\n type: string\n format: date-time\n description: Search users modified prior to this date.\n example: 2012-05-04T19:42:32.987Z\n limit:\n type: integer\n description: This is the maximum number of objects that may be returned. A query may return fewer than the value\n of limit once reached the end of the list of data.\n example: \"10\"\n after:\n type: string\n description: This is the cursor that points to the end of the page of data that has been returned.\n example: \"MTA=\"\n sort_by:\n type: string\n description: The way results should be sorted.\n example: \"created\"\n order_by:\n description: The way results should be ordered.\n $ref: \"#/definitions/SortDirection\"\n\n User:\n type: object\n properties:\n id:\n type: string\n description: |\n ID parameter serves as the unique identifier of the user. If it is not included in the 'Create user' request, then the\n system generates it automatically. This field is used in other API calls to identify the user and\n cannot be updated.\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n title:\n description: |\n Title of a person. Possible values are MR/MRS/MISS.\n $ref: \"#/definitions/UserTitle\"\n first_name:\n description: |\n User's first name.\n example: \"John\"\n type: string\n middle_name:\n description: |\n User's middle name.\n example: \"Anthony\"\n type: string\n last_name:\n description: |\n User's last name.\n example: \"Smith\"\n type: string\n native_name:\n description: |\n Native name of the user.\n example: \"John Smith\"\n type: string\n native_last_name:\n description: Native last name.\n example: \"Júañ Hérreró\"\n maxLength: 60\n type: string\n date_of_birth:\n type: string\n description: |\n The date of birth of the user in the following format - yyyy-mm-dd.\n format: date\n example: \"2012-05-04\"\n email:\n description: |\n A valid email address for the user.\n example: \"bob@example.com\"\n maxLength: 255\n type: string\n mobile:\n description: |\n Mobile number of the user (including area code), appended with \"+\" symbol and the first three digits to identify the country calling code. Please do not include hyphens, spaces or parentheses.\n example: \"+551185249635\"\n type: string\n address:\n $ref: \"#/definitions/Address\"\n gender:\n $ref: \"#/definitions/UserGender\"\n education_level:\n description: |\n Education level.\n example: \"Graduate\"\n type: string\n maxLength: 50\n preferred_language:\n description: |\n A selected language for 3D Secure and digital wallet token notifications sent to this user. By default, notifications are sent in English. The supported value should be provided in ISO language format.\n example: EN\n type: string\n place_of_birth:\n description: |\n The place of birth of the user. The format should be ISO alpha 3-character country code.\n example: USA\n type: string\n place_of_birth_city:\n type: string\n maxLength: 50\n description: The city of birth.\n example: \"Toronto\"\n nationality:\n description: |\n Nationality; must be one of ISO alpha 3-character country code.\n example: USA\n type: string\n parent_user_id:\n description: |\n Unique identifier of parent user\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n type: string\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2012-05-04T19:42:32.987Z\"\n created_by:\n description: |\n Identifier of user's creator.\n type: string\n maxLength: 50\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n modified_by:\n type: string\n maxLength: 50\n description: This field indicates the user who executed the operation.\n default: \"API\"\n country_residence:\n type: string\n maxLength: 3\n description: |\n The country where the individual user resides or is currently citizen of. The format is ISO alpha 3-character country code.\n example: \"USA\"\n x-nymos-country: true\n country_tax_residence:\n type: string\n maxLength: 3\n description: |\n The country for which the tax rules apply to the individual/business user and the user pays tax according to it. The format is ISO alpha 3-character country code.\n example: \"USA\"\n x-nymos-country: true\n employment_type:\n description: |\n The employment type of the individual user.\n $ref: \"#/definitions/EmploymentType\"\n employment_title:\n type: string\n example: \"QAE\"\n description: |\n The job title (designation) for user_type = INDIVIDUAL. For user_type = BUSINESS this field can give the designation of the primary contact person of the business.\n maxLength: 50\n monthly_salary:\n type: number\n minimum: 0\n example: \"12000\"\n description: |\n The monthly salary of the user_type = INDIVIDUAL.\n company_name:\n type: string\n example: \"Example\"\n description: |\n The company name for which the individual works for in case of SALARIED OR company name that the individual runs in case of SELF-EMPLOYED or BUSINESS_OWNER. This parameter is required if \"employment_type\" = 'SALARIED\", \"EMPLOYED\" or \"BUSINESS_OWNER\".\n maxLength: 200\n company_address:\n type: object\n description: |\n The company name for which the individual works for in case of SALARIED OR company name that the individual runs in case of SELF-EMPLOYED OR BUSINESS_OWNER.\n $ref: \"#/definitions/Address\"\n company_country:\n type: string\n maxLength: 3\n description: |\n Company country in format of ISO alpha 3-character country code. For user_type = INDIVIDUAL this field indicates the country in which the company is registered and conducts its business and activities.\n For user_type = BUSINESS this field indicates the country in which the business is registered and conducts its activities.\n example: \"USA\"\n x-nymos-country: true\n industry_type:\n type: object\n description: |\n For user_type = INDIVIDUAL and employment_type = SALARIED or employment_type = SELF-EMPLOYED or employment_type = BUSINESS_OWNER, for the individual who is employed in a company or running a company this field indicates the type of the industry in which the company operates.\n For user_type = BUSINESS, this field indicates the type of the industry in which the business operates.\n $ref: \"#/definitions/IndustryType\"\n expected_monthly_balance:\n type: number\n minimum: 0\n example: \"100000\"\n description: |\n For user_type = INDIVIDUAL this field indicates the expected monthly balance the individual user is planning to maintain in his accounts.\n For user_type = BUSINESS this field indicates the expected monthly balance the business is planning to maintain in its accounts.\n relationship_with_parent:\n type: object\n description: |\n For a child user this field indicates the relationship of the child user with the parent user. This field is allowed to be filled only in case of child user.\n $ref: \"#/definitions/RelationshipWithParent\"\n user_type:\n type: object\n description: |\n This parameter indicates type of the user. The default value 'INDIVIDUAL' is used if the parameter value is not explicitly specified in the received request.\n $ref: \"#/definitions/UserType\"\n business_legal_name:\n type: string\n example: \"Insurance corporation\"\n description: |\n The business legal name. This field may be used for KYB verification. Applicable for 'user_type' = BUSINESS.\n maxLength: 200\n business_dba_name:\n type: string\n example: \"John Smith insurance corporation\"\n description: |\n The business’s secondary name. This field may be used for KYB verification, if the business name is different from the legal business name. Applicable for 'user_type' = BUSINESS.\n maxLength: 50\n date_established:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The established date and time. Applicable for 'user_type' = BUSINESS.\n phone_number:\n example: \"+551185249635\"\n pattern: '^\\+\\d+'\n type: string\n description: The telephone number.\n website:\n type: string\n maxLength: 50\n description: The website. Applicable for 'user_type' = BUSINESS.\n example: \"example.com\"\n status:\n $ref: '#/definitions/UserStatus'\n status_reason_code:\n $ref: '#/definitions/UserStatusReasonCode'\n kyc_policy_passed:\n $ref: '#/definitions/SupportedKycPolicies'\n designation:\n type: string\n maxLength: 50\n example: CEO\n description: |\n It is mandatory to provide this parameter if 'user_type' is DIRECTOR or SIGNATURE. The valid designation should be provided, such as: CEO, CPO, CEO - (region name).\n shares_percentage:\n type: number\n format: float\n example: 100\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.\n share_controller_name:\n type: string\n maxLength: 100\n example: Nabil Benaissa\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.\n local_address:\n $ref: \"#/definitions/Address\"\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER.\n incorporation_type:\n $ref: '#/definitions/UserIncorporationType'\n description: This indicates whether this business entity is Limited, LLC, Free-zone or anything else.\n entity_registered_no:\n type: string\n maxLength: 50\n example: \"2233445533\"\n description: This parameter describes the business/entity registered number.\n old_entity_name:\n type: string\n maxLength: 50\n example: \"Old name\"\n description: This parameter describes the business’s old name.\n old_entity_ops_start_date:\n type: string\n format: date-time\n description: It is the start date when the business was operated under old name.\n example: \"2012-05-04\"\n old_entity_ops_end_date:\n type: string\n format: date-time\n description: It is the end date when the business was operated under old name.\n example: \"2014-05-04\"\n regulated_entity:\n type: boolean\n description: This parameter indicates if the entity is a regulated entity or no. Possible values are true/false.\n regulator_name:\n type: string\n maxLength: 50\n example: \"ABC\"\n description: This parameter indicates the regulator’s name. It is applicable if 'regulated_entity' parameter is set as 'true'.\n business_activities:\n type: string\n maxLength: 1000\n example: \"IT Services\"\n description: |\n This parameter describes the business/entity activities such as Payment Service Provider, IT service provider etc. It can be a comma separated values.\n other_operated_countries:\n type: string\n example: \"US\"\n description: This parameter indicates the valid country's name(s), where the business is operated.\n tax_residence_country:\n type: string\n example: \"UAE\"\n maxLength: 50\n description: This parameter indicates the name of a country, where the business has a tax residence.\n tin:\n type: string\n example: \"1122334455\"\n maxLength: 50\n description: Tax identification number.\n external_auditor_name:\n type: string\n example: \"ABC\"\n maxLength: 50\n description: Name of the external auditor.\n director_list:\n type: array\n items:\n type: string\n example: \"director_id1\"\n description: The list of directors. Up to 10 directors can be linked to a business user; but directors should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n signature_list:\n type: array\n items:\n type: string\n example: \"signature_id1\"\n description: The list of signatures. Up to 10 signatures can be linked to a business user; but the signatures should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n shareholder_list:\n type: array\n items:\n type: string\n example: \"shareholder_id1\"\n description: The list of shareholders. Up to 50 shareholders can be linked to a business user; but the shareholders should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n company_onbehalf:\n type: boolean\n description: This parameter indicates if the company is opened on behalf of another person. Possible values are true/false.\n company_onbehalf_relation:\n type: string\n example: \"John Smith\"\n maxLength: 50\n description: In this parameter you should confirm the relationship of the beneficial owner. It is applicable if 'company_onbehalf' parameter is set as 'true'.\n group_additional_info:\n $ref: '#/definitions/UserGroupAdditionalInfo'\n pep_check_info:\n $ref: '#/definitions/UserPepCheckInfo'\n no_of_employees:\n $ref: '#/definitions/UserNoOfEmployees'\n accept_cash_check:\n type: boolean\n description: This parameter indicates whether the corporate company accepts cash from end users or not. Possible values are true/false.\n annual_turnover:\n type: number\n description: This parameter describes the annual turnover of the business entity.\n source_of_funds:\n type: string\n example: \"Business\"\n maxLength: 50\n description: This parameter describes how is the company being funded.\n source_fund_uae:\n type: boolean\n description: This parameter indicates whether the business source of funds is derived from outside of the UAE or no. Possible values are true/false.\n due_diligence_declaration:\n $ref: '#/definitions/UserDueDiligenceDeclaration'\n license_type:\n type: string\n maxLength: 100\n example: \"Test License Updated\"\n description: The license type. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.\n license_expiry:\n type: string\n format: date\n example: \"2025-06-06\"\n description: The license expiry. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.\n estimated_activity_through_nymcard:\n type: string\n example: \"ABCD\"\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n expected_number_of_cards:\n type: integer\n format: int32\n minimum: 0\n example: \"1\"\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n expected_use_of_ncs_services:\n type: string\n example: \"ABCD\"\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n custom_info:\n type: object\n additionalProperties:\n type: string\n description: This parameter holds additional fields configured in tenant settings. This parameter is optional.\n\n UserGender:\n type: string\n description: The gender of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n enum:\n - MALE\n - FEMALE\n\n UserCreateRequest:\n type: object\n required:\n - first_name\n properties:\n id:\n type: string\n description: Unique identifier of the user. If this information is not present in the request, the system generates one automatically. Please note that this token ID is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n title:\n description: |\n Title of a person. Possible values are MR/MRS/MISS.\n $ref: \"#/definitions/UserTitle\"\n first_name:\n description: |\n User's first name. This parameter is optional for 'user_type'=BUSINESS. Note, that when you want to simulate an Identity Verification process, please provide both the user's 'first_name' and 'last_name' parameters. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"John\"\n maxLength: 60\n type: string\n middle_name:\n description: |\n User's middle name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"Anthony\"\n maxLength: 60\n type: string\n last_name:\n description: |\n User's last name. This parameter is mandatory to provide when Identity verification is required. Note, that when you want to simulate an Identity Verification process, please provide both the user's 'first_name' and 'last_name' parameters. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"Smith\"\n maxLength: 60\n type: string\n native_name:\n description: |\n Native name of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"John Smith\"\n maxLength: 60\n type: string\n native_last_name:\n description: Native last name.\n example: \"Júañ Hérreró\"\n maxLength: 60\n type: string\n date_of_birth:\n type: string\n description: |\n The date of birth of the user in the following format - yyyy-mm-dd. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n format: date\n example: \"2012-05-04\"\n email:\n description: |\n A valid email address for the user.\n example: \"bob@example.com\"\n type: string\n maxLength: 255\n mobile:\n description: |\n Mobile number of the user (including area code), appended with \"+\" symbol and the first three digits to identify the country calling code. Please do not include hyphens, spaces or parentheses.\n example: \"+551185249635\"\n type: string\n address:\n $ref: \"#/definitions/Address\"\n gender:\n $ref: \"#/definitions/UserGender\"\n education_level:\n description: |\n Education level.\n example: \"Graduate\"\n type: string\n maxLength: 50\n preferred_language:\n description: |\n A selected language for 3D Secure and digital wallet token notifications sent to this user. By default, notifications are sent in English. The supported value should be provided in ISO language format.\n example: EN\n type: string\n place_of_birth:\n description: |\n The place of birth of the user. The format should be ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: USA\n type: string\n place_of_birth_city:\n type: string\n maxLength: 50\n description: The city of birth.\n example: \"Toronto\"\n nationality:\n description: |\n Nationality; must be one of ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: USA\n type: string\n parent_user_id:\n description: |\n Unique identifier of parent user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n type: string\n created_by:\n description: |\n Identifier of user's creator.\n type: string\n maxLength: 50\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n country_residence:\n type: string\n maxLength: 3\n description: |\n The country where the individual user resides or is currently citizen of. The format is ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"USA\"\n x-nymos-country: true\n country_tax_residence:\n type: string\n maxLength: 3\n description: |\n The country for which the tax rules apply to the individual/business user and the user pays tax according to it. The format is ISO alpha 3-character country code.\n example: \"USA\"\n x-nymos-country: true\n employment_type:\n description: |\n The employment type of the individual user.\n $ref: \"#/definitions/EmploymentType\"\n employment_title:\n type: string\n example: \"QAE\"\n description: |\n The job title (designation) for user_type = INDIVIDUAL. For user_type = BUSINESS this field can give the designation of the primary contact person of the business.\n maxLength: 50\n monthly_salary:\n type: number\n minimum: 0\n example: \"12000\"\n description: |\n The monthly salary of the user_type = INDIVIDUAL.\n company_name:\n type: string\n example: \"Example\"\n description: |\n The company name for which the individual works for in case of SALARIED or company name that the individual runs in case of SELF-EMPLOYED or BUSINESS_OWNER. This parameter is required if \"employment_type\" = 'SALARIED\", \"EMPLOYED\" or \"BUSINESS_OWNER\".\n maxLength: 200\n company_address:\n type: object\n description: |\n The company name for which the individual works for in case of SALARIED or company name that the individual runs in case of SELF-EMPLOYED or BUSINESS_OWNER.\n $ref: \"#/definitions/Address\"\n company_country:\n type: string\n maxLength: 3\n description: |\n Company country in format of ISO alpha 3-character country code. For user_type = INDIVIDUAL this field indicates the country in which the company is registered and conducts its business and activities.\n For user_type = BUSINESS this field indicates the country in which the business is registered and conducts its activities.\n example: \"USA\"\n x-nymos-country: true\n industry_type:\n type: object\n description: |\n For user_type = INDIVIDUAL and employment_type = SALARIED or employment_type = SELF-EMPLOYED or employment_type = BUSINESS_OWNER, for the individual who is employed in a company or running a company this field indicates the type of the industry in which the company operates.\n For user_type = BUSINESS, this field indicates the type of the industry in which the business operates.\n $ref: \"#/definitions/IndustryType\"\n expected_monthly_balance:\n type: number\n minimum: 0\n example: \"100000\"\n description: |\n For user_type = INDIVIDUAL this field indicates the expected monthly balance the individual user is planning to maintain in his accounts.\n For user_type = BUSINESS this field indicates the expected monthly balance the business is planning to maintain in its accounts.\n relationship_with_parent:\n type: object\n description: |\n For a child user this field indicates the relationship of the child user with the parent user. This field is allowed to be filled only in case of child user.\n $ref: \"#/definitions/RelationshipWithParent\"\n user_type:\n type: object\n description: |\n This parameter indicates type of the user. The default value 'INDIVIDUAL' should be used if the parameter value is not explicitly specified in the received request.\n $ref: \"#/definitions/UserType\"\n business_legal_name:\n type: string\n example: \"Insurance corporation\"\n description: |\n The business legal name. This field may be used for KYB verification. Applicable for 'user_type' = BUSINESS.\n maxLength: 200\n business_dba_name:\n type: string\n example: \"John Smith insurance corporation\"\n description: |\n The business’s secondary name. This field may be used for KYB verification, if the business name is different from the legal business name. Applicable for 'user_type' = BUSINESS.\n maxLength: 50\n date_established:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The established date and time. Applicable for 'user_type' = BUSINESS.\n phone_number:\n example: \"+551185249635\"\n pattern: '^\\+\\d+'\n description: The telephone number.\n type: string\n website:\n type: string\n maxLength: 50\n example: \"example.com\"\n description: The website. Applicable for 'user_type' = BUSINESS.\n designation:\n type: string\n maxLength: 50\n example: CEO\n description: |\n It is mandatory to provide this parameter if 'user_type' is DIRECTOR or SIGNATURE. The valid designation should be provided, such as: CEO, CPO, CEO - (region name).\n shares_percentage:\n type: number\n format: float\n example: 100\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.\n share_controller_name:\n type: string\n maxLength: 100\n example: Nabil Benaissa\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.\n local_address:\n $ref: \"#/definitions/Address\"\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER.\n incorporation_type:\n $ref: '#/definitions/UserIncorporationType'\n description: This indicates whether this business entity is Limited, LLC, Free-zone or anything else.\n entity_registered_no:\n type: string\n maxLength: 50\n example: \"2233445533\"\n description: This parameter describes the business/entity registered number.\n old_entity_name:\n type: string\n maxLength: 50\n example: \"Old name\"\n description: This parameter describes the business’s old name.\n old_entity_ops_start_date:\n type: string\n format: date-time\n description: It is the start date when the business was operated under old name.\n example: \"2012-05-04\"\n old_entity_ops_end_date:\n type: string\n format: date-time\n description: It is the end date when the business was operated under old name.\n example: \"2014-05-04\"\n regulated_entity:\n type: boolean\n description: This parameter indicates if the entity is a regulated entity or no. Possible values are true/false.\n regulator_name:\n type: string\n maxLength: 50\n example: \"ABC\"\n description: This parameter indicates the regulator’s name. It is applicable if 'regulated_entity' parameter is set as 'true'.\n business_activities:\n type: string\n maxLength: 1000\n example: \"IT Services\"\n description: |\n This parameter describes the business/entity activities such as Payment Service Provider, IT service provider etc. It can be a comma separated values.\n other_operated_countries:\n type: string\n example: \"US\"\n description: This parameter indicates the valid country's name(s), where the business is operated.\n tax_residence_country:\n type: string\n example: \"UAE\"\n maxLength: 50\n description: This parameter indicates the name of a country, where the business has a tax residence.\n tin:\n type: string\n example: \"1122334455\"\n maxLength: 50\n description: Tax identification number.\n external_auditor_name:\n type: string\n example: \"ABC\"\n maxLength: 50\n description: Name of the external auditor.\n director_list:\n type: array\n items:\n type: string\n example: \"director_id1\"\n description: The list of directors. Up to 10 directors can be linked to a business user; but directors should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n signature_list:\n type: array\n items:\n type: string\n example: \"signature_id1\"\n description: The list of signatures. Up to 10 signatures can be linked to a business user; but the signatures should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n shareholder_list:\n type: array\n items:\n type: string\n example: \"shareholder_id1\"\n description: The list of shareholders. Up to 50 shareholders can be linked to a business user; but the shareholders should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n company_onbehalf:\n type: boolean\n description: This parameter indicates if the company is opened on behalf of another person. Possible values are true/false.\n company_onbehalf_relation:\n type: string\n example: \"John Smith\"\n maxLength: 50\n description: In this parameter you should confirm the relationship of the beneficial owner. It is applicable if 'company_onbehalf' parameter is set as 'true'.\n group_additional_info:\n $ref: '#/definitions/UserGroupAdditionalInfo'\n pep_check_info:\n $ref: '#/definitions/UserPepCheckInfo'\n no_of_employees:\n $ref: '#/definitions/UserNoOfEmployees'\n accept_cash_check:\n type: boolean\n description: This parameter indicates whether the corporate company accepts cash from end users or not. Possible values are true/false.\n annual_turnover:\n type: number\n description: This parameter describes the annual turnover of the business entity.\n source_of_funds:\n type: string\n maxLength: 50\n example: \"Business\"\n description: This parameter describes how is the company being funded.\n source_fund_uae:\n type: boolean\n description: This parameter indicates whether the business source of funds is derived from outside of the UAE or no. Possible values are true/false.\n due_diligence_declaration:\n $ref: '#/definitions/UserDueDiligenceDeclaration'\n license_type:\n type: string\n maxLength: 100\n example: \"Test License Updated\"\n description: The license type. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.\n license_expiry:\n type: string\n format: date\n example: \"2025-06-06\"\n description: The license expiry. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.\n estimated_activity_through_nymcard:\n type: string\n example: \"ABCD\"\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n expected_number_of_cards:\n type: integer\n format: int32\n example: \"1\"\n minimum: 0\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n expected_use_of_ncs_services:\n type: string\n example: \"ABCD\"\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n custom_info:\n type: object\n additionalProperties:\n type: string\n description: This parameter holds additional fields configured in tenant settings. This parameter is optional.\n\n UserUpdateRequest:\n type: object\n description: |\n This model allows the user to perform updates on user.\n properties:\n title:\n description: |\n Title of a person. Possible values are MR/MRS/MISS.\n $ref: \"#/definitions/UserTitle\"\n first_name:\n description: |\n User's first name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"John\"\n type: string\n middle_name:\n description: |\n User's middle name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"Anthony\"\n type: string\n last_name:\n description: |\n User's last name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"Smith\"\n type: string\n native_name:\n description: |\n Native name of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"John Smith\"\n type: string\n native_last_name:\n description: Native last name.\n example: \"Júañ Hérreró\"\n maxLength: 60\n type: string\n date_of_birth:\n type: string\n description: |\n The date of birth of the user in the following format - yyyy-mm-dd. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n format: date\n example: \"2012-05-04\"\n email:\n description: |\n A valid email address for the user.\n example: \"bob@example.com\"\n type: string\n maxLength: 255\n mobile:\n description: |\n Mobile number of the user (including area code), appended with \"+\" symbol and the first three digits to identify the country calling code. Please do not include hyphens, spaces or parentheses.\n example: \"+551185249635\"\n type: string\n address:\n $ref: \"#/definitions/Address\"\n gender:\n $ref: \"#/definitions/UserGender\"\n education_level:\n description: |\n Education level.\n example: \"Graduate\"\n type: string\n maxLength: 50\n preferred_language:\n description: |\n A selected language for 3D Secure and digital wallet token notifications sent to this user. By default, notifications are sent in English. The supported value should be provided in ISO language format.\n example: EN\n type: string\n place_of_birth:\n description: |\n The place of birth of the user. The format should be ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: USA\n type: string\n place_of_birth_city:\n type: string\n maxLength: 50\n description: The city of birth.\n example: \"Toronto\"\n nationality:\n description: |\n Nationality; must be one of ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: USA\n type: string\n parent_user_id:\n description: |\n Unique identifier of parent user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n type: string\n country_residence:\n type: string\n maxLength: 3\n description: |\n The country where the individual user resides or is currently citizen of. The format is ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.\n example: \"USA\"\n x-nymos-country: true\n country_tax_residence:\n type: string\n maxLength: 3\n description: |\n The country for which the tax rules apply to the individual/business user and the user pays tax according to it. The format is ISO alpha 3-character country code.\n example: \"USA\"\n x-nymos-country: true\n employment_type:\n description: |\n The employment type of the individual user.\n $ref: \"#/definitions/EmploymentType\"\n employment_title:\n type: string\n example: \"QAE\"\n description: |\n The job title (designation) for user_type = INDIVIDUAL. For user_type = BUSINESS this field can give the designation of the primary contact person of the business.\n maxLength: 50\n monthly_salary:\n type: number\n minimum: 0\n example: \"12000\"\n description: |\n The monthly salary of the user_type = INDIVIDUAL.\n company_name:\n type: string\n example: \"Example\"\n description: |\n The company name for which the individual works for in case of SALARIED OR company name that the individual runs in case of SELF-EMPLOYED OR BUSINESS_OWNER. This parameter is required if \"employment_type\" = 'SALARIED\", \"EMPLOYED\" or \"BUSINESS_OWNER\".\n maxLength: 200\n company_address:\n type: object\n description: |\n The company name for which the individual works for in case of SALARIED OR company name that the individual runs in case of SELF-EMPLOYED OR BUSINESS_OWNER.\n $ref: \"#/definitions/Address\"\n company_country:\n type: string\n maxLength: 3\n description: |\n Company country in format of ISO alpha 3-character country code. For user_type = INDIVIDUAL this field indicates the country in which the company is registered and conducts its business and activities.\n For user_type = BUSINESS this field indicates the country in which the Business is registered and conducts its activities.\n example: \"USA\"\n x-nymos-country: true\n industry_type:\n type: object\n description: |\n For user_type = INDIVIDUAL and employment_type = SALARIED or employment_type = SELF-EMPLOYED or employment_type = BUSINESS_OWNER, for the individual who is employed in a company or running a company this field indicates the type of the industry in which the company operates.\n For user_type = BUSINESS, this field indicates the type of the industry in which the business operates.\n $ref: \"#/definitions/IndustryType\"\n expected_monthly_balance:\n type: number\n minimum: 0\n example: \"100000\"\n description: |\n For user_type = INDIVIDUAL this field indicates the expected monthly balance the individual user is planning to maintain in his accounts.\n For user_type = BUSINESS this field indicates the expected monthly balance the business is planning to maintain in its accounts.\n relationship_with_parent:\n type: object\n description: |\n For a child user this field indicates the relationship of the child user with the parent user. This field is allowed to be filled only in case of child user.\n $ref: \"#/definitions/RelationshipWithParent\"\n business_legal_name:\n type: string\n example: \"Insurance corporation\"\n description: |\n The business legal name. This field may be used for KYB verification. Applicable for 'user_type' = BUSINESS.\n maxLength: 200\n business_dba_name:\n type: string\n example: \"John Smith insurance corporation\"\n description: |\n The business’s secondary name. This field may be used for KYB verification, if the business name is different from the legal business name. Applicable for 'user_type' = BUSINESS.\n maxLength: 50\n date_established:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The established date and time. Applicable for 'user_type' = BUSINESS.\n phone_number:\n example: \"+551185249635\"\n pattern: '^\\+\\d+'\n type: string\n description: The telephone number.\n website:\n type: string\n maxLength: 50\n example: \"example.com\"\n description: The website. Applicable for 'user_type' = BUSINESS.\n designation:\n type: string\n maxLength: 50\n example: CEO\n description: |\n It is mandatory to provide this parameter if 'user_type' is DIRECTOR or SIGNATURE. The valid designation should be provided, such as: CEO, CPO, CEO - (region name).\n shares_percentage:\n type: number\n format: float\n example: 100\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.\n share_controller_name:\n type: string\n maxLength: 100\n example: Nabil Benaissa\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.\n local_address:\n $ref: \"#/definitions/Address\"\n description: It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER.\n incorporation_type:\n $ref: '#/definitions/UserIncorporationType'\n description: This indicates whether this business entity is Limited, LLC, Free-zone or anything else.\n entity_registered_no:\n type: string\n maxLength: 50\n example: \"2233445533\"\n description: This parameter describes the business/entity registered number.\n old_entity_name:\n type: string\n maxLength: 50\n example: \"Old name\"\n description: This parameter describes the business’s old name.\n old_entity_ops_start_date:\n type: string\n format: date-time\n description: It is the start date when the business was operated under old name.\n example: \"2012-05-04\"\n old_entity_ops_end_date:\n type: string\n format: date-time\n description: It is the end date when the business was operated under old name.\n example: \"2014-05-04\"\n regulated_entity:\n type: boolean\n description: This parameter indicates if the entity is a regulated entity or no. Possible values are true/false.\n regulator_name:\n type: string\n maxLength: 50\n example: \"ABC\"\n description: This parameter indicates the regulator’s name. It is applicable if 'regulated_entity' parameter is set as 'true'.\n business_activities:\n type: string\n maxLength: 1000\n example: \"IT Services\"\n description: |\n This parameter describes the business/entity activities such as Payment Service Provider, IT service provider etc. It can be a comma separated values.\n other_operated_countries:\n type: string\n example: \"US\"\n description: This parameter indicates the valid country's name(s), where the business is operated.\n tax_residence_country:\n type: string\n example: \"UAE\"\n maxLength: 50\n description: This parameter indicates the name of a country, where the business has a tax residence.\n tin:\n type: string\n example: \"1122334455\"\n maxLength: 50\n description: Tax identification number.\n external_auditor_name:\n type: string\n example: \"ABC\"\n maxLength: 50\n description: Name of the external auditor.\n director_list:\n type: array\n items:\n type: string\n example: \"director_id1\"\n description: The list of directors. Up to 10 directors can be linked to a business user; but directors should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n signature_list:\n type: array\n items:\n type: string\n example: \"signature_id1\"\n description: The list of signatures. Up to 10 signatures can be linked to a business user; but the signatures should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n shareholder_list:\n type: array\n items:\n type: string\n example: \"shareholder_id1\"\n description: The list of shareholders. Up to 50 shareholders can be linked to a business user; but the shareholders should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.\n company_onbehalf:\n type: boolean\n description: This parameter indicates if the company is opened on behalf of another person. Possible values are true/false.\n company_onbehalf_relation:\n type: string\n maxLength: 50\n example: \"John Smith\"\n description: In this parameter you should confirm the relationship of the beneficial owner. It is applicable if 'company_onbehalf' parameter is set as 'true'.\n group_additional_info:\n $ref: '#/definitions/UserGroupAdditionalInfo'\n pep_check_info:\n $ref: '#/definitions/UserPepCheckInfo'\n no_of_employees:\n $ref: '#/definitions/UserNoOfEmployees'\n accept_cash_check:\n type: boolean\n description: This parameter indicates whether the corporate company accepts cash from end users or not. Possible values are true/false.\n annual_turnover:\n type: number\n description: This parameter describes the annual turnover of the business entity.\n source_of_funds:\n type: string\n maxLength: 50\n example: \"Business\"\n description: This parameter describes how is the company being funded.\n source_fund_uae:\n type: boolean\n description: This parameter indicates whether the business source of funds is derived from outside of the UAE or no. Possible values are true/false.\n due_diligence_declaration:\n $ref: '#/definitions/UserDueDiligenceDeclaration'\n license_type:\n type: string\n maxLength: 100\n example: \"Test License Updated\"\n description: The license type. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.\n license_expiry:\n type: string\n format: date\n example: \"2025-06-06\"\n description: The license expiry. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.\n estimated_activity_through_nymcard:\n type: string\n example: \"ABCD\"\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n expected_number_of_cards:\n type: integer\n format: int32\n example: \"1\"\n minimum: 0\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n expected_use_of_ncs_services:\n type: string\n example: \"ABCD\"\n description: This parameter is optional and applicable for 'user_type' = BUSINESS.\n custom_info:\n type: object\n additionalProperties:\n type: string\n description: This parameter holds additional fields configured in tenant settings. This parameter is optional.\n\n UserType:\n type: string\n description: The type of the user. You can find all necessary fields per each user type in this GSG doc - https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type.\n enum:\n - INDIVIDUAL # default value\n - BUSINESS\n - DIRECTOR\n - SIGNATURE\n - SHAREHOLDER\n - SHAREHOLDER_BUSINESS\n\n EmploymentType:\n type: string\n description: The employment type of the individual user.\n enum:\n - SALARIED\n - SELF_EMPLOYED\n - RETIRED\n - NOT_EMPLOYED\n - BUSINESS_OWNER\n - STUDENT\n - HOMEMAKER\n - OTHER\n\n IndustryType:\n type: string\n enum:\n - I01 # Gambling/Casinos\n - I02 # Defence/Military goods or Arms Dealers and Manufacturers\n - I03 # Exchange Companies / Bureaus de Change, Money Changers, Hawala dealers / Other Finance Companies (For e.g. Derivatives Trading, Hedge Funds, Unregistered/Pvt Collective Investment Schemes)\n - I04 # Real Estate Brokers / Real Estate Agencies / Real Estate Developers (Non-Govt)\n - I05 # Charity Organizations, Religious/Social/Non-Profit Organizations, Cooperative/Social/Professional Societies & associations\n - I06 # Auction Houses\n - I07 # Dealers in Luxury Goods: (Definition of Luxury Goods include: Precious metals & Stones, Jewelry & Antiques, Art, Furs, Yachts , Executive/Private Jets)\n - I08 # Trust Service Providers, Lawyers, Accountants, Tax Advisers, Auditors\n - I09 # Private Banking Relationship\n - I11 # Agriculture, Forestry, Fishing, and Hunting\n - I12 # Mining, Quarrying, and Oil and Gas Extraction\n - I13 # Utilities (water, gas, electricity)\n - I14 # Telecommunications\n - I15 # Construction\n - I16 # Manufacturing\n - I17 # Wholesale Trade\n - I18 # Retail Trade and Commerce\n - I19 # Transportation and Warehousing\n - I20 # Technology\n - I21 # Finance and Insurance\n - I22 # Real Estate and Rental and Leasing\n - I23 # Professional, Scientific, and Technical Services\n - I24 # Management of Companies and Enterprises\n - I25 # Educational Services\n - I26 # Health Care and Social Assistance\n - I27 # Arts, Entertainment, and Recreation\n - I28 # Hotels and Food Services\n - I29 # Public Administration\n - I30 # Administrative and Support and Waste Management\n - I00 # Other\n description: >\n Type of industry:\n * `I01`: Gambling/Casinos\n * `I02`: Defence/Military goods or Arms Dealers and Manufacturers\n * `I03`: Exchange Companies / Bureaus de Change, Money Changers, Hawala dealers / Other Finance Companies (For e.g. Derivatives Trading, Hedge Funds, Unregistered/Pvt Collective Investment Schemes)\n * `I04`: Real Estate Brokers / Real Estate Agencies / Real Estate Developers (Non * Govt)\n * `I05`: Charity Organizations, Religious/Social/Non * Profit Organizations, Cooperative/Social/Professional Societies & associations\n * `I06`: Auction Houses\n * `I07`: Dealers in Luxury Goods: (Definition of Luxury Goods include: Precious metals & Stones, Jewelry & Antiques, Art, Furs, Yachts , Executive/Private Jets)\n * `I08`: Trust Service Providers, Lawyers, Accountants, Tax Advisers, Auditors\n * `I09`: Private Banking Relationship\n * `I11`: Agriculture, Forestry, Fishing, and Hunting\n * `I12`: Mining, Quarrying, and Oil and Gas Extraction\n * `I13`: Utilities (water, gas, electricity)\n * `I14`: Telecommunications\n * `I15`: Construction\n * `I16`: Manufacturing\n * `I17`: Wholesale Trade\n * `I18`: Retail Trade and Commerce\n * `I19`: Transportation and Warehousing\n * `I20`: Technology\n * `I21`: Finance and Insurance\n * `I22`: Real Estate and Rental and Leasing\n * `I23`: Professional, Scientific, and Technical Services\n * `I24`: Management of Companies and Enterprises\n * `I25`: Educational Services\n * `I26`: Health Care and Social Assistance\n * `I27`: Arts, Entertainment, and Recreation\n * `I28`: Hotels and Food Services\n * `I29`: Public Administration\n * `I30`: Administrative and Support and Waste Management\n * `I00`: Other\n\n RelationshipWithParent:\n type: string\n description: For a child user this field indicates the relationship of the child user with the parent user.\n enum:\n - SON\n - DAUGHTER\n - NEPHEW\n - NIECE\n - HUSBAND\n - WIFE\n - FATHER\n - MOTHER\n - EMPLOYEE\n - OTHER\n\n UserTitle:\n type: string\n description: The user's title/prefix.\n enum:\n - MR\n - MRS\n - MISS\n\n Address:\n type: object\n description: The details of the address. \"ADDRESS\" parameter stands for user's address. \"COMPANY_ADDRESS\" parameter stands for company's address. \"LOCAL_ADDRESS\" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide \"LOCAL_ADDRESS\" parameter if 'user_type' is SHAREHOLDER.\n properties:\n address_line1:\n type: string\n maxLength: 100\n description: |\n Address Line 1.\n example: \"Flat 1904\"\n address_line2:\n type: string\n maxLength: 100\n description: |\n Address Line 2.\n example: \"Glass Tower\"\n city:\n type: string\n maxLength: 50\n description: |\n City.\n example: \"New York City\"\n state:\n type: string\n maxLength: 50\n description: |\n State.\n example: \"New York\"\n postal_code:\n type: string\n maxLength: 10\n description: |\n Postal code.\n example: \"12345\"\n country:\n type: string\n maxLength: 3\n description: |\n Country; must be one of ISO alpha 3-character country code.\n example: \"USA\"\n nearest_place:\n type: string\n maxLength: 100\n description: |\n Nearest place.\n example: \"Burj Khalifa\"\n\n\n Identification:\n type: object\n properties:\n id:\n type: string\n description: Identification ID\n example: \"3e9392df-4093-4389-a0ad-92456a181b8a\"\n type:\n $ref: \"#/definitions/IdentificationType\"\n title:\n type: string\n maxLength: 40\n example: \"SELFIE\"\n description: The document title.\n user_id:\n type: string\n example: \"132123123\"\n description: Unique identifier of the user.\n number:\n type: string\n example: \"132123123\"\n description: The document number.\n issuance_authority:\n type: string\n example: \"Ministry of defense\"\n description: The name of issuance authority.\n place_of_issuance:\n type: string\n example: \"Lebanon\"\n description: The place of issuance.\n issuance_date:\n type: string\n format: date-time\n description: The issuance date of the document.\n example: \"2012-05-04T19:42:32.987Z\"\n expiration_date:\n type: string\n format: date-time\n description: The expiration date of the document.\n example: \"2012-05-04T19:42:32.987Z\"\n document_status:\n $ref: \"#/definitions/IdentificationStatus\"\n document_status_reason:\n $ref: \"#/definitions/IdentificationStatusReasonCode\"\n files:\n type: array\n description: An array of file upload data.\n items:\n $ref: \"#/definitions/FileRef\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2012-05-04T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n identification_note:\n type: string\n maxLength: 100\n description: A note, which contains details about the identification type.\n example: \"Some note\"\n\n IdentificationCreateRequest:\n type: object\n required:\n - type\n - number\n properties:\n type:\n $ref: \"#/definitions/IdentificationType\"\n title:\n type: string\n maxLength: 40\n example: \"SELFIE\"\n description: The document title.\n number:\n type: string\n example: \"132123123\"\n description: The document number.\n issuance_authority:\n type: string\n example: \"Ministry of defense\"\n description: The name of issuance authority.\n place_of_issuance:\n type: string\n example: \"Lebanon\"\n description: The place of issuance.\n expiration_date:\n type: string\n description: The expiration date of the document.\n example: \"2022-05-04\"\n issuance_date:\n type: string\n description: The issuance date of the document.\n example: \"2012-05-04\"\n identification_note:\n type: string\n maxLength: 100\n description: A note, which contains details about the identification type.\n example: \"Some note\"\n\n IdentificationUpdateRequest:\n type: object\n properties:\n title:\n type: string\n maxLength: 40\n example: \"SELFIE\"\n description: The document title.\n number:\n type: string\n example: \"132123123\"\n description: The document number.\n issuance_authority:\n type: string\n example: \"Ministry of defense\"\n description: The name of issuance authority.\n place_of_issuance:\n type: string\n example: \"Lebanon\"\n description: The place of issuance.\n expiration_date:\n type: string\n description: The expiration date of the document.\n example: \"2012-05-04\"\n issuance_date:\n type: string\n description: The issuance date of the document.\n example: \"2012-05-04\"\n identification_note:\n type: string\n maxLength: 100\n description: A note, which contains details about the identification type.\n example: \"Some note\"\n\n IdentificationStatus:\n type: string\n description: The identification status.\n enum:\n - PENDINGKYB # default\n\n IdentificationStatusReasonCode:\n type: string\n description: The identification status reason code.\n enum:\n - I0 # default\n\n IdentificationType:\n type: string\n description: The identification type of file to be uploaded.\n enum:\n - PASSPORT\n - VISA\n - NATIONAL_ID\n - TRADE_LICENSE\n - COMMERCIAL_LICENSE\n - INCORPORATION_CERT\n - INCUMBENCY_CERT\n - MEMORANDUM_ARTICLES\n - BANK_STATEMENT\n - ADDITIONAL\n\n IdentificationDocumentType:\n type: string\n description: The identification document type of file to be uploaded.\n enum:\n - NATIONAL_ID_FRONT\n - NATIONAL_ID_BACK\n - PASSPORT_PAGE1\n - PASSPORT_PAGE2\n - VISA\n - ADDITIONAL_PAGE_1\n - ADDITIONAL_PAGE_2\n\n UserIdentificationCollection:\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load\"\n data:\n type: array\n description: An array of user identification data\n items:\n $ref: \"#/definitions/Identification\"\n\n FileRef:\n type: object\n description: File data.\n properties:\n id:\n type: string\n description: Unique file ID.\n example: 9e354f40-2ea5-43a9-92ec-2f967c3981f9.png\n file_name:\n type: string\n description: File name.\n example: 9e354f40-2ea5-43a9-92ec-2f967c3981f9.png\n content_type:\n type: string\n description: File's data content type.\n example: \"application/pdf\"\n size:\n type: integer\n format: int64\n description: File size.\n example: 4562\n identification_type:\n $ref: \"#/definitions/IdentificationType\"\n identification_document_type:\n $ref: \"#/definitions/IdentificationDocumentType\"\n version:\n type: integer\n format: int32\n description: The version of the document.\n example: 1\n created:\n type: string\n format: date-time\n description: The date and time when file was created.\n example: \"2012-05-04T19:42:32.987Z\"\n title:\n type: string\n maxLength: 40\n example: \"SELFIE\"\n description: The document title.\n\n FileUploadMetadata:\n type: object\n description: File upload metadata.\n properties:\n location:\n type: string\n description: File's location(file_path + file_name).\n example: \"tenant1/user120/e9f2cefe-e859-4a02-89bc-7fc3792cac74.pdf\"\n file_path:\n type: string\n description: File's path.\n example: \"tenant1/user120/e9f2cefe-e859-4a02-89bc-7fc3792cac74.pdf\"\n file_name:\n type: string\n description: File name.\n example: \"e9f2cefe-e859-4a02-89bc-7fc3792cac74.pdf\"\n original_file_name:\n type: string\n description: File name passed while uploading file.\n example: \"a2.pdf\"\n content_type:\n type: string\n description: File's data content type.\n example: \"application/pdf\"\n md5:\n type: string\n description: MD5 hash of file's data encoded in base64.\n example: \"957789812c1767bb6939ea0089b75a00\"\n etag:\n type: string\n description: HTTP 1.1 Entity tag for the file.\n example: \"957789812c1767bb6939ea0089b75a00\"\n size:\n type: integer\n format: int64\n example: 1000\n description: Content length of the data in bytes.\n created:\n type: string\n format: date-time\n description: The date and time when file was created.\n example: \"2012-05-04T19:42:32.987Z\"\n\n FileUploadContent:\n allOf:\n - $ref: '#/definitions/FileUpload'\n - type: object\n properties:\n content:\n type: string\n example: \"2rl0Dvc1gTrOTTqzgNaK62wj9tT91kEZRjUGF2kWWeBN4BGy7xYdAR7Mc6duajDBLQ_y8pBKeXaxRPUXIcK5K734Z7rmtAYIzMam2RClvKcU\"\n description: Content data, base64 encoded (urlsafe, no padding, no wrap).\n\n FileUpload:\n type: object\n discriminator: id\n properties:\n id:\n type: string\n description: Unique file ID.\n user_id:\n type: string\n example: \"user120\"\n description: The link to user_id. Might be usefull for retrieving all uploads for account_id.\n metadata:\n $ref: \"#/definitions/FileUploadMetadata\"\n\n Cursors:\n type: object\n description: Cursors\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load.\"\n example: John Smith\n has_more:\n type: boolean\n description: \"This parameter indicates whether there are more data to load.\"\n\n Paging:\n type: object\n description: Paging\n properties:\n cursors:\n $ref: \"#/definitions/Cursors\"\n\n Pageable:\n type: object\n discriminator: data\n properties:\n paging:\n $ref: \"#/definitions/Paging\"\n\n CardCollection:\n type: object\n properties:\n after:\n type: string\n description: Durable version of current results that can be used on the next load.\n example: \"MjAxOC0wMS0wMlQxOTo0MjozMi45ODda\"\n has_more:\n type: boolean\n description: Indicates whether there are more data to load.\n data:\n type: array\n description: Card data\n items:\n $ref: \"#/definitions/Card\"\n\n Card:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the card.\n user_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: Token identifier of the user who owns this card.\n card_type:\n description: Type of card which should be issued. Applicable values are virtual/physical.\n $ref: \"#/definitions/CardType\"\n card_product_id:\n description: The unique identifier of the card product. This token id is referred to as an existing card product.\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n reference_card_id:\n type: string\n description: Token identifier of the card to refer to when creating a card linked to an existing account.\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n bulk_issuance_id:\n type: string\n description: Token identifier of the bulk issuance request to which this card belongs to.\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n name_on_card:\n type: string\n description: Name to print on the card and track data. If this field finds empty in the request, then the name of the user profile will be printed on the card.\n example: \"John Smith\"\n maxLength: 20\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n status:\n $ref: \"#/definitions/CardStatus\"\n status_reason:\n $ref: \"#/definitions/CardStatusReason\"\n description: Status reason\n type: string\n example: 's0'\n fulfillment_status:\n $ref: \"#/definitions/FulfillmentStatus\"\n bin:\n type: string\n description: Card BIN number.\n example: \"123456\"\n last_four:\n type: string\n description: Card last four digits.\n example: \"5789\"\n expiry_date:\n type: string\n description: Card expiry date.\n example: \"01/2025\"\n pin_retries:\n type: integer\n format: int32\n description: When the cardholder performs a bad PIN, a counter is maintained at the card level to keep track of successive bad PIN attempts.\n proxy_number:\n type: string\n description: Alternate card identifier\n example: \"0000367466\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n type: string\n description: The date and time when request was modified.\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n modified_by:\n type: string\n maxLength: 50\n default: \"API\"\n description: This field indicates the user who executed the operation.\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n card_soft_expiry:\n type: string\n description: Card soft expiry date.\n example: \"01/2025\"\n auth_settings:\n description: An array of authorization settings.\n $ref: \"#/definitions/InternalAuthSettings\"\n is_account_linked:\n type: boolean\n description: This parameters becomes true once account is linked with card.\n example: true\n\n CardCreateRequest:\n type: object\n required:\n - card_product_id\n - user_id\n - card_type\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the card. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls and this value cannot be updated.\n user_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: Token identifier of the user who owns this card.\n card_type:\n description: The type of the card. Supported values are physical and virtual.\n $ref: \"#/definitions/CardType\"\n card_product_id:\n description: The unique identifier of the card product. This token id is referred to as an existing card product. The card creating with this card product token will inherit all of its characteristics.\n type: string\n example: \"aabc9d-996azam799-9ac99879b9a9bC99\"\n reference_card_id:\n type: string\n description: Token identifier of the card to refer to when creating a card linked to an existing account.\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n bulk_issuance_id:\n type: string\n description: Token identifier of the bulk issuance request to which this card belongs to.\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n name_on_card:\n type: string\n description: Name to print on the card and track data. If this field finds empty in the request, then the name of the user profile will be printed on the card.\n example: \"John Smith\"\n maxLength: 20\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n dry_run:\n type: boolean\n example: false\n description: |\n This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.\n card_validity_term:\n type: integer\n format: int32\n minimum: 1\n maximum: 99\n example: 36\n description: |\n This is the term (in months) for which a newly created card will be valid for.\n Used to set the expiry date for the card. The expiry date shall be calculated from the date of card creation till the number of months given by this parameter. This field is optional; if it is empty, then card_validity_term from card_product shall be used. Card validity term of the card can not be greater than that of the card product.\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n\n CardUpdateRequest:\n type: object\n properties:\n bulk_issuance_id:\n type: string\n description: Token identifier of the bulk issuance request to which this card belongs to.\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n name_on_card:\n type: string\n description: Name to print on the card and track data. If this field finds empty in the request, then the name of the user profile will be printed on the card.\n example: \"John Smith\"\n maxLength: 20\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n\n CardShippingMethod:\n type: string\n description: Shipping method, for example by courier.\n enum:\n - COURIER\n\n CardShippingDetails:\n type: object\n description: Details of card shipping destination.\n properties:\n method:\n $ref: \"#/definitions/CardShippingMethod\"\n description: Shipping method, for example by courier.\n return_address:\n $ref: \"#/definitions/ReturnAddress\"\n description: Address details of where the card will be returned if the card cannot be delivered.\n shipping_address:\n $ref: \"#/definitions/CardAddress\"\n description: Address to which the card will be shipped. If empty then the name, mobile, and address will be taken from the user profile.\n\n ReturnAddress:\n type: object\n description: Address details of where the card will be returned if the card cannot be delivered.\n properties:\n first_name:\n type: string\n description: First name of card recipient.\n maxLength: 60\n example: John\n middle_name:\n type: string\n description: Middle name of card recipient.\n maxLength: 60\n example: Anthony\n last_name:\n type: string\n description: Last name of card recipient.\n maxLength: 60\n example: Smith\n mobile:\n type: string\n description: Mobile number of card recipient.\n maxLength: 20\n example: \"+551185249635\"\n address_line1:\n type: string\n maxLength: 255\n example: \"Flat 1904\"\n description: |\n Address line 1.\n 255 char max, though lower limits may be imposed by providers.\n Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50.\n address_line2:\n type: string\n maxLength: 255\n example: \"Glass Tower\"\n description: |\n Address line 2.\n 255 char max, though lower limits may be imposed by providers.\n Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50.\n city:\n type: string\n description: City\n maxLength: 40\n example: \"New York City\"\n state:\n type: string\n description: State\n example: \"New York\"\n maxLength: 32\n country:\n type: string\n description: Country to which the card will be returned. The format is 3-letter ISO_4217 code.\n example: \"USA\"\n maxLength: 3\n postal_code:\n type: string\n description: Postal code\n maxLength: 10\n example: \"12345\"\n\n CardAddress:\n type: object\n description: Address to which the card will be shipped.\n properties:\n first_name:\n type: string\n description: First name of card recipient.\n maxLength: 60\n example: John\n middle_name:\n type: string\n description: Middle name of card recipient.\n maxLength: 60\n example: Anthony\n last_name:\n type: string\n description: Last name of card recipient.\n maxLength: 60\n example: Smith\n mobile:\n type: string\n description: Mobile number of card recipient.\n maxLength: 20\n example: \"+551185249635\"\n address_line1:\n type: string\n maxLength: 255\n example: \"Flat 1904\"\n description: |\n Address line 1.\n 255 char max, though lower limits may be imposed by providers.\n Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50.\n address_line2:\n type: string\n maxLength: 255\n example: \"Glass Tower\"\n description: |\n Address line 2.\n 255 char max, though lower limits may be imposed by providers.\n Perfect Plastic Printing and IDEMIA limit chars to 100, and Arroweye Solutions limits chars to 50.\n city:\n type: string\n description: City\n maxLength: 40\n example: \"New York City\"\n state:\n type: string\n description: State\n example: \"New York\"\n maxLength: 32\n country:\n type: string\n description: Country to which the card will be shipped. The format is 3-letter ISO_4217 code.\n example: \"USA\"\n maxLength: 3\n postal_code:\n type: string\n description: Postal code\n maxLength: 10\n example: \"12345\"\n\n\n\n CardType:\n type: string\n example: \"PHYSICAL\"\n description: The type of the card. Supported values are physical and virtual.\n enum:\n - PHYSICAL\n - VIRTUAL\n\n CardInfo:\n allOf:\n - $ref: \"#/definitions/Card\"\n - type: object\n properties:\n number:\n type: string\n description: PAN - primary account number. It is printed on the front of the card.\n example: \"9999999999999999\"\n cvv2:\n type: string\n description: CVV2 - card verification value.\n example: \"999\"\n\n CardStatus:\n type: string\n description: The status of a card.\n enum:\n - INACTIVE\n - ACTIVE\n - SUSPENDED\n - TERMINATED\n\n CardStatusReason:\n type: string\n enum:\n - I0\n - I1\n - I2\n - I3\n - A0\n - A1\n - A3\n - S0\n - S1\n - S2\n - S3\n - S4\n - S5\n - S6\n - T0\n - T1\n - T2\n - T3\n - T4\n - T5\n - T7\n - T8\n - T9\n - T10\n - T11\n - T12\n - T13\n - T14\n - T15\n - T16\n - T17\n - T18\n\n description: >\n Status Reason Code:\n * `I0`: First time created: when the card is created.\n * `I1`: Embossing generated: when the card is embossed.\n * `I2`: Card created with no account.\n * `I3`: Embossing generated with no account.\n * `A0`: First time activation: when activated from Inactive to Active status.\n * `A1`: Resumed from Suspended status: when card is moved back to Active status.\n * `A3`: Activated by admin.\n * `S0`: Temporary suspension: initiated by the user or system user or the system.\n * `S1`: PIN retries exhausted: when bad PIN retries are exhausted.\n * `S2`: Card validity expired.\n * `S3`: Admin rejected due to ID verification failed.\n * `S4`: Suspended by admin.\n * `S5`: Admin rejected due to ID verification failed.\n * `S6`: Suspended by admin.\n * `T0`: Card Lost.\n * `T1`: Card Stolen.\n * `T2`: Card Expired.\n * `T3`: Card Damaged.\n * `T4`: Closed by user.\n * `T5`: Closed by issuer.\n * `T7`: Admin terminated due to limited time exceeded and action taken for ID verification fail.\n * `T8`: Terminated by admin.\n * `T9`: Admin terminated due to ID verification failed.\n * `T10`: Admin terminated due to limited time exceeded and action taken for KYB fail.\n * `T11`: Terminated by Admin.\n * `T12`: System terminated due to ID verification rejected.\n * `T13`: System terminated due to ID verification suspected.\n * `T14`: Failed KYC.\n * `T15`: Terminated by admin.\n * `T16`: Terminated by admin.\n * `T17`: Admin terminated due to ID verification failed.\n * `T18`: Admin terminated due to KYC failed.\n\n\n FulfillmentStatus:\n type: string\n description: Fulfilment status of the card.\n enum:\n - CREATED\n - ORDERED\n\n UserStatusChangeRequest:\n type: object\n required:\n - status\n - status_reason_code\n properties:\n status:\n $ref: \"#/definitions/UserStatus\"\n status_reason_code:\n $ref: \"#/definitions/UserStatusReasonCode\"\n note:\n type: string\n example: \"Some note regarding the reason of user status change.\"\n description: This field is to capture additional information while changing the user status.\n modified_by:\n type: string\n default: \"API\"\n description: This field indicates the user who executed the operation.\n\n UserStatus:\n type: string\n description: The status of the user.\n enum:\n - PENDINGKYC\n - PENDINGKYB\n - ACTIVE\n - SUSPENDED\n - TERMINATED\n - PENDINGIDVERIFICATION\n\n UserStatusReasonCode:\n type: string\n description: >\n Status Change Reason Code:\n * `I0`: Initial status.\n * `A0`: First time activation: when activated from PENDINGKYC to ACTIVE status.\n * `A1`: Resumed from Suspended status: when user is moved back to ACTIVE status.\n * `A2`: Admin Activated the user from status suspended.\n * `A3`: Admin activated the user by manual intervention from the dashboard.\n * `A4`: Admin Activated the business user from status suspended.\n * `A5`: Admin Activated.\n * `A6`: Document expired or about to expire.\n * `A7`: ID renewed.\n * `A8`: ID re-verification failed after document expiration.\n * `B0`: Documents are uploaded successfully for identity verification.\n * `B1`: Identity is not verified, manual intervention required.\n * `B2`: SDK token is no longer valid, please generate a new SDK token.\n * `B3`: Admin approved, proceed to KYC verification flow.\n * `B4`: Name mismatched.\n * `B5`: Identity verification consider with caution status and name mismatched.\n * `B6`: Identity verification consider.\n * `B7`: Date of birth consider.\n * `B9`: Document issuing country mismatch.\n * `B10`: Identity verification consider with caution status and document issuing country mismatch.\n * `B1E`: Identity is not verified, manual intervention required in Re-Uploading Case.\n * `B2E`: Generate SDK token, document expired (same as B2).\n * `B0E`: Documents re-uploaded after document expiration for identity verification (same as B0).\n * `B9E`: Document issuing country mismatch upon IDV re-verification after document expiration.\n * `B10E`: Identity verification consider with caution status and document issuing country mismatch upon IDV re-verification after document expiration.\n * `B19`: Identity verification consider, contact Admin.\n * `S0`: Temporary suspension: initiated by the user or system user or the system.\n * `S1`: Inactivity over time.\n * `S2`: Suspended by Admin.\n * `S3`: Suspended by Admin.\n * `S4`: Suspended by Admin.\n * `S5`: Suspended by Admin.\n * `S6`: Suspended by Admin.\n * `S7`: IDV not renewed and document expiration grace period reached.\n * `T0`: Closed by user.\n * `T1`: Closed by issuer.\n * `T2`: Failed KYC.\n * `T3`: Terminated by Admin.\n * `T4`: Terminated by Admin.\n * `T5`: Admin terminated due to ID verification failed.\n * `T6`: Admin terminated due to KYC failed.\n * `T7`: Admin terminated due to limited time exceeded and action taken for ID verification fail.\n * `T8`: Terminated by Admin.\n * `T9`: Admin terminated due to ID verification failed.\n * `T10`: Admin terminated due to limited time exceeded and action taken for KYB fail.\n * `T11`: Admin terminated due to certain reason.\n * `T12`: System terminated due to ID verification rejected.\n * `T13`: System terminated due to ID verification suspected.\n * `T12E`: System terminated due to ID verification rejected after document expiration for identity verification (same as T12).\n * `T13E`: System terminated due to ID verification suspected after document expiration for identity verification (same as T13).\n * `O1`: Other reason.\n enum:\n - I0\n - A0\n - A1\n - A2\n - A3\n - A4\n - A5\n - A6\n - A7\n - A8\n - B0\n - B1\n - B2\n - B3\n - B4\n - B5\n - B6\n - B7\n - B9\n - B10\n - B1E\n - B2E\n - B0E\n - B9E\n - B10E\n - B19\n - S0\n - S1\n - S2\n - S3\n - S4\n - S5\n - S6\n - S7\n - T0\n - T1\n - T2\n - T3\n - T4\n - T5\n - T6\n - T7\n - T8\n - T9\n - T10\n - T11\n - T12\n - T13\n - T12E\n - T13E\n - O1\n\n StatusChangeRequest:\n type: object\n required:\n - status\n - status_reason_code\n properties:\n status:\n $ref: \"#/definitions/CardStatus\"\n description: Card status\n status_reason_code:\n $ref: \"#/definitions/StatusChangeReason\"\n note:\n description: This field is to capture additional information by the user while changing the card status. E.g. how the card got stolen, what is the reason behind a damage, etc.\n $ref: \"#/definitions/CoreNote\"\n modified_by:\n type: string\n default: \"API\"\n description: This field indicates the user who executed the operation.\n\n StatusChangeReason:\n type: string\n enum:\n - A0\n - A1\n - A3\n - S0\n - S1\n - S2\n - S3\n - S4\n - S5\n - S6\n - T0\n - T1\n - T2\n - T3\n - T4\n - T5\n - T7\n - T8\n - T9\n - T10\n - T11\n - T12\n - T13\n - T14\n - T15\n - T16\n - T17\n - T18\n description: >\n Status Change Reason Code:\n * `A0`: First time activation: when activated from INACTIVE to ACTIVE status.\n * `A1`: Resumed from Suspended status: when card is moved back to ACTIVE status.\n * `A3`: Activated by admin.\n * `S0`: Temporary suspension: initiated by the user or system user or the system.\n * `S1`: PIN retries exhausted: when bad PIN retries are exhausted.\n * `S2`: Card validity expired.\n * `S3`: Admin rejected due to ID verification failed.\n * `S4`: Suspended by admin.\n * `S5`: Admin rejected due to ID verification failed.\n * `S6`: Suspended by admin.\n * `T0`: Card is lost.\n * `T1`: Card is stolen.\n * `T2`: Card is expired.\n * `T3`: Card is damaged.\n * `T4`: Card is closed by user.\n * `T5`: Card is closed by issuer.\n * `T7`: Admin terminated due to limited time exceeded and action taken for ID verification fail.\n * `T8`: Terminated by admin.\n * `T9`: Admin terminated due to ID verification failed.\n * `T10`: Admin terminated due to limited time exceeded and action taken for KYB fail.\n * `T11`: Terminated by Admin.\n * `T12`: System terminated due to ID verification rejected.\n * `T13`: System terminated due to ID verification suspected.\n * `T14`: Failed KYC.\n * `T15`: Terminated by admin.\n * `T16`: Terminated by admin.\n * `T17`: Admin terminated due to ID verification failed.\n * `T18`: Admin terminated due to KYC failed.\n\n CardSoftExpiryChangeRequest:\n type: object\n description: A request payload to change card soft expiry.\n required:\n - period\n - extend_soft_expiry\n properties:\n period:\n description: Card soft expiry period unit.\n $ref: \"#/definitions/CardSoftExpiryPeriod\"\n extend_soft_expiry:\n description: Card soft expiry period number. The unit of this value depends on provided period unit.\n type: integer\n minimum: 1\n example: 1\n note:\n description: An optional note.\n type: string\n example: \"Some info\"\n modified_by:\n description: This field indicates Who updated card's soft expiry setting. Default is 'API'.\n type: string\n maxLength: 50\n default: \"API\"\n\n CardSoftExpiryPeriod:\n type: string\n description: Card soft expiry period.\n example: \"MONTH\"\n enum:\n - MONTH\n\n CoreNote:\n type: object\n description: This field is to capture additional information by the user while changing the card status. E.g. how the card got stolen, what is the reason behind a damage, etc.\n required:\n - category\n - description\n properties:\n title:\n type: string\n description: Optional note title\n example: \"Reason of termination\"\n category:\n type: string\n description: Note category\n pattern: '^[a-z]{1}[a-z_0-9]+[a-z0-9]{1}$'\n example: \"Stolen\"\n description:\n type: string\n description: Notes description\n example: \"This card is terminated because of being stolen.\"\n extras:\n type: object\n description: This field can be use to provide additional information regarding the reason of status change.\n additionalProperties:\n type: string\n example: \"Hotel Z\"\n description: Extra info\n\n AccountsCollection:\n type: object\n properties:\n after:\n type: string\n description: Durable version of current results that can be used on the next load.\n example: \"MjAxOC0wMS0wMlQxOTo0MjozMi45ODda\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load\"\n data:\n type: array\n description: Account data.\n items:\n $ref: \"#/definitions/Account\"\n\n AccountStatus:\n type: string\n enum:\n - ACTIVE\n - SUSPENDED\n - TERMINATED\n description: |\n Account status.\n\n 1. The card account when created shall be in Active status.\n While in Active status the account can be used for loading/unloading of funds and\n to process card authorizations and clearings.\n\n 2. The account status can be changed from Active to Suspended status.\n When in Suspended status the account does not allow loading/unloading of funds\n and to process card authorizations. However clearings coming from the scheme are processed.\n Suspended status is a temporary status and the account status is allowed to change back to Active status.\n\n 3. The account status can be changed to Terminated status. This is a permanent status,\n the account status can be changed to Terminated status only when card account closure\n operation is explicitly performed. You can update account status to Terminated if account has no balance or account has no pending authorizations.\n\n AccountType:\n type: string\n enum:\n - PREPAID\n - MASTER\n description: The type of account.\n\n UpdateAccountType:\n type: string\n enum:\n - PREPAID\n - MASTER\n description: The type of account.\n\n AccountCreateRequest:\n type: object\n required:\n - user_id\n - card_product_id\n - type\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the account. If this information is not present in the request,the system generates one automatically.\n user_id:\n type: string\n example: \"gg5a80f-e641-4045-8a80-54841e4a55555\"\n description: The unique identifier of the user.\n card_product_id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of the card product. This token ID is referred to as an existing card product.\n type:\n $ref: '#/definitions/AccountType'\n description: The type of account.\n currencies:\n type: array\n description: An array of currencies. It is used to create account with several currencies. If currency is not passed in this API, account is created with only 1 currency (base currency).\n items:\n type: string\n example: \"USD\"\n\n UpdateAccountRequest:\n type: object\n required:\n - wallet_details\n properties:\n wallet_details:\n type: array\n description: An array of wallet details.\n items:\n $ref: \"#/definitions/WalletDetails\"\n\n\n UpdateAccountResponse:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of the account.\n user_id:\n type: string\n example: \"gg5a80f-e641-4045-8a80-54841e4a55555\"\n description: The unique identifier of the user.\n card_product_id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of the card product.\n type:\n $ref: '#/definitions/UpdateAccountType'\n description: The type of account.\n balances:\n type: object\n example: { USD: 125.58, EUR: 400.20 }\n additionalProperties:\n type: number\n format: decimal\n example: 99.95\n description: Account balance amount in relevant currency.\n description: Account balances.\n ledger_balances:\n type: object\n example: { USD: 125.58, EUR: 400.20 }\n additionalProperties:\n type: number\n format: decimal\n example: 99.95\n description: Ledger balance amount in relevant currency.\n description: Ledger balances.\n status:\n $ref: '#/definitions/AccountStatus'\n currencies:\n type: array\n description: An array of currencies. It is used to create account with several currencies. If currency is not passed in 'Create account' API, account is created with only 1 currency (base currency).\n items:\n type: string\n pattern: \"^[A-Z]{3}$\"\n example: \"USD\"\n wallet_details:\n type: array\n description: An array of wallet details.\n items:\n $ref: '#/definitions/WalletDetails'\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when account was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when account was updated.\n\n\n Account:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of the account.\n user_id:\n type: string\n example: \"gg5a80f-e641-4045-8a80-54841e4a55555\"\n description: The unique identifier of the user.\n card_product_id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of the card product.\n type:\n $ref: '#/definitions/AccountType'\n description: The type of account.\n balances:\n type: object\n example: { USD: 125.58, EUR: 400.20 }\n additionalProperties:\n type: number\n format: decimal\n example: 99.95\n description: Account balance amount in relevant currency.\n description: Account balances.\n ledger_balances:\n type: object\n example: { USD: 125.58, EUR: 400.20 }\n additionalProperties:\n type: number\n format: decimal\n example: 99.95\n description: Ledger balance amount in relevant currency.\n description: Ledger balances.\n status:\n $ref: '#/definitions/AccountStatus'\n currencies:\n type: array\n description: An array of currencies. It is used to create account with several currencies. If currency is not passed in 'Create account' API, account is created with only 1 currency (base currency).\n items:\n type: string\n pattern: \"^[A-Z]{3}$\"\n example: \"USD\"\n wallet_details:\n type: array\n description: An array of wallet details.\n items:\n $ref: '#/definitions/WalletDetails'\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when account was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when account was updated.\n modified_by:\n type: string\n maxLength: 50\n default: \"API\"\n description: This field indicates the user who executed the operation.\n\n ChangeAccountStatusRequest:\n type: object\n required:\n - status\n properties:\n status:\n $ref: '#/definitions/AccountStatus'\n modified_by:\n type: string\n default: \"API\"\n description: This field indicates the user who executed the operation.\n\n CardsLinkToAccountRequest:\n type: object\n required:\n - ids\n - dry_run\n properties:\n ids:\n type: array\n description: The unique identifier or the proxy number of the card(s).\n example: [ \"card327\" ]\n items:\n type: string\n description: The unique identifier or the proxy number of the card(s).\n dry_run:\n type: boolean\n default: false\n example: false\n description: This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false, and the default value is false.\n\n AccountFundsRequest:\n type: object\n description: Information about account funds request.\n required:\n - currency\n - amount\n properties:\n currency:\n type: string\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n amount:\n type: number\n format: decimal\n example: 123.45\n description: Funds amount of the operation.\n note:\n type: string\n description: Additional description to the load account funds operation that is being performed can be added in this field.\n example: Performing operation for 123.45 USD\n dry_run:\n type: boolean\n description: This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false, and the default value is false.\n example: false\n default: false\n reference_number:\n type: string\n example: 3e50d5f7-6c18-4768-81c5-e4bc31f209db\n description: This parameter is searched against 'transaction_id'. This parameter is optional.\n\n\n AccountFundsTransactionResult:\n type: object\n description: Information about account funds transaction result.\n required:\n - fee_amount\n - status\n properties:\n fee_amount:\n type: number\n format: decimal\n description: Total fees for account funds transaction.\n status:\n $ref: \"#/definitions/AccountFundsTransactionResultStatus\"\n status_reason:\n $ref: \"#/definitions/AccountFundsTransactionResultStatusReason\"\n status_description:\n type: string\n description: Status description of account funds transaction.\n\n\n AccountFundsTransactionResultStatus:\n type: string\n enum:\n - PROCESSING\n - SETTLED\n - DECLINED\n - CANCELLED\n - ERROR\n\n AccountFundsTransactionResultStatusReason:\n type: string\n enum:\n - NOT_ENOUGH_FUNDS\n - ACCOUNT_LIMITS_REACHED\n - INVALID_ACCOUNT\n - VELOCITY_USAGE_LIMIT_REACHED\n - VELOCITY_AMOUNT_LIMIT_REACHED\n - FX_RATE_NOT_CONFIGURED\n - UNKNOWN\n\n ### Non exposed entities:\n\n AccountStatusChangeHistory:\n type: object\n required:\n - account_id\n - history\n properties:\n account_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: Account ID of status change history.\n history:\n type: array\n items:\n $ref: '#/definitions/AccountStatusChangeEvent'\n\n AccountStatusChangeEvent:\n type: object\n required:\n - new_status\n - old_status\n - modified\n properties:\n old_status:\n $ref: '#/definitions/AccountStatus'\n new_status:\n $ref: '#/definitions/AccountStatus'\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when status of the account was changed.\n\n JCardAccountWalletPinInternal:\n type: object\n required:\n - wallet_key\n - enc_pin\n properties:\n wallet_key:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n enc_pin:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n\n AccountFundsTransaction:\n type: object\n properties:\n transaction_id:\n type: string\n example: \"123456789012\"\n description: Transaction id (RRN) of the funds request.\n account_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: Account ID of status change history.\n request:\n $ref: \"#/definitions/AccountFundsRequest\"\n description: Information about account funds request.\n result:\n $ref: \"#/definitions/AccountFundsTransactionResult\"\n description: Information about account funds transaction result.\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when account funds transaction was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when account funds transaction was modified.\n source_channel:\n $ref: \"#/definitions/TransferSourceChannel\"\n description: Information about transaction source channel.\n\n CardPinResponse:\n type: object\n required:\n - enc_pin\n properties:\n enc_pin:\n type: string\n example: \"ncrypt:2:xKzHT-2NJ8yCZIv7Ra9oFQ:VETEcevv-ZyndOeLF7CqO-4aNJ6Z5Tha0wcMFoJEDAJAoLsst1ccMSeeMdbJUwq1GfKjCpm5mMwkEn51ZAFqLW43EcNkapSiPPVRJtU5V1z9u4ZGEXi4swPVzY2j0NfaM4a4aGM_WdpKSx6r7m86vhjI5901GXRd2vpyGAztfL9krOMA7KgLGaVlqj1i-xIaxvGbIDhFVepIWcxTxiSHqwZxLMN1HMojtf2pJacwoq5nOBP3DX3DgdapIdJN8AWCSIpZ8M6nwf4-2Wr8GGTJrUChU1eJiALKZ-lliP8RvIERG9zP3Z41kQDoWP9JlEFr547xREvXIf6IS4a_ixuwrg:1Ya9e6e0Los\"\n description: Encrypted card PIN\n\n CardPinChangeRequest:\n type: object\n required:\n - enc_pin\n properties:\n enc_pin:\n type: string\n example: \"ncrypt:2:bP6dZTzopk6TTYeP4lETrw:kjQRz3M9wzOFPU3cphAomtHoMv3aC2-CkMtAgiLvYfpy1cEwTm3ag7_caXHFThWN_SBxHpj9aviki9rr7okJKN-BqdO46d7Uu4Bx9dNo0_Tn9ZcKV7X-dAGLgNViYeAaGbA2jlcESYZZLecqPBqBADQ12DdGV4VfRtEb3pDZRO3VRP1hXL4VgN_H1vRwIwT5vTyBLuzQA3Lh3xqrlVrrRFHah42oH3YkgaY6M8mc3r3e3pBItNMiwW10wjfO50z7dy2O0yAGyy-QSWqu4LQYMLKMAPx4wsuEcAQg3Xpmnv3GmP_goAvu88ASH9u4iKWGh0OtrldQZlmUqiYcq9mWMQ:Ok9OebFuRwQ\"\n description: Encrypted card PIN.\n\n NotificationTemplates:\n type: object\n properties:\n id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: |\n A unique template ID.\n language:\n type: string\n example: \"EN\"\n description: |\n A language attribute identifying the language used in the template. ISO language codes are used.\n text:\n type: string\n example:\n Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.\n description: |\n A free text field for defining the SMS text.\n category:\n $ref: \"#/definitions/NotificationTemplatesCategory\"\n description: For ITSP_OTP category wallet provider field applicable.\n card_product_id:\n type: string\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n description: |\n ID of the card product.\n created:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was modified.\n wallet_provider:\n $ref: \"#/definitions/WalletProvider\"\n description: Wallet provider field applicable for ITSP_OTP category.\n email:\n $ref: \"#/definitions/EmailData\"\n description: Optional email OTP template. It is applicable for ITSP_OTP category only.\n\n EmailData:\n type: object\n description: Optional email OTP template. It is applicable for ITSP_OTP category only.\n properties:\n subject:\n type: string\n description: Email subject - if email body is provided then subject becomes mandatory.\n maxLength: 50\n example: \"OTP notification\"\n body:\n type: string\n description: Email body - if email subject is provided then body becomes mandatory.\n maxLength: 10000\n example: \"Dear Customer, your one-time verification code is <OTP> for the digital wallet provisioning for card <CARD_NAME> ending with <CARD_LAST4_DIGITS>. The expiration of OTP is <OTP_EXPIRY>. Do not share this code. <FINTECH_NAME> will never contact you to ask for code.\"\n\n NotificationTemplatesCategory:\n type: string\n enum:\n - THREE_D_SECURE_OTP\n - ITSP_OTP\n example: THREE_D_SECURE_OTP\n description: |\n A notification category field that informs about the type of event to which this template is associated.\n\n NotificationTemplatesCreateRequest:\n type: object\n required:\n - language\n - text\n - category\n - card_product_id\n properties:\n language:\n type: string\n example: \"EN\"\n description: |\n A language attribute identifying the language used in the template. ISO language codes are used.\n text:\n type: string\n example:\n Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.\n description: |\n A free text field for defining the SMS text.\n category:\n $ref: \"#/definitions/NotificationTemplatesCategory\"\n description: For ITSP_OTP category wallet provider field applicable.\n card_product_id:\n type: string\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n description: |\n The notification template is linked with the card product id shared in this parameter.\n wallet_provider:\n $ref: \"#/definitions/WalletProvider\"\n description: Wallet provider field applicable for ITSP_OTP category.\n email:\n $ref: \"#/definitions/EmailData\"\n description: Optional email OTP template. It is applicable for ITSP_OTP category only.\n\n NotificationTemplatesUpdateRequest:\n type: object\n properties:\n language:\n type: string\n example: \"EN\"\n description: |\n A language attribute identifying the language used in the template. ISO language codes are used.\n text:\n type: string\n example:\n Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.\n description: |\n A free text field for defining the SMS text.\n category:\n $ref: \"#/definitions/NotificationTemplatesCategory\"\n description: For ITSP_OTP category wallet provider field applicable.\n card_product_id:\n type: string\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n description: |\n ID of the card product.\n wallet_provider:\n $ref: \"#/definitions/WalletProvider\"\n description: Wallet provider field applicable for ITSP_OTP category.\n email:\n $ref: \"#/definitions/EmailData\"\n description: Optional email OTP template. It is applicable for ITSP_OTP category only.\n\n NotificationtemplatesPlaceholder:\n type: string\n enum:\n - \"<OTP>\"\n - \"<OTP_EXPIRY>\"\n - \"<MERCHANT_NAME>\"\n - \"<MERCHANT_URL>\"\n - \"<TRANSACTION_AMOUNT>\"\n - \"<TRANSACTION_CURRENCY>\"\n - \"<CARD_LAST4_DIGITS>\"\n - \"<CARD_NAME>\"\n - \"<FINTECH_NAME>\"\n example: \"<OTP>\"\n description: |\n The list of placeholders to support for 3DS OTP authentication.\n\n CardBulkIssuanceCreateRequest:\n type: object\n required:\n - card_product_id\n - number_of_cards\n properties:\n id:\n type: string\n maxLength: 36\n example: \"2ca78c19-5a4e-4123-a069-6d84f6aa1b54\"\n description: The unique identifier of the bulk issuance card request. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls and this value cannot be updated.\n card_product_id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: ID of a card product for which card will be created.\n number_of_cards:\n type: integer\n format: int32\n minimum: 0\n maximum: 5000\n example: 1000\n description: Number of cards to create. Can be 0 only for draft bulk issuance to create an open bulk card order. The maximum amount is up to 5000 cards.\n amount:\n type: number\n format: decimal\n example: 100\n minimum: 0\n description: The amount which shall be preloaded on card. If set, then currency is required.\n currency:\n type: string\n example: USD\n description: 3-letter ISO_4217 code representing the currency. If set, then amount is required.\n pattern: \"^[A-Z]{3}$\"\n name_on_card:\n type: string\n example: \"Gift Card\"\n maxLength: 20\n description: Name on card to be printed. For example, GIFT CARD, DRIVER CARD, TRAVEL CARD etc.. If not provided, then name from the product definition will be taken.\n card_validity_term:\n type: integer\n format: int32\n example: 36\n minimum: 1\n maximum: 99\n description: Number of months of expiry. If not provided, then value from the product definition will be taken.\n status:\n $ref: \"#/definitions/CardBulkIssuanceStatusCreateRequest\"\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n dry_run:\n type: boolean\n description: This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.\n default: false\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n card_type:\n description: Type of card which should be issued. Applicable values are virtual/physical.\n $ref: \"#/definitions/CardType\"\n\n\n CardBulkIssuanceUpdateRequest:\n properties:\n card_product_id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of the card product. This token id is referred to as an existing card product. The cards in bulk creating with this card product token will inherit all of its characteristics.\n number_of_cards:\n type: integer\n format: int32\n minimum: 0\n maximum: 5000\n example: 1000\n description: |\n Number of cards to create. The maximum amount is up to 5000 cards. Can be zero for an open bulk card order.\n Submitted card bulk issuance request must have 'number of cards' higher than 0, or it must have\n at least 1 personalized card in the card bulk issuance request.\n amount:\n type: number\n format: decimal\n example: 123.45\n minimum: 0\n description: The amount which shall be preloaded on card. If set, then currency is required.\n currency:\n type: string\n example: USD\n description: 3-letter ISO_4217 code representing the currency. If set, then amount is required.\n pattern: \"^[A-Z]{3}$\"\n name_on_card:\n type: string\n example: \"Diamond Card\"\n maxLength: 20\n description: Name on card to be printed. For example, GIFT CARD, DRIVER CARD, TRAVEL CARD etc.. If not provided, then name from the product definition will be taken.\n card_validity_term:\n type: integer\n format: int32\n example: 36\n minimum: 1\n maximum: 99\n description: Number of months of expiry. If not provided, then value from the product definition will be taken.\n status:\n $ref: \"#/definitions/CardBulkIssuanceStatusUpdateRequest\"\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n card_type:\n description: Type of card which should be issued. Applicable values are virtual/physical.\n $ref: \"#/definitions/CardType\"\n\n CardBulkIssuance:\n properties:\n id:\n type: string\n maxLength: 36\n example: \"2ca78c19-5a4e-4123-a069-6d84f6aa1b54\"\n description: The unique identifier of the bulk issuance\n card_product_id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: ID of a card product for which card will be created\n number_of_cards:\n type: integer\n format: int32\n minimum: 0\n maximum: 5000\n example: 1000\n description: Number of cards to create. Can be zero to create an open bulk card order. The maximum amount is up to 5000 cards.\n amount:\n type: number\n format: decimal\n example: 123.45\n minimum: 0\n description: The amount which shall be preloaded on card. If set, then currency is required.\n currency:\n type: string\n example: USD\n description: 3-letter ISO_4217 code representing the currency. If set, then amount is required.\n pattern: \"^[A-Z]{3}$\"\n name_on_card:\n type: string\n example: \"Diamond Card\"\n maxLength: 20\n description: Name on card to be printed. For example, GIFT CARD, DRIVER CARD, TRAVEL CARD etc.. If not provided, then name from the product definition will be taken.\n card_validity_term:\n type: integer\n format: int32\n example: 36\n minimum: 1\n maximum: 99\n description: Number of months of expiry. If not provided, then value from the product definition will be taken.\n status:\n $ref: \"#/definitions/CardBulkIssuanceStatus\"\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n created:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n card_type:\n description: Type of card which should be issued. Applicable values are virtual/physical.\n $ref: \"#/definitions/CardType\"\n\n CreateCardBulkIssuance:\n properties:\n id:\n type: string\n maxLength: 36\n example: \"2ca78c19-5a4e-4123-a069-6d84f6aa1b54\"\n description: The unique identifier of the bulk issuance\n card_product_id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: ID of a card product for which card will be created\n number_of_cards:\n type: integer\n format: int32\n minimum: 0\n maximum: 5000\n example: 1000\n description: Number of cards to create. Can be zero to create an open bulk card order. The maximum amount is up to 5000 cards.\n amount:\n type: number\n format: decimal\n example: 123.45\n minimum: 0\n description: The amount which shall be preloaded on card. If set, then currency is required.\n currency:\n type: string\n example: USD\n description: 3-letter ISO_4217 code representing the currency. If set, then amount is required.\n pattern: \"^[A-Z]{3}$\"\n name_on_card:\n type: string\n example: \"Diamond Card\"\n maxLength: 20\n description: Name on card to be printed. For example, GIFT CARD, DRIVER CARD, TRAVEL CARD etc.. If not provided, then name from the product definition will be taken.\n card_validity_term:\n type: integer\n format: int32\n example: 36\n minimum: 1\n maximum: 99\n description: Number of months of expiry. If not provided, then value from the product definition will be taken.\n status:\n $ref: \"#/definitions/CardBulkIssuanceStatusCreateRequest\"\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n created:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n\n UpdateCardBulkIssuance:\n properties:\n id:\n type: string\n maxLength: 36\n example: \"2ca78c19-5a4e-4123-a069-6d84f6aa1b54\"\n description: The unique identifier of the bulk issuance\n card_product_id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: ID of a card product for which card will be created\n number_of_cards:\n type: integer\n format: int32\n minimum: 0\n maximum: 5000\n example: 1000\n description: Number of cards to create. Can be zero to create an open bulk card order. The maximum amount is up to 5000 cards.\n amount:\n type: number\n format: decimal\n example: 123.45\n minimum: 0\n description: The amount which shall be preloaded on card. If set, then currency is required.\n currency:\n type: string\n example: USD\n description: 3-letter ISO_4217 code representing the currency. If set, then amount is required.\n pattern: \"^[A-Z]{3}$\"\n name_on_card:\n type: string\n example: \"Diamond Card\"\n maxLength: 20\n description: Name on card to be printed. For example, GIFT CARD, DRIVER CARD, TRAVEL CARD etc.. If not provided, then name from the product definition will be taken.\n card_validity_term:\n type: integer\n format: int32\n example: 36\n minimum: 1\n maximum: 99\n description: Number of months of expiry. If not provided, then value from the product definition will be taken.\n status:\n $ref: \"#/definitions/CardBulkIssuanceStatusUpdateRequest\"\n shipping_details:\n $ref: \"#/definitions/CardShippingDetails\"\n created:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n extra_embossing_line:\n type: string\n maxLength: 20\n description: Extra embossing line.\n example: \"CLASSIC\"\n pattern: '^[a-zA-Z0-9\\s]+$'\n\n CardBulkIssuanceCollection:\n type: object\n properties:\n after:\n type: string\n example: \"MjAyMS0wMy0yOVQxNToyMjo1Mi40NDJa\"\n description: \"Durable version of current results that can be used on the next load.\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load.\"\n data:\n type: array\n description: An array of card bulk issuance data\n items:\n $ref: \"#/definitions/CardBulkIssuance\"\n\n CardBulkIssuanceStatusCreateRequest:\n type: string\n description: Status of bulk issuance request.\n enum:\n - DRAFT\n - SUBMITTED\n\n CardBulkIssuanceStatusUpdateRequest:\n type: string\n default: \"SUBMITTED\"\n description: Status of bulk issuance request. Default status is 'SUBMITTED'.\n enum:\n - SUBMITTED\n - CANCELLED\n\n CardBulkIssuanceStatus:\n type: string\n description: Status of bulk issuance request. Default status is 'SUBMITTED'.\n enum:\n - DRAFT\n - SUBMITTED\n - COMPLETED\n - CANCELLED\n\n LutOperation:\n type: string\n description: The LUT creation is based on the supported operations such as, \"show_clear_card_details\", \"get_pin\", \"activate_card\", and \"change_pin\".\n enum:\n - SHOW_CLEAR_CARD_DETAILS\n - GET_PIN\n - ACTIVATE_CARD\n - CHANGE_PIN\n\n LutCreateRequest:\n type: object\n required:\n - source_id\n - operation\n properties:\n source_id:\n type: string\n example: \"ae31cd18-7ed6-4b03-8e6b-4857f11d380d\"\n description: The source identifier is used to identify the PCI source to get the cipher key.\n operation:\n $ref: \"#/definitions/LutOperation\"\n\n LutResponse:\n type: object\n properties:\n token:\n type: string\n example: \"152e8a03-719e-40b6-a901-ed981d31d52f\"\n description: Created Limited Usage Token\n\n LutKey:\n type: object\n required:\n - token\n - source_id\n - card_id\n - operation\n properties:\n token:\n type: string\n example: \"bdd3228e-37ee-4cb0-a9dc-420ed7aca07a\"\n description: Unique Limit Usage Token\n source_id:\n type: string\n example: \"ae31cd18-7ed6-4b03-8e6b-4857f11d380d\"\n description: Identifies the PCI source to get cipher key.\n card_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: Card ID\n operation:\n $ref: \"#/definitions/LutOperation\"\n\n AccountTransferRequest:\n type: object\n required:\n - sender_account_id\n - recipient_account_id\n - amount\n - currency\n properties:\n sender_account_id:\n type: string\n description: Sender account Identifier.\n example: bc121529-e6e9-45f1-b820-8c46ce7f005a\n recipient_account_id:\n type: string\n description: Recipient account Identifier.\n example: 39dbff34-5505-4181-9e81-727b71e72186\n amount:\n type: number\n format: decimal\n description: Amount which should be transfered.\n example: 12.50\n minimum: 0\n currency:\n type: string\n pattern: '^[A-Z]{3}'\n example: USD\n description: 3-letter ISO_4217 code representing the currency.\n notes:\n type: string\n description: Notes about performed transfer request.\n example: Performing operation for 12.50 USD\n dry_run:\n type: boolean\n description: This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.\n default: false\n\n AccountTransferTransaction:\n type: object\n properties:\n transaction_id:\n type: string\n example: \"123456789012\"\n description: Transaction id (RRN) of the funds request.\n sender_account_id:\n type: string\n description: Sender account Identifier.\n example: bc121529-e6e9-45f1-b820-8c46ce7f005a\n recipient_account_id:\n type: string\n description: Receipient account Identifier.\n example: 39dbff34-5505-4181-9e81-727b71e72186\n amount:\n type: number\n format: decimal\n description: Amount which should be transfered.\n example: 12.50\n sender_user_id:\n type: string\n description: The unique ID of the sender user. It is applicable only for 'WALLET_TRANSFER' transactions.\n example: \"hkuser282\"\n currency:\n type: string\n pattern: '^[A-Z]{3}$'\n example: USD\n description: 3-letter ISO_4217 code representing the currency.\n fee_amount:\n type: number\n format: decimal\n description: Fee amount for the transfer.\n example: 2.50\n fee_details:\n type: array\n description: The list of fees applied to transaction by the issuer.\n items:\n $ref: \"#/definitions/AccountTransferTransactionFeeDetail\"\n notes:\n type: string\n description: Notes about performed transfer request.\n example: Performing operation for 12.50 USD\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2012-05-04T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n source_channel:\n type: string\n example: \"DAPI\"\n $ref: \"#/definitions/TransferSourceChannel\"\n receiver_user_id:\n type: string\n description: The unique identifier of receiver user.\n example: \"g157a80f-e641-7745-8a80-99841e4a1234\"\n\n AccountTransferTransactionFeeDetail:\n type: object\n properties:\n fee_id:\n type: string\n example: \"ed2e2ddb-c028-470d-b08b-7f28bd84fbfe\"\n description: The unique identifier of the fee.\n description:\n type: string\n example: \"Some description\"\n description: The description of the applied fee.\n amount:\n type: number\n format: decimal\n example: \"100.01\"\n description: The amount of the applied fee.\n x-nymos-currency: currency\n currency:\n type: string\n format: iso-4217\n example: \"USD\"\n description: The currency of the applied fee.\n pattern: \"^[A-Z]{3}$\"\n\n CardLinkRequest:\n type: object\n properties:\n activation_token:\n type: string\n example: \"671BD682A4FD7CB04B87EBE005866BF81B706F0AA4A3E5F337E810CEC7074325\"\n description: Activation token is a card data encrypted with secure hash algorithm SHA-512. SHA-512 is formed in the following way - (card.pan + card.expiryDate_yyMM + card.cvv2).toUpperCase().\n maxLength: 255\n user_id:\n type: string\n example: \"c489509d-a973-4892-9135-42c214212cdf\"\n description: ID of a user to whom the card should be linked.\n activate_card:\n type: boolean\n description: Set this parameter as 'true' to activate the card.\n card_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of the card.\n proxy_number:\n type: string\n description: The unique short identifier of the card.\n example: \"d089a80f28kl\"\n\n TransfersCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load.\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load.\"\n data:\n type: array\n description: An array of transfer transaction data.\n items:\n $ref: \"#/definitions/AccountTransferTransaction\"\n\n Webhook:\n type: object\n properties:\n id:\n type: string\n description: Unique webhook ID.\n example: b012776c-ab74-4ece-8403-0bbb9130508c\n active:\n type: boolean\n description: If webhook is active the notifications will be sent, otherwise, not.\n example: true\n events:\n type: array\n description: Webhook event\n items:\n $ref: \"#/definitions/WebhookEvent\"\n endpoint:\n type: string\n description: The enpoint to which the message will be delivered.\n example: https://example.com/\n config:\n $ref: \"#/definitions/WebhooksConfig\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2012-05-04T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n\n WebhookCreateRequest:\n type: object\n required:\n - endpoint\n - events\n properties:\n endpoint:\n type: string\n description: The enpoint to which the message will be delivered.\n example: https://example.com/\n events:\n type: array\n description: Events to which you can subscribe. Please note that CARD_PROVISIONING event is only applicable for VISA at the moment.\n items:\n $ref: \"#/definitions/WebhookEvent\"\n config:\n description: Authentication config, supports basic auth and custom headers.\n $ref: \"#/definitions/WebhooksConfig\"\n\n WebhookNotification:\n type: object\n required:\n - event\n properties:\n id:\n type: string\n description: Unique event ID.\n example: 306e38e4-54be-469f-beca-4297129289d6\n event:\n $ref: \"#/definitions/WebhookEvent\"\n description: Event for which notification is sent.\n example: card_status_change\n endpoint:\n type: string\n description: The enpoint to which the message will be delivered.\n example: http://example.com\n payload:\n type: string\n description: Payload of the notification which is sent.\n example: \"{}\"\n tries:\n type: array\n description: Array with information of each attempt to deliver the notification.\n items:\n $ref: \"#/definitions/WebhookTry\"\n expired:\n type: boolean\n description: After maximum number of attempts, notification is considered expired.\n example: true\n response:\n type: string\n description: Response of notification.\n example: \"Success\"\n config:\n $ref: \"#/definitions/WebhooksConfig\"\n\n WebhookEvent:\n type: string\n description: Webhook event.\n enum:\n - CARD_STATUS_CHANGE\n - TRANSACTION\n - KYC_RESULT\n - USER_CREATED\n - USER_STATUS_CHANGE\n - USER_DOCUMENT_ALERT\n - IDENTITY_VERIFICATION\n - PIN_CHANGE\n - EXPIRED_AUTH\n - CHARGE_APPLIED\n - ACCOUNT_STATUS_CHANGE\n - CARD_PROVISIONING\n - TOKEN_NOTIFICATION\n - SUCCESSFULLY_CREATED\n\n WebhookTry:\n type: object\n required:\n - when\n - status\n properties:\n when:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2012-05-04T19:42:32.987Z\"\n status:\n type: string\n example: \"success\"\n\n WebhooksConfig:\n type: object\n description: Authentication config, supports basic auth and custom headers.\n properties:\n basic_auth_username:\n type: string\n description: Username used when auth method is Basic Auth.\n example: \"username\"\n basic_auth_password:\n type: string\n description: Password used when auth method is Basic Auth.\n example: \"password\"\n custom_headers:\n type: array\n description: Custom header data.\n items:\n $ref: \"#/definitions/CustomHeader\"\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2012-05-04T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2012-05-04T19:42:32.987Z\"\n\n CustomHeader:\n type: object\n description: Custom header data.\n required:\n - name\n - value\n properties:\n header_name:\n type: string\n description: Custom header name.\n example: \"apikey\"\n header_value:\n type: string\n description: Custom header value.\n example: \"306e38e4-54be-469f-beca-4297129289d6\"\n\n SearchCriteria:\n type: object\n properties:\n query:\n type: string\n description: A search query.\n example: \"Transfer\"\n sort_by:\n type: string\n description: The way results should be sorted.\n example: \"By name\"\n order_by:\n description: The way results should be ordered.\n $ref: \"#/definitions/SortDirection\"\n matcher:\n description: Search matcher.\n $ref: \"#/definitions/SearchMatcher\"\n filters:\n type: array\n description: An array of search filters.\n items:\n $ref: \"#/definitions/SearchFilter\"\n cursors:\n description: Search cursors.\n $ref: \"#/definitions/Cursors\"\n limit:\n type: integer\n description: Search limit.\n format: int32\n\n SortDirection:\n type: string\n description: The way results should be ordered (ascending or descending).\n enum:\n - asc\n - desc\n\n SearchMatcher:\n description: Search matcher.\n type: string\n enum:\n - and\n - or\n\n SearchFilter:\n type: object\n properties:\n field:\n type: string\n description: Search filter field. Below you can find supported fields.\n\n\n * transaction_timestamp\n\n * parent_transaction_id\n\n * message_type\n\n * transaction_type\n\n * transmission_date_time\n\n * card_id\n\n * user_id\n\n * account_id1\n\n * account_id2\n\n * card_product_1\n\n * card_product_2\n\n * mcc\n\n * merchant_name\n\n * rrn\n\n * network_transaction_id\n\n * transaction_amount\n\n * transaction_currency\n\n * billing_amount\n\n * billing_currency\n\n * billing_amount_account\n\n * billing_currency_account\n\n * status_code\n\n * transfer_id\n\n * auth_expired_by\n\n * auth_expired_at\n\n * reference_number\n\n * sender_user_id\n\n * receiver_user_id\n\n\n To search, for example, by 'transaction_type', you may use the following values.\n\n * `PURCHASE` Any kind of card purchase, which can be identified in more detail via the 'pos_environment' field.\n\n * `CASH_WITHDRAWAL` Cardholder performed the withdrawal of cash at the ATM.\n\n * `REFUND` A credit note on the card which can happen in case the customer bought something and gave it back, for example.\n\n * `BALANCE_INQUIRY` Checking the account balance on the ATM.\n\n * `ACCOUNT_VERIFICATION` Adding the card on a payment gateway portal. Gateway will generate a transaction just to verify that the account is valid (0 amount trx).\n\n * `WALLET_DEBIT` Unloads related transaction.\n\n * `WALLET_CREDIT` Loads related transaction.\n\n * `WALLET_TRANSFER` Account to account transfer.\n\n * `OCT` Original Credit Transaction.\n\n * `AFT` Account Funding Transaction.\n\n example: \"ID\"\n operator:\n description: Search operator attributes.\n $ref: \"#/definitions/SearchOperator\"\n values:\n type: array\n description: An array of values.\n items:\n type: string\n example: \"21\"\n\n SearchOperator:\n type: string\n description: You can use such formats as \"any_of\" (in list), \"all_of\" (=), \"none_of\" (<>), \"less_than\" (<), \"less_or_equal\" (<=), \"greater_than\" (>), \"greater_or_equal\" (>=).\n enum:\n - any_of\n - all_of\n - none_of\n - less_than\n - less_or_equal\n - greater_than\n - greater_or_equal\n\n WebhooksIndex:\n type: object\n properties:\n id:\n type: string\n description: Webhook ID.\n example: \"400ad4b4-84f3-49c8-8892-b5f67c39be2f\"\n webhook_config_id:\n type: string\n description: Webhook configuration ID.\n example: \"129642d3-62b6-4009-9c75-b08867d7661d\"\n event:\n type: string\n description: Webhook event.\n example: \"TRANSACTION\"\n endpoint:\n type: string\n description: Webhook endpoint.\n example: \"https://webhook.site/bb123022-a739-410c-a2fe-341b4e9dcff5\"\n payload:\n type: string\n description: Notification payload.\n example: \"payload sample\"\n response:\n type: string\n description: Notification response.\n example: \"This URL has no default content configured.\"\n tries:\n type: string\n description: Number of tries.\n example: \"1\"\n last_try_date:\n type: string\n description: Date of last attempt.\n example: \"2024-05-16T12:57:58.720Z\"\n last_try_status:\n type: string\n description: Status of last attempt.\n example: \"success\"\n created:\n type: string\n description: Date and time of webhook creation.\n example: \"2024-05-16T12:57:58.720Z\"\n\n WebhooksIndexCollection:\n type: object\n properties:\n paging:\n $ref: \"#/definitions/Paging\"\n data:\n type: array\n description: An array of webhooks data.\n items:\n $ref: \"#/definitions/WebhooksIndex\"\n\n FxRatesUpsertRequest:\n type: object\n required:\n - card_product_id\n - fxrates\n properties:\n card_product_id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: ID of a card product for which FX rates are updated.\n fxrates:\n type: array\n minItems: 1\n description: An array of 'fxrates' parameters.\n items:\n $ref: \"#/definitions/FxRateUpsert\"\n\n FxRateUpsert:\n type: object\n required:\n - from_currency\n - to_currency\n - fx_rate\n properties:\n force_update:\n type: boolean\n default: false\n description: If true then the system ignores the variance percentage check and store the provided FX rate.\n from_currency:\n type: string\n pattern: \"^[A-Z]{3}\"\n example: USD\n description: 3-letter ISO_4217 code representing the currency, from which we are converting.\n to_currency:\n type: string\n pattern: \"^[A-Z]{3}\"\n example: USD\n description: 3-letter ISO_4217 code representing the currency, to which we are converting.\n fx_rate:\n type: string\n example: \"1234567890.1234567890\"\n description: Numeric FX conversation rate, must be higher than 0.\n\n FxRatesResponse:\n type: object\n properties:\n card_product_id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: ID of a card product for which FX rates are updated.\n fxrates:\n type: array\n minItems: 1\n description: An array of 'fxrates' parameters.\n items:\n $ref: \"#/definitions/FxRateResponse\"\n\n FxRateResponse:\n type: object\n properties:\n force_update:\n type: boolean\n description: If true then the system ignores the variance percentage check and stores the provided FX rate.\n from_currency:\n type: string\n pattern: \"^[A-Z]{3}\"\n example: USD\n description: 3-letter ISO_4217 code representing the currency, from which we are converting.\n to_currency:\n type: string\n pattern: \"^[A-Z]{3}\"\n example: USD\n description: 3-letter ISO_4217 code representing the currency, to which we are converting.\n fx_rate:\n type: string\n example: \"1234567890.1234567890\"\n description: Numeric FX conversation rate, must be higher than 0.\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when FX rate was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: Date and time when FX rate was updated.\n\n CardReplaceRequest:\n type: object\n required:\n - reference_card_id\n properties:\n reference_card_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7459\"\n description: Original terminated card ID for replacement. The replaced card should have status “TERMINATED”.\n activate_card:\n type: boolean\n description: This parameter is used to activate a card. The default value is 'true'.\n default: true\n\n CardVelocityLimitsLinkRequest:\n type: object\n properties:\n ids:\n type: array\n items:\n type: string\n example: \"velocitylimit02\"\n description: Velocity limits IDs.\n\n CardVelocityLimitsUnlinkRequest:\n type: object\n properties:\n ids:\n type: array\n items:\n type: string\n example: \"velocitylimit02\"\n description: Velocity limits IDs.\n\n AllowedCountries:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the allowed countries list.\n name:\n type: string\n example: \"Country list 1\"\n description: The country list name.\n minLength: 1\n maxLength: 50\n allow:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then it is a whitelist of country codes. If it is set as 'false', then it is a blacklist of country codes.\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the country list must be checked. If it is set as 'false', then the country list must not be checked. Default value is 'true'.\n country_codes:\n type: array\n description: ISO alpha 3-character country codes (e.g. USA, CAN etc.). At least one country code should be provided.\n items:\n type: string\n created:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n AllowedCountriesRequest:\n type: object\n required:\n - name\n - allow\n - country_codes\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the allowed countries list.\n name:\n type: string\n example: \"Country list 1\"\n description: The country list name.\n minLength: 1\n maxLength: 50\n allow:\n type: boolean\n description: If this parameter is set as 'true', then it is a whitelist of country codes. If it is set as 'false', then it is a blacklist of country codes.\n example: true\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the country list must be checked. If it is set as 'false', then the country list must not be checked. Default value is 'true'.\n country_codes:\n minItems: 1\n type: array\n description: ISO alpha 3-character country codes (e.g. USA, CAN etc.). At least one country code should be provided.\n items:\n type: string\n\n AllowedCountriesResponse:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the allowed countries list.\n name:\n type: string\n example: \"Country list 1\"\n description: The country list name.\n minLength: 1\n maxLength: 50\n allow:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then it is a whitelist of country codes. If it is set as 'false', then it is a blacklist of country codes.\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the country list must be checked. If it is set as 'false', then the country list must not be checked. Default value is 'true'.\n country_codes:\n type: array\n description: ISO alpha 3-character country codes (e.g. USA, CAN etc.). At least one country code should be provided.\n items:\n type: string\n\n MccInfo:\n type: object\n description: The MCC information.\n required:\n - allow\n - mcc_id\n properties:\n mcc_id:\n type: string\n description: 4-characters long MCC. At least one MCC should be provided.\n example: \"9852\"\n maxLength: 4\n allow:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then it is a whitelist of MCCs. If it is set as 'false', then it is a blacklist of MCCs.\n\n AllowedMccs:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the allowed MCCs list.\n name:\n type: string\n example: \"MCC List 01\"\n description: The MCC list name.\n minLength: 1\n maxLength: 50\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the MCC list must be checked. If it is set as 'false', then the MCC list must not be checked. Default value is 'true'.\n mccs:\n type: array\n description: The MCC information.\n items:\n $ref: \"#/definitions/MccInfo\"\n created:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n AllowedMccsRequest:\n type: object\n required:\n - name\n - allow\n - mccs\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: The unique identifier of the allowed MCCs list.\n name:\n type: string\n example: \"MCC List 01\"\n description: The MCC list name.\n minLength: 1\n maxLength: 50\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the MCC list must be checked. If it is set as 'false', then the MCC list must not be checked. Default value is 'true'.\n mccs:\n type: array\n description: The MCC information.\n items:\n $ref: \"#/definitions/MccInfo\"\n type: string\n maxLength: 4\n\n AllowedMccsResponse:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: Unique identifier of the MCCs.\n name:\n type: string\n example: \"Country list 1\"\n description: MCC list name.\n minLength: 1\n maxLength: 50\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the MCC list must be checked. If it is set as 'false', then the MCC list must not be checked. Default value is 'true'.\n mccs:\n type: array\n description: The MCC information.\n items:\n $ref: \"#/definitions/MccInfo\"\n\n AllowedCountriesCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load.\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load.\"\n data:\n type: array\n description: An array of allowed countries data.\n items:\n $ref: \"#/definitions/AllowedCountries\"\n\n AllowedCountriesUpdateRequest:\n type: object\n properties:\n name:\n type: string\n example: \"Country list 1\"\n description: The country list name.\n minLength: 1\n maxLength: 50\n allow:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then it is a whitelist of country codes. If it is set as 'false', then it is a blacklist of country codes.\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the country list must be checked. If it is set as 'false', then the country list must not be checked. Default value is 'true'.\n country_codes:\n type: array\n description: ISO alpha 3-character country codes (e.g. USA, CAN etc.). At least one country code should be provided.\n items:\n type: string\n\n AllowedMccsCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load.\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load.\"\n data:\n type: array\n description: An array of allowed MCCs data.\n items:\n $ref: \"#/definitions/AllowedMccs\"\n\n AllowedMccsUpdateRequest:\n type: object\n properties:\n active:\n type: boolean\n example: true\n description: If this parameter is set as 'true', then the MCC list must be checked. If it is set as 'false', then the MCC list must not be checked. Default value is 'true'.\n mccs:\n type: array\n description: The MCC information.\n items:\n $ref: \"#/definitions/MccInfo\"\n\n CardAuthSettings:\n type: object\n properties:\n allow_atm:\n type: boolean\n default: true\n description: This parameter indicates if ATM transactions are allowed or not.\n allow_pos:\n type: boolean\n default: true\n description: This parameter indicates if transactions originating from point of sales are allowed or not.\n allow_chip:\n type: boolean\n default: true\n description: This parameter indicates if chip transactions are allowed or not.\n allow_magstripe:\n type: boolean\n default: true\n description: This parameter indicates if magnetic stripe transactions are allowed or not.\n allow_chip_fallback:\n type: boolean\n default: true\n description: This parameter indicates if chip fallback to magnetic stripe transactions are allowed or not.\n allow_without_pin:\n type: boolean\n default: true\n description: This parameter indicates if authorization transactions without PIN are allowed or not.\n allow_ecommerce_non_3DS:\n type: boolean\n default: true\n description: This parameter indicates if e-commerce non-3DS transactions are allowed or not.\n allow_ecommerce_3DS:\n type: boolean\n default: true\n description: This parameter indicates if e-commerce 3DS transactions are allowed or not.\n allow_ecommerce_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if e-commerce transactions without CVV2/CVN2 are allowed or not.\n allow_account_verification_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if e-commerce account verification transactions without CVV2/CVN2 are allowed or not.\n allow_quasi_cash:\n type: boolean\n default: false\n description: This parameter indicates if a quasi cash transaction is allowed or not.\n allow_scheme_account_funding:\n type: boolean\n default: false\n description: This parameter indicates if a scheme account funding transaction is allowed or not.\n allow_scheme_credits:\n type: boolean\n default: false\n description: This parameter indicates if scheme credit transactions like Visa OCT or MC MoneySend are allowed or not.\n allow_contactless:\n type: boolean\n default: true\n description: This parameter indicates if contactless transactions are allowed or not.\n allowed_mccs_id:\n type: string\n maxLength: 36\n description: Allowed MCCS identifier.\n example: \"a8180db3-b2e9-4ae0-93cd-2a0b52a99737\"\n allowed_countries_id:\n type: string\n maxLength: 36\n description: Allowed countries identifier.\n example: \"8358c501-56a3-43b0-b2b3-a2c49f3c33ab\"\n\n UpdateCardAuthSettings:\n type: object\n properties:\n allow_atm:\n type: boolean\n default: true\n description: This parameter indicates if ATM transactions are allowed or not.\n allow_pos:\n type: boolean\n default: true\n description: This parameter indicates if transactions originating from point of sales are allowed or not.\n allow_chip:\n type: boolean\n default: true\n description: This parameter indicates if chip transactions are allowed or not.\n allow_magstripe:\n type: boolean\n default: true\n description: This parameter indicates if magnetic stripe transactions are allowed or not.\n allow_chip_fallback:\n type: boolean\n default: true\n description: This parameter indicates if chip fallback to magnetic stripe transactions are allowed or not.\n allow_without_pin:\n type: boolean\n default: true\n description: This parameter indicates if authorization transactions without PIN are allowed or not.\n allow_ecommerce_non_3DS:\n type: boolean\n default: true\n description: This parameter indicates if e-commerce non-3DS transactions are allowed or not.\n allow_ecommerce_3DS:\n type: boolean\n default: true\n description: This parameter indicates if e-commerce 3DS transactions are allowed or not.\n allow_ecommerce_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if e-commerce transactions without CVV2/CVN2 are allowed or not.\n allow_account_verification_without_CVV:\n type: boolean\n default: false\n description: This parameter indicates if e-commerce account verification transactions without CVV2/CVN2 are allowed or not.\n allow_quasi_cash:\n type: boolean\n default: false\n description: This parameter indicates if a quasi cash transaction is allowed or not.\n allow_scheme_account_funding:\n type: boolean\n default: false\n description: This parameter indicates if a scheme account funding transaction is allowed or not.\n allow_scheme_credits:\n type: boolean\n default: false\n description: This parameter indicates if scheme credit transactions like Visa OCT or MC MoneySend are allowed or not.\n allow_contactless:\n type: boolean\n default: true\n description: This parameter indicates if contactless transactions are allowed or not.\n allowed_mccs_id:\n type: string\n maxLength: 36\n description: Allowed MCCS identifier.\n example: \"a8180db3-b2e9-4ae0-93cd-2a0b52a99737\"\n allowed_countries_id:\n type: string\n maxLength: 36\n description: Allowed countries identifier.\n example: \"8358c501-56a3-43b0-b2b3-a2c49f3c33ab\"\n\n PerformKycCreateRequest:\n type: object\n required:\n - kyc_policy\n properties:\n id:\n type: string\n example: \"6daf85ea-f5f6-4e0b-b381-de5b7a9834e2\"\n description: Unique identifier of the KYC request.\n note:\n type: string\n example: \"Some note\"\n description: KYC note.\n maxLength: 500\n kyc_policy:\n $ref: '#/definitions/SupportedKycPolicies'\n\n UserExternalBankAccountDetailsRequest:\n type: object\n properties:\n iban:\n type: string\n maxLength: 34\n description: IBAN.\n example: \"AE460090000000123456789\"\n swift_code:\n type: string\n maxLength: 11\n description: SWIFT code.\n example: \"CBAUAEAAXXX\"\n bank_name:\n type: string\n maxLength: 50\n description: Bank name.\n example: \"CENTRAL BANK OF THE U.A.E\"\n routing_number:\n type: string\n maxLength: 10\n description: Routing number (unique, nine-digit number that functions as an address for the bank).\n example: \"800110101\"\n status:\n type: string\n description: User bank account details status.\n example: \"ACTIVE\"\n required:\n - iban\n - swift_code\n - bank_name\n\n UserExternalBankAccountDetailsUpdateRequest:\n type: object\n properties:\n iban:\n type: string\n maxLength: 34\n description: IBAN.\n example: \"AE460090000000123456789\"\n swift_code:\n type: string\n maxLength: 11\n description: SWIFT code.\n example: \"CBAUAEAAXXX\"\n bank_name:\n type: string\n maxLength: 50\n description: Bank name.\n example: \"CENTRAL BANK OF THE U.A.E\"\n routing_number:\n type: string\n maxLength: 10\n description: Routing number (unique, nine-digit number that functions as an address for the bank).\n example: \"800110101\"\n status:\n type: string\n description: User bank account details status.\n example: \"TERMINATED\"\n\n UserExternalBankAccountDetailsResponse:\n type: object\n properties:\n user_id:\n type: string\n description: Unique identifier of the user.\n example: \"a34b6c8e-28e5-4370-8234-aeca2b58c48d\"\n bank_details_id:\n type: string\n description: Unique identifier of the bank details.\n example: \"c5cebaf4-9b16-4e50-bae6-dca00210283c\"\n iban:\n type: string\n description: IBAN.\n example: \"AE460090000000123456789\"\n swift_code:\n type: string\n description: SWIFT code.\n example: \"CBAUAEAAXXX\"\n bank_name:\n type: string\n description: Bank name.\n example: \"CENTRAL BANK OF THE U.A.E\"\n routing_number:\n type: string\n description: Routing number (unique, nine-digit number that functions as an address for the bank).\n example: \"800110101\"\n\n Kyc:\n type: object\n properties:\n id:\n type: string\n description: Unique identifier of the KYC request.\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n maxLength: 36\n user_id:\n type: string\n example: \"055ef899-9650-4700-9497-e71826dd2825\"\n description: Unique identifier of the user.\n kyc_policy:\n $ref: '#/definitions/SupportedKycPolicies'\n note:\n type: string\n example: \"Some note\"\n description: KYC note.\n status:\n $ref: '#/definitions/KycStatus'\n status_reason_code:\n $ref: '#/definitions/KycStatusReasonCode'\n status_reason:\n example: \"KYC status reason\"\n description: The reason of KYC status.\n created:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n KycStatus:\n type: string\n description: KYC status.\n enum:\n - SUBMITTED\n - INPROGRESS\n - PASS\n - FAIL\n - INCONCLUSIVE\n\n KycStatusReasonCode:\n type: string\n description: >\n KYC Status Reason Code:\n * `S0`: SUBMITTED. KYC initial request submitted.\n * `I0`: INPROGRESS. KYC process is in-progress.\n * `P0`: PASS. KYC process is completed and passed.\n * `F0`: FAIL. KYC process is completed and failed.\n * `C0`: INCONCLUSIVE. KYC process outcome is inconclusive.\n * `C1`: INCONCLUSIVE. Refer to issuer.\n enum:\n - S0\n - I0\n - P0\n - F0\n - C0\n - C1\n\n SupportedKycPolicies:\n type: string\n maxLength: 40\n description: Supported KYC policies.\n enum:\n - UAE_INDIVIDUAL_PRIMARY\n - UAE_INDIVIDUAL_SECONDARY\n\n UserKycCollection:\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load\"\n data:\n type: array\n description: An array of KYC requests.\n items:\n $ref: \"#/definitions/Kyc\"\n\n OrderCreateRequest:\n type: object\n description: The order request data.\n required:\n - account_id\n - amount\n - currency\n - payment_method\n properties:\n dry_run:\n type: boolean\n default: false\n description: This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.\n account_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n maxLength: 36\n description: Unique identifier of the account in NymCard platform in which amount will be loaded.\n amount:\n type: number\n format: decimal\n example: 123.45\n x-nymos-currency: currency\n description: Amount which should be loaded in the account.\n currency:\n type: string\n example: AED\n description: Currency of the amount which should be loaded. The format is 3-letter ISO_4217 code. \"AED” is the only supported currency for now.\n pattern: \"^[A-Z]{3}$\"\n note:\n type: string\n maxLength: 500\n description: Additional description to the load account funds operation that is being performed.\n example: \"Funds load\"\n payment_method:\n $ref: \"#/definitions/OrderPaymentMethod\"\n redirect_url:\n type: string\n maxLength: 1000\n description: If payment_method is HOSTED_CHECKOUT, then this field is mandatory.\n example: \"https://localhost/redirect-url\"\n\n OrderPaymentMethod:\n type: string\n description: The payment gateway loading flow.\n enum:\n - HOSTED_CHECKOUT\n\n OrderStatus:\n type: string\n description: The order status.\n enum:\n - SUCCESS\n - ERROR\n - FAILED\n - CANCELED\n\n OrderResponse:\n type: object\n properties:\n order_id:\n type: string\n example: \"e82c3059-33af-4ed0-969a-7c23801dd770\"\n description: Unique identifier of the order.\n session_id:\n type: string\n example: \"SESSION0002034447366K45355737H1\"\n description: Unique identifier of the session.\n transaction_id:\n type: string\n example: \"111c3059-33af-4ed0-969a-7c23801dd555\"\n description: Unique identifier of the order transaction.\n merchant_id:\n type: string\n example: \"500532\"\n description: Unique identifier of the merchant.\n merchant_currency:\n type: string\n example: \"AED\"\n description: Merchant currency. The format is 3-letter ISO_4217 code. \"AED” is the only supported currency for now.\n reference_number:\n type: string\n example: \"1644426451325\"\n description: This parameter is relevant to DAPI orders.\n request:\n $ref: \"#/definitions/OrderCreateRequest\"\n result:\n $ref: \"#/definitions/OrderResult\"\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was updated.\n\n OrderResult:\n type: object\n description: The order result data.\n properties:\n fee_amount:\n type: number\n format: decimal\n example: 10.05\n description: Fee amount.\n status:\n $ref: \"#/definitions/OrderStatus\"\n status_reason:\n type: string\n example: \"INVALID_MFA\"\n description: The reason of order status. Below you can find the list of possible values, but be aware that new values can be added in future.\n\n * `ORDER_CREATED`\n\n * `SESSION_CREATION_FAILED`\n\n * `AUTHORIZED`\n\n * `ORDER_VOID`\n\n * `ORDER_VOID_FAILED`\n\n * `CANCELLED_BY_CARDHOLDER`\n\n * `TIMED_OUT`\n\n * `FAILED`\n\n * `INVALID_REQUEST`\n\n * `REQUEST_REJECTED`\n\n * `SERVER_BUSY`\n\n * `SERVER_FAILED`\n\n * `ABORTED`\n\n * `ACQUIRER_SYSTEM_ERROR`\n\n * `APPROVED`\n\n * `APPROVED_AUTO`\n\n * `APPROVED_PENDING_SETTLEMENT`\n\n * `AUTHENTICATION_FAILED`\n\n * `AUTHENTICATION_IN_PROGRESS`\n\n * `BALANCE_AVAILABLE`\n\n * `BALANCE_UNKNOWN`\n\n * `BLOCKED`\n\n * `CANCELLED`\n\n * `DECLINED`\n\n * `DECLINED_AVS`\n\n * `DECLINED_AVS_CSC`\n\n * `DECLINED_CSC`\n\n * `DECLINED_DO_NOT_CONTACT`\n\n * `DECLINED_INVALID_PIN`\n\n * `DECLINED_PAYMENT_PLAN`\n\n * `DECLINED_PIN_REQUIRED`\n\n * `DEFERRED_TRANSACTION_RECEIVED`\n\n * `DUPLICATE_BATCH`\n\n * `EXCEEDED_RETRY_LIMIT`\n\n * `EXPIRED_CARD`\n\n * `INSUFFICIENT_FUNDS`\n\n * `INVALID_CSC`\n\n * `LOCK_FAILURE`\n\n * `NOT_ENROLLED_3D_SECURE`\n\n * `NOT_SUPPORTED`\n\n * `NO_BALANCE`\n\n * `PARTIALLY_APPROVED`\n\n * `PENDING`\n\n * `REFERRED`\n\n * `SUBMITTED`\n\n * `SYSTEM_ERROR`\n\n * `UNKNOWN`\n\n * `UNSPECIFIED_FAILURE`\n\n CreateOrderTokenRequest:\n type: object\n required:\n - account_id\n properties:\n account_id:\n type: string\n example: \"e6b500c7-b37b-46cf-baae-e1b4f43e8749\"\n description: ID of the account, to which funds will be loaded.\n\n OrderTokenResponse:\n type: object\n properties:\n token:\n type: string\n description: The token itself.\n example: \"42504465-5410-46fc-94e8-aa5bc062ada9%7Ctenant\"\n expire_at:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when token will expire.\n\n VtsTokenCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load\"\n data:\n type: array\n description: An array of token data.\n items:\n $ref: \"#/definitions/VtsToken\"\n\n VtsToken:\n type: object\n properties:\n id:\n type: string\n description: Generated token ID.\n example: \"202ff34d-8d6f-42f3-b728-4c59f2158591\"\n token_requestor_id:\n type: string\n example: \"40000073\"\n description: Token requestor ID passed in the API request.\n token_reference_id:\n type: string\n example: \"DNI...04\"\n description: Token reference ID passed in the API request.\n pan_reference_id:\n type: string\n example: \"V-420...90\"\n description: PAN reference ID passed in the API request.\n client_wallet_account_id:\n type: string\n example: \"897...31\"\n description: Client wallet account ID passed in the API request.\n lifecycle_trace_id:\n type: integer\n format: int64\n description: Lifecycle trace ID.\n card_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: System internal ID of the card that is resolved using the clear PAN coming in the API request.\n user_id:\n type: string\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: Internal ID of the user.\n pan_source:\n $ref: \"#/definitions/PanSource\"\n card_last_four:\n type: string\n example: \"4587\"\n description: Last four PAN digits.\n consumer_entry_mode:\n $ref: \"#/definitions/ConsumerEntryMode\"\n token_info:\n $ref: \"#/definitions/VtsTokenTokenInfo\"\n device_info:\n $ref: \"#/definitions/VtsTokenDeviceInfo\"\n created:\n type: string\n description: The date and time when request was created.\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n x-nymos-index: desc\n updated:\n type: string\n description: The date and time when request was modified.\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n x-nymos-index: desc\n\n VtsTokenDeviceInfo:\n type: object\n description: The token device information.\n properties:\n device_id:\n type: string\n example: \"zmi...zA\"\n description: Received device ID.\n device_type:\n type: string\n example: \"MOBILE_PHONE\"\n description: The device type passed in the API request.\n device_name:\n type: string\n example: \"My Phone\"\n description: The device name passed in the API request.\n device_number:\n type: string\n example: \"86...30\"\n description: The device number.\n os_type:\n $ref: '#/definitions/OSType'\n os_version:\n type: string\n description: The version of the operating system running on the device.\n example: \"4.4.4\"\n os_build_id:\n type: string\n description: The operating system build identifier.\n example: \"KTU84M\"\n device_manufacturer:\n type: string\n description: The manufacturer of the device.\n example: \"Samsung\"\n device_brand:\n type: string\n description: The brand name of the device.\n example: \"Galaxy\"\n device_model:\n type: string\n description: The specific model of the device.\n example: \"SGH-T999\"\n\n VtsTokenTokenInfo:\n type: object\n description: The token information.\n properties:\n token:\n type: string\n example: \"451...75\"\n description: The token itself.\n token_type:\n $ref: '#/definitions/TokenType'\n token_status:\n $ref: '#/definitions/TokenStatus'\n token_expiration_date:\n type: string\n example: \"01/2021\"\n description: The token expiration date.\n token_activation_date:\n type: string\n format: date-time\n description: The activation date of the token.\n example: \"2018-01-02T19:42:32.987Z\"\n last_token_status_modified:\n type: string\n format: date-time\n example: \"2019-01-02T19:42:32.987Z\"\n description: The date and time when token status was modified.\n\n\n\n TokenType:\n type: string\n description: The type of the token.\n example: \"ECOMMERCE\"\n enum:\n - SECURE_ELEMENT\n - HCE\n - CARD_ON_FILE\n - ECOMMERCE\n - QRC\n\n TokenStatus:\n type: string\n description: The status of the token.\n example: \"ACTIVE\"\n enum:\n - ACTIVE\n - INACTIVE\n - SUSPENDED\n - DEACTIVATED\n\n PanSource:\n type: string\n example: \"KEY_ENTERED\"\n description: The source of PAN.\n enum:\n - KEY_ENTERED\n - ON_FILE\n - MOBILE_BANKING_APP\n - TOKEN\n - CHIP_DIP\n - CONTACTLESS_TAP\n\n ConsumerEntryMode:\n type: string\n example: \"CAMERA_CAPTURED\"\n enum:\n - KEY_ENTERED\n - CAMERA_CAPTURED\n - UNKNOWN\n description: The method of consumer entry.\n\n OSType:\n type: string\n example: \"IOS\"\n description: The type of operating system.\n enum:\n - ANDROID\n - IOS\n - WINDOWS\n - BLACKBERRY\n - TIZEN\n - OTHER\n\n TokenStatusChangeRequest:\n type: object\n required:\n - status\n - status_reason_code\n properties:\n status:\n $ref: '#/definitions/StatusToChange'\n status_reason_code:\n $ref: '#/definitions/StatusReasonCodeToChange'\n note:\n type: string\n description: Some additional notes.\n example: \"Additional info\"\n maxLength: 254\n\n StatusToChange:\n type: string\n description: New status.\n enum:\n - ACTIVE\n - SUSPENDED\n - TERMINATED\n\n StatusReasonCodeToChange:\n type: string\n description: >\n New Status Reason Code:\n * `A0`: First time activation: when activated from INACTIVE to ACTIVE status.\n * `A1`: Resumed from Suspended status: when token is moved back to ACTIVE status.\n * `S0`: Temporary suspension: initiated by the user or system user or the system.\n * `T0`: Token is closed by user.\n * `T1`: Token is closed by issuer.\n enum:\n - A0\n - A1\n - S0\n - T0\n - T1\n\n EncryptCardDetailsResponse:\n type: object\n properties:\n status:\n $ref: \"#/definitions/EncryptResponseStatus\"\n status_reason_code:\n $ref: \"#/definitions/ErrorCode\"\n card_details:\n type: string\n example: \"encrypted_card_details\"\n description: |\n Encrypted card details.\n This parameter is conditional and will be returned only if status=SUCCESS.\n\n EncryptResponseStatus:\n type: string\n description: Status of encrypted card details.\n enum:\n - SUCCESS\n - FAILED\n\n ErrorCode:\n type: string\n description: >\n Status reason code of encrypted card details:\n * `F0`: Internal server error.\n * `F1`: Nonce is expired.\n * `F2`: Signature is invalid.\n * `F3`: card_id is invalid.\n * `F4`: Keys required for encryption are missing in system.\n * `F5`: Tokenization setting is missing in system.\n enum:\n - F0\n - F1\n - F2\n - F3\n - F4\n - F5\n\n SimulateTransactionRequest:\n type: object\n properties:\n message_type:\n $ref: '#/definitions/SimulateTransactionMessageType'\n example: \"AUTHORIZATION\"\n transaction_type:\n $ref: '#/definitions/SimulateTransactionTransactionType'\n example: \"PURCHASE\"\n card_number:\n type: string\n example: \"4434221121121123\"\n description: The card number.\n card_expiry_date:\n type: string\n example: \"2212\"\n description: The card expiry date in 'yymm' format.\n cvv2:\n type: string\n example: \"642\"\n description: The card CVV.\n transaction_amount:\n type: integer\n example: 20\n description: The amount of transaction.\n transaction_currency:\n type: string\n example: \"USD\"\n description: The currency of the transaction.\n billing_amount:\n type: integer\n example: 20\n description: The billing amount.\n billing_currency:\n type: string\n description: The billing currency.\n example: \"USD\"\n date_time_acquirer:\n type: string\n example: \"0928201947\"\n description: The date of the transaction at the acquirer end when this transaction was performed. The format is \"mmddhhmmss\" (MonthDateHoursSec).\n network:\n type: string\n example: \"VISA\"\n description: The network scheme.\n network_transaction_id:\n type: string\n description: The unique transaction ID filled by the Network/Scheme. This field is only applicable for \"MASTERCARD\" network scheme.\n example: \"234551234561008\"\n maxLength: 25\n terminal_id:\n type: string\n example: \"TERMID01\"\n description: The unique identifier of the merchant's terminal.\n merchant_id:\n type: string\n example: \"MERCHID01\"\n description: The unique identifier of the merchant.\n mcc:\n type: string\n example: \"5411\"\n description: The merchant category code.\n merchant_name:\n type: string\n description: The merchant name.\n example: \"ACQUIRER NAME\"\n maxLength: 25\n merchant_country:\n type: string\n example: \"USA\"\n description: The merchant country in 3 digit ISO Alpha country code format.\n merchant_city:\n type: string\n example: \"New York\"\n description: The merchant city.\n maxLength: 13\n pin:\n type: string\n example: \"2341\"\n description: The card PIN.\n\n SimulateTransactionMessageType:\n type: string\n description: The type of transaction simulation message.\n enum:\n - AUTHORIZATION\n\n SimulateTransactionTransactionType:\n type: string\n description: The type of transaction simulation.\n enum:\n - PURCHASE\n - CASH_WITHDRAWAL\n - REFUND\n - BALANCE_INQUIRY\n - ACCOUNT_VERIFICATION\n\n SimulateTransactionResponse:\n type: object\n description: The response of transaction simulation.\n properties:\n message_type:\n $ref: '#/definitions/SimulateTransactionMessageType'\n example: \"AUTHORIZATION\"\n transaction_type:\n $ref: '#/definitions/SimulateTransactionTransactionType'\n example: \"PURCHASE\"\n transaction_amount:\n type: integer\n example: 20.00\n description: The amount of transaction.\n transaction_currency:\n type: string\n example: \"USD\"\n description: The currency of the transaction.\n billing_amount:\n type: integer\n example: 20.00\n description: The billing amount.\n billing_currency:\n type: string\n example: \"USD\"\n description: The billing currency.\n date_time_acquirer:\n type: string\n example: \"0928201947\"\n description: The date of the transaction at the acquirer end when this transaction was performed. The format is \"mmddhhmmss\" (MonthDateHoursSec).\n network:\n type: string\n example: \"VISA\"\n description: The network scheme.\n network_transaction_id:\n type: string\n description: The unique transaction ID filled by the Network/Scheme. This field is only applicable for \"MASTERCARD\" network scheme.\n example: \"234551234561008\"\n maxLength: 25\n terminal_id:\n type: string\n example: \"TERMID01\"\n description: The unique identifier of the merchant's terminal.\n merchant_id:\n type: string\n example: \"MERCHID01\"\n description: The unique identifier of the merchant.\n mcc:\n type: string\n example: \"5411\"\n description: The merchant category code.\n merchant_name:\n type: string\n description: The merchant name.\n example: \"ACQUIRER NAME\"\n maxLength: 25\n merchant_country:\n type: string\n example: \"USA\"\n description: The merchant country in 3 digit ISO Alpha country code format.\n merchant_city:\n type: string\n example: \"New York\"\n description: The merchant city.\n maxLength: 13\n id:\n type: string\n example: \"135015000017\"\n description: The transaction ID generated by the system.\n status_code:\n type: string\n example: \"00\"\n description: The status code of the transaction. Possible values are \"00\", \"55\" etc.. For more info please refer to the standard status codes defined by Visa and Mastercard.\n status_description:\n type: string\n example: \"Approved\"\n description: The short description of the transaction status (Approved/Declined). For example, \"00\" - \"Approved\", \"55\" - \"Bad PIN\" etc.. For more info please refer to the standard status codes defined by Visa and Mastercard.\n available_balance:\n type: string\n example: \"9900.00\"\n description: The available balance.\n ledger_balance:\n type: string\n example: \"10000.00\"\n description: The ledger balance.\n stan:\n type: string\n example: \"000017\"\n description: The system trace audit number of the transaction.\n rrn:\n type: string\n example: \"135015000017\"\n description: The retrieval reference number of the transaction.\n auth_id_response:\n type: string\n example: \"575620\"\n description: The Auth ID response of the transaction.\n sweep_details:\n type: array\n description: An array of sweeping details. Sweeping is performed upon insufficient funds - they are pulled from the other wallets and are credited to the wallet on which transaction is received.\n items:\n $ref: \"#/definitions/SimulateTransactionSweepDetails\"\n\n\n Checks:\n type: string\n description: Reports which need to be generated by the client. The values are `DOCUMENT` and `FACIAL_SIMILARITY_VIDEO`.\n enum:\n - DOCUMENT\n - FACIAL_SIMILARITY_VIDEO\n UserIncorporationType:\n type: string\n description: This parameter indicates whether this business entity is Limited, LLC, Free-zone or anything else.\n enum:\n - LTD\n - LLC\n - FZE\n - FZCO\n - FZ-LLC\n - INC\n - FOUNDATION\n - TRUST\n - FUND\n - PUBLIC_TRADED\n - GOVT_OWNED\n - LLP\n - OTHER\n\n UserGroupAdditionalInfo:\n type: object\n description: The additional information, which describes whether entity is a part of a group etc.\n properties:\n group_entity:\n type: boolean\n description: This parameter describes whether the entity is a part of a group. If yes, then the name/details should be given in the 'entity_details' field.\n independent_entity:\n type: boolean\n description: This parameter describes whether the entity is acting on its own behalf. If yes, then the name should be given in the 'entity_details' field.\n special_investment:\n type: boolean\n description: This parameter describes whether the entity is a special investment Vehicle/ Trust/ Foundation part of a 'structure' of the ultimate beneficial owner.\n entity_details:\n type: string\n description: The name of the individual or entity,on whose behalf the entity is acting, should be provided in this field.\n maxLength: 100\n example: \"Nexxo LLC\"\n\n UserPepCheckInfo:\n type: object\n description: The information about checking politically exposed persons (“PEPs”) among main shareholders, directors of the entity.\n properties:\n pri_pep_check:\n type: boolean\n description: This parameter indicates whether any of main shareholders, directors of the entity, or any other persons (signature) have ever been or currently are politically exposed persons (“PEPs”). Applicable values are true/false.\n pri_pep_check_name:\n type: string\n description: If the 'pri_pep_check' parameter is set as 'true', then a name should be provided in this field.\n maxLength: 50\n example: \"John Smith\"\n sec_pep_check:\n type: boolean\n description: This parameter indicates whether any family members of main shareholders, directors of the entity, or of any other persons (signature) have ever been or currently are politically exposed persons (“PEPs”). Applicable values are true/false.\n sec_pep_check_name:\n type: string\n description: If the 'sec_pep_check' parameter is set as 'true', then a name should be provided in this field.\n maxLength: 50\n example: \"Adam Smith\"\n\n UserNoOfEmployees:\n type: integer\n format: int32\n example: 25\n description: This parameter describes the number of employees for the business entity.\n\n UserDueDiligenceDeclaration:\n type: object\n description: The information about due diligence declaration.\n properties:\n bankruptcy_declaration:\n type: boolean\n description: Has the Entity, any Owner or Controlling Person ever filed for bankruptcy, been denied credit, or does the Entity, Owner, or Controlling person currently have a pending proceeding or judgment against it? Possible values are true/false. If yes, please also provide the full details including who, when, where, and any other relevant information.\n disciplinary_declaration:\n type: boolean\n description: Has the Entity, any Owner or Controlling Person ever been the subject of any interrogation, investigations, or disciplinary proceedings by any government or non- government entity, whether in the UAE or elsewhere? Possible values are true/false.\n fraud_aml_declaration:\n type: boolean\n description: Has the Entity, any Owner or Controlling Person ever been formally investigated, accused, charged, or convicted of any felony or misdemeanor such as fraud, money laundering, narcotics, drug trafficking, human smuggling or terrorist financing? Possible values are true/false. If yes, please also provide an explanation of the facts, including the date of any formal charges, date of conviction or judgment, and the court in which such charges were brought or adjudicated.\n disqualification_declaration:\n type: boolean\n description: Has the Entity, any Owner or Controlling person (s) ever been the subject of any interrogation, investigations, Disqualification or disciplinary proceedings by any government or non-government entity, whether in the UAE or elsewhere? Possible values are true/false.\n conviction_accusition_declaration:\n type: boolean\n description: Has the Entity, any Owner or Controlling person, ever been convicted or accused of practicing any unauthorized or unlicensed activities or been investigated for the possible carrying out of unauthorized or unlicensed activities, whether in the UAE or elsewhere? Possible values are true/false.\n breach_of_law_declaration:\n type: boolean\n description: Has the Entity, Any Owner or Controlling person, ever demonstrated unwillingness to comply with any laws, regulations, or instructions, or in any way helped or abetted another person in breach of any laws, regulations, or instructions, whether in the UAE or elsewhere? Possible values are true/false.\n\n LinkedRelationships:\n type: object\n properties:\n parent_user:\n type: string\n example: \"ABC\"\n description: The unique identifier of parent user.\n child_users:\n type: array\n example: \"signature1\"\n description: An array of child user IDs.\n items:\n type: string\n\n IdvPolicyResponse:\n type: object\n properties:\n id:\n type: string\n maxLength: 32\n description: The unique identifier of IDV policy.\n example: \"4b4eabfcf8394e519dc13dc25c5eddd6\"\n idv_policy_name:\n type: string\n example: \"IDV_POLICY_INDIVIDUAL_PRIMARY\"\n description: The name of IDV policy. This value can be `IDV_POLICY_INDIVIDUAL_PRIMARY` or `IDV_POLICY_INDIVIDUAL_SECONDARY`.\n checks:\n type: array\n description: Reports which need to be generated by the client. The values are `DOCUMENT` and `FACIAL_SIMILARITY_VIDEO`.\n items:\n $ref: '#/definitions/Checks'\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: 2012-05-04T19:42:32.987Z\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: 2012-05-04T19:42:32.987Z\n\n IdvPolicyCollection:\n properties:\n after:\n type: string\n description: Durable version of current results that can be used on the next load.\n has_more:\n type: boolean\n description: Indicates whether there are more data to load.\n data:\n type: array\n items:\n $ref: \"#/definitions/IdvPolicyResponse\"\n\n IdvPolicyUpdateRequest:\n type: object\n properties:\n checks:\n type: array\n description: Reports which need to be generated by the client. The values are `DOCUMENT` and `FACIAL_SIMILARITY_VIDEO`.\n items:\n $ref: '#/definitions/Checks'\n\n SupportedIdvPolicies:\n type: string\n description: Supported IDV policies.\n enum:\n - IDV_POLICY_INDIVIDUAL_PRIMARY\n - IDV_POLICY_INDIVIDUAL_SECONDARY\n\n SourceChannel:\n type: string\n description: Type of source channel only applicable for transaction_type = TRANSFERS. Default value is \"ANY\".\n enum:\n - ANY\n - MPGS\n - DAPI\n - LEAN\n\n BalanceLimitObject:\n type: object\n required:\n - balance_limit_id\n properties:\n balance_limit_id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of the balance limit.\n\n UserDocumentReportCollection:\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load\"\n data:\n type: array\n description: User document report data.\n items:\n $ref: \"#/definitions/UserDocumentReportResponse\"\n\n UserDocumentReportResponse:\n type: object\n properties:\n id:\n type: string\n description: The unique identifier of report.\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n maxLength: 36\n validation_result:\n $ref: '#/definitions/ValidationResult'\n name:\n type: string\n description: The name of report.\n check_id:\n type: string\n description: The ID of the check to which the report belongs.\n created_at:\n type: string\n description: The date and time at which the report was first initiated.\n format: date-time\n example: 2012-05-04T19:42:32.987Z\n result:\n type: string\n description: The result of the report.\n status:\n type: string\n description: The current state of the report\n sub_result:\n type: string\n description: The sub result of the report.\n\n ValidationResult:\n type: object\n description: Report results.\n properties:\n date_of_birth:\n $ref: '#/definitions/UserDocumentReportDetails'\n date_of_expiry:\n $ref: '#/definitions/UserDocumentReportDetails'\n document_numbers:\n $ref: '#/definitions/UserDocumentReportDetails'\n document_type:\n $ref: '#/definitions/UserDocumentReportDetails'\n first_name:\n $ref: '#/definitions/UserDocumentReportDetails'\n last_name:\n $ref: '#/definitions/UserDocumentReportDetails'\n gender:\n $ref: '#/definitions/UserDocumentReportDetails'\n age:\n $ref: '#/definitions/UserDocumentReportDetails'\n issuing_country:\n $ref: '#/definitions/UserDocumentReportDetails'\n nationality:\n $ref: '#/definitions/UserDocumentReportDetails'\n multiple_data_sources_present:\n $ref: '#/definitions/UserDocumentReportDetails'\n additional_document_information:\n $ref: '#/definitions/UserDocumentReportDetails'\n mrz:\n $ref: '#/definitions/UserDocumentReportDetailsWithArrayValue'\n barcode:\n $ref: '#/definitions/UserDocumentReportDetailsWithArrayValue'\n image:\n $ref: '#/definitions/UserDocumentReportDetails'\n visual:\n $ref: '#/definitions/UserDocumentReportDetails'\n issuing_authority:\n $ref: '#/definitions/UserDocumentReportDetails'\n police_record:\n $ref: '#/definitions/UserDocumentReportDetails'\n\n UserDocumentReportDetails:\n type: object\n properties:\n status:\n $ref: '#/definitions/UserReportDocumentStatus'\n description:\n type: array\n description: Parameter's description from user document report.\n items:\n type: string\n value:\n type: string\n description: Parameter's value from user document report.\n\n UserDocumentReportDetailsWithArrayValue:\n allOf:\n - $ref: '#/definitions/UserDocumentReportDetails'\n - type: object\n properties:\n value:\n type: array\n description: User document report value.\n items:\n type: string\n\n\n UserReportDocumentStatus:\n type: string\n description: Parameter's status from user document report.\n enum:\n - PASS\n - FAIL\n\n CardProductType:\n type: string\n example: \"PREPAID\"\n description: |\n Card product type.\n enum:\n - PREPAID\n\n InternalAuthSettings:\n type: object\n description: An array of authorization settings.\n properties:\n allow_atm:\n type: boolean\n description: This parameter shall indicate if ATM transactions are allowed or not.\n allow_pos:\n type: boolean\n description: This parameter shall indicate if transactions originating from point of sales are allowed or not.\n allow_chip:\n type: boolean\n description: This parameter shall indicate if chip transactions are allowed or not.\n allow_magstripe:\n type: boolean\n description: This parameter shall indicate if magnetic stripe transactions are allowed or not.\n allow_chip_fallback:\n type: boolean\n description: This parameter shall indicate if chip fallback to magnetic stripe transactions are allowed or not.\n allow_without_pin:\n type: boolean\n description: This parameter shall indicate if authorization transactions without PIN are allowed or not.\n allow_ecommerce_non_3DS:\n type: boolean\n description: This parameter shall indicate if Ecommerce non-3DS transactions are allowed or not.\n allow_ecommerce_3DS:\n type: boolean\n description: This parameter shall indicate if Ecommerce 3DS transactions are allowed or not.\n allow_ecommerce_without_CVV:\n type: boolean\n description: This parameter shall indicate if Ecommerce transactions without CVV2/CVN2 are allowed or not.\n allow_account_verification_without_CVV:\n type: boolean\n description: This parameter shall indicate if Ecommerce account verification transactions without CVV2/CVN2 are allowed or not.\n allow_quasi_cash:\n type: boolean\n description: This parameter shall indicate if a quasi cash transaction is allowed or not.\n allow_scheme_account_funding:\n type: boolean\n description: This parameter shall indicate if a scheme account funding transaction is allowed or not.\n allow_scheme_credits:\n type: boolean\n description: This parameter shall indicate if scheme credit transactions like Visa OCT or MC MoneySend are allowed or not.\n allow_contactless:\n type: boolean\n description: This parameter shall indicate if contactless transactions are allowed or not.\n allowed_mccs_id:\n type: string\n maxLength: 36\n description: Allowed MCCS identifier.\n example: \"a8180db3-b2e9-4ae0-93cd-2a0b52a99737\"\n allowed_countries_id:\n type: string\n maxLength: 36\n description: Allowed countries identifier.\n example: \"8358c501-56a3-43b0-b2b3-a2c49f3c33ab\"\n\n AccountTokenResponse:\n type: object\n properties:\n token:\n type: string\n description: The account token itself.\n example: \"ODjoP1.....k6o=\"\n expiry:\n type: integer\n format: int32\n example: 3600\n description: Token expiry time in seconds. Default value for expiry is 3600 sec.\n\n CreateTokenRequest:\n type: object\n properties:\n channel:\n $ref: \"#/definitions/LoadFundsChannel\"\n\n LoadFundsChannel:\n type: string\n description: Load funds channel.\n example: \"DAPI\"\n enum:\n - DAPI\n - LEAN\n\n FxRateGroupsResponse:\n type: object\n properties:\n data:\n type: array\n description: An array of FX rate group data.\n items:\n $ref: \"#/definitions/FxRateGroupResponse\"\n\n FxRateProvidersResponse:\n type: object\n properties:\n data:\n type: array\n description: An array of FX rate provider data.\n items:\n $ref: \"#/definitions/FxRateProviderResponse\"\n\n FxRateGroupResponse:\n type: object\n properties:\n id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of a FX rate group.\n providerId:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of a FX rate provider.\n providerGroupId:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of a FX rate provider group.\n status:\n $ref: \"#/definitions/FxRateGroupStatus\"\n isDefault:\n type: boolean\n description: This parameter indicates whether this group is default or not.\n example: true\n created:\n type: string\n format: date-time\n description: The date and time when request was created.\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2018-01-02T19:42:32.987Z\"\n\n FxRateGroupStatus:\n type: string\n description: The status of FX rate group.\n example: \"ACTIVE\"\n enum:\n - ACTIVE\n - INACTIVE\n\n FxRateProviderResponse:\n type: object\n properties:\n id:\n type: string\n description: The unique identifier of FX rate provider.\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n name:\n type: string\n maxLength: 40\n example: \"Converter\"\n description: The name of FX rate provider.\n type:\n $ref: '#/definitions/FxRateProviderType'\n status:\n $ref: '#/definitions/FxRateProviderStatus'\n fxRateProviderGroups:\n type: array\n description: An array of FX rate provider groups.\n items:\n $ref: \"#/definitions/FxRateProviderGroup\"\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n FxRateProviderType:\n type: string\n description: This field identifies whether the FX rate provider is third party or being managed internally by NymCard.\n example: \"INTERNAL\"\n enum:\n - INTERNAL\n - EXTERNAL\n\n FxRateProviderStatus:\n type: string\n description: FX rate provider status.\n example: \"ACTIVE\"\n enum:\n - ACTIVE\n - INACTIVE\n\n FxRateProviderGroup:\n type: object\n description: FX rate provider group.\n properties:\n provider_group_id:\n type: string\n maxLength: 36\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of a FX rate provider group.\n status:\n $ref: '#/definitions/FxRateProviderStatus'\n\n Charges:\n type: object\n required:\n - id\n - description\n - type\n - currency\n - charge_type\n properties:\n id:\n type: string\n maxLength: 36\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of the charge.\n description:\n type: string\n description: Description of the charge.\n example: \"Withdrawal charges\"\n maxLength: 50\n type:\n description: The charge type.\n example: \"FLAT\"\n $ref: \"#/definitions/Type\"\n currency:\n description: The charge currency.\n example: \"USD\"\n type: string\n pattern: \"^[A-Z]{3}$\"\n amount:\n description: The charge amount.\n example: 2\n type: number\n minimum: 0\n x-nymos-currency: currency\n percentage:\n description: Percentage of the charge.\n example: 15\n type: number\n minimum: 0\n maximum: 100\n active:\n type: boolean\n description: The charge status.\n example: true\n charge_type:\n description: The type of charge operation.\n example: \"PHYSICAL_CARD_ISSUANCE\"\n $ref: \"#/definitions/ChargesType\"\n frequency:\n description: Frequency of charging.\n example: \"MONTHLY\"\n $ref: '#/definitions/ChargesFrequency'\n application_type:\n $ref: '#/definitions/ChargesApplicationType'\n example: \"SCHEDULED\"\n description: Application type. If \"application_type\" is \"INSTANT\", \"account_type\" should be \"MASTER\".\n account_type:\n $ref: '#/definitions/ChargesAccountType'\n example: \"MASTER\"\n description: Account type.\n allow_overdraft:\n type: boolean\n description: This field indicates whether overdraft is allowed or not. The default value is 'false'.\n default: false\n created:\n description: The date and time when request was created.\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n modified:\n description: The date and time when request was modified.\n type: string\n format: date-time\n example: \"2018-01-02T19:42:32.987Z\"\n\n ChargesCreateRequest:\n type: object\n required:\n - description\n - type\n - currency\n - charge_type\n properties:\n id:\n type: string\n maxLength: 36\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of the charge.\n description:\n type: string\n description: Description of the charge.\n example: \"Withdrawal charges\"\n maxLength: 50\n type:\n description: The charge type.\n example: \"FLAT\"\n $ref: \"#/definitions/Type\"\n currency:\n description: The charge currency.\n example: \"USD\"\n type: string\n pattern: \"^[A-Z]{3}$\"\n amount:\n description: The charge amount.\n example: 2\n type: number\n minimum: 0\n x-nymos-currency: currency\n percentage:\n description: Percentage of the charge.\n example: 15\n type: number\n minimum: 0\n maximum: 100\n active:\n type: boolean\n description: The charge status.\n example: true\n charge_type:\n description: The type of charge operation.\n example: \"PHYSICAL_CARD_ISSUANCE\"\n $ref: \"#/definitions/ChargesType\"\n frequency:\n description: Frequency of charging.\n example: \"MONTHLY\"\n $ref: '#/definitions/ChargesFrequency'\n application_type:\n $ref: '#/definitions/ChargesApplicationType'\n example: \"SCHEDULED\"\n description: Application type. If \"application_type\" is \"INSTANT\", \"account_type\" should be \"MASTER\".\n account_type:\n $ref: '#/definitions/ChargesAccountType'\n example: \"MASTER\"\n description: Account type.\n allow_overdraft:\n type: boolean\n description: This field indicates whether overdraft is allowed or not. The default value is 'false'.\n default: false\n\n ChargesUpdateRequest:\n type: object\n properties:\n description:\n type: string\n description: Description of the charge.\n example: \"Withdrawal charges\"\n maxLength: 50\n type:\n description: The charge type.\n example: \"FLAT\"\n $ref: \"#/definitions/Type\"\n currency:\n description: The charge currency.\n example: \"USD\"\n type: string\n pattern: \"^[A-Z]{3}$\"\n amount:\n description: The charge amount.\n example: 2\n type: number\n minimum: 0\n x-nymos-currency: currency\n percentage:\n description: Percentage of the charge.\n example: 15\n type: number\n minimum: 0\n maximum: 100\n active:\n type: boolean\n description: The charge status.\n example: true\n charge_type:\n description: The type of charge operation.\n example: \"PHYSICAL_CARD_ISSUANCE\"\n $ref: \"#/definitions/ChargesType\"\n frequency:\n description: Frequency of charging.\n example: \"MONTHLY\"\n $ref: '#/definitions/ChargesFrequency'\n application_type:\n $ref: '#/definitions/ChargesApplicationType'\n example: \"SCHEDULED\"\n description: Application type. If \"application_type\" is \"INSTANT\", \"account_type\" should be \"MASTER\".\n account_type:\n $ref: '#/definitions/ChargesAccountType'\n example: \"MASTER\"\n description: Account type.\n allow_overdraft:\n type: boolean\n description: This field indicates whether overdraft is allowed or not. The default value is 'false'.\n default: false\n\n ChargeStatusHistory:\n type: object\n properties:\n id:\n type: string\n example: \"d089a80f-e641-4045-8a80-54841e4a7458\"\n description: The unique identifier of the charge history.\n history:\n type: array\n description: History of charge changes.\n items:\n $ref: \"#/definitions/ChargesStatusChange\"\n\n ChargesStatusChange:\n type: object\n properties:\n old_status:\n description: Old charge status.\n type: boolean\n example: false\n new_status:\n example: true\n description: New charge status.\n type: boolean\n modified:\n type: string\n format: date-time\n description: The date and time when request was modified.\n example: \"2018-01-02T19:42:32.987Z\"\n\n ChargesCollection:\n type: object\n properties:\n has_more:\n type: boolean\n description: This parameter indicates whether there are more data to load.\n after:\n type: string\n description: Durable version of current results that can be used on the next load.\n data:\n type: array\n description: An array of charges.\n items:\n $ref: \"#/definitions/Charges\"\n\n ChargesType:\n type: string\n description: The type of charge operation.\n example: \"PHYSICAL_CARD_ISSUANCE\"\n enum:\n - PHYSICAL_CARD_ISSUANCE\n - VIRTUAL_CARD_ISSUANCE\n - PHYSICAL_CARD_REPLACEMENT\n - VIRTUAL_CARD_REPLACEMENT\n - DELIVERY\n - CARD_ACTIVATION_CHARGES\n\n ChargesSortBy:\n type: string\n enum:\n - id\n - description\n - type\n - currency\n - amount\n - transaction_type\n - created\n - modified\n\n Type:\n type: string\n description: The charge type.\n example: \"FLAT\"\n enum:\n - FLAT\n - PERCENTAGE\n - MAX_PERC_OR_FLAT\n - MIN_PERC_OR_FLAT\n\n ChargesFrequency:\n type: string\n description: Frequency of charging.\n example: \"MONTHLY\"\n enum:\n - MONTHLY\n - YEARLY\n\n ChargesApplicationType:\n type: string\n description: Charges application type. If \"application_type\" is \"INSTANT\", \"account_type\" should be \"MASTER\".\n default: SCHEDULED\n enum:\n - INSTANT\n - SCHEDULED\n\n ChargesAccountType:\n type: string\n example: \"PREPAID\"\n description: Charges account type.\n enum:\n - PREPAID\n - MASTER\n\n FxRateProvider:\n type: object\n description: FX rate provider.\n properties:\n provider_id:\n type: string\n description: The unique identifier of FX rate provider.\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n provider_name:\n type: string\n maxLength: 40\n example: \"Converter\"\n description: The name of FX rate provider.\n type:\n $ref: '#/definitions/FxRateProviderType'\n status:\n $ref: '#/definitions/FxRateProviderStatus'\n rate_expiry_buffer_time:\n type: integer\n format: int32\n minimum: 0\n description: The buffer time of FX rate expiry.\n fxrate_mode:\n type: array\n description: FX rate transaction mode.\n items:\n $ref: '#/definitions/FxRateTransactionMode'\n fxrate_provider_groups:\n type: array\n description: An array of FX rate provider groups.\n items:\n $ref: '#/definitions/FxRateProviderGroup'\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n FxRateTransactionMode:\n type: object\n description: FX rate transaction mode.\n required:\n - transaction_type\n - mode\n properties:\n transaction_type:\n $ref: '#/definitions/FxRateTransactionType'\n mode:\n $ref: '#/definitions/FxRateMode'\n\n FxRateTransactionType:\n type: string\n description: FX rate transaction type.\n enum:\n - TRANSFERS\n - SWEEP\n\n FxRateMode:\n type: string\n description: FX rate mode.\n enum:\n - ONLINE\n - OFFLINE\n - BOTH\n\n WalletDetails:\n type: object\n properties:\n currency:\n type: string\n description: The currency of the wallet.\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n priority:\n type: integer\n format: int32\n description: This field gives the priority in which the currency wallets are used in funds sweeping.\n status:\n $ref: '#/definitions/WalletDetailsStatus'\n description: The status of the wallet. If it is set to 'INACTIVE', then the wallets of this currency cannot be used in any transactions.\n example: \"ACTIVE\"\n allowed_load_type:\n $ref: '#/definitions/WalletDetailsAllowedLoadType'\n description: The allowed load type.\n\n WalletDetailsAllowedLoadType:\n type: string\n description: The allowed load type.\n example: \"LOAD\"\n enum:\n - INITIAL_LOAD\n - LOAD\n\n WalletDetailsStatus:\n type: string\n description: The status of wallet. If it is set to 'INACTIVE', then the wallets of this currency cannot be used in any transactions.\n enum:\n - ACTIVE\n - INACTIVE\n\n FxRatesQuotesCollection:\n type: object\n properties:\n after:\n type: string\n description: \"Durable version of current results that can be used on the next load.\"\n has_more:\n type: boolean\n description: \"Indicates whether there are more data to load.\"\n data:\n type: array\n description: An array of FX rate quotes data.\n items:\n $ref: \"#/definitions/FxRatesQuotes\"\n\n FxRateQuotesSortBy:\n type: string\n enum:\n - id\n - created\n - modified\n\n FxRatesQuotes:\n type: object\n properties:\n id:\n type: string\n maxLength: 36\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of FX rate quote.\n id_external:\n type: string\n description: The unique identifier of FX rate quote, provided by external FX rate provider.\n example: \"2\"\n status:\n $ref: \"#/definitions/FxRatesQuotesStatus\"\n example: \"BOOKED\"\n description: The status of FX rate quote.\n ts:\n type: string\n format: date-time\n description: The current date and time.\n example: \"2012-05-04T19:42:32.987Z\"\n expiry:\n type: string\n format: date-time\n description: Expiration date and time of the quoted exchange rate and quote amount in UTC format.\n example: \"2012-05-04T19:42:32.987Z\"\n booking_ts:\n type: string\n format: date-time\n description: The date and time when quote is booked.\n example: \"2012-05-04T19:42:32.987Z\"\n account_id:\n type: string\n maxLength: 36\n description: The unique identifier of the account.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n recipient_account_id:\n type: string\n description: The unique identifier of the recipient account.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n fxprovider_id:\n type: string\n description: The unique identifier of FX rate provider.\n example: \"34\"\n maxLength: 36\n fxrate_mode:\n $ref: \"#/definitions/FxRatesMode\"\n description: The FX rate mode.\n example: \"ONLINE\"\n rate_group_id:\n type: string\n maxLength: 36\n description: The unique identifier of FX rate group.\n example: \"R34\"\n rate_group_id_external:\n type: string\n description: The external ID of FX rate group.\n example: \"P1\"\n from_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"AED\"\n description: 3-letter ISO_4217 code representing the selling currency.\n from_amount:\n type: number\n example: 57\n description: Selling amount.\n to_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"USD\"\n description: 3-letter ISO_4217 code representing the buying currency.\n to_amount:\n type: number\n example: 14.82\n description: Buying amount as per standard FX rate of the provider.\n to_amount_applied:\n type: number\n example: 14.82\n description: Buying amount after addition of markup.\n exchange_rate_id:\n type: string\n description: The unique identifier of exhange rate.\n example: \"2\"\n exchange_rate:\n type: number\n example: 0.26\n description: The numeric FX conversation rate, must be higher than 0.\n exchange_rate_applied:\n type: number\n example: 0.26\n description: Modified rate after addition of markup.\n markup_type:\n $ref: \"#/definitions/FxRatesQuotesMarkupType\"\n description: The markup type of FX rate quote.\n example: \"PERCENTAGE\"\n markup_value:\n type: number\n description: The markup value.\n example: 5\n transaction_id:\n type: string\n example: \"111c3059-33af-4ed0-969a-7c23801dd555\"\n description: Unique identifier of the transaction. Applicable only for a booked FX rate quote.\n derived_rate:\n type: number\n description: The derived rate.\n example: 2\n final_rate:\n type: number\n description: The final rate.\n example: 5\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n UserBankAccountDetails:\n properties:\n bank_details_id:\n type: string\n maxLength: 34\n description: Unique identifier of the bank details.\n example: \"c5cebaf4-9b16-4e50-bae6-dca00210283c\"\n user_id:\n type: string\n description: Unique identifier of the user.\n example: \"a34b6c8e-28e5-4370-8234-aeca2b58c48d\"\n iban:\n type: string\n maxLength: 34\n description: IBAN.\n example: \"AE460090000000123456789\"\n swift_code:\n type: string\n maxLength: 11\n description: SWIFT code.\n example: \"CBAUAEAAXXX\"\n bank_name:\n type: string\n maxLength: 50\n description: Bank name.\n example: \"CENTRAL BANK OF THE U.A.E\"\n routing_number:\n type: string\n maxLength: 10\n description: Routing number (unique, nine-digit number that functions as an address for the bank).\n example: \"800110101\"\n status:\n $ref: '#/definitions/UserBankAccountDetailsStatus'\n required:\n - bank_details_id\n - user_id\n - iban\n - swift_code\n - bank_name\n\n FxRatesQuotesStatus:\n type: string\n description: The status of FX rate quote.\n\n * `OFFERED` - waiting for cardholder/purchaser to accept or decline quote.\n\n * `BOOKED` - shows that the quote is booked as offered.\n\n * `EXPIRED` - quote has expired and is no longer valid.\n\n enum:\n - OFFERED\n - BOOKED\n - EXPIRED\n - ERROR\n\n FxRatesMode:\n type: string\n description: The FX rate mode.\n enum:\n - ONLINE\n - OFFLINE\n\n FxRatesQuotesMarkupType:\n type: string\n description: The markup type of FX rate quote.\n enum:\n - PERCENTAGE\n - FIXED\n\n UserBankAccountDetailsStatus:\n type: string\n description: Status of user bank account details.\n example: \"ACTIVE\"\n enum:\n - ACTIVE\n - TERMINATED\n\n CardProductLinkChargesIds:\n type: object\n properties:\n ids:\n type: array\n description: An array of IDs.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n items:\n type: string\n maxLength: 36\n\n BookFxRateQuoteResponse:\n type: object\n properties:\n id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of FX rate quote.\n ts:\n type: string\n format: date-time\n description: The current date and time.\n example: \"2012-05-04T19:42:32.987Z\"\n quote_booking_ts:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time of booking a quote.\n from_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"AED\"\n description: 3-letter ISO_4217 code representing the selling currency.\n from_amount:\n type: number\n example: 57\n description: Selling amount.\n to_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"USD\"\n description: 3-letter ISO_4217 code representing the buying currency.\n to_amount:\n type: number\n example: 14.82\n description: Buying amount as per standard FX rate of the provider.\n exchange_rate:\n type: number\n example: 0.26\n description: The numeric FX conversation rate, must be higher than 0.\n status:\n $ref: \"#/definitions/FxRatesQuotesStatus\"\n expiry:\n type: string\n format: date-time\n description: Expiration date and time of the quoted exchange rate and quote amount in UTC format.\n example: \"2012-05-04T19:42:32.987Z\"\n transaction_id:\n type: string\n example: \"111c3059-33af-4ed0-969a-7c23801dd555\"\n description: Unique identifier of the transaction.\n fxrate_provider_id:\n type: string\n description: The unique identifier of FX rate provider.\n example: \"34\"\n fxrate_provider_name:\n type: string\n description: The name of FX rate provider.\n example: \"Converter\"\n markup_value:\n type: number\n description: The markup value.\n example: 5\n fee_amount:\n type: number\n format: decimal\n description: The fee amount.\n example: 2.50\n fee_details:\n type: array\n description: An array of fee details.\n items:\n $ref: \"#/definitions/FeeDetail\"\n account_id:\n type: string\n description: The unique identifier of the account.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n recipient_account_id:\n type: string\n description: The unique identifier of the recipient account. This parameter is used for fund transfer between accounts of different wallet currencies.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n booking_ts:\n type: string\n format: date-time\n description: The date and time when quote is booked.\n example: \"2012-05-04T19:42:32.987Z\"\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n FeeDetail:\n type: object\n description: Fee details.\n properties:\n fee_id:\n type: string\n description: The unique identifier of the fee.\n example: \"ed2e2ddb-c028-470d-b08b-7f28bd84fbfe\"\n description:\n type: string\n description: The fee description.\n example: \"Some description\"\n amount:\n type: number\n format: decimal\n x-nymos-currency: currency\n example: \"5\"\n description: The fee amount.\n currency:\n type: string\n format: iso-4217\n example: \"USD\"\n pattern: \"^[A-Z]{3}$\"\n description: 3-letter ISO_4217 code representing the currency.\n\n QuoteCreateRequest:\n type: object\n required:\n - account_id\n - from_currency\n - to_currency\n - amount\n properties:\n account_id:\n type: string\n description: The unique identifier of the account.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n recipient_account_id:\n type: string\n description: The unique identifier of the recipient account. This parameter is used for fund transfer between accounts of different wallet currencies.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n from_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"AED\"\n description: 3-letter ISO_4217 code representing the selling currency.\n to_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"USD\"\n description: 3-letter ISO_4217 code representing the buying currency.\n amount:\n type: number\n example: 50\n description: The amount which should be converted.\n amount_type:\n $ref: \"#/definitions/FxRateAmountType\"\n\n QuoteCreateResponse:\n type: object\n properties:\n id:\n type: string\n example: \"g189a80f-e641-4045-8a80-54841e4a1234\"\n description: The unique identifier of FX rate quote.\n ts:\n type: string\n format: date-time\n description: The current date and time.\n example: \"2012-05-04T19:42:32.987Z\"\n account_id:\n type: string\n description: The unique identifier of the account.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n recipient_account_id:\n type: string\n description: The unique identifier of the recipient account. This parameter is used for fund transfer between accounts of different wallet currencies.\n example: \"c1971753-2d53-4cc4-9e95-5bcb9a3fef95\"\n from_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"AED\"\n description: 3-letter ISO_4217 code representing the selling currency.\n from_amount:\n type: number\n example: 57\n description: Selling amount.\n to_currency:\n type: string\n pattern: ^[A-Z]{3}$\n example: \"USD\"\n description: 3-letter ISO_4217 code representing the buying currency.\n to_amount:\n type: number\n example: 14.82\n description: Buying amount as per standard FX rate of the provider.\n exchange_rate:\n type: number\n example: 0.26\n description: The numeric FX conversation rate, must be higher than 0.\n status:\n $ref: \"#/definitions/FxRatesQuotesStatus\"\n expiry:\n type: string\n format: date-time\n description: Expiration date and time of the quoted exchange rate and quote amount in UTC format.\n example: \"2012-05-04T19:42:32.987Z\"\n fxrate_provider_id:\n type: string\n description: The unique identifier of FX rate provider.\n example: \"34\"\n fxrate_provider_name:\n type: string\n description: The name of FX rate provider.\n example: \"Converter\"\n markup_value:\n type: number\n description: The markup value.\n example: 5\n created:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was created.\n modified:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when request was modified.\n\n PartnerStatus:\n type: object\n description: The partner status.\n x-nymos-entity: partner_status\n x-nymos-shared-entity: true\n required:\n - name\n properties:\n id:\n type: string\n x-nymos-key: true\n description: The unique identifier of partner.\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n maxLength: 36\n name:\n type: string\n description: The name of a partner.\n example: \"WesternUnion\"\n status:\n $ref: \"#/definitions/PartnerAvailabilityStatus\"\n description: The partner availability status.\n updated:\n type: string\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n description: The date and time when status was modified.\n\n PartnerAvailabilityStatus:\n type: string\n description: The partner availability status.\n enum: [ AVAILABLE, UNAVAILABLE ]\n\n OriginationCurrency:\n type: object\n description: The origination currency details.\n x-nymos-entity: origination_currency\n x-nymos-shared-entity: true\n required:\n - id\n properties:\n id:\n type: string\n x-nymos-key: true\n example: cf2de83b-ac68-441b-bc54-21de60014d57\n description: The unique identifier of currency.\n maxLength: 36\n cd:\n type: string\n example: \"AED\"\n description: 3-letter ISO_4217 code representing the currency.\n name:\n type: string\n example: \"Utd. Arab Emir. Dirham\"\n description: Currency name.\n prefix:\n type: string\n example: \"Dhs.\"\n description: Currency prefix.\n majorUnit:\n type: string\n example: \"Dirham\"\n description: Currency major unit.\n minorUnit:\n type: string\n example: \"Fil\"\n description: Currency minor unit.\n\n DestinationCountry:\n type: object\n description: The destination country details.\n x-nymos-entity: destination_country\n x-nymos-shared-entity: true\n required:\n - id\n properties:\n id:\n type: string\n x-nymos-key: true\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of destination country.\n maxLength: 36\n cd:\n type: string\n description: Code representing the country.\n example: \"AF\"\n name:\n type: string\n maxLength: 100\n example: \"Afghanistan\"\n description: Country name.\n originationCurrency:\n type: string\n description: The origination currency.\n example: \"AED\"\n destinationCurrencies:\n type: array\n description: An array of destination currencies.\n items:\n description: Destination currency.\n $ref: \"#/definitions/DestinationCurrency\"\n\n DestinationCurrency:\n type: object\n description: The destination currency details.\n properties:\n cd:\n type: string\n example: \"USD\"\n description: 3-letter ISO_4217 code representing the currency.\n name:\n type: string\n example: \"USDollar\"\n description: Currency name.\n prefix:\n type: string\n example: \"$\"\n description: Currency prefix.\n majorUnit:\n type: string\n example: \"Dollar\"\n description: Currency major unit.\n minorUnit:\n type: string\n example: \"Cent\"\n description: Currency minor unit.\n\n DeliveryService:\n type: object\n description: The delivery service details.\n x-nymos-entity: delivery_service\n x-nymos-shared-entity: true\n required:\n - id\n properties:\n id:\n type: string\n x-nymos-key: true\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of delivery service.\n maxLength: 36\n originationCurrency:\n type: string\n description: The origination currency.\n example: \"AED\"\n destinationCountry:\n type: string\n description: The destination country.\n example: \"IN\"\n destinationCurrency:\n type: string\n description: The destination currency.\n example: \"INR\"\n serviceCode:\n type: string\n description: The service code.\n example: \"500\"\n serviceName:\n type: string\n description: The service name.\n example: \"DIRECT TO BANK\"\n templateId:\n type: string\n description: The ID of the template.\n example: \"4020\"\n\n DeliveryOptionTemplate:\n type: object\n description: The delivery option template details.\n x-nymos-entity: delivery_option_template\n x-nymos-shared-entity: true\n required:\n - id\n properties:\n id:\n type: string\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of delivery template.\n x-nymos-key: true\n maxLength: 36\n destinationCountry:\n type: string\n description: The destination country.\n example: \"BD\"\n destinationCurrency:\n type: string\n description: The destination currency.\n example: \"BDT\"\n templateId:\n type: string\n description: The ID of the template.\n example: \"4020\"\n index:\n type: string\n description: The template index.\n example: \"001\"\n description:\n type: string\n description: The additional information. You can find more info in this document https://docs.nymcard.com/get-started/funding-and-transfers/western-union-apis#get-delivery-option-template-api.\n example: \"Some description\"\n\n CascadeNode:\n type: object\n description: The cascade node details.\n discriminator: type\n properties:\n value:\n type: string\n description: The value.\n example: \"S020\"\n text:\n type: string\n description: The descriptive text.\n example: \"AB BANK LIMITED\"\n children:\n type: array\n description: An array of children data.\n items:\n description: Cascade node.\n $ref: \"#/definitions/CascadeNode\"\n\n ReversalReason:\n type: object\n description: The reversal reason details.\n x-nymos-entity: reversal_reason\n x-nymos-shared-entity: true\n properties:\n id:\n type: string\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of reversal.\n x-nymos-key: true\n maxLength: 36\n type:\n $ref: \"#/definitions/ReversalType\"\n description: The reversal type.\n code:\n type: string\n example: \"454\"\n description: The code.\n description:\n type: string\n example: \"Some description\"\n description: The additional information.\n\n ReversalType:\n type: string\n description: The type of reversal.\n example: \"CANCEL\"\n enum: [ CANCEL, REFUND ]\n\n StateInfo:\n type: object\n description: The state details.\n x-nymos-entity: state_info\n x-nymos-shared-entity: true\n properties:\n id:\n type: string\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of state.\n x-nymos-key: true\n maxLength: 36\n countryCode:\n $ref: \"#/definitions/CountryCode\"\n description: The country code.\n stateCode:\n type: string\n maxLength: 2\n example: \"USA\"\n description: The state code.\n stateName:\n type: string\n maxLength: 282\n example: \"United States\"\n description: The state name.\n city:\n type: string\n example: \"Washington\"\n description: The city name.\n\n CountryCode:\n type: string\n example: \"CA\"\n description: The country code.\n enum: [ CA, MX, US ]\n\n FeeInquireRequest:\n type: object\n required:\n - senderId\n - transactionType\n - paymentDetails\n - hostBasedTaxes\n properties:\n senderId:\n type: string\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of sender.\n maxLength: 36\n transactionType:\n $ref: \"#/definitions/WuTransactionType\"\n description: WU transaction type.\n paymentDetails:\n $ref: \"#/definitions/PaymentDetailsBaseRequest\"\n description: Payment details.\n hostBasedTaxes:\n $ref: \"#/definitions/HostBasedTaxes\"\n description: Host based taxes.\n\n FeeInquireResponse:\n type: object\n required:\n - senderId\n properties:\n senderId:\n type: string\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of sender.\n maxLength: 36\n testQuestionFlag:\n $ref: \"#/definitions/TestQuestionFlag\"\n description: The flag which shows if test question is required.\n serviceOptions:\n type: array\n description: An array of service options.\n items:\n $ref: \"#/definitions/ServiceOption\"\n description: Service options.\n\n TestQuestionFlag:\n type: string\n enum: [ Y, N, P ]\n example: \"Y\"\n description: The flag which shows if test question is required. Y - Mandatory; N - Not Required; P - Prohibited\n\n ServiceOption:\n type: object\n description: The service option details.\n properties:\n product:\n $ref: \"#/definitions/Product\"\n description: Product details.\n baseWordLimit:\n type: string\n example: \"3\"\n description: The limit for base words.\n maxLength: 3\n incrementWordLimit:\n type: string\n example: \"3\"\n description: The limit for increment words.\n maxLength: 3\n lines:\n type: string\n example: \"3\"\n description: The amount of lines.\n paymentDetails:\n $ref: \"#/definitions/PaymentDetailsBaseResponse\"\n description: Payment details.\n\n AmountDetailsRequest:\n type: object\n description: The amount details.\n required:\n - principalAmount\n - currencyIsoCode\n properties:\n principalAmount:\n type: number\n description: The amount of money being sent by the sender.\n minimum: 0\n multipleOf: 0.01\n grossAmount:\n type: number\n description: The amount of money to be collected from the sender. Gross_amount = principal_amount + fees.\n minimum: 0\n multipleOf: 0.01\n currencyIsoCode:\n type: string\n description: The currency ISO code.\n example: \"USD\"\n maxLength: 3\n\n AmountDetailsResponse:\n allOf:\n - $ref: \"#/definitions/AmountDetailsRequest\"\n - type: object\n required:\n - countryIsoCode\n properties:\n countryIsoCode:\n type: string\n description: The country ISO code.\n example: \"US\"\n maxLength: 2\n\n PayoutAmountDetails:\n type: object\n description: The payout amount details.\n required:\n - countryIsoCode\n - currencyIsoCode\n properties:\n expectedPayoutAmount:\n type: number\n description: Expected payout amount that receiver will be paid.\n example: \"10\"\n minimum: 0\n multipleOf: 0.01\n currencyIsoCode:\n type: string\n description: The currency ISO code.\n example: \"USD\"\n maxLength: 3\n countryIsoCode:\n type: string\n description: The country ISO code.\n example: \"US\"\n maxLength: 2\n stateCode:\n type: string\n maxLength: 12\n description: Payout state code.\n example: \"US\"\n city:\n type: string\n maxLength: 50\n description: Payout city name.\n example: \"Denver\"\n\n Promotion:\n type: object\n description: The promotion details.\n properties:\n name:\n type: string\n description: Promotion name.\n example: \"Best\"\n code:\n type: string\n maxLength: 30\n description: Promo code.\n example: \"promo\"\n description:\n type: string\n maxLength: 80\n description: Promo description.\n example: \"Some description\"\n discount:\n type: number\n description: Discount amount.\n example: \"5\"\n minimum: 0\n multipleOf: 0.01\n status:\n $ref: \"#/definitions/PromotionStatus\"\n description: Promotion status.\n message:\n type: string\n maxLength: 80\n description: Promo message.\n example: \"Some message\"\n\n PromotionStatus:\n type: string\n description: Promotion status.\n example: \"APPLIED\"\n enum: [ APPLIED, NOT_APPLIED ]\n\n Taxes:\n type: object\n description: Taxes details.\n properties:\n taxAmount:\n type: number\n description: Tax amount on base transaction.\n example: \"3\"\n minimum: 0\n multipleOf: 0.01\n taxRate:\n type: number\n description: Tax rate.\n example: \"3\"\n minimum: 0\n multipleOf: 1\n municipalTax:\n type: number\n description: Municipal tax applied on transaction.\n example: \"0.5\"\n minimum: 0\n multipleOf: 0.01\n stateTax:\n type: number\n description: State tax applied on transaction.\n example: \"0.88\"\n minimum: 0\n multipleOf: 0.01\n countyTax:\n type: number\n description: Country tax applied on transaction.\n example: \"0.57\"\n minimum: 0\n multipleOf: 0.01\n\n Fees:\n type: object\n description: The fees details.\n properties:\n baseCharges:\n type: number\n description: Money transfer charges on base transaction.\n example: \"0.02\"\n minimum: 0\n multipleOf: 0.01\n deliveryCharges:\n type: number\n description: Delivery charges.\n example: \"0.02\"\n minimum: 0\n multipleOf: 0.01\n otherCharges:\n type: number\n description: Other service charges.\n example: \"0.02\"\n minimum: 0\n multipleOf: 0.01\n charges:\n type: number\n description: MT charges.\n example: \"0.02\"\n minimum: 0\n multipleOf: 0.01\n exchangeFee:\n type: number\n description: Exchange rate fees used to convert between currencies.\n example: \"0.02\"\n minimum: 0\n multipleOf: 0.01\n conversionFee:\n type: number\n description: Exchange rate conversion fees.\n example: \"0.02\"\n minimum: 0\n multipleOf: 0.01\n secondExchangeFee:\n type: number\n description: Second exchange fees.\n example: \"0.02\"\n minimum: 0\n multipleOf: 0.01\n\n MessageCharges:\n type: object\n description: The message charges details.\n properties:\n baseRate:\n type: number\n description: Charge rage for base message.\n example: \"0.02\"\n baseCount:\n type: number\n description: Number of characters in base message.\n example: \"0.02\"\n margRate:\n type: number\n description: Marg rate.\n example: \"0.02\"\n rateSpecial:\n type: number\n description: Special message rate.\n example: \"0.02\"\n\n IdentificationQuestion:\n type: object\n description: The identification question details.\n properties:\n question:\n type: string\n description: Identification question.\n example: \"Month of birth\"\n answer:\n type: string\n description: Identification answer.\n example: \"May\"\n bypass:\n type: string\n maxLength: 1\n description: Bypass.\n example: \"M\"\n\n SendMoneyBaseType:\n type: object\n discriminator: type\n required:\n - accountId\n - senderId\n - receiver\n - smsNotificationFlag\n - hostBasedTaxes\n - product\n - sourceOfFunds\n - transactionReason\n - senderOccupation\n - senderEmploymentPositionLevel\n properties:\n accountId:\n type: string\n maxLength: 36\n example: \"cf2fgj3b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of account.\n senderId:\n type: string\n maxLength: 36\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of sender.\n receiver:\n $ref: \"#/definitions/Receiver\"\n description: The receiver.\n smsNotificationFlag:\n $ref: \"#/definitions/SmsNotificationFlag\"\n description: SMS notification flag.\n bankAccount:\n $ref: \"#/definitions/BankAccount\"\n description: The bank account details.\n hostBasedTaxes:\n $ref: \"#/definitions/HostBasedTaxes\"\n description: The host based taxes.\n product:\n $ref: \"#/definitions/Product\"\n description: The WU product.\n senderEmploymentPositionLevel:\n type: string\n description: Additional field for development purpose. Possible values are - `Entry Level`, `Mid-Level/Supervisory/Management`, `Senior Level/Executive`, `Owner`.\n senderOccupation:\n type: string\n description: Additional field for development purpose. Possible values are -\n\n * Airline/Maritime Employee\n\n * Art/Entertainment/Media\n\n * Civil/Government Employee\n\n * Domestic Helper\n\n * Driver\n\n * Teacher/Educator\n\n * Hotel/Restaurant/Leisure\n\n * Housewife/Child Care\n\n * IT and Tech Professional\n\n * Laborer-Agriculture\n\n * Laborer-Construction\n\n * Laborer-Manufacturing\n\n * Laborer- Oil/Gas/Mining\n\n * Medical/Health Care\n\n * Non-profit/Volunteer\n\n * Cosmetic/Personal Care\n\n * Law Enforcement/Military\n\n * Office Professional\n\n * Religious/Church Servant\n\n * Retail Sales\n\n * Retired\n\n * Sales/Insurance/Real Estate\n\n * Science/Research Professional\n\n * Security Guard\n\n * Self-Employed\n\n * Skilled Trade/Specialist\n\n * Student\n\n * Unemployed\n\n sourceOfFunds:\n type: string\n maxLength: 30\n description: Source of funds.\n example: \"Source\"\n transactionReason:\n type: string\n maxLength: 50\n description: Reason for transaction. Possible values are -\n\n * Family Support/Living Expenses\n\n * Saving/Investments\n\n * Gift\n\n * Goods & Services payment\n\n * Travel expenses\n\n * Education/School Fee\n\n * Rent/Mortgage\n\n * Emergency/Medical Aid\n\n * Charity/Aid Payment\n\n * Employee Payroll/Employee Expense\n\n * Prize or Lottery Fees/Taxes\n example: \"Gift\"\n\n Receiver:\n type: object\n description: The receiver details.\n required:\n - name\n properties:\n name:\n $ref: \"#/definitions/ReceiverName\"\n description: The receiver name details.\n address:\n $ref: \"#/definitions/ReceiverAddress\"\n description: The receiver address details.\n contactPhone:\n type: string\n maxLength: 31\n description: Customers home phone number.\n example: \"33498868\"\n mobileDetails:\n $ref: \"#/definitions/MobileDetails\"\n description: The mobile details.\n email:\n type: string\n maxLength: 80\n description: Customers email ID.\n example: \"gmail\"\n dateOfBirth:\n type: string\n format: date\n description: Date of birth.\n example: \"2002-05-04\"\n nationality:\n type: string\n maxLength: 50\n description: Nationality.\n example: \"American\"\n resident:\n type: boolean\n description: This field indicates whether receiver is UAE resident or not.\n example: true\n reasonForSending:\n type: string\n description: Reason for sending.\n example: \"Reason\"\n relationshipToSender:\n type: string\n maxLength: 35\n description: This field indicates any relationship to sender.\n example: \"Relationship\"\n nationalIdNo:\n type: string\n maxLength: 10\n description: Receiver's ID number.\n example: \"645747\"\n walletDetails:\n $ref: \"#/definitions/ReceiverWalletDetails\"\n description: The wallet details.\n\n ReceiverName:\n type: object\n description: The receiver name details.\n required:\n - nameType\n - firstName\n - lastName\n properties:\n nameType:\n $ref: \"#/definitions/ReceiverNameType\"\n description: The receiver name type.\n firstName:\n type: string\n description: Receiver's first name.\n example: \"John\"\n middleName:\n type: string\n description: Receiver's middle name.\n example: \"Mike\"\n lastName:\n type: string\n description: Receiver's last name.\n example: \"Smith\"\n\n ReceiverNameType:\n type: string\n description: Receiver's name type.\n example: \"DOMESTIC\"\n enum: [ DOMESTIC, MEXICAN ]\n\n ReceiverAddress:\n description: The receiver address details.\n properties:\n addrLine1:\n type: string\n maxLength: 100\n description: Line 1 of address.\n example: \"Corn\"\n addrLine2:\n type: string\n maxLength: 84\n description: Line 2 of address.\n example: \"Street\"\n city:\n type: string\n maxLength: 50\n description: City.\n example: \"Denver\"\n state:\n type: string\n maxLength: 50\n description: State.\n example: \"USA\"\n postalCode:\n type: string\n maxLength: 40\n description: Postal or zip code.\n example: \"59856\"\n\n ReceiverWalletDetails:\n type: object\n description: The receiver wallet details.\n properties:\n serviceProviderCode:\n type: string\n description: Service provider code.\n example: \"577\"\n maxLength: 20\n serviceProviderType:\n type: string\n description: Service provider type.\n example: \"Type\"\n serviceProviderName:\n type: string\n description: Service provider name.\n example: \"Provider\"\n walletAccountNumber:\n type: string\n maxLength: 32\n description: Wallet account number.\n example: \"5475\"\n\n SmsNotificationFlag:\n type: string\n description: SMS notification flag.\n example: \"Y\"\n enum: [ Y, N ]\n\n BankAccount:\n type: object\n description: The bank account details.\n properties:\n bankName:\n type: string\n maxLength: 50\n description: Official bank name.\n example: \"PKAO\"\n bankLocation:\n type: string\n maxLength: 90\n description: Bank location.\n example: \"UAE\"\n branchCode:\n type: string\n maxLength: 50\n description: Branch code.\n example: \"54\"\n swiftBic:\n type: string\n maxLength: 70\n description: BIC/SWIFTBIC.\n example: \"JHIUI7G\"\n bankCode:\n type: string\n description: Bank code.\n example: \"75\"\n sortCode:\n type: string\n maxLength: 9\n description: Sort code.\n example: \"54445\"\n accountNumber:\n type: string\n maxLength: 35\n example: \"54688875\"\n description: Unique account number identifying the financial account.\n routingNumber:\n type: string\n example: \"5477555\"\n maxLength: 40\n description: Bank routing number.\n accountType:\n type: string\n maxLength: 50\n example: \"t2\"\n description: Bank account type.\n accountHolder:\n type: string\n example: \"tt\"\n maxLength: 20\n description: Bank account holder.\n accountPrefix:\n type: string\n example: \"RT\"\n maxLength: 14\n description: Bank account prefix.\n accountSuffix:\n type: string\n example: \"HH\"\n maxLength: 14\n description: Bank account suffix.\n rcvFinancialId:\n type: string\n maxLength: 20\n example: \"6866875\"\n description: RCV Financial ID.\n\n MobileDetails:\n type: object\n description: The mobile details.\n properties:\n cityCode:\n type: string\n maxLength: 20\n example: \"39\"\n description: Receiver city code.\n number:\n type: string\n maxLength: 15\n example: \"68656875\"\n description: Receiver phone number.\n\n MobilePhone:\n type: object\n description: The mobile phone details.\n required:\n - countryCode\n - nationalNumber\n properties:\n countryCode:\n type: string\n maxLength: 24\n example: \"464\"\n description: Phone number country code.\n nationalNumber:\n type: string\n maxLength: 14\n example: \"6867756875\"\n description: Phone number.\n\n SendMoneyValidateRequest:\n allOf:\n - $ref: \"#/definitions/SendMoneyBaseType\"\n - type: object\n required:\n - paymentDetails\n properties:\n paymentDetails:\n description: Payment details.\n $ref: \"#/definitions/PaymentDetailsBaseRequest\"\n\n SendMoneyValidateResponse:\n allOf:\n - $ref: \"#/definitions/SendMoneyBaseType\"\n - type: object\n properties:\n paymentDetails:\n $ref: \"#/definitions/PaymentDetailsResponse\"\n description: Payment details.\n tempTransactionId:\n type: string\n maxLength: 16\n example: \"6867756875456789\"\n description: Temp transaction Id (16 digit MTCN).\n transactionDigest:\n type: string\n maxLength: 80\n example: \"65\"\n description: Transaction digest.\n dateTime:\n type: string\n description: Timestamp.\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n\n\n SendMoneyStoreRequest:\n allOf:\n - $ref: \"#/definitions/SendMoneyBaseType\"\n - type: object\n required:\n - paymentDetails\n - tempTransactionId\n - transactionDigest\n properties:\n paymentDetails:\n $ref: \"#/definitions/PaymentDetailsRequest\"\n description: Payment details.\n tempTransactionId:\n type: string\n maxLength: 16\n example: \"6867756875456789\"\n description: Temp transaction Id (16 digit MTCN).\n transactionDigest:\n type: string\n maxLength: 80\n example: \"65\"\n description: Transaction digest.\n initiationId:\n type: string\n example: \"3e9392df-4093-4389-a0ad-92456a181b8a\"\n description: Unique identifier of the OTP verification.\n otpCode:\n type: string\n example: \"123456\"\n description: OTP code value.\n\n SendMoneyStoreResponse:\n allOf:\n - $ref: \"#/definitions/SendMoneyBaseType\"\n - type: object\n properties:\n paymentDetails:\n $ref: \"#/definitions/PaymentDetailsResponse\"\n description: Payment details.\n transactionId:\n type: string\n maxLength: 16\n example: \"2236280599697362\"\n description: 16 digit MTCN.\n moneyTransferControl:\n $ref: \"#/definitions/MoneyTransferControl\"\n description: Money transfer control details.\n dateTime:\n type: string\n description: Timestamp.\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n\n MoneyTransferControl:\n type: object\n description: MTCN.\n properties:\n date:\n type: string\n description: \"MM-DD-YY HHMMA/P EDT\"\n example: \"2012-05-04T19:42:32.987Z\"\n mtcn:\n type: string\n maxLength: 10\n example: \"5739473946\"\n description: 10 digit MTCN.\n\n Product:\n type: object\n description: WU product details.\n required:\n - name\n - code\n - transactionType\n properties:\n name:\n type: string\n maxLength: 40\n example: \"Name\"\n description: WU product name.\n code:\n type: string\n maxLength: 3\n example: \"946\"\n description: WU product code.\n transactionType:\n $ref: \"#/definitions/WuTransactionType\"\n description: WU transaction type.\n routingCode:\n type: string\n maxLength: 41\n example: \"573947394657577\"\n description: Routing code.\n message:\n type: string\n maxLength: 69\n example: \"Some message\"\n description: Message.\n\n CancelTransactionRequest:\n type: object\n description: The cancel transaction details.\n required:\n - accountId\n - cancelReasonCode\n - reverseFees\n properties:\n accountId:\n type: string\n maxLength: 36\n example: \"9675496749769476974\"\n description: Unique account number identifying the financial account.\n cancelReasonCode:\n type: string\n maxLength: 3\n example: \"66\"\n description: Cancel reason code.\n reverseFees:\n type: boolean\n example: true\n description: This field indicates whether fees should be returned.\n\n CancelTransactionResponse:\n type: object\n properties:\n accountId:\n type: string\n maxLength: 36\n example: \"9675496749769476974\"\n description: Unique account number identifying the financial account.\n transactionId:\n type: string\n maxLength: 16\n example: \"9675496749769476\"\n description: 16 digit MTCN.\n cancelReasonCode:\n type: string\n maxLength: 3\n example: \"66\"\n description: Cancel reason code.\n reverseFees:\n type: boolean\n example: true\n description: This field indicates whether fees should be returned.\n cancelStatus:\n $ref: \"#/definitions/CancelStatus\"\n description: Status of the refund transaction.\n\n CancelStatus:\n type: string\n example: \"SUCCESS\"\n description: Status of the refund transaction.\n enum: [ SUCCESS, FAILURE ]\n\n RefundTransactionRequest:\n type: object\n description: The refund transaction details.\n required:\n - accountId\n - senderId\n - refundReasonCode\n properties:\n accountId:\n type: string\n maxLength: 36\n example: \"9675496749769476974\"\n description: Unique account number identifying the financial account.\n senderId:\n type: string\n maxLength: 36\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of sender.\n refundReasonCode:\n type: string\n maxLength: 6\n example: \"4874\"\n description: Refund reason code.This code should be provided by NymCard’s Customer from Get Reason List dictionary API.\n\n RefundTransactionResponse:\n type: object\n properties:\n accountId:\n type: string\n maxLength: 36\n example: \"9675496749769476974\"\n description: Unique account number identifying the financial account.\n senderId:\n type: string\n maxLength: 36\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of sender.\n transactionId:\n type: string\n maxLength: 16\n example: \"9675496749769476\"\n description: 16 digit MTCN.\n refundReasonCode:\n type: string\n maxLength: 6\n example: \"4874\"\n description: Refund reason code.\n status:\n $ref: \"#/definitions/RefundStatus\"\n description: Status of the refund.\n dateTime:\n type: string\n description: Timestamp.\n format: date-time\n example: \"2012-05-04T19:42:32.987Z\"\n\n RefundStatus:\n type: object\n description: Status of the refund.\n properties:\n code:\n type: integer\n example: \"6\"\n description: Code.\n message:\n type: string\n example: \"Some text\"\n description: Message.\n referenceNo:\n type: string\n example: \"96\"\n description: Reference number.\n\n WuTransactionType:\n type: string\n example: \"WMF\"\n description: WU transaction type.\n enum: [ WMF, WMN, WMO, MOD, MOR, MOP ]\n\n HostBasedTaxes:\n type: string\n description: The host based taxes.\n example: \"Y\"\n enum: [ Y, N ]\n\n TransactionAction:\n type: string\n example: \"HOLD\"\n description: Transaction action.\n enum: [ HOLD, RELEASE, CANCEL ]\n\n PaymentDetailsRequest:\n allOf:\n - $ref: \"#/definitions/PaymentDetailsBaseRequest\"\n - type: object\n properties:\n holdReleaseFields:\n $ref: \"#/definitions/HoldReleaseFields\"\n description: The hold/release fields details.\n\n PaymentDetailsBaseRequest:\n allOf:\n - $ref: \"#/definitions/PaymentDetailsCommon\"\n - type: object\n required:\n - origination\n properties:\n origination:\n $ref: \"#/definitions/AmountDetailsRequest\"\n description: Amount details.\n\n PaymentDetailsResponse:\n allOf:\n - $ref: \"#/definitions/PaymentDetailsBaseResponse\"\n - type: object\n properties:\n holdReleaseFields:\n $ref: \"#/definitions/HoldReleaseFields\"\n description: The hold/release fields details.\n\n PaymentDetailsBaseResponse:\n allOf:\n - $ref: \"#/definitions/PaymentDetailsCommon\"\n - type: object\n required:\n - origination\n properties:\n origination:\n $ref: \"#/definitions/AmountDetailsResponse\"\n description: Amount details.\n\n PaymentDetailsCommon:\n type: object\n discriminator: type\n description: The payment details.\n required:\n - destination\n properties:\n destination:\n $ref: \"#/definitions/PayoutAmountDetails\"\n description: Payout amount details.\n promotion:\n $ref: \"#/definitions/Promotion\"\n description: Promotion details.\n taxes:\n $ref: \"#/definitions/Taxes\"\n description: Taxes details.\n fees:\n $ref: \"#/definitions/Fees\"\n description: Fees details.\n messageCharges:\n $ref: \"#/definitions/MessageCharges\"\n description: Message charges details.\n exchangeRate:\n type: number\n example: \"0.46\"\n description: Exchange rate.\n paymentDigest:\n type: string\n example: \"4985743876487\"\n description: Key information about the session used by WU Core.\n totalUndiscountedCharges:\n type: number\n example: \"4\"\n description: Total undiscounted charges.\n totalDiscount:\n type: number\n example: \"3\"\n description: Total discount.\n totalDiscountedCharges:\n type: number\n example: \"2\"\n description: Total discounted charges.\n additionalServiceCharges:\n type: string\n maxLength: 300\n example: \"1\"\n description: Additional service charges.\n identificationQuestion:\n $ref: \"#/definitions/IdentificationQuestion\"\n description: Identification question details.\n\n\n HoldReleaseFields:\n type: object\n description: Hold/release fields details.\n properties:\n holdReleaseBuffer:\n type: string\n example: \"0101C0202BM0303AED\"\n description: Buffer.\n\n GenerateOtpRequest:\n type: object\n description: OTP request details.\n required:\n - senderId\n properties:\n senderId:\n type: string\n maxLength: 36\n example: \"cf2de83b-ac68-441b-bc54-21de60014d57\"\n description: The unique identifier of sender.\n\n GenerateOtpResponse:\n type: object\n description: OTP response details.\n properties:\n initiationId:\n type: string\n example: \"3e9392df-4093-4389-a0ad-92456a181b8a\"\n description: Unique identifier of the OTP verification.\n\n UserVerificationSettings:\n type: object\n properties:\n KYC:\n type: array\n description: An array of KYC data.\n items:\n $ref: \"#/definitions/UserVerificationSettingsDefinition\"\n IDV:\n type: array\n description: An array of IDV data.\n items:\n $ref: \"#/definitions/UserVerificationSettingsDefinition\"\n\n UserVerificationSettingsDefinition:\n type: object\n required:\n - category\n - provider\n properties:\n category:\n type: string\n example: \"all\"\n description: User verification category.\n provider:\n type: string\n example: \"onfido/worldcheck\"\n description: The name of provider.\n\n Conditions:\n type: object\n description: Advanced velocity limit conditions.\n required:\n - type\n - active\n properties:\n type:\n $ref: \"#/definitions/ConditionType\"\n values:\n type: array\n description: An array of values.\n items:\n type: string\n example: \"4511\"\n active:\n type: boolean\n description: This parameter indicates whether it is active or not.\n default: true\n\n ConditionType:\n type: string\n description: Condition type.\n\n * \"PURCHASE_TYPE\" has such enums as PURCHASE and ECOMMERCE.\n\n * \"TRANSACTION_ORIGIN\" has such enums as DOMESTIC, FOREIGN and ANY.\n\n * \"CARD_TYPE\" has such enums as VIRTUAL and PHYSICAL.\n\n example: \"MCC\"\n enum:\n - \"MCC\"\n - \"MERCHANT_ID\"\n - \"KYC_LEVEL\"\n - \"CHANNEL_SCOPE\"\n - \"API_CHANNEL\"\n - \"TRANSFER_TYPE\"\n - \"PURCHASE_TYPE\"\n - \"CARD_TYPE\"\n - \"TRANSACTION_ORIGIN\"\n\n PurchaseType:\n type: string\n description: Purchase type.\n example: \"PURCHASE\"\n enum:\n - \"PURCHASE\"\n - \"ECOMMERCE\"\n\n WalletProvider:\n type: string\n description: The wallet provider.\n enum:\n - \"APPLEPAY\"\n - \"SAMSUNGPAY\"\n - \"GOOGLEPAY\"\n\n CardsLimitsSearchResponse:\n type: object\n properties:\n user_id:\n type: string\n description: The unique identifier of the user.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6\"\n velocity_limits:\n type: array\n description: An array of velocity limits.\n items:\n $ref: \"#/definitions/CardVelocityLimitLinked\"\n balance_limits:\n type: array\n description: An array of balance limits.\n items:\n $ref: \"#/definitions/CardBalanceLimitLinked\"\n advanced_velocity_limits:\n type: array\n description: An array of advanced velocity limits.\n items:\n $ref: \"#/definitions/CardAdvancedVelocityLimitLinked\"\n\n CardVelocityLimitLinked:\n allOf:\n - $ref: \"#/definitions/CardVelocityLimit\"\n - type: object\n properties:\n linked_to:\n $ref: \"#/definitions/CardLimitsInfoLinkedTo\"\n\n CardBalanceLimitLinked:\n allOf:\n - $ref: \"#/definitions/BalanceLimit\"\n - type: object\n properties:\n linked_to:\n $ref: \"#/definitions/CardLimitsInfoLinkedTo\"\n\n CardAdvancedVelocityLimitLinked:\n allOf:\n - $ref: \"#/definitions/CardAdvancedVelocityLimit\"\n - type: object\n properties:\n linked_to:\n $ref: \"#/definitions/CardLimitsInfoLinkedTo\"\n\n CardLimitsInfoLinkedTo:\n type: string\n description: This parameter indicates whether card limits are linked to card, product or account.\n example: \"CARD\"\n enum:\n - CARD\n - PRODUCT\n - ACCOUNT\n\n CardProductAdvancedFeeIds:\n type: object\n properties:\n ids:\n type: array\n items:\n type: string\n maxLength: 36\n description: Advanced fee ID.\n example: \"4b4eabfc-f839-4e51-9dc1-3dc25c3eddd6\"\n\n MdesTokenStatusChangeRequest:\n type: object\n required:\n - status\n - status_reason_code\n properties:\n status:\n $ref: '#/definitions/MdesStatusToChange'\n status_reason_code:\n $ref: '#/definitions/MdesStatusReasonCodeToChange'\n note:\n type: string\n description: The additional information.\n example: \"Some text\"\n maxLength: 450\n\n MdesStatusToChange:\n type: string\n description: The change status.\n example: \"SUSPENDED\"\n enum: [ ACTIVE, SUSPENDED, UNSUSPENDED, TERMINATED ]\n\n MdesStatusReasonCodeToChange:\n type: string\n description: New Status Reason Code.\n\n * `A0` First time activation - when activated from INACTIVE to ACTIVE status by customer service agent.\n\n * `A2` First time activation - when activated from INACTIVE to ACTIVE status and user was authenticated with an activation method.\n\n * `S0` Temporary suspension - Cardholder reported token device lost.\n\n * `S1` Temporary suspension - Cardholder reported token device stolen.\n\n * `S2` Temporary suspension - Issue or cardholder reported fraudulent token transactions.\n\n * `S3` Temporary suspension - Other.\n\n * `A3` Resumed from Suspended status - Cardholder reported token device found or not stolen.\n\n * `A4` Resumed from Suspended status - Issuer or cardholder confirmed no fraudulent token transactions.\n\n * `A5` Resumed from Suspended status - Other.\n\n * `T0` Terminated - Cardholder confirmed token device lost.\n\n * `T1` Terminated - Cardholder confirmed token device stolen.\n\n * `T2` Terminated - Issuer or cardholder confirmed fraudulent token transactions (Deprecated).\n\n * `T3` Terminated - Issuer or cardholder confirmed fraudulent token transactions.\n\n * `T4` Terminated - Account closed.\n\n * `T5` Terminated - Issuer consumer deleted.\n\n * `T6` Terminated - Other.\n example: \"A0\"\n enum: [ A0, A2, A3, A4, A5, S0, S1, S2, S3, T0, T1, T2, T3, T4, T5, T6 ]\n\n MdesApiLog:\n x-nymos-entity: tokens_mdes_log\n x-nymos-shared-entity: true\n type: object\n properties:\n id:\n type: string\n description: The unique identifier.\n example: \"fceb7dc9-9795-4a7b-a091-94a5074cd78f\"\n x-nymos-key: true\n request_id:\n type: string\n description: The unique identifier of request.\n example: \"65d42717-c804-4cde-a71f-0ce2b6db4d00\"\n tenant_id:\n type: string\n description: The unique identifier of a tenant.\n example: \"tenant21\"\n api_name:\n type: string\n description: The api name.\n example: \"AUTHORIZE_SERVICE\"\n created:\n type: string\n description: Timestamp of the Mdes log event.\n format: date-time\n example: \"2023-09-05T13:01:55.309Z\"\n x-nymos-index: desc\n services:\n type: array\n description: An array of services items.\n items:\n type: string\n description: Services items.\n example: \"DIGITIZATION\"\n x-nymos-default-value: null\n token_unique_reference:\n type: string\n description: Token unique reference.\n example: \"DSAPMC0000324984865fc4106a624a7dae0445bb1fab78b6\"\n pan_unique_reference:\n type: string\n description: PAN unique reference.\n example: \"FHAPMC5678324984865fc4106a624a7dae0445bb1fab78b6\"\n source:\n type: string\n description: The source.\n example: \"94.206.96.76\"\n data_valid_until_timestamp:\n type: string\n description: Data valid until timestamp.\n example: \"2023-09-05T13:31:50.272Z\"\n account_number_last_four:\n type: string\n example: \"0013\"\n description: the last four digits of account number.\n financial_account_id:\n type: string\n description: The unique identifier of financial account.\n example: \"65d47865-c804-4cde-a71f-0ce2b6db4d00\"\n interbank_card_association_id:\n type: string\n description: The unique identifier of interbank card association.\n example: \"57832717-c804-4cde-a71f-0ce2b6db4d00\"\n country_code:\n type: string\n description: The country code.\n example: \"USA\"\n token:\n type: string\n description: The token itself.\n example: \"123CCB2F30BA420B22B0B2231BD58EEADD2FCC7F0039199BBF461EAE60A88460\"\n expiry_month:\n type: string\n description: The month of expiry.\n example: \"June\"\n expiry_year:\n type: string\n description: The year of expiry.\n example: \"2024\"\n sequence_number:\n type: string\n description: The sequence number.\n example: \"4\"\n payment_account_reference:\n type: string\n description: The payment account reference.\n example: \"23\"\n account_holder_name:\n type: string\n description: The account holder name.\n example: \"John Smith\"\n line1:\n type: string\n description: Line 1.\n example: \"Jellow\"\n line2:\n type: string\n description: Line 2.\n example: \"Stone\"\n city:\n type: string\n description: The city name.\n example: \"Paris\"\n country_subdivision:\n type: string\n description: The country subdivision.\n example: \"US\"\n postal_code:\n type: string\n description: The postal code.\n example: \"79000\"\n country:\n type: string\n description: The country name\n example: \"USA\"\n source_ip:\n type: string\n description: The source IP address.\n example: \"94.206.96.76\"\n device_location:\n type: string\n description: Location of device.\n example: \"Town\"\n consumer_identifier:\n type: string\n description: Identifier of consumer.\n example: \"TCCA\"\n account_holder_email_address:\n type: string\n description: Email of account holder.\n example: \"example@gmail.com\"\n country_dial_in_code:\n type: string\n description: Country dial in code.\n example: \"380\"\n phone_number:\n type: string\n description: The phone number.\n example: \"575930304\"\n correlation_id:\n type: string\n example: \"D0000061238490\"\n description: The unique indentifier of correlation.\n token_requestor_id:\n type: string\n description: The unique indentifier of token requestor.\n example: \"50139059239\"\n wallet_id:\n type: string\n description: The unique indentifier of wallet.\n example: \"217\"\n payment_app_instance_id:\n type: string\n description: The unique indentifier of payment app instance.\n example: \"5MTUwNzI0MDEwMDAwODMyMzc3003XPzFWpzQ0yBkGWpdp8iKQ\"\n account_id_hash:\n type: string\n description: Account ID hash.\n example: \"123CCB2F30BA420B22B0B2231BD58EEADD2FCC7F0039199BBF461EAE60A88460\"\n mobile_number_suffix:\n type: string\n description: Mobile number suffix.\n example: \"501390\"\n active_token_count:\n type: string\n description: Active token count.\n example: \"0\"\n device_name:\n type: string\n description: Device name.\n example: \"Mastercard Samsung\"\n serial_number:\n type: string\n description: Serial number.\n example: \"M988575524e47423039\"\n form_factor:\n type: string\n description: Form factor.\n example: \"PHONE\"\n iso_device_type:\n type: string\n description: ISO device type.\n example: \"21\"\n os_name:\n type: string\n description: OS name.\n example: \"ANDROID\"\n os_version:\n type: string\n description: OS version.\n example: \"8.0.0\"\n imei:\n type: string\n description: IMEI.\n example: \"87576457646746\"\n msisdn:\n type: string\n description: MSI SDN.\n example: \"8988753\"\n payment_types:\n type: array\n description: An array of payment types.\n items:\n type: string\n description: Payment type.\n example: \"NFC\"\n x-nymos-default-value: null\n storage_technology:\n type: string\n description: Storage technology.\n example: \"TEE\"\n card_capture_technology:\n type: string\n description: Card capture technology.\n example: \"GE\"\n recommended_decision:\n type: string\n description: Recommended decision.\n example: \"REQUIRE_ADDITIONAL_AUTHENTICATION\"\n recommendation_standard_version:\n type: string\n description: Recommendation of standard version.\n example: \"01\"\n device_score:\n type: string\n description: Device score.\n example: \"5\"\n account_score:\n type: string\n description: Account score.\n example: \"3\"\n phone_number_score:\n type: string\n description: Phone number score.\n example: \"1\"\n account_lifetime:\n type: string\n description: Account lifetime.\n example: \"16\"\n recommendation_reasons:\n type: array\n description: An array of recommendation reasons.\n items:\n type: string\n description: Recommendation reason.\n example: \"TOO_MANY_DIFFERENT_CARDHOLDERS\"\n x-nymos-default-value: null\n token_type:\n type: string\n description: Type of token.\n example: \"EMBEDDED_SE\"\n consumer_facing_entity_name:\n type: string\n description: Consumer facing entity name.\n example: \"Samsung Pay\"\n user_id:\n type: string\n description: The unique indentifier of the user.\n example: \"e898a182-ddd3-4993-83c4-3b6e370700ff\"\n mobile_number:\n type: string\n description: Mobile number.\n example: \"+971525080230\"\n email:\n type: string\n description: Email.\n example: \"example@gmail.com\"\n card_id:\n type: string\n description: The unique indentifier of card.\n example: \"4cc48c09-b5c4-46cf-9e8b-55df2cbf7940\"\n decision:\n type: string\n description: Decision.\n example: \"REQUIRE_ADDITIONAL_AUTHENTICATION\"\n cvcResponse:\n type: string\n description: CVC response.\n example: \"MATCH\"\n errorCode:\n type: string\n description: Error code.\n example: \"01\"\n errorDescription:\n type: string\n description: Error description.\n example: \"Some error\"\n secureElementId:\n type: string\n description: The unique indentifier of secure element.\n example: \"4cc48c09-b5c4-46cf-9e8b-55df2cbf7940\"\n accountPanSuffix:\n type: string\n description: Account PAN suffix.\n example: \"4cc48c\"\n serviceRequestDateTime:\n type: string\n description: Date and time of service request.\n example: \"2023-09-05T13:01:55.309Z\"\n termsAndConditionsAssetId:\n type: string\n description: Asset ID of terms and conditions.\n example: \"4c55df2cbf7940\"\n termsAndConditionsAcceptedTimestamp:\n type: string\n description: Timestamp of accepted terms and conditions.\n example: \"2023-09-05T13:01:55.309Z\"\n productConfigurationId:\n type: string\n description: The unique indentifier of product configuration.\n example: \"4c5bf7940\"\n consumerLanguage:\n type: string\n description: Consumer language.\n example: \"ENG\"\n decisionMadeBy:\n type: string\n description: By whom the decision is made.\n example: \"person\"\n tokenActivatedDateTime:\n type: string\n description: Date and time of token activation.\n example: \"2023-09-05T13:01:55.309Z\"\n numberOfActivationAttempts:\n type: integer\n description: The number of activation attempts.\n example: \"1\"\n numberOfActiveTokens:\n type: integer\n description: The number of active tokens.\n example: \"1\"\n tokenAssuranceLevel:\n type: integer\n description: Token assurance level.\n example: \"2\"\n requestStatus:\n type: string\n description: Request status.\n example: \"T5\"\n status:\n type: string\n description: The status.\n example: \"5\"\n status_reason_code:\n type: string\n description: Status reason code.\n example: \"2T\"\n note:\n type: string\n description: Some note.\n example: \"some info\"\n status_updated_on:\n type: string\n description: The date and time when status was updated.\n example: \"2023-09-05T13:01:55.309Z\"\n format: date-time\n notify_token_reason:\n type: string\n description: Notify token reason.\n example: \"STATUS_UPDATE\"\n token_provisioning_status:\n $ref: '#/definitions/TokenProvisioningStatus'\n\n TokenProvisioningStatus:\n type: string\n description: Token provisioning status.\n example: \"ABANDONED\"\n enum:\n - ABANDONED\n SoftExpirySetting:\n type: object\n description: Soft expiry setting.\n properties:\n count:\n type: integer\n description: The count.\n format: int32\n minimum: 1\n default: 5\n grace_period:\n type: integer\n description: Grace period.\n format: int32\n minimum: 1\n default: 30\n\n\n FxRateAmountType:\n type: string\n description: FX rate amount type.\n example: \"FROM\"\n enum:\n - FROM\n - TO\n"