openapi: 3.0.0 info: title: Wallester description: >- Wallester Card API # Rate limits Wallester has no rate limits and allows sending an unlimited number of requests to API, but we reserve the right to impose such limits if necessary. # RSA keys Encrypted card data exchange schema: ![Encrypted card data exchange schema](img/encrypted-card-data-exchange-schema.png) Public key needed in the request might be programmed to be generated and encrypted on each request or prepared in advance as given in the examples below and updated periodically. It is recommended to use length of at least 3076 bytes when keys are being generated. ## Generating RSA keys RSA key pair can be generated using following command: ```shell openssl genrsa -des3 -out private.pem 4096 openssl rsa -in private.pem -outform PEM -pubout -out public.pem ``` ## Public key example ### Decoded public key example: ##### -----BEGIN PUBLIC KEY----- ##### MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA2oHA/IYjo06fRA33tca7 ##### Lgss1OvB8+cv8sTPJ5m4uwm0YChCNQW8lhDe3GP+w2ZUGAK25e8Y3gllF+G9WL0n ##### khGmYenC9+fNWCdL2npcrucNG82XgU+v8cQQNbTkzombjw4bG1fkuowLoSQir2uK ##### PE0aDhHmbdm0DebXb8mw/4NthU6dc5PFqaGuv7F9rMdtDo08mH5pOFjhkP1QGqap ##### S0sL1vrzaQv9QSs6VASiMeCVzovUqqDGS55NSY1bzvRP9zjzbNJeeK5ywadK0apu ##### y8QUgl2Wa8Xq4PcyiKMYbzpqq9oqnsc8d+WwALJaxfDfa5qMKyL7HvQXuXAZejNQ ##### L9X1DRKkBvYZEhliV/yoKwD1lwHo28sqXWW/J8ITAZwaG8K4UyERVT4mfO8RHlJU ##### lZ762KPRy+lqRqTnZkYLgG6jzShhADnfn1GaM5/obr9ZjLw3owqOaevF0NmsJlfy ##### I2aM8I9XANl+ZyQNJfART9OErfLqruOa2lZg1XebcupYxjEKfyZpiWQvD42I18UM ##### 6OGx2kpvYq6jggDqiz6BNu6LB/ckv+9z/olnkjr1cmZU3EfrfLuxRYboEBIV2GWG ##### eo0LLEiFUYP5LD60P7EnGPN4qgJ9epWWVxQKR6wAljVMUXLDzdBEu9lk45X7ILK8 ##### ejP034fViVKHij6jQZPce3cCAwEAAQ== ##### -----END PUBLIC KEY----- Test results were received using this website: https://www.base64encode.org/ : ### Base64 encoded public key string (using example above): ```shell LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQ0lqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FnOEFNSUlDQ2dLQ0FnRUEyb0hBL0lZam8wNmZSQTMzdGNhNwpMZ3NzMU92QjgrY3Y4c1RQSjVtNHV3bTBZQ2hDTlFXOGxoRGUzR1ArdzJaVUdBSzI1ZThZM2dsbEYrRzlXTDBuCmtoR21ZZW5DOStmTldDZEwybnBjcnVjTkc4MlhnVSt2OGNRUU5iVGt6b21ianc0YkcxZmt1b3dMb1NRaXIydUsKUEUwYURoSG1iZG0wRGViWGI4bXcvNE50aFU2ZGM1UEZxYUd1djdGOXJNZHREbzA4bUg1cE9GamhrUDFRR3FhcApTMHNMMXZyemFRdjlRU3M2VkFTaU1lQ1Z6b3ZVcXFER1M1NU5TWTFienZSUDl6anpiTkplZUs1eXdhZEswYXB1Cnk4UVVnbDJXYThYcTRQY3lpS01ZYnpwcXE5b3Fuc2M4ZCtXd0FMSmF4ZkRmYTVxTUt5TDdIdlFYdVhBWmVqTlEKTDlYMURSS2tCdllaRWhsaVYveW9Ld0QxbHdIbzI4c3FYV1cvSjhJVEFad2FHOEs0VXlFUlZUNG1mTzhSSGxKVQpsWjc2MktQUnkrbHFScVRuWmtZTGdHNmp6U2hoQURuZm4xR2FNNS9vYnI5WmpMdzNvd3FPYWV2RjBObXNKbGZ5CkkyYU04STlYQU5sK1p5UU5KZkFSVDlPRXJmTHFydU9hMmxaZzFYZWJjdXBZeGpFS2Z5WnBpV1F2RDQySTE4VU0KNk9HeDJrcHZZcTZqZ2dEcWl6NkJOdTZMQi9ja3YrOXovb2xua2pyMWNtWlUzRWZyZkx1eFJZYm9FQklWMkdXRwplbzBMTEVpRlVZUDVMRDYwUDdFbkdQTjRxZ0o5ZXBXV1Z4UUtSNndBbGpWTVVYTER6ZEJFdTlsazQ1WDdJTEs4CmVqUDAzNGZWaVZLSGlqNmpRWlBjZTNjQ0F3RUFBUT09Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ== ``` # Authorization Authorization is implemented using [JSON Web Tokens (JWT)](https://jwt.io/). For more information, please see [our repository of integration examples](https://github.com/wallester/integration-examples). version: v1 contact: email: operations@wallester.com url: /v1/doc/# x-logo: url: img/wallester-logo.png x-api-status-urls: - https://api-doc.wallester.com/ x-konfig-ignore: potential-incorrect-type: true servers: - url: https://localhost:8000 tags: - name: Card - name: Person - description: >+ ## Introduction This document describes how the **Client** can integrate with the **Wallester** system to receive events in real-time and do custom business logic in **Client’s** system based on the received data. **Wallester** sends events using [Webhooks](https://hookdeck.com/webhooks/guides/what-are-webhooks-how-they-work#consuming-a-webhook) based communication, where **Client** has an HTTP server and **Wallester** acts as a client. **Wallester** does a HTTP POST request to a URL of **Client** choice in a JSON format. Along with the event, data about the object is transferred, which is referred to as the payload. The payload can be extended with new optional fields at any time, therefore **Client** should be able to receive and process fields of any type and not add strict validation. ## Communication Format To use the **Wallester** notification system, **Client** must share the following information: 1. Basic authentication credentials (Username & Password) 2. HTTP server URL 3. Type of events to be enabled ## HTTP HTTP requests are protected with HTTP Basic authentication. To unauthenticated requests, the external system should return a response with a HTTP 401 Unauthorized status. ![Request-response scheme](img/request-response.png) The **Client** needs to whitelist the **Wallester** IP addresses in order to allow requests to pass through the firewall. **Production:** - Contact our Support team [support@wallester.com](mailto:support@wallester.com) **Sandbox:** - Contact our Support team [support@wallester.com](mailto:support@wallester.com) ## Guaranteed delivery Notifications can be configured with guaranteed delivery feature. Notification will be sent again in case of an unexpected response status code (not HTTP code 200) or a timeout for any of the involved notification types, the Retry logic will apply. The feature is available for the following Notification Event types: - Authorization notification - Create card - Fee - Authorization release - Transaction clearing - KYC Check - Person KYC status change (new format) - Apple pay orange flow notifications **Retry logic:**
RetryApproximate time after the first failure
1st retry2 seconds
2nd retry5 seconds
3rd retry10 seconds
4th retry10 minutes
5th retry30 minutes
6th retry1 hour
7th retry3 hours
8th retry6 hours
9th retry12 hours
10th retry24 hours
Depending on the technical requirements, a specific message delivery type should be chosen: 1. **Limited** - events will be retried 10 times only; retry logic intervals are applied; 2. **Mandatory** - events will be retried until Wallester receives a successful response; retry logic intervals are applied; after the 10th try message will be resent every 24 hours. The diagram below is given for the visual flow representation: ![Diagram of Notification Sending Process](img/send-notifications-diagram.png) ## Events ### 1. Authorization Given events allows the Client to receive information for all card related authorizations and binded notifications, initiated by Cardholder or Merchant. Intent of such notifications is purely informative. 1.1. [Authorization](https://api-doc.wallester.com) 1.2. [Reversal authorization](https://api-doc.wallester.com) 1.3. [Release authorization](https://api-doc.wallester.com) ### 1.4. Decision request Following events might be used in case when **Client** would like to get access to authorization approval logic. There are a few specific decision requests: Balance Inquiry and Partial payment. Those require more advanced behavior than regular payment authorizations. Due to strict card schema requirements, a response must be sent back to **Wallester** within 1 second or less. If **Client** does not reply within the expected period or there are any communication issues between **Client** and **Wallester** (unresolvable within a given time), **Wallester** will use **default behavior defined by Client** (approve or decline). 1.4.1. [Decision request: Authorization](https://api-doc.wallester.com) 1.4.2. [Decision request: Balance inquiry authorization](https://api-doc.wallester.com) 1.4.3. [Decision request: Partial Authorization](https://api-doc.wallester.com) #### Response codes This section describes all possible response codes that can be used in response to a decision request. It is strongly recommended to use all available options and return the correct reason for each decision.
Response CodeDescription
ApprovedApprove.
ApprovedForPartialAmountApprove for a partial amount. See Partial authorization for more details.
ClientSystemMalfunctionClient system is experiencing downtime.
DeclinedByClientDecline.
DoNotHonourDecline due to potential fraud or other system rules.
NotSufficientFundsInsufficient funds on the cardholder balance.
TransactionNotPermittedToCardholderPayment not allowed for the cardholder.
### 2. Transaction 2.1. [Transaction clearing](https://api-doc.wallester.com) ### 3. Account adjustment 3.1. [Incoming payment](https://api-doc.wallester.com) ### 4. Fee Fee types and events are configured in the Wallester system, which makes it possible to configure notifications only for a specific fee or event type. Only a complete event is available at the moment. Possible event types: - **create** (Event notification is triggered when a new fee is created, except one that is created in Completed status and is not related to authorization.) - **update** (Event notification is triggered when a fee amount changes. For example, during clearing the amount is recalculated.) - **cancel** (Event notification is triggered when a fee is canceled. For example, the authorization has expired and related fee is canceled) - **complete** (Event notification is triggered when a new fee is created in Completed status or fee status has changed to Completed. For example, the CardIssuanceFee is created in Completed status or fee status has changed to Completed after clearing.) 4.1. [Complete fee](https://api-doc.wallester.com) 4.2. [Create fee](https://api-doc.wallester.com) 4.3. [Update fee](https://api-doc.wallester.com) 4.4. [Cancel fee](https://api-doc.wallester.com) ### 5. Tokenization 5.1. Apple pay incentive notifications 5.1.1. [Apple Pay incentive notification incomplete provisioning](https://api-doc.wallester.com) 5.1.2. [Apple Pay incentive notification successful transaction](https://api-doc.wallester.com) 5.2. [Apple pay orange flow](https://api-doc.wallester.com) ### 6. Person 6.1. [KYC status change](https://api-doc.wallester.com) ### 7. Card Card lifecycle representation: ![Card lifecycle representation](img/card-lifecycle-representation.png) 7.1. [Create card](https://api-doc.wallester.com) 7.2. [Ordered card](https://api-doc.wallester.com) 7.3. [Personalize card](https://api-doc.wallester.com) 7.4. [Dispatch card](https://api-doc.wallester.com) 7.5. [Activate card](https://api-doc.wallester.com) 7.6. [Block card](https://api-doc.wallester.com) 7.7. Close card Event notification is triggered when a new card is closed. The status is applicable for all card types. - 7.7.1. [Closing](https://api-doc.wallester.com) - 7.7.2. [Closed](https://api-doc.wallester.com) 7.8. [Expire card](https://api-doc.wallester.com) 7.9. [Renew card](https://api-doc.wallester.com) ### 8. 3D Secure 8.1. [Event notification is triggered when a new 3DS OTP request is received. By default, the message is sent to the cardholder via SMS, however when this event is enabled, the message will be forwarded to a server defined by the Client instead.](https://api-doc.wallester.com) 8.2. 3D secure authentication **Currently, this topic only implies Out of Band authentication. This is the initial version that can be modified in the future, therefore make sure to not add strict validation.** 1. **Wallester** will send the [Initiate Action](https://api-doc.wallester.com) event to Client, providing information about cardholder and purchase. 2. **Client** will send a notification to the cardholder’s device to wake the mobile application. 3. Cardholder will authenticate within **Client** App (via out of band). 4. **Wallester** will send the [Validate](https://api-doc.wallester.com) event to the **Client** asking for the results (this recurs every 2 seconds after each Pending Status is received). 5. **Client** will verify whether the cardholder has confirmed the purchase. **Wallester** expects to receive response from **Client** in less than 500 ms per each event. ![3Ds Out of Band authentication](img/3ds-out-of-band-authentication.jpg) - 8.2.1. [Initiate action](https://api-doc.wallester.com) - 8.2.2. [Validate](https://api-doc.wallester.com) ### 9. KYC Check 9.1. [KYC Check](https://api-doc.wallester.com) name: Webhooks - name: Company - name: Account - name: Product - name: Token - name: Fee - name: Testing - name: Authorizations - name: Transactions - name: Fraud-Case - name: KYC-Check - name: Payment-Document - name: Templates - name: Account-Adjustments - name: Extract-Files - name: Reminders - name: KYC-Document - name: Settlement - name: Other - name: Status paths: /host:port/v1/3d-secure-otp-event: post: tags: - Webhooks summary: 3D Secure OTP operationId: Webhooks_threeDSecureOtpEventNotification security: - basic: [] description: >- Event notification is triggered when a new 3DS OTP request is received. By default, the message is sent to the cardholder via SMS, however when this event is enabled, the message will be forwarded to a server defined by the Client instead. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ThreeDSecureOTP' multipart/form-data: schema: $ref: '#/components/schemas/ThreeDSecureOTP' x-go-name: Request responses: '200': description: threeDSecureOTPResponse content: application/json: schema: $ref: '#/components/schemas/threeDSecureOTPResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/account-adjustment-notification: post: tags: - Webhooks summary: Account adjustment notification operationId: Webhooks_notifyAccountAdjustment security: - basic: [] description: Account adjustment notification parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountAdjustmentNotification' multipart/form-data: schema: $ref: '#/components/schemas/AccountAdjustmentNotification' x-go-name: Request responses: '200': description: accountAdjustmentNotificationResponse content: application/json: schema: $ref: '#/components/schemas/accountAdjustmentNotificationResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/account-to-account-transfer-notification: post: tags: - Webhooks summary: Account to Account transfer notification operationId: Webhooks_notifyAccountTransfer security: - basic: [] description: Account to Account transfer notification parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountToAccountTransferNotification' multipart/form-data: schema: $ref: '#/components/schemas/AccountToAccountTransferNotification' x-go-name: Request responses: '200': description: accountToAccountTransferNotificationResponse content: application/json: schema: $ref: >- #/components/schemas/accountToAccountTransferNotificationResponse '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/activate-card-event: post: tags: - Webhooks summary: Activate card operationId: Webhooks_notifyCardActivation security: - basic: [] description: >- Event notification is triggered when a new card is activated. The status is applicable for all card types. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/ActivateCardEvent' x-go-name: Request responses: '200': description: activateCardEventResponse content: application/json: schema: $ref: '#/components/schemas/activateCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/apple-pay-incentive-notification-incomplete-provisioning-event: post: tags: - Webhooks summary: Apple Pay incentive notification incomplete provisioning operationId: Webhooks_sendIncompleteProvisioningNotification security: - basic: [] description: >- Incomplete provisioning Apple Pay incentive notification is sent when a cardholder has commenced provisioning onto Apple Pay platform but has not completed provisioning within seven (7) days. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: >- #/components/schemas/ApplePayIncentiveNotificationIncompleteProvisioning multipart/form-data: schema: $ref: >- #/components/schemas/ApplePayIncentiveNotificationIncompleteProvisioning x-go-name: Request responses: '200': description: applePayIncentiveNotificationIncompleteProvisioningResponse content: application/json: schema: $ref: >- #/components/schemas/applePayIncentiveNotificationIncompleteProvisioningResponse '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/apple-pay-incentive-notification-successful-transaction-event: post: tags: - Webhooks summary: Apple Pay incentive notification successful transaction operationId: Webhooks_sendApplePayIncentiveNotification security: - basic: [] description: >- Successful transaction Apple Pay incentive notification is sent when a cardholder has completed provisioning onto Apple Pay platform but has not made a successful payment with Apple Pay within fourteen (14) days. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: >- #/components/schemas/ApplePayIncentiveNotificationSuccessfulTransaction multipart/form-data: schema: $ref: >- #/components/schemas/ApplePayIncentiveNotificationSuccessfulTransaction x-go-name: Request responses: '200': description: applePayIncentiveNotificationSuccessfulTransactionResponse content: application/json: schema: $ref: >- #/components/schemas/applePayIncentiveNotificationSuccessfulTransactionResponse '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/apple-pay-orange-flow-event: post: tags: - Webhooks summary: Apple pay orange flow operationId: Webhooks_notifyAuthenticationOptions security: - basic: [] description: >- Apple provides recommendations on authentication methods that users may encounter during provisioning. A notification will be sent if the user is only given the option to authenticate through the Call Center. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplePayOrangeFlow' multipart/form-data: schema: $ref: '#/components/schemas/ApplePayOrangeFlow' x-go-name: Request responses: '200': description: applePayIncentiveNotificationSuccessfulTransactionResponse content: application/json: schema: $ref: >- #/components/schemas/applePayIncentiveNotificationSuccessfulTransactionResponse '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/authorization-event: post: tags: - Webhooks summary: Authorization operationId: Webhooks_authorizeEvent security: - basic: [] description: Authorization parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthorizationView' multipart/form-data: schema: $ref: '#/components/schemas/AuthorizationView' x-go-name: Request responses: '200': description: authorizationResponse content: application/json: schema: $ref: '#/components/schemas/authorizationResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/block-card-event: post: tags: - Webhooks summary: Block card operationId: Webhooks_notifyCardBlocked security: - basic: [] description: >- Event notification is triggered when a card is blocked. The status is applicable for all card types. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/BlockCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/BlockCardEvent' x-go-name: Request responses: '200': description: blockCardEventResponse content: application/json: schema: $ref: '#/components/schemas/blockCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/cancel-fee-event: post: tags: - Webhooks summary: Cancel fee operationId: Webhooks_cancelFeeEvent security: - basic: [] description: >- Event notification is triggered when a fee is canceled. For example, the authorization has expired and related fee is canceled parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelFee' multipart/form-data: schema: $ref: '#/components/schemas/CancelFee' x-go-name: Request responses: '200': description: cancelFeeResponse content: application/json: schema: $ref: '#/components/schemas/cancelFeeResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/closed-card-event: post: tags: - Webhooks summary: Card closed operationId: Webhooks_notifyCardClosure security: - basic: [] description: >- Event notification is triggered when a card closes. The status is applicable for ChipAndPin and ChipAndPinAnonymous card types only. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClosedCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/ClosedCardEvent' x-go-name: Request responses: '200': description: closedCardEventResponse content: application/json: schema: $ref: '#/components/schemas/closedCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/closing-card-event: post: tags: - Webhooks summary: Card closing operationId: Webhooks_notifyCardClosingStatus security: - basic: [] description: >- If a card was closed but the clearing was not complete for all authorizations, the card will get a “Closing” status until clearing is done. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClosingCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/ClosingCardEvent' x-go-name: Request responses: '200': description: closingCardEventResponse content: application/json: schema: $ref: '#/components/schemas/closingCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/complete-fee-event: post: tags: - Webhooks summary: Complete fee operationId: Webhooks_completeFeeEventNotification security: - basic: [] description: >- Event notification is triggered when a new fee is created in Completed status or fee status has changed to Completed. For example, the CardIssuanceFee is created in Completed status or fee status has changed to Completed after clearing. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CompleteFee' multipart/form-data: schema: $ref: '#/components/schemas/CompleteFee' x-go-name: Request responses: '200': description: completeFeeResponse content: application/json: schema: $ref: '#/components/schemas/completeFeeResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/create-card-event: post: tags: - Webhooks summary: Create card operationId: Webhooks_triggerCardEventNotification security: - basic: [] description: >- Event notification is triggered when a new card is created. This type of notification is best to use with cards extracts file described in the specification called "Extract Files Overview". There are two options for notifications: 1. Send notification only for cards which are created with send_notification flag set to true. API documentation: https://api-doc.wallester.com/#operation/CreateCard 2. Send notifications for all cards created in the system. There is no need to send flag through the API in this case. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/CreateCardEvent' x-go-name: Request responses: '200': description: createCardEventResponse content: application/json: schema: $ref: '#/components/schemas/createCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/create-fee-event: post: tags: - Webhooks summary: Create fee operationId: Webhooks_notifyNewFee security: - basic: [] description: >- Event notification is triggered when a new fee is created, except one that is created in Completed status, and is not related to authorization. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFee' multipart/form-data: schema: $ref: '#/components/schemas/CreateFee' x-go-name: Request responses: '200': description: createFeeResponse content: application/json: schema: $ref: '#/components/schemas/createFeeResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/decision-request-authorization-event: post: tags: - Webhooks summary: 'Decision request: Authorization' operationId: Webhooks_authorizeDecisionRequest security: - basic: [] description: 'Decision request: Authorization' parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/DecisionRequestAuthorizationView' multipart/form-data: schema: $ref: '#/components/schemas/DecisionRequestAuthorizationView' x-go-name: Request responses: '200': description: decisionRequestAuthorizationResponse content: application/json: schema: $ref: '#/components/schemas/decisionRequestAuthorizationResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/decision-request-balance-inquiry-authorization-event: post: tags: - Webhooks summary: 'Decision request: Balance inquiry authorization' operationId: Webhooks_balanceInquiryAuthorization security: - basic: [] description: >- In case when an external balance system is implemented on the **Client** side, the given interface helps **Wallester** to provide to the Customer information on card balance requests, fulfill reversal operations and resolve partial payments. For the authorizations which have type **ATMBalanceInquiry**, sending of balance information is mandatory in a response if the response code is set to **Approved**. Where **balance**: cardholder’s balance, **available_amount** - cardholder’s available amount funds. In case of **Wallester** declining Balance Inquiry authorization for any reason, the **Client** will receive an appropriate notification event with the information on the declined request. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: >- #/components/schemas/DecisionRequestBalanceInquiryAuthorizationView multipart/form-data: schema: $ref: >- #/components/schemas/DecisionRequestBalanceInquiryAuthorizationView x-go-name: Request responses: '200': description: decisionRequestBalanceInquiryAuthorizationResponse content: application/json: schema: $ref: >- #/components/schemas/decisionRequestBalanceInquiryAuthorizationResponse '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/dispatch-card-event: post: tags: - Webhooks summary: Dispatch card operationId: Webhooks_dispatchCardEvent security: - basic: [] description: >- Event notification is triggered when a new card is dispatched from the personalization bureau. The status is applicable for ChipAndPin and ChipAndPinAnonymous card types only. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/DispatchCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/DispatchCardEvent' x-go-name: Request responses: '200': description: dispatchCardEventResponse content: application/json: schema: $ref: '#/components/schemas/dispatchCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/expire-card-event: post: tags: - Webhooks summary: Expire card operationId: Webhooks_expireCardEventNotification security: - basic: [] description: >- Event notification is triggered when a card gets expired. The status is applicable for all card types. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ExpireCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/ExpireCardEvent' x-go-name: Request responses: '200': description: expireCardEventResponse content: application/json: schema: $ref: '#/components/schemas/expireCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/initiate-action-event: post: tags: - Webhooks summary: Initiate action operationId: Webhooks_initiateActionEvent security: - basic: [] description: >- The **Initiate Action** event takes place once the method of 3DS authentication is identified. The outcome of the event is the cardholder seeing the screen with instructions on how to complete their authentication by interacting with a 3rd party application. Use **request_id** as a unique identifier to identify the particular authentication request in the [Validate](https://api-doc.wallester.com) event. Expected response HTTP status code is **200 OK**, otherwise unavailable authentication status returned to the merchant. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/InitiateAction' multipart/form-data: schema: $ref: '#/components/schemas/InitiateAction' x-go-name: Request responses: '200': description: initiateActionResponse content: application/json: schema: $ref: '#/components/schemas/initiateActionResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/kyc-check-event: post: tags: - Webhooks summary: KYC Check operationId: Webhooks_kycCheckEventCreate security: - basic: [] description: >- These events are available only on the Wallester White-Label program. Possible event types: create - Event notification is triggered when a new KYC Check is created. delete - Event notification is triggered when a KYC Check is deleted. reject - Event notification is triggered when a KYC Check is rejected. approve - Event notification is triggered when a KYC Check is approved. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/KYCCheckEvent' multipart/form-data: schema: $ref: '#/components/schemas/KYCCheckEvent' x-go-name: Request responses: '200': description: kycCheckResponse content: application/json: schema: $ref: '#/components/schemas/kycCheckResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/kyc-status-change-event: post: tags: - Webhooks summary: KYC status change operationId: Webhooks_kycStatusChange security: - basic: [] description: KYC status change parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/KYCStatusChange' multipart/form-data: schema: $ref: '#/components/schemas/KYCStatusChange' x-go-name: Request responses: '200': description: kycStatusChangeResponse content: application/json: schema: $ref: '#/components/schemas/kycStatusChangeResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/ordered-card-event: post: tags: - Webhooks summary: Ordered card operationId: Webhooks_notifyCardOrder security: - basic: [] description: >- Event notification is triggered when a new card is ordered. The status is applicable for ChipAndPin and ChipAndPinAnonymous card types only. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderedCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/OrderedCardEvent' x-go-name: Request responses: '200': description: orderedCardEventResponse content: application/json: schema: $ref: '#/components/schemas/orderedCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/partial-authorization-event: post: tags: - Webhooks summary: 'Decision request: Partial authorization' operationId: Webhooks_partialAuthorizationEventPost security: - basic: [] description: >- Partial authorizations might be available for the various authorization types, depending on merchant type and its capabilities to support partial approvals. Nevertheless, a good sample of conditions where partial payments apply might be authorization with the type **AutomatedFuelDispenser**. Conditions when partial payments might be allowed or declined fully depending on Client’s regulations. For example, in case when a cardholder has less money on account than requested via authorization, the Client might freeze the available amount and respond with the response code **ApprovedForPartialAmount**. In such cases an **approved_amount** is expected in response, where the **approved_amount** - amount of money that will be frozen on the cardholder's account. In case when a cardholder has enough funds on account on **AutomatedFuelDispenser**, authorization response code is set to **Approved**, which means the full amount was available and frozen on account. In case of **Wallester** declining authorization for any reason, the **Client** will receive an appropriate notification event with the information on the declined request. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/DecisionRequestPartialAuthorizationView' multipart/form-data: schema: $ref: '#/components/schemas/DecisionRequestPartialAuthorizationView' x-go-name: Request responses: '200': description: decisionRequestPartialAuthorizationResponse content: application/json: schema: $ref: >- #/components/schemas/decisionRequestPartialAuthorizationResponse '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/personalize-card-event: post: tags: - Webhooks summary: Personalize card operationId: Webhooks_notifyCardPersonalization security: - basic: [] description: >- Event notification is triggered when a new card is personalized. The status is applicable for ChipAndPin and ChipAndPinAnonymous card types only. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/PersonalizeCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/PersonalizeCardEvent' x-go-name: Request responses: '200': description: personalizeCardEventResponse content: application/json: schema: $ref: '#/components/schemas/personalizeCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/release-authorization-event: post: tags: - Webhooks summary: Release authorization operationId: Webhooks_releaseAuthorizationEvent security: - basic: [] description: >- Authorization transfers funds from the available amount to the blocked amount, while the money remains in the account. Banks usually hold funds for 7-14 days. Funds are physically transferred at the time of the transaction. If the transaction did not occur on time, then the funds are returned from the blocked amount to the available amount. This is called "release authorization". "Release authorization" can occur for several reasons, for example, due to a technical error or due to the fault of the merchant who did not send the transaction on time. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReleaseAuthorizationView' multipart/form-data: schema: $ref: '#/components/schemas/ReleaseAuthorizationView' x-go-name: Request responses: '200': description: releaseAuthorizationResponse content: application/json: schema: $ref: '#/components/schemas/releaseAuthorizationResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/renew-card-event: post: tags: - Webhooks summary: Renew card operationId: Webhooks_renewCardEventNotification security: - basic: [] description: >- Event notification is triggered N days before the card expiration and identifies that the card may be renewed. The status is applicable for all card types. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/RenewCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/RenewCardEvent' x-go-name: Request responses: '200': description: renewCardEventResponse content: application/json: schema: $ref: '#/components/schemas/renewCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/replace-card-event: post: tags: - Webhooks summary: Replace card operationId: Webhooks_cardReplaceEventNotification security: - basic: [] description: >- Event notification is triggered when the card is replaced. The status is applicable for all card types. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReplaceCardEvent' multipart/form-data: schema: $ref: '#/components/schemas/ReplaceCardEvent' x-go-name: Request responses: '200': description: replaceCardEventResponse content: application/json: schema: $ref: '#/components/schemas/replaceCardEventResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/reversal-authorization-event: post: tags: - Webhooks summary: Reversal authorization operationId: Webhooks_reversalAuthorization security: - basic: [] description: >- Reversal authorization happens when the funds used by the cardholder in a payment are returned to the cardholder's account. This can be initiated by the cardholder, the merchant, the issuing bank, the acquiring bank, or the card association. Common reason why reversal authorization occurs: the item ended up being sold out. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReversalAuthorizationView' multipart/form-data: schema: $ref: '#/components/schemas/ReversalAuthorizationView' x-go-name: Request responses: '200': description: reversalAuthorizationResponse content: application/json: schema: $ref: '#/components/schemas/reversalAuthorizationResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/transaction-clearing-event: post: tags: - Webhooks summary: Transaction clearing operationId: Webhooks_triggerTransactionClearing security: - basic: [] description: Transaction clearing parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionClearing' multipart/form-data: schema: $ref: '#/components/schemas/TransactionClearing' x-go-name: Request responses: '200': description: transactionClearingResponse content: application/json: schema: $ref: '#/components/schemas/transactionClearingResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/update-fee-event: post: tags: - Webhooks summary: Update fee operationId: Webhooks_updateFeeEvent security: - basic: [] description: >- Event notification is triggered when a fee amount changes. For example, during clearing the amount is recalculated. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFee' multipart/form-data: schema: $ref: '#/components/schemas/UpdateFee' x-go-name: Request responses: '200': description: updateFeeResponse content: application/json: schema: $ref: '#/components/schemas/updateFeeResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /host:port/v1/validate-event: post: tags: - Webhooks summary: Validate operationId: Webhooks_validateEvent security: - basic: [] description: >- The **Validate** event takes place after the [Initiate Action](https://api-doc.wallester.com) in order to check whether the cardholder has confirmed the purchase or not. Use request_id as a unique identifier to identify the particular authentication request from the Initiate Action event. Expected response HTTP status code is **200 OK** and a status from the list below in the request body, otherwise unavailable authentication status returned to the merchant. Success - Ends the transaction with a successful authentication status to the merchant. Pending - Initiates another Validate event from **Wallester** to the **Client** after 2 seconds. Rejected - Ends the transaction with a rejected authentication status to the merchant and indicates they should not proceed with authorization. Error - Returns an unavailable authentication status to the merchant. parameters: - description: 'Basic auth, in "Authorization: Basic BASE64_ENCODED_DATA" format' in: header name: Authorization required: true x-go-name: Token schema: type: string - description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header name: X-Request-ID required: true x-go-name: RequestID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ThreeDSValidate' multipart/form-data: schema: $ref: '#/components/schemas/ThreeDSValidate' x-go-name: Request responses: '200': description: threeDSValidateResponse content: application/json: schema: $ref: '#/components/schemas/threeDSValidateResponse' '401': $ref: '#/components/responses/unauthorized' '500': $ref: '#/components/responses/internalServerError' /v1/account-adjustments: post: tags: - Account-Adjustments summary: Create account adjustment operationId: AccountAdjustments_createAccountAdjustment security: - JWT: [] description: >- Adds or subtracts specified amount from account balance (negative value is used for subtraction). Returns account adjustment in response parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AdjustAccountBalanceWithAdjustmentRequest' multipart/form-data: schema: $ref: '#/components/schemas/AdjustAccountBalanceWithAdjustmentRequest' required: true x-go-name: Request responses: '200': description: AdjustAccountBalanceWithAdjustmentResponse content: application/json: schema: $ref: >- #/components/schemas/AdjustAccountBalanceWithAdjustmentResponse '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/account-adjustments-by-external-id/{external_id}: get: tags: - Account-Adjustments summary: Get account adjustment by external ID operationId: AccountAdjustments_getByExternalId security: - JWT: [] description: Get account adjustment by external ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: External ID in: path name: external_id required: true x-go-name: ExternalID schema: type: string responses: '200': description: GetAccountAdjustmentByExternalIDResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountAdjustmentByExternalIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/account-adjustments/{account_adjustment_id}: get: tags: - Account-Adjustments summary: Get account adjustment operationId: AccountAdjustments_getInformation security: - JWT: [] description: Get account adjustment information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account adjustment ID in: path name: account_adjustment_id required: true x-go-name: AccountAdjustmentID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetAccountAdjustmentResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountAdjustmentResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/account-payments: patch: tags: - Account summary: Create account payment operationId: Account_transferFunds security: - JWT: [] description: Transfers money from one account to another parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccountPaymentRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateAccountPaymentRequest' required: true x-go-name: Request responses: '200': description: CreateAccountPaymentResponse content: application/json: schema: $ref: '#/components/schemas/CreateAccountPaymentResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts: get: tags: - Account summary: Search accounts operationId: Account_searchList security: - JWT: [] description: Search accounts parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Name in: query name: name x-go-name: Name schema: type: string - description: External ID in: query name: external_id x-go-name: ExternalID schema: type: string - description: Is main account in: query name: is_main x-go-name: IsMain schema: type: boolean - description: Exceeding credit limit in: query name: exceeding_credit_limit x-go-name: ExceedingCreditLimit schema: type: boolean - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- Field to sort by: created_at, updated_at, balance, blocked_amount, available_amount, name, status in: query name: order_field x-go-name: OrderField schema: type: string default: created_at - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: SearchAccountsResponse content: application/json: schema: $ref: '#/components/schemas/SearchAccountsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Account summary: Create account operationId: Account_createNewAccount security: - JWT: [] description: Create account parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccountRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateAccountRequest' required: true x-go-name: Request responses: '201': description: CreateAccountResponse content: application/json: schema: $ref: '#/components/schemas/CreateAccountResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts-by-external-id/{external_id}: get: tags: - Account summary: Get account by external ID operationId: Account_getByExternalId security: - JWT: [] description: Get account by external ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: External ID in: path name: external_id required: true x-go-name: ExternalID schema: type: string responses: '200': description: GetAccountByExternalIDResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountByExternalIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts-by-ids: post: tags: - Account summary: Get accounts by IDs operationId: Account_getByIds security: - JWT: [] description: Get accounts information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GetAccountsByIDsRequest' multipart/form-data: schema: $ref: '#/components/schemas/GetAccountsByIDsRequest' required: true x-go-name: Request responses: '200': description: GetAccountsByIDsResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountsByIDsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts-exceeding-credit-limit: get: tags: - Account summary: Get accounts exceeding credit limit operationId: Account_getExceedingCreditAccounts security: - JWT: [] description: Returns accounts that have available amount more than credit limit parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: GetAccountsExceedingCreditLimitResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountsExceedingCreditLimitResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' deprecated: true /v1/accounts/{account_id}: get: tags: - Account summary: Get account operationId: Account_getInformation security: - JWT: [] description: Get account information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetAccountResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/account-adjustments/{account_adjustment_id}/external-id: patch: tags: - Account summary: Update account adjustment external ID operationId: Account_updateExternalId security: - JWT: [] description: >- Update account adjustment external ID. It is allowed to send empty external ID to remove the external ID from the account adjustment. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: Account adjustment ID in: path name: account_adjustment_id required: true x-go-name: AccountAdjustmentID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccountAdjustmentExternalIDRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateAccountAdjustmentExternalIDRequest' required: true x-go-name: Request responses: '200': description: UpdateAccountAdjustmentExternalIDResponse content: application/json: schema: $ref: '#/components/schemas/UpdateAccountAdjustmentExternalIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/authorizations: get: tags: - Authorizations summary: Get account authorizations operationId: Authorizations_getAccountAuthorizations security: - JWT: [] description: Get account authorizations parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetAccountAuthorizationsResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountAuthorizationsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/balance: patch: tags: - Account summary: Adjust account balance operationId: Account_adjustBalanceById security: - JWT: [] description: >- Adds or subtracts specified amount from account balance (negative value is used for subtraction). Returns account in response. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/AdjustAccountBalanceRequest' multipart/form-data: schema: $ref: '#/components/schemas/AdjustAccountBalanceRequest' required: true x-go-name: Request responses: '200': description: AdjustAccountBalanceResponse content: application/json: schema: $ref: '#/components/schemas/AdjustAccountBalanceResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/cards: get: tags: - Account summary: Get account cards operationId: Account_getCards security: - JWT: [] description: Get account cards parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- CardStatuses is **repeated** query parameter to specify card statuses to return. in: query name: card_statuses x-go-name: CardStatuses schema: type: string enum: - Created - Ordered - Personalized - Dispatched - Active - Blocked - Closing - Closed - Expired - AwaitingRenewal - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetAccountCardsResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountCardsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/close: delete: tags: - Account summary: Close account operationId: Account_closeAccount security: - JWT: [] description: Closes account with default reason ClosedByClient parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 responses: '200': description: CloseAccountResponse content: application/json: schema: $ref: '#/components/schemas/CloseAccountResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Account summary: Close account operationId: Account_closeAccount security: - JWT: [] description: Close account parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CloseAccountRequest' multipart/form-data: schema: $ref: '#/components/schemas/CloseAccountRequest' required: true x-go-name: Request responses: '200': description: CloseAccountResponse content: application/json: schema: $ref: '#/components/schemas/CloseAccountResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/credit-limit: patch: tags: - Account summary: Update credit limit operationId: Account_updateCreditLimit security: - JWT: [] description: Update credit limit parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCreditLimitRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCreditLimitRequest' required: true x-go-name: Request responses: '201': description: UpdateCreditLimitResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCreditLimitResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/download-statement: get: tags: - Account summary: Download account statement operationId: Account_downloadStatement security: - JWT: [] description: Download account statement parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: from_date required: true x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: to_date required: true x-go-name: ToDate schema: type: string format: date-time - description: Timezone in: query name: timezone x-go-name: Timezone schema: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - Egypt - Eire - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - W-SU - description: Language code in: query name: language_code x-go-name: LanguageCode schema: type: string enum: - ENG - RUS - LAV - LIT - description: Statement file type in: query name: statement_file_type required: true x-go-name: StatementFileType schema: type: string enum: - pdf - csv - excel - iso20022.053.001.02 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: DownloadAccountStatementResponse content: application/json: schema: $ref: '#/components/schemas/DownloadAccountStatementResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/external-id: patch: tags: - Account summary: Update account external ID operationId: Account_updateExternalId security: - JWT: [] description: >- Update account external ID. It is allowed to send empty external ID to remove the external ID from the account. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccountExternalIDRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateAccountExternalIDRequest' required: true x-go-name: Request responses: '200': description: UpdateAccountExternalIDResponse content: application/json: schema: $ref: '#/components/schemas/UpdateAccountExternalIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/history: get: tags: - Account summary: Get account history operationId: Account_getHistory security: - JWT: [] description: Get account history parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: Return only records not made by system in: query name: is_not_system x-go-name: IsNotSystem schema: type: boolean responses: '200': description: GetAccountHistoryResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountHistoryResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/limits: patch: tags: - Account summary: Update account limits operationId: Account_updateLimits security: - JWT: [] description: Update account limits parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 requestBody: $ref: '#/components/requestBodies/UpdateAccountLimitsRequest' responses: '200': description: UpdateAccountLimitsResponse content: application/json: schema: $ref: '#/components/schemas/UpdateAccountLimitsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/limits-usage: get: tags: - Account summary: Get account limits usage operationId: Account_getLimitsUsage security: - JWT: [] description: Get account limits usage parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetAccountLimitsUsageResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountLimitsUsageResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/name: patch: tags: - Account summary: Update account name operationId: Account_updateName security: - JWT: [] description: >- Update account name. It is allowed to send empty name to remove the name from the account. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccountNameRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateAccountNameRequest' required: true x-go-name: Request responses: '200': description: UpdateAccountNameResponse content: application/json: schema: $ref: '#/components/schemas/UpdateAccountNameResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/reopen: patch: tags: - Account summary: Reopen account operationId: Account_reopenAccount security: - JWT: [] description: Reopen account parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 responses: '200': description: ReopenAccountResponse content: application/json: schema: $ref: '#/components/schemas/ReopenAccountResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/statement: get: tags: - Account summary: Get account statement operationId: Account_getStatement security: - JWT: [] description: >- It can contain account authorizations, transactions and adjustments, and can filter declined, reversed or cleared authorizations out parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- IncludeAuthorizations defines whether to include authorizations to account statement or not. in: query name: include_authorizations x-go-name: IncludeAuthorizations schema: type: boolean - description: >- IncludeTransactions defines whether to include transactions to account statement or not. in: query name: include_transactions x-go-name: IncludeTransactions schema: type: boolean - description: >- IncludeAccountAdjustments defines whether to include account adjustments to account statement or not. in: query name: include_account_adjustments x-go-name: IncludeAccountAdjustments schema: type: boolean - description: >- IncludeFees defines whether to include fees to account statement or not. in: query name: include_fees x-go-name: IncludeFees schema: type: boolean - description: >- ExcludeDeclinedAuthorizations defines whether to exclude declined authorizations from account statement or not. in: query name: exclude_declined_authorizations x-go-name: ExcludeDeclinedAuthorizations schema: type: boolean - description: >- ExcludeReversedAuthorizations defines whether to exclude reversed authorizations and reversals from account statement or not. in: query name: exclude_reversed_authorizations x-go-name: ExcludeReversedAuthorizations schema: type: boolean - description: >- ExcludeClearedAuthorizations defines whether to exclude cleared authorizations from account statement or not. in: query name: exclude_cleared_authorizations x-go-name: ExcludeClearedAuthorizations schema: type: boolean - description: >- ExcludePendingAuthorizations defines whether to exclude pending authorizations from account statement or not. in: query name: exclude_pending_authorizations x-go-name: ExcludePendingAuthorizations schema: type: boolean - description: >- ExcludeStatusAuthorizations defines whether to exclude status authorizations from account statement or not. in: query name: exclude_status_authorizations x-go-name: ExcludeStatusAuthorizations schema: type: boolean - description: >- ExcludePendingFees defines whether to exclude pending fees from account statement or not. in: query name: exclude_pending_fees x-go-name: ExcludePendingFees schema: type: boolean - description: >- ExcludeClearedFees defines whether to exclude cleared fees from account statement or not. in: query name: exclude_cleared_fees x-go-name: ExcludeClearedFees schema: type: boolean - description: >- ExcludeDeclinedFees defines whether to exclude declined fees from account statement or not. in: query name: exclude_declined_fees x-go-name: ExcludeDeclinedFees schema: type: boolean - description: >- ExcludeFXFees defines whether to exclude FX fees from account statement or not. in: query name: exclude_fx_fees x-go-name: ExcludeFXFees schema: type: boolean - description: MergeFees defines whether to merge fees per authorization or not. in: query name: merge_fees x-go-name: MergeFees schema: type: boolean - description: Search keyword in: query name: search_keyword x-go-name: SearchKeyword schema: type: string - description: Statuses **repeated** in: query name: statuses x-go-name: Statuses schema: type: string enum: - Completed - Pending - Canceled - description: Merchant category code **repeated** in: query name: merchant_category_codes x-go-name: MerchantCategoryCodes schema: type: string - description: Merchant category types **repeated** in: query name: merchant_category_types x-go-name: MerchantCategoryTypes schema: type: string enum: - Groceries - Shopping - Restaurants - Transport - Travel - Entertainment - Health - Services - Utilities - Cash - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: desc - description: Field to sort by in: query name: order_field x-go-name: OrderField schema: type: string enum: - date - type - group - merchant_name - transaction_amount - account_amount - response - status default: date - description: >- Field to filter account adjustments by type when **include_account_adjustments** is true in: query name: adjustment_type x-go-name: AdjustmentType schema: type: string enum: - Adjustment - Cashback - IncomingSEPAPayment - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetAccountStatementResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountStatementResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/statement-by-cursor: get: tags: - Account summary: Get account statement by cursor operationId: Account_getStatementByCursor security: - JWT: [] description: >- It can contain account authorizations, transactions and adjustments, and can filter declined, reversed or cleared authorizations out parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- Cursor is an object that stores the state of the last requested data in base64 format so that newer or older data can be requested. Received in response to "request by date" or "request by cursor" (used with the move_forward parameter in pairs) in: query name: cursor required: true x-go-name: Cursor schema: type: string - description: >- MoveForward is used as an auxiliary parameter to select newer or older data from the Cursor object. If the default value is "false", the query returns older data (used with cursor parameter in pair) in: query name: move_forward x-go-name: MoveForward schema: type: boolean default: false responses: '200': description: GetAccountStatementByCursorResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountStatementByCursorResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/statement-by-date: get: tags: - Account summary: Get account statement by date operationId: Account_getStatementByDate security: - JWT: [] description: >- It can contain account authorizations, transactions and adjustments, and can filter declined, reversed or cleared authorizations out parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- RecordsCount defines number of records of requested data set (used with from_date parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with records_count parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: from_date required: true x-go-name: FromDate schema: type: string format: date-time - description: >- IncludeAuthorizations defines whether to include authorizations to account statement or not. in: query name: include_authorizations x-go-name: IncludeAuthorizations schema: type: boolean - description: >- IncludeTransactions defines whether to include transactions to account statement or not. in: query name: include_transactions x-go-name: IncludeTransactions schema: type: boolean - description: >- IncludeAccountAdjustments defines whether to include account adjustments to account statement or not. in: query name: include_account_adjustments x-go-name: IncludeAccountAdjustments schema: type: boolean - description: >- IncludeFees defines whether to include fees to account statement or not. in: query name: include_fees x-go-name: IncludeFees schema: type: boolean - description: >- ExcludeDeclinedAuthorizations defines whether to exclude declined authorizations from account statement or not. in: query name: exclude_declined_authorizations x-go-name: ExcludeDeclinedAuthorizations schema: type: boolean - description: >- ExcludeReversedAuthorizations defines whether to exclude reversed authorizations and reversals from account statement or not. in: query name: exclude_reversed_authorizations x-go-name: ExcludeReversedAuthorizations schema: type: boolean - description: >- ExcludeClearedAuthorizations defines whether to exclude cleared authorizations from account statement or not. in: query name: exclude_cleared_authorizations x-go-name: ExcludeClearedAuthorizations schema: type: boolean - description: >- ExcludePendingAuthorizations defines whether to exclude pending authorizations from account statement or not. in: query name: exclude_pending_authorizations x-go-name: ExcludePendingAuthorizations schema: type: boolean - description: >- ExcludeStatusAuthorizations defines whether to exclude status authorizations from account statement or not. in: query name: exclude_status_authorizations x-go-name: ExcludeStatusAuthorizations schema: type: boolean - description: >- ExcludePendingFees defines whether to exclude pending fees from account statement or not. in: query name: exclude_pending_fees x-go-name: ExcludePendingFees schema: type: boolean - description: >- ExcludeClearedFees defines whether to exclude cleared fees from account statement or not. in: query name: exclude_cleared_fees x-go-name: ExcludeClearedFees schema: type: boolean - description: >- ExcludeDeclinedFees defines whether to exclude declined fees from account statement or not. in: query name: exclude_declined_fees x-go-name: ExcludeDeclinedFees schema: type: boolean - description: >- ExcludeFXFees defines whether to exclude FX fees from account statement or not. in: query name: exclude_fx_fees x-go-name: ExcludeFXFees schema: type: boolean - description: MergeFees defines whether to merge fees per authorization or not. in: query name: merge_fees x-go-name: MergeFees schema: type: boolean responses: '200': description: GetAccountStatementByDateResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountStatementByDateResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/top-up-details: put: tags: - Account summary: Update account top up details operationId: Account_updateTopUpDetails security: - JWT: [] description: >- Update account top up details as IBAN, Swift Code and Receiver Name, etc... parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccountTopUpDetailsRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateAccountTopUpDetailsRequest' required: true x-go-name: Request responses: '200': description: UpdateAccountTopUpDetailsResponse content: application/json: schema: $ref: '#/components/schemas/UpdateAccountTopUpDetailsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/accounts/{account_id}/transactions: get: tags: - Transactions summary: Get account transactions operationId: Transactions_getAccountTransactions security: - JWT: [] description: Get account transactions parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetAccountTransactionsResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountTransactionsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/authorizations/{authorization_id}: get: tags: - Authorizations summary: Get authorization operationId: Authorizations_getAuthorizationInfo security: - JWT: [] description: Get authorization information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Authorization ID in: path name: authorization_id required: true x-go-name: AuthorizationID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetAuthorizationResponse content: application/json: schema: $ref: '#/components/schemas/GetAuthorizationResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/authorizations/{authorization_id}/additional-info: get: tags: - Authorizations summary: Get authorization additional info operationId: Authorizations_getAdditionalInfo security: - JWT: [] description: Get authorization additional info parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Authorization ID in: path name: authorization_id required: true x-go-name: AuthorizationID schema: type: string format: uuid4 responses: '200': description: GetAuthorizationAdditionalInfoResponse content: application/json: schema: $ref: '#/components/schemas/GetAuthorizationAdditionalInfoResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/authorizations/{authorization_id}/fees: get: tags: - Fee summary: Get fees by authorization ID operationId: Fee_getFeesById security: - JWT: [] description: Get fees by authorization ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Authorization ID in: path name: authorization_id required: true x-go-name: AuthorizationID schema: type: string format: uuid4 - description: >- Fee types is a **repeated** query parameter to specify fee types to return. in: query name: fee_types x-go-name: FeeTypes schema: type: string - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: FeesByAuthorizationIDResponse content: application/json: schema: $ref: '#/components/schemas/FeesByAuthorizationIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/cards/block: patch: tags: - Card summary: Block cards batch operationId: Card_blockBatch security: - JWT: [] description: Block multiple cards at the same time parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/BlockCardsBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/BlockCardsBatchRequest' required: true x-go-name: Request responses: '200': description: BlockCardsBatchResponse content: application/json: schema: $ref: '#/components/schemas/BlockCardsBatchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/cards/close: patch: tags: - Card summary: Close cards batch operationId: Card_closeBatchCards security: - JWT: [] description: Close multiple cards at the same time parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CloseCardsBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/CloseCardsBatchRequest' required: true x-go-name: Request responses: '200': description: CloseCardsBatchResponse content: application/json: schema: $ref: '#/components/schemas/CloseCardsBatchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/cards/fees: patch: tags: - Card summary: Update card fees batch operationId: Card_updateFeesBatch security: - JWT: [] description: Update card fees batch parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardFeesBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardFeesBatchRequest' required: true x-go-name: Request responses: '200': description: UpdateCardFeesBatchResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardFeesBatchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/cards/replace: patch: tags: - Card summary: Replace cards batch operationId: Card_updateBatchFees security: - JWT: [] description: Replaces multiple cards using existing card data. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReplaceCardsBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/ReplaceCardsBatchRequest' required: true x-go-name: Request responses: '200': description: ReplaceCardsBatchResponse content: application/json: schema: $ref: '#/components/schemas/ReplaceCardsBatchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/cards/unblock: patch: tags: - Card summary: Unblock cards batch operationId: Card_unblockBatchCards security: - JWT: [] description: Unblock multiple cards at the same time parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UnblockCardsBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/UnblockCardsBatchRequest' required: true x-go-name: Request responses: '200': description: UnblockCardsBatchResponse content: application/json: schema: $ref: '#/components/schemas/UnblockCardsBatchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/persons/deactivate: patch: tags: - Person summary: Deactivate persons batch operationId: Person_batchDeactivate security: - JWT: [] description: Deactivate multiple persons at the same time parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeactivatePersonsBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/DeactivatePersonsBatchRequest' required: true x-go-name: Request responses: '200': description: DeactivatePersonsBatchResponse content: application/json: schema: $ref: '#/components/schemas/DeactivatePersonsBatchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/persons/{person_id}/additional-infos: post: tags: - Person summary: Create person additional info batch operationId: Person_createAdditionalInfoBatch security: - JWT: [] description: Create person additional info batch parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePersonAdditionalInfoBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreatePersonAdditionalInfoBatchRequest' required: true x-go-name: Request responses: '201': description: CreatePersonAdditionalInfoBatchResponse content: application/json: schema: $ref: '#/components/schemas/CreatePersonAdditionalInfoBatchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/batch/persons/{person_id}/additional-infos/delete: post: tags: - Person summary: Delete person additional info batch operationId: Person_deleteAdditionalInfoBatch security: - JWT: [] description: Delete person additional info batch parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/DeletePersonAdditionalInfoBatchRequest' multipart/form-data: schema: $ref: '#/components/schemas/DeletePersonAdditionalInfoBatchRequest' required: true x-go-name: Request responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/card-by-reference-number/{reference_number}: get: tags: - Card summary: Get card by reference number operationId: Card_getByReferenceNumber security: - JWT: [] description: Get card by reference number parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Reference number in: path name: reference_number required: true x-go-name: ReferenceNumber schema: type: string responses: '200': description: GetCardByReferenceNumberResponse content: application/json: schema: $ref: '#/components/schemas/GetCardByReferenceNumberResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards: get: tags: - Card summary: Search cards operationId: Card_search security: - JWT: [] description: Search cards. At least one search parameter is required parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Masked card number to search in: query name: masked_card_number x-go-name: MaskedCardNumber schema: type: string - description: Reference number to search in: query name: reference_number x-go-name: ReferenceNumber schema: type: string - description: External ID in: query name: external_id x-go-name: ExternalID schema: type: string - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- OrderField is **repeated** query parameter to specify cards order by. in: query name: order_field x-go-name: OrderField schema: type: string enum: - embossing_name - masked_card_number - status - type - personalization_product_code - expiry_date - updated_at - block_type default: embossing_name responses: '200': description: SearchCardsResponse content: application/json: schema: $ref: '#/components/schemas/SearchCardsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Card summary: Create card operationId: Card_registerNewCard security: - JWT: [] description: Create card parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- The flag specifies whether to send the event notification to a predefined client server. If set to true, minimal webhook parameters (URL, basic authentication credentials) must be configured in the Wallester system to successfully send the event. If set to false, no event notification will be sent even when event notifications are enabled by default. in: query name: send_notification x-go-name: SendNotification schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCardRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateCardRequest' required: true x-go-name: Request responses: '201': description: CreateCardResponse content: application/json: schema: $ref: '#/components/schemas/CreateCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards-by-external-id/{external_id}: get: tags: - Card summary: Get card by external ID operationId: Card_getByExternalId security: - JWT: [] description: Get card by external ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: External ID in: path name: external_id required: true x-go-name: ExternalID schema: type: string responses: '200': description: GetCardByExternalIDResponse content: application/json: schema: $ref: '#/components/schemas/GetCardByExternalIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards-by-last-digits/{last_four_digits}: get: tags: - Card summary: Get cards by last 4 digits operationId: Card_getByLastFourDigits security: - JWT: [] description: Get cards by last 4 digits parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Last 4 Digits in: path name: last_four_digits required: true x-go-name: LastFourDigits schema: type: string responses: '200': description: GetCardsByLastFourDigitsResponse content: application/json: schema: $ref: '#/components/schemas/GetCardsByLastFourDigitsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards-dispatch-methods: get: tags: - Card summary: Cards dispatch methods operationId: Card_getDispatchMethods security: - JWT: [] description: Cards dispatch methods parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Country code in ISO 3166-1 Alpha-3 code standard. in: query name: country_code required: true x-go-name: CountryCode schema: type: string enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT responses: '200': description: CardsDispatchMethodsResponse content: application/json: schema: $ref: '#/components/schemas/CardsDispatchMethodsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/fee-waivers: put: tags: - Fee summary: Update card fee waivers operationId: Fee_updateWaivers security: - JWT: [] description: Update card fee waivers parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardFeeWaiversRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardFeeWaiversRequest' required: true x-go-name: Request responses: '200': description: UpdateCardFeeWaiversResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardFeeWaiversResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}: get: tags: - Card summary: Get card operationId: Card_information security: - JWT: [] description: Get card information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetCardResponse content: application/json: schema: $ref: '#/components/schemas/GetCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/3d-secure: patch: tags: - Card summary: Update 3D secure settings operationId: Card_update3dSecureSettings security: - JWT: [] description: >- Update 3D secure settings. It is allowed to update either all or specific fields only (e.g. only mobile or password). Fields having empty values will not be updated. At least one of the fields: mobile, email, out_of_band_enabled:true is required. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/Update3DSecureSettingsRequest' multipart/form-data: schema: $ref: '#/components/schemas/Update3DSecureSettingsRequest' required: true x-go-name: Request responses: '200': description: Update3DSecureSettingsResponse content: application/json: schema: $ref: '#/components/schemas/Update3DSecureSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/3d-secure/enrol: patch: tags: - Card summary: Enrol card for 3D secure operationId: Card_enrol3dSecure security: - JWT: [] description: >- Enrol card for 3D secure. Must only be used with a specific provider that was agreed during Project Implementation. Contact your Implementation Manager if unsure whether it must be used or not. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: EnrolCardFor3DSecureResponse content: application/json: schema: $ref: '#/components/schemas/EnrolCardFor3DSecureResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/3d-secure/unenrol: patch: tags: - Card summary: Unenrol card from 3D secure operationId: Card_unenrol3dSecure security: - JWT: [] description: >- Unenrol card from 3D secure. Must only be used with a specific provider that was agreed during Project Implementation. Contact your Implementation Manager if unsure whether it must be used or not. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: UnenrolCardFrom3DSecureResponse content: application/json: schema: $ref: '#/components/schemas/UnenrolCardFrom3DSecureResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/3ds-password: put: tags: - Reminders summary: Remind 3DS password operationId: Reminders_send3dsPasswordBySms security: - JWT: [] description: >- Send card 3DS password directly to cardholder by SMS. Wallester configures SMS templates by multiple languages (please contact a Wallester representative if something needs to be adjusted with the templates). parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: CardholderReminderResponse content: application/json: schema: $ref: '#/components/schemas/CardholderReminderResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/activate: patch: tags: - Card summary: Activate card operationId: Card_activateCardById security: - JWT: [] description: >- Activate card. Card 3D Secure settings are required to activate card if product has 3D Secure enabled. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: ActivateCardResponse content: application/json: schema: $ref: '#/components/schemas/ActivateCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/activate-by-cvv: patch: tags: - Card summary: Activate card by CVV operationId: Card_activateByCvvPatch security: - JWT: [] description: >- Activate card by CVV. Card 3D Secure settings are required to activate card if product has 3D Secure enabled. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateCardByCVVRequest' multipart/form-data: schema: $ref: '#/components/schemas/ActivateCardByCVVRequest' required: true x-go-name: Request responses: '200': description: ActivateCardByCVVResponse content: application/json: schema: $ref: '#/components/schemas/ActivateCardByCVVResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/authorizations: get: tags: - Authorizations summary: Get card authorizations operationId: Authorizations_getCardBlockingAuthorizations security: - JWT: [] description: Get card blocking authorizations parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetCardAuthorizationsResponse content: application/json: schema: $ref: '#/components/schemas/GetCardAuthorizationsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/block: patch: tags: - Card summary: Block card operationId: Card_blockCard security: - JWT: [] description: Block card parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/BlockCardRequest' multipart/form-data: schema: $ref: '#/components/schemas/BlockCardRequest' required: true x-go-name: Request responses: '200': description: BlockCardResponse content: application/json: schema: $ref: '#/components/schemas/BlockCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/close: delete: tags: - Card summary: Close card operationId: Card_closeCard security: - JWT: [] description: Closes card with default reason ClosedByClient parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: CloseCardResponse content: application/json: schema: $ref: '#/components/schemas/CloseCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Card summary: Close card operationId: Card_closeCard security: - JWT: [] description: Close card parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CloseCardRequest' multipart/form-data: schema: $ref: '#/components/schemas/CloseCardRequest' required: true x-go-name: Request responses: '200': description: CloseCardResponse content: application/json: schema: $ref: '#/components/schemas/CloseCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/delivery-address: patch: tags: - Card summary: Update card delivery address operationId: Card_updateDeliveryAddress security: - JWT: [] description: >- Update card delivery address. It is allowed to update either all or specific fields only. Fields having empty values will not be updated. Card delivery address can be updated only if card status is Created and card has not been processed for personalization (processed_at = null). Phone is required if dispatch method is DPDExpress, DHLGlobalMail, DHLGlobalMailTracked or DHLExpress and phone was not initially set. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardDeliveryAddressRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardDeliveryAddressRequest' required: true x-go-name: Request responses: '200': description: UpdateCardDeliveryAddressResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardDeliveryAddressResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/download-statement: get: tags: - Card summary: Download card statement operationId: Card_downloadStatement security: - JWT: [] description: Download card statement parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: from_date required: true x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: to_date required: true x-go-name: ToDate schema: type: string format: date-time - description: >- If provided, the date in statement will be in this timezone. If not provided, the timezone will be taken from the user. All timezones could be received from the /v1/timezones endpoint. in: query name: timezone x-go-name: Timezone schema: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - Egypt - Eire - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - W-SU - description: Language code in: query name: language_code x-go-name: LanguageCode schema: type: string enum: - ENG - RUS - LAV - LIT - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: DownloadCardStatementResponse content: application/json: schema: $ref: '#/components/schemas/DownloadCardStatementResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/encrypted-3ds-password: post: tags: - Card summary: Get encrypted 3DS password by card ID operationId: Card_getEncrypted3dsPassword security: - JWT: [] description: >- Get encrypted 3DS password by card ID. 3DS password will be encrypted using [RSA public key](https://api-doc.wallester.com) from request. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/GetEncrypted3DSPasswordRequest' multipart/form-data: schema: $ref: '#/components/schemas/GetEncrypted3DSPasswordRequest' required: true x-go-name: Request responses: '200': description: GetEncrypted3DSPasswordResponse content: application/json: schema: $ref: '#/components/schemas/GetEncrypted3DSPasswordResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/encrypted-card-number: post: tags: - Card summary: Get card encrypted card number operationId: Card_getEncryptedCardNumber security: - JWT: [] description: >- Get card encrypted card number. Card number will be encrypted using [RSA public key](https://api-doc.wallester.com) in request. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/GetEncryptedCardNumberRequest' multipart/form-data: schema: $ref: '#/components/schemas/GetEncryptedCardNumberRequest' required: true x-go-name: Request responses: '200': description: GetEncryptedCardNumberResponse content: application/json: schema: $ref: '#/components/schemas/GetEncryptedCardNumberResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/encrypted-cvv2: post: tags: - Card summary: Get card encrypted CVV2 operationId: Card_getEncryptedCvv2 security: - JWT: [] description: >- Get card encrypted CVV2. CVV2 will be encrypted using [RSA public key](https://api-doc.wallester.com) in request. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/GetEncryptedCVV2Request' multipart/form-data: schema: $ref: '#/components/schemas/GetEncryptedCVV2Request' required: true x-go-name: Request responses: '200': description: GetEncryptedCVV2Response content: application/json: schema: $ref: '#/components/schemas/GetEncryptedCVV2Response' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/encrypted-pin: post: tags: - Card summary: Get card encrypted PIN operationId: Card_getEncryptedPin security: - JWT: [] description: >- Get card encrypted PIN. PIN will be encrypted using [RSA public key](https://api-doc.wallester.com) from request. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/GetEncryptedPINRequest' multipart/form-data: schema: $ref: '#/components/schemas/GetEncryptedPINRequest' required: true x-go-name: Request responses: '200': description: GetEncryptedPINResponse content: application/json: schema: $ref: '#/components/schemas/GetEncryptedPINResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/external-id: patch: tags: - Card summary: Update card external ID operationId: Card_updateExternalId security: - JWT: [] description: >- Update card external ID. It is allowed to send empty external ID to remove the external ID from the card. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardExternalIDRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardExternalIDRequest' required: true x-go-name: Request responses: '200': description: UpdateCardExternalIDResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardExternalIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/fee-waivers: get: tags: - Fee summary: Get card fee waivers operationId: Fee_getCardFeeWaivers security: - JWT: [] description: Get card fee waivers parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: GetCardFeeWaiversResponse content: application/json: schema: $ref: '#/components/schemas/GetCardFeeWaiversResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/fee-waivers/{fee_waiver_id}: delete: tags: - Fee summary: Delete card fee waiver operationId: Fee_deleteFeeWaiver security: - JWT: [] description: Delete card fee waiver parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Fee waiver ID in: path name: fee_waiver_id required: true x-go-name: FeeWaiverID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Fee summary: Get card fee waiver by ID operationId: Fee_getFeeWaiverById security: - JWT: [] description: Get card fee waiver by ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Fee waiver ID in: path name: fee_waiver_id required: true x-go-name: FeeWaiverID schema: type: string format: uuid4 responses: '200': description: GetCardFeeWaiverByIDResponse content: application/json: schema: $ref: '#/components/schemas/GetCardFeeWaiverByIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/fees: get: tags: - Card summary: Get card fees operationId: Card_getFees security: - JWT: [] description: Get card fees parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: GetCardFeesResponse content: application/json: schema: $ref: '#/components/schemas/GetCardFeesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Card summary: Update card fees operationId: Card_updateFees security: - JWT: [] description: Update card fees parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardFeesRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardFeesRequest' required: true x-go-name: Request responses: '200': description: UpdateCardFeesResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardFeesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/history: get: tags: - Card summary: Get card history operationId: Card_getHistory security: - JWT: [] description: Get card history parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time responses: '200': description: GetCardHistoryResponse content: application/json: schema: $ref: '#/components/schemas/GetCardHistoryResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/is-card-renewal-allowed: get: tags: - Card summary: Is card renewal allowed operationId: Card_checkRenewalStatus security: - JWT: [] description: Is card renewal allowed parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: IsCardRenewalAllowedResponse content: application/json: schema: $ref: '#/components/schemas/IsCardRenewalAllowedResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/limits: get: tags: - Card summary: Get card limits usage operationId: Card_getLimitsUsage security: - JWT: [] description: Get card limits usage parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetCardLimitsUsageResponse content: application/json: schema: $ref: '#/components/schemas/GetCardLimitsUsageResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Card summary: Update card limits operationId: Card_updateLimits security: - JWT: [] description: Update card limits parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardLimitsRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardLimitsRequest' required: true x-go-name: Request responses: '200': description: UpdateCardLimitsResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardLimitsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/link-to-account/{account_id}: patch: tags: - Card summary: Link card to account operationId: Card_linkToAccount security: - JWT: [] description: Link card to account parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Account ID in: path name: account_id required: true x-go-name: AccountID schema: type: string format: uuid4 responses: '200': description: LinkCardToAccountResponse content: application/json: schema: $ref: '#/components/schemas/LinkCardToAccountResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/merchant-rules: get: tags: - Card summary: Get card merchant rules operationId: Card_getMerchantRules security: - JWT: [] description: Get card merchant rules parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: Is whitelist card merchant rule in: query name: is_white_list x-go-name: IsWhiteList schema: type: boolean responses: '200': description: GetCardMerchantRulesResponse content: application/json: schema: $ref: '#/components/schemas/GetCardMerchantRulesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Card summary: Create card merchant rules operationId: Card_createMerchantRules security: - JWT: [] description: Create card merchant rules parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCardMerchantRulesRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateCardMerchantRulesRequest' required: true x-go-name: Request responses: '201': description: CreateCardMerchantRulesResponse content: application/json: schema: $ref: '#/components/schemas/CreateCardMerchantRulesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/merchant-rules/{merchant_rule_id}: delete: tags: - Card summary: Delete card merchant rule operationId: Card_deleteMerchantRule security: - JWT: [] description: Delete card merchant rule parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Card Merchant Rule ID in: path name: merchant_rule_id required: true x-go-name: CardMerchantRuleID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Card summary: Get card merchant rule by ID operationId: Card_getMerchantRuleById security: - JWT: [] description: Get card merchant rule by ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Card Merchant Rule ID in: path name: merchant_rule_id required: true x-go-name: CardMerchantRuleID schema: type: string format: uuid4 responses: '200': description: GetCardMerchantRuleByIDResponse content: application/json: schema: $ref: '#/components/schemas/GetCardMerchantRuleByIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/name: patch: tags: - Card summary: Update card name operationId: Card_updateNameOperation security: - JWT: [] description: >- Update card name. It is allowed to send empty name to remove the name from the card. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardNameRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardNameRequest' required: true x-go-name: Request responses: '200': description: UpdateCardNameResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardNameResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/pin: patch: tags: - Card summary: Change PIN code operationId: Card_changePin security: - JWT: [] description: >- Change PIN code. PIN code must be encrypted using public RSA key shared to you by Wallester. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCardPINRequest' multipart/form-data: schema: $ref: '#/components/schemas/ChangeCardPINRequest' required: true x-go-name: Request responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' put: tags: - Reminders summary: Remind PIN operationId: Reminders_sendPinBySms security: - JWT: [] description: >- Send card PIN directly to cardholder by SMS. Wallester configures SMS templates by multiple languages (please contact a Wallester representative if something needs to be adjusted with the templates). parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: CardholderReminderResponse content: application/json: schema: $ref: '#/components/schemas/CardholderReminderResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/push-provisioning/apple-pay: post: tags: - Token summary: Apple Pay push provisioning operationId: Token_pushProvisioningApplePay security: - JWT: [] description: Pushing card to wallet parameters: - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplePayPushProvisioningRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplePayPushProvisioningRequest' required: true x-go-name: Request responses: '200': description: ApplePayPushProvisioningResponse content: application/json: schema: $ref: '#/components/schemas/ApplePayPushProvisioningResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/push-provisioning/google-pay: post: tags: - Token summary: Google push provisioning operationId: Token_pushProvisioningGooglePay security: - JWT: [] description: Pushing card to wallet parameters: - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GooglePayPushProvisioningRequest' multipart/form-data: schema: $ref: '#/components/schemas/GooglePayPushProvisioningRequest' required: true x-go-name: Request responses: '200': description: GooglePayPushProvisioningResponse content: application/json: schema: $ref: '#/components/schemas/GooglePayPushProvisioningResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/renew-automatically: patch: tags: - Card summary: Update card renew automatically operationId: Card_renewAutomaticallyPatch security: - JWT: [] description: Update card renew automatically parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardRenewAutomaticallyRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardRenewAutomaticallyRequest' required: true x-go-name: Request responses: '200': description: UpdateCardRenewAutomaticallyResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardRenewAutomaticallyResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/replace: patch: tags: - Card summary: Replace card operationId: Card_updateCardData security: - JWT: [] description: |- Replaces card using existing card data. The card can be replaced regardless of its status. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: ReplaceCardResponse content: application/json: schema: $ref: '#/components/schemas/ReplaceCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/security: patch: tags: - Card summary: Update card security operationId: Card_updateSecurity security: - JWT: [] description: >- Update card security. It is allowed to update either all or specific fields only. Fields having empty values will not be updated. Card 3D Secure settings are required to enable internet purchases if product has 3D Secure enabled. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardSecurityRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardSecurityRequest' required: true x-go-name: Request responses: '200': description: UpdateCardSecurityResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardSecurityResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/statement: get: tags: - Card summary: Get card statement operationId: Card_getStatement security: - JWT: [] description: >- It can contain card authorizations, transactions and adjustments, and can filter declined, reversed or cleared authorizations out parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 - description: >- IncludeAuthorizations defines whether to include authorizations to account statement or not. in: query name: include_authorizations x-go-name: IncludeAuthorizations schema: type: boolean - description: >- IncludeTransactions defines whether to include transactions to account statement or not. in: query name: include_transactions x-go-name: IncludeTransactions schema: type: boolean - description: >- IncludeFees defines whether to include fees to account statement or not. in: query name: include_fees x-go-name: IncludeFees schema: type: boolean - description: >- ExcludeDeclinedAuthorizations defines whether to exclude declined authorizations from account statement or not. in: query name: exclude_declined_authorizations x-go-name: ExcludeDeclinedAuthorizations schema: type: boolean - description: >- ExcludeReversedAuthorizations defines whether to exclude reversed authorizations and reversals from account statement or not. in: query name: exclude_reversed_authorizations x-go-name: ExcludeReversedAuthorizations schema: type: boolean - description: >- ExcludeClearedAuthorizations defines whether to exclude cleared authorizations from account statement or not. in: query name: exclude_cleared_authorizations x-go-name: ExcludeClearedAuthorizations schema: type: boolean - description: >- ExcludePendingAuthorizations defines whether to exclude pending authorizations from account statement or not. in: query name: exclude_pending_authorizations x-go-name: ExcludePendingAuthorizations schema: type: boolean - description: >- ExcludeStatusAuthorizations defines whether to exclude status authorizations from account statement or not. in: query name: exclude_status_authorizations x-go-name: ExcludeStatusAuthorizations schema: type: boolean - description: >- ExcludePendingFees defines whether to exclude pending fees from account statement or not. in: query name: exclude_pending_fees x-go-name: ExcludePendingFees schema: type: boolean - description: >- ExcludeClearedFees defines whether to exclude cleared fees from account statement or not. in: query name: exclude_cleared_fees x-go-name: ExcludeClearedFees schema: type: boolean - description: >- ExcludeDeclinedFees defines whether to exclude declined fees from account statement or not. in: query name: exclude_declined_fees x-go-name: ExcludeDeclinedFees schema: type: boolean - description: MergeFees defines whether to merge fees per authorization or not. in: query name: merge_fees x-go-name: MergeFees schema: type: boolean - description: Search keyword in: query name: search_keyword x-go-name: SearchKeyword schema: type: string responses: '200': description: GetCardStatementResponse content: application/json: schema: $ref: '#/components/schemas/GetCardStatementResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/sync-tokens: post: tags: - Token summary: Sync tokens operationId: Token_syncAndUpdate security: - JWT: [] description: >- Synchronizes and updates tokens internally with the latest information received from Visa parameters: - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/tokens: get: tags: - Token summary: Get tokens by card ID operationId: Token_getByCardId security: - JWT: [] description: Get tokens by card ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- Field to sort by: id, reference_id, card_id, card_metadata_profile_id, requestor_id, pan_reference_id, type, status, expiration or created_at in: query name: order_field x-go-name: OrderField schema: type: string default: created_at - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: TokensByCardIDResponse content: application/json: schema: $ref: '#/components/schemas/TokensByCardIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/transactions: get: tags: - Transactions summary: Get card transactions operationId: Transactions_getCardTransactions security: - JWT: [] description: Get card transactions parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetCardTransactionsResponse content: application/json: schema: $ref: '#/components/schemas/GetCardTransactionsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/unblock: patch: tags: - Card summary: Unblock card operationId: Card_unblockCard security: - JWT: [] description: Unblock card parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 responses: '200': description: UnblockCardResponse content: application/json: schema: $ref: '#/components/schemas/UnblockCardResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/cards/{card_id}/users: delete: tags: - Card summary: Delete card users operationId: Card_deleteUsers security: - JWT: [] description: Delete card users parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: User IDs in: query name: user_ids required: true x-go-name: UserID style: form explode: false schema: type: array items: format: uuid4 type: string responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Card summary: Get card users operationId: Card_getUsers security: - JWT: [] description: Get card users parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: 'Field to sort by: first_name, last_name, mobile, email' in: query name: order_field x-go-name: OrderField schema: type: string default: mobile - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetCardUsersResponse content: application/json: schema: $ref: '#/components/schemas/GetCardUsersResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Card summary: Create card user operationId: Card_createUser security: - JWT: [] description: Create card user parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCardUserRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateCardUserRequest' required: true x-go-name: Request responses: '201': description: CreateCardUserResponse content: application/json: schema: $ref: '#/components/schemas/CreateCardUserResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies: get: tags: - Company summary: Search companies operationId: Company_search security: - JWT: [] description: >- Search companies. If no search parameters are provided, then returns only active companies. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Name in: query name: name x-go-name: Name schema: type: string - description: Registration number in: query name: registration_number required: true x-go-name: RegistrationNumber schema: type: string - description: Person phone or mobile to search in: query name: mobile x-go-name: Mobile schema: type: string - description: Person email to search in: query name: email x-go-name: Email schema: type: string - description: >- Statuses is **repeated** query parameter to specify company statuses to return. in: query name: statuses x-go-name: Statuses schema: type: string enum: - Active - Deactivated - Frozen - description: >- RiskProfiles is **repeated** query parameter to specify company risk profiles to return. in: query name: risk_profiles x-go-name: RiskProfiles schema: type: string enum: - Low - Medium - High - Pending - Prohibited - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- Field to sort by **repeated** (format or . (asc by default)) in: query name: order_field x-go-name: OrderFieldName schema: type: string enum: - name - registration_number - mobile - email - status - risk_profile - description: 'Direction to sort by: asc or desc (DEPRECATED)' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc responses: '200': description: SearchCompaniesResponse content: application/json: schema: $ref: '#/components/schemas/SearchCompaniesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Company summary: Create company operationId: Company_createNewCompany security: - JWT: [] description: Creates company parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCompanySwaggerModel' multipart/form-data: schema: $ref: '#/components/schemas/CreateCompanySwaggerModel' required: true x-go-name: Request responses: '201': description: CreateCompanyResponse content: application/json: schema: $ref: '#/components/schemas/CreateCompanyResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}: delete: tags: - Company summary: Deactivate company operationId: Company_deactivateCompany security: - JWT: [] description: >- Deactivates company, it is not possible to close company with active accounts linked to it. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 responses: '200': description: DeactivateCompanyResponse content: application/json: schema: $ref: '#/components/schemas/DeactivateCompanyResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Company summary: Get company operationId: Company_getInformation security: - JWT: [] description: Get company information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 responses: '200': description: GetCompanyResponse content: application/json: schema: $ref: '#/components/schemas/GetCompanyResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Company summary: Update company operationId: Company_updateDetails security: - JWT: [] description: Update company parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCompanySwaggerModel' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCompanySwaggerModel' required: true x-go-name: Request responses: '200': description: UpdateCompanyResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCompanyResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/3ds-settings: delete: tags: - Company summary: Delete company 3DS settings operationId: Company_delete3dsSettings description: Delete company 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Company summary: Get company 3DS settings operationId: Company_get3dsSettings description: Get company 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 responses: '200': description: Company3DSSettingsResponse content: application/json: schema: $ref: '#/components/schemas/Company3DSSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Company summary: Update company 3DS settings operationId: Company_update3dsSettings description: Update company 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: $ref: '#/components/requestBodies/UpdateCardholder3DSSettingsRequest' responses: '200': description: Company3DSSettingsResponse content: application/json: schema: $ref: '#/components/schemas/Company3DSSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Company summary: Create company 3DS settings operationId: Company_create3dsSettings description: Create company 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: $ref: '#/components/requestBodies/CreateCardholder3DSSettingsRequest' responses: '201': description: Company3DSSettingsResponse content: application/json: schema: $ref: '#/components/schemas/Company3DSSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/accounts: get: tags: - Company summary: Get company accounts operationId: Company_getAccounts security: - JWT: [] description: Get company accounts parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: Return only active accounts in: query name: is_active x-go-name: IsActive schema: type: boolean - description: >- AccountStatuses is **repeated** query parameter to specify account statuses to return. in: query name: account_statuses x-go-name: AccountStatuses schema: type: string enum: - Active - Closing - Closed - Blocked - description: >- Is a **repeated** query parameter to sort accounts to return. Sorting could be done by direct and backward order (asc or desc). Default order direct "asc". Format: or . (order_field=status&order_field=created_at.desc). in: query name: order_field x-go-name: OrderFieldName schema: type: string enum: - created_at - updated_at - balance - blocked_amount - available_amount - name - status - is_main - description: Excluding or only showing null balance in: query name: balance_is_zero x-go-name: Value schema: type: boolean - description: Excluding or only showing null available amount in: query name: available_amount_is_zero x-go-name: Value schema: type: boolean - description: Excluding or only showing null blocked amount in: query name: blocked_amount_is_zero x-go-name: Value schema: type: boolean - description: AccountName is a query parameter to specify account name to return. in: query name: account_name x-go-name: AccountName schema: type: string maximum: 100 - description: Account viban in: query name: viban x-go-name: Viban schema: type: string responses: '200': description: GetCompanyAccountsResponse content: application/json: schema: $ref: '#/components/schemas/GetCompanyAccountsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/cards: get: tags: - Company summary: Get company cards operationId: Company_getCards security: - JWT: [] description: Returns all cards linked to the company parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- CardStatuses is **repeated** query parameter to specify card statuses to return. in: query name: card_statuses x-go-name: CardStatuses schema: type: string enum: - Created - Ordered - Personalized - Dispatched - Active - Blocked - Closing - Closed - Expired - AwaitingRenewal - description: >- CardTypes is **repeated** query parameter to specify card types to return. in: query name: card_types x-go-name: CardTypes schema: type: string enum: - Virtual - ChipAndPin - ChipAndPinAnonymous - description: |- FromExpiryDate defines a beginning expiry date of card. Time must be in 2006-01-02T15:04:05Z format in: query name: from_expiry_date x-go-name: FromExpiryDate schema: type: string format: date-time - description: |- ToExpiryDate defines an end expiry date of card. Time must be in 2006-01-02T15:04:05Z format in: query name: to_expiry_date x-go-name: ToExpiryDate schema: type: string format: date-time - description: Card name in: query name: name x-go-name: Name schema: type: string maxLength: 100 - description: Masked card number to search in: query name: masked_card_number x-go-name: MaskedCardNumber schema: type: string - description: >- Field to sort by **repeated** (format or . (asc by default)) Status field order is: "Active", "Ordered", "Blocked", "Frozen", "Expired", "Closed". in: query name: order_field x-go-name: OrderFieldName schema: type: string enum: - name - masked_card_number - expiry_date - type - status - description: 'Direction to sort by: asc or desc (DEPRECATED)' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc responses: '200': description: GetCompanyCardsResponse content: application/json: schema: $ref: '#/components/schemas/GetCompanyCardsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/corporate-documents: post: tags: - Company summary: Add company corporate documents operationId: Company_addCorporateDocuments security: - JWT: [] description: Add company corporate documents parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/CompanyAddCorporateDocumentsRequest' required: true responses: '201': description: AddCompanyCorporateDocumentResponse content: application/json: schema: $ref: '#/components/schemas/AddCompanyCorporateDocumentResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/fcm-tokens: post: tags: - Company summary: Register FCM Token operationId: Company_registerFcmToken security: - JWT: [] description: >- Registers FCM token received from Firebase to be able to send push notifications to device for companies parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterCompanyFCMTokenRequest' multipart/form-data: schema: $ref: '#/components/schemas/RegisterCompanyFCMTokenRequest' required: true x-go-name: Request responses: '201': description: RegisterCompanyFCMTokenResponse content: application/json: schema: $ref: '#/components/schemas/RegisterCompanyFCMTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/fcm-tokens-by-device-id/{device_id}: delete: tags: - Company summary: Delete FCM Token operationId: Company_deleteFcmToken security: - JWT: [] description: Delete FCM Token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Device ID in: path name: device_id required: true x-go-name: DeviceID schema: type: string responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Company summary: Get FCM Token operationId: Company_getFcmTokenByDeviceId security: - JWT: [] description: Get FCM Token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Device ID in: path name: device_id required: true x-go-name: DeviceID schema: type: string responses: '200': description: GetCompanyFCMTokenResponse content: application/json: schema: $ref: '#/components/schemas/GetCompanyFCMTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/fcm-tokens-by-device-id/{device_id}/push-notifications-enabled: patch: tags: - Company summary: Update push notifications enabled for device operationId: Company_updatePushNotificationsEnabledForDevice security: - JWT: [] description: Turn off or on push notifications for device parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Device ID in: path name: device_id required: true x-go-name: DeviceID schema: type: string requestBody: $ref: >- #/components/requestBodies/UpdateCompanyPushNotificationsEnabledRequest responses: '200': description: UpdateCompanyFCMTokenPushNotificationsEnabledResponse content: application/json: schema: $ref: >- #/components/schemas/UpdateCompanyFCMTokenPushNotificationsEnabledResponse '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/history: get: tags: - Company summary: Get company history operationId: Company_getHistory security: - JWT: [] description: Returns company's history of changes parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time responses: '200': description: GetCompanyHistoryResponse content: application/json: schema: $ref: '#/components/schemas/GetCompanyHistoryResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/limits: patch: tags: - Company summary: Update company limits operationId: Company_updateLimits security: - JWT: [] description: Update company limits parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: $ref: '#/components/requestBodies/UpdateAccountLimitsRequest' responses: '200': description: UpdateCompanyLimitsResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCompanyLimitsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/push-notifications-enabled: patch: tags: - Company summary: Update push notifications enabled for company operationId: Company_updatePushNotificationsEnabled security: - JWT: [] description: Turn off or on push notifications for company parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: $ref: >- #/components/requestBodies/UpdateCompanyPushNotificationsEnabledRequest responses: '200': description: UpdateCompanyPushNotificationsEnabledResponse content: application/json: schema: $ref: >- #/components/schemas/UpdateCompanyPushNotificationsEnabledResponse '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/representatives: get: tags: - Company summary: Get company representatives operationId: Company_getRepresentatives security: - JWT: [] description: Returns all representatives linked to the company parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetRepresentativesResponse content: application/json: schema: $ref: '#/components/schemas/GetRepresentativesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Company summary: Add company representatives operationId: Company_addRepresentatives security: - JWT: [] description: Adds company representatives parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRepresentativesSwaggerRequest' multipart/form-data: schema: $ref: '#/components/schemas/AddRepresentativesSwaggerRequest' required: true x-go-name: Request responses: '201': description: AddRepresentativesResponse content: application/json: schema: $ref: '#/components/schemas/AddRepresentativesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/representatives/{representative_id}: delete: tags: - Company summary: Remove company representative operationId: Company_removeRepresentative security: - JWT: [] description: >- Removes company representative, cannot remove last representative because 1 representative is always required. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Representative ID in: path name: representative_id required: true x-go-name: RepresentativeID schema: type: string format: uuid4 responses: '200': description: RemoveRepresentativeResponse content: application/json: schema: $ref: '#/components/schemas/RemoveRepresentativeResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Company summary: Get company representative operationId: Company_getRepresentativeInfo security: - JWT: [] description: Get company representative information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Representative ID in: path name: representative_id required: true x-go-name: RepresentativeID schema: type: string format: uuid4 responses: '200': description: GetRepresentativeResponse content: application/json: schema: $ref: '#/components/schemas/GetRepresentativeResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Company summary: Update company representative operationId: Company_updateRepresentative security: - JWT: [] description: Update company representative parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Representative ID in: path name: representative_id required: true x-go-name: RepresentativeID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRepresentativeRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateRepresentativeRequest' required: true x-go-name: Request responses: '200': description: UpdateRepresentativeResponse content: application/json: schema: $ref: '#/components/schemas/UpdateRepresentativeResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/representatives/{representative_id}/history: get: tags: - Company summary: Get representative history operationId: Company_getRepresentativeHistory security: - JWT: [] description: Returns representative's history of changes parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Representative ID in: path name: representative_id required: true x-go-name: RepresentativeID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (can be used with records_count parameter in pair) in: query name: from_record x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (can be used with from_record parameter in pair) in: query name: records_count x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time responses: '200': description: GetRepresentativeHistoryResponse content: application/json: schema: $ref: '#/components/schemas/GetRepresentativeHistoryResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/representatives/{representative_id}/verification-link: put: tags: - Company summary: Send representative verification link operationId: Company_sendVerificationLink description: Send representative verification link parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: Representative ID in: path name: representative_id required: true x-go-name: RepresentativeID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/submit-agreement: post: tags: - Company summary: Submit company agreement operationId: Company_submitAgreement security: - JWT: [] description: Submit company agreement parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitCompanyAgreementRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubmitCompanyAgreementRequest' required: true x-go-name: Request responses: '201': description: SubmitCompanyAgreementResponse content: application/json: schema: $ref: '#/components/schemas/SubmitCompanyAgreementResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/companies/{company_id}/users: delete: tags: - Company summary: Delete company users operationId: Company_deleteUsers security: - JWT: [] description: Delete company users parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: User IDs in: query name: user_ids required: true x-go-name: UserID style: form explode: false schema: type: array items: format: uuid4 type: string responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Company summary: Get company users operationId: Company_getUsers security: - JWT: [] description: Get company users parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 - description: 'Field to sort by: first_name, last_name, mobile, email' in: query name: order_field x-go-name: OrderField schema: type: string default: first_name - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetCompanyUsersResponse content: application/json: schema: $ref: '#/components/schemas/GetCompanyUsersResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Company summary: Create company user operationId: Company_createUser security: - JWT: [] description: Create company user parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Company ID in: path name: company_id required: true x-go-name: CompanyID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCompanyUserRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateCompanyUserRequest' required: true x-go-name: Request responses: '201': description: CreateCompanyUserResponse content: application/json: schema: $ref: '#/components/schemas/CreateCompanyUserResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/expiring-cards: get: tags: - Card summary: Get expiring cards operationId: Card_getExpiringCards security: - JWT: [] description: Get expiring cards parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: 'Field to sort by: masked_card_number, expiry_date' in: query name: order_field x-go-name: OrderField schema: type: string default: masked_card_number - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetExpiringCardsResponse content: application/json: schema: $ref: '#/components/schemas/GetExpiringCardsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/extract-files: get: tags: - Extract-Files summary: Get directories list operationId: ExtractFiles_listDirectories security: - JWT: [] description: Get extract files directories list responses: '200': description: ExtractFilesDirectoriesResponse content: application/json: schema: $ref: '#/components/schemas/ExtractFilesDirectoriesResponse' /v1/extract-files/{directory_name}: get: tags: - Extract-Files summary: Get directory files list operationId: ExtractFiles_getFilesList security: - JWT: [] description: Get extract files directory files list parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Directory name in: path name: directory_name required: true x-go-name: DirectoryName schema: type: string responses: '200': description: ExtractFilesListResponse content: application/json: schema: $ref: '#/components/schemas/ExtractFilesListResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/extract-files/{directory_name}/{file_name}: get: tags: - Extract-Files summary: Download file operationId: ExtractFiles_downloadFile security: - JWT: [] description: Download extract file parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Directory name in: path name: directory_name required: true x-go-name: DirectoryName schema: type: string - description: File name in: path name: file_name required: true x-go-name: FileName schema: type: string responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/fees/{fee_id}: get: tags: - Fee summary: Get fee operationId: Fee_getFeeInformation security: - JWT: [] description: Get fee information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Fee ID in: path name: fee_id required: true x-go-name: FeeID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetFeeResponse content: application/json: schema: $ref: '#/components/schemas/GetFeeResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/fraud-cases: get: tags: - Fraud-Case summary: Get fraud cases operationId: FraudCase_listCases security: - JWT: [] description: Get fraud cases parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- Field to sort by **repeated** (format or . (asc by default)) in: query name: order_field x-go-name: OrderFieldName schema: type: string enum: - case_id - card_owner_name - card_id - authorization_date - merchant_name - risk_score - risk_zone - risk_status - case_status - assigned_to_name - description: >- CaseStatuses is **repeated** query parameter to specify case statuses to return. in: query name: case_statuses x-go-name: CaseStatuses schema: type: string enum: - Pending - Positive - Negative - Escalation - NotClassified - description: >- RiskStatuses is **repeated** query parameter to specify risk statuses to return. in: query name: risk_statuses x-go-name: RiskStatuses schema: type: string enum: - Unknown - Approved - Declined - Suspicious - FreezeCard - description: >- RiskZones is **repeated** query parameter to specify risk zones to return. in: query name: risk_zones x-go-name: RiskZones schema: type: string enum: - Low - Medium - High - description: FromRiskScore defines a beginning risk score number of fraud case in: query name: from_risk_score x-go-name: FromRiskScore schema: type: integer format: int64 minimum: 0 maximum: 100 - description: ToRiskScore defines an end risk score number of fraud case in: query name: to_risk_score x-go-name: ToRiskScore schema: type: integer format: int64 minimum: 0 maximum: 100 - description: Card owner IDs in: query name: card_owner_ids x-go-name: CardOwnerIDs style: form explode: false schema: type: array items: format: uuid4 type: string - description: Merchant country code in: query name: merchant_country_code x-go-name: MerchantCountryCode schema: type: string enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT - description: Card owner country code in: query name: card_owner_country_code x-go-name: CardOwnerCountryCode schema: type: string enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT - description: Assigned to name parameter in: query name: assigned_to_name x-go-name: AssignedToName schema: type: string - description: Scoring fields, repeated parameter in: query name: scoring x-go-name: ScoringFields style: form explode: false schema: type: array items: enum: - account_velocity_amounts - account_velocity_counts - avg_month_amount - black_list - country_change_within_24h - diff_currencies - high_cash_volume - high_number_of_declines - high_risk_country - high_risk_country_decline_all - high_risk_country_decline_atm - high_risk_country_mark_suspicious - high_risk_mcc_purchase - invalid_pin - large_amount - last_month_declines - last_month_high_risk_country - last_month_refund - magnetic_stripe - magnetic_stripe_and_card_data_entered_manually - magnetic_stripe_on_chip_capable_terminal - non_neighboring_country - not_enough_funds - reversal_refund - same_merchant_1_minutes - same_merchant_24h - sequence_declines - transaction_frequency - within_1_minute - within_1_minute_transactions_count - wrong_cvv type: string - description: Minimum scoring parameter in: query name: minimum_scoring x-go-name: MinimumScoring schema: type: integer format: int32 responses: '200': description: GetFraudCasesResponse content: application/json: schema: $ref: '#/components/schemas/GetFraudCasesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/fraud-cases/card-owners: get: tags: - Fraud-Case summary: Get fraud cases card owners operationId: FraudCase_getCardOwners security: - JWT: [] description: Get fraud cases card owners parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- CardOwnerName defines company name or person first name and last name in: query name: card_owner_name x-go-name: CardOwnerName schema: type: string maximum: 201 - description: FromCasesCount defines a beginning cases count number in: query name: from_cases_count x-go-name: FromCasesCount schema: type: integer format: int64 minimum: 1 - description: ToCasesCount defines an end cases count number in: query name: to_cases_count x-go-name: ToCasesCount schema: type: integer format: int64 minimum: 1 responses: '200': description: GetFraudCasesCardOwnersResponse content: application/json: schema: $ref: '#/components/schemas/GetFraudCasesCardOwnersResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/fraud-cases/{fraud_case_id}: get: tags: - Fraud-Case summary: Get fraud case operationId: FraudCase_getCase security: - JWT: [] description: Get fraud case parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Fraud case ID in: path name: fraud_case_id required: true x-go-name: FraudCaseID schema: type: string format: uuid4 responses: '200': description: GetFraudCaseResponse content: application/json: schema: $ref: '#/components/schemas/GetFraudCaseResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' put: tags: - Fraud-Case summary: Update fraud case operationId: FraudCase_updateCase security: - JWT: [] description: Update fraud case parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Fraud case ID in: path name: fraud_case_id required: true x-go-name: FraudCaseID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFraudCaseRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateFraudCaseRequest' required: true x-go-name: Request responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/fraud-cases/{fraud_case_id}/history: get: tags: - Fraud-Case summary: Get fraud case history operationId: FraudCase_getHistory security: - JWT: [] description: Get fraud case history parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Fraud case ID in: path name: fraud_case_id required: true x-go-name: FraudCaseID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time - description: >- Field to sort by **repeated** (format or . (asc by default)) in: query name: order_field x-go-name: OrderFieldName schema: type: string enum: - created_at - created_by - old_case_status - new_case_status - description responses: '200': description: GetFraudCaseHistoryResponse content: application/json: schema: $ref: '#/components/schemas/GetFraudCaseHistoryResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/kyc-checks: get: tags: - KYC-Check summary: Get KYC checks operationId: KycCheck_getAll security: - JWT: [] description: Get KYC checks parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- Is a **repeated** query parameter to sort kyc checks to return. Sorting could be done by direct and backward order (asc or desc). Default order direct "asc". Format: or . (order_field=status&order_field=created_at.desc). in: query name: order_field x-go-name: OrderField schema: type: string enum: - created_at - status default: created_at - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: Person ID in: query name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetKYCChecksResponse content: application/json: schema: $ref: '#/components/schemas/GetKYCChecksResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - KYC-Check summary: Create KYC check operationId: KycCheck_createNew security: - JWT: [] description: Creates KYC check parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKYCCheckRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateKYCCheckRequest' required: true x-go-name: Request responses: '201': description: CreateKYCCheckResponse content: application/json: schema: $ref: '#/components/schemas/CreateKYCCheckResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/kyc-checks/{kyc_check_id}: delete: tags: - KYC-Check summary: Delete KYC check operationId: KycCheck_deleteCheck security: - JWT: [] description: Delete KYC check parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: KYC Check ID in: path name: kyc_check_id required: true x-go-name: KYCCheckID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - KYC-Check summary: Get KYC check operationId: KycCheck_getDetails security: - JWT: [] description: Get KYC check details parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: KYC Check ID in: path name: kyc_check_id required: true x-go-name: KYCCheckID schema: type: string format: uuid4 responses: '200': description: GetKYCCheckResponse content: application/json: schema: $ref: '#/components/schemas/GetKYCCheckResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/kyc-checks/{kyc_check_id}/initiate: post: tags: - KYC-Check summary: Initiate KYC check operationId: KycCheck_initiateProcess security: - JWT: [] description: Initiate KYC check parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: KYC Check ID in: path name: kyc_check_id required: true x-go-name: KYCCheckID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/kyc-documents: post: tags: - KYC-Document summary: Upload KYC documents operationId: KycDocument_uploadDocument description: Upload KYC documents parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/KycDocumentUploadDocumentRequest' required: true responses: '201': description: UploadKYCDocumentResponse content: application/json: schema: $ref: '#/components/schemas/UploadKYCDocumentResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/kyc-documents/{kyc_document_id}: get: tags: - KYC-Document summary: Get KYC documents details operationId: KycDocument_getDetails security: - JWT: [] description: Get KYC documents details parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: KYC Document ID in: path name: kyc_document_id required: true x-go-name: KYCDocumentID schema: type: string format: uuid4 responses: '200': description: GetKYCDocumentDetailsResponse content: application/json: schema: $ref: '#/components/schemas/GetKYCDocumentDetailsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/payment-documents: post: tags: - Payment-Document summary: Add payment documents operationId: PaymentDocument_addDocuments security: - JWT: [] description: Add payment documents parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PaymentDocumentAddDocumentsRequest' required: true responses: '201': description: AddPaymentDocumentsResponse content: application/json: schema: $ref: '#/components/schemas/AddPaymentDocumentsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/payment-documents/download: get: tags: - Payment-Document summary: Download payment documents operationId: PaymentDocument_downloadFiles security: - JWT: [] description: >- Download payment documents, if there's only 1 file it will be returned unzipped, otherwise files will be zipped in one archive parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Payment ID in: query name: payment_id required: true x-go-name: PaymentID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetPaymentDocumentThumbnailsResponse content: application/json: schema: $ref: '#/components/schemas/GetPaymentDocumentThumbnailsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/payment-documents/thumbnails: get: tags: - Payment-Document summary: Get payment documents thumbnail operationId: PaymentDocument_getThumbnail security: - JWT: [] description: Get payment documents thumbnail parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Payment ID in: query name: payment_id required: true x-go-name: PaymentID schema: type: string format: uuid4 - description: Payment type in: query name: payment_type required: true x-go-name: PaymentType schema: type: string enum: - transaction - authorization - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetPaymentDocumentThumbnailsResponse content: application/json: schema: $ref: '#/components/schemas/GetPaymentDocumentThumbnailsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/payment-documents/{payment_document_id}: delete: tags: - Payment-Document summary: Delete payment document operationId: PaymentDocument_deleteDocument security: - JWT: [] description: Delete payment document parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: PaymentDocument ID in: path name: payment_document_id required: true x-go-name: PaymentDocumentID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Payment-Document summary: Get payment document operationId: PaymentDocument_getDocument security: - JWT: [] description: Get payment document parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: PaymentDocument ID in: path name: payment_document_id required: true x-go-name: PaymentDocumentID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetPaymentDocumentResponse content: application/json: schema: $ref: '#/components/schemas/GetPaymentDocumentResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/payments/authorizations: get: tags: - Authorizations summary: Get product authorizations operationId: Authorizations_getProductAuthorizations security: - JWT: [] description: Get product authorizations parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- OrderField is **repeated** query parameter to specify authorization payments order by. in: query name: order_field x-go-name: OrderField schema: type: string enum: - id - card_id - merchant_name - merchant_category_code - merchant_city - merchant_country_code - response_code - transaction_amount - transaction_currency_code - account_amount - account_currency_code - created_at default: created_at - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (can be used in pair with to_date parameter). Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (can be used with from_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time responses: '200': description: GetAuthorizationsByProductIDResponse content: application/json: schema: $ref: '#/components/schemas/GetAuthorizationsByProductIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/payments/transactions: get: tags: - Transactions summary: Get product transactions operationId: Transactions_getProductTransactions security: - JWT: [] description: Get product transactions parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- OrderField is **repeated** query parameter to specify transaction payments order by. in: query name: order_field x-go-name: OrderField schema: type: string enum: - id - card_id - merchant_name - merchant_category_code - merchant_city - merchant_country_code - ' transaction_amount' - transaction_currency_code - account_amount - account_currency_code - created_at default: created_at - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: 'Field to get records by date: created_at, processed_at' in: query name: date_field x-go-name: DateField schema: type: string default: created_at - description: >- FromDate defines a beginning date of requested data set (can be used in pair with to_date parameter). Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (can be used with from_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time responses: '200': description: GetTransactionsByProductIDResponse content: application/json: schema: $ref: '#/components/schemas/GetTransactionsByProductIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/pending-orders: get: tags: - Card summary: Get pending orders operationId: Card_listPendingOrders security: - JWT: [] description: Get pending orders parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: 'Field to sort by: masked_card_number, created_at, status' in: query name: order_field x-go-name: OrderField schema: type: string default: created_at - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetPendingOrdersResponse content: application/json: schema: $ref: '#/components/schemas/GetPendingOrdersResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons: get: tags: - Person summary: Search persons operationId: Person_search security: - JWT: [] description: >- Search persons. If no search parameters are provided, then returns only active persons. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person first name to search in: query name: first_name x-go-name: FirstName schema: type: string - description: Person last name to search in: query name: last_name x-go-name: LastName schema: type: string - description: Person personal number to search in: query name: personal_number x-go-name: PersonalNumber schema: type: string - description: Person phone or mobile to search in: query name: mobile x-go-name: Mobile schema: type: string - description: Person email to search in: query name: email x-go-name: Email schema: type: string - description: External ID in: query name: external_id x-go-name: ExternalID schema: type: string - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- Field to sort by: first_name, last_name, personal_number, mobile, email, status, residence_country_code, updated_at in: query name: order_field x-go-name: OrderField schema: type: string default: first_name - description: Return only active persons in: query name: is_active x-go-name: IsActive schema: type: boolean default: false - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc responses: '200': description: SearchPersonsResponse content: application/json: schema: $ref: '#/components/schemas/SearchPersonsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Person summary: Create person operationId: Person_createNew security: - JWT: [] description: Create person parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePersonRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreatePersonRequest' required: true x-go-name: Request responses: '201': description: CreatePersonResponse content: application/json: schema: $ref: '#/components/schemas/CreatePersonResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons-by-external-id/{external_id}: get: tags: - Person summary: Get person by external ID operationId: Person_getByExternalId security: - JWT: [] description: Get person by externalID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: External ID in: path name: external_id required: true x-go-name: ExternalID schema: type: string responses: '200': description: GetPersonByExternalIDResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonByExternalIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}: delete: tags: - Person summary: Deactivate person operationId: Person_deactivate security: - JWT: [] description: Deactivate person parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: DeactivatePersonResponse content: application/json: schema: $ref: '#/components/schemas/DeactivatePersonResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Person summary: Get person operationId: Person_getInformation security: - JWT: [] description: Get person information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetPersonResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Person summary: Update person patch operationId: Person_updatePatch security: - JWT: [] description: Update person patch parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePersonPatchSwaggerModel' multipart/form-data: schema: $ref: '#/components/schemas/UpdatePersonPatchSwaggerModel' required: true x-go-name: Request responses: '200': description: UpdatePersonResponse content: application/json: schema: $ref: '#/components/schemas/UpdatePersonResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' put: tags: - Person summary: Update person operationId: Person_updateDetails security: - JWT: [] description: Update person parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePersonRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdatePersonRequest' required: true x-go-name: Request responses: '200': description: UpdatePersonResponse content: application/json: schema: $ref: '#/components/schemas/UpdatePersonResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' deprecated: true /v1/persons/{person_id}/3ds-settings: delete: tags: - Person summary: Delete person 3DS settings operationId: Person_delete3dsSettings description: Delete person 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Person summary: Get person 3DS settings operationId: Person_get3dsSettings description: Get person 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: Person3DSSettingsResponse content: application/json: schema: $ref: '#/components/schemas/Person3DSSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Person summary: Update person 3DS settings operationId: Person_update3dsSettings description: Update person 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: $ref: '#/components/requestBodies/UpdateCardholder3DSSettingsRequest' responses: '200': description: Person3DSSettingsResponse content: application/json: schema: $ref: '#/components/schemas/Person3DSSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Person summary: Create person 3DS settings operationId: Person_create3dsSettings description: Create person 3DS settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: $ref: '#/components/requestBodies/CreateCardholder3DSSettingsRequest' responses: '201': description: Person3DSSettingsResponse content: application/json: schema: $ref: '#/components/schemas/Person3DSSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/accounts: get: tags: - Person summary: Get person accounts operationId: Person_getAccounts security: - JWT: [] description: Get person accounts parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: Return only active accounts in: query name: is_active x-go-name: IsActive schema: type: boolean - description: >- AccountStatuses is **repeated** query parameter to specify account statuses to return. in: query name: account_statuses x-go-name: AccountStatuses schema: type: string enum: - Active - Closing - Closed - Blocked - description: AccountName is a query parameter to specify account name to return. in: query name: account_name x-go-name: AccountName schema: type: string maximum: 100 - description: Viban is a query parameter to specify account Viban to return. in: query name: viban x-go-name: Viban schema: type: string maximum: 34 responses: '200': description: GetPersonAccountsResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonAccountsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/activate: patch: tags: - Person summary: Activate person operationId: Person_activatePatch security: - JWT: [] description: Activate person parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: ActivatePersonResponse content: application/json: schema: $ref: '#/components/schemas/ActivatePersonResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/activate-card: patch: tags: - Person summary: Activate card operationId: Person_activateCardByLastFourDigits security: - JWT: [] description: >- Activate card by last four digits. Card 3D Secure settings are required to activate card if product has 3D Secure enabled. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateCardByLastFourDigitsRequest' multipart/form-data: schema: $ref: '#/components/schemas/ActivateCardByLastFourDigitsRequest' required: true x-go-name: Request responses: '200': description: ActivateCardByLastFourDigitsResponse content: application/json: schema: $ref: '#/components/schemas/ActivateCardByLastFourDigitsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/additional-infos: get: tags: - Person summary: Get person additional infos operationId: Person_getAdditionalInfos security: - JWT: [] description: Get person additional infos parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetPersonAdditionalInfosResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonAdditionalInfosResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/additional-infos/{person_additional_info_id}: delete: tags: - Person summary: Delete person additional info operationId: Person_deleteAdditionalInfo security: - JWT: [] description: Delete person additional info parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: Person additional info ID in: path name: person_additional_info_id required: true x-go-name: PersonAdditionalInfoID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Person summary: Get person additional info operationId: Person_getAdditionalInfo security: - JWT: [] description: Get person additional info parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: Person additional info ID in: path name: person_additional_info_id required: true x-go-name: PersonAdditionalInfoID schema: type: string format: uuid4 responses: '200': description: GetPersonAdditionalInfoResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonAdditionalInfoResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Person summary: Update person additional info operationId: Person_updateAdditionalInfo security: - JWT: [] description: Update person additional info parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: Person additional info ID in: path name: person_additional_info_id required: true x-go-name: PersonAdditionalInfoID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePersonAdditionalInfoRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdatePersonAdditionalInfoRequest' required: true x-go-name: Request responses: '200': description: UpdatePersonAdditionalInfoResponse content: application/json: schema: $ref: '#/components/schemas/UpdatePersonAdditionalInfoResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/card-blocks: get: tags: - Person summary: Get cards block logs operationId: Person_getCardBlockLogs security: - JWT: [] description: Get cards block logs parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time responses: '200': description: GetCardsBlockLogsResponse content: application/json: schema: $ref: '#/components/schemas/GetCardsBlockLogsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/cards: get: tags: - Person summary: Get person cards operationId: Person_getCards security: - JWT: [] description: Get person cards parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: 'Field to sort by: masked_card_number, expiry_date, type, status' in: query name: order_field x-go-name: OrderField schema: type: string default: masked_card_number - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- CardStatuses is **repeated** query parameter to specify card statuses to return. in: query name: card_statuses x-go-name: CardStatuses schema: type: string enum: - Created - Ordered - Personalized - Dispatched - Active - Blocked - Closing - Closed - Expired - AwaitingRenewal responses: '200': description: GetPersonCardsResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonCardsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/fcm-tokens: post: tags: - Person summary: Register FCM Token operationId: Person_registerFcmToken security: - JWT: [] description: >- Registers FCM token received from Firebase to be able to send push notifications to device parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterFCMTokenRequest' multipart/form-data: schema: $ref: '#/components/schemas/RegisterFCMTokenRequest' required: true x-go-name: Request responses: '201': description: RegisterFCMTokenResponse content: application/json: schema: $ref: '#/components/schemas/RegisterFCMTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/fcm-tokens-by-device-id/{device_id}: delete: tags: - Person summary: Delete FCM Token operationId: Person_deleteFcmToken security: - JWT: [] description: Delete FCM Token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: Device ID in: path name: device_id required: true x-go-name: DeviceID schema: type: string responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Person summary: Get FCM Token operationId: Person_getFcmToken security: - JWT: [] description: Get FCM Token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: Device ID in: path name: device_id required: true x-go-name: DeviceID schema: type: string responses: '200': description: GetFCMTokenResponse content: application/json: schema: $ref: '#/components/schemas/GetFCMTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/fcm-tokens-by-device-id/{device_id}/push-notifications-enabled: patch: tags: - Person summary: Update push notifications enabled operationId: Person_updatePushNotificationsEnabled security: - JWT: [] description: Turn off or on push notifications for device parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: Device ID in: path name: device_id required: true x-go-name: DeviceID schema: type: string requestBody: $ref: '#/components/requestBodies/UpdatePushNotificationsEnabledRequest' responses: '200': description: UpdateFCMTokenPushNotificationsEnabledResponse content: application/json: schema: $ref: >- #/components/schemas/UpdateFCMTokenPushNotificationsEnabledResponse '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/fees-statements: get: tags: - Person summary: Get fees statement operationId: Person_getFeesStatement security: - JWT: [] description: Get fees statement parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetFeesStatementResponse content: application/json: schema: $ref: '#/components/schemas/GetFeesStatementResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/history: get: tags: - Person summary: Get person history operationId: Person_getHistory security: - JWT: [] description: Get person history parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Required if to_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: from_date x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Required if from_date is set. Time must be in 2006-01-02T15:04:05Z format in: query name: to_date x-go-name: ToDate schema: type: string format: date-time responses: '200': description: GetPersonHistoryResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonHistoryResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/onfido-check: post: tags: - Person summary: Create Onfido check operationId: Person_createOnfidoCheck security: - JWT: [] description: Create Onfido check parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 responses: '201': description: CreateOnfidoCheckResponse content: application/json: schema: $ref: '#/components/schemas/CreateOnfidoCheckResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/onfido-sdk-token: post: tags: - Person summary: Generate Onfido SDK token operationId: Person_generateSdkToken security: - JWT: [] description: >- Generate Onfido SDK token. For Onfido SDK information please refer to: https://documentation.onfido.com/sdk/web/ parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: >- Person IP Address. Required if your Onfido integration versions less than: API v3.4, iOS SDK v25.1.1, Android SDK v12.3.0, Web SDK 8.3.0 in: query name: ip_address x-go-name: IPAddress schema: type: string responses: '201': description: GenerateOnfidoSDKTokenResponse content: application/json: schema: $ref: '#/components/schemas/GenerateOnfidoSDKTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/push-notifications-enabled: patch: tags: - Person summary: Update push notifications enabled operationId: Person_togglePushNotifications security: - JWT: [] description: Turn off or on push notifications for cardholder parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: $ref: '#/components/requestBodies/UpdatePushNotificationsEnabledRequest' responses: '200': description: UpdatePushNotificationsEnabledResponse content: application/json: schema: $ref: '#/components/schemas/UpdatePushNotificationsEnabledResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/persons/{person_id}/users: delete: tags: - Person summary: Delete person users operationId: Person_deleteUser security: - JWT: [] description: Delete person users parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: User IDs in: query name: user_ids required: true x-go-name: UserID style: form explode: false schema: type: array items: format: uuid4 type: string responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Person summary: Get person users operationId: Person_getUserList security: - JWT: [] description: Get person users parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 - description: 'Field to sort by: first_name, last_name, mobile, email' in: query name: order_field x-go-name: OrderField schema: type: string default: first_name - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetPersonUsersResponse content: application/json: schema: $ref: '#/components/schemas/GetPersonUsersResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Person summary: Create person user operationId: Person_createUser security: - JWT: [] description: Create person user parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Person ID in: path name: person_id required: true x-go-name: PersonID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePersonUserRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreatePersonUserRequest' required: true x-go-name: Request responses: '201': description: CreatePersonUserResponse content: application/json: schema: $ref: '#/components/schemas/CreatePersonUserResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-cards: get: tags: - Card summary: Get list of cards operationId: Card_getList security: - JWT: [] description: Get list of cards parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- OrderField is **repeated** query parameter to specify cards order by. in: query name: order_field x-go-name: OrderField schema: type: string enum: - embossing_name - masked_card_number - status - type - personalization_product_code - expiry_date - updated_at - block_type default: embossing_name - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: Return only active cards in: query name: is_active x-go-name: IsActive schema: type: boolean default: false - description: >- CardStatuses is **repeated** query parameter to specify card statuses to return. in: query name: card_statuses x-go-name: CardStatuses schema: type: string enum: - Created - Ordered - Personalized - Dispatched - Active - Blocked - Closing - Closed - Expired - AwaitingRenewal - description: >- BlockTypes is **repeated** query parameter to specify card block types to return. in: query name: block_types x-go-name: BlockTypes schema: type: string enum: - BlockedByCardholder - BlockedByCardholderViaPhone - BlockedByClient - BlockedByIssuer - MaxInvalidTriesCVV2 - MaxInvalidTriesPIN - Counterfeit - Fraudulent - Lost - Stolen - description: AccountIDs is **repeated** query parameter with card account IDs in: query name: account_ids x-go-name: AccountIDs schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetCardsResponse content: application/json: schema: $ref: '#/components/schemas/GetCardsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/about-company: get: tags: - Product summary: Company info operationId: Product_getCompanyInfo security: - JWT: [] description: Returns information about company responses: '200': description: GetCompanyInfoByProductIDResponse content: application/json: schema: $ref: '#/components/schemas/GetCompanyInfoByProductIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/account-allowed-currencies: get: tags: - Product summary: Account allowed currencies operationId: Product_getAllowedCurrencies security: - JWT: [] description: Returns account allowed currencies for product parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: GetAccountAllowedCurrenciesResponse content: application/json: schema: $ref: '#/components/schemas/GetAccountAllowedCurrenciesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/account-limits: get: tags: - Product summary: Account limits operationId: Product_getAccountLimits security: - JWT: [] description: >- Returns default & maximum account limits together with credit limit and program type set for your product. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: AccountLimitsByProductIDResponse content: application/json: schema: $ref: '#/components/schemas/AccountLimitsByProductIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/allowed-card-delivery-country-codes: get: tags: - Product summary: Allowed card delivery countries operationId: Product_getAllowedDeliveryCountries security: - JWT: [] description: Returns allowed card delivery countries for your product. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: AllowedCardDeliveryCountryCodesByProductIDResponse content: application/json: schema: $ref: >- #/components/schemas/AllowedCardDeliveryCountryCodesByProductIDResponse '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/card-limits: get: tags: - Product summary: Card limits operationId: Product_getCardLimits security: - JWT: [] description: Returns default & maximum card limits set for your product. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: CardLimitsByProductIDResponse content: application/json: schema: $ref: '#/components/schemas/CardLimitsByProductIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/embossing-name: get: tags: - Product summary: Embossing name product settings operationId: Product_getEmbossingNameSettings security: - JWT: [] description: Embossing name product settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: GetEmbossingNameProductSettingsResponse content: application/json: schema: $ref: '#/components/schemas/GetEmbossingNameProductSettingsResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/mobile-application: get: tags: - Product summary: Mobile application product settings operationId: Product_getMobileApplicationSettings security: - JWT: [] description: Mobile application product settings parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: GetMobileApplicationProductSettingsResponse content: application/json: schema: $ref: >- #/components/schemas/GetMobileApplicationProductSettingsResponse '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/personalization-product-codes: get: tags: - Product summary: Personalization product codes operationId: Product_getPersonalizationProductCodes security: - JWT: [] description: >- Returns default and actual personalization product codes for your product. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: PersonalizationProductCodesResponse content: application/json: schema: $ref: '#/components/schemas/PersonalizationProductCodesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/product-settings/product-fees: get: tags: - Product summary: Product fees operationId: Product_getFees security: - JWT: [] description: Returns product fees for your product. responses: '200': description: ProductFeesByProductIDResponse content: application/json: schema: $ref: '#/components/schemas/ProductFeesByProductIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/products/card-designs: get: tags: - Product summary: Card designs by personalization product codes operationId: Product_getCardDesignsByCodes security: - JWT: [] description: Returns card designs by personalization product codes parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: PersonalizationProductCode **repeated** in: query name: personalization_product_code required: true x-go-name: PersonalizationProductCode schema: type: string responses: '200': description: GetCardDesignsByPersonalizationProductCodesResponse content: application/json: schema: $ref: >- #/components/schemas/GetCardDesignsByPersonalizationProductCodesResponse '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/reserved-settlement-balance: get: tags: - Settlement summary: Get reserved settlement balance operationId: Settlement_getReservedBalance security: - JWT: [] description: Get reserved settlement balance parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: '200': description: GetReservedSettlementBalanceResponse content: application/json: schema: $ref: '#/components/schemas/GetReservedSettlementBalanceResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/search: get: tags: - Other summary: Search operationId: Other_searchAccountsAndPersons description: >- Search works for accounts/persons/cards. Person search accepts person ID, personal number or last name as search value. Account search works only by account ID. Card search accepts masked card number or card ID as search value. Returns business error in case of search returned no results. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 - description: >- Person search allows to order fields by: full_name, residency_country_code, mobile, status, personal_id Card search allows to order fields by: embossing_name, masked_card_number, status, type, personalization_product_code, expiry_date in: query name: order_field x-go-name: OrderFieldName schema: type: string enum: - full_name - residency_country_code - mobile - status - personal_id - embossing_name - masked_card_number - type - personalization_product_code - expiry_date - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: Search value in: query name: value required: true x-go-name: Value schema: type: string responses: '200': description: SearchResponse content: application/json: schema: $ref: '#/components/schemas/SearchResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/status: get: tags: - Status summary: Get API status operationId: Status_checkApiStatus security: - none: [] description: Use this endpoint to check the current status of the API. responses: '200': $ref: '#/components/responses/ok' /v1/templates: get: tags: - Templates summary: Get list of templates operationId: Templates_getList security: - JWT: [] description: Get list of templates parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- Field to sort by: message_type, delivery_type, language_code, body, subject, updated_at in: query name: order_field x-go-name: OrderField schema: type: string default: message_type - description: 'Direction to sort by: asc or desc' in: query name: order_direction x-go-name: OrderDirection schema: type: string default: asc - description: >- FromRecord defines a beginning record number of requested data set (used with records_count parameter in pair) in: query name: from_record required: true x-go-name: FromRecord schema: type: integer format: int64 minimum: 0 - description: >- RecordsCount defines number of records of requested data set (used with from_record parameter in pair) in: query name: records_count required: true x-go-name: RecordsCount schema: type: integer format: int64 minimum: 1 maximum: 1000 responses: '200': description: GetTemplatesResponse content: application/json: schema: $ref: '#/components/schemas/GetTemplatesResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' post: tags: - Templates summary: Create template operationId: Templates_createNewTemplate security: - JWT: [] description: Create template. Template must be unique. parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateTemplateRequest' required: true x-go-name: Request responses: '201': description: CreateTemplateResponse content: application/json: schema: $ref: '#/components/schemas/CreateTemplateResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/templates/{template_id}: delete: tags: - Templates summary: Delete template operationId: Templates_deleteTemplate security: - JWT: [] description: Delete template parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Template ID in: path name: template_id required: true x-go-name: TemplateID schema: type: string format: uuid4 responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' get: tags: - Templates summary: Get template operationId: Templates_getById security: - JWT: [] description: Get template parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Template ID in: path name: template_id required: true x-go-name: TemplateID schema: type: string format: uuid4 responses: '200': description: GetTemplateResponse content: application/json: schema: $ref: '#/components/schemas/GetTemplateResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' patch: tags: - Templates summary: Update template operationId: Templates_updateTemplate security: - JWT: [] description: Update template parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Template ID in: path name: template_id required: true x-go-name: TemplateID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateTemplateRequest' required: true x-go-name: Request responses: '200': description: UpdateTemplateResponse content: application/json: schema: $ref: '#/components/schemas/UpdateTemplateResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/test/authorizations: post: tags: - Testing summary: Create authorization operationId: Testing_createAuthorization security: - JWT: [] description: Create authorization parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- CreateMatchingTransactionAndPerformClearing defines whether to create matching transaction and perform clearing or not. in: query name: create_matching_transaction_and_perform_clearing x-go-name: CreateMatchingTransactionAndPerformClearing schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAuthorizationRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateAuthorizationRequest' required: true x-go-name: Request responses: '201': description: CreateAuthorizationResponse content: application/json: schema: $ref: '#/components/schemas/CreateAuthorizationResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/test/cards/{card_id}/3ds-otp: post: tags: - Testing summary: Send 3DS OTP operationId: Testing_send3dsOtpNotification security: - JWT: [] description: Send 3DS OTP notification parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/Send3DSOTPRequest' multipart/form-data: schema: $ref: '#/components/schemas/Send3DSOTPRequest' required: true x-go-name: Request responses: '200': $ref: '#/components/responses/ok' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/test/cards/{card_id}/status: patch: tags: - Testing summary: Update card status operationId: Testing_updateCardStatus security: - JWT: [] description: Update card status parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Card ID in: path name: card_id required: true x-go-name: CardID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCardStatusRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardStatusRequest' required: true x-go-name: Request responses: '200': description: UpdateCardStatusResponse content: application/json: schema: $ref: '#/components/schemas/UpdateCardStatusResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/test/no-access: get: tags: - Testing summary: No Access operationId: Testing_handleNoAccessError security: - JWT: [] description: This endpoint is useful for testing the handling of no access error parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string responses: default: $ref: '#/components/responses/forbidden' /v1/test/ping: post: tags: - Testing summary: Ping operationId: Testing_jwtToken security: - JWT: [] description: This endpoint is useful for testing JWT tokens requestBody: content: application/json: schema: $ref: '#/components/schemas/PingRequest' multipart/form-data: schema: $ref: '#/components/schemas/PingRequest' required: true x-go-name: Request responses: '200': description: PingResponse content: application/json: schema: $ref: '#/components/schemas/PingResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/test/transactions: post: tags: - Testing summary: Create transaction operationId: Testing_submitTransaction security: - JWT: [] description: Create transaction parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTransactionRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateTransactionRequest' required: true x-go-name: Request responses: '201': description: CreateTransactionResponse content: application/json: schema: $ref: '#/components/schemas/CreateTransactionResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/tokens/{token_id}: get: tags: - Token summary: Get token by token ID operationId: Token_getById security: - JWT: [] description: Get token by token ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Token ID in: path name: token_id required: true x-go-name: TokenID schema: type: string format: uuid4 responses: '200': description: TokenByIDResponse content: application/json: schema: $ref: '#/components/schemas/TokenByIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/tokens/{token_id}/activate: post: tags: - Token summary: Activate token operationId: Token_activateToken security: - JWT: [] description: Activate token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Token ID in: path name: token_id required: true x-go-name: TokenID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateTokenRequest' multipart/form-data: schema: $ref: '#/components/schemas/ActivateTokenRequest' required: true x-go-name: Request responses: '200': description: ActivateTokenResponse content: application/json: schema: $ref: '#/components/schemas/ActivateTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/tokens/{token_id}/deactivate: post: tags: - Token summary: Deactivate token operationId: Token_deactivateToken security: - JWT: [] description: Deactivate token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Token ID in: path name: token_id required: true x-go-name: TokenID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/DeactivateTokenRequest' multipart/form-data: schema: $ref: '#/components/schemas/DeactivateTokenRequest' required: true x-go-name: Request responses: '200': description: DeactivateTokenResponse content: application/json: schema: $ref: '#/components/schemas/DeactivateTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/tokens/{token_id}/resume: post: tags: - Token summary: Resume token operationId: Token_resume security: - JWT: [] description: Resume token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Token ID in: path name: token_id required: true x-go-name: TokenID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ResumeTokenRequest' multipart/form-data: schema: $ref: '#/components/schemas/ResumeTokenRequest' required: true x-go-name: Request responses: '200': description: ResumeTokenResponse content: application/json: schema: $ref: '#/components/schemas/ResumeTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/tokens/{token_id}/suspend: post: tags: - Token summary: Suspend token operationId: Token_suspendToken security: - JWT: [] description: Suspend token parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Token ID in: path name: token_id required: true x-go-name: TokenID schema: type: string format: uuid4 requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspendTokenRequest' multipart/form-data: schema: $ref: '#/components/schemas/SuspendTokenRequest' required: true x-go-name: Request responses: '200': description: SuspendTokenResponse content: application/json: schema: $ref: '#/components/schemas/SuspendTokenResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '415': $ref: '#/components/responses/unsupportedMediaType' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/transactions/summary: get: tags: - Transactions summary: Transactions summary operationId: Transactions_getSummary security: - JWT: [] description: Transactions summary parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: >- FromDate defines a beginning date of requested data set (used with to_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: from_date required: true x-go-name: FromDate schema: type: string format: date-time - description: >- ToDate defines an end date of requested data set (used with from_date parameter in pair). Time must be in 2006-01-02T15:04:05Z format in: query name: to_date required: true x-go-name: ToDate schema: type: string format: date-time responses: '200': description: TransactionsSummaryResponse content: application/json: schema: $ref: '#/components/schemas/TransactionsSummaryResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/transactions/{transaction_id}: get: tags: - Transactions summary: Get transaction operationId: Transactions_getInformation security: - JWT: [] description: Get transaction information parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Transaction ID in: path name: transaction_id required: true x-go-name: TransactionID schema: type: string format: uuid4 - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: GetTransactionResponse content: application/json: schema: $ref: '#/components/schemas/GetTransactionResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v1/transactions/{transaction_id}/fees: get: tags: - Fee summary: Get fees by transaction ID operationId: Fee_getByTransactionId security: - JWT: [] description: Get fees by transaction ID parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: Transaction ID in: path name: transaction_id required: true x-go-name: TransactionID schema: type: string format: uuid4 - description: >- Fee types is a **repeated** query parameter to specify fee types to return. in: query name: fee_types x-go-name: FeeTypes schema: type: string - description: Filter by Company ID, cannot be used together with Person ID in: query name: company_id x-go-name: CompanyID schema: type: string format: uuid4 - description: Filter by Person ID, cannot be used together with Company ID in: query name: person_id x-go-name: PersonID schema: type: string format: uuid4 responses: '200': description: FeesByTransactionIDResponse content: application/json: schema: $ref: '#/components/schemas/FeesByTransactionIDResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' /v2/cards-by-hashed-card-number/{sha}: get: tags: - Card summary: Get card by SHA hashed card number operationId: Card_getByShaHashedCardNumber security: - JWT: [] description: Get card by SHA hashed card number parameters: - description: >- Product, which this request belongs to (product code is defined by Wallester and specific for each client's product) in: header name: X-Product-Code required: true x-go-name: ProductCode schema: type: string - description: >- Type of the source system, possible values are Backend or SelfService in: header name: X-Audit-Source-Type required: true x-go-name: AuditSourceType schema: type: string enum: - Backend - SelfService - description: ID of the user who initiated the request in: header name: X-Audit-User-Id required: true x-go-name: AuditUserID schema: type: string - description: 'JWT Token, in "Authorization: Bearer JWT_TOKEN" format' in: header name: Authorization required: true schema: type: string - description: SHA hashed card number in: path name: sha required: true x-go-name: SHA schema: type: string responses: '200': description: GetCardBySHACardNumberResponse content: application/json: schema: $ref: '#/components/schemas/GetCardBySHACardNumberResponse' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessableEntity' '500': $ref: '#/components/responses/internalServerError' components: responses: badRequest: description: Request failed. empty: description: Empty response. forbidden: description: Authorization has been denied for this request. internalServerError: description: Internal server error. ok: description: OK. serviceUnavailable: description: Service is unavailable. unauthorized: description: Authentication has failed for this request. unprocessableEntity: description: Model validation failed. unsupportedMediaType: description: Media type is unsupported. requestBodies: CreateCardholder3DSSettingsRequest: content: application/json: schema: $ref: '#/components/schemas/CreateCardholder3DSSettingsRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateCardholder3DSSettingsRequest' required: true x-go-name: Request UpdateCompanyPushNotificationsEnabledRequest: content: application/json: schema: $ref: '#/components/schemas/UpdateCompanyPushNotificationsEnabledRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCompanyPushNotificationsEnabledRequest' required: true x-go-name: Request UpdateAccountLimitsRequest: content: application/json: schema: $ref: '#/components/schemas/UpdateAccountLimitsRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateAccountLimitsRequest' required: true x-go-name: Request UpdateCardholder3DSSettingsRequest: content: application/json: schema: $ref: '#/components/schemas/UpdateCardholder3DSSettingsRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCardholder3DSSettingsRequest' required: true x-go-name: Request UpdatePushNotificationsEnabledRequest: content: application/json: schema: $ref: '#/components/schemas/UpdatePushNotificationsEnabledRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdatePushNotificationsEnabledRequest' required: true x-go-name: Request schemas: ACSLanguageCode: title: DEPRECATED. Language code. enum: - ENG type: string x-go-package: github.com/wallester/api/model APIBlockType: title: Card api block type. enum: - BlockedByCardUser - BlockedByCardholder - BlockedByCardholderViaPhone - BlockedByClient - BlockedByIssuer - Counterfeit - Fraudulent - Lost - Stolen type: string x-go-package: github.com/wallester/common/model APICard3DSecureType: title: DEPRECATED. Not used, will be removed soon. Card 3D Secure type. enum: - SMSOTPAndStaticPassword type: string x-go-package: github.com/wallester/api/model APICardType: description: Card type enum: - ChipAndPin - ChipAndPinAnonymous - Virtual type: string x-go-package: github.com/wallester/api/model APIModelCardCloseReason: description: APIModelCardCloseReason types enum: - ClosedByCardholder - ClosedByClient - ClosedByIssuer - ClosedByReplace - ClosedBySystem type: string x-go-package: github.com/wallester/api/model APIModelFeeType: description: APIModelFeeType types enum: - AdditionalBINConfigurationFee - AdditionalBINMaintenanceFee - AdditionalVirtualCardsFee - AuthorizationATMBalanceInquiryFixedFee - AuthorizationATMDeclinedFixedFee - AuthorizationATMWithdrawalComplexFee - AuthorizationATMWithdrawalEEAComplexFee - AuthorizationATMWithdrawalFixedFee - AuthorizationATMWithdrawalInternationalComplexFee - AuthorizationATMWithdrawalPercentageFee - AuthorizationDeclinedFixedFee - AuthorizationEEAFixedFee - AuthorizationForeignExchangePercentageFee - AuthorizationInternationalFixedFee - AvailableFundsRefundFee - CardDeliveryFixedFee - CardExpressDeliveryFixedFee - CardIssuanceFixedFee - CardRenewalFixedFee - CardReplacementFixedFee - CardUsageFixedFee - ChargebackProcessingFee - MerchantWhitelistFee - OtherAdministrativeRequestFee - PINChangeFixedFee - PaymentEEAComplexFee - PaymentEEAFixedFee - PaymentInternationalComplexFee - PaymentInternationalFixedFee - PaymentPercentageFee - PricingPlanFee - Remind3DSPasswordFixedFee - RemindPINFixedFee - ZeroAuthorizationEEAFixedFee - ZeroAuthorizationInternationalFixedFee type: string x-go-package: github.com/wallester/api/model APIRiskProfile: title: Risk profile. description: |- __Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ enum: - High - Low - Medium type: string x-go-package: github.com/wallester/api/model APIUser: title: User represents API user, for example CRM. properties: description: description: Description maxLength: 200 type: string x-go-name: Description id: description: API user ID format: uuid4 type: string x-go-name: ID client_id: description: Client ID format: uuid4 type: string x-go-name: ClientID name: description: Name maxLength: 100 type: string x-go-name: Name public_key: description: RSA Public key. Required without shared_key type: string x-go-name: PublicKey shared_key: description: HS256 Shared key. Required without public_key type: string x-go-name: SharedKey status: $ref: '#/components/schemas/APIUserStatus' created_at: description: |- Date-time when API user was created Date-time in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: CreatedAt updated_at: description: |- Last date-time when API user was updated Date-time in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: UpdatedAt deleted_at: description: |- Date-time when API user was deleted Date-time in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: DeletedAt required: - name type: object x-go-package: github.com/wallester/api/model APIUserStatus: enum: - Active - Deleted type: string x-go-package: github.com/wallester/common/model Account: title: Account represents a person account. properties: id: description: Account ID format: uuid4 type: string x-go-name: ID product_id: description: Product ID format: uuid4 type: string x-go-name: ProductID person_id: description: >- Account owner ID. Filled when account owner is cardholder, not a company. format: uuid4 type: string x-go-name: PersonID company_id: description: >- Account owner ID. Filled when account owner is company, not a cardholder. format: uuid4 type: string x-go-name: CompanyID external_id: description: ExternalID type: string x-go-name: ExternalID name: description: A name specified by the user on creation of the Account type: string x-go-name: Name currency_code: description: Code of the Account’s currency under ISO 4217 enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode credit_limit: description: Credit limit format: double type: number x-go-name: CreditLimit used_credit: description: Used credit format: double type: number x-go-name: UsedCredit balance: description: Account balance format: double type: number x-go-name: Balance available_amount: description: >- Account balance less blocked amount, i.e. available money that can be spent format: double type: number x-go-name: AvailableAmount blocked_amount: description: Amount blocked by payments and is waiting to be settled format: double type: number x-go-name: BlockedAmount status: $ref: '#/components/schemas/AccountStatus' created_at: description: Date-time in UTC when the Account was created format: date-time type: string x-go-name: CreatedAt updated_at: description: Date-time in UTC of the last changes in the Account’s object format: date-time type: string x-go-name: UpdatedAt closed_at: description: Date-time in UTC, applies if the Account is closed format: date-time type: string x-go-name: ClosedAt limits: $ref: '#/components/schemas/AccountLimits' closed_by: description: ID of the user who closed the account type: string x-go-name: ClosedBy close_reason: $ref: '#/components/schemas/AccountCloseReason' is_main: description: >- Indication if the Account is the main for the Company (field available only for Wallester Business product) type: boolean x-go-name: IsMain cards_count: description: Number of Cards linked to the Account format: int64 type: integer x-go-name: CardsCount viban: description: Feature for this field is coming soon type: string x-go-name: Viban top_up_details: $ref: '#/components/schemas/AccountTopUpDetails' type: object x-go-package: github.com/wallester/api/model AccountAdjustment: title: AccountAdjustment represents an account adjustment. properties: description: description: Account adjustment description type: string x-go-name: Description id: description: Account adjustment ID format: uuid4 type: string x-go-name: ID account_id: description: Account ID to which this adjustment belongs format: uuid4 type: string x-go-name: AccountID external_id: description: External ID type: string x-go-name: ExternalID amount: description: Account adjustment amount format: double type: number x-go-name: Amount sender_name: description: Account adjustment sender name type: string x-go-name: SenderName created_at: description: Date-time the account adjustment was created at format: date-time type: string x-go-name: CreatedAt type: $ref: '#/components/schemas/AccountAdjustmentType' icon_url: description: Icon URL type: string x-go-name: IconURL updated_at: description: Updated at format: date-time type: string x-go-name: UpdatedAt updated_by: description: Updated by type: string x-go-name: UpdatedBy type: object x-go-package: github.com/wallester/api/model AccountAdjustmentNotification: properties: data: $ref: '#/components/schemas/EventAccountAdjustment' event: description: Event identifier enum: - account_adjustment type: string x-go-name: Event type: description: Event type enum: - account_adjustment - incoming_payment - cashback type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks AccountAdjustmentNotificationType: description: Account adjustment notification type enum: - account_adjustment - account_to_account_payment - cashback - incoming_payment - mobile_payment type: string x-go-package: github.com/wallester/common/model AccountAdjustmentType: title: Account adjustment type. enum: - AccountToAccountTransfer - Adjustment - Cashback - IncomingCardPayment - IncomingSEPAPayment - ReceiveEmployeeTransfer - ReceiveMobileTransfer - SendEmployeeTransfer - SendMobileTransfer type: string x-go-package: github.com/wallester/common/model AccountBlockType: enum: - Frozen type: string x-go-package: github.com/wallester/common/model AccountCloseReason: title: Account close reason. enum: - ClosedByCardholder - ClosedByClient - ClosedByIssuer - ClosedBySystem type: string x-go-package: github.com/wallester/common/model AccountLimits: title: AccountLimits represents daily, weekly and monthly limits. properties: daily_purchase: description: Daily purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyPurchase daily_withdrawal: description: Daily withdrawal amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyWithdrawal daily_internet_purchase: description: Daily internet purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyInternetPurchase daily_contactless_purchase: description: Daily contactless purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyContactlessPurchase weekly_purchase: description: Weekly purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyPurchase weekly_withdrawal: description: Weekly withdrawal amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyWithdrawal weekly_internet_purchase: description: Weekly internet purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyInternetPurchase weekly_contactless_purchase: description: Weekly contactless purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyContactlessPurchase monthly_purchase: description: Monthly purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyPurchase monthly_withdrawal: description: Monthly withdrawal amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyWithdrawal monthly_internet_purchase: description: Monthly internet purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyInternetPurchase monthly_contactless_purchase: description: Monthly contactless purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyContactlessPurchase type: object x-go-package: github.com/wallester/api/model AccountLimitsByProductIDResponse: properties: credit_limit_max_amount: format: double type: number x-go-name: CreditLimitMaxAmount default_account_daily_contactless_purchase_limit: format: double type: number x-go-name: DefaultAccountDailyContactlessPurchaseLimit default_account_daily_internet_purchase_limit: format: double type: number x-go-name: DefaultAccountDailyInternetPurchaseLimit default_account_daily_purchase_limit: format: double type: number x-go-name: DefaultAccountDailyPurchaseLimit default_account_daily_withdrawal_limit: format: double type: number x-go-name: DefaultAccountDailyWithdrawalLimit default_account_weekly_contactless_purchase_limit: format: double type: number x-go-name: DefaultAccountWeeklyContactlessPurchaseLimit default_account_weekly_internet_purchase_limit: format: double type: number x-go-name: DefaultAccountWeeklyInternetPurchaseLimit default_account_weekly_purchase_limit: format: double type: number x-go-name: DefaultAccountWeeklyPurchaseLimit default_account_weekly_withdrawal_limit: format: double type: number x-go-name: DefaultAccountWeeklyWithdrawalLimit default_account_monthly_contactless_purchase_limit: format: double type: number x-go-name: DefaultAccountMonthlyContactlessPurchaseLimit default_account_monthly_internet_purchase_limit: format: double type: number x-go-name: DefaultAccountMonthlyInternetPurchaseLimit default_account_monthly_purchase_limit: format: double type: number x-go-name: DefaultAccountMonthlyPurchaseLimit default_account_monthly_withdrawal_limit: format: double type: number x-go-name: DefaultAccountMonthlyWithdrawalLimit max_account_daily_contactless_purchase_limit: format: double type: number x-go-name: MaxAccountDailyContactlessPurchaseLimit max_account_daily_internet_purchase_limit: format: double type: number x-go-name: MaxAccountDailyInternetPurchaseLimit max_account_daily_purchase_limit: format: double type: number x-go-name: MaxAccountDailyPurchaseLimit max_account_daily_withdrawal_limit: format: double type: number x-go-name: MaxAccountDailyWithdrawalLimit max_account_weekly_contactless_purchase_limit: format: double type: number x-go-name: MaxAccountWeeklyContactlessPurchaseLimit max_account_weekly_internet_purchase_limit: format: double type: number x-go-name: MaxAccountWeeklyInternetPurchaseLimit max_account_weekly_purchase_limit: format: double type: number x-go-name: MaxAccountWeeklyPurchaseLimit max_account_weekly_withdrawal_limit: format: double type: number x-go-name: MaxAccountWeeklyWithdrawalLimit max_account_monthly_contactless_purchase_limit: format: double type: number x-go-name: MaxAccountMonthlyContactlessPurchaseLimit max_account_monthly_internet_purchase_limit: format: double type: number x-go-name: MaxAccountMonthlyInternetPurchaseLimit max_account_monthly_purchase_limit: format: double type: number x-go-name: MaxAccountMonthlyPurchaseLimit max_account_monthly_withdrawal_limit: format: double type: number x-go-name: MaxAccountMonthlyWithdrawalLimit program_type: type: string x-go-name: ProgramType weekly_limits_enabled: type: boolean x-go-name: WeeklyLimitsEnabled type: object x-go-package: github.com/wallester/api/model AccountLimitsUsage: properties: daily: format: double type: number x-go-name: Daily weekly: format: double type: number x-go-name: Weekly monthly: format: double type: number x-go-name: Monthly type: object x-go-package: github.com/wallester/api/model AccountStatementRecord: title: AccountStatementRecord represents an account statement record. properties: description: description: Description (used for account adjustments) type: string x-go-name: Description id: description: Record ID format: uuid4 type: string x-go-name: ID card_id: description: Card ID to which this record belongs to format: uuid4 type: string x-go-name: CardID type: $ref: '#/components/schemas/AccountStatementRecordType' group: $ref: '#/components/schemas/AccountStatementRecordGroup' date: description: Date-time the record was made format: date-time type: string x-go-name: Date transaction_amount: description: Transaction amount format: double type: number x-go-name: TransactionAmount transaction_currency_code: description: Transaction currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode account_amount: description: Account amount format: double type: number x-go-name: AccountAmount account_currency_code: description: Account currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode merchant_category_code: $ref: '#/components/schemas/MerchantCategoryCode' merchant_id: description: Merchant ID type: string x-go-name: MerchantID terminal_id: description: Terminal ID type: string x-go-name: TerminalID merchant_name: description: Merchant name type: string x-go-name: MerchantName merchant_city: description: Merchant city type: string x-go-name: MerchantCity merchant_country_code: description: Merchant country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode original_authorization_id: description: >- Authorization ID (used for transactions and authorization reversals to link with original authorization) format: uuid4 type: string x-go-name: OriginalAuthorizationID is_reversal: description: Shows whether this is reversal authorization or not type: boolean x-go-name: IsReversal is_declined: description: Shows whether this is declined authorization or not type: boolean x-go-name: IsDeclined is_cleared: description: Shows whether this is cleared authorization or not type: boolean x-go-name: IsCleared marked_for_dispute_at: description: Date-time the transaction was marked for dispute format: date-time type: string x-go-name: MarkedForDisputeAt marked_for_dispute_by: description: Marked for dispute by type: string x-go-name: MarkedForDisputeBy status: $ref: '#/components/schemas/AccountStatementRecordStatus' response: $ref: '#/components/schemas/AccountStatementRecordResponse' response_code: description: Response Code type: string x-go-name: ResponseCode account_external_id: description: Account external ID type: string x-go-name: AccountExternalID masked_card_number: description: Masked card number type: string x-go-name: MaskedCardNumber has_payment_document_files: description: Shows whether this record has payment document files type: boolean x-go-name: HasPaymentDocumentFiles card_name: description: Card name type: string x-go-name: CardName embossing_name: description: Card embossing name type: string x-go-name: EmbossingName embossing_first_name: description: Card embossing first name type: string x-go-name: EmbossingFirstName embossing_last_name: description: Card embossing last name type: string x-go-name: EmbossingLastName embossing_company_name: description: Card embossing company name type: string x-go-name: EmbossingCompanyName sub_type: description: Sub type type: string x-go-name: SubType purchase_date: description: Date-time the payment was done format: date-time type: string x-go-name: PurchaseDate exchange_rate: description: Exchange rate format: double type: number x-go-name: ExchangeRate enriched_merchant_data: $ref: '#/components/schemas/EnrichedMerchantData' total_amount: description: Total amount (account amount + foreign exchange fee) format: double type: number x-go-name: TotalAmount type: object x-go-package: github.com/wallester/api/model AccountStatementRecordGroup: title: Account statement record group. enum: - AccountTransferFee - AdditionalBINConfigurationFee - AdditionalBINMaintenanceFee - AdditionalVirtualCardsFee - AuthorizationATMBalanceInquiryFixedFee - AuthorizationATMDeclinedFixedFee - AuthorizationATMWithdrawalComplexFee - AuthorizationATMWithdrawalEEAComplexFee - AuthorizationATMWithdrawalFixedFee - AuthorizationATMWithdrawalInternationalComplexFee - AuthorizationATMWithdrawalPercentageFee - AuthorizationDeclinedFixedFee - AuthorizationEEAFixedFee - AuthorizationForeignExchangePercentageFee - AuthorizationInternationalFixedFee - AvailableFundsRefundFee - CardDeliveryFixedFee - CardExpressDeliveryFixedFee - CardIssuanceFixedFee - CardRenewalFixedFee - CardReplacementFixedFee - CardUsageFixedFee - ChargebackProcessingFee - DedicatedBINRangeFee - Deposit - ExclusiveBINFee - ExclusiveSharedBINFee - IncomingSEPAPaymentFixedFee - IncomingSEPAPaymentPercentageFee - IndustryFee - InternetPurchase - MerchantWhitelistFee - MonthlyFeePerEmployee - MonthlyServiceFee - NewEmployeeAdditionFee - Other - OtherAdministrativeRequestFee - PINChangeFixedFee - PINManagement - PaymentEEAComplexFee - PaymentEEAFixedFee - PaymentInternationalComplexFee - PaymentInternationalFixedFee - PaymentPercentageFee - PricingPlanFee - Purchase - Refund - Remind3DSPasswordFixedFee - RemindPINFixedFee - SharedBINRangeFee - Withdraw - ZeroAuthorizationEEAFixedFee - ZeroAuthorizationInternationalFixedFee type: string x-go-package: github.com/wallester/common/model AccountStatementRecordResponse: title: AccountStatementRecordResponse Account statement record response. description: >- For authorizations and fees, if the Response is "Declined", the Status will be "Canceled". In cases where the Status is "Completed" or "Pending", the Response will be "Approved". For transactions and adjustments, the Response can only be "Approved", and the Status can only be "Completed". enum: - Approved - Declined type: string x-go-package: github.com/wallester/common/model AccountStatementRecordStatus: title: AccountStatementRecordStatus Account statement record status. description: >- "Completed" indicates the successful completion of the operation. If a fund transfer was initiated, then the funds were physically withdrawn from the account or added in the case of a top-up. "Pending" indicates that the funds are on hold but still remain in the account. "Canceled" indicates that the operation was declined. If funds were on hold during the pending status, they will be released. enum: - Canceled - Completed - Pending type: string x-go-package: github.com/wallester/common/model AccountStatementRecordType: title: Account statement record type. enum: - AccountAdjustment - Authorization - Fee - Transaction type: string x-go-package: github.com/wallester/common/model AccountStatementSubType: title: >- AccountStatementSubType represents account statement sub type, for fee type records, it shows the fee type, for account adjustment records, it shows the adjustment type, for the transactions and authorizations it is empty. enum: - AccountToAccountTransfer - AccountTransferFee - AdditionalBINConfigurationFee - AdditionalBINMaintenanceFee - AdditionalVirtualCardsFee - Adjustment - AuthorizationATMBalanceInquiryFixedFee - AuthorizationATMDeclinedFixedFee - AuthorizationATMWithdrawalComplexFee - AuthorizationATMWithdrawalEEAComplexFee - AuthorizationATMWithdrawalFixedFee - AuthorizationATMWithdrawalInternationalComplexFee - AuthorizationATMWithdrawalPercentageFee - AuthorizationDeclinedFixedFee - AuthorizationEEAFixedFee - AuthorizationForeignExchangePercentageFee - AuthorizationInternationalFixedFee - AvailableFundsRefundFee - CardDeliveryFixedFee - CardExpressDeliveryFixedFee - CardIssuanceFixedFee - CardRenewalFixedFee - CardReplacementFixedFee - CardUsageFixedFee - Cashback - ChargebackProcessingFee - DedicatedBINRangeFee - ExclusiveBINFee - ExclusiveSharedBINFee - IncomingSEPAPayment - IncomingSEPAPaymentFixedFee - IncomingSEPAPaymentPercentageFee - IndustryFee - MerchantWhitelistFee - MonthlyFeePerEmployee - MonthlyServiceFee - NewEmployeeAdditionFee - OtherAdministrativeRequestFee - PINChangeFixedFee - PaymentEEAComplexFee - PaymentEEAFixedFee - PaymentInternationalComplexFee - PaymentInternationalFixedFee - PaymentPercentageFee - PricingPlanFee - ReceiveEmployeeTransfer - ReceiveMobileTransfer - Remind3DSPasswordFixedFee - RemindPINFixedFee - SendEmployeeTransfer - SendMobileTransfer - SharedBINRangeFee - ZeroAuthorizationEEAFixedFee - ZeroAuthorizationInternationalFixedFee type: string x-go-package: github.com/wallester/common/model AccountStatus: title: Account status. enum: - Active - Blocked - Closed - Closing type: string x-go-package: github.com/wallester/common/model AccountToAccountTransferNotification: properties: data: $ref: '#/components/schemas/EventAccountToAccountTransfer' event: description: Event identifier enum: - account_adjustment type: string x-go-name: Event type: description: Event type enum: - account_to_account_payment - mobile_payment type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks AccountTopUpDetails: title: >- AccountTopUpDetails represents account top up details as IBAN, swift code, etc... properties: iban: description: Account bank IBAN maxLength: 35 type: string x-go-name: IBAN swift_code: description: Account bank swift code maxLength: 11 type: string x-go-name: SwiftCode receiver_name: description: Account payment receiver name maxLength: 200 type: string x-go-name: ReceiverName payment_details: description: Account payment details maxLength: 200 type: string x-go-name: PaymentDetails bank_name: description: Account bank name maxLength: 200 type: string x-go-name: BankName bank_address: description: Account bank address maxLength: 200 type: string x-go-name: BankAddress registration_number: description: Account bank registration number maxLength: 100 type: string x-go-name: RegistrationNumber required: - iban - swift_code - receiver_name - bank_name - bank_address - registration_number type: object x-go-package: github.com/wallester/api/model ActivateCardByCVVRequest: properties: cvv: description: Card CVV. Must be RSA encrypted and base64 encoded. type: string x-go-name: CVV required: - cvv type: object x-go-package: github.com/wallester/api/model ActivateCardByCVVResponse: title: >- ActivateCardByCVVResponse is the response to the request to activate a card by CVV. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model ActivateCardByLastFourDigitsRequest: properties: last_four_digits: description: Last four digits type: string x-go-name: LastFourDigits required: - last_four_digits type: object x-go-package: github.com/wallester/api/model ActivateCardByLastFourDigitsResponse: properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model ActivateCardEvent: properties: data: $ref: '#/components/schemas/ActivateCardEventView' event: description: Event identifier enum: - activate type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ActivateCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Active type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks ActivateCardResponse: title: ActivateCardResponse is the response to the request to activate a card. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model ActivatePersonResponse: properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model ActivateTokenRequest: title: ActivateTokenRequest represents activate token request. properties: reason: description: Activate reason. maxLength: 254 type: string x-go-name: Reason required: - reason type: object x-go-package: github.com/wallester/api/model ActivateTokenResponse: title: ActivateTokenResponse returns related token. properties: token: $ref: '#/components/schemas/Token' type: object x-go-package: github.com/wallester/api/model ActivityType: enum: - ActivitiesOfExtraterritorialOrganizationsAndBodies - AdultEntertainment - AdvertisingMarketing - AgricultureForestryFisheries - AlcoholicBeveragesAndTobacco - AlimentaryProducts - ArchitectureEngineeringAndTechnicalConsultingInTheseAreas - ArtworksCollectionItemsAntiques - BeverageService - BuildingAndTerritoryMaintenance - Charity - CinemaVideoFilmsAndTvProgramsSoundRecordingAndRecordedMusic - ClothingAndFootwear - ComputerProgrammingConsultingAndOtherRelatedServices - ConstructionActivities - CreativeWorkAndArt - CreditsOrMonetaryIntermediation - Cryptocurrencies - DataProcessingWebPortals - Design - DomesticAppliancesAndElectronics - Education - Energy - EngineeringTests - EventManagement - FoodDelivery - FuelAndGas - FundManagement - GamblingGamesAndBetting - HealthCareAndSocialServices - HighValueGoods - HoldingCompaniesAndPropertyManagement - HotelsAndRelatedAccommodation - HrAgencies - InformationAndReferenceServices - Insurance - InvestmentActivities - LandscapeDesign - LegalServicesAndAccounting - LibrariesArchivesMuseums - LodgingAndCateringServices - ManagementConsulting - Manufacturing - MedicationAndPharmaceuticals - MiningIndustry - MotorVehicles - NonProfitOrganizationFoundations - NonProfitOrganizationOther - OffshoreServices - OtherAccommodationTypes - OtherAdministrativeActivities - OtherFinancialServicesExcludingInsuranceAndPensionFundServices - OtherGoods - OtherInformationServices - OtherProfessionalScientificAndTechnicalActivities - OtherServices - PensionFunds - Photography - PoliticalOrganization - PrivateBanking - ProfessionalMembershipOrganization - PublicAdministrationAndDefense - PublishingActivities - RadioBroadcasting - RealEstateActivities - RealEstateLeasingAndManagement - RealEstatePurchaseAndSale - RecreationAndEntertainment - ReligiousOrganization - RentingLeasing - RepairingServices - Restaurants - ScientificResearchAndDevelopment - SecurityAndInvestigation - ShortTermAccommodationServices - Software - Sport - SupportingActivitiesRelatedToFinancialServices - SupportingActivitiesRelatedToInsuranceAndPensionFunds - Telecommunications - TourOperatorTravelAgent - TouristCampsRecreationAndEntertainmentParks - TradeUnion - TranslationServices - TransportationAndStorage - TrustsFundsAndOtherRelatedFinancialFacilities - ValuablesJewelry - WaterSupplySewerageWasteCollectionAndDistribution type: string x-go-package: github.com/wallester/common/model AddCompanyCorporateDocumentRequest: properties: type: description: Document type enum: - RegistrationIncorporationCertificate - BeneficialOwnersCertificate type: string x-go-name: Type file: $ref: '#/components/schemas/CorporateDocumentFile' required: - type - file type: object x-go-package: github.com/wallester/api/model AddCompanyCorporateDocumentResponse: properties: corporate_document: $ref: '#/components/schemas/CompanyCorporateDocument' type: object x-go-package: github.com/wallester/api/model AddPaymentDocumentsResponse: title: >- AddPaymentDocumentsResponse is the response to the request to add a new payment documents. properties: payment_documents: items: $ref: '#/components/schemas/PaymentDocument' type: array x-go-name: PaymentDocuments type: object x-go-package: github.com/wallester/api/model AddRepresentative: allOf: - properties: title: $ref: '#/components/schemas/Title' birth_date: description: >- Birthdate. Must be in 2006-01-02 format. Must be at least 16 years old. format: date type: string x-go-name: BirthDate email: description: Email. maxLength: 255 type: string x-go-name: Email first_name: description: >- Representative first name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName is_adverse_media_involved: description: |- Is Adverse Media Involved.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved is_member_of_the_board: description: Is member of the board? type: boolean x-go-name: IsMemberOfTheBoard is_politically_exposed: description: |- Is Politically Exposed.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsPoliticallyExposed is_representative: description: Is representative? type: boolean x-go-name: IsRepresentative is_sanctions_related: description: |- Is Sanctions Related.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_shareholder: description: Is shareholder type: boolean x-go-name: IsShareholder is_ultimate_beneficial_owner: description: Is ultimate beneficial owner? type: boolean x-go-name: IsUltimateBeneficialOwner last_name: description: >- Representative last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName middle_name: description: >- Representative middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile percentage_owned: description: |- Percentage owned.
__If representative is shareholder, minimum value is 1.__ format: float maximum: 100 minimum: 0 type: number x-go-name: PercentageOwned position: description: |- Representative position.
__Field is required for NonRegulated WhiteLabel partners.__ maxLength: 100 type: string x-go-name: Position residence_country_code: description: >- Residence country code. Must be in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode required: - first_name - last_name - birth_date - residence_country_code type: object x-go-package: github.com/wallester/api/model AddRepresentativeSwaggerModel: allOf: - properties: title: description: |- Representative title.
__Field is required for NonRegulated WhiteLabel partners.__ enum: - Mr. - Ms. - Mrs. - Miss maxLength: 4 type: string x-go-name: Title birth_date: description: >- Birthdate. Must be in 2006-01-02 format. Must be at least 16 years old. format: date type: string x-go-name: BirthDate email: description: Email. maxLength: 255 type: string x-go-name: Email first_name: description: >- Representative first name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName is_adverse_media_involved: description: |- Is Adverse Media Involved.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved is_member_of_the_board: description: Is member of the board? type: boolean x-go-name: IsMemberOfTheBoard is_politically_exposed: description: |- Is Politically Exposed.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsPoliticallyExposed is_representative: description: Is representative? type: boolean x-go-name: IsRepresentative is_sanctions_related: description: |- Is Sanctions Related.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_shareholder: description: Is shareholder type: boolean x-go-name: IsShareholder is_ultimate_beneficial_owner: description: Is ultimate beneficial owner? type: boolean x-go-name: IsUltimateBeneficialOwner last_name: description: >- Representative last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName middle_name: description: >- Representative middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile percentage_owned: description: |- Percentage owned.
__If representative is shareholder, minimum value is 1.__ format: float maximum: 100 minimum: 0 type: number x-go-name: PercentageOwned position: description: |- Representative position.
__Field is required for NonRegulated WhiteLabel partners.__ maxLength: 100 type: string x-go-name: Position residence_country_code: description: >- Residence country code. Must be in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode required: - first_name - last_name - birth_date - residence_country_code type: object x-go-package: github.com/wallester/api/model AddRepresentativesRequest: properties: representatives: description: >- Representatives to be added. At least 1 representative is always required for the company. items: $ref: '#/components/schemas/AddRepresentative' type: array x-go-name: Representatives required: - representatives type: object x-go-package: github.com/wallester/api/model AddRepresentativesResponse: properties: representatives: items: $ref: '#/components/schemas/Representative' type: array x-go-name: Representatives type: object x-go-package: github.com/wallester/api/model AddRepresentativesSwaggerRequest: properties: representatives: description: |- Representatives to be added.
At least 1 representative is always required for the company. items: $ref: '#/components/schemas/AddRepresentativeSwaggerModel' type: array x-go-name: Representatives required: - representatives type: object x-go-package: github.com/wallester/api/model Address: description: Address properties: country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: CountryCode address1: description: Address maxLength: 45 type: string x-go-name: Address1 address2: description: Address 2 maxLength: 45 type: string x-go-name: Address2 city: description: City maxLength: 35 type: string x-go-name: City postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode required: - country_code type: object x-go-package: github.com/wallester/api/model AdjustAccountBalanceRequest: title: AdjustAccountBalanceRequest represents adjust account balance request. properties: description: description: Description, change reason, etc. maxLength: 256 type: string x-go-name: Description external_id: description: External ID. Must be unique. maxLength: 50 type: string x-go-name: ExternalID amount: description: >- Amount to be added to or subtracted from account balance. Amount cannot be equal to 0. Resulting account balance cannot exceed credit limit of account or be negative. format: double maximum: 999000000 minimum: -999000000 type: number x-go-name: Amount sender_name: description: Sender name maxLength: 255 type: string x-go-name: SenderName allow_negative_balance: description: Allow negative balance type: boolean x-go-name: AllowNegativeBalance required: - amount - description type: object x-go-package: github.com/wallester/api/model AdjustAccountBalanceResponse: title: AdjustAccountBalanceResponse represents adjust account balance response. properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model AdjustAccountBalanceWithAdjustmentRequest: properties: description: description: Description, change reason, etc. maxLength: 256 type: string x-go-name: Description account_id: description: Account ID format: uuid4 type: string x-go-name: AccountID external_id: description: External ID maxLength: 50 type: string x-go-name: ExternalID amount: description: >- Amount to be added or subtracted to/from account balance. Amount cannot be equal to 0. format: double maximum: 999000000 minimum: -999000000 type: number x-go-name: Amount sender_name: description: Sender name maxLength: 255 type: string x-go-name: SenderName allow_negative_balance: description: Allow negative balance type: boolean x-go-name: AllowNegativeBalance required: - account_id - amount - description type: object x-go-package: github.com/wallester/api/model AdjustAccountBalanceWithAdjustmentResponse: properties: account_adjustment: $ref: '#/components/schemas/AccountAdjustment' type: object x-go-package: github.com/wallester/api/model AllowedCardDeliveryCountryCodesByProductIDResponse: properties: country_codes: items: type: string type: array x-go-name: CountryCodes type: object x-go-package: github.com/wallester/api/model ApplePayIncentiveNotificationIncompleteProvisioning: properties: data: $ref: '#/components/schemas/IncentiveNotification' event: description: Event identifier enum: - incentive_notification type: string x-go-name: Event type: description: Event type enum: - incomplete_provisioning type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ApplePayIncentiveNotificationSuccessfulTransaction: properties: data: $ref: '#/components/schemas/IncentiveNotification' event: description: Event identifier enum: - incentive_notification type: string x-go-name: Event type: description: Event type enum: - successful_transaction type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ApplePayOrangeFlow: properties: data: $ref: '#/components/schemas/ApplePayToken' event: description: Event identifier enum: - apple_pay_orange_flow type: string x-go-name: Event type: description: Event type enum: - token type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ApplePayPushProvisioningRequest: properties: certificates: description: >- Certificates is an array of certificates. Each element should contain the bytes of a DER encoded X.509 certificate. items: type: string type: array x-go-name: Certificates nonce: description: >- Nonce is a one time use nonce generated by Apple Servers. Base64 encoded. maxLength: 64 type: string x-go-name: Nonce nonce_signature: description: >- NonceSignature is a device and account specific signature of the nonce. Base64 encoded. maxLength: 128 type: string x-go-name: NonceSignature required: - certificates - nonce - nonce_signature type: object x-go-package: github.com/wallester/api/model ApplePayPushProvisioningResponse: title: >- ApplePayPushProvisioningResponse returns encrypted payload, ephemeral public key and cryptographic OTP for the Wallet. properties: encrypted_data: type: string x-go-name: EncryptedData activation_data: type: string x-go-name: ActivationData ephemeral_public_key: type: string x-go-name: EphemeralPublicKey type: object x-go-package: github.com/wallester/api/model ApplePayToken: properties: card_id: format: uuid4 type: string x-go-name: CardID id: format: uuid4 type: string x-go-name: ID required: - id - card_id type: object x-go-package: github.com/wallester/api/model/webhooks AssignedTo: properties: id: description: Admin user ID number format: int64 type: integer x-go-name: ID uuid: description: User ID format: uuid4 type: string x-go-name: UUID type: object x-go-package: github.com/wallester/api/model Authorization: title: Authorization represents an authorization data for a card. properties: id: description: ID of the authorization format: uuid4 type: string x-go-name: ID card_id: description: ID of the card by which the payment authorization is effected format: uuid4 type: string x-go-name: CardID date: description: Date-time in UTC when the payment authorization was effected format: date-time type: string x-go-name: Date expiration_date: description: >- Latest date by which the payment authorization must be cleared. If not cleared, the blocked amount for this payment authorization will be released format: date-time type: string x-go-name: ExpirationDate type: $ref: '#/components/schemas/AuthorizationType' transaction_amount: description: Original payment authorization amount at the point of sale format: double type: number x-go-name: TransactionAmount transaction_currency_code: description: >- Currency code in ISO-4217 format, original payment authorization currency at the point of sale enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode account_amount: description: >- Payment authorization amount converted to the Account currency for final settlement of the Account balance format: double type: number x-go-name: AccountAmount account_currency_code: description: >- Currency code in ISO-4217 format, currency of the Account to which the card that is the source of the payment authorization is linked enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode merchant_category_code: description: Merchant Category Code (MCC) type: string x-go-name: MerchantCategoryCode merchant_id: description: ID of the merchant type: string x-go-name: MerchantID terminal_id: description: Point of Sale (POS) terminal ID type: string x-go-name: TerminalID merchant_name: description: >- Merchant’s name identified in Visa system (can be different from the legal name) type: string x-go-name: MerchantName merchant_city: description: Merchant’s city name type: string x-go-name: MerchantCity merchant_country_code: description: Merchant's Country in ISO 3166-1 Alpha-3 format enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode response_code: description: >- Approval or any other responses given by Wallester as the result of authorization attempt type: string x-go-name: ResponseCode created_at: description: >- Date-time in UTC when the payment authorization object was created at Wallester system format: date-time type: string x-go-name: CreatedAt approved_amount: description: >- Is used in case the partial payment authorisation is required, e.g. on automatic tank stations format: double type: number x-go-name: ApprovedAmount approval_code: description: >- The code that links the transaction to the partial payment authorization type: string x-go-name: ApprovalCode reserved_amount: description: >- Original payment authorization amount at the point of sale in case the authorization was reverted by the merchant format: double type: number x-go-name: ReservedAmount threshold_amount: description: >- Foreign exchange reserve to cover the difference between the rate at the time of authorization of payment and at clearance of the transaction format: double type: number x-go-name: ThresholdAmount reversed_amount: description: Reversed amount format: double type: number x-go-name: ReversedAmount cleared_amount: description: >- Original payment authorization amount indicated in the Visa clearance report format: double type: number x-go-name: ClearedAmount balance: description: >- Balancing amount after clearing of the partial payment authorization (Balance = Approved amount - Reversed amount - Cleared amount) format: double type: number x-go-name: Balance group: $ref: '#/components/schemas/AuthorizationGroup' original_authorization_id: description: Payment authorization ID assigned by Visa format: uuid4 type: string x-go-name: OriginalAuthorizationID retrieval_reference_number: description: VISA payment authorization reference number type: string x-go-name: RetrievalReferenceNumber marked_for_dispute_at: description: >- Date-time in UTC when the authorization is accepted for dispute by Wallester format: date-time type: string x-go-name: MarkedForDisputeAt marked_for_dispute_by: description: Reference ID who marked authorization for dispute type: string x-go-name: MarkedForDisputeBy released_at: description: >- Date-time in UTC when the blocked amount based on the payment authorization is released due to payment authorization was not cleared for transaction or by any other reason format: date-time type: string x-go-name: ReleasedAt is_ready_for_manual_release: description: >- True means the payment authorization that was not cleared for the Transaction was manually released by the authorized Wallester officer type: boolean x-go-name: IsReadyForManualRelease release_reason: description: >- System information on the details of the release of the blocked amount type: string x-go-name: ReleaseReason is_reversal: description: >- True means the payment authorization was reverted (i.e. no cash out is expected), e.g. as the result of the return of purchases to the merchant type: boolean x-go-name: IsReversal is_declined: description: Indication of if the payment authorization is declined type: boolean x-go-name: IsDeclined is_contactless: description: >- Indication of if the payment authorization is effected as a result of contactless payment by the card type: boolean x-go-name: IsContactless is_mass_transit: description: >- True indicates that the payment authorization is effected in the public transportation and requires special handling type: boolean x-go-name: IsMassTransit token_id: description: >- Apple Pay or Google Pay token if the authorization is effected via a payment system format: uuid4 type: string x-go-name: TokenID is_3d_secure_used: description: Indication of if the payment authorization is confirmed by 3D-secure type: boolean x-go-name: Is3DSecureUsed is_pin_used: description: >- Indication of if the payment authorizations confirmed by the use of the card PIN type: boolean x-go-name: IsPINUsed fraud_result: $ref: '#/components/schemas/AuthorizationFraudResult' exchange_rate: description: Exchange rate format: double type: number x-go-name: ExchangeRate total_amount: description: Total amount format: double type: number x-go-name: TotalAmount type: object x-go-package: github.com/wallester/api/model AuthorizationAdditionalInfo: properties: card_presence: type: string x-go-name: CardPresence card_read_method: type: string x-go-name: CardReadMethod cardholder_presence: type: string x-go-name: CardholderPresence cardholder_verification_method: type: string x-go-name: CardholderVerificationMethod terminal_card_capture_capability: type: string x-go-name: TerminalCardCaptureCapability terminal_operating_environment: type: string x-go-name: TerminalOperatingEnvironment terminal_primary_authentication_method: type: string x-go-name: TerminalPrimaryAuthenticationMethod terminal_primary_card_read_method: type: string x-go-name: TerminalPrimaryCardReadMethod type: object x-go-package: github.com/wallester/api/model AuthorizationCard: properties: external_id: type: string x-go-name: ExternalID type: object x-go-package: github.com/wallester/api/model/webhooks AuthorizationFraudResult: description: AuthorizationFraudResult properties: risk_status: $ref: '#/components/schemas/FraudRiskStatus' risk_score: description: RiskScore format: int64 maximum: 100 minimum: 0 type: integer x-go-name: RiskScore risk_zone: $ref: '#/components/schemas/FraudRiskZone' type: object x-go-package: github.com/wallester/api/model AuthorizationGroup: title: Authorization group. enum: - Deposit - InternetPurchase - Other - PINManagement - Purchase - Refund - Withdraw type: string x-go-package: github.com/wallester/common/model AuthorizationType: title: Authorization type. enum: - ATMBalanceInquiry - ATMWithdrawal - AccountVerification - AutomatedFuelDispenser - AutomatedFuelDispenserConfirmation - CardToCardPaymentCredit - CardToCardPaymentDebit - CreditVoucherAndMerchandiseReturn - MOTOPurchase - ManualCashPurchase - PINChange - PINUnblock - POSPurchase - PurchaseWithCashback - QuasiCashPurchase - RecurringPayment - StatusCheck - UnattendedCardholderActivatedTerminal - Unknown - eCommercePurchase - payWaveHighValuePurchase - payWaveLowValuePurchase type: string x-go-package: github.com/wallester/common/model AuthorizationView: properties: data: $ref: '#/components/schemas/EventAuthorization' event: description: Event identifier enum: - notification type: string x-go-name: Event type: description: Event type enum: - authorization type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks AuthorizationWithEnrichedMerchant: allOf: - $ref: '#/components/schemas/Authorization' - properties: enriched_merchant_data: $ref: '#/components/schemas/EnrichedMerchantData' type: object x-go-package: github.com/wallester/api/model BatchDeliveryAddress: title: Card batch delivery address (required for physical cards). properties: first_name: description: First name maxLength: 50 type: string x-go-name: FirstName last_name: description: Last name maxLength: 50 type: string x-go-name: LastName company_name: description: Company name maxLength: 45 type: string x-go-name: CompanyName address1: description: Address maxLength: 45 type: string x-go-name: Address1 address2: description: 'Address #2' maxLength: 45 type: string x-go-name: Address2 postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode city: description: City maxLength: 35 type: string x-go-name: City country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: CountryCode dispatch_method: $ref: '#/components/schemas/BatchDispatchMethod' phone: description: Phone number type: string x-go-name: Phone required: - first_name - last_name - address1 - postal_code - city - country_code type: object x-go-package: github.com/wallester/api/model BatchDispatchMethod: title: Card batch dispatch method. enum: - BatchEconomy type: string x-go-package: github.com/wallester/common/model BatchRequestAction: description: BatchRequestAction represents the action of a batch request enum: - CreateAnonymous type: string x-go-package: github.com/wallester/common/model BatchRequestStatus: description: BatchRequestStatus represents the status of a batch request enum: - Failed - FailedRetryable - Finished - InProgress - New type: string x-go-package: github.com/wallester/common/model BlockCardEvent: properties: data: $ref: '#/components/schemas/BlockCardEventView' event: description: Event identifier enum: - block type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks BlockCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Blocked type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks BlockCardRequest: title: BlockCardRequest is a request to block credit card. properties: block_type: $ref: '#/components/schemas/APIBlockType' required: - block_type type: object x-go-package: github.com/wallester/api/model BlockCardResponse: title: BlockCardResponse is the response to the request to block a credit card. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model BlockCardsBatchRequest: title: BlockCardsBatchRequest is a request to block a batch of credit cards. properties: card_ids: description: Card IDs items: format: uuid4 type: string type: array x-go-name: CardIDs block_type: $ref: '#/components/schemas/APIBlockType' required: - card_ids - block_type type: object x-go-package: github.com/wallester/api/model BlockCardsBatchResponse: title: >- BlockCardsBatchResponse is the response to the request to block a batch of credit cards. properties: cards: items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards type: object x-go-package: github.com/wallester/api/model BlockType: title: Card block type. enum: - BlockedByCardUser - BlockedByCardholder - BlockedByCardholderViaPhone - BlockedByClient - BlockedByIssuer - Counterfeit - Fraudulent - Frozen - Lost - MaxInvalidTriesCVV2 - MaxInvalidTriesPIN - NotDelivered - Stolen type: string x-go-package: github.com/wallester/common/model CVV2Result: enum: - M - 'N' - P type: string x-go-package: github.com/wallester/common/model CancelFee: properties: data: $ref: '#/components/schemas/CancelFeeView' event: description: Event identifier enum: - cancel type: string x-go-name: Event type: description: Event type enum: - fee type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks CancelFeeView: properties: account_id: format: uuid4 type: string x-go-name: AccountID amount: format: double maximum: 0 type: number x-go-name: Amount authorization_id: format: uuid4 type: string x-go-name: AuthorizationID canceled_at: example: '1625932529' type: string x-go-name: CanceledAt canceled_reason: type: string x-go-name: CanceledReason card_id: format: uuid4 type: string x-go-name: CardID company_id: format: uuid4 type: string x-go-name: CompanyID completed_at: example: '1625932529' type: string x-go-name: CompletedAt created_at: example: '1625932529' type: string x-go-name: CreatedAt currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode id: format: uuid4 type: string x-go-name: ID person_id: format: uuid4 type: string x-go-name: PersonID status: enum: - Canceled type: string x-go-name: Status transaction_id: format: uuid4 type: string x-go-name: TransactionID type: $ref: '#/components/schemas/FeeType' updated_at: example: '1625932529' type: string x-go-name: UpdatedAt required: - id - type - status - amount - currency_code - account_id - created_at type: object x-go-package: github.com/wallester/api/model/webhooks Card: title: Card represents a card in the system. properties: security: $ref: '#/components/schemas/CardSecurity' id: description: Card ID format: uuid4 type: string x-go-name: ID predecessor_card_id: description: ID of the old card that has been replaced by this card format: uuid4 type: string x-go-name: PredecessorCardID account_id: description: ID of the Account where the card is linked to format: uuid4 type: string x-go-name: AccountID person_id: description: ID of the Person who owns the card format: uuid4 type: string x-go-name: PersonID external_id: description: External ID type: string x-go-name: ExternalID type: $ref: '#/components/schemas/APICardType' name: description: >- Non-unique name of the card assigned to it by the user for easier reference type: string x-go-name: Name masked_card_number: description: Truncated card number, e.g. 416548******0998 type: string x-go-name: MaskedCardNumber reference_number: description: >- Reserved for physical cards batch orders single reference for the order type: string x-go-name: ReferenceNumber expiry_date: description: Date-time in UTC when the card will expire. format: date-time type: string x-go-name: ExpiryDate block_type: $ref: '#/components/schemas/BlockType' blocked_at: description: >- Indicates the date starting from which the card is blocked for any reason. Apply if the card is currently blocked format: date-time type: string x-go-name: BlockedAt blocked_by: description: System information on the details of the card block type: string x-go-name: BlockedBy status: $ref: '#/components/schemas/CardStatus' embossing_name: description: >- Used if there is no EmbossingFirstName and EmbossingLastName. Any name of the card holder imprinted (embossed) on the card if any type: string x-go-name: EmbossingName embossing_first_name: description: >- Any first name of the card holder imprinted (embossed) on the card if any type: string x-go-name: EmbossingFirstName embossing_last_name: description: >- Any last name of the card holder imprinted (embossed) on the card if any type: string x-go-name: EmbossingLastName embossing_company_name: description: Any corporate name imprinted (embossed) on the card if any type: string x-go-name: EmbossingCompanyName limits: $ref: '#/components/schemas/CardLimitsWithUsage' 3d_secure_settings: $ref: '#/components/schemas/Card3DSecureSettings' delivery_address: $ref: '#/components/schemas/DeliveryAddress' is_enrolled_for_3d_secure: description: >- DEPRECATED States if 3D-secure identification should be used on the card transactions. By default, it is true type: boolean x-go-name: IsEnrolledFor3DSecure is_card_3d_secure_activated: description: |- DEPRECATED Is false only if the 3D-secure on the card is switched-off type: boolean x-go-name: IsCard3DSecureActivated renew_automatically: description: States if the card should be renewed after the expiration type: boolean x-go-name: RenewAutomatically is_disposable: description: >- If the is_disposable is true, the card is automatically closed after a single transaction irrespective of its amount type: boolean x-go-name: IsDisposable personalization_product_code: description: Reference to the prototype of the card design type: string x-go-name: PersonalizationProductCode carrier_type: $ref: '#/components/schemas/CarrierType' card_metadata_profile_id: description: Cards metadata of card tokens provided to mobile payment systems format: uuid4 type: string x-go-name: CardMetadataProfileID activated_at: description: >- Date-time in UTC when the transactions can be effected using the card. The card can be activated any time after it is created, irrespective of the delivery format: date-time type: string x-go-name: ActivatedAt created_at: description: Date-time in UTC when the card object was created format: date-time type: string x-go-name: CreatedAt updated_at: description: >- Date-time in UTC when the information on the card object was last updated format: date-time type: string x-go-name: UpdatedAt closed_at: description: Date-time in UTC when the card was closed format: date-time type: string x-go-name: ClosedAt closed_by: description: ID of the user who closed the card type: string x-go-name: ClosedBy close_reason: $ref: '#/components/schemas/CardCloseReason' company_id: description: ID of the Company where the card is linked to format: uuid4 type: string x-go-name: CompanyID dispatched_at: description: Date-time when the card was dispatched format: date-time type: string x-go-name: DispatchedAt type: object x-go-package: github.com/wallester/api/model Card3DSecureSettings: title: >- Card 3D Secure settings. Required for card activation and enabling of internet purchases in case product has 3D Secure enabled. description: >- At least one of the fields: mobile, email, out_of_band_enabled:true is required. properties: type: $ref: '#/components/schemas/APICard3DSecureType' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile language_code: $ref: '#/components/schemas/ACSLanguageCode' password: description: >- Password. Masked value returned if password is set.
Allowed to use characters: A-Z a-z 0-9 ! " # ; : ? * ( ) + = / \ , . [ ] { }. maxLength: 36 minLength: 8 type: string x-go-name: Password email: description: Email format: email maxLength: 255 type: string x-go-name: Email out_of_band_enabled: description: Out of Band enabled type: boolean x-go-name: OutOfBandEnabled out_of_band_id: description: Out of Band ID. Which basically is ID of User. format: uuid4 type: string x-go-name: OutOfBandID required: - password type: object x-go-package: github.com/wallester/api/model Card3DSecureType: title: Card 3D Secure type. enum: - SMSOTP - SMSOTPAndStaticPassword type: string x-go-package: github.com/wallester/common/model CardCloseReason: title: Card close reason. enum: - ClosedByCardholder - ClosedByClient - ClosedByIssuer - ClosedByRenewal - ClosedByReplace - ClosedBySystem type: string x-go-package: github.com/wallester/common/model CardDesign: properties: personalization_product_code: description: Personalization product code type: string x-go-name: PersonalizationProductCode image: description: Base64 encoded image type: string x-go-name: Image color_code: description: Color code in hex type: string x-go-name: ColorCode created_at: description: Date-time when card design was created format: date-time type: string x-go-name: CreatedAt created_by: description: Who created card design type: string x-go-name: CreatedBy updated_at: description: Date-time when card design was updated format: date-time type: string x-go-name: UpdatedAt updated_by: description: Who updated card design type: string x-go-name: UpdatedBy type: object x-go-package: github.com/wallester/api/model CardDesignUpdateInfo: properties: personalization_product_code: description: Personalization product code type: string x-go-name: PersonalizationProductCode created_at: description: Date-time when card design was created format: date-time type: string x-go-name: CreatedAt updated_at: description: Date-time when card design was updated format: date-time type: string x-go-name: UpdatedAt type: object x-go-package: github.com/wallester/api/model CardEventCard3DSecureSettings: properties: email: type: string x-go-name: Email mobile: type: string x-go-name: Mobile password: type: string x-go-name: Password type: object x-go-package: github.com/wallester/api/model/webhooks CardEventDeliveryAddress: properties: address1: type: string x-go-name: Address1 address2: type: string x-go-name: Address2 city: type: string x-go-name: City company_name: type: string x-go-name: CompanyName country_code: enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: CountryCode dispatch_method: $ref: '#/components/schemas/DispatchMethod' first_name: type: string x-go-name: FirstName last_name: type: string x-go-name: LastName phone: type: string x-go-name: Phone postal_code: type: string x-go-name: PostalCode tracking_number: type: string x-go-name: TrackingNumber required: - first_name - last_name - address1 - city - postal_code - country_code - dispatch_method type: object x-go-package: github.com/wallester/api/model/webhooks CardEventLimits: properties: daily_contactless_purchase: format: double type: number x-go-name: DailyContactlessPurchase daily_internet_purchase: format: double type: number x-go-name: DailyInternetPurchase daily_overall_purchase: format: double type: number x-go-name: DailyOverallPurchase daily_purchase: format: double type: number x-go-name: DailyPurchase daily_withdrawal: format: double type: number x-go-name: DailyWithdrawal monthly_contactless_purchase: format: double type: number x-go-name: MonthlyContactlessPurchase monthly_internet_purchase: format: double type: number x-go-name: MonthlyInternetPurchase monthly_overall_purchase: format: double type: number x-go-name: MonthlyOverallPurchase monthly_purchase: format: double type: number x-go-name: MonthlyPurchase monthly_withdrawal: format: double type: number x-go-name: MonthlyWithdrawal transaction_contactless_purchase: format: double type: number x-go-name: TransactionContactlessPurchase transaction_internet_purchase: format: double type: number x-go-name: TransactionInternetPurchase transaction_purchase: format: double type: number x-go-name: TransactionPurchase transaction_withdrawal: format: double type: number x-go-name: TransactionWithdrawal weekly_contactless_purchase: format: double type: number x-go-name: WeeklyContactlessPurchase weekly_internet_purchase: format: double type: number x-go-name: WeeklyInternetPurchase weekly_overall_purchase: format: double type: number x-go-name: WeeklyOverallPurchase weekly_purchase: format: double type: number x-go-name: WeeklyPurchase weekly_withdrawal: format: double type: number x-go-name: WeeklyWithdrawal type: object x-go-package: github.com/wallester/api/model/webhooks CardEventSecurity: properties: contactless_enabled: type: boolean x-go-name: ContactlessEnabled internet_purchase_enabled: type: boolean x-go-name: InternetPurchaseEnabled overall_limits_enabled: type: boolean x-go-name: OverallLimitsEnabled withdrawal_enabled: type: boolean x-go-name: WithdrawalEnabled type: object x-go-package: github.com/wallester/api/model/webhooks CardFee: title: CardFee represents card fee. properties: type: $ref: '#/components/schemas/FeeType' percentage_part: description: Percentage part format: double maximum: 100 minimum: 0 type: number x-go-name: PercentagePart fixed_part: description: Fixed part format: double maximum: 100000 minimum: 0 type: number x-go-name: FixedPart min_amount: description: Min amount format: double maximum: 100000 minimum: 0 type: number x-go-name: MinAmount required: - type type: object x-go-package: github.com/wallester/api/model CardFeeWaiver: properties: id: description: Waiver ID format: uuid4 type: string x-go-name: ID card_id: description: Card ID format: uuid4 type: string x-go-name: CardID limit_value: description: Limit amount format: double type: number x-go-name: LimitValue limit_value_used: description: Limit amount used format: double type: number x-go-name: LimitValueUsed limit_value_available: description: Limit amount available format: double type: number x-go-name: LimitValueAvailable waiver_type: $ref: '#/components/schemas/FeeWaiverType' authorization_type: $ref: '#/components/schemas/AuthorizationType' last_used_at: description: Last used at format: date-time type: string x-go-name: LastUsedAt created_at: description: Created at format: date-time type: string x-go-name: CreatedAt created_by: description: Created by type: string x-go-name: CreatedBy updated_at: description: Updated at format: date-time type: string x-go-name: UpdatedAt updated_by: description: Updated by type: string x-go-name: UpdatedBy deleted_at: description: Deleted at format: date-time type: string x-go-name: DeletedAt deleted_by: description: Deleted by type: string x-go-name: DeletedBy type: object x-go-package: github.com/wallester/api/model CardFeesBatch: properties: card_id: format: uuid4 type: string x-go-name: CardID card_fees: items: $ref: '#/components/schemas/RequestCardFee' type: array x-go-name: CardFees type: object x-go-package: github.com/wallester/api/model CardLimitUsage: properties: total: format: double type: number x-go-name: Total used: format: double type: number x-go-name: Used available: format: double type: number x-go-name: Available type: object x-go-package: github.com/wallester/api/model CardLimits: title: CardLimits represents daily, weekly, monthly and transaction limits. properties: daily_purchase: description: >- Daily purchase amount. Cannot exceed both MonthlyPurchase and product setting MaxCardDailyPurchaseLimit. When product setting WeeklyLimitsEnabled is true, then DailyPurchase cannot exceed WeeklyPurchase. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyPurchase daily_withdrawal: description: >- Daily withdrawal amount. Cannot exceed both MonthlyWithdrawal and product setting MaxCardDailyWithdrawalLimit. When product setting WeeklyLimitsEnabled is true, then DailyWithdrawal cannot exceed WeeklyWithdrawal. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyWithdrawal daily_internet_purchase: description: >- Daily internet purchase amount. Cannot exceed both MonthlyInternetPurchase and product setting MaxCardDailyInternetPurchaseLimit. When product setting WeeklyLimitsEnabled is true, then DailyInternetPurchase cannot exceed WeeklyInternetPurchase. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyInternetPurchase daily_contactless_purchase: description: >- Daily contactless purchase amount. Cannot exceed both MonthlyContactlessPurchase and product setting MaxCardDailyContactlessPurchaseLimit. When product setting WeeklyLimitsEnabled is true, then DailyContactlessPurchase cannot exceed WeeklyContactlessPurchase. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyContactlessPurchase weekly_purchase: description: >- Weekly purchase amount. Enabled when product setting WeeklyLimitsEnabled is true. Cannot exceed both MonthlyPurchase and product setting MaxCardWeeklyPurchaseLimit. When product setting WeeklyLimitsEnabled is false, then WeeklyPurchase becomes equal to MonthlyPurchase. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyPurchase weekly_withdrawal: description: >- Weekly withdrawal amount. Enabled when product setting WeeklyLimitsEnabled is true. Cannot exceed both MonthlyWithdrawal and product setting MaxCardWeeklyWithdrawalLimit. When product setting WeeklyLimitsEnabled is false, then WeeklyWithdrawal becomes equal to MonthlyWithdrawal. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyWithdrawal weekly_internet_purchase: description: >- Weekly internet purchase amount. Enabled when product setting WeeklyLimitsEnabled is true. Cannot exceed both MonthlyInternetPurchase and product setting MaxCardWeeklyInternetPurchaseLimit. When product setting WeeklyLimitsEnabled is false, then WeeklyInternetPurchase becomes equal to MonthlyInternetPurchase. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyInternetPurchase weekly_contactless_purchase: description: >- Weekly contactless purchase amount. Enabled when product setting WeeklyLimitsEnabled is true. Cannot exceed both MonthlyContactlessPurchase and product setting MaxCardWeeklyContactlessPurchaseLimit. When product setting WeeklyLimitsEnabled is false, then WeeklyContactlessPurchase becomes equal to MonthlyContactlessPurchase. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyContactlessPurchase monthly_purchase: description: >- Monthly purchase amount. Cannot exceed product setting MaxCardMonthlyPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyPurchase monthly_withdrawal: description: >- Monthly withdrawal amount. Cannot exceed product setting MaxCardMonthlyWithdrawalLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyWithdrawal monthly_internet_purchase: description: >- Monthly internet purchase amount. Cannot exceed product setting MaxCardMonthlyInternetPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyInternetPurchase monthly_contactless_purchase: description: >- Monthly contactless purchase amount. Cannot exceed product setting MaxCardMonthlyContactlessPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyContactlessPurchase transaction_purchase: description: >- Transaction purchase amount. Cannot exceed both DailyPurchase and product setting MaxCardDailyPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: TransactionPurchase transaction_withdrawal: description: >- Transaction withdrawal amount. Cannot exceed both DailyWithdrawal and product setting MaxCardTransactionWithdrawalLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: TransactionWithdrawal transaction_internet_purchase: description: >- Transaction internet purchase amount. Cannot exceed both DailyInternetPurchase and product setting MaxCardTransactionInternetPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: TransactionInternetPurchase transaction_contactless_purchase: description: >- Transaction contactless purchase amount. Cannot exceed both DailyContactlessPurchase and product setting MaxCardTransactionContactlessPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: TransactionContactlessPurchase daily_overall_purchase: description: Daily overall purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyOverallPurchase weekly_overall_purchase: description: Weekly overall purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyOverallPurchase monthly_overall_purchase: description: Monthly overall purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyOverallPurchase all_time_purchase: description: >- All time purchase amount. Permanent limit which does not reset over time. Cannot be enabled together with other limit types. Cannot exceed product setting MaxCardAllTimePurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: AllTimePurchase all_time_withdrawal: description: >- All time withdrawal amount. Permanent limit which does not reset over time. Cannot be enabled together with other limit types. Cannot exceed product setting MaxCardAllTimeWithdrawalLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: AllTimeWithdrawal all_time_internet_purchase: description: >- All time internet purchase amount. Permanent limit which does not reset over time. Cannot be enabled together with other limit types. Cannot exceed product setting MaxCardAllTimeInternetPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: AllTimeInternetPurchase all_time_contactless_purchase: description: >- All time contactless purchase amount. Permanent limit which does not reset over time. Cannot be enabled together with other limit types. Cannot exceed product setting MaxCardAllTimeContactlessPurchaseLimit. format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: AllTimeContactlessPurchase type: object x-go-package: github.com/wallester/api/model CardLimitsByProductIDResponse: properties: default_card_daily_contactless_purchase_limit: format: double type: number x-go-name: DefaultCardDailyContactlessPurchaseLimit default_card_daily_internet_purchase_limit: format: double type: number x-go-name: DefaultCardDailyInternetPurchaseLimit default_card_daily_purchase_limit: format: double type: number x-go-name: DefaultCardDailyPurchaseLimit default_card_daily_withdrawal_limit: format: double type: number x-go-name: DefaultCardDailyWithdrawalLimit default_card_weekly_contactless_purchase_limit: format: double type: number x-go-name: DefaultCardWeeklyContactlessPurchaseLimit default_card_weekly_internet_purchase_limit: format: double type: number x-go-name: DefaultCardWeeklyInternetPurchaseLimit default_card_weekly_purchase_limit: format: double type: number x-go-name: DefaultCardWeeklyPurchaseLimit default_card_weekly_withdrawal_limit: format: double type: number x-go-name: DefaultCardWeeklyWithdrawalLimit default_card_monthly_contactless_purchase_limit: format: double type: number x-go-name: DefaultCardMonthlyContactlessPurchaseLimit default_card_monthly_internet_purchase_limit: format: double type: number x-go-name: DefaultCardMonthlyInternetPurchaseLimit default_card_monthly_purchase_limit: format: double type: number x-go-name: DefaultCardMonthlyPurchaseLimit default_card_monthly_withdrawal_limit: format: double type: number x-go-name: DefaultCardMonthlyWithdrawalLimit default_card_transaction_contactless_purchase_limit: format: double type: number x-go-name: DefaultCardTransactionContactlessPurchaseLimit default_card_transaction_internet_purchase_limit: format: double type: number x-go-name: DefaultCardTransactionInternetPurchaseLimit default_card_transaction_purchase_limit: format: double type: number x-go-name: DefaultCardTransactionPurchaseLimit default_card_transaction_withdrawal_limit: format: double type: number x-go-name: DefaultCardTransactionWithdrawalLimit max_card_daily_contactless_purchase_limit: format: double type: number x-go-name: MaxCardDailyContactlessPurchaseLimit max_card_daily_internet_purchase_limit: format: double type: number x-go-name: MaxCardDailyInternetPurchaseLimit max_card_daily_purchase_limit: format: double type: number x-go-name: MaxCardDailyPurchaseLimit max_card_daily_withdrawal_limit: format: double type: number x-go-name: MaxCardDailyWithdrawalLimit max_card_weekly_contactless_purchase_limit: format: double type: number x-go-name: MaxCardWeeklyContactlessPurchaseLimit max_card_weekly_internet_purchase_limit: format: double type: number x-go-name: MaxCardWeeklyInternetPurchaseLimit max_card_weekly_purchase_limit: format: double type: number x-go-name: MaxCardWeeklyPurchaseLimit max_card_weekly_withdrawal_limit: format: double type: number x-go-name: MaxCardWeeklyWithdrawalLimit max_card_monthly_contactless_purchase_limit: format: double type: number x-go-name: MaxCardMonthlyContactlessPurchaseLimit max_card_monthly_internet_purchase_limit: format: double type: number x-go-name: MaxCardMonthlyInternetPurchaseLimit max_card_monthly_purchase_limit: format: double type: number x-go-name: MaxCardMonthlyPurchaseLimit max_card_monthly_withdrawal_limit: format: double type: number x-go-name: MaxCardMonthlyWithdrawalLimit max_card_transaction_contactless_purchase_limit: format: double type: number x-go-name: MaxCardTransactionContactlessPurchaseLimit max_card_transaction_internet_purchase_limit: format: double type: number x-go-name: MaxCardTransactionInternetPurchaseLimit max_card_transaction_purchase_limit: format: double type: number x-go-name: MaxCardTransactionPurchaseLimit max_card_transaction_withdrawal_limit: format: double type: number x-go-name: MaxCardTransactionWithdrawalLimit default_card_daily_overall_purchase_limit: format: double type: number x-go-name: DefaultCardDailyOverallPurchaseLimit max_card_daily_overall_purchase_limit: format: double type: number x-go-name: MaxCardDailyOverallPurchaseLimit default_card_weekly_overall_purchase_limit: format: double type: number x-go-name: DefaultCardWeeklyOverallPurchaseLimit max_card_weekly_overall_purchase_limit: format: double type: number x-go-name: MaxCardWeeklyOverallPurchaseLimit default_card_monthly_overall_purchase_limit: format: double type: number x-go-name: DefaultCardMonthlyOverallPurchaseLimit max_card_monthly_overall_purchase_limit: format: double type: number x-go-name: MaxCardMonthlyOverallPurchaseLimit weekly_limits_enabled: type: boolean x-go-name: WeeklyLimitsEnabled all_time_limits_enabled: type: boolean x-go-name: AllTimeLimitsEnabled default_card_all_time_contactless_purchase_limit: format: double type: number x-go-name: DefaultCardAllTimeContactlessPurchaseLimit default_card_all_time_internet_purchase_limit: format: double type: number x-go-name: DefaultCardAllTimeInternetPurchaseLimit default_card_all_time_purchase_limit: format: double type: number x-go-name: DefaultCardAllTimePurchaseLimit default_card_all_time_withdrawal_limit: format: double type: number x-go-name: DefaultCardAllTimeWithdrawalLimit max_card_all_time_contactless_purchase_limit: format: double type: number x-go-name: MaxCardAllTimeContactlessPurchaseLimit max_card_all_time_internet_purchase_limit: format: double type: number x-go-name: MaxCardAllTimeInternetPurchaseLimit max_card_all_time_purchase_limit: format: double type: number x-go-name: MaxCardAllTimePurchaseLimit max_card_all_time_withdrawal_limit: format: double type: number x-go-name: MaxCardAllTimeWithdrawalLimit type: object x-go-package: github.com/wallester/api/model CardLimitsWithUsage: allOf: - $ref: '#/components/schemas/CardLimits' - properties: all_time_contactless_purchase_available: description: All time contactless purchase available amount format: double type: number x-go-name: AllTimeContactlessPurchaseAvailable all_time_contactless_purchase_used: description: All time contactless purchase used amount format: double type: number x-go-name: AllTimeContactlessPurchaseUsed all_time_internet_purchase_available: description: All time internet purchase available amount format: double type: number x-go-name: AllTimeInternetPurchaseAvailable all_time_internet_purchase_used: description: All time internet purchase used amount format: double type: number x-go-name: AllTimeInternetPurchaseUsed all_time_purchase_available: description: All time purchase available amount format: double type: number x-go-name: AllTimePurchaseAvailable all_time_purchase_used: description: All time purchase used amount format: double type: number x-go-name: AllTimePurchaseUsed all_time_withdrawal_available: description: All time withdrawal available amount format: double type: number x-go-name: AllTimeWithdrawalAvailable all_time_withdrawal_used: description: All time withdrawal used amount format: double type: number x-go-name: AllTimeWithdrawalUsed daily_contactless_purchase_available: description: Daily contactless purchase available amount format: double type: number x-go-name: DailyContactlessPurchaseAvailable daily_contactless_purchase_used: description: Daily contactless purchase used amount format: double type: number x-go-name: DailyContactlessPurchaseUsed daily_internet_purchase_available: description: Daily internet purchase available amount format: double type: number x-go-name: DailyInternetPurchaseAvailable daily_internet_purchase_used: description: Daily internet purchase used amount format: double type: number x-go-name: DailyInternetPurchaseUsed daily_overall_purchase_available: description: Daily overall purchase available amount format: double type: number x-go-name: DailyOverallPurchaseAvailable daily_overall_purchase_used: description: Daily overall purchase used amount format: double type: number x-go-name: DailyOverallPurchaseUsed daily_purchase_available: description: Daily purchase available amount format: double type: number x-go-name: DailyPurchaseAvailable daily_purchase_used: description: Daily purchase used amount format: double type: number x-go-name: DailyPurchaseUsed daily_withdrawal_available: description: Daily withdrawal available amount format: double type: number x-go-name: DailyWithdrawalAvailable daily_withdrawal_used: description: Daily withdrawal used amount format: double type: number x-go-name: DailyWithdrawalUsed monthly_contactless_purchase_available: description: Monthly contactless purchase available amount format: double type: number x-go-name: MonthlyContactlessPurchaseAvailable monthly_contactless_purchase_used: description: Monthly contactless purchase used amount format: double type: number x-go-name: MonthlyContactlessPurchaseUsed monthly_internet_purchase_available: description: Monthly internet purchase available amount format: double type: number x-go-name: MonthlyInternetPurchaseAvailable monthly_internet_purchase_used: description: Monthly internet purchase used amount format: double type: number x-go-name: MonthlyInternetPurchaseUsed monthly_overall_purchase_available: description: Monthly overall purchase available amount format: double type: number x-go-name: MonthlyOverallPurchaseAvailable monthly_overall_purchase_used: description: Monthly overall purchase used amount format: double type: number x-go-name: MonthlyOverallPurchaseUsed monthly_purchase_available: description: Monthly purchase available amount format: double type: number x-go-name: MonthlyPurchaseAvailable monthly_purchase_used: description: Monthly purchase used amount format: double type: number x-go-name: MonthlyPurchaseUsed monthly_withdrawal_available: description: Monthly withdrawal available amount format: double type: number x-go-name: MonthlyWithdrawalAvailable monthly_withdrawal_used: description: Monthly withdrawal used amount format: double type: number x-go-name: MonthlyWithdrawalUsed weekly_contactless_purchase_available: description: Weekly contactless purchase available amount format: double type: number x-go-name: WeeklyContactlessPurchaseAvailable weekly_contactless_purchase_used: description: Weekly contactless purchase used amount format: double type: number x-go-name: WeeklyContactlessPurchaseUsed weekly_internet_purchase_available: description: Weekly internet purchase available amount format: double type: number x-go-name: WeeklyInternetPurchaseAvailable weekly_internet_purchase_used: description: Weekly internet purchase used amount format: double type: number x-go-name: WeeklyInternetPurchaseUsed weekly_overall_purchase_available: description: Weekly overall purchase available amount format: double type: number x-go-name: WeeklyOverallPurchaseAvailable weekly_overall_purchase_used: description: Weekly overall purchase used amount format: double type: number x-go-name: WeeklyOverallPurchaseUsed weekly_purchase_available: description: Weekly purchase available amount format: double type: number x-go-name: WeeklyPurchaseAvailable weekly_purchase_used: description: Weekly purchase used amount format: double type: number x-go-name: WeeklyPurchaseUsed weekly_withdrawal_available: description: Weekly withdrawal available amount format: double type: number x-go-name: WeeklyWithdrawalAvailable weekly_withdrawal_used: description: Weekly withdrawal used amount format: double type: number x-go-name: WeeklyWithdrawalUsed type: object x-go-package: github.com/wallester/api/model CardMerchantRule: title: CardMerchantRule represents card merchant rule. properties: id: description: ID format: uuid4 type: string x-go-name: ID card_id: description: Card ID format: uuid4 type: string x-go-name: CardID type: $ref: '#/components/schemas/CardMerchantRuleType' value: description: Merchant rule value. Depends on type. type: string x-go-name: Value is_whitelist: description: Is rule a whitelist type: boolean x-go-name: IsWhiteList created_at: description: Date-time the card rule was created at format: date-time type: string x-go-name: CreatedAt created_by: description: Created by type: string x-go-name: CreatedBy required: - card_id - type - value - is_whitelist type: object x-go-package: github.com/wallester/api/model CardMerchantRuleFields: title: CardMerchantRuleFields represents card merchant rule fields. properties: type: $ref: '#/components/schemas/CardMerchantRuleType' value: description: >- Merchant rule value.
For rule type MerchantCountryCode ISO 3166-1 Alpha-3 code standard is accepted.
For rule type MerchantCategoryCode ISO 18245 code standard is accepted. type: string x-go-name: Value is_whitelist: description: Is rule a whitelist type: boolean x-go-name: IsWhiteList required: - type - value - is_whitelist type: object x-go-package: github.com/wallester/api/model CardMerchantRuleType: enum: - MerchantCategoryCode - MerchantCountryCode type: string x-go-package: github.com/wallester/common/model CardOwner: properties: id: description: Card owner ID format: uuid4 type: string x-go-name: ID name: description: Company name or Person first name and last name type: string x-go-name: Name type: $ref: '#/components/schemas/CardOwnerType' fraud_cases_count: description: Card owner fraud cases count format: int64 type: integer x-go-name: FraudCasesCount type: object x-go-package: github.com/wallester/api/model CardOwnerType: enum: - Company - Person type: string x-go-package: github.com/wallester/common/model CardSecurity: title: Card Security settings. properties: contactless_enabled: description: Contactless enabled type: boolean x-go-name: ContactlessEnabled withdrawal_enabled: description: Withdrawal enabled type: boolean x-go-name: WithdrawalEnabled internet_purchase_enabled: description: Internet purchase enabled type: boolean x-go-name: InternetPurchaseEnabled overall_limits_enabled: description: >- Overall limits enabled. Cannot be enabled together with all time limits. type: boolean x-go-name: OverallLimitsEnabled all_time_limits_enabled: description: >- All time limits enabled. Cannot be enabled together with overall limits. type: boolean x-go-name: AllTimeLimitsEnabled type: object x-go-package: github.com/wallester/api/model CardStatementRecord: title: CardStatementRecord represents a card statement record. properties: description: description: Description (used for account adjustments) type: string x-go-name: Description id: description: Record ID format: uuid4 type: string x-go-name: ID card_id: description: Card ID to which this record belongs to format: uuid4 type: string x-go-name: CardID type: $ref: '#/components/schemas/CardStatementRecordType' group: $ref: '#/components/schemas/CardStatementRecordGroup' date: description: Date-time the record was made format: date-time type: string x-go-name: Date transaction_amount: description: Transaction amount format: double type: number x-go-name: TransactionAmount transaction_currency_code: description: Transaction currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode account_amount: description: Account amount format: double type: number x-go-name: AccountAmount account_currency_code: description: Account currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode merchant_category_code: description: Merchant category code type: string x-go-name: MerchantCategoryCode merchant_id: description: Merchant ID type: string x-go-name: MerchantID terminal_id: description: Terminal ID type: string x-go-name: TerminalID merchant_name: description: Merchant name type: string x-go-name: MerchantName merchant_city: description: Merchant city type: string x-go-name: MerchantCity merchant_country_code: description: Merchant country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode original_authorization_id: description: >- Authorization ID (used for transactions and authorization reversals to link with original authorization) format: uuid4 type: string x-go-name: OriginalAuthorizationID is_reversal: description: Shows whether this is reversal authorization or not type: boolean x-go-name: IsReversal is_declined: description: Shows whether this is declined authorization or not type: boolean x-go-name: IsDeclined is_cleared: description: Shows whether this is cleared authorization or not type: boolean x-go-name: IsCleared marked_for_dispute_at: description: Date-time the transaction was marked for dispute format: date-time type: string x-go-name: MarkedForDisputeAt marked_for_dispute_by: description: Marked for dispute by type: string x-go-name: MarkedForDisputeBy status: $ref: '#/components/schemas/CardStatementRecordStatus' response: $ref: '#/components/schemas/CardStatementRecordResponse' response_code: description: Response Code type: string x-go-name: ResponseCode account_external_id: description: Account external ID type: string x-go-name: AccountExternalID masked_card_number: description: Masked card number type: string x-go-name: MaskedCardNumber has_payment_document_files: description: Shows whether this record has payment document files type: boolean x-go-name: HasPaymentDocumentFiles card_name: description: Card name type: string x-go-name: CardName sub_type: description: Sub type type: string x-go-name: SubType purchase_date: description: Date-time the payment was done format: date-time type: string x-go-name: PurchaseDate exchange_rate: description: Exchange rate format: double type: number x-go-name: ExchangeRate enriched_merchant_data: $ref: '#/components/schemas/EnrichedMerchantData' total_amount: description: Total amount format: double type: number x-go-name: TotalAmount type: object x-go-package: github.com/wallester/api/model CardStatementRecordGroup: title: Card statement record group. enum: - AuthorizationATMBalanceInquiryFixedFee - AuthorizationATMDeclinedFixedFee - AuthorizationATMWithdrawalComplexFee - AuthorizationATMWithdrawalFixedFee - AuthorizationATMWithdrawalPercentageFee - AuthorizationDeclinedFixedFee - AuthorizationForeignExchangePercentageFee - CardIssuanceFixedFee - CardReplacementFixedFee - CardUsageFixedFee - Deposit - InternetPurchase - Other - PINChangeFixedFee - PINManagement - Purchase - Refund - Withdraw type: string x-go-package: github.com/wallester/common/model CardStatementRecordResponse: title: Card statement record response. enum: - Approved - Declined type: string x-go-package: github.com/wallester/common/model CardStatementRecordStatus: title: Card statement record status. enum: - Canceled - Completed - Pending type: string x-go-package: github.com/wallester/common/model CardStatementRecordType: title: Card statement record type. enum: - Authorization - Fee - Transaction type: string x-go-package: github.com/wallester/common/model CardStatementSubType: title: >- CardStatementSubType represents card statement sub type, for fee type records, it shows the fee type, for the transactions and authorizations it is empty. enum: - AccountTransferFee - AdditionalBINConfigurationFee - AdditionalBINMaintenanceFee - AdditionalVirtualCardsFee - AuthorizationATMBalanceInquiryFixedFee - AuthorizationATMDeclinedFixedFee - AuthorizationATMWithdrawalComplexFee - AuthorizationATMWithdrawalEEAComplexFee - AuthorizationATMWithdrawalFixedFee - AuthorizationATMWithdrawalInternationalComplexFee - AuthorizationATMWithdrawalPercentageFee - AuthorizationDeclinedFixedFee - AuthorizationEEAFixedFee - AuthorizationForeignExchangePercentageFee - AuthorizationInternationalFixedFee - AvailableFundsRefundFee - CardDeliveryFixedFee - CardExpressDeliveryFixedFee - CardIssuanceFixedFee - CardRenewalFixedFee - CardReplacementFixedFee - CardUsageFixedFee - ChargebackProcessingFee - DedicatedBINRangeFee - ExclusiveBINFee - ExclusiveSharedBINFee - IncomingSEPAPaymentFixedFee - IncomingSEPAPaymentPercentageFee - IndustryFee - MerchantWhitelistFee - MonthlyFeePerEmployee - MonthlyServiceFee - NewEmployeeAdditionFee - OtherAdministrativeRequestFee - PINChangeFixedFee - PaymentEEAComplexFee - PaymentEEAFixedFee - PaymentInternationalComplexFee - PaymentInternationalFixedFee - PaymentPercentageFee - PricingPlanFee - Remind3DSPasswordFixedFee - RemindPINFixedFee - SharedBINRangeFee - ZeroAuthorizationEEAFixedFee - ZeroAuthorizationInternationalFixedFee type: string x-go-package: github.com/wallester/common/model CardStatus: title: Card status. enum: - Active - AwaitingRenewal - Blocked - Closed - Closing - Created - Dispatched - Expired - Ordered - Personalized type: string x-go-package: github.com/wallester/common/model CardType: title: Card type. enum: - ChipAndPin - ChipAndPinAnonymous - Sticker - Virtual type: string x-go-package: github.com/wallester/common/model Cardholder3DSSettings: description: Cardholder3DSSettings properties: id: description: ID format: uuid4 type: string x-go-name: ID product_id: description: ProductID format: uuid4 type: string x-go-name: ProductID person_id: description: PersonID format: uuid4 type: string x-go-name: PersonID company_id: description: CompanyID format: uuid4 type: string x-go-name: CompanyID email: description: Email maxLength: 255 type: string x-go-name: Email mobile: description: Mobile type: string x-go-name: Mobile password: description: Password type: string x-go-name: Password force_usage: description: ForceUsage type: boolean x-go-name: ForceUsage card_default_settings: description: CardDefaultSettings type: boolean x-go-name: CardDefaultSettings type: object x-go-package: github.com/wallester/api/model CardholderReminderResponse: title: CardholderReminderResponse represents a cardholder reminder response. properties: success: type: boolean x-go-name: Success type: object x-go-package: github.com/wallester/api/model CardsBlockLog: properties: id: description: ID format: uuid4 type: string x-go-name: ID mobile_number: description: Mobile Number type: string x-go-name: MobileNumber language_code: description: Language Code type: string x-go-name: LanguageCode call_time: $ref: '#/components/schemas/DateTime' type: object x-go-package: github.com/wallester/api/model CardsDispatchMethodItem: properties: description: type: string x-go-name: Description dispatch_method: $ref: '#/components/schemas/DispatchMethod' price: format: double type: number x-go-name: Price delivery_time: $ref: '#/components/schemas/DeliveryTime' type: object x-go-package: github.com/wallester/api/model CardsDispatchMethodsResponse: properties: dispatch_methods: items: $ref: '#/components/schemas/CardsDispatchMethodItem' type: array x-go-name: DispatchMethods type: object x-go-package: github.com/wallester/api/model CarrierType: enum: - Custom - Standard type: string x-go-package: github.com/wallester/common/model ChangeCardPINRequest: title: ChangeCardPINRequest represents change card PIN request. properties: encrypted_pin: description: Encrypted PIN - base64 encoded type: string x-go-name: EncryptedPIN required: - encrypted_pin type: object x-go-package: github.com/wallester/api/model CloseAccountRequest: title: CloseAccountRequest is a request to close account. properties: close_reason: $ref: '#/components/schemas/AccountCloseReason' required: - close_reason type: object x-go-package: github.com/wallester/api/model CloseAccountResponse: title: CloseAccountResponse represents cloase account response. properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model CloseCardRequest: title: CloseCardRequest is a request to close card. properties: close_reason: $ref: '#/components/schemas/APIModelCardCloseReason' required: - close_reason type: object x-go-package: github.com/wallester/api/model CloseCardResponse: title: CloseCardResponse is the response to the request to close a card. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model CloseCardsBatchRequest: title: CloseCardsBatchRequest is a request to close cards batch. properties: card_ids: description: Card IDs items: format: uuid4 type: string type: array x-go-name: CardIDs close_reason: $ref: '#/components/schemas/APIModelCardCloseReason' required: - card_ids - close_reason type: object x-go-package: github.com/wallester/api/model CloseCardsBatchResponse: title: >- CloseCardsBatchResponse is the response to the request to close a number of cards. properties: cards: items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards type: object x-go-package: github.com/wallester/api/model ClosedCardEvent: properties: data: $ref: '#/components/schemas/ClosedCardEventView' event: description: Event identifier enum: - close type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ClosedCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Closed type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks ClosingCardEvent: properties: data: $ref: '#/components/schemas/ClosingCardEventView' event: description: Event identifier enum: - closing type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ClosingCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Closing type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks Company: properties: id: description: Company ID format: uuid4 type: string x-go-name: ID name: description: Company name type: string x-go-name: Name registration_number: description: Registration number type: string x-go-name: RegistrationNumber registration_address: $ref: '#/components/schemas/Address' headquarter_address: $ref: '#/components/schemas/Address' risk_profile: $ref: '#/components/schemas/RiskProfile' mobile: description: Mobile type: string x-go-name: Mobile email: description: Email format: email type: string x-go-name: Email created_at: description: Created at format: date-time type: string x-go-name: CreatedAt created_by: description: Created by type: string x-go-name: CreatedBy updated_at: description: Updated at format: date-time type: string x-go-name: UpdatedAt updated_by: description: Updated by type: string x-go-name: UpdatedBy deleted_at: description: Deleted at format: date-time type: string x-go-name: DeletedAt deleted_by: description: Deleted by type: string x-go-name: DeletedBy industry_type: description: Industry Type type: string x-go-name: IndustryType date_of_incorporation: description: Date Of Incorporation format: date-time type: string x-go-name: DateOfIncorporation business_relationship_purpose: description: Business Relationship Purpose type: string x-go-name: BusinessRelationshipPurpose is_sanctions_related: description: Is Sanctions Related type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: Is Adverse Media Involved type: boolean x-go-name: IsAdverseMediaInvolved employees_quantity: description: Employees Quantity type: string x-go-name: EmployeesQuantity card_spending_amount: description: Card Spending Amount type: string x-go-name: CardSpendingAmount limits: $ref: '#/components/schemas/CompanyLimits' kyb_status: $ref: '#/components/schemas/KYBStatus' status: $ref: '#/components/schemas/CompanyStatus' push_notifications_enabled: description: Is push notifications enabled type: boolean x-go-name: PushNotificationsEnabled preferred_language_code: $ref: '#/components/schemas/LanguageCode' vat_number: description: VAT Number type: string x-go-name: VATNumber type: object x-go-package: github.com/wallester/api/model Company3DSSettingsResponse: description: Person3DSSettingsResponse properties: id: description: ID format: uuid4 type: string x-go-name: ID company_id: description: Company ID format: uuid4 type: string x-go-name: CompanyID email: description: Email type: string x-go-name: Email mobile: description: Mobile type: string x-go-name: Mobile password: description: Password type: string x-go-name: Password force_usage: description: ForceUsage type: boolean x-go-name: ForceUsage card_default_settings: description: CardDefaultSettings type: boolean x-go-name: CardDefaultSettings type: object x-go-package: github.com/wallester/api/model CompanyCorporateDocument: properties: id: description: Document ID format: uuid4 type: string x-go-name: ID company_id: description: Company ID format: uuid4 type: string x-go-name: CompanyID type: description: Document type enum: - RegistrationIncorporationCertificate - BeneficialOwnersCertificate type: string x-go-name: Type file_name: description: File name type: string x-go-name: FileName file_size: description: File size format: int64 type: integer x-go-name: FileSize file_mime_type: description: File mime type type: string x-go-name: FileMimeType created_at: description: Created at format: date-time type: string x-go-name: CreatedAt created_by: description: Created by type: string x-go-name: CreatedBy type: object x-go-package: github.com/wallester/api/model CompanyFCMToken: properties: id: description: FCM Token ID format: uuid4 type: string x-go-name: ID device_id: description: Device ID type: string x-go-name: DeviceID fcm_token: description: FCM Token type: string x-go-name: FCMToken push_notifications_enabled: description: Push notifications enabled type: boolean x-go-name: PushNotificationsEnabled created_at: description: Created at format: date-time type: string x-go-name: CreatedAt created_by: description: Created by type: string x-go-name: CreatedBy updated_at: description: Updated at format: date-time type: string x-go-name: UpdatedAt updated_by: description: Updated by type: string x-go-name: UpdatedBy type: object x-go-package: github.com/wallester/api/model CompanyLimits: properties: daily_purchase: description: Daily purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyPurchase daily_withdrawal: description: Daily withdrawal amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyWithdrawal daily_internet_purchase: description: Daily internet purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyInternetPurchase daily_contactless_purchase: description: Daily contactless purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: DailyContactlessPurchase weekly_purchase: description: Weekly purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyPurchase weekly_withdrawal: description: Weekly withdrawal amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyWithdrawal weekly_internet_purchase: description: Weekly internet purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyInternetPurchase weekly_contactless_purchase: description: Weekly contactless purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: WeeklyContactlessPurchase monthly_purchase: description: Monthly purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyPurchase monthly_withdrawal: description: Monthly withdrawal amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyWithdrawal monthly_internet_purchase: description: Monthly internet purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyInternetPurchase monthly_contactless_purchase: description: Monthly contactless purchase amount format: double maximum: 9999999.99 minimum: 0 type: number x-go-name: MonthlyContactlessPurchase type: object x-go-package: github.com/wallester/api/model CompanyStatus: title: Company status. enum: - Active - Deactivated - Frozen type: string x-go-package: github.com/wallester/common/model CompleteFee: properties: data: $ref: '#/components/schemas/CompleteFeeView' event: description: Event identifier enum: - complete type: string x-go-name: Event type: description: Event type enum: - fee type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks CompleteFeeView: properties: account_id: format: uuid4 type: string x-go-name: AccountID amount: format: double maximum: 0 type: number x-go-name: Amount authorization_id: format: uuid4 type: string x-go-name: AuthorizationID canceled_at: example: '1625932529' type: string x-go-name: CanceledAt canceled_reason: type: string x-go-name: CanceledReason card_id: format: uuid4 type: string x-go-name: CardID company_id: format: uuid4 type: string x-go-name: CompanyID completed_at: example: '1625932529' type: string x-go-name: CompletedAt created_at: example: '1625932529' type: string x-go-name: CreatedAt currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode id: format: uuid4 type: string x-go-name: ID person_id: format: uuid4 type: string x-go-name: PersonID status: enum: - Completed - Canceled type: string x-go-name: Status transaction_id: format: uuid4 type: string x-go-name: TransactionID type: $ref: '#/components/schemas/FeeType' updated_at: example: '1625932529' type: string x-go-name: UpdatedAt required: - id - type - status - amount - currency_code - account_id - created_at type: object x-go-package: github.com/wallester/api/model/webhooks ConsumerEntryMode: enum: - CAMERA_CAPTURED - KEY_ENTERED - UNKNOWN type: string x-go-package: github.com/wallester/common/model CorporateDocumentFile: properties: Body: items: format: uint8 type: integer type: array Name: type: string type: object x-go-package: github.com/wallester/api/model CorporateDocumentType: title: Corporate document type. enum: - BeneficialOwnersCertificate - LatestFinancialReport - Other - RegistrationIncorporationCertificate type: string x-go-package: github.com/wallester/common/model CorporateDocumentVerificationStatus: title: Corporate document verification status. enum: - Approved - PendingApproval - Rejected - Required - Uploaded type: string x-go-package: github.com/wallester/common/model CreateAccountPaymentRequest: title: CreateAccountPaymentRequest represents account payment request. properties: description: description: Description maxLength: 256 type: string x-go-name: Description amount: description: Amount format: double maximum: 9999999999.99 minimum: 0.01 type: number x-go-name: Amount from_account_id: description: From account ID format: uuid4 type: string x-go-name: FromAccountID to_account_id: description: To account ID format: uuid4 type: string x-go-name: ToAccountID required: - amount - description - from_account_id - to_account_id type: object x-go-package: github.com/wallester/api/model CreateAccountPaymentResponse: title: CreateAccountPaymentResponse represents account payment response. properties: to_account: $ref: '#/components/schemas/Account' to_account_adjustment: $ref: '#/components/schemas/AccountAdjustment' from_account: $ref: '#/components/schemas/Account' from_account_adjustment: $ref: '#/components/schemas/AccountAdjustment' type: object x-go-package: github.com/wallester/api/model CreateAccountRequest: title: CreateAccountRequest represents create account request. properties: person_id: description: Account owner ID. Must be filled if account owner is cardholder. format: uuid4 type: string x-go-name: PersonID company_id: description: Account owner ID. Must be filled if account owner is company. format: uuid4 type: string x-go-name: CompanyID external_id: description: External ID. Must be unique. maxLength: 50 type: string x-go-name: ExternalID name: description: Account name maxLength: 100 type: string x-go-name: Name currency_code: description: Currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode credit_limit: description: >- Credit limit is required in case of program type "Credit" and can't be more than product setting CreditLimitMaxAmount. format: double maximum: 999999.99 minimum: 0 type: number x-go-name: CreditLimit used_credit: description: >- Used credit cannot exceed Credit limit in request. Allowed only in case of program type "Credit". format: double type: number x-go-name: UsedCredit limits: $ref: '#/components/schemas/AccountLimits' top_up_details: $ref: '#/components/schemas/AccountTopUpDetails' type: object x-go-package: github.com/wallester/api/model CreateAccountResponse: title: CreateAccountResponse represents create account response. properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model CreateAuthorizationRequest: title: CreateAuthorizationRequest is a request to create a new authorization. properties: card_id: description: Card ID format: uuid4 type: string x-go-name: CardID transaction_amount: description: Transaction amount format: double maximum: 9999999999.99 minimum: -9999999999.99 type: number x-go-name: TransactionAmount transaction_currency_code: description: Transaction currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode account_amount: description: Account amount format: double maximum: 9999999999.99 minimum: -9999999999.99 type: number x-go-name: AccountAmount account_currency_code: description: Account currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode merchant_category_code: $ref: '#/components/schemas/MerchantCategoryCode' merchant_id: description: Merchant ID maxLength: 20 type: string x-go-name: MerchantID merchant_name: description: Merchant name maxLength: 40 type: string x-go-name: MerchantName merchant_city: description: Merchant city maxLength: 20 type: string x-go-name: MerchantCity merchant_country_code: description: Merchant country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode terminal_id: description: Terminal ID maxLength: 10 type: string x-go-name: TerminalID date: description: |- Date Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: Date type: $ref: '#/components/schemas/AuthorizationType' retrieval_reference_number: description: RetrievalReferenceNumber maxLength: 12 type: string x-go-name: RetrievalReferenceNumber does_terminal_support_partial_approvals: description: Does terminal support partial approvals type: boolean x-go-name: DoesTerminalSupportPartialApprovals required: - card_id - transaction_amount - transaction_currency_code - account_amount - account_currency_code - merchant_category_code - merchant_id - merchant_name - merchant_city - merchant_country_code - terminal_id - date - type type: object x-go-package: github.com/wallester/api/model CreateAuthorizationResponse: title: >- CreateAuthorizationResponse is the response to the request to create a new authorization. properties: authorization: $ref: '#/components/schemas/Authorization' transaction: $ref: '#/components/schemas/Transaction' type: object x-go-package: github.com/wallester/api/model CreateCardBatchDeliveryAddress: title: Card batch delivery address (required for physical cards). properties: company_name: description: Company name maxLength: 45 type: string x-go-name: CompanyName address1: description: 'Address #1' maxLength: 45 type: string x-go-name: Address1 address2: description: 'Address #2' maxLength: 45 type: string x-go-name: Address2 postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode city: description: City maxLength: 35 type: string x-go-name: City country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: CountryCode batch_dispatch_method: $ref: '#/components/schemas/BatchDispatchMethod' phone: description: >- Phone number is required in case of dispatch_method is "DPDExpress", "DHLGlobalMail", "DHLGlobalMailTracked" or "DHLExpress" type: string x-go-name: Phone required: - address1 - postal_code - city - country_code type: object x-go-package: github.com/wallester/api/model CreateCardDeliveryAddress: title: Card delivery address. description: Required for `"ChipAndPin"` and `"ChipAndPinAnonymous"` cards. properties: first_name: description: >- First name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 50 type: string x-go-name: FirstName last_name: description: >- Last name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 50 type: string x-go-name: LastName company_name: description: >- Company name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 minLength: 2 type: string x-go-name: CompanyName address1: description: >- Address #1 Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 type: string x-go-name: Address1 address2: description: >- Address #2 Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 type: string x-go-name: Address2 postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode city: description: >- City Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 35 type: string x-go-name: City country_code: description: Country code enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: CountryCode dispatch_method: $ref: '#/components/schemas/SingleCardDispatchMethod' phone: description: >- Phone number is required in case of dispatch_method is "DPDExpress", "DHLGlobalMail", "DHLGlobalMailTracked" or "DHLExpress" type: string x-go-name: Phone required: - address1 - postal_code - city - country_code type: object x-go-package: github.com/wallester/api/model CreateCardEvent: properties: data: $ref: '#/components/schemas/CreateCardEventView' event: description: Event identifier enum: - create type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks CreateCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Created type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks CreateCardMerchantRulesRequest: title: >- CreateCardMerchantRulesRequest represents create card merchant rules request. properties: card_merchant_rules: description: Card merchant rules items: $ref: '#/components/schemas/CardMerchantRuleFields' type: array x-go-name: CardMerchantRules required: - card_merchant_rules type: object x-go-package: github.com/wallester/api/model CreateCardMerchantRulesResponse: title: >- CreateCardMerchantRulesResponse represents create card merchant rules response. properties: card_merchant_rules: description: Card merchant rules items: $ref: '#/components/schemas/CardMerchantRule' type: array x-go-name: CardMerchantRules type: object x-go-package: github.com/wallester/api/model CreateCardRequest: title: CreateCardRequest represents create card request. properties: security: $ref: '#/components/schemas/CreateCardSecurity' predecessor_card_id: description: |- Predecessor card ID. Is used to renew the card. format: uuid4 type: string x-go-name: PredecessorCardID account_id: description: >- Card account ID. Required for `"ChipAndPin"` and `"Virtual"` CardType. format: uuid4 type: string x-go-name: AccountID external_id: description: External ID must be unique maxLength: 50 type: string uniqueItems: true x-go-name: ExternalID type: $ref: '#/components/schemas/APICardType' name: description: Card name maxLength: 100 type: string x-go-name: Name 3d_secure_settings: $ref: '#/components/schemas/Card3DSecureSettings' delivery_address: $ref: '#/components/schemas/CreateCardDeliveryAddress' limits: $ref: '#/components/schemas/CardLimits' personalization_product_code: description: Personalization product code type: string x-go-name: PersonalizationProductCode carrier_type: $ref: '#/components/schemas/CarrierType' expiry_days: description: Expiry days format: int64 maximum: 1825 minimum: 1 type: integer x-go-name: ExpiryDays expiry_days_round: description: When set to true rounds expiry days to end of month type: boolean x-go-name: RoundExpiryDays encrypted_pin: description: >- Encrypted PIN, if present then this PIN will be selected for card. Encrypted PIN must be base64 encoded. type: string x-go-name: EncryptedPIN embossing_name: description: >- Embossing name, if present then this embossing name will be selected for name on the card. maxLength: 26 minLength: 2 type: string x-go-name: EmbossingName is_disposable: description: Whether card is disposable. Allowed only for CardTypeVirtual type: boolean x-go-name: IsDisposable separated_embossing_name: $ref: '#/components/schemas/SeparatedEmbossingName' embossing_company_name: description: >- Embossing company name, used only for business cards and specific personalization product codes maxLength: 26 minLength: 2 type: string x-go-name: EmbossingCompanyName card_fees: description: CardFees items: $ref: '#/components/schemas/RequestCardFee' type: array x-go-name: CardFees required: - type type: object x-go-package: github.com/wallester/api/model CreateCardResponse: title: CreateCardResponse represents create card response. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model CreateCardSecurity: title: Card Security settings. properties: contactless_enabled: description: Contactless enabled type: boolean x-go-name: ContactlessEnabled withdrawal_enabled: description: Withdrawal enabled type: boolean x-go-name: WithdrawalEnabled internet_purchase_enabled: description: Internet purchase enabled type: boolean x-go-name: InternetPurchaseEnabled overall_limits_enabled: description: >- Overall limits enabled. Cannot be enabled together with all time limits. type: boolean x-go-name: OverallLimitsEnabled all_time_limits_enabled: description: >- All time limits enabled. Cannot be enabled together with overall limits. type: boolean x-go-name: AllTimeLimitsEnabled type: object x-go-package: github.com/wallester/api/model CreateCardUserRequest: title: CreateCardUserRequest represents create card user request. properties: first_name: description: >- First name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName last_name: description: >- Last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName email: description: E-mail address maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. maxLength: 100 type: string x-go-name: Mobile required: - mobile type: object x-go-package: github.com/wallester/api/model CreateCardUserResponse: title: CreateCardUserResponse represents create card user response. properties: user: $ref: '#/components/schemas/UserWithProfile' type: object x-go-package: github.com/wallester/api/model CreateCardholder3DSSettingsRequest: properties: email: description: |- Email
__Required if mobile is empty__ maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed.
__Required if email is empty__ type: string x-go-name: Mobile password: description: >- Password. Allowed to use characters: A-Z a-z 0-9 ! " # ; : ? * ( ) + = / \ , . [ ] { }. maxLength: 36 minLength: 8 type: string x-go-name: Password force_usage: description: >- ForceUsage is using to force cardholder settings for 3DS step-up methods type: boolean x-go-name: ForceUsage card_default_settings: description: >- CardDefaultSettings is using to ensure that new cards are created with cardholder 3DS settings type: boolean x-go-name: CardDefaultSettings required: - password type: object x-go-package: github.com/wallester/api/model CreateCompanyRequest: properties: name: description: >- Company name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: Name registration_number: description: Registration number maxLength: 100 type: string x-go-name: RegistrationNumber registration_address: $ref: '#/components/schemas/Address' headquarter_address: $ref: '#/components/schemas/Address' risk_profile: $ref: '#/components/schemas/APIRiskProfile' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed.
__Required if Email is empty.__ maxLength: 100 type: string x-go-name: Mobile email: description: |- Email.
__Required if Mobile is empty.__ format: email maxLength: 255 type: string x-go-name: Email industry_type: $ref: '#/components/schemas/ActivityType' date_of_incorporation: description: Date Of Incorporation. format: date-time type: string x-go-name: DateOfIncorporation is_sanctions_related: description: |- Is Sanctions Related.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: |- Is Adverse Media Involved.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved preferred_language_code: $ref: '#/components/schemas/LanguageCode' vat_number: description: VAT Number maxLength: 30 type: string x-go-name: VATNumber required: - name - registration_number - registration_address - headquarter_address - date_of_incorporation type: object x-go-package: github.com/wallester/api/model CreateCompanyResponse: properties: company: $ref: '#/components/schemas/Company' type: object x-go-package: github.com/wallester/api/model CreateCompanySwaggerModel: properties: name: description: >- Company name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: Name registration_number: description: Registration number maxLength: 100 type: string x-go-name: RegistrationNumber registration_address: $ref: '#/components/schemas/Address' headquarter_address: $ref: '#/components/schemas/Address' risk_profile: $ref: '#/components/schemas/APIRiskProfile' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed.
__Required if Email is empty.__ maxLength: 100 type: string x-go-name: Mobile email: description: |- Email.
__Required if Mobile is empty.__ format: email maxLength: 255 type: string x-go-name: Email industry_type: $ref: '#/components/schemas/ActivityType' date_of_incorporation: description: Date Of Incorporation. format: date-time type: string x-go-name: DateOfIncorporation is_sanctions_related: description: |- Is Sanctions Related.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: |- Is Adverse Media Involved.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved preferred_language_code: $ref: '#/components/schemas/LanguageCode' vat_number: description: VAT Number maxLength: 30 type: string x-go-name: VATNumber required: - name - registration_number - registration_address - headquarter_address - date_of_incorporation type: object x-go-package: github.com/wallester/api/model CreateCompanyUserRequest: title: CreateCompanyUserRequest represents create company user request. properties: first_name: description: >- First name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName last_name: description: >- Last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName email: description: E-mail address maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. maxLength: 100 type: string x-go-name: Mobile required: - mobile type: object x-go-package: github.com/wallester/api/model CreateCompanyUserResponse: title: CreateCompanyUserResponse represents create company user response. properties: user_profile: $ref: '#/components/schemas/UserWithProfile' type: object x-go-package: github.com/wallester/api/model CreateFee: properties: data: $ref: '#/components/schemas/CreateFeeView' event: description: Event identifier enum: - create type: string x-go-name: Event type: description: Event type enum: - fee type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks CreateFeeView: properties: account_id: format: uuid4 type: string x-go-name: AccountID amount: format: double maximum: 0 type: number x-go-name: Amount authorization_id: format: uuid4 type: string x-go-name: AuthorizationID canceled_at: example: '1625932529' type: string x-go-name: CanceledAt canceled_reason: type: string x-go-name: CanceledReason card_id: format: uuid4 type: string x-go-name: CardID company_id: format: uuid4 type: string x-go-name: CompanyID completed_at: example: '1625932529' type: string x-go-name: CompletedAt created_at: example: '1625932529' type: string x-go-name: CreatedAt currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode id: format: uuid4 type: string x-go-name: ID person_id: format: uuid4 type: string x-go-name: PersonID status: $ref: '#/components/schemas/FeeStatus' transaction_id: format: uuid4 type: string x-go-name: TransactionID type: $ref: '#/components/schemas/FeeType' updated_at: example: '1625932529' type: string x-go-name: UpdatedAt required: - id - type - status - amount - currency_code - account_id - created_at type: object x-go-package: github.com/wallester/api/model/webhooks CreateKYCCheckRequest: properties: applicant_id: description: Applicant ID maxLength: 50 type: string x-go-name: ApplicantID person_id: description: Person ID format: uuid4 type: string x-go-name: PersonID idv_result: $ref: '#/components/schemas/IDVResult' required: - applicant_id - person_id type: object x-go-package: github.com/wallester/api/model CreateKYCCheckResponse: title: CreateKYCCheckResponse represents create KYC check response. properties: kyc_check_id: format: uuid4 type: string x-go-name: KYCCheckID type: object x-go-package: github.com/wallester/api/model CreateOnfidoCheckResponse: properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model CreatePersonAdditionalInfoBatchRequest: title: >- CreatePersonAdditionalInfoBatchRequest is a request to create person additional info. properties: person_additional_infos: description: Person additional info items: $ref: '#/components/schemas/PersonAdditionalInfoFields' type: array x-go-name: PersonAdditionalInfos required: - person_additional_infos type: object x-go-package: github.com/wallester/api/model CreatePersonAdditionalInfoBatchResponse: title: >- CreatePersonAdditionalInfoBatchResponse is the response to the request to create person additional info batch. properties: person_additional_infos: items: $ref: '#/components/schemas/PersonAdditionalInfo' type: array x-go-name: PersonAdditionalInfos type: object x-go-package: github.com/wallester/api/model CreatePersonRequest: title: CreatePersonRequest is a request to create a new person. properties: person: $ref: '#/components/schemas/PersonFields' required: - person type: object x-go-package: github.com/wallester/api/model CreatePersonResponse: title: >- CreatePersonResponse is the response to the request to create a new person. properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model CreatePersonUserRequest: title: CreatePersonUserRequest represents create person user request. properties: first_name: description: >- First name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName last_name: description: >- Last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName email: description: E-mail address maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. maxLength: 100 type: string x-go-name: Mobile required: - first_name - last_name - email - mobile type: object x-go-package: github.com/wallester/api/model CreatePersonUserResponse: title: CreatePersonUserResponse represents create person user response. properties: user_profile: $ref: '#/components/schemas/UserWithProfile' type: object x-go-package: github.com/wallester/api/model CreateTemplateRequest: title: CreateTemplateRequest is a request to create a new template. properties: message_type: $ref: '#/components/schemas/MessageType' delivery_type: $ref: '#/components/schemas/DeliveryType' language_code: $ref: '#/components/schemas/LanguageCode' body: description: Template body type: string x-go-name: Body subject: description: Template subject type: string x-go-name: Subject required: - message_type - delivery_type - language_code - body type: object x-go-package: github.com/wallester/api/model CreateTemplateResponse: title: >- CreateTemplateResponse is the response to the request to create a new template. properties: template: $ref: '#/components/schemas/Template' type: object x-go-package: github.com/wallester/api/model CreateTransactionRequest: title: CreateTransactionRequest is a request to create a new transaction. properties: card_id: description: Card ID to which transaction belongs to format: uuid4 type: string x-go-name: CardID purchase_date: description: |- Date-time of the transaction Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: PurchaseDate group: $ref: '#/components/schemas/TransactionGroup' transaction_amount: description: Transaction amount format: double maximum: 9999999999.99 minimum: -9999999999.99 type: number x-go-name: TransactionAmount transaction_currency_code: description: Transaction currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode account_amount: description: Account amount format: double maximum: 9999999999.99 minimum: -9999999999.99 type: number x-go-name: AccountAmount account_currency_code: description: Account currency in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode merchant_category_code: $ref: '#/components/schemas/MerchantCategoryCode' merchant_id: description: Merchant ID maxLength: 15 type: string x-go-name: MerchantID terminal_id: description: Terminal ID maxLength: 8 type: string x-go-name: TerminalID merchant_name: description: Merchant name maxLength: 25 type: string x-go-name: MerchantName merchant_postal_code: description: Merchant postal code default: str maxLength: 5 type: string x-go-name: MerchantPostalCode merchant_city: description: Merchant city maxLength: 13 type: string x-go-name: MerchantCity merchant_country_code: description: Merchant country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode acquirer_reference_number: description: Acquirer transaction reference number maxLength: 23 type: string x-go-name: AcquirerReferenceNumber acquirer_business_id: description: Acquirer business ID maxLength: 8 type: string x-go-name: AcquirerBusinessID transaction_code: $ref: '#/components/schemas/TransactionCode' transaction_identifier: description: Transaction identifier maxLength: 15 type: string x-go-name: TransactionIdentifier processed_at: description: |- Date-time when transaction has been processed Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: ProcessedAt required: - card_id - group - transaction_amount - transaction_currency_code - account_amount - account_currency_code - merchant_category_code - merchant_id - terminal_id - merchant_name - merchant_postal_code - merchant_city - merchant_country_code - acquirer_reference_number - acquirer_business_id - transaction_code - transaction_identifier - processed_at type: object x-go-package: github.com/wallester/api/model CreateTransactionResponse: title: >- CreateTransactionResponse is the response to the request to create a new transaction. properties: transaction: $ref: '#/components/schemas/Transaction' type: object x-go-package: github.com/wallester/api/model Date: description: Date represents a date from the API format: date-time type: string x-go-package: github.com/go-openapi/strfmt DateTime: type: object x-go-package: github.com/wallester/common/time DeactivateCompanyResponse: properties: company: $ref: '#/components/schemas/Company' type: object x-go-package: github.com/wallester/api/model DeactivatePersonResponse: properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model DeactivatePersonsBatchRequest: title: >- DeactivatePersonsBatchRequest is a request to deactivate multiple persons. properties: person_ids: description: Person IDs items: format: uuid4 type: string type: array x-go-name: PersonIDs required: - person_ids type: object x-go-package: github.com/wallester/api/model DeactivatePersonsBatchResponse: title: >- DeactivatePersonsBatchResponse is the response to the request to deactivate multiple persons. properties: persons: items: $ref: '#/components/schemas/Person' type: array x-go-name: Persons type: object x-go-package: github.com/wallester/api/model DeactivateTokenRequest: title: DeactivateTokenRequest represents deactivate token request. properties: reason: description: Deactivate reason. maxLength: 254 type: string x-go-name: Reason required: - reason type: object x-go-package: github.com/wallester/api/model DeactivateTokenResponse: title: DeactivateTokenResponse returns related token. properties: token: $ref: '#/components/schemas/Token' type: object x-go-package: github.com/wallester/api/model DecisionRequestAuthorizationView: properties: data: $ref: '#/components/schemas/EventAuthorization' event: description: Event identifier enum: - decision_request type: string x-go-name: Event type: description: Event type enum: - authorization type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks DecisionRequestBalanceInquiryAuthorization: properties: account_amount: format: double type: number x-go-name: AccountAmount account_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode acquiring_institution_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: AcquiringInstitutionCountryCode acquiring_institution_id: type: string x-go-name: AcquiringInstitutionID approval_code: type: string x-go-name: ApprovalCode approved_amount: format: double type: number x-go-name: ApprovedAmount card: $ref: '#/components/schemas/AuthorizationCard' card_3d_secure_authentication_type: type: string x-go-name: Card3DSecureAuthenticationType card_3d_secure_cavv_validation_result: type: string x-go-name: Card3DSecureCAVVValidationResult card_3d_secure_indicator: type: string x-go-name: Card3DSecureIndicator card_id: format: uuid4 type: string x-go-name: CardID created_at: example: '1625932529' type: string x-go-name: CreatedAt date: example: '1625932529' type: string x-go-name: Date does_terminal_support_partial_approvals: type: boolean x-go-name: DoesTerminalSupportPartialApprovals fees_amount: format: double type: number x-go-name: FeesAmount group: $ref: '#/components/schemas/AuthorizationGroup' id: format: uuid4 type: string x-go-name: ID is_contactless: type: boolean x-go-name: IsContactless is_declined: type: boolean x-go-name: IsDeclined is_mass_transit: type: boolean x-go-name: IsMassTransit is_reversal: type: boolean x-go-name: IsReversal merchant_category_code: type: string x-go-name: MerchantCategoryCode merchant_city: type: string x-go-name: MerchantCity merchant_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode merchant_id: type: string x-go-name: MerchantID merchant_name: type: string x-go-name: MerchantName original_authorization_id: format: uuid4 type: string x-go-name: OriginalAuthorizationID response_code: type: string x-go-name: ResponseCode retrieval_reference_number: type: string x-go-name: RetrievalReferenceNumber terminal_id: type: string x-go-name: TerminalID transaction_amount: format: double type: number x-go-name: TransactionAmount transaction_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode type: enum: - ATMBalanceInquiry type: string x-go-name: Type required: - id - card_id - date - account_amount - account_currency_code - group - is_contactless - is_mass_transit - transaction_amount - transaction_currency_code - is_reversal - is_declined - does_terminal_support_partial_approvals type: object x-go-package: github.com/wallester/api/model/webhooks DecisionRequestBalanceInquiryAuthorizationView: properties: data: $ref: '#/components/schemas/DecisionRequestBalanceInquiryAuthorization' event: description: Event identifier enum: - decision_request type: string x-go-name: Event type: description: Event type enum: - authorization type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks DecisionRequestPartialAuthorization: properties: account_amount: format: double type: number x-go-name: AccountAmount account_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode acquiring_institution_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: AcquiringInstitutionCountryCode acquiring_institution_id: type: string x-go-name: AcquiringInstitutionID approval_code: type: string x-go-name: ApprovalCode approved_amount: format: double type: number x-go-name: ApprovedAmount card: $ref: '#/components/schemas/AuthorizationCard' card_3d_secure_authentication_type: type: string x-go-name: Card3DSecureAuthenticationType card_3d_secure_cavv_validation_result: type: string x-go-name: Card3DSecureCAVVValidationResult card_3d_secure_indicator: type: string x-go-name: Card3DSecureIndicator card_id: format: uuid4 type: string x-go-name: CardID created_at: example: '1625932529' type: string x-go-name: CreatedAt date: example: '1625932529' type: string x-go-name: Date does_terminal_support_partial_approvals: type: boolean x-go-name: DoesTerminalSupportPartialApprovals fees_amount: format: double type: number x-go-name: FeesAmount group: $ref: '#/components/schemas/AuthorizationGroup' id: format: uuid4 type: string x-go-name: ID is_contactless: type: boolean x-go-name: IsContactless is_declined: type: boolean x-go-name: IsDeclined is_mass_transit: type: boolean x-go-name: IsMassTransit is_reversal: type: boolean x-go-name: IsReversal merchant_category_code: type: string x-go-name: MerchantCategoryCode merchant_city: type: string x-go-name: MerchantCity merchant_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode merchant_id: type: string x-go-name: MerchantID merchant_name: type: string x-go-name: MerchantName original_authorization_id: format: uuid4 type: string x-go-name: OriginalAuthorizationID response_code: type: string x-go-name: ResponseCode retrieval_reference_number: type: string x-go-name: RetrievalReferenceNumber terminal_id: type: string x-go-name: TerminalID transaction_amount: format: double type: number x-go-name: TransactionAmount transaction_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode type: $ref: '#/components/schemas/AuthorizationType' required: - id - card_id - date - account_amount - account_currency_code - group - is_contactless - is_mass_transit - transaction_amount - transaction_currency_code - is_reversal - is_declined - does_terminal_support_partial_approvals type: object x-go-package: github.com/wallester/api/model/webhooks DecisionRequestPartialAuthorizationView: properties: data: $ref: '#/components/schemas/DecisionRequestPartialAuthorization' event: description: Event identifier enum: - decision_request type: string x-go-name: Event type: description: Event type enum: - authorization type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks DeletePersonAdditionalInfoBatchRequest: title: >- DeletePersonAdditionalInfoBatchRequest is a request to delete existing person additional info batch. properties: person_additional_info_ids: description: Person additional info ID list items: type: string type: array x-go-name: PersonAdditionalInfoIDs required: - person_additional_info_ids type: object x-go-package: github.com/wallester/api/model DeliveryAddress: title: Card delivery address. properties: first_name: description: >- First name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 50 type: string x-go-name: FirstName last_name: description: >- Last name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 50 type: string x-go-name: LastName company_name: description: >- Company name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 minLength: 2 type: string x-go-name: CompanyName address1: description: >- Address #1 Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 type: string x-go-name: Address1 address2: description: >- Address #2 Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 type: string x-go-name: Address2 postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode city: description: >- City Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 35 type: string x-go-name: City country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: CountryCode dispatch_method: $ref: '#/components/schemas/SingleCardDispatchMethod' phone: description: >- Phone number is required in case of dispatch_method is "DPDExpress", "DHLGlobalMail", "DHLGlobalMailTracked" or "DHLExpress" type: string x-go-name: Phone tracking_number: description: Tracking number type: string x-go-name: TrackingNumber required: - address1 - postal_code - city - country_code type: object x-go-package: github.com/wallester/api/model DeliveryAddressForUpdate: title: Card delivery address without required fields. properties: first_name: description: First name maxLength: 50 type: string x-go-name: FirstName last_name: description: >- Last name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 50 type: string x-go-name: LastName company_name: description: >- Company name Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 minLength: 2 type: string x-go-name: CompanyName address1: description: >- Address #1 Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 type: string x-go-name: Address1 address2: description: >- Address #2 Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 45 type: string x-go-name: Address2 postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode city: description: >- City Allowed case-insensitive characters: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'æ', 'ä', 'å', 'á', 'é', 'í', 'ø', 'ö', 'ó', 'õ', 'š', 'ü', 'ú', 'ž', 'à', 'è', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ô', 'û', 'ã', 'ñ', 'ë', 'ï', 'ÿ', 'ė', 'ç', 'ć', 'ń', 'ś', 'ź', 'ā', 'ē', 'ī', 'ō', 'ū', 'ą', 'ę', 'į', 'ų', 'č', 'ģ', 'ķ', 'ļ', 'ņ', 'ŗ', 'ỳ', 'ǹ', 'ẁ', 'ý', 'ǵ', 'ḱ', 'ĺ', 'ḿ', 'ṕ', 'ŕ', 'ẃ', 'ŷ', 'ĉ', 'ĝ', 'ĥ', 'ĵ', 'ŝ', 'ŵ', 'ẑ', 'ẽ', 'ĩ', 'ũ', 'ỹ', 'ṽ', 'ḧ', 'ẅ', 'ẍ', 'ẗ', 'ẘ', 'ẙ', 'ȳ', 'ḡ', 'ă', 'ĕ', 'ĭ', 'ŏ', 'ŭ', 'ğ', 'ǫ', 'ǎ', 'ě', 'ǐ', 'ǒ', 'ǔ', 'ď', 'ǧ', 'ȟ', 'ǰ', 'ǩ', 'ľ', 'ň', 'ř', 'ť', 'ȩ', 'ḑ', 'ḩ', 'ş', 'ţ', 'ő', 'ű', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '\'', '-', '/', '.', ',', '&', ' '] maxLength: 35 type: string x-go-name: City country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: CountryCode dispatch_method: $ref: '#/components/schemas/SingleCardDispatchMethod' phone: description: >- Phone number is required in case of dispatch_method is "DPDExpress", "DHLGlobalMail", "DHLGlobalMailTracked" or "DHLExpress" type: string x-go-name: Phone type: object x-go-package: github.com/wallester/api/model DeliveryTime: description: >- Possible delivery intervals: `2-3 working days`, `5-9 working days`, `10-12 working days` properties: min: description: Minimum delivery time (e.g. "2d", "5d", "10d") type: string x-go-name: Min max: description: Maximum delivery time (e.g. "3d", "9d", "12d") type: string x-go-name: Max type: object x-go-package: github.com/wallester/api/model DeliveryType: title: DeliveryType represents delivery type. enum: - email - push - sms type: string x-go-package: github.com/wallester/common/model DeviceType: enum: - AUTOMOBILE_DEVICE - HOUSEHOLD_DEVICE - MOBILEPHONE_OR_TABLET - MOBILE_PHONE - PC - TABLET - UNKNOWN - WATCH - WEARABLE_DEVICE type: string x-go-package: github.com/wallester/common/model DispatchCardEvent: properties: data: $ref: '#/components/schemas/DispatchCardEventView' event: description: Event identifier enum: - dispatch type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks DispatchCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Dispatched type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks DispatchMethod: title: DB Dispatch method. enum: - BatchEconomy - DHLExpress - DHLGlobalMail - DHLGlobalMailTracked - DPDExpress - StandardLatvianPostMail type: string x-go-package: github.com/wallester/common/model DownloadAccountStatementResponse: properties: file: $ref: '#/components/schemas/File' type: object x-go-package: github.com/wallester/api/model DownloadAccountStatementResponseV2: properties: link: type: string x-go-name: Link type: object x-go-package: github.com/wallester/api/model DownloadCardStatementResponse: properties: file: $ref: '#/components/schemas/File' type: object x-go-package: github.com/wallester/api/model DownloadCardStatementResponseV2: properties: link: type: string x-go-name: Link type: object x-go-package: github.com/wallester/api/model DownloadPaymentDocumentsResponse: title: >- DownloadPaymentDocumentsResponse is the response to the request to download payment documents. properties: file: $ref: '#/components/schemas/File' type: object x-go-package: github.com/wallester/api/model EmployeeStatus: title: Employee status. enum: - Active - Declined - Deleted - Pending - Rejected type: string x-go-package: github.com/wallester/common/model EnrichedMerchantData: description: EnrichedMerchantData detailed information from the merchant properties: name: description: Full merchant name type: string x-go-name: Name url: description: Merchant website URL type: string x-go-name: URL domain: description: Merchant website domain type: string x-go-name: Domain telephone_number: description: Merchant telephone number type: string x-go-name: TelephoneNumber icon_url: description: Merchant logo icon URL in SVG format type: string x-go-name: IconURL type: object x-go-package: github.com/wallester/api/model EnrolCardFor3DSecureResponse: title: >- EnrolCardFor3DSecureResponse is the response to the request to enrol card for 3D secure. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model EventAccountAdjustment: properties: description: type: string x-go-name: Description account_id: format: uuid4 type: string x-go-name: AccountID amount: format: double type: number x-go-name: Amount external_id: type: string x-go-name: ExternalID id: type: string x-go-name: ID required: - id - account_id - amount - description - external_id type: object x-go-package: github.com/wallester/api/model/webhooks EventAccountToAccountTransfer: properties: from: $ref: '#/components/schemas/EventAccountAdjustment' to: $ref: '#/components/schemas/EventAccountAdjustment' type: object x-go-package: github.com/wallester/api/model/webhooks EventAuthorization: properties: account_amount: format: double maximum: 0 type: number x-go-name: AccountAmount account_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode acquiring_institution_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: AcquiringInstitutionCountryCode acquiring_institution_id: type: string x-go-name: AcquiringInstitutionID approval_code: type: string x-go-name: ApprovalCode approved_amount: format: double type: number x-go-name: ApprovedAmount card: $ref: '#/components/schemas/AuthorizationCard' card_3d_secure_authentication_type: type: string x-go-name: Card3DSecureAuthenticationType card_3d_secure_cavv_validation_result: type: string x-go-name: Card3DSecureCAVVValidationResult card_3d_secure_indicator: type: string x-go-name: Card3DSecureIndicator card_id: format: uuid4 type: string x-go-name: CardID created_at: example: '1625932529' type: string x-go-name: CreatedAt date: example: '1625932529' type: string x-go-name: Date does_terminal_support_partial_approvals: type: boolean x-go-name: DoesTerminalSupportPartialApprovals fees_amount: format: double type: number x-go-name: FeesAmount group: $ref: '#/components/schemas/AuthorizationGroup' id: format: uuid4 type: string x-go-name: ID is_contactless: type: boolean x-go-name: IsContactless is_declined: type: boolean x-go-name: IsDeclined is_mass_transit: type: boolean x-go-name: IsMassTransit is_reversal: type: boolean x-go-name: IsReversal merchant_category_code: type: string x-go-name: MerchantCategoryCode merchant_city: type: string x-go-name: MerchantCity merchant_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode merchant_id: type: string x-go-name: MerchantID merchant_name: type: string x-go-name: MerchantName original_authorization_id: format: uuid4 type: string x-go-name: OriginalAuthorizationID released_account_amount: description: >- Represents the released account amount of authorization on release authorization format: double type: number x-go-name: ReleasedAccountAmount response_code: type: string x-go-name: ResponseCode retrieval_reference_number: type: string x-go-name: RetrievalReferenceNumber terminal_id: type: string x-go-name: TerminalID transaction_amount: format: double maximum: 0 type: number x-go-name: TransactionAmount transaction_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode type: $ref: '#/components/schemas/AuthorizationType' required: - id - card_id - date - account_amount - account_currency_code - group - is_contactless - is_mass_transit - transaction_amount - transaction_currency_code - is_reversal - is_declined - does_terminal_support_partial_approvals type: object x-go-package: github.com/wallester/api/model/webhooks EventIDVResult: properties: created_at: example: '1625932529' type: string x-go-name: CreatedAt report_link: type: string x-go-name: ReportLink source: $ref: '#/components/schemas/IDVResultSource' status: $ref: '#/components/schemas/IDVResultStatus' required: - report_link - source - status - created_at type: object x-go-package: github.com/wallester/api/model/webhooks EventTransaction: properties: account_amount: format: double type: number x-go-name: AccountAmount account_currency_code: description: Currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode acquirer_reference_number: type: string x-go-name: AcquirerReferenceNumber authorization_code: type: string x-go-name: AuthorizationCode authorization_id: type: string x-go-name: AuthorizationID card_id: format: uuid4 type: string x-go-name: CardID code: type: string x-go-name: Code created_at: example: '1625932529' type: string x-go-name: CreatedAt group: $ref: '#/components/schemas/TransactionGroup' id: format: uuid4 type: string x-go-name: ID identifier: type: string x-go-name: Identifier merchant_category_code: type: string x-go-name: MerchantCategoryCode merchant_city: type: string x-go-name: MerchantCity merchant_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode merchant_id: type: string x-go-name: MerchantID merchant_name: type: string x-go-name: MerchantName processed_at: example: '1625932529' type: string x-go-name: ProcessedAt purchase_date: example: '1625932529' type: string x-go-name: PurchaseDate terminal_id: type: string x-go-name: TerminalID transaction_amount: format: double type: number x-go-name: TransactionAmount transaction_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode required: - transaction_amount - id - transaction_currency_code - created_at type: object x-go-package: github.com/wallester/api/model/webhooks ExpireCardEvent: properties: data: $ref: '#/components/schemas/ExpireCardEventView' event: description: Event identifier enum: - expire type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ExpireCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Expired type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks ExtractFilesDirectoriesResponse: description: ExtractFilesDirectoriesResponse properties: directories: description: Directories items: type: string type: array x-go-name: Directories type: object x-go-package: github.com/wallester/api/model ExtractFilesListItem: properties: name: type: string x-go-name: Name type: object x-go-package: github.com/wallester/api/model ExtractFilesListResponse: description: ExtractFilesListResponse properties: files: items: $ref: '#/components/schemas/ExtractFilesListItem' type: array x-go-name: Files type: object x-go-package: github.com/wallester/api/model FCMToken: properties: id: description: FCM Token ID format: uuid4 type: string x-go-name: ID device_id: description: Device ID type: string x-go-name: DeviceID fcm_token: description: FCM Token type: string x-go-name: FCMToken push_notifications_enabled: description: Push notifications enabled type: boolean x-go-name: PushNotificationsEnabled created_at: description: Created at format: date-time type: string x-go-name: CreatedAt created_by: description: Created by type: string x-go-name: CreatedBy updated_at: description: Updated at format: date-time type: string x-go-name: UpdatedAt updated_by: description: Updated by type: string x-go-name: UpdatedBy type: object x-go-package: github.com/wallester/api/model Fee: title: Fee represents a fee. properties: id: description: Fee ID format: uuid4 type: string x-go-name: ID type: $ref: '#/components/schemas/FeeType' status: $ref: '#/components/schemas/FeeStatus' amount: description: Fee amount format: double type: number x-go-name: Amount currency_code: description: Fee currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode person_id: description: Person ID to which this fee belongs to format: uuid4 type: string x-go-name: PersonID company_id: description: Company ID to which this fee belongs to format: uuid4 type: string x-go-name: CompanyID account_id: description: Account ID to which this fee belongs to format: uuid4 type: string x-go-name: AccountID card_id: description: Card ID to which this fee belongs to format: uuid4 type: string x-go-name: CardID authorization_id: description: Authorization ID to which this fee belongs to format: uuid4 type: string x-go-name: AuthorizationID transaction_id: description: Transaction ID to which this fee belongs to format: uuid4 type: string x-go-name: TransactionID created_at: format: date-time type: string x-go-name: CreatedAt created_by: description: ID of the user who has created fee type: string x-go-name: CreatedBy update_at: format: date-time type: string x-go-name: UpdatedAt update_by: description: ID of the user who has made the change type: string x-go-name: UpdatedBy completed_at: format: date-time type: string x-go-name: CompletedAt canceled_at: format: date-time type: string x-go-name: CanceledAt canceled_by: description: ID of the user who has canceled fee type: string x-go-name: CanceledBy canceled_reason: description: Fee cancellation reason type: string x-go-name: CanceledReason completed_by: description: ID of the user who has completed fee type: string x-go-name: CompletedBy original_fee_id: description: Original fee ID format: uuid4 type: string x-go-name: OriginalFeeID refund_info: $ref: '#/components/schemas/RefundInfo' refund_fee_ids: description: Refund fee IDs items: type: string type: array x-go-name: RefundFeeIDs type: object x-go-package: github.com/wallester/api/model FeeStatus: enum: - Canceled - Completed - WaitingForClearing type: string x-go-package: github.com/wallester/common/model FeeType: enum: - AccountTransferFee - AdditionalBINConfigurationFee - AdditionalBINMaintenanceFee - AdditionalVirtualCardsFee - AuthorizationATMBalanceInquiryFixedFee - AuthorizationATMDeclinedFixedFee - AuthorizationATMWithdrawalComplexFee - AuthorizationATMWithdrawalEEAComplexFee - AuthorizationATMWithdrawalFixedFee - AuthorizationATMWithdrawalInternationalComplexFee - AuthorizationATMWithdrawalPercentageFee - AuthorizationDeclinedFixedFee - AuthorizationEEAFixedFee - AuthorizationForeignExchangePercentageFee - AuthorizationInternationalFixedFee - AvailableFundsRefundFee - CardDeliveryFixedFee - CardExpressDeliveryFixedFee - CardIssuanceFixedFee - CardRenewalFixedFee - CardReplacementFixedFee - CardUsageFixedFee - ChargebackProcessingFee - DedicatedBINRangeFee - ExclusiveBINFee - ExclusiveSharedBINFee - IncomingCardPaymentPercentageFee - IncomingSEPAPaymentFixedFee - IncomingSEPAPaymentPercentageFee - IndustryFee - MerchantWhitelistFee - MonthlyFeePerEmployee - MonthlyServiceFee - NewEmployeeAdditionFee - OtherAdministrativeRequestFee - PINChangeFixedFee - PaymentEEAComplexFee - PaymentEEAFixedFee - PaymentInternationalComplexFee - PaymentInternationalFixedFee - PaymentPercentageFee - PricingPlanFee - Remind3DSPasswordFixedFee - RemindPINFixedFee - SharedBINRangeFee - ZeroAuthorizationEEAFixedFee - ZeroAuthorizationInternationalFixedFee type: string x-go-package: github.com/wallester/common/model FeeWaiverAuthorizationType: enum: - ATMWithdrawal type: string x-go-package: github.com/wallester/api/model FeeWaiverType: enum: - Amount - Quantity type: string x-go-package: github.com/wallester/common/model FeesByAuthorizationIDResponse: properties: fees: items: $ref: '#/components/schemas/Fee' type: array x-go-name: Fees type: object x-go-package: github.com/wallester/api/model FeesByTransactionIDResponse: properties: fees: items: $ref: '#/components/schemas/Fee' type: array x-go-name: Fees type: object x-go-package: github.com/wallester/api/model FeesStatement: properties: id: type: string x-go-name: ID file_name: type: string x-go-name: FileName mime_type: $ref: '#/components/schemas/MimeType' file_size: format: int64 type: integer x-go-name: FileSize year: format: int32 type: integer x-go-name: Year link: type: string x-go-name: Link created_at: format: date-time type: string x-go-name: CreatedAt type: object x-go-package: github.com/wallester/api/model File: title: File represents a file. properties: name: description: File name type: string x-go-name: Name mime_type: $ref: '#/components/schemas/MimeType' body: description: Body type: string x-go-name: Body type: object x-go-package: github.com/wallester/api/model FraudCase: properties: description: description: Fraud case description type: string x-go-name: Description id: description: Fraud case ID format: uuid4 type: string x-go-name: ID authorization_id: description: Authorization ID format: uuid4 type: string x-go-name: AuthorizationID product_id: description: Product ID format: uuid4 type: string x-go-name: ProductID authorization_date: description: Authorization date format: date-time type: string x-go-name: AuthorizationDate merchant_name: description: Merchant name type: string x-go-name: MerchantName card_id: description: Card ID format: uuid4 type: string x-go-name: CardID card_owner_id: description: Card owner ID format: uuid4 type: string x-go-name: CardOwnerID card_owner_type: $ref: '#/components/schemas/CardOwnerType' card_owner_name: description: Card owner name type: string x-go-name: CardOwnerName risk_score: description: Fraud case risk score format: int32 type: integer x-go-name: RiskScore risk_zone: $ref: '#/components/schemas/RiskZone' risk_status: $ref: '#/components/schemas/RiskStatus' case_status: $ref: '#/components/schemas/FraudCaseStatus' source: $ref: '#/components/schemas/FraudSource' type: $ref: '#/components/schemas/FraudType' liability: $ref: '#/components/schemas/FraudLiability' assigned_to: $ref: '#/components/schemas/AssignedTo' assigned_at: description: Assigned at format: date-time type: string x-go-name: AssignedAt assigned_to_name: description: Assigned to name type: string x-go-name: AssignedToName created_at: description: Created at format: date-time type: string x-go-name: CreatedAt updated_at: description: Updated at format: date-time type: string x-go-name: UpdatedAt updated_by: description: Updated by type: string x-go-name: UpdatedBy scoring: $ref: '#/components/schemas/Scoring' merchant_country_code: description: Merchant Country code enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode card_owner_country_code: description: Card owner Country code enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: CardOwnerCountryCode type: object x-go-package: github.com/wallester/api/model FraudCaseHistory: properties: description: description: Description type: string x-go-name: Description id: description: Fraud case ID format: uuid4 type: string x-go-name: FraudCaseID old_case_status: description: Old case status type: string x-go-name: OldCaseStatus new_case_status: description: New case status type: string x-go-name: NewCaseStatus created_by: description: Created by type: string x-go-name: CreatedBy created_at: description: Date-time when the change has been made format: date-time type: string x-go-name: CreatedAt type: object x-go-package: github.com/wallester/api/model FraudCaseStatus: enum: - Escalation - Negative - NotClassified - Pending - Positive type: string x-go-package: github.com/wallester/common/model FraudLiability: enum: - Client - Other - Payer - PaymentServiceProvider type: string x-go-package: github.com/wallester/common/model FraudRiskStatus: enum: - Approved - Declined - FreezeCard - Suspicious - Unknown type: string x-go-package: github.com/wallester/api/model FraudRiskZone: enum: - High - Low - Medium type: string x-go-package: github.com/wallester/common/model FraudSource: enum: - Cardholder - Client - FraudAnalyst - Other type: string x-go-package: github.com/wallester/common/model FraudType: enum: - CardDetailsTheft - CardNotDelivered - CounterfeitCard - LostOrStolenCard - ManipulationOfThePayerToMakeACardPayment - ModificationOfPaymentOrderByTheFraudster - Other - PayerIsTheFraudster type: string x-go-package: github.com/wallester/common/model Gender: title: Person gender. enum: - FEMALE - MALE type: string x-go-package: github.com/wallester/common/model GenerateOnfidoSDKTokenResponse: properties: token: type: string x-go-name: Token type: object x-go-package: github.com/wallester/api/model GetAccountAdjustmentByExternalIDResponse: properties: account_adjustment: $ref: '#/components/schemas/AccountAdjustment' type: object x-go-package: github.com/wallester/api/model GetAccountAdjustmentResponse: title: >- GetAccountAdjustmentResponse returns specific account adjustment information. properties: account_adjustment: $ref: '#/components/schemas/AccountAdjustment' type: object x-go-package: github.com/wallester/api/model GetAccountAllowedCurrenciesResponse: title: >- GetAccountAllowedCurrenciesResponse is the response to the request to get account allowed currencies. properties: currency_codes: description: Currency codes in ISO 4217 standard items: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string type: array x-go-name: CurrencyCodes type: object x-go-package: github.com/wallester/api/model GetAccountAuthorizationsResponse: title: >- GetAccountAuthorizationsResponse represents get account authorizations response. properties: authorizations: description: List of account authorizations items: $ref: '#/components/schemas/Authorization' type: array x-go-name: Authorizations total_records_number: description: Total number of account authorizations satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetAccountByExternalIDResponse: properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model GetAccountCardsResponse: title: GetAccountCardsResponse lists cards of an account. properties: cards: description: List of account cards items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards total_records_number: description: Total number of cards format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetAccountHistoryResponse: title: GetAccountHistoryResponse represents get account history response. properties: history: description: List of account information changes items: $ref: '#/components/schemas/History' type: array x-go-name: History total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetAccountLimitsUsageResponse: properties: purchase: $ref: '#/components/schemas/AccountLimitsUsage' withdrawal: $ref: '#/components/schemas/AccountLimitsUsage' internet_purchase: $ref: '#/components/schemas/AccountLimitsUsage' contactless_purchase: $ref: '#/components/schemas/AccountLimitsUsage' overall_purchase: $ref: '#/components/schemas/AccountLimitsUsage' type: object x-go-package: github.com/wallester/api/model GetAccountResponse: title: GetAccountResponse represents get account response details. properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model GetAccountStatementByCursorResponse: title: GetAccountStatementByCursorResponse returns account statement. properties: records: description: List of account statement records items: $ref: '#/components/schemas/AccountStatementRecord' type: array x-go-name: Records cursor: description: >- Cursor is an object that stores the state of the last requested data in base64 format so that newer or older data can be requested. Cursor parameter that is used to paginate the page in the GetAccountStatementByCursor request type: string x-go-name: Cursor type: object x-go-package: github.com/wallester/api/model GetAccountStatementByDateResponse: title: GetAccountStatementByDateResponse returns account statement. properties: records: description: List of account statement records items: $ref: '#/components/schemas/AccountStatementRecord' type: array x-go-name: Records cursor: description: >- Cursor is an object that stores the state of the last requested data in base64 format so that newer or older data can be requested. Cursor parameter that is used to paginate the page in the GetAccountStatementByCursor request type: string x-go-name: Cursor type: object x-go-package: github.com/wallester/api/model GetAccountStatementResponse: title: GetAccountStatementResponse returns account statement. allOf: - properties: credit_turnover: description: Total credit money flow for statement records format: double type: number x-go-name: CreditTurnover debit_turnover: description: Total debit money flow for statement records format: double type: number x-go-name: DebitTurnover pending_amount: description: Total pending money flow for statement records format: double type: number x-go-name: PendingAmount total_records_number: description: Total number of statement records satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object - properties: records: description: List of account statement records items: $ref: '#/components/schemas/AccountStatementRecord' type: array x-go-name: Records type: object x-go-package: github.com/wallester/api/model GetAccountTransactionsResponse: title: >- GetAccountTransactionsResponse represents get account transactions response. properties: transactions: description: List of account transactions items: $ref: '#/components/schemas/Transaction' type: array x-go-name: Transactions total_records_number: description: Total number of account transactions satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetAccountsByIDsRequest: title: GetAccountsByIDsRequest represents get account by IDs request. properties: ids: description: Account IDs items: format: uuid4 type: string type: array x-go-name: AccountIDs required: - ids type: object x-go-package: github.com/wallester/api/model GetAccountsByIDsResponse: title: GetAccountsByIDsResponse list of accounts. properties: accounts: description: List of accounts items: $ref: '#/components/schemas/Account' type: array x-go-name: Accounts type: object x-go-package: github.com/wallester/api/model GetAccountsExceedingCreditLimitResponse: properties: accounts: items: $ref: '#/components/schemas/Account' type: array x-go-name: Accounts type: object x-go-package: github.com/wallester/api/model GetAuthorizationAdditionalInfoResponse: title: >- GetAuthorizationAdditionalInfoResponse is the response to the request to get the authorization additional info. properties: authorization_additional_info: $ref: '#/components/schemas/AuthorizationAdditionalInfo' type: object x-go-package: github.com/wallester/api/model GetAuthorizationResponse: title: >- GetAuthorizationResponse returns specific authorization information with enriched merchant. properties: authorization: $ref: '#/components/schemas/AuthorizationWithEnrichedMerchant' type: object x-go-package: github.com/wallester/api/model GetAuthorizationsByProductIDResponse: title: >- GetAuthorizationsByProductIDResponse represents get product authorizations response. properties: authorizations: description: List of authorizations items: $ref: '#/components/schemas/Authorization' type: array x-go-name: Authorizations total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCardAuthorizationsResponse: title: >- GetCardAuthorizationsResponse represents get card authorizations response. properties: authorizations: description: List of authorizations. items: $ref: '#/components/schemas/Authorization' type: array x-go-name: Authorizations total_records_number: description: Total number of authorizations satisfying given criteria. format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCardByExternalIDResponse: properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model GetCardByReferenceNumberResponse: properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model GetCardBySHACardNumberResponse: properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model GetCardDesignsByPersonalizationProductCodesResponse: properties: cards_designs: items: $ref: '#/components/schemas/CardDesign' type: array x-go-name: CardDesigns type: object x-go-package: github.com/wallester/api/model GetCardFeeWaiverByIDResponse: properties: card_fee_waiver: $ref: '#/components/schemas/CardFeeWaiver' type: object x-go-package: github.com/wallester/api/model GetCardFeeWaiversResponse: properties: card_fee_waivers: items: $ref: '#/components/schemas/CardFeeWaiver' type: array x-go-name: CardFeeWaivers type: object x-go-package: github.com/wallester/api/model GetCardFeesResponse: title: GetCardFeesResponse represents get card fees response. properties: card_fees: description: List of card fees items: $ref: '#/components/schemas/CardFee' type: array x-go-name: CardFees type: object x-go-package: github.com/wallester/api/model GetCardHistoryResponse: title: GetCardHistoryResponse represents get card history response. properties: history: description: List of card information changes items: $ref: '#/components/schemas/History' type: array x-go-name: History total_records_number: description: Total number of changes format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCardLimitsUsageResponse: title: GetCardLimitsUsageResponse returns card limits usage information. properties: currency_code: description: Currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode daily_purchase: $ref: '#/components/schemas/CardLimitUsage' daily_withdrawal: $ref: '#/components/schemas/CardLimitUsage' daily_internet_purchase: $ref: '#/components/schemas/CardLimitUsage' daily_contactless_purchase: $ref: '#/components/schemas/CardLimitUsage' daily_overall_purchase: $ref: '#/components/schemas/CardLimitUsage' weekly_purchase: $ref: '#/components/schemas/CardLimitUsage' weekly_withdrawal: $ref: '#/components/schemas/CardLimitUsage' weekly_internet_purchase: $ref: '#/components/schemas/CardLimitUsage' weekly_contactless_purchase: $ref: '#/components/schemas/CardLimitUsage' weekly_overall_purchase: $ref: '#/components/schemas/CardLimitUsage' monthly_purchase: $ref: '#/components/schemas/CardLimitUsage' monthly_withdrawal: $ref: '#/components/schemas/CardLimitUsage' monthly_internet_purchase: $ref: '#/components/schemas/CardLimitUsage' monthly_contactless_purchase: $ref: '#/components/schemas/CardLimitUsage' monthly_overall_purchase: $ref: '#/components/schemas/CardLimitUsage' transaction_purchase: format: double type: number x-go-name: TransactionPurchase transaction_withdrawal: format: double type: number x-go-name: TransactionWithdrawal transaction_internet_purchase: format: double type: number x-go-name: TransactionInternetPurchase transaction_contactless_purchase: format: double type: number x-go-name: TransactionContactlessPurchase all_time_purchase: $ref: '#/components/schemas/CardLimitUsage' all_time_withdrawal: $ref: '#/components/schemas/CardLimitUsage' all_time_internet_purchase: $ref: '#/components/schemas/CardLimitUsage' all_time_contactless_purchase: $ref: '#/components/schemas/CardLimitUsage' type: object x-go-package: github.com/wallester/api/model GetCardMerchantRuleByIDResponse: title: >- GetCardMerchantRuleByIDResponse represents get card merchant role by ID response. properties: card_merchant_rule: $ref: '#/components/schemas/CardMerchantRule' type: object x-go-package: github.com/wallester/api/model GetCardMerchantRulesResponse: title: >- GetCardMerchantRulesResponse represents get card merchant rules by card id response. properties: card_merchant_rules: description: Card merchant rules items: $ref: '#/components/schemas/CardMerchantRule' type: array x-go-name: CardMerchantRules total_records_number: description: Total records number format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCardResponse: title: GetCardResponse returns card information. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model GetCardStatementResponse: title: GetCardStatementResponse returns card statement. allOf: - properties: credit_turnover: description: Total credit money flow for statement records format: double type: number x-go-name: CreditTurnover debit_turnover: description: Total debit money flow for statement records format: double type: number x-go-name: DebitTurnover pending_amount: description: Total pending money flow for statement records format: double type: number x-go-name: PendingAmount total_records_number: description: Total number of statement records satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object - properties: records: description: List of account statement records items: $ref: '#/components/schemas/CardStatementRecord' type: array x-go-name: Records type: object x-go-package: github.com/wallester/api/model GetCardTransactionsResponse: title: GetCardTransactionsResponse represents get card transactions response. properties: transactions: description: List of card transactions items: $ref: '#/components/schemas/Transaction' type: array x-go-name: Transactions total_records_number: description: Total number of card transactions satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCardUsersResponse: title: GetCardUsersResponse represents get card users response. properties: users: description: User profiles with user data items: $ref: '#/components/schemas/UserWithProfile' type: array x-go-name: UsersWithProfile total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCardsBlockLogsResponse: title: GetCardsBlockLogsResponse represents get block logs response. properties: cards_block_logs: description: List of cards block logs items: $ref: '#/components/schemas/CardsBlockLog' type: array x-go-name: CardsBlockLogs total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCardsByLastFourDigitsResponse: properties: cards: items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards type: object x-go-package: github.com/wallester/api/model GetCardsResponse: properties: cards: description: List of cards items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards total_records_number: description: Total number of cards format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCompanyAccountsResponse: properties: accounts: description: List of company accounts items: $ref: '#/components/schemas/Account' type: array x-go-name: Accounts total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCompanyCardsResponse: properties: cards: description: List of company cards items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCompanyFCMTokenResponse: properties: company_fcm_token: $ref: '#/components/schemas/CompanyFCMToken' type: object x-go-package: github.com/wallester/api/model GetCompanyHistoryResponse: title: GetCompanyHistoryResponse represents get company history response. properties: history: description: List of company information changes items: $ref: '#/components/schemas/History' type: array x-go-name: History total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetCompanyInfoByProductIDResponse: properties: company_name: type: string x-go-name: CompanyName country_code: type: string x-go-name: CountryCode address1: type: string x-go-name: Address1 address2: type: string x-go-name: Address2 postal_code: type: string x-go-name: PostalCode city: type: string x-go-name: City phone: type: string x-go-name: Phone email: type: string x-go-name: Email office_coordinates: $ref: '#/components/schemas/OfficeCoordinates' web_representation: type: string x-go-name: WebRepresentation type: object x-go-package: github.com/wallester/api/model GetCompanyResponse: title: GetCompanyResponse returns specific company information. properties: company: $ref: '#/components/schemas/Company' type: object x-go-package: github.com/wallester/api/model GetCompanyUsersResponse: title: GetCompanyUsersResponse represents get company users response. properties: company_users: description: User profile with user data items: $ref: '#/components/schemas/UserWithProfile' type: array x-go-name: CompanyUsers total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetEmbossingNameProductSettingsResponse: properties: personalization_product_codes_two_lines_embossing_name: type: string x-go-name: PersonalizationProductCodesTwoLinesEmbossingName personalization_product_codes_three_lines_embossing_name: type: string x-go-name: PersonalizationProductCodesThreeLinesEmbossingName type: object x-go-package: github.com/wallester/api/model GetEncrypted3DSPasswordRequest: properties: public_key: description: RSA Public key - base64 encoded type: string x-go-name: PublicKey required: - public_key type: object x-go-package: github.com/wallester/api/model GetEncrypted3DSPasswordResponse: properties: encrypted_3ds_password: type: string x-go-name: Encrypted3DSPassword type: object x-go-package: github.com/wallester/api/model GetEncryptedCVV2Request: title: GetEncryptedCVV2Request is a request to get encrypted CVV2. properties: public_key: description: RSA Public key - base64 encoded type: string x-go-name: PublicKey required: - public_key type: object x-go-package: github.com/wallester/api/model GetEncryptedCVV2Response: title: GetEncryptedCVV2Response returns encrypted CVV2. properties: encrypted_cvv2: type: string x-go-name: EncryptedCVV2 type: object x-go-package: github.com/wallester/api/model GetEncryptedCardNumberRequest: properties: public_key: description: |- RSA Public key - base64 encoded
Recommended key size: 1024 bits and above type: string x-go-name: PublicKey required: - public_key type: object x-go-package: github.com/wallester/api/model GetEncryptedCardNumberResponse: properties: encrypted_card_number: type: string x-go-name: EncryptedCardNumber type: object x-go-package: github.com/wallester/api/model GetEncryptedPINRequest: title: GetEncryptedPINRequest is a request to get encrypted PIN. properties: public_key: description: RSA Public key - base64 encoded type: string x-go-name: PublicKey required: - public_key type: object x-go-package: github.com/wallester/api/model GetEncryptedPINResponse: title: GetEncryptedPINResponse returns encrypted PIN. properties: encrypted_pin: type: string x-go-name: EncryptedPIN type: object x-go-package: github.com/wallester/api/model GetExpiringCardsResponse: properties: cards: description: List of cards items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards total_records_number: description: Total number of cards format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetFCMTokenResponse: properties: fcm_token: $ref: '#/components/schemas/FCMToken' type: object x-go-package: github.com/wallester/api/model GetFeeResponse: title: GetFeeResponse returns specific fee information. properties: fee: $ref: '#/components/schemas/Fee' type: object x-go-package: github.com/wallester/api/model GetFeesStatementResponse: properties: fees_statement: items: $ref: '#/components/schemas/FeesStatement' type: array x-go-name: FeesStatement type: object x-go-package: github.com/wallester/api/model GetFraudCaseHistoryResponse: title: GetFraudCaseHistoryResponse represents get fraud case history response. properties: history: description: List of account information changes items: $ref: '#/components/schemas/FraudCaseHistory' type: array x-go-name: History total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetFraudCaseResponse: title: GetFraudCaseResponse returns specific fraud case information. properties: fraud_case: $ref: '#/components/schemas/FraudCase' type: object x-go-package: github.com/wallester/api/model GetFraudCasesCardOwnersResponse: title: GetFraudCasesCardOwnersResponse returns company or person IDs and names. properties: card_owners: description: List of fraud cases card owners items: $ref: '#/components/schemas/CardOwner' type: array x-go-name: CardOwners total_records_number: description: >- Total number of found fraud cases card owners satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetFraudCasesResponse: title: GetFraudCasesResponse returns fraud cases. properties: fraud_cases: description: List of fraud cases items: $ref: '#/components/schemas/FraudCase' type: array x-go-name: FraudCases total_records_number: description: Total number of found fraud cases satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetKYCCheckResponse: title: GetKYCCheckResponse returns specific KYC check information. properties: kyc_check: $ref: '#/components/schemas/KYCCheck' type: object x-go-package: github.com/wallester/api/model GetKYCChecksResponse: properties: kyc_checks: description: List of KYC checks items: $ref: '#/components/schemas/KYCCheck' type: array x-go-name: KYCChecks total_records_number: description: Total number of KYC checks format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetKYCDocumentDetailsResponse: title: GetKYCDocumentDetailsResponse returns specific KYC check information. properties: kyc_document: $ref: '#/components/schemas/KYCDocument' type: object x-go-package: github.com/wallester/api/model GetMobileApplicationProductSettingsResponse: title: >- GetMobileApplicationProductSettingsResponse is the response to the request to get mobile application product settings. properties: mobile_application_top_up_enabled: description: Top up enabled type: boolean x-go-name: MobileApplicationTopUpEnabled mobile_application_create_card_enabled: description: Create card enabled type: boolean x-go-name: MobileApplicationCreateCardEnabled mobile_application_tokenization_enabled: description: Tokenization enabled type: boolean x-go-name: MobileApplicationTokenizationEnabled wallets: $ref: '#/components/schemas/Wallets' pin_rules: $ref: '#/components/schemas/PINRules' type: object x-go-package: github.com/wallester/api/model GetPaymentDocumentResponse: title: >- GetPaymentDocumentResponse is the response to the request to get payment document. properties: payment_document: $ref: '#/components/schemas/PaymentDocument' type: object x-go-package: github.com/wallester/api/model GetPaymentDocumentThumbnailsResponse: title: >- GetPaymentDocumentThumbnailsResponse is the response to the request to get payment document thumbnails. properties: payment_documents: items: $ref: '#/components/schemas/PaymentDocument' type: array x-go-name: PaymentDocuments type: object x-go-package: github.com/wallester/api/model GetPendingOrdersResponse: properties: cards: description: List of cards items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards total_records_number: description: Total number of cards format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetPersonAccountsResponse: title: GetPersonAccountsResponse lists accounts of a person. properties: accounts: description: List of person accounts items: $ref: '#/components/schemas/Account' type: array x-go-name: Accounts total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetPersonAdditionalInfoResponse: title: >- GetPersonAdditionalInfoResponse is the response to the request to get person additional info. properties: person_additional_info: $ref: '#/components/schemas/PersonAdditionalInfo' type: object x-go-package: github.com/wallester/api/model GetPersonAdditionalInfosResponse: title: >- GetPersonAdditionalInfosResponse is the response to the request to get person additional infos. properties: person_additional_infos: items: $ref: '#/components/schemas/PersonAdditionalInfo' type: array x-go-name: PersonAdditionalInfos type: object x-go-package: github.com/wallester/api/model GetPersonByExternalIDResponse: properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model GetPersonCardsResponse: title: GetPersonCardsResponse lists cards of a person. properties: cards: description: List of person cards items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetPersonHistoryResponse: title: GetPersonHistoryResponse represents get person history response. properties: history: description: List of person information changes items: $ref: '#/components/schemas/History' type: array x-go-name: History total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetPersonResponse: title: GetPersonResponse returns specific person information. properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model GetPersonUsersResponse: title: GetPersonUsersResponse represents get person users response. properties: person_users: description: User profile with user data items: $ref: '#/components/schemas/UserWithProfile' type: array x-go-name: PersonUsers total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetRepresentativeHistoryResponse: title: >- GetRepresentativeHistoryResponse represents get representative history response. properties: history: description: List of company information changes items: $ref: '#/components/schemas/History' type: array x-go-name: History total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetRepresentativeResponse: title: GetRepresentativeResponse returns specific representative information. properties: representative: $ref: '#/components/schemas/Representative' type: object x-go-package: github.com/wallester/api/model GetRepresentativesResponse: properties: representatives: description: List of representatives items: $ref: '#/components/schemas/Representative' type: array x-go-name: Representatives total_records_number: description: Total number of records found format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetReservedSettlementBalanceResponse: properties: amount: description: Settlement risk limit amount format: double type: number x-go-name: Amount authorizations_count: description: Total number of authorizations for current day format: int64 type: integer x-go-name: AuthorizationsCount authorizations_total_reserved_amount: description: Total reserved amount of authorizations for current day format: double type: number x-go-name: AuthorizationsTotalReservedAmount pending_authorizations_count: description: Total number of pending authorizations format: int64 type: integer x-go-name: PendingAuthorizationsCount pending_authorizations_total_reserved_amount: description: Total reserved amount of pending authorizations format: double type: number x-go-name: PendingAuthorizationsTotalReservedAmount currency_code: description: Currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode type: object x-go-package: github.com/wallester/api/model GetServiceAccessResponse: title: >- GetServiceAccessResponse represents response for get service access request. properties: services: description: Services items: $ref: '#/components/schemas/Service' type: array x-go-name: Services type: object x-go-package: github.com/wallester/api/model GetTemplateResponse: title: GetTemplateResponse returns template. properties: template: $ref: '#/components/schemas/Template' type: object x-go-package: github.com/wallester/api/model GetTemplatesResponse: title: GetTemplatesResponse returns list of templates. properties: templates: description: List of templates items: $ref: '#/components/schemas/Template' type: array x-go-name: Templates total_records_number: description: Total number of templates format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetTransactionResponse: title: >- GetTransactionResponse returns specific transaction information with enriched merchant. properties: transaction: $ref: '#/components/schemas/TransactionWithEnrichedMerchant' type: object x-go-package: github.com/wallester/api/model GetTransactionsByProductIDResponse: title: >- GetTransactionsByProductIDResponse represents get product transactions response. properties: transactions: description: List of transactions items: $ref: '#/components/schemas/Transaction' type: array x-go-name: Transactions total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GetUserResponse: title: GetUserResponse represents response for Get API user request. properties: user: $ref: '#/components/schemas/APIUser' products: description: Products items: $ref: '#/components/schemas/Product' type: array x-go-name: Products type: object x-go-package: github.com/wallester/api/model GetUsersResponse: title: GetUsersResponse represents response for list API users request. properties: users: description: API users items: $ref: '#/components/schemas/APIUser' type: array x-go-name: Users total_records_number: description: Total number of records format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model GooglePayPushProvisioningRequest: properties: client_wallet_account_id: description: >- ClientWalletAccountID is client-provided consumer ID that identifies the Wallet Account Holder entity type: string x-go-name: ClientWalletAccountID client_device_id: description: >- ClientDeviceID is stable device identification set by Wallet Provider type: string x-go-name: ClientDeviceID verify_cardholder: description: >- VerifyCardholder is cardholder will be prompted to verify himself using an OTP SMS/Email or Call center type: boolean x-go-name: VerifyCardholder required: - client_wallet_account_id - client_device_id type: object x-go-package: github.com/wallester/api/model GooglePayPushProvisioningResponse: title: >- GooglePayPushProvisioningResponse returns encrypted payload for the Wallet. properties: encrypted_data: type: string x-go-name: EncryptedData type: object x-go-package: github.com/wallester/api/model History: title: History represents audit log, one history record per field. properties: created_at: description: Date-time when the change has been made format: date-time type: string x-go-name: CreatedAt created_by: description: ID of the user who has made the change type: string x-go-name: CreatedBy field: description: Field name that has been changed type: string x-go-name: Field old_value: description: Old value of the field type: string x-go-name: OldValue new_value: description: New value of the field type: string x-go-name: NewValue type: object x-go-package: github.com/wallester/api/model IDVResult: properties: created_at: description: |- Date-time in UTC when the object was created Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: CreatedAt report_link: description: Report link maxLength: 500 type: string x-go-name: ReportLink source: $ref: '#/components/schemas/IDVResultSource' status: $ref: '#/components/schemas/IDVResultStatus' required: - created_at - report_link - source - status type: object x-go-package: github.com/wallester/api/model IDVResultSource: enum: - Jumio - Onfido - Sumsub - Veriff type: string x-go-package: github.com/wallester/common/model IDVResultStatus: enum: - Approved - Consider - Declined type: string x-go-package: github.com/wallester/common/model IncentiveNotification: properties: card_id: format: uuid4 type: string x-go-name: CardID required: - card_id type: object x-go-package: github.com/wallester/api/model/webhooks InitiateAction: properties: data: $ref: '#/components/schemas/ThreeDSInitiateAction' event: description: Event identifier enum: - initiate_action type: string x-go-name: Event type: description: Event type enum: - 3ds type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks IsCardRenewalAllowedResponse: title: >- IsCardRenewalAllowedResponse represents is card renewal allowed response. properties: IsCardRenewalAllowed: type: boolean type: object x-go-package: github.com/wallester/api/model KYBStatus: enum: - NotConfirmed - Pending - PendingManual - Rejected - Verified type: string x-go-package: github.com/wallester/common/model KYCCheck: properties: id: description: KYCCheck ID format: uuid4 type: string x-go-name: ID applicant_id: description: Applicant ID type: string x-go-name: ApplicantID person_id: description: Person ID format: uuid4 type: string x-go-name: PersonID idv_result: $ref: '#/components/schemas/IDVResult' status: $ref: '#/components/schemas/KYCCheckStatus' reject_reason: $ref: '#/components/schemas/KYCCheckRejectReason' reject_reason_comment: description: Reject reason comment type: string x-go-name: RejectReasonComment created_at: format: date-time type: string x-go-name: CreatedAt created_by: description: ID of the user who has created KYC check type: string x-go-name: CreatedBy updated_at: format: date-time type: string x-go-name: UpdatedAt updated_by: description: ID of the user who has made the change type: string x-go-name: UpdatedBy deleted_at: format: date-time type: string x-go-name: DeletedAt deleted_by: description: ID of the user who has made the change type: string x-go-name: DeletedBy required: - person_id type: object x-go-package: github.com/wallester/api/model KYCCheckEvent: properties: data: $ref: '#/components/schemas/KYCCheckView' event: description: Event identifier enum: - create - delete - reject - approve type: string x-go-name: Event type: description: Event type enum: - kyc_check type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks KYCCheckRejectReason: enum: - BlurryImage - DifferentBirthdate - DocumentDamaged - ExpiredDocument - InformationOnDocumentPartlyCovered - NameMismatch - Other - PersonUnder18YearsOfAge type: string x-go-package: github.com/wallester/common/model KYCCheckStatus: enum: - Approved - Created - Pending - Rejected type: string x-go-package: github.com/wallester/common/model KYCCheckView: properties: applicant_id: type: string x-go-name: ApplicantID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy deleted_at: example: '1625932529' type: string x-go-name: DeletedAt deleted_by: type: string x-go-name: DeletedBy id: format: uuid4 type: string x-go-name: ID idv_result: $ref: '#/components/schemas/EventIDVResult' person_id: format: uuid4 type: string x-go-name: PersonID reject_reason: $ref: '#/components/schemas/KYCCheckRejectReason' reject_reason_comment: type: string x-go-name: RejectReasonComment status: $ref: '#/components/schemas/KYCCheckStatus' updated_at: example: '1625932529' type: string x-go-name: UpdatedAt updated_by: type: string x-go-name: UpdatedBy required: - id - applicant_id - person_id - status - created_at - created_by type: object x-go-package: github.com/wallester/api/model/webhooks KYCDocument: properties: id: description: KYC document ID format: uuid4 type: string x-go-name: ID kyc_check_id: description: KYC check ID format: uuid4 type: string x-go-name: KYCCheckID issuer: description: Issuer country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: Issuer number: description: Number type: string x-go-name: Number type: description: KYC document Type enum: - IDVDocument - IDVSelfieImage - IDVReport type: string x-go-name: Type subtype: description: KYC document subtype enum: - NationalIDFront - NationalIDBack - DrivingLicenseBack - DrivingLicenseFront - ResidencePermitBack - ResidencePermitFront - Passport type: string x-go-name: Subtype created_at: format: date-time type: string x-go-name: CreatedAt created_by: description: ID of the user who has created KYC document type: string x-go-name: CreatedBy type: object x-go-package: github.com/wallester/api/model KYCDocumentFile: properties: Body: items: format: uint8 type: integer type: array Name: type: string type: object x-go-package: github.com/wallester/api/model KYCPerson: properties: title: $ref: '#/components/schemas/Title' address: $ref: '#/components/schemas/KYCPersonAddress' birth_country_code: enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: BirthCountryCode birth_date: format: date type: string x-go-name: BirthDate created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy document_number: type: string x-go-name: DocumentNumber email: format: email type: string x-go-name: Email external_id: type: string x-go-name: ExternalID first_name: type: string x-go-name: FirstName gender: $ref: '#/components/schemas/Gender' id: format: uuid4 type: string x-go-name: ID is_adverse_media_involved: type: boolean x-go-name: IsAdverseMediaInvolved is_beneficial_owner: type: boolean x-go-name: IsBeneficialOwner is_politically_exposed_person: type: boolean x-go-name: IsPoliticallyExposedPerson is_represented_by_someone_else: type: boolean x-go-name: IsRepresentedBySomeoneElse is_sanctions_related: type: boolean x-go-name: IsSanctionsRelated kyc_status: $ref: '#/components/schemas/KYCStatus' last_name: type: string x-go-name: LastName loyalty_number: type: string x-go-name: LoyaltyNumber middle_name: type: string x-go-name: MiddleName mobile: type: string x-go-name: Mobile personal_number: type: string x-go-name: PersonalNumber personal_number_issuer: enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: PersonalNumberIssuer politically_exposed_person_explanation: type: string x-go-name: PoliticallyExposedPersonExplanation preferred_language_code: type: string x-go-name: PreferredLanguageCode push_notifications_enabled: type: boolean x-go-name: PushNotificationsEnabled residence_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: ResidenceCountryCode risk_profile: $ref: '#/components/schemas/RiskProfile' status: $ref: '#/components/schemas/PersonStatus' status_reason_code: $ref: '#/components/schemas/PersonStatusReasonCode' status_reason_text: type: string x-go-name: StatusReasonText updated_at: example: '1625932529' type: string x-go-name: UpdatedAt updated_by: type: string x-go-name: UpdatedBy required: - id - personal_number_issuer - title - first_name - last_name - mobile - created_at - created_by - birth_country_code - is_represented_by_someone_else - is_politically_exposed_person - is_beneficial_owner - risk_profile - status - push_notifications_enabled - is_sanctions_related - is_adverse_media_involved type: object x-go-package: github.com/wallester/api/model/webhooks KYCPersonAddress: properties: address1: type: string x-go-name: Address1 address2: type: string x-go-name: Address2 city: type: string x-go-name: City country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: CountryCode postal_code: type: string x-go-name: PostalCode type: object x-go-package: github.com/wallester/api/model/webhooks KYCStatus: enum: - NotConfirmed - Pending - PendingManual - Rejected - Verified type: string x-go-package: github.com/wallester/common/model KYCStatusChange: properties: data: $ref: '#/components/schemas/KYCPerson' event: description: Event identifier enum: - kyc_status_update type: string x-go-name: Event type: description: Event type enum: - person type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks LanguageCode: title: Language code in ISO 639-2/T standard. enum: - AAR - ABK - AFR - AKA - AMH - ARA - ARG - ASM - AVA - AVE - AYM - AZE - BAK - BAL - BAM - BEL - BEN - BIH - BIS - BOD - BOS - BRE - BUL - CAT - CES - CHA - CHE - CHU - CHV - COR - COS - CRE - CYM - DAN - DEU - DIV - DZO - ELL - ENG - EPO - EST - EUS - EWE - FAO - FAS - FIJ - FIN - FRA - FRY - FUL - GLA - GLE - GLG - GLV - GRN - GUJ - HAT - HAU - HEB - HER - HIN - HMO - HRV - HUN - HYE - IBO - IDO - III - IKU - ILE - INA - IND - IPK - ISL - ITA - JAV - JPN - KAL - KAN - KAS - KAT - KAU - KAZ - KHM - KIK - KIN - KIR - KOM - KON - KOR - KUA - KUR - LAO - LAT - LAV - LIJ - LIN - LIT - LTZ - LUB - LUG - MAH - MAL - MAR - MKD - MLG - MLT - MON - MRI - MSA - MYA - NAU - NAV - NBL - NDE - NDO - NEP - NLD - NNO - NOB - NOR - NYA - OCI - OJI - ORI - ORM - OSS - PAN - PLI - POL - POR - PUS - QUE - ROH - RON - RUN - RUS - SAG - SAN - SIN - SLK - SLV - SME - SMO - SNA - SND - SOM - SOT - SPA - SQI - SRD - SRP - SSW - SUN - SWA - SWE - TAH - TAM - TAT - TEL - TGK - TGL - THA - TIR - TON - TSN - TSO - TUK - TUR - TWI - UIG - UKR - URD - UZB - VEN - VIE - VOL - WLN - WOL - XHO - YID - YOR - ZHA - ZHO - ZUL type: string x-go-package: github.com/wallester/common/model LinkCardToAccountResponse: properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model LocationSource: enum: - CELLULAR - GPS - OTHER - WIFI type: string x-go-package: github.com/wallester/common/model MerchantCategoryCode: enum: - '0742' - '0763' - '0780' - '1520' - '1711' - '1731' - '1740' - '1750' - '1761' - '1771' - '1799' - '2842' - '4011' - '4111' - '4112' - '4119' - '4121' - '4131' - '4214' - '4215' - '4225' - '4411' - '4457' - '4468' - '4511' - '4582' - '4722' - '4784' - '4789' - '4812' - '4814' - '4816' - '4821' - '4829' - '4899' - '4900' - '5013' - '5137' - '5139' - '5200' - '5211' - '5231' - '5251' - '5261' - '5271' - '5300' - '5309' - '5310' - '5311' - '5331' - '5411' - '5422' - '5441' - '5451' - '5462' - '5499' - '5511' - '5521' - '5532' - '5533' - '5541' - '5542' - '5561' - '5571' - '5592' - '5598' - '5599' - '5611' - '5621' - '5631' - '5641' - '5651' - '5655' - '5661' - '5681' - '5691' - '5697' - '5699' - '5712' - '5713' - '5714' - '5718' - '5719' - '5722' - '5732' - '5733' - '5735' - '5811' - '5812' - '5813' - '5814' - '5912' - '5931' - '5932' - '5933' - '5937' - '5940' - '5941' - '5942' - '5943' - '5945' - '5946' - '5947' - '5948' - '5949' - '5950' - '5962' - '5967' - '5970' - '5971' - '5972' - '5973' - '5975' - '5976' - '5977' - '5978' - '5983' - '5992' - '5993' - '5994' - '5995' - '5996' - '5997' - '5998' - '5999' - '6010' - '6011' - '6051' - '6300' - '7011' - '7012' - '7032' - '7033' - '7210' - '7211' - '7216' - '7217' - '7221' - '7230' - '7251' - '7261' - '7273' - '7276' - '7277' - '7278' - '7296' - '7297' - '7298' - '7299' - '7311' - '7321' - '7322' - '7333' - '7338' - '7339' - '7342' - '7349' - '7361' - '7372' - '7375' - '7379' - '7392' - '7393' - '7394' - '7395' - '7399' - '7512' - '7513' - '7519' - '7523' - '7531' - '7538' - '7829' - '7832' - '7841' - '7911' - '7922' - '7929' - '7932' - '7933' - '7941' - '7991' - '7992' - '7993' - '7994' - '7995' - '7996' - '7997' - '7998' - '7999' - '8011' - '8021' - '8031' - '8041' - '8042' - '8043' - '8049' - '8050' - '8062' - '8071' - '8099' - '8111' - '8351' - '8911' - '8931' - '8999' - '9223' - '9402' type: string x-go-package: github.com/wallester/common/model MessageType: title: Message type. enum: - ClientFrozen - ClientUnfrozen - CompanyDeletedEmployee - CompanyInvitedEmployee - CompanyRequestedAddPersonAsEmployee - DebtNegativeBalanceNotification - DebtNegativeBalanceNotificationReminder - FeesStatementNotification - NotifyCardOrder - NotifyCardholderOnChipAndPinCardActivation - NotifyCardholderOnDisabledInternetPurchase - NotifyCardholderOnInsufficientFunds - NotifyCardholderOnStickerActivation - NotifyClientAboutVibanCreation - NotifyClientOnRejection - NotifyClientOnRejectionOfVerificationFields - NotifyClientOnSuccessfulVerification - PaymentReminderNotification - RaiseCompanyLimitsRequest - RaiseCompanyLimitsThanks - Send3DSAttemptNotification - Send3DSOTP - Send3DSPasswordOnCardActivation - Send3DSPasswordOnCardCreation - Send3DSPasswordOnInternetPurchasesEnabled - Send3DSPasswordToCardholder - SendAbandonedProvisioningApplePayNotificationToCardholder - SendActivationOTPCode - SendAdjustAccountBalanceToCardholder - SendApplePayCardRemovedNotification - SendApplePayCardRenewedNotification - SendCardBlockNotificationToCardholder - SendCloseClientCancellation - SendCustomNotificationToCardholder - SendDeclinedAuthorizationNotificationToCardholder - SendForgotPasswordLinkToCardholder - SendFraudAlert - SendFraudDeclinedAuthorizationApplePayNotificationToCardholder - SendInactiveCustomerApplePayNotificationToCardHolder - SendInvitationSMSToEmployee - SendInvitationToCardUser - SendLinkToSetPasswordToCardholder - SendLowSettlementRiskLimitNotification - SendMobileOTP - SendMultiCurrencyRequest - SendOTPToCardholderAppleWatch - SendOTPToCardholderIMac - SendOTPToCardholderIPad - SendOTPToCardholderIPhone - SendPINToCardholderForChipAndPin - SendPINToCardholderForSticker - SendPaymentNotificationToCardholder - SendPendingProvisioningApplePayNotificationToCardholder - SendRepresentativeVerificationLink - SendStatementToUser - SendSuccessfulOnboardingNotification - SendTokenAuthenticationOTP - SendTokenCreateApplePayNotificationToCardHolder - SendTokenCreateNotificationToCardHolder - SendVerificationEmailToCardholder - SendVerificationEmailToClient - SendVerificationSMSToCardholder - SendVerificationSMSToClient - SendVerificationSMSToUser - ShareholderBoardMemberKYCVerfication - TerminateByClient - TerminateByRegulator - TerminateByServiceProvider - TopUpNotification type: string x-go-package: github.com/wallester/common/model MimeType: enum: - application/pdf - application/vnd.ms-excel - application/vnd.oasis.opendocument.text - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document - application/xml - application/zip - image/jpeg - image/png - text/csv - text/xml type: string x-go-package: github.com/wallester/common/model OSType: enum: - ANDROID - BLACKBERRY - IOS - OTHER - TIZEN - WINDOWS type: string x-go-package: github.com/wallester/common/model OfficeCoordinates: properties: latitude: type: string x-go-name: Latitude longitude: type: string x-go-name: Longitude type: object x-go-package: github.com/wallester/api/model OnfidoReportName: title: Onfido report name. enum: - document - document_with_address_information - document_with_driving_licence_information - facial_similarity_photo - facial_similarity_photo_fully_auto - facial_similarity_video - identity_enhanced - known_faces - proof_of_address - right_to_work - us_driving_licence - watchlist_enhanced - watchlist_peps_only - watchlist_sanctions_only - watchlist_standard type: string x-go-package: github.com/wallester/common/model OrderCardsBatchRequest: properties: personalization_product_code: description: Personalization product code type: string x-go-name: PersonalizationProductCode carrier_type: $ref: '#/components/schemas/CarrierType' notification_email: description: Email is required only if SendNotificationEmail is set to true. maxLength: 255 type: string x-go-name: NotificationEmail send_notification_email: description: Send notification email sends notification if set to true. type: boolean x-go-name: SendNotificationEmail number_of_cards: description: Number of cards format: int32 maximum: 1000 minimum: 1 type: integer x-go-name: NumberOfCards delivery_address: $ref: '#/components/schemas/BatchDeliveryAddress' embossing_name: description: Embossing name maxLength: 26 minLength: 2 type: string x-go-name: EmbossingName required: - personalization_product_code - number_of_cards - delivery_address type: object x-go-package: github.com/wallester/api/model OrderCardsBatchResponse: properties: cards: items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards type: object x-go-package: github.com/wallester/api/model OrderedCardEvent: properties: data: $ref: '#/components/schemas/OrderedCardEventView' event: description: Event identifier enum: - order type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks OrderedCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Ordered type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks PINRules: properties: must_contain_only_digits: type: boolean x-go-name: MustContainOnlyDigits must_be_at_least_4_digits: type: boolean x-go-name: MustBeAtLeast4Digits must_be_max_12_digits: type: boolean x-go-name: MustBeMax12Digits not_allowed_same_digits: type: boolean x-go-name: NotAllowedSameDigits not_allowed_consecutive_numbers: type: boolean x-go-name: NotAllowedConsecutiveNumbers type: object x-go-package: github.com/wallester/api/model PaymentDocument: properties: id: description: Payment document ID format: uuid4 type: string x-go-name: ID payment_id: description: Payment ID format: uuid4 type: string x-go-name: PaymentID payment_type: $ref: '#/components/schemas/PaymentType' file_name: description: File name type: string x-go-name: FileName mime_type: $ref: '#/components/schemas/MimeType' file_body: description: Body type: string x-go-name: FileBody created_at: description: Date-time the payment document was created at format: date-time type: string x-go-name: CreatedAt created_by: description: ID of the user who created the payment document type: string x-go-name: CreatedBy type: object x-go-package: github.com/wallester/api/model PaymentType: enum: - authorization - transaction type: string x-go-package: github.com/wallester/common/model Person: title: Person represents a person. allOf: - properties: title: $ref: '#/components/schemas/Title' address: $ref: '#/components/schemas/PersonAddress' address1: description: |- DEPRECATED Address line 1 maxLength: 45 type: string x-go-name: Address1 address2: description: |- DEPRECATED Address line 2 maxLength: 45 type: string x-go-name: Address2 birth_country_code: description: Birth country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: BirthCountryCode birth_date: description: Birthdate. Must be in 2006-01-02 format. format: date type: string x-go-name: BirthDate city: description: |- DEPRECATED City maxLength: 35 type: string x-go-name: City document_number: description: Document number maxLength: 100 type: string x-go-name: DocumentNumber email: description: |- E-mail address.
__Required if Mobile is empty.__ format: email maxLength: 255 type: string x-go-name: Email expected_turnover: description: ExpectedTurnover enum: - From0to1500 - From1501to3000 - From3001to5000 - From5001to15000 - From15001AndMore type: string x-go-name: ExpectedTurnover external_id: description: External ID must be unique for every person on product. maxLength: 50 type: string x-go-name: ExternalID first_name: description: >- First name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName gender: $ref: '#/components/schemas/Gender' is_adverse_media_involved: description: |- Is Adverse Media Involved?
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved is_beneficial_owner: description: Whether the person is beneficial owner or not type: boolean x-go-name: IsBeneficialOwner is_politically_exposed_person: description: |- Whether the person is politically exposed or not.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsPoliticallyExposedPerson is_represented_by_someone_else: description: Whether the person is representative or not type: boolean x-go-name: IsRepresentedBySomeoneElse is_sanctions_related: description: |- Is Sanctions Related?
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated last_name: description: >- Last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName loyalty_number: description: Loyalty number maxLength: 20 minLength: 20 type: string x-go-name: LoyaltyNumber middle_name: description: >- Middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed.
__Required if Email is empty.__ type: string x-go-name: Mobile personal_number: description: Personal number must be unique for every person on product. maxLength: 20 type: string x-go-name: PersonalNumber personal_number_issuer: description: >- Personal number issuer country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: PersonalNumberIssuer politically_exposed_person_explanation: description: Explanation of politically exposed person maxLength: 255 type: string x-go-name: PoliticallyExposedPersonExplanation postal_code: description: |- DEPRECATED Postal code maxLength: 10 type: string x-go-name: PostalCode preferred_language_code: $ref: '#/components/schemas/LanguageCode' residence_country_code: description: >- Residence country code. Must be in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode risk_profile: $ref: '#/components/schemas/APIRiskProfile' required: - first_name - last_name - birth_date - residence_country_code - is_represented_by_someone_else - is_beneficial_owner type: object - properties: business_relationship_purpose: description: Business relationship purpose maxLength: 255 type: string x-go-name: BusinessRelationshipPurpose created_at: description: |- Date-time the person was created at Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: CreatedAt deactivated_at: description: |- Date-time the person was deactivated at Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: DeactivatedAt id: description: Person ID format: uuid4 type: string x-go-name: ID kyc_status: $ref: '#/components/schemas/KYCStatus' push_notifications_enabled: description: Are push notifications enabled for cardholder type: boolean x-go-name: PushNotificationsEnabled status: $ref: '#/components/schemas/PersonStatus' updated_at: description: |- Date-time the person was updated at Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: UpdatedAt type: object x-go-package: github.com/wallester/api/model Person3DSSettingsResponse: description: Person3DSSettingsResponse properties: id: description: ID format: uuid4 type: string x-go-name: ID person_id: description: Person ID format: uuid4 type: string x-go-name: PersonID email: description: Email type: string x-go-name: Email mobile: description: Mobile type: string x-go-name: Mobile password: description: Password type: string x-go-name: Password force_usage: description: ForceUsage type: boolean x-go-name: ForceUsage card_default_settings: description: CardDefaultSettings type: boolean x-go-name: CardDefaultSettings type: object x-go-package: github.com/wallester/api/model PersonAdditionalInfo: title: PersonAdditionalInfo represents person additional info. allOf: - properties: key: description: >- Key must be unique. Allowed case-insensitive characters: [a-z0-9] maxLength: 50 type: string x-go-name: Key value: description: Value maxLength: 50 type: string x-go-name: Value required: - key type: object - properties: created_at: format: date-time type: string x-go-name: CreatedAt created_by: description: ID of the user who has created person additional info type: string x-go-name: CreatedBy deleted_at: format: date-time type: string x-go-name: DeletedAt deleted_by: description: ID of the user who has deleted person additional info type: string x-go-name: DeletedBy id: description: ID format: uuid4 type: string x-go-name: ID person_id: description: Person ID format: uuid4 type: string x-go-name: PersonID updated_at: format: date-time type: string x-go-name: UpdatedAt updated_by: description: ID of the user who has updated person additional info type: string x-go-name: UpdatedBy type: object x-go-package: github.com/wallester/api/model PersonAdditionalInfoFields: properties: key: description: 'Key must be unique. Allowed case-insensitive characters: [a-z0-9]' maxLength: 50 type: string x-go-name: Key value: description: Value maxLength: 50 type: string x-go-name: Value required: - key type: object x-go-package: github.com/wallester/api/model PersonAddress: properties: address1: description: Address line 1 maxLength: 45 type: string x-go-name: Address1 address2: description: Address line 2 maxLength: 45 type: string x-go-name: Address2 city: description: City maxLength: 35 type: string x-go-name: City postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode country_code: description: Country Code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: CountryCode type: object x-go-package: github.com/wallester/api/model PersonFields: properties: title: $ref: '#/components/schemas/Title' personal_number: description: Personal number must be unique for every person on product. maxLength: 20 type: string x-go-name: PersonalNumber personal_number_issuer: description: >- Personal number issuer country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: PersonalNumberIssuer first_name: description: >- First name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName middle_name: description: >- Middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName last_name: description: >- Last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName birth_date: description: Birthdate. Must be in 2006-01-02 format. format: date type: string x-go-name: BirthDate birth_country_code: description: Birth country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: BirthCountryCode gender: $ref: '#/components/schemas/Gender' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed.
__Required if Email is empty.__ type: string x-go-name: Mobile email: description: |- E-mail address.
__Required if Mobile is empty.__ format: email maxLength: 255 type: string x-go-name: Email external_id: description: External ID must be unique for every person on product. maxLength: 50 type: string x-go-name: ExternalID residence_country_code: description: Residence country code. Must be in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode is_represented_by_someone_else: description: Whether the person is representative or not type: boolean x-go-name: IsRepresentedBySomeoneElse is_beneficial_owner: description: Whether the person is beneficial owner or not type: boolean x-go-name: IsBeneficialOwner is_politically_exposed_person: description: |- Whether the person is politically exposed or not.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsPoliticallyExposedPerson politically_exposed_person_explanation: description: Explanation of politically exposed person maxLength: 255 type: string x-go-name: PoliticallyExposedPersonExplanation risk_profile: $ref: '#/components/schemas/APIRiskProfile' loyalty_number: description: Loyalty number maxLength: 20 minLength: 20 type: string x-go-name: LoyaltyNumber document_number: description: Document number maxLength: 100 type: string x-go-name: DocumentNumber address1: description: |- DEPRECATED Address line 1 maxLength: 45 type: string x-go-name: Address1 address2: description: |- DEPRECATED Address line 2 maxLength: 45 type: string x-go-name: Address2 city: description: |- DEPRECATED City maxLength: 35 type: string x-go-name: City postal_code: description: |- DEPRECATED Postal code maxLength: 10 type: string x-go-name: PostalCode address: $ref: '#/components/schemas/PersonAddress' is_sanctions_related: description: |- Is Sanctions Related?
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: |- Is Adverse Media Involved?
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved preferred_language_code: $ref: '#/components/schemas/LanguageCode' expected_turnover: description: ExpectedTurnover enum: - From0to1500 - From1501to3000 - From3001to5000 - From5001to15000 - From15001AndMore type: string x-go-name: ExpectedTurnover required: - first_name - last_name - birth_date - residence_country_code - is_represented_by_someone_else - is_beneficial_owner type: object x-go-package: github.com/wallester/api/model PersonStatus: title: Person status. enum: - Active - Deactivated - Rejected type: string x-go-package: github.com/wallester/common/model PersonStatusReasonCode: title: Person status reason code. enum: - Declined - Prohibited - Rejected - Test type: string x-go-package: github.com/wallester/common/model PersonalizationProductCodesResponse: title: >- PersonalizationProductCodesResponse represents get personalization product codes response. properties: personalization_default_product_code: type: string x-go-name: PersonalizationDefaultProductCode personalization_virtual_default_product_code: type: string x-go-name: PersonalizationVirtualDefaultProductCode personalization_product_codes: items: type: string type: array x-go-name: PersonalizationProductCodes card_design_update_info: items: $ref: '#/components/schemas/CardDesignUpdateInfo' type: array x-go-name: CardDesignUpdateInfo type: object x-go-package: github.com/wallester/api/model PersonalizeCardEvent: properties: data: $ref: '#/components/schemas/PersonalizeCardEventView' event: description: Event identifier enum: - personalize type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks PersonalizeCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - Personalized type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks PingRequest: title: PingRequest represents a test ping request. properties: message: description: Ping message type: string x-go-name: Message required: - message type: object x-go-package: github.com/wallester/api/model PingResponse: title: PingResponse represents a test ping response. properties: message: type: string x-go-name: Message type: object x-go-package: github.com/wallester/api/model PricingPlanType: title: Employee status. enum: - Custom - Free - Platinum - Premium type: string x-go-package: github.com/wallester/common/model Product: title: Product represents a product. properties: id: description: Product ID format: uuid4 type: string x-go-name: ID client_id: description: Client ID format: uuid4 type: string x-go-name: ClientID code: description: Product code type: string x-go-name: Code deleted_at: description: |- Date-time the client was deleted at Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: DeletedAt type: object x-go-package: github.com/wallester/api/model ProductFeesByProductIDResponse: properties: default_fee_complex_authorization_atm_withdrawal_fixed_part: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalFixedPart default_fee_complex_authorization_atm_withdrawal_min: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalMin default_fee_complex_authorization_atm_withdrawal_percentage_part: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalPercentagePart default_fee_fixed_rate_authorization_atm_balance_inquiry: format: double type: number x-go-name: DefaultFeeFixedRateAuthorizationATMBalanceInquiry default_fee_fixed_rate_authorization_atm_withdrawal: format: double type: number x-go-name: DefaultFeeFixedRateAuthorizationATMWithdrawal default_fee_fixed_rate_authorization_declined: format: double type: number x-go-name: DefaultFeeFixedRateAuthorizationDeclined default_fee_fixed_rate_authorization_declined_atm: format: double type: number x-go-name: DefaultFeeFixedRateAuthorizationDeclinedATM default_fee_fixed_rate_card_replacement: format: double type: number x-go-name: DefaultFeeFixedRateCardReplacement default_fee_fixed_rate_pin_change: format: double type: number x-go-name: DefaultFeeFixedRatePINChange default_fee_percentage_rate_authorization_atm_withdrawal: format: double type: number x-go-name: DefaultFeePercentageRateAuthorizationATMWithdrawal default_fee_percentage_rate_authorization_atm_withdrawal_fixed_min: format: double type: number x-go-name: DefaultFeePercentageRateAuthorizationATMWithdrawalFixedMin default_fee_percentage_rate_authorization_foreign_exchange: format: double type: number x-go-name: DefaultFeePercentageRateAuthorizationForeignExchange default_fee_percentage_rate_authorization_foreign_exchange_fixed_min: format: double type: number x-go-name: DefaultFeePercentageRateAuthorizationForeignExchangeFixedMin default_fee_fixed_rate_card_usage: format: double type: number x-go-name: DefaultFeeFixedRateCardUsage default_fee_payment_percentage_part: format: double type: number x-go-name: DefaultFeePaymentPercentagePart default_fee_payment_fixed_part: format: double type: number x-go-name: DefaultFeePaymentFixedPart default_fee_payment_fixed_min: format: double type: number x-go-name: DefaultFeePaymentFixedMin default_fee_complex_authorization_atm_withdrawal_eea_percentage_part: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalEEAPercentagePart default_fee_complex_authorization_atm_withdrawal_eea_fixed_part: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalEEAFixedPart default_fee_complex_authorization_atm_withdrawal_eea_min: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalEEAMin default_fee_complex_authorization_atm_withdrawal_international_percentage_part: format: double type: number x-go-name: >- DefaultFeeComplexAuthorizationATMWithdrawalInternationalPercentagePart default_fee_complex_authorization_atm_withdrawal_international_fixed_part: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalInternationalFixedPart default_fee_complex_authorization_atm_withdrawal_international_min: format: double type: number x-go-name: DefaultFeeComplexAuthorizationATMWithdrawalInternationalMin default_fee_complex_payment_eea_percentage_part: format: double type: number x-go-name: DefaultFeeComplexPaymentEEAPercentagePart default_fee_complex_payment_eea_fixed_part: format: double type: number x-go-name: DefaultFeeComplexPaymentEEAFixedPart default_fee_complex_payment_eea_min: format: double type: number x-go-name: DefaultFeeComplexPaymentEEAMin default_fee_complex_payment_international_percentage_part: format: double type: number x-go-name: DefaultFeeComplexPaymentInternationalPercentagePart default_fee_complex_payment_international_fixed_part: format: double type: number x-go-name: DefaultFeeComplexPaymentInternationalFixedPart default_fee_complex_payment_international_min: format: double type: number x-go-name: DefaultFeeComplexPaymentInternationalMin default_fee_fixed_rate_remind_3ds_password: format: double type: number x-go-name: DefaultFeeFixedRateRemind3DSPassword default_fee_fixed_rate_remind_pin: format: double type: number x-go-name: DefaultFeeFixedRateRemindPIN default_fee_fixed_rate_card_express_delivery: format: double type: number x-go-name: DefaultFeeFixedRateCardExpressDelivery default_fee_fixed_rate_payment_eea: format: double type: number x-go-name: DefaultFeeFixedRatePaymentEEA default_fee_fixed_rate_payment_international: format: double type: number x-go-name: DefaultFeeFixedRatePaymentInternational default_fee_fixed_rate_plastic_card_issuance: format: double type: number x-go-name: DefaultFeeFixedRatePlasticCardIssuance default_fee_fixed_rate_virtual_card_issuance: format: double type: number x-go-name: DefaultFeeFixedRateVirtualCardIssuance default_fee_fixed_rate_authorization_eea: format: double type: number x-go-name: DefaultFeeFixedRateAuthorizationEEA default_fee_fixed_rate_authorization_international: format: double type: number x-go-name: DefaultFeeFixedRateAuthorizationInternational default_fee_percentage_rate_incoming_sepa_payment: format: double type: number x-go-name: DefaultFeePercentageRateIncomingSEPAPayment default_fee_fixed_rate_incoming_sepa_payment: format: double type: number x-go-name: DefaultFeeFixedRateIncomingSEPAPayment default_fee_percentage_rate_main_account_transfer: format: double type: number x-go-name: DefaultFeePercentageRateMainAccountTransfer default_fee_fixed_rate_zero_authorization_eea: format: double type: number x-go-name: DefaultFeeFixedRateZeroAuthorizationEEA default_fee_fixed_rate_zero_authorization_international: format: double type: number x-go-name: DefaultFeeFixedRateZeroAuthorizationInternational type: object x-go-package: github.com/wallester/api/model Records: properties: paginated_accounts: items: $ref: '#/components/schemas/Account' type: array x-go-name: Accounts paginated_cards: items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards paginated_persons: items: $ref: '#/components/schemas/Person' type: array x-go-name: Persons type: object x-go-package: github.com/wallester/api/model RecordsCount: properties: accounts_count: format: int64 type: integer x-go-name: Accounts cards_count: format: int64 type: integer x-go-name: Cards persons_count: format: int64 type: integer x-go-name: Persons type: object x-go-package: github.com/wallester/api/model RefundInfo: title: RefundInfo represents an information about refund. properties: is_partial: type: boolean x-go-name: IsPartial comment: type: string x-go-name: Comment type: object x-go-package: github.com/wallester/api/model RegisterCompanyFCMTokenRequest: properties: device_id: description: Device ID maxLength: 4096 type: string x-go-name: DeviceID fcm_token: description: Firebase token maxLength: 255 type: string x-go-name: FCMToken required: - device_id - fcm_token type: object x-go-package: github.com/wallester/api/model RegisterCompanyFCMTokenResponse: properties: company_fcm_token: $ref: '#/components/schemas/CompanyFCMToken' type: object x-go-package: github.com/wallester/api/model RegisterFCMTokenRequest: properties: device_id: description: Device ID maxLength: 4096 type: string x-go-name: DeviceID fcm_token: description: Firebase token maxLength: 255 type: string x-go-name: FCMToken required: - device_id - fcm_token type: object x-go-package: github.com/wallester/api/model RegisterFCMTokenResponse: properties: fcm_token: $ref: '#/components/schemas/FCMToken' type: object x-go-package: github.com/wallester/api/model ReleaseAuthorizationView: properties: data: $ref: '#/components/schemas/EventAuthorization' event: description: Event identifier enum: - notification type: string x-go-name: Event type: description: Event type enum: - authorization_release type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks RemoveRepresentativeResponse: title: >- RemoveRepresentativeResponse is the response to the request to remove existing representative. properties: representative: $ref: '#/components/schemas/Representative' type: object x-go-package: github.com/wallester/api/model RenewCardEvent: properties: data: $ref: '#/components/schemas/RenewCardEventView' event: description: Event identifier enum: - renew type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks RenewCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - AwaitingRenewal type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks ReopenAccountResponse: properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model ReplaceCardEvent: properties: data: $ref: '#/components/schemas/ReplaceCardEventView' event: description: Event identifier enum: - replace type: string x-go-name: Event type: description: Event type enum: - card type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ReplaceCardEventView: properties: security: $ref: '#/components/schemas/CardEventSecurity' 3d_secure_settings: $ref: '#/components/schemas/CardEventCard3DSecureSettings' account_id: format: uuid4 type: string x-go-name: AccountID card_metadata_profile_id: format: uuid4 type: string x-go-name: CardMetadataProfileID card_processor_card_id: type: string x-go-name: CardProcessorCardID company_id: format: uuid4 type: string x-go-name: CompanyID created_at: example: '1625932529' type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy delivery_address: $ref: '#/components/schemas/CardEventDeliveryAddress' embossing_name: type: string x-go-name: EmbossingName expiry_date: example: '1625932529' type: string x-go-name: ExpiryDate external_id: type: string x-go-name: ExternalID id: format: uuid4 type: string x-go-name: ID is_disposable: type: boolean x-go-name: IsDisposable is_paid: type: boolean x-go-name: IsPaid limits: $ref: '#/components/schemas/CardEventLimits' masked_card_number: type: string x-go-name: MaskedCardNumber name: type: string x-go-name: Name person_id: format: uuid4 type: string x-go-name: PersonID personalization_product_code: type: string x-go-name: PersonalizationProductCode predecessor_card_id: format: uuid4 type: string x-go-name: PredecessorCardID renew_automatically: type: boolean x-go-name: RenewAutomatically status: enum: - AwaitingRenewal type: string x-go-name: Status type: $ref: '#/components/schemas/CardType' required: - id - type - status - is_paid - created_at - created_by - expiry_date - is_disposable - masked_card_number - renew_automatically - personalization_product_code type: object x-go-package: github.com/wallester/api/model/webhooks ReplaceCardResponse: title: ReplaceCardResponse is the response to the request to replace a card. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model ReplaceCardsBatchRequest: title: >- ReplaceCardsBatchRequest is the response to the request to replace a cards. properties: card_ids: description: Card IDs items: format: uuid4 type: string type: array x-go-name: CardIDs required: - card_ids type: object x-go-package: github.com/wallester/api/model ReplaceCardsBatchResponse: title: >- ReplaceCardsBatchResponse is the response to the request to replace a cards. properties: cards: items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards type: object x-go-package: github.com/wallester/api/model Representative: allOf: - properties: title: $ref: '#/components/schemas/Title' birth_date: description: >- Birthdate. Must be in 2006-01-02 format. Must be at least 16 years old. format: date type: string x-go-name: BirthDate email: description: Email. maxLength: 255 type: string x-go-name: Email first_name: description: >- Representative first name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName is_adverse_media_involved: description: |- Is Adverse Media Involved.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved is_member_of_the_board: description: Is member of the board? type: boolean x-go-name: IsMemberOfTheBoard is_politically_exposed: description: |- Is Politically Exposed.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsPoliticallyExposed is_representative: description: Is representative? type: boolean x-go-name: IsRepresentative is_sanctions_related: description: |- Is Sanctions Related.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_shareholder: description: Is shareholder type: boolean x-go-name: IsShareholder is_ultimate_beneficial_owner: description: Is ultimate beneficial owner? type: boolean x-go-name: IsUltimateBeneficialOwner last_name: description: >- Representative last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName middle_name: description: >- Representative middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile percentage_owned: description: |- Percentage owned.
__If representative is shareholder, minimum value is 1.__ format: float maximum: 100 minimum: 0 type: number x-go-name: PercentageOwned position: description: |- Representative position.
__Field is required for NonRegulated WhiteLabel partners.__ maxLength: 100 type: string x-go-name: Position residence_country_code: description: >- Residence country code. Must be in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode required: - first_name - last_name - birth_date - residence_country_code type: object - properties: created_at: format: date-time type: string x-go-name: CreatedAt created_by: description: Created by type: string x-go-name: CreatedBy deleted_at: format: date-time type: string x-go-name: DeletedAt deleted_by: description: Deleted by type: string x-go-name: DeletedBy id: description: Representative ID format: uuid4 type: string x-go-name: ID kyc_status: $ref: '#/components/schemas/KYCStatus' updated_at: format: date-time type: string x-go-name: UpdatedAt updated_by: description: Updated by type: string x-go-name: UpdatedBy type: object x-go-package: github.com/wallester/api/model RepresentativeFields: properties: title: $ref: '#/components/schemas/Title' first_name: description: >- Representative first name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName middle_name: description: >- Representative middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName last_name: description: >- Representative last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName position: description: |- Representative position.
__Field is required for NonRegulated WhiteLabel partners.__ maxLength: 100 type: string x-go-name: Position is_member_of_the_board: description: Is member of the board? type: boolean x-go-name: IsMemberOfTheBoard is_representative: description: Is representative? type: boolean x-go-name: IsRepresentative is_ultimate_beneficial_owner: description: Is ultimate beneficial owner? type: boolean x-go-name: IsUltimateBeneficialOwner birth_date: description: >- Birthdate. Must be in 2006-01-02 format. Must be at least 16 years old. format: date type: string x-go-name: BirthDate residence_country_code: description: Residence country code. Must be in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode is_sanctions_related: description: |- Is Sanctions Related.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_politically_exposed: description: |- Is Politically Exposed.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsPoliticallyExposed is_adverse_media_involved: description: |- Is Adverse Media Involved.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved is_shareholder: description: Is shareholder type: boolean x-go-name: IsShareholder percentage_owned: description: |- Percentage owned.
__If representative is shareholder, minimum value is 1.__ format: float maximum: 100 minimum: 0 type: number x-go-name: PercentageOwned email: description: Email. maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile required: - first_name - last_name - birth_date - residence_country_code type: object x-go-package: github.com/wallester/api/model RepresentativeFieldsSwaggerModel: properties: title: description: |- Representative title.
__Field is required for NonRegulated WhiteLabel partners.__ enum: - Mr. - Ms. - Mrs. - Miss maxLength: 4 type: string x-go-name: Title first_name: description: >- Representative first name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: FirstName middle_name: description: >- Representative middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName last_name: description: >- Representative last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: LastName position: description: |- Representative position.
__Field is required for NonRegulated WhiteLabel partners.__ maxLength: 100 type: string x-go-name: Position is_member_of_the_board: description: Is member of the board? type: boolean x-go-name: IsMemberOfTheBoard is_representative: description: Is representative? type: boolean x-go-name: IsRepresentative is_ultimate_beneficial_owner: description: Is ultimate beneficial owner? type: boolean x-go-name: IsUltimateBeneficialOwner birth_date: description: >- Birthdate. Must be in 2006-01-02 format. Must be at least 16 years old. format: date type: string x-go-name: BirthDate residence_country_code: description: Residence country code. Must be in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode is_sanctions_related: description: |- Is Sanctions Related.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsSanctionsRelated is_politically_exposed: description: |- Is Politically Exposed.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsPoliticallyExposed is_adverse_media_involved: description: |- Is Adverse Media Involved.
__Required for Regulated and RegulatedVASP partners.__
__Field must be empty for NonRegulated partners.__ type: boolean x-go-name: IsAdverseMediaInvolved is_shareholder: description: Is shareholder type: boolean x-go-name: IsShareholder percentage_owned: description: |- Percentage owned.
__If representative is shareholder, minimum value is 1.__ format: float maximum: 100 minimum: 0 type: number x-go-name: PercentageOwned email: description: Email. maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile required: - first_name - last_name - birth_date - residence_country_code type: object x-go-package: github.com/wallester/api/model RequestCardFee: title: RequestCardFee represents card fee. properties: type: $ref: '#/components/schemas/APIModelFeeType' percentage_part: description: Percentage part format: double maximum: 100 minimum: 0 type: number x-go-name: PercentagePart fixed_part: description: Fixed part format: double maximum: 100000 minimum: 0 type: number x-go-name: FixedPart min_amount: description: Min amount format: double maximum: 100000 minimum: 0 type: number x-go-name: MinAmount required: - type type: object x-go-package: github.com/wallester/api/model ResumeTokenRequest: title: ResumeTokenRequest represents deactivate token request. properties: reason: description: Resume reason. maxLength: 254 type: string x-go-name: Reason required: - reason type: object x-go-package: github.com/wallester/api/model ResumeTokenResponse: title: ResumeTokenResponse returns related token. properties: token: $ref: '#/components/schemas/Token' type: object x-go-package: github.com/wallester/api/model ReversalAuthorization: properties: account_amount: format: double minimum: 0.01 type: number x-go-name: AccountAmount account_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode acquiring_institution_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: AcquiringInstitutionCountryCode acquiring_institution_id: type: string x-go-name: AcquiringInstitutionID approval_code: type: string x-go-name: ApprovalCode approved_amount: format: double type: number x-go-name: ApprovedAmount card: $ref: '#/components/schemas/AuthorizationCard' card_3d_secure_authentication_type: type: string x-go-name: Card3DSecureAuthenticationType card_3d_secure_cavv_validation_result: type: string x-go-name: Card3DSecureCAVVValidationResult card_3d_secure_indicator: type: string x-go-name: Card3DSecureIndicator card_id: format: uuid4 type: string x-go-name: CardID created_at: example: '1625932529' type: string x-go-name: CreatedAt date: example: '1625932529' type: string x-go-name: Date does_terminal_support_partial_approvals: type: boolean x-go-name: DoesTerminalSupportPartialApprovals fees_amount: format: double type: number x-go-name: FeesAmount group: $ref: '#/components/schemas/AuthorizationGroup' id: format: uuid4 type: string x-go-name: ID is_contactless: type: boolean x-go-name: IsContactless is_declined: type: boolean x-go-name: IsDeclined is_mass_transit: type: boolean x-go-name: IsMassTransit is_reversal: type: boolean x-go-name: IsReversal merchant_category_code: type: string x-go-name: MerchantCategoryCode merchant_city: type: string x-go-name: MerchantCity merchant_country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode merchant_id: type: string x-go-name: MerchantID merchant_name: type: string x-go-name: MerchantName original_authorization_id: format: uuid4 type: string x-go-name: OriginalAuthorizationID response_code: type: string x-go-name: ResponseCode retrieval_reference_number: type: string x-go-name: RetrievalReferenceNumber terminal_id: type: string x-go-name: TerminalID transaction_amount: format: double minimum: 0.01 type: number x-go-name: TransactionAmount transaction_currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode type: $ref: '#/components/schemas/AuthorizationType' required: - id - card_id - date - account_amount - account_currency_code - group - is_contactless - is_mass_transit - transaction_amount - transaction_currency_code - is_reversal - is_declined - does_terminal_support_partial_approvals type: object x-go-package: github.com/wallester/api/model/webhooks ReversalAuthorizationView: properties: data: $ref: '#/components/schemas/ReversalAuthorization' event: description: Event identifier enum: - notification type: string x-go-name: Event type: description: Event type enum: - authorization type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks RiskProfile: title: Risk profile. enum: - High - Low - Medium - Pending - Prohibited type: string x-go-package: github.com/wallester/common/model RiskStatus: enum: - Approved - Declined - FreezeCard - Suspicious - Unknown type: string x-go-package: github.com/wallester/common/model RiskZone: enum: - High - Low - Medium type: string x-go-package: github.com/wallester/common/model RoleProductType: enum: - All - WBLACK - WhiteLabel type: string x-go-package: github.com/wallester/common/model Scoring: properties: non_neighboring_country: format: int32 type: integer x-go-name: NonNeighboringCountry reversal_refund: format: int32 type: integer x-go-name: ReversalRefund high_risk_country_decline_all: format: int32 type: integer x-go-name: HighRiskCountryDeclineAll magnetic_stripe_on_chip_capable_terminal: format: int32 type: integer x-go-name: MagneticStripeOnChipCapableTerminal last_month_refund: format: int32 type: integer x-go-name: LastMonthRefund sequence_declines: format: int32 type: integer x-go-name: SequenceDeclines not_enough_funds: format: int32 type: integer x-go-name: NotEnoughFunds black_list: format: int32 type: integer x-go-name: BlackList magnetic_stripe_and_card_data_entered_manually: format: int32 type: integer x-go-name: MagneticStripeAndCardDataEnteredManually large_amount: format: int32 type: integer x-go-name: LargeAmount avg_month_amount: format: int32 type: integer x-go-name: AvgMonthAmount diff_currencies: format: int32 type: integer x-go-name: DiffCurrencies high_risk_country: format: int32 type: integer x-go-name: HighRiskCountry within_1_minute_transactions_count: format: int32 type: integer x-go-name: Within1MinuteTransactionsCount magnetic_stripe: format: int32 type: integer x-go-name: MagneticStripe country_change_within_24h: format: int32 type: integer x-go-name: CountryChangeWithin24H transaction_frequency: format: int32 type: integer x-go-name: TransactionFrequency last_month_high_risk_country: format: int32 type: integer x-go-name: LastMonthHighRiskCountry account_velocity_amounts: format: int32 type: integer x-go-name: AccountVelocityAmounts account_velocity_counts: format: int32 type: integer x-go-name: AccountVelocityCounts high_cash_volume: format: int32 type: integer x-go-name: HighCashVolume high_number_of_declines: format: int32 type: integer x-go-name: HighNumberOfDeclines high_risk_mcc_purchase: format: int32 type: integer x-go-name: HighRiskMccPurchase high_risk_country_decline_atm: format: int32 type: integer x-go-name: HighRiskCountryDeclineAtm high_risk_country_mark_suspicious: format: int32 type: integer x-go-name: HighRiskCountryMarkSuspicious invalid_pin: format: int32 type: integer x-go-name: InvalidPin same_merchant_1_minutes: format: int32 type: integer x-go-name: SameMerchant1Minutes same_merchant_24h: format: int32 type: integer x-go-name: SameMerchant24H within_1_minute: format: int32 type: integer x-go-name: Within1Minute wrong_cvv: format: int32 type: integer x-go-name: WrongCvv last_month_declines: format: int32 type: integer x-go-name: LastMonthDeclines type: object x-go-package: github.com/wallester/api/model SearchAccountsResponse: properties: accounts: description: List of found accounts items: $ref: '#/components/schemas/Account' type: array x-go-name: Accounts total_records_number: description: Total number of found accounts satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model SearchCardsResponse: title: SearchCardsResponse returns cards. properties: cards: description: List of found cards items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards total_records_number: description: Total number of found cards satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model SearchCompaniesResponse: properties: company: description: List of found companies items: $ref: '#/components/schemas/Company' type: array x-go-name: Companies total_records_number: description: Total number of found companies satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model SearchPersonsResponse: title: SearchPersonsResponse returns persons. properties: persons: description: List of found persons items: $ref: '#/components/schemas/Person' type: array x-go-name: Persons total_records_number: description: Total number of found persons satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model SearchResponse: properties: records: $ref: '#/components/schemas/Records' records_count: $ref: '#/components/schemas/RecordsCount' type: object x-go-package: github.com/wallester/api/model Send3DSOTPRequest: title: Send3DSOTPRequest is a request to send 3DS OTP. properties: otp: description: OTP maxLength: 6 type: string x-go-name: OTP merchant_name: description: Merchant name maxLength: 100 type: string x-go-name: MerchantName amount: description: Amount format: double maximum: 100000 minimum: 0 type: number x-go-name: Amount currency_code: description: Currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode purchase_date: description: Purchase date. Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: PurchaseDate required: - otp - merchant_name - amount - currency_code - purchase_date type: object x-go-package: github.com/wallester/api/model SeparatedEmbossingName: properties: first_name: description: First name maxLength: 21 type: string x-go-name: FirstName last_name: description: Last name maxLength: 21 type: string x-go-name: LastName type: object x-go-package: github.com/wallester/api/model Service: description: Service represents service fields properties: description: description: Description type: string x-go-name: Description id: description: ID format: int64 type: integer x-go-name: ID type: object x-go-package: github.com/wallester/api/model SingleCardDispatchMethod: title: Card dispatch method. enum: - DHLExpress - DHLGlobalMail - DHLGlobalMailTracked - DPDExpress - StandardLatvianPostMail type: string x-go-package: github.com/wallester/common/model StatementTotalFields: properties: total_records_number: description: Total number of statement records satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber pending_amount: description: Total pending money flow for statement records format: double type: number x-go-name: PendingAmount debit_turnover: description: Total debit money flow for statement records format: double type: number x-go-name: DebitTurnover credit_turnover: description: Total credit money flow for statement records format: double type: number x-go-name: CreditTurnover type: object x-go-package: github.com/wallester/api/model StepUpMethodType: title: StepUp method type. enum: - APP_TO_APP - CUSTOMERSERVICE - OTPEMAIL - OTPSMS - OUTBOUNDCALL type: string x-go-package: github.com/wallester/common/model SubmitCompanyAgreementRequest: title: SubmitCompanyAgreementRequest is a request to submit company agreement. properties: agreement_id: description: Agreement ID format: uuid4 type: string x-go-name: AgreementID signed_at: description: Signed at. Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: SignedAt required: - agreement_id - signed_at type: object x-go-package: github.com/wallester/api/model SubmitCompanyAgreementResponse: title: SubmitCompanyAgreementResponse returns company. properties: company: $ref: '#/components/schemas/Company' type: object x-go-package: github.com/wallester/api/model SuspendTokenRequest: title: SuspendTokenRequest represents suspend token request. properties: reason: description: Suspend reason. maxLength: 254 type: string x-go-name: Reason required: - reason type: object x-go-package: github.com/wallester/api/model SuspendTokenResponse: title: SuspendTokenResponse returns related token. properties: token: $ref: '#/components/schemas/Token' type: object x-go-package: github.com/wallester/api/model Template: properties: id: description: Template ID format: uuid4 type: string x-go-name: ID product_id: description: Product ID template belongs to format: uuid4 type: string x-go-name: ProductID message_type: $ref: '#/components/schemas/MessageType' delivery_type: $ref: '#/components/schemas/DeliveryType' language_code: $ref: '#/components/schemas/LanguageCode' body: description: Template body type: string x-go-name: Body subject: description: Template subject type: string x-go-name: Subject created_at: description: Date-time when template was created format: date-time type: string x-go-name: CreatedAt created_by: description: User ID who has created template type: string x-go-name: CreatedBy updated_at: description: Date-time when template was updated format: date-time type: string x-go-name: UpdatedAt updated_by: description: User who updated the template type: string x-go-name: UpdatedBy deleted_at: description: Date-time when template was deleted format: date-time type: string x-go-name: DeletedAt deleted_by: description: User who deleted the template type: string x-go-name: DeletedBy type: object x-go-package: github.com/wallester/api/model ThreeDSCard: properties: external_id: type: string x-go-name: ExternalID id: type: string x-go-name: ID last_four_digits: type: string x-go-name: LastFourDigits required: - id - last_four_digits type: object x-go-package: github.com/wallester/api/model/webhooks ThreeDSInitiateAction: properties: card: $ref: '#/components/schemas/ThreeDSCard' merchant: $ref: '#/components/schemas/ThreeDSMerchant' request_id: type: string x-go-name: RequestID transaction: $ref: '#/components/schemas/ThreeDSTransaction' required: - request_id - card - merchant - transaction type: object x-go-package: github.com/wallester/api/model/webhooks ThreeDSMerchant: properties: category_code: type: string x-go-name: CategoryCode country_code: type: string x-go-name: CountryCode name: type: string x-go-name: Name url: type: string x-go-name: URL type: object x-go-package: github.com/wallester/api/model/webhooks ThreeDSOTPNotificationView: properties: amount: type: string x-go-name: Amount card_id: type: string x-go-name: CardID currency: type: string x-go-name: Currency last_four_digits: type: string x-go-name: LastFourDigits merchant_name: type: string x-go-name: MerchantName otp: type: string x-go-name: OTP purchase_date: example: 14/12/2022 12:01 CET type: string x-go-name: PurchaseDate required: - card_id - otp - merchant_name - amount - currency - purchase_date - last_four_digits type: object x-go-package: github.com/wallester/api/model/webhooks ThreeDSTransaction: properties: amount: type: string x-go-name: Amount currency: type: string x-go-name: Currency time: description: Time in UTC example: '2023-03-21T20:55:49.000Z' type: string x-go-name: Time type: object x-go-package: github.com/wallester/api/model/webhooks ThreeDSValidate: properties: data: $ref: '#/components/schemas/ThreeDSValidateView' event: description: Event identifier enum: - validate type: string x-go-name: Event type: description: Event type enum: - 3ds type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks ThreeDSValidateView: properties: request_id: type: string x-go-name: RequestID required: - request_id type: object x-go-package: github.com/wallester/api/model/webhooks ThreeDSecureOTP: properties: data: $ref: '#/components/schemas/ThreeDSOTPNotificationView' event: description: Event identifier enum: - notification type: string x-go-name: Event type: description: Event type enum: - 3dsotp type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks TicketStatus: title: Ticket status. enum: - InProgress - OnHold - Resolved - Submitted - WaitingOnCustomer type: string x-go-package: github.com/wallester/common/model Time: title: A Time represents an instant in time with nanosecond precision. description: >- Programs using times should typically store and pass them as values, not pointers. That is, time variables and struct fields should be of type time.Time, not *time.Time. A Time value can be used by multiple goroutines simultaneously except that the methods GobDecode, UnmarshalBinary, UnmarshalJSON and UnmarshalText are not concurrency-safe. Time instants can be compared using the Before, After, and Equal methods. The Sub method subtracts two instants, producing a Duration. The Add method adds a Time and a Duration, producing a Time. The zero value of type Time is January 1, year 1, 00:00:00.000000000 UTC. As this time is unlikely to come up in practice, the IsZero method gives a simple way of detecting a time that has not been initialized explicitly. Each Time has associated with it a Location, consulted when computing the presentation form of the time, such as in the Format, Hour, and Year methods. The methods Local, UTC, and In return a Time with a specific location. Changing the location in this way changes only the presentation; it does not change the instant in time being denoted and therefore does not affect the computations described in earlier paragraphs. Representations of a Time value saved by the GobEncode, MarshalBinary, MarshalJSON, and MarshalText methods store the Time.Location's offset, but not the location name. They therefore lose information about Daylight Saving Time. In addition to the required “wall clock” reading, a Time may contain an optional reading of the current process's monotonic clock, to provide additional precision for comparison or subtraction. See the “Monotonic Clocks” section in the package documentation for details. Note that the Go == operator compares not just the time instant but also the Location and the monotonic clock reading. Therefore, Time values should not be used as map or database keys without first guaranteeing that the identical Location has been set for all values, which can be achieved through use of the UTC or Local method, and that the monotonic clock reading has been stripped by setting t = t.Round(0). In general, prefer t.Equal(u) to t == u, since t.Equal uses the most accurate comparison available and correctly handles the case when only one of its arguments has a monotonic clock reading. format: date-time type: string TimeFrameParamsRequired: properties: from_date: description: Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: FromDate to_date: description: Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: ToDate type: object x-go-package: github.com/wallester/api/model Title: title: Person title. enum: - Miss - Mr. - Mrs. - Ms. type: string x-go-package: github.com/wallester/common/model Token: title: Token represents the token associated with the PAN. properties: id: description: Token ID format: uuid4 type: string x-go-name: ID reference_id: description: Reference ID represents unique ID associated with the PAN type: string x-go-name: ReferenceID card_id: description: Card ID to which this token belongs to format: uuid4 type: string x-go-name: CardID card_metadata_profile_id: description: CardMetadataProfileID is associated with the card format: uuid4 type: string x-go-name: CardMetadataProfileID requestor_id: description: >- RequestorID is unique ID assigned to the initiator of the token request format: int64 type: integer x-go-name: RequestorID pan_reference_id: description: PANReferenceID unique ID for the PAN type: string x-go-name: PANReferenceID type: $ref: '#/components/schemas/TokenType' status: $ref: '#/components/schemas/TokenStatus' expiration: description: Expiration the date upon which the token is set to expire format: date-time type: string x-go-name: Expiration original_token: description: >- OriginalToken is token account number. This field is populated when performing token-for-token provisioning only. type: string x-go-name: OriginalToken original_token_requestor_id: description: >- OriginalTokenRequestorID is unique ID assigned to the initiator of the token request. This field is populated when performing token-for-token provisioning only. format: int64 type: integer x-go-name: OriginalTokenRequestorID original_token_reference_id: description: >- OriginalTokenReferenceID is unique ID for the token associated with the PAN. This field is populated when performing token-for-token provisioning only. type: string x-go-name: OriginalTokenReferenceID original_token_assurance_level: description: >- OriginalTokenAssuranceLevel assurance level of the Token to PAN binding. This field is populated when performing token-for-token provisioning only. type: string x-go-name: OriginalTokenAssuranceLevel wallet_account_email_address_hash: description: >- WalletAccountEmailAddressHash is hash of email address linked to their wallet account login type: string x-go-name: WalletAccountEmailAddressHash cvv_2_result_code: $ref: '#/components/schemas/CVV2Result' address_verification_result_code: description: >- AddressVerificationResultCode is code that describes the result of an address verification type: string x-go-name: AddressVerificationResultCode locale: description: >- Locale is language in which the app communicates with the customer, based on the type: string x-go-name: Locale consumer_entry_mode_id: $ref: '#/components/schemas/ConsumerEntryMode' client_wallet_account_id: description: ClientWalletAccountID identifying the wallet account-holder entity type: string x-go-name: ClientWalletAccountID stip_reason_code: description: >- STIPReasonCode this field contains a code that identifies why STIP responded for the issuer type: string x-go-name: STIPReasonCode action_code: $ref: '#/components/schemas/VisaActionCode' created_at: description: Date-time when token appeared in the system format: date-time type: string x-go-name: CreatedAt created_by: description: ID of the user who has created the token type: string x-go-name: CreatedBy updated_at: description: Date-time the token was updated at format: date-time type: string x-go-name: UpdatedAt updated_by: description: ID of the user who has updated the token type: string x-go-name: UpdatedBy deleted_at: description: Date-time the token was deleted at format: date-time type: string x-go-name: DeletedAt deleted_by: description: ID of the user who deleted the token type: string x-go-name: DeletedBy token_value: description: TokenValue is digital PAN type: string x-go-name: TokenValue device_information_list: description: Device information list from which the token was requested items: $ref: '#/components/schemas/TokenDeviceInformation' type: array x-go-name: DeviceInformationList type: object x-go-package: github.com/wallester/api/model TokenByIDResponse: title: TokenByIDResponse returns card related token. properties: token: $ref: '#/components/schemas/Token' type: object x-go-package: github.com/wallester/api/model TokenDeviceInformation: properties: id: format: uuid4 type: string x-go-name: ID token_id: format: uuid4 type: string x-go-name: TokenID device_id: type: string x-go-name: DeviceID device_id_type: type: string x-go-name: DeviceIDType language_code: type: string x-go-name: LanguageCode type_id: $ref: '#/components/schemas/DeviceType' name: type: string x-go-name: Name number: type: string x-go-name: Number os_type_id: $ref: '#/components/schemas/OSType' os_version: type: string x-go-name: OSVersion os_build_id: type: string x-go-name: OSBuildID manufacturer: type: string x-go-name: Manufacturer model: type: string x-go-name: Model brand: type: string x-go-name: Brand location: type: string x-go-name: Location location_source_id: $ref: '#/components/schemas/LocationSource' device_index: format: int64 type: integer x-go-name: Index ip_address_v4: type: string x-go-name: IPAddressV4 token_protection_method_id: $ref: '#/components/schemas/TokenProtectionMethod' created_at: format: date-time type: string x-go-name: CreatedAt created_by: type: string x-go-name: CreatedBy updated_at: format: date-time type: string x-go-name: UpdatedAt updated_by: type: string x-go-name: UpdatedBy deleted_at: format: date-time type: string x-go-name: DeletedAt deleted_by: type: string x-go-name: DeletedBy type: object x-go-package: github.com/wallester/api/model TokenProtectionMethod: enum: - CLOUD - SECURE_ELEMENT - SOFTWARE - TRUSTED_EXECUTION_ENVIRONMENT type: string x-go-package: github.com/wallester/common/model TokenStatus: enum: - '' - ACTIVE - DEACTIVATED - INACTIVE - SUSPENDED type: string x-go-package: github.com/wallester/common/model TokenType: enum: - '' - CARD_ON_FILE - ECOMMERCE - HCE - QRC - SECURE_ELEMENT type: string x-go-package: github.com/wallester/common/model TokensByCardIDResponse: title: TokensByCardIDResponse returns card related tokens. properties: tokens: description: List of tokens items: $ref: '#/components/schemas/Token' type: array x-go-name: Tokens total_records_number: description: Total number of found tokens satisfying given criteria format: int64 type: integer x-go-name: TotalRecordsNumber type: object x-go-package: github.com/wallester/api/model Transaction: title: Transaction represents a card transaction. properties: id: description: Transaction ID format: uuid4 type: string x-go-name: ID card_id: description: Card ID to which this transaction belongs to format: uuid4 type: string x-go-name: CardID purchase_date: description: Date-time of the transaction format: date-time type: string x-go-name: PurchaseDate group: $ref: '#/components/schemas/TransactionGroup' transaction_amount: description: Transaction amount format: double type: number x-go-name: TransactionAmount transaction_currency_code: description: Transaction currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: TransactionCurrencyCode account_amount: description: Account amount format: double type: number x-go-name: AccountAmount account_currency_code: description: Account currency code in ISO 4217 standard enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: AccountCurrencyCode merchant_category_code: description: Merchant category code type: string x-go-name: MerchantCategoryCode merchant_id: description: Merchant ID type: string x-go-name: MerchantID terminal_id: description: Terminal ID type: string x-go-name: TerminalID merchant_name: description: Merchant name type: string x-go-name: MerchantName merchant_postal_code: description: Merchant postal code type: string x-go-name: MerchantPostalCode merchant_city: description: Merchant city type: string x-go-name: MerchantCity merchant_country_code: description: Merchant country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: MerchantCountryCode acquirer_reference_number: description: Acquirer transaction reference number type: string x-go-name: AcquirerReferenceNumber acquirer_business_id: description: Acquirer business ID type: string x-go-name: AcquirerBusinessID transaction_code: description: Transaction code type: string x-go-name: TransactionCode transaction_identifier: description: Transaction identifier type: string x-go-name: TransactionIdentifier authorization_id: description: Authorization ID format: uuid4 type: string x-go-name: AuthorizationID marked_for_dispute_at: description: Date-time the transaction was marked for dispute format: date-time type: string x-go-name: MarkedForDisputeAt marked_for_dispute_by: description: Marked for dispute by type: string x-go-name: MarkedForDisputeBy created_at: description: Date-time when transaction appeared in the system format: date-time type: string x-go-name: CreatedAt processed_at: description: Date-time when transaction has been processed format: date-time type: string x-go-name: ProcessedAt is_failed: description: Is failed type: boolean x-go-name: IsFailed central_processing_date: description: Date-time when transaction has been processed in the payment system format: date-time type: string x-go-name: CentralProcessingDate exchange_rate: description: Exchange rate of transaction format: double type: number x-go-name: ExchangeRate authorization_code: description: Authorization code type: string x-go-name: AuthorizationCode total_amount: description: Total amount format: double type: number x-go-name: TotalAmount type: object x-go-package: github.com/wallester/api/model TransactionClearing: properties: data: $ref: '#/components/schemas/EventTransaction' event: description: Event identifier enum: - notification type: string x-go-name: Event type: description: Event type enum: - transaction type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks TransactionCode: format: int64 type: integer x-go-package: github.com/wallester/common/model TransactionGroup: enum: - Deposit - InternetPurchase - Other - Purchase - Refund - Withdraw type: string x-go-package: github.com/wallester/common/model TransactionWithEnrichedMerchant: title: TransactionWithEnrichedMerchant represents a card transaction. allOf: - $ref: '#/components/schemas/Transaction' - properties: enriched_merchant_data: $ref: '#/components/schemas/EnrichedMerchantData' type: object x-go-package: github.com/wallester/api/model TransactionsSummaryResponse: properties: account_amount: description: Total amount of transactions format: double type: number x-go-name: Amount count: description: Total number of transactions format: int64 type: integer x-go-name: Count type: object x-go-package: github.com/wallester/api/model UnblockCardResponse: title: UnblockCardResponse is the response to the request to unblock a card. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UnblockCardsBatchRequest: title: >- UnblockCardsBatchRequest is a request to unblock a batch of credit cards. properties: card_ids: description: Card IDs items: format: uuid4 type: string type: array x-go-name: CardIDs required: - card_ids type: object x-go-package: github.com/wallester/api/model UnblockCardsBatchResponse: title: >- UnblockCardsBatchResponse is the response to the request to unblock a batch of credit cards. properties: cards: items: $ref: '#/components/schemas/Card' type: array x-go-name: Cards type: object x-go-package: github.com/wallester/api/model UnenrolCardFrom3DSecureResponse: title: >- UnenrolCardFrom3DSecureResponse is the response to the request to unenrol card from 3D secure. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model Update3DSecureSettingsRequest: title: >- Update3DSecureSettingsRequest is a request to update card 3D secure settings. properties: type: $ref: '#/components/schemas/APICard3DSecureType' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile language_code: $ref: '#/components/schemas/ACSLanguageCode' password: description: >- Password. Allowed to use characters: A-Z a-z 0-9 ! " # ; : ? * ( ) + = / \ , . [ ] { }. Masked value returned if password is set. maxLength: 36 minLength: 8 type: string x-go-name: Password email: description: Email format: email maxLength: 255 type: string x-go-name: Email out_of_band_enabled: description: Out of Band enabled type: boolean x-go-name: OutOfBandEnabled out_of_band_id: description: Out of Band ID. Which basically is ID of User. type: string x-go-name: OutOfBandID type: object x-go-package: github.com/wallester/api/model Update3DSecureSettingsResponse: title: >- Update3DSecureSettingsResponse returns card information after updating 3D secure settings. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateAccountAdjustmentExternalIDRequest: title: >- UpdateAccountAdjustmentExternalIDRequest represents update account adjustment external ID request. properties: external_id: description: External ID maxLength: 50 type: string x-go-name: ExternalID type: object x-go-package: github.com/wallester/api/model UpdateAccountAdjustmentExternalIDResponse: title: >- UpdateAccountAdjustmentExternalIDResponse represents update account adjustment external ID response. properties: account_adjustment: $ref: '#/components/schemas/AccountAdjustment' type: object x-go-package: github.com/wallester/api/model UpdateAccountExternalIDRequest: title: >- UpdateAccountExternalIDRequest represents update account external ID request. properties: external_id: description: External ID maxLength: 50 type: string x-go-name: ExternalID type: object x-go-package: github.com/wallester/api/model UpdateAccountExternalIDResponse: title: >- UpdateAccountExternalIDResponse represents update account external ID response. properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model UpdateAccountLimitsRequest: title: UpdateAccountLimitsRequest represents update account limits request. properties: limits: $ref: '#/components/schemas/AccountLimits' required: - limits type: object x-go-package: github.com/wallester/api/model UpdateAccountLimitsResponse: title: UpdateAccountLimitsResponse represents update account limits response. properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model UpdateAccountNameRequest: title: UpdateAccountNameRequest represents update account name request. properties: name: description: Account name maxLength: 100 type: string x-go-name: Name type: object x-go-package: github.com/wallester/api/model UpdateAccountNameResponse: properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model UpdateAccountTopUpDetailsRequest: title: >- UpdateAccountTopUpDetailsRequest represents update account top up details request. properties: top_up_details: $ref: '#/components/schemas/AccountTopUpDetails' required: - top_up_details type: object x-go-package: github.com/wallester/api/model UpdateAccountTopUpDetailsResponse: properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model UpdateAddress: description: Address properties: country_code: description: Country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: CountryCode address1: description: Address maxLength: 45 type: string x-go-name: Address1 address2: description: Address 2 maxLength: 45 type: string x-go-name: Address2 city: description: City maxLength: 35 type: string x-go-name: City postal_code: description: Postal code maxLength: 10 type: string x-go-name: PostalCode required: - country_code type: object x-go-package: github.com/wallester/api/model UpdateCardDeliveryAddressRequest: title: >- UpdateCardDeliveryAddressRequest is a request to update card delivery address. properties: delivery_address: $ref: '#/components/schemas/DeliveryAddressForUpdate' type: object x-go-package: github.com/wallester/api/model UpdateCardDeliveryAddressResponse: properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateCardExternalIDRequest: title: UpdateCardExternalIDRequest represents update card external ID request. properties: external_id: description: External ID maxLength: 50 type: string x-go-name: ExternalID type: object x-go-package: github.com/wallester/api/model UpdateCardExternalIDResponse: title: >- UpdateCardExternalIDResponse represents update card external ID response. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateCardFeeWaiver: properties: card_id: description: Card ID format: uuid4 type: string x-go-name: CardID limit_amount: description: Limit amount, required when quantity limit is not set format: double maximum: 9999999999.99 minimum: 1 type: number x-go-name: LimitAmount limit_quantity: description: Limit quantity, required when amount limit is not set format: int64 maximum: 9999999999 minimum: 1 type: integer x-go-name: LimitQuantity fee_waiver_authorization_type: $ref: '#/components/schemas/FeeWaiverAuthorizationType' required: - card_id - fee_waiver_authorization_type type: object x-go-package: github.com/wallester/api/model UpdateCardFeeWaiversRequest: properties: card_fee_waivers: items: $ref: '#/components/schemas/UpdateCardFeeWaiver' type: array x-go-name: CardFeeWaivers type: object x-go-package: github.com/wallester/api/model UpdateCardFeeWaiversResponse: properties: card_fee_waivers: items: $ref: '#/components/schemas/CardFeeWaiver' type: array x-go-name: CardFeeWaivers type: object x-go-package: github.com/wallester/api/model UpdateCardFeesBatchRequest: title: UpdateCardFeesBatchRequest represents update card fees batch request. properties: card_fees_batch: description: Card fees items: $ref: '#/components/schemas/CardFeesBatch' type: array x-go-name: CardFeesBatch required: - card_fees_batch type: object x-go-package: github.com/wallester/api/model UpdateCardFeesBatchResponse: title: UpdateCardFeesBatchResponse represents update card fees batch response. properties: card_fees_batch: items: $ref: '#/components/schemas/CardFeesBatch' type: array x-go-name: CardFeesBatch type: object x-go-package: github.com/wallester/api/model UpdateCardFeesRequest: title: UpdateCardFeesRequest represents update card fees request. properties: card_fees: description: Card fees items: $ref: '#/components/schemas/RequestCardFee' type: array x-go-name: CardFees required: - card_fees type: object x-go-package: github.com/wallester/api/model UpdateCardFeesResponse: title: UpdateCardFeesResponse represents update card fees response. properties: card_fees: description: List of card fees items: $ref: '#/components/schemas/RequestCardFee' type: array x-go-name: CardFees type: object x-go-package: github.com/wallester/api/model UpdateCardLimitsRequest: title: UpdateCardLimitsRequest represents update card limits request. properties: limits: $ref: '#/components/schemas/CardLimits' required: - limits type: object x-go-package: github.com/wallester/api/model UpdateCardLimitsResponse: title: UpdateCardLimitsResponse represents update card limits response. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateCardNameRequest: properties: name: description: Card name maxLength: 100 type: string x-go-name: Name type: object x-go-package: github.com/wallester/api/model UpdateCardNameResponse: properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateCardRenewAutomaticallyRequest: title: >- UpdateCardRenewAutomaticallyRequest represents update card renew automatically request. properties: renew_automatically: description: Renew automatically. type: boolean x-go-name: RenewAutomatically required: - renew_automatically type: object x-go-package: github.com/wallester/api/model UpdateCardRenewAutomaticallyResponse: title: >- UpdateCardRenewAutomaticallyResponse represents update card renew automatically response. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateCardSecurityRequest: title: UpdateCardSecurityRequest is a request to update card security. properties: contactless_enabled: description: Contactless enabled type: boolean x-go-name: ContactlessEnabled withdrawal_enabled: description: Withdrawal enabled type: boolean x-go-name: WithdrawalEnabled internet_purchase_enabled: description: Internet purchase enabled type: boolean x-go-name: InternetPurchaseEnabled overall_limits_enabled: description: >- Overall limits enabled. Cannot be enabled together with all time limits. type: boolean x-go-name: OverallLimitsEnabled all_time_limits_enabled: description: >- All time limits enabled. Cannot be enabled together with overall limits. type: boolean x-go-name: AllTimeLimitsEnabled type: object x-go-package: github.com/wallester/api/model UpdateCardSecurityResponse: title: >- UpdateCardSecurityResponse returns card information after updating card security. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateCardStatusRequest: title: UpdateCardStatusRequest is a request to update card status. properties: status: $ref: '#/components/schemas/CardStatus' block_type: $ref: '#/components/schemas/APIBlockType' type: object x-go-package: github.com/wallester/api/model UpdateCardStatusResponse: title: >- UpdateCardStatusResponse is the response to the request to update card status. properties: card: $ref: '#/components/schemas/Card' type: object x-go-package: github.com/wallester/api/model UpdateCardholder3DSSettingsRequest: properties: email: description: Email maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile password: description: >- Password. Allowed to use characters: A-Z a-z 0-9 ! " # ; : ? * ( ) + = / \ , . [ ] { }. maxLength: 36 minLength: 8 type: string x-go-name: Password force_usage: description: >- ForceUsage is using to force cardholder settings for 3DS step-up methods type: boolean x-go-name: ForceUsage card_default_settings: description: >- CardDefaultSettings is using to ensure that new cards are created with cardholder 3DS settings type: boolean x-go-name: CardDefaultSettings type: object x-go-package: github.com/wallester/api/model UpdateCompanyFCMTokenPushNotificationsEnabledResponse: properties: company_fcm_token: $ref: '#/components/schemas/CompanyFCMToken' type: object x-go-package: github.com/wallester/api/model UpdateCompanyLimitsRequest: properties: limits: $ref: '#/components/schemas/CompanyLimits' required: - limits type: object x-go-package: github.com/wallester/api/model UpdateCompanyLimitsResponse: properties: company: $ref: '#/components/schemas/Company' type: object x-go-package: github.com/wallester/api/model UpdateCompanyPushNotificationsEnabledRequest: properties: push_notifications_enabled: description: Are push notifications enabled for company type: boolean x-go-name: PushNotificationsEnabled required: - push_notifications_enabled type: object x-go-package: github.com/wallester/api/model UpdateCompanyPushNotificationsEnabledResponse: properties: company: $ref: '#/components/schemas/Company' type: object x-go-package: github.com/wallester/api/model UpdateCompanyRequest: properties: name: description: >- Company name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: Name registration_number: description: Registration number maxLength: 100 type: string x-go-name: RegistrationNumber registration_address: $ref: '#/components/schemas/UpdateAddress' headquarter_address: $ref: '#/components/schemas/UpdateAddress' risk_profile: $ref: '#/components/schemas/APIRiskProfile' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. maxLength: 100 type: string x-go-name: Mobile email: description: Email format: email maxLength: 255 type: string x-go-name: Email industry_type: $ref: '#/components/schemas/ActivityType' date_of_incorporation: description: Date Of Incorporation format: date-time type: string x-go-name: DateOfIncorporation is_sanctions_related: description: Is Sanctions Related type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: Is Adverse Media Involved type: boolean x-go-name: IsAdverseMediaInvolved push_notifications_enabled: description: Is push notifications enabled type: boolean x-go-name: PushNotificationsEnabled preferred_language_code: $ref: '#/components/schemas/LanguageCode' vat_number: description: VAT Number maxLength: 30 type: string x-go-name: VATNumber type: object x-go-package: github.com/wallester/api/model UpdateCompanyResponse: properties: company: $ref: '#/components/schemas/Company' type: object x-go-package: github.com/wallester/api/model UpdateCompanySwaggerModel: properties: name: description: Company name maxLength: 100 type: string x-go-name: Name registration_number: description: Registration number maxLength: 100 type: string x-go-name: RegistrationNumber registration_address: $ref: '#/components/schemas/UpdateAddress' headquarter_address: $ref: '#/components/schemas/UpdateAddress' risk_profile: description: Company risk profile. enum: - Low - Medium - High type: string x-go-name: RiskProfile mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. maxLength: 100 type: string x-go-name: Mobile email: description: Email format: email maxLength: 255 type: string x-go-name: Email industry_type: $ref: '#/components/schemas/ActivityType' date_of_incorporation: description: Date Of Incorporation format: date-time type: string x-go-name: DateOfIncorporation is_sanctions_related: description: Is Sanctions Related type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: Is Adverse Media Involved type: boolean x-go-name: IsAdverseMediaInvolved push_notifications_enabled: description: Is push notifications enabled type: boolean x-go-name: PushNotificationsEnabled preferred_language_code: $ref: '#/components/schemas/LanguageCode' vat_number: description: VAT Number maxLength: 30 type: string x-go-name: VATNumber type: object x-go-package: github.com/wallester/api/model UpdateCreditLimitRequest: properties: description: description: Description, change reason, etc. maxLength: 256 type: string x-go-name: Description credit_limit: description: Credit limit format: double minimum: 0 type: number x-go-name: CreditLimit required: - description type: object x-go-package: github.com/wallester/api/model UpdateCreditLimitResponse: properties: account: $ref: '#/components/schemas/Account' type: object x-go-package: github.com/wallester/api/model UpdateFCMTokenPushNotificationsEnabledResponse: properties: fcm_token: $ref: '#/components/schemas/FCMToken' type: object x-go-package: github.com/wallester/api/model UpdateFee: properties: data: $ref: '#/components/schemas/UpdateFeeView' event: description: Event identifier enum: - update type: string x-go-name: Event type: description: Event type enum: - fee type: string x-go-name: Type required: - data - event - type type: object x-go-package: github.com/wallester/api/model/webhooks UpdateFeeView: properties: account_id: format: uuid4 type: string x-go-name: AccountID amount: format: double maximum: 0 type: number x-go-name: Amount authorization_id: format: uuid4 type: string x-go-name: AuthorizationID canceled_at: example: '1625932529' type: string x-go-name: CanceledAt canceled_reason: type: string x-go-name: CanceledReason card_id: format: uuid4 type: string x-go-name: CardID company_id: format: uuid4 type: string x-go-name: CompanyID completed_at: example: '1625932529' type: string x-go-name: CompletedAt created_at: example: '1625932529' type: string x-go-name: CreatedAt currency_code: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL type: string x-go-name: CurrencyCode id: format: uuid4 type: string x-go-name: ID person_id: format: uuid4 type: string x-go-name: PersonID status: $ref: '#/components/schemas/FeeStatus' transaction_id: format: uuid4 type: string x-go-name: TransactionID type: $ref: '#/components/schemas/FeeType' updated_at: example: '1625932529' type: string x-go-name: UpdatedAt required: - id - type - status - amount - currency_code - account_id - created_at type: object x-go-name: UpdatFeeView x-go-package: github.com/wallester/api/model/webhooks UpdateFraudCaseRequest: title: >- UpdateFraudCaseRequest is a request to update existing fraud case information. properties: description: description: Fraud case description maxLength: 5000 type: string x-go-name: Description case_status: $ref: '#/components/schemas/FraudCaseStatus' source: $ref: '#/components/schemas/FraudSource' type: $ref: '#/components/schemas/FraudType' liability: $ref: '#/components/schemas/FraudLiability' required: - case_status type: object x-go-package: github.com/wallester/api/model UpdatePersonAdditionalInfoRequest: title: >- UpdatePersonAdditionalInfoRequest is a request to update existing person additional info. properties: key: description: Key maxLength: 50 type: string x-go-name: Key value: description: Value maxLength: 50 type: string x-go-name: Value type: object x-go-package: github.com/wallester/api/model UpdatePersonAdditionalInfoResponse: title: >- UpdatePersonAdditionalInfoResponse is the response to the request to update existing person additional info. properties: person_additional_info: $ref: '#/components/schemas/PersonAdditionalInfo' type: object x-go-package: github.com/wallester/api/model UpdatePersonPatchRequest: title: >- UpdatePersonPatchRequest is a request to partially update existing person information. properties: title: $ref: '#/components/schemas/Title' personal_number: description: Personal number must be unique for every person on product. maxLength: 20 type: string x-go-name: PersonalNumber personal_number_issuer: description: >- Personal number issuer country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: PersonalNumberIssuer first_name: description: >- First name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 minLength: 1 type: string x-go-name: FirstName middle_name: description: >- Middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName last_name: description: >- Last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 minLength: 1 type: string x-go-name: LastName birth_date: description: Birthdate. Must be in 2006-01-02 format. At least 18 years old. format: date type: string x-go-name: BirthDate birth_country_code: description: Birth country code in ISO 3166-1 Alpha-3 code standard. enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: BirthCountryCode gender: $ref: '#/components/schemas/Gender' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. maxLength: 100 type: string x-go-name: Mobile email: description: E-mail address format: email maxLength: 255 type: string x-go-name: Email external_id: description: External ID must be unique for every person on product. maxLength: 50 type: string x-go-name: ExternalID residence_country_code: description: Residence country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode is_represented_by_someone_else: description: Whether the person is representative or not type: boolean x-go-name: IsRepresentedBySomeoneElse is_beneficial_owner: description: Whether the person is beneficial owner or not type: boolean x-go-name: IsBeneficialOwner is_politically_exposed_person: description: Whether the person is politically exposed or not type: boolean x-go-name: IsPoliticallyExposedPerson politically_exposed_person_explanation: description: Explanation of politically exposed person maxLength: 255 type: string x-go-name: PoliticallyExposedPersonExplanation risk_profile: $ref: '#/components/schemas/APIRiskProfile' loyalty_number: description: Loyalty number maxLength: 20 minLength: 20 type: string x-go-name: LoyaltyNumber document_number: description: Document number maxLength: 100 type: string x-go-name: DocumentNumber address: $ref: '#/components/schemas/PersonAddress' is_sanctions_related: description: Is Sanctions Related type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: Is Adverse Media Involved type: boolean x-go-name: IsAdverseMediaInvolved push_notifications_enabled: description: Is push notifications enabled type: boolean x-go-name: PushNotificationsEnabled preferred_language_code: $ref: '#/components/schemas/LanguageCode' expected_turnover: description: ExpectedTurnover enum: - From0to1500 - From1501to3000 - From3001to5000 - From5001to15000 - From15001AndMore type: string x-go-name: ExpectedTurnover type: object x-go-package: github.com/wallester/api/model UpdatePersonPatchSwaggerModel: title: >- UpdatePersonPatchSwaggerModel is a model representation of the UpdatePersonPatchRequest for swagger. properties: title: $ref: '#/components/schemas/Title' personal_number: description: Personal number must be unique for every person on product. maxLength: 20 type: string x-go-name: PersonalNumber personal_number_issuer: description: >- Personal number issuer country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: PersonalNumberIssuer first_name: description: >- First name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 minLength: 1 type: string x-go-name: FirstName middle_name: description: >- Middle name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 type: string x-go-name: MiddleName last_name: description: >- Last name. Allowed case-insensitive characters: [a-z0-9'-./, & æ ä å á é í ø ö ó õ š ü ú ž à è ì ò ù â ê î ô û ã ñ ë ï ÿ ė ç ć ń ś ź ā ē ī ō ū ą ę į ų č ģ ķ ļ ņ ŗ ỳ ǹ ẁ ý ǵ ḱ ĺ ḿ ṕ ŕ ẃ ŷ ĉ ĝ ĥ ĵ ŝ ŵ ẑ ẽ ĩ ũ ỹ ṽ ḧ ẅ ẍ ẗ ẘ ẙ ȳ ḡ ă ĕ ĭ ŏ ŭ ğ ǫ ǎ ě ǐ ǒ ǔ ď ǧ ȟ ǰ ǩ ľ ň ř ť ȩ ḑ ḩ ş ţ ő ű ů ǖ ǘ ǚ ǜ] maxLength: 100 minLength: 1 type: string x-go-name: LastName birth_date: description: Birthdate. Must be in 2006-01-02 format. At least 18 years old. format: date type: string x-go-name: BirthDate birth_country_code: description: Birth country code in ISO 3166-1 Alpha-3 code standard. enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: BirthCountryCode gender: $ref: '#/components/schemas/Gender' mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. maxLength: 100 type: string x-go-name: Mobile email: description: E-mail address format: email maxLength: 255 type: string x-go-name: Email external_id: description: External ID must be unique for every person on product. maxLength: 50 type: string x-go-name: ExternalID residence_country_code: description: Residence country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode is_represented_by_someone_else: description: Whether the person is representative or not type: boolean x-go-name: IsRepresentedBySomeoneElse is_beneficial_owner: description: Whether the person is beneficial owner or not type: boolean x-go-name: IsBeneficialOwner is_politically_exposed_person: description: Whether the person is politically exposed or not type: boolean x-go-name: IsPoliticallyExposedPerson politically_exposed_person_explanation: description: Explanation of politically exposed person maxLength: 255 type: string x-go-name: PoliticallyExposedPersonExplanation risk_profile: description: Risk profile. enum: - Low - Medium - High type: string x-go-name: RiskProfile loyalty_number: description: Loyalty number maxLength: 20 minLength: 20 type: string x-go-name: LoyaltyNumber document_number: description: Document number maxLength: 100 type: string x-go-name: DocumentNumber address: $ref: '#/components/schemas/PersonAddress' is_sanctions_related: description: Is Sanctions Related type: boolean x-go-name: IsSanctionsRelated is_adverse_media_involved: description: Is Adverse Media Involved type: boolean x-go-name: IsAdverseMediaInvolved push_notifications_enabled: description: Is push notifications enabled type: boolean x-go-name: PushNotificationsEnabled preferred_language_code: $ref: '#/components/schemas/LanguageCode' expected_turnover: description: ExpectedTurnover enum: - From0to1500 - From1501to3000 - From3001to5000 - From5001to15000 - From15001AndMore type: string x-go-name: ExpectedTurnover type: object x-go-package: github.com/wallester/api/model UpdatePersonRequest: title: UpdatePersonRequest is a request to update existing person information. properties: person: $ref: '#/components/schemas/PersonFields' required: - person type: object x-go-package: github.com/wallester/api/model UpdatePersonResponse: title: >- UpdatePersonResponse is the response to the request to update existing person information. properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model UpdatePushNotificationsEnabledRequest: properties: push_notifications_enabled: description: Are push notifications enabled for cardholder type: boolean x-go-name: PushNotificationsEnabled type: object x-go-package: github.com/wallester/api/model UpdatePushNotificationsEnabledResponse: properties: person: $ref: '#/components/schemas/Person' type: object x-go-package: github.com/wallester/api/model UpdateRepresentativeRequest: title: >- UpdateRepresentativeRequest is a request to update existing representative information. properties: title: $ref: '#/components/schemas/Title' first_name: description: Representative first name maxLength: 100 type: string x-go-name: FirstName middle_name: description: Representative middle name maxLength: 100 type: string x-go-name: MiddleName last_name: description: Representative last name maxLength: 100 type: string x-go-name: LastName position: description: Representative position maxLength: 100 type: string x-go-name: Position is_member_of_the_board: description: Is member of the board? type: boolean x-go-name: IsMemberOfTheBoard is_representative: description: Is representative? type: boolean x-go-name: IsRepresentative is_ultimate_beneficial_owner: description: Is ultimate beneficial owner? type: boolean x-go-name: IsUltimateBeneficialOwner birth_date: description: >- Birthdate. Must be in 2006-01-02 format. Must be at least 16 years old. format: date type: string x-go-name: BirthDate residence_country_code: description: Residence country code in ISO 3166-1 Alpha-3 code standard enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT maxLength: 3 type: string x-go-name: ResidenceCountryCode is_sanctions_related: description: Is Sanctions Related type: boolean x-go-name: IsSanctionsRelated is_politically_exposed: description: Is Politically Exposed type: boolean x-go-name: IsPoliticallyExposed is_adverse_media_involved: description: Is Adverse Media Involved type: boolean x-go-name: IsAdverseMediaInvolved is_shareholder: description: Is shareholder? type: boolean x-go-name: IsShareholder percentage_owned: description: |- Percentage owned.
__If representative is shareholder, minimum value is 1.__ format: float maximum: 100 minimum: 0 type: number x-go-name: PercentageOwned email: description: Email maxLength: 255 type: string x-go-name: Email mobile: description: >- Mobile phone number. Must be an international standard valid number, only digits with "+" prefix allowed. type: string x-go-name: Mobile type: object x-go-package: github.com/wallester/api/model UpdateRepresentativeResponse: title: >- UpdateRepresentativeResponse is the response to the request to update existing representative information. properties: representative: $ref: '#/components/schemas/Representative' type: object x-go-package: github.com/wallester/api/model UpdateTemplateRequest: title: >- UpdateTemplateRequest is a request to update template. Template must be unique. properties: message_type: $ref: '#/components/schemas/MessageType' delivery_type: $ref: '#/components/schemas/DeliveryType' language_code: $ref: '#/components/schemas/LanguageCode' body: description: Template body type: string x-go-name: Body subject: description: Template subject type: string x-go-name: Subject required: - message_type - delivery_type - language_code - body type: object x-go-package: github.com/wallester/api/model UpdateTemplateResponse: title: >- UpdateTemplateResponse is the response to the request to update template. properties: template: $ref: '#/components/schemas/Template' type: object x-go-package: github.com/wallester/api/model UploadKYCDocumentRequest: properties: kyc_check_id: description: KYC check ID format: uuid4 type: string x-go-name: KYCCheckID file: $ref: '#/components/schemas/KYCDocumentFile' issuer: description: |- Issuer country code in ISO 3166-1 Alpha-3 code standard in: formData enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT type: string x-go-name: Issuer number: description: Number maxLength: 50 type: string x-go-name: Number type: description: Type enum: - IDVDocument - IDVSelfieImage - IDVReport type: string x-go-name: Type subtype: description: |- Subtype in: formData enum: - NationalIDBack - NationalIDFront - Passport - ResidencePermitBack - ResidencePermitFront type: string x-go-name: Subtype required: - kyc_check_id - file - type type: object x-go-package: github.com/wallester/api/model UploadKYCDocumentResponse: properties: kyc_document_id: format: uuid4 type: string x-go-name: KYCDocumentID type: object x-go-package: github.com/wallester/api/model UserWithProfile: properties: id: description: User ID format: uuid4 type: string x-go-name: ID first_name: description: First name maxLength: 100 type: string x-go-name: FirstName last_name: description: Last name maxLength: 100 type: string x-go-name: LastName email: description: Email maxLength: 255 type: string x-go-name: Email profile_image: description: Profile image type: string x-go-name: ProfileImage profile_background_color: description: Profile background color type: string x-go-name: ProfileBackgroundColor last_logon_time: description: |- Recent date-time the user was logged in at Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: LastLogonTime mobile: description: Mobile. Must be unique maxLength: 30 type: string x-go-name: Mobile created_at: description: |- Date-time the user was created at Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: CreatedAt deleted_at: description: |- Date-time the user was deleted at Time must be in 2006-01-02T15:04:05Z format format: date-time type: string x-go-name: DeletedAt required: - first_name - last_name - email - mobile type: object x-go-package: github.com/wallester/api/model VerificationStatus: title: Verification status. enum: - Confirmed - Failed - NotConfirmed - PendingApproval - Rejected - Required type: string x-go-package: github.com/wallester/common/model VisaActionCode: enum: - '00' - '05' - '06' - '14' - '54' - '85' - '96' - N7 type: string x-go-package: github.com/wallester/common/model Wallets: properties: is_apple_pay_enabled: type: boolean x-go-name: IsApplePayEnabled is_google_pay_enabled: type: boolean x-go-name: IsGooglePayEnabled type: object x-go-package: github.com/wallester/api/model accountAdjustmentNotificationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller accountToAccountTransferNotificationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller activateCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller applePayIncentiveNotificationIncompleteProvisioningResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller applePayIncentiveNotificationSuccessfulTransactionResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-name: applePayOrangeFlowResponse x-go-package: github.com/wallester/api/controller authorizationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller blockCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller cancelFeeResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller closedCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller closingCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller completeFeeResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller createCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller createFeeResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller decisionRequestAuthorizationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID response_code: description: 'in: body' enum: - Approved - ApprovedForPartialAmount - ClientSystemMalfunction - DeclinedByClient - DoNotHonour - NotSufficientFunds - TransactionNotPermittedToCardholder type: string x-go-name: ResponseCode required: - X-Request-ID - response_code type: object x-go-package: github.com/wallester/api/controller decisionRequestBalanceInquiryAuthorizationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID available_amount: description: 'in: body' format: double type: number x-go-name: AvailableAmount balance: description: 'in: body' format: double type: number x-go-name: Balance response_code: description: 'in: body' enum: - Approved - ApprovedForPartialAmount - ClientSystemMalfunction - DeclinedByClient - DoNotHonour - NotSufficientFunds - TransactionNotPermittedToCardholder type: string x-go-name: ResponseCode required: - X-Request-ID - response_code type: object x-go-package: github.com/wallester/api/controller decisionRequestPartialAuthorizationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID approved_amount: description: 'in: body' format: double type: number x-go-name: ApprovedAmount response_code: description: 'in: body' enum: - Approved - ApprovedForPartialAmount - ClientSystemMalfunction - DeclinedByClient - DoNotHonour - NotSufficientFunds - TransactionNotPermittedToCardholder type: string x-go-name: ResponseCode required: - X-Request-ID - response_code type: object x-go-package: github.com/wallester/api/controller dispatchCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller expireCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller headerXRequestID: description: nolint:unused properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller initiateActionResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller kycCheckResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller kycStatusChangeResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller orderedCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller personalizeCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller releaseAuthorizationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller renewCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller replaceCardEventResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller reversalAuthorizationResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller threeDSValidateResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID status: description: 'in: body' enum: - Success - Pending - Rejected - Error type: string x-go-name: Status required: - X-Request-ID - status type: object x-go-package: github.com/wallester/api/controller threeDSecureOTPResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller transactionClearingResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller updateFeeResponse: properties: X-Request-ID: description: >- Unique ID for the request. Generated by Wallester. Equal for Request and Response in: header format: uuid4 type: string x-go-name: RequestID required: - X-Request-ID type: object x-go-package: github.com/wallester/api/controller CompanyAddCorporateDocumentsRequest: type: object properties: type: description: Document type type: string enum: - RegistrationIncorporationCertificate - BeneficialOwnersCertificate x-go-name: Type file: description: >- File to upload. Supported types: docx, pdf, odt, jpeg, jpg. File max size is 15MB. Filename max length is 1024 chars type: string format: binary x-go-name: File required: - type - file KycDocumentUploadDocumentRequest: type: object properties: kyc_check_id: description: KYC check ID type: string format: uuid4 x-go-name: KYCCheckID file: description: >- File to upload. Supported types: pdf, jpeg, jpg, png. File max size is 100MB. Filename max length is 1024 chars type: string format: binary x-go-name: File issuer: description: Issuer country code in ISO 3166-1 Alpha-3 code standard type: string enum: - AFG - ALA - ALB - DZA - ASM - AND - AGO - AIA - ATA - ATG - ARG - ARM - ABW - AUS - AUT - AZE - BHS - BHR - BGD - BRB - BLR - BEL - BLZ - BEN - BMU - BTN - BOL - BES - BIH - BWA - BVT - BRA - IOT - BRN - BGR - BFA - BDI - CPV - KHM - CMR - CAN - CYM - CAF - TCD - CHL - CHN - CXR - CCK - COL - COM - COG - COD - COK - CRI - CIV - HRV - CUB - CUW - CYP - CZE - DNK - DJI - DMA - DOM - ECU - EGY - SLV - GNQ - ERI - EST - ETH - FLK - FRO - FJI - FIN - FRA - GUF - PYF - ATF - GAB - GMB - GEO - DEU - GHA - GIB - GRC - GRL - GRD - GLP - GUM - GTM - GGY - GIN - GNB - GUY - HTI - HMD - VAT - HND - HKG - HUN - ISL - IND - IDN - IRN - IRQ - IRL - IMN - ISR - ITA - JAM - JPN - JEY - JOR - KAZ - KEN - KIR - PRK - KOR - KWT - KGZ - LAO - LVA - LBN - LSO - LBR - LBY - LIE - LTU - LUX - MAC - MKD - MDG - MWI - MYS - MDV - MLI - MLT - MHL - MTQ - MRT - MUS - MYT - MEX - FSM - MDA - MCO - MNG - MNE - MSR - MAR - MOZ - MMR - NAM - NRU - NPL - NLD - NCL - NZL - NIC - NER - NGA - NIU - NFK - MNP - NOR - OMN - PAK - PLW - PSE - PAN - PNG - PRY - PER - PHL - PCN - POL - PRT - PRI - QAT - REU - ROU - RUS - RWA - BLM - SHN - KNA - LCA - MAF - SPM - VCT - WSM - SMR - STP - SAU - SEN - SRB - SYC - SLE - SGP - SXM - SVK - SVN - SLB - SOM - ZAF - SGS - SSD - ESP - LKA - SDN - SUR - SJM - SWZ - SWE - CHE - SYR - TWN - TJK - TZA - THA - TLS - TGO - TKL - TON - TTO - TUN - TUR - TKM - TCA - TUV - UGA - UKR - ARE - GBR - USA - UMI - URY - UZB - VUT - VEN - VNM - VGB - VIR - WLF - ESH - YEM - ZMB - ZWE - UNK - XKX - ANT x-go-name: Issuer number: description: Number type: string maxLength: 50 x-go-name: Number type: description: Type type: string enum: - IDVDocument - IDVSelfieImage - IDVReport x-go-name: Type subtype: description: Subtype type: string enum: - NationalIDBack - NationalIDFront - Passport - ResidencePermitBack - ResidencePermitFront x-go-name: Subtype required: - kyc_check_id - file - type PaymentDocumentAddDocumentsRequest: type: object properties: payment_id: description: Payment ID type: string format: uuid4 x-go-name: PaymentID payment_type: description: Payment type type: string x-go-name: PaymentType payment_documents: description: >- Payment documents to upload. Total size of files should not exceed 12MB. Supported types: png, jpg, pdf. Each file should be sent under the same key "payment_documents" and should not exceed 3MB. type: string format: binary x-go-name: PaymentDocuments required: - payment_id - payment_type - payment_documents