[{"name":"post-auth-token","description":"Generate JWT Token. Generates a new JWT token using the client key and seller key.","parameters":{"type":"object","properties":{"body":{"type":"object","properties":{"mpl":{"type":"string"},"key":{"type":"string"}}}}},"x-payme":{"method":"POST","path":"/auth/token","operationId":"post-auth-token","baseUrl":"https://sandbox.payme.io/api"}},{"name":"post-auth-refresh","description":"Refresh JWT Token. Refreshes an existing JWT token using the refresh token.","parameters":{"type":"object","properties":{"PayMe-Partner-Key":{"type":"string","description":"The unique Partner identifier.","in":"header"},"PayMe-Merchant-Key":{"type":"string","description":"The unique Seller identifier.","in":"header"},"body":{"type":"object","properties":{"refresh_token":{"type":"string","description":"The refresh token."}},"required":["refresh_token"]}},"required":["PayMe-Partner-Key","PayMe-Merchant-Key","body"]},"x-payme":{"method":"POST","path":"/auth/refresh","operationId":"post-auth-refresh","baseUrl":"https://sandbox.payme.io/api","security":[{"partnerKey":[],"merchantKey":[]}],"securitySchemes":{"partnerKey":{"type":"apiKey","in":"header","name":"PayMe-Partner-Key"},"merchantKey":{"type":"apiKey","in":"header","name":"PayMe-Merchant-Key"}},"credentials":[{"name":"PayMe-Partner-Key","in":"header","required":true},{"name":"PayMe-Merchant-Key","in":"header","required":true},{"name":"refresh_token","in":"body","required":true}]}},{"name":"get-products","description":"Get Products. The GET /products endpoint provides access to product data, enabling clients to filter and sort through available products. Clients can specify parameters such as product status, creation date range, currency, description, order columns, and directions.","parameters":{"type":"object","properties":{"status":{"type":"string","description":"The product status - indicates if the product is available or not.","in":"query"},"created_at[]":{"type":"string","description":"Common date range. Use [min] / [max] on query parameters.","in":"query"},"due_date":{"type":"string","description":"Common date range. Use [min] / [max] on query parameters.","in":"query"},"items_per_page":{"type":"integer","description":"The count of items returned under the page, up to 500 per page. ","in":"query"},"page":{"type":"integer","description":"The page number","in":"query"},"name":{"type":"string","description":"The product name.","in":"query"},"description":{"type":"string","description":"The product description.","in":"query"},"currency":{"type":"string","description":"The product currency - ISO 3 letters.","in":"query"},"price_inc_vat_min":{"type":"number","description":"The minimum price include VAT -> Store Price only. (store_configuration)","in":"query"},"price_inc_vat_max":{"type":"number","description":"The maximum price include VAT -> Store price only. (store_configuration)","in":"query"},"sort_by":{"type":"string","description":"The column name that will be used for ordering the results.","in":"query"},"sort_direction":{"type":"string","description":"The direction of ordering.","in":"query"}},"required":["status"]},"x-payme":{"method":"GET","path":"/products","operationId":"get-products","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"post-user","description":"Create New Product. This endpoint is an essential part of the product management system. The endpoint allows clients to add new products to the system by sending the necessary information in the request.","parameters":{"type":"object","properties":{"body":{"type":"object","properties":{"product_remote_id":{"type":"string","description":"The extneral product identifier."},"name":{"type":"string","description":"The name of the product.\n"},"status":{"type":"integer","description":"The status of the product.\nOptions:\n1 = `Available`, 0 = `Not Available`"},"description":{"type":"string","description":"The product description.\n\nMaximum Length = 75 Characters. "},"store_prices":{"type":"object","description":"The item store configuration.","properties":{"currency":{"type":"string","description":"3 Letter ISO."},"is_vat_free":{"type":"boolean","description":"The VAT indicator. "},"price_without_vat":{"type":"number","description":"Price without VAT."},"price_include_vat":{"type":"number","description":"Price with VAT."}}},"costs":{"type":"object","description":"The item costs object.","properties":{"currency":{"type":"string","description":"3 Letter ISO."},"is_vat_free":{"type":"boolean","description":"The VAT indicator. "},"price_without_vat":{"type":"number","description":"The price without VAT."},"price_include_vat":{"type":"number","description":"The price including VAT."}}}},"required":["name","status","description"],"description":"Post the necessary fields for the API to create a new user."}},"required":["body"]},"x-payme":{"method":"POST","path":"/products","operationId":"post-user","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"get-products-guid","description":"Get by Product Guid. The GET /products/guid endpoint provides access to product data, enabling clients to filter and sort through available products. Clients can specify parameters such as product status, creation date range, currency, description, order columns, and directions.","parameters":{"type":"object","properties":{"guid":{"type":"string","in":"path"}},"required":["guid"]},"x-payme":{"method":"GET","path":"/products/{guid}","operationId":"get-products-guid","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"patch-products-product-id","description":"Update Product. The patch-product endpoint allows for partial updates to an existing product's details using guid as the identifier. Below is an example JSON payload for a PATCH request to update various fields of a product.","parameters":{"type":"object","properties":{"guid":{"type":"string","in":"path"},"body":{"type":"object","properties":{"name":{"type":"string","description":"The name of the product."},"status":{"type":"integer","description":"The status of the product.\nOptions:\n1 = `Available`, 0 = `Not Available`"},"description":{"type":"string","description":"The description of the product."},"store_configuration":{"type":"object","description":"The item store configurations object.","properties":{"currency":{"type":"string","description":"The currency of the item in the store.\n3 Letter ISO"},"is_vat_free":{"type":"boolean","description":"The item VAT indicator."},"price_without_vat":{"type":"number","description":"The price without VAT."},"price_include_vat":{"type":"number","description":"The price including VAT."}}},"costs_details":{"type":"object","description":"The item costs object.","properties":{"currency":{"type":"string","description":"The currency of the item in the store.\n3 Letter ISO"},"is_vat_free":{"type":"boolean","description":"The item VAT indicator."},"price_without_vat":{"type":"number","description":"The price without VAT."},"price_include_vat":{"type":"number","description":"The price including VAT."}}}}}},"required":["guid"]},"x-payme":{"method":"PATCH","path":"/products/{guid}","operationId":"patch-products-product-id","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"delete-products-guid","description":"Delete Product. The delete-product endpoint is a critical component of the product management system. It allows clients to remove products from the available products list based on specific identifiers.","parameters":{"type":"object","properties":{"guid":{"type":"string","in":"path"},"body":{"type":"object"}},"required":["guid"]},"x-payme":{"method":"DELETE","path":"/products/{guid}","operationId":"delete-products-guid","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"get-customers","description":"Get Customers. The GET /customers endpoint provides access to customer data, enabling clients to filter and sort through available customers.","parameters":{"type":"object","properties":{"status":{"type":"boolean","description":"The customer status - indicates if the customer is available or not. 0 - Deacativated, 1 - Active, 2 - Draft","in":"query"},"created_at":{"type":"string","description":"Common date range. Use [min] / [max] on query parameters.","in":"query"},"due_date":{"type":"string","description":"Common date range. Use [min] / [max] on query parameters.","in":"query"},"items_per_page":{"type":"integer","description":"The number of items per page.","in":"query"},"page":{"type":"integer","description":"The page number.","in":"query"},"first_name":{"type":"string","description":"The customer's first name.","in":"query"},"last_name":{"type":"string","description":"The customer's last name.","in":"query"},"email":{"type":"string","description":"The customer's email.","in":"query"},"phone_number":{"type":"string","description":"The customer's phone number.","in":"query"},"description":{"type":"string","description":"The customer description.","in":"query"},"sort_by":{"type":"string","description":"The column name for ordering results.","in":"query"},"sort_direction":{"type":"string","description":"The direction for ordering results.","in":"query"}}},"x-payme":{"method":"GET","path":"/customers","operationId":"get-customers","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"post-customers","description":"Create New Customer. This endpoint allows clients to add new customers to the system by sending the necessary information in the request.","parameters":{"type":"object","properties":{"body":{"type":"object","properties":{"customer_remote_id":{"type":"string","description":"The customer's first name."},"first_name":{"type":"string","description":"The customer's first name."},"last_name":{"type":"string","description":"The customer's last name."},"email":{"type":"string","description":"The customer's email."},"phone_number":{"type":"string","description":"The customer's mobile number."},"country":{"type":"string","description":"The customer's country."},"city":{"type":"string","description":"The customer's city."},"street":{"type":"string","description":"The customer's street."},"building_number":{"type":"string","description":"The customer's building number."},"floor":{"type":"string","description":"The customer's floor."},"zip":{"type":"string","description":"The customer's ZIP code."},"middle_name":{"type":"string","description":"The customer's middle name."},"company_name":{"type":"string","description":"The customer's company name."},"gender":{"type":"string","description":"The customer's gender.\nAllowed values:\n1. `Male`\n2. `Female`\n3. `Other`"},"description":{"type":"string","description":"The customer description."},"birthday":{"type":"string","description":"The customer's birthday.\n\nMM-DD-YYYY Format"},"additional_phone":{"type":"string","description":"Additional phone number of the customer."},"payment_tokens":{"type":"object","properties":{"payment_method":{"type":"string","description":"The payment method of the token.\nAllowed values:\n1. `Credit Card`\n2. `IL Direct Debit`"},"token_guid":{"type":"string","description":"The unique identifier of the token in PayMe.\n"}}}},"required":["first_name","last_name","email","phone_number"]}},"required":["body"]},"x-payme":{"method":"POST","path":"/customers","operationId":"post-customers","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"get-customers-guid","description":"Get by Customer Guid","parameters":{"type":"object","properties":{"guid":{"type":"string","description":"The unique PayMe customer identifier.","in":"path"}},"required":["guid"]},"x-payme":{"method":"GET","path":"/customers/{guid}","operationId":"get-customers-guid","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"patch-customers","description":"Update Customer. Update customer details.","parameters":{"type":"object","properties":{"guid":{"type":"string","description":"The unique PayMe customer identifier.","in":"path"},"body":{"type":"object","properties":{"customer_remote_id":{"type":"string","description":"The unique identifier for the customer."},"first_name":{"type":"string","description":"The customer's first name."},"middle_name":{"type":"string","description":"The customer's middle name."},"last_name":{"type":"string","description":"The customer's last name."},"email":{"type":"string","description":"The customer's email."},"phone_number":{"type":"string","description":"The customer's mobile number."},"additional_phone_number":{"type":"string","description":"Additional phone number of the customer."},"country":{"type":"string","description":"The customer's country."},"city":{"type":"string","description":"The customer's city."},"street":{"type":"string","description":"The customer's street."},"building_number":{"type":"string","description":"The customer's building number."},"floor":{"type":"string","description":"The customer's floor."},"zip":{"type":"string","description":"The customer's ZIP code."},"company_name":{"type":"string","description":"The customer's company name."},"gender":{"type":"string","description":"The customer's gender."},"description":{"type":"string","description":"The customer description."},"birthday":{"type":"string","description":"The customer's birthday."},"payment_tokens":{"type":"object","properties":{"payment_method":{"type":"string","description":"The payment method of the token.\nAllowed values:\n1. `Credit Card`\n2. `IL Direct Debit`"},"token_guid":{"type":"string","description":"The unique identifier of the token in PayMe.\n"}}}}}},"required":["guid"]},"x-payme":{"method":"PATCH","path":"/customers/{guid}","operationId":"patch-customers","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}},{"name":"delete-customers","description":"Delete Customer. Delete a customer by their unique PayMe identifier.","parameters":{"type":"object","properties":{"guid":{"type":"string","description":"The unique PayMe customer identifier.","in":"path"}},"required":["guid"]},"x-payme":{"method":"DELETE","path":"/customers/{guid}","operationId":"delete-customers","baseUrl":"https://sandbox.payme.io/api","security":[{"bearerAuth":[]}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}]