{"openapi":"3.0.0","paths":{"/merchant-api/v1/balance":{"get":{"operationId":"MerchantApiController_getMerchantBalance","summary":"Get balance of the merchant","description":"This method is showing the current balance and hold_balance of the merchant\n\n    To use method you must send empty body in the HTTP request","parameters":[],"responses":{"200":{"description":"The balance and hold balance of the merchant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBalanceResponseDto"}}}}},"security":[{"bearer":[]}],"tags":["Balances"]}},"/merchant-api/v1/gates-balance":{"get":{"operationId":"MerchantApiController_getGatesBalance","summary":"Get balance of of the merchant gates","description":"This method is showing the current balance  of the gates\n\n    To use method you must send empty body in the HTTP request","parameters":[],"responses":{"200":{"description":"The balance of the merchant gates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/getGatesBalanceResponseDto"}}}}}},"security":[{"bearer":[]}],"tags":["Balances"]}},"/merchant-api/v1/invoices":{"post":{"operationId":"InvoicesController_getInvoices","summary":"Get list of invoices","description":"This method showing the list of the invoices","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoicesDto"},"examples":{"a":{"summary":"Get list of invoices","description":"For the getting list of the invoices you must enter few params in request body:\n                                                       \n      \"limit\" - specifies how many invoices should be returned in the list,\n\n      \"updated_at_gte\" - specifies how many invoices, which timestamp is greater or equal than provided  timestamp should be returned in the list"}}}}},"responses":{"201":{"description":"The invoices was successfully geted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantInvoice"}}}}},"tags":["Invoices"],"security":[{"bearer":[]}]}},"/merchant-api/v1/invoices/{transaction_uid}":{"post":{"operationId":"InvoicesController_getInvoiceById","summary":"Get invoice by transaction_uid","description":"This method shows the  invoice by provided in params transaction_uid:\n       \n        To use method you must send empty body in the HTTP request","parameters":[{"name":"transaction_uid","required":true,"in":"path","description":"The id of the invoice, which will be shown by the method","allowEmptyValue":false,"example":"268b2841-ca68-4b55-bf09-25641f1f304a","schema":{"type":"string"}}],"responses":{"201":{"description":"The invoice by id was successfully geted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantInvoice"}}}}},"tags":["Invoices"],"security":[{"bearer":[]}]}},"/merchant-api/v1/invoices/get-by-external-id":{"post":{"operationId":"InvoicesController_getInvoiceByExternalId","summary":"Get invoice by external_id","description":"This method shows the invoice by external_id","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceByExternalId"}}}},"responses":{"201":{"description":"The invoice by external id was successfully geted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantInvoice"}}}}},"tags":["Invoices"],"security":[{"bearer":[]}]}},"/merchant-api/v1/invoices/create":{"post":{"operationId":"InvoicesController_createInvoice","summary":"Create invoice","description":"This method is creating invoice","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceDto"},"examples":{"a":{"summary":"Create invoice","description":"For the creating of the invoice - you must enter few params in the HTTP request body:\n\n           \"amount\" - the price of the invoice,\n           \n           \"comment\" - the description of the invoice,\n           \n           \"currency_id\" - the currency of the invoice,\n           \n           \"external_id\" -  client order number, must be unique for the merchant,\n\n           \"succeed_url\" - the URL to which the payer will be redirected after successful payment of the invoice,\n           \n           \"failed_url\" - the URL to which the payer will be redirected after an unsuccessful invoice payment,\n\n           \"callback_url\" - URL address to which the transaction status notification will be sent,\n\n           \"client_ip\" - Ip address of the buyer,\n\n           \"personal_data\" - Additional parameters are needed for some gates, for example, when personal data needs to be provided to the API, not through a form. Example:{\"first_name\": \"Alex\"}\n\n           Example of callback body:\n\n           {\n            \"transaction_uid\": \"dbbc2453-47ee-4d22-bde4-25a9bb6eebe9\",\n            \"amount\": 300,\n            \"status\": \"Succeed\",\n            \"remark\": \"Successfully paid\",\n            \"currency_id\": \"RUB\",\n            \"external_id\": \"invoice test\",\n            \"comment\": \"For merchant\",\n            \"recalculated\": false,\n            \"updated_at\": \"2023-02-20T06:47:21.227291+00:00\",\n            \"type\": \"invoice\",\n            \"sanitized_mask\": \"516180******3082\",\n            \"sign\": \"f07adb242df5c39b73cc1c13e6f796013840102cbaf86aa708a03d1199b14e21\"\n          }"}}}}},"responses":{"201":{"description":"The invoice has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceResponseDto"}}}}},"tags":["Invoices"],"security":[{"bearer":[]}]}},"/merchant-api/v1/invoices/create-h2h":{"post":{"operationId":"InvoicesController_createInvoiceH2H","summary":"Create h2h invoice","description":"This method is creating h2h invoice","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceH2HDto"},"examples":{"a":{"summary":"Create h2h invoice","description":"For the creating of the h2h  invoice - you must enter few params in the HTTP request body:\n\n           \"amount\" - the price of the invoice,\n           \n           \"comment\" - the description of the invoice,\n           \n           \"currency_id\" - the currency of the invoice,\n           \n           \"external_id\" -  client order number, must be unique for the merchant,\n\n           \"succeed_url\" - the URL to which the payer will be redirected after successful payment of the invoice,\n           \n           \"failed_url\" - the URL to which the payer will be redirected after an unsuccessful invoice payment,\n\n           \"callback_url\" - URL address to which the transaction status notification will be sent,\n\n           \"card_cvv\" - cvv of the credit card,\n\n           \"card_month\" -  expiration month of the credit card,\n\n           \"card_number\" - card number of the credit card,\n\n           \"card_year\" - expiration year of the credit card,\n\n           \"cardholder\" - cardholder of the credit card\n\n           Example of callback body:\n\n           {\n            \"transaction_uid\": \"dbbc2453-47ee-4d22-bde4-25a9bb6eebe9\",\n            \"amount\": 300,\n            \"status\": \"Succeed\",\n            \"remark\": \"Successfully paid\",\n            \"currency_id\": \"RUB\",\n            \"external_id\": \"invoice test\",\n            \"comment\": \"For merchant\",\n            \"recalculated\": false,\n            \"updated_at\": \"2023-02-20T06:47:21.227291+00:00\",\n            \"type\": \"invoice\",\n            \"sanitized_mask\": \"516180******3082\",\n            \"sign\": \"f07adb242df5c39b73cc1c13e6f796013840102cbaf86aa708a03d1199b14e21\"\n          }"}}}}},"responses":{"201":{"description":"The h2h invoice has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceH2HResponseDto"}}}}},"tags":["Invoices"],"security":[{"bearer":[]}]}},"/merchant-api/v1/invoices/create-token":{"post":{"operationId":"InvoicesController_createInvoiceToken","summary":"Create invoice by token","description":"This method is creating invoice by token","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceTokenDto"},"examples":{"a":{"summary":"Create invoice by token","description":"For the creating of the  invoice by token - you must enter few params in the HTTP request body:\n\n           \"amount\" - the price of the invoice,\n           \n           \"comment\" - the description of the invoice,\n           \n           \"currency_id\" - the currency of the invoice,\n           \n           \"external_id\" -  client order number, must be unique for the merchant,\n\n           \"succeed_url\" - the URL to which the payer will be redirected after successful payment of the invoice,\n           \n           \"failed_url\" - the URL to which the payer will be redirected after an unsuccessful invoice payment,\n\n           \"callback_url\" - URL address to which the transaction status notification will be sent,\n\n           \"recurrent_token\" - token of the credit card,\n\n           \"additional_data\" - An optional parameter required to modify the stored token data  Existing token parameters will be overwritten by the submitted data,\n\n           Example of callback body:\n\n           {\n            \"transaction_uid\": \"dbbc2453-47ee-4d22-bde4-25a9bb6eebe9\",\n            \"amount\": 300,\n            \"status\": \"Succeed\",\n            \"remark\": \"Successfully paid\",\n            \"currency_id\": \"RUB\",\n            \"external_id\": \"invoice test\",\n            \"comment\": \"For merchant\",\n            \"recalculated\": false,\n            \"updated_at\": \"2023-02-20T06:47:21.227291+00:00\",\n            \"type\": \"invoice\",\n            \"sanitized_mask\": \"516180******3082\",\n            \"sign\": \"f07adb242df5c39b73cc1c13e6f796013840102cbaf86aa708a03d1199b14e21\"\n          }"}}}}},"responses":{"201":{"description":"The  invoice by token has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceResponseDto"}}}}},"tags":["Invoices"],"security":[{"bearer":[]}]}},"/merchant-api/v1/invoices/create-apm":{"post":{"operationId":"InvoicesController_createInvoiceApm","summary":"Create apm invoice","description":"This method is creating apm invoice","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceApmDto"},"examples":{"a":{"summary":"Create apm invoice","description":"For the creating of the apm  invoice - you must enter few params showed in CreateInvoiceApmDto"}}}}},"responses":{"201":{"description":"The apm invoice has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceResponseDto"}}}}},"tags":["Invoices"],"security":[{"bearer":[]}]}},"/merchant-api/v1/merchant/request-currency":{"post":{"operationId":"MerchantController_requestCurrency","parameters":[],"responses":{"201":{"description":""}}}},"/merchant-api/v1/withdraw":{"post":{"operationId":"WithdrawController_getWithdraws","summary":"Get list of withdraw","description":"This method showing the list of the withdraw","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWithdrawsDto"},"examples":{"a":{"summary":"Get list of withdraw","description":"For the getting list of the withdraw you must enter few params in request body:\n                                                       \n      \"limit\" - specifies how many withdraw should be returned in the list,\n\n      \"updated_at_gte\" - specifies how many withdraw, which timestamp is greater or equal than provided  timestamp should be returned in the list"}}}}},"responses":{"201":{"description":"The withdraw was successfully geted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantWithdraw"}}}}},"tags":["Withdraws"],"security":[{"bearer":[]}]}},"/merchant-api/v1/withdraw/{transaction_uid}":{"post":{"operationId":"WithdrawController_getWithdrawById","summary":"Get withdraw by transaction_uid","description":"This method shows the  withdraw by provided in params transaction_uid:\n       \n        To use method you must send empty body in the HTTP request","parameters":[{"name":"transaction_uid","required":true,"in":"path","description":"The id of the withdraw, which will be shown by the method","allowEmptyValue":false,"example":"268b2841-ca68-4b55-bf09-25641f1f304a","schema":{"type":"string"}}],"responses":{"201":{"description":"The withdraw by id was successfully geted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantWithdraw"}}}}},"tags":["Withdraws"],"security":[{"bearer":[]}]}},"/merchant-api/v1/withdraw/get-by-external-id":{"post":{"operationId":"WithdrawController_getInvoiceByExternalId","summary":"Get withdraw by external_id","description":"This method shows the withdraw by external_id","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWithdrawByExternalId"}}}},"responses":{"201":{"description":"The withdraw by external id was successfully geted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantWithdraw"}}}}},"tags":["Withdraws"],"security":[{"bearer":[]}]}},"/merchant-api/v1/withdraw/mass/create":{"post":{"operationId":"WithdrawController_generateMassWithdraws","summary":"Create mass withdraw","description":"This method is creating mass withdraw","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMassWithdrawDto"},"examples":{"a":{"summary":"Create mass withdraw","description":"For the creating of the mass withdraw - you must enter few params in the HTTP request body:\n\n           \"amount\" - the amount of the withdraw,\n           \n           \"comment\" - the description of the withdraw,\n           \n           \"external_id\" -  client order number, must be unique for the merchant,\n           \n           \"currency_id\" - the currency of the withdraw,\n           \n           \"card_number\" - number of the card to withdraw money,\n           \n           \"card_holder\" - card_holder of the card to withdraw money,\n           \n           \"card_year\" -  expiration year of the card to withdraw money, \n\n           \"card_month\" -  expiration month of the card to withdraw money, \n           \n           \"callback_url\" - URL address to which the transaction status notification will be sent,\n\n           \"additional_params\" - Additional params needed for some gates,\n\n           Example of callback body:\n\n           {\n             \"transaction_uid\": \"dbbc2453-47ee-4d22-bde4-25a9bb6eebe9\",\n             \"amount\": 300,\n             \"status\": \"Succeed\",\n             \"remark\": \"Payout successful\",\n             \"currency_id\": \"RUB\",\n             \"external_id\": \"withdraw test\",\n             \"comment\": \"For merchant\",\n             \"recalculated\": false,\n             \"updated_at\": \"2023-02-20T06:47:21.227291+00:00\",\n             \"type\": \"withdraw\",\n             \"sign\": \"f07adb242df5c39b73cc1c13e6f796013840102cbaf86aa708a03d1199b14e21\"\n           }"}}}}},"responses":{"201":{"description":"The withdraw has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMassWithdrawResponseDto"}}}}},"tags":["Withdraws"],"security":[{"bearer":[]}]}},"/merchant-api/v1/withdraw/apm/create":{"post":{"operationId":"WithdrawController_generateApmWithdraws","summary":"Create Apm withdraw","description":"This method is creating Apm withdraw","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWithdrawApmDto"},"examples":{"a":{"summary":"Create Apm withdraw","description":"For the creating of the Apm withdraw - you must enter params showed in CreateWithdrawApmDto\n        \n        Example of callback body:\n\n        {\n          \"transaction_uid\": \"dbbc2453-47ee-4d22-bde4-25a9bb6eebe9\",\n          \"amount\": 300,\n          \"status\": \"Succeed\",\n          \"remark\": \"Payout successful\",\n          \"currency_id\": \"RUB\",\n          \"external_id\": \"withdraw test\",\n          \"comment\": \"For merchant\",\n          \"recalculated\": false,\n          \"updated_at\": \"2023-02-20T06:47:21.227291+00:00\",\n          \"type\": \"withdraw\",\n          \"sign\": \"f07adb242df5c39b73cc1c13e6f796013840102cbaf86aa708a03d1199b14e21\"\n        }"}}}}},"responses":{"201":{"description":"The withdraw has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMassWithdrawResponseDto"}}}}},"tags":["Withdraws"],"security":[{"bearer":[]}]}},"/merchant-api/v1/recurrent/delete":{"post":{"operationId":"RecurrentController_deleteToken","summary":"Delete token","description":"This method is deleting token","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTokenDto"},"examples":{"a":{"summary":"Create token","description":"For the creating of the token you must enter  params from CreateTokenDto"}}}}},"responses":{"201":{"description":""}},"tags":["Recurrent"],"security":[{"bearer":[]}]}},"/merchant-api/v1/recurrent":{"post":{"operationId":"RecurrentController_getTokens","summary":"Get list of tokens","description":"This method showing the list of the tokens","parameters":[],"requestBody":{"required":true,"description":"The description for the Post Body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTokensDto"},"examples":{"a":{"summary":"Get list of tokens","description":"For the getting list of the tokens you must enter few params in request body:\n                                                       \n      \"limit\" - specifies how many tokens should be returned in the list,\n\n      \"updated_at_gte\" - specifies how many tokens, which timestamp is greater or equal than provided  timestamp should be returned in the list"}}}}},"responses":{"201":{"description":"The tokens was successfully geted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurrentToken"}}}}},"tags":["Recurrent"],"security":[{"bearer":[]}]}}},"info":{"title":"SmartGates","description":"Welcome to the Smartgates API                                            \n  \n  Authorization:\n  To use API you must have Api-token for the merchant, which you must enter in the HTTP header that is listed below,\n  or you can test methods from that ui, by entering Api-token in the Authorization button menu(on right side of the page)\n\n  Authorization Headers:                                                  \n  Authorization - Bearer {Api-token} - the token which is provided to the merchant by the smart-gates,                                              \n  Content-Type - application/json\n  \n  Status of the transactions:                          \n  1. Created                   \n  2. Pending                   \n  3. Failed\n  4. Succeed","version":"1.0","contact":{}},"tags":[],"servers":[],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GetBalanceResponseDto":{"type":"object","properties":{"balance":{"type":"string","example":"2500","description":"Balance of the merchant"},"hold_balance":{"type":"string","example":"0","description":"Hold_balance of the merchant"},"currency_id":{"type":"string","example":"RUB","description":"Currency of the balance"}},"required":["balance","hold_balance","currency_id"]},"getGatesBalanceResponseDto":{"type":"object","properties":{"balance":{"type":"string","example":"2500","description":"Balance of the gates"},"frozen_balance":{"type":"string","example":"2500","description":"Frozen withdraw balance of the gates"},"gate_id":{"type":"string","example":"01cfd079-5d56-44d1-b98d-397c8f9ac891","description":"Id of the gates"},"currency_id":{"type":"string","enum":["USD","EGP","RUB","KZT","EUR","UAH","MXN","INR","TRY","UZS","AZN","MDL","VND","KRW","AED","IDR","PKR","PEN","CLP","MAD","BYN","COP","NGN","ZAR","SAR","XOF","CAD","AUD","GBP","PLN","NZD","NOK","DKK","SEK","HUF","PHP","TJS","RSD"],"example":"EUR","description":"Currency of the gate"}},"required":["balance","frozen_balance","gate_id","currency_id"]},"GetInvoicesDto":{"type":"object","properties":{"limit":{"type":"number","example":10,"description":"How many invoices to show"},"updated_at_gte":{"type":"string","example":"2010-09-15T15:05:25.775Z","description":"Show the invoices with timestamps greater or equal to argument"}}},"MerchantInvoice":{"type":"object","properties":{"transaction_uid":{"type":"string","example":"268b2841-ca68-4b55-bf09-25641f1f304a","description":"Id of the invoice"},"amount":{"type":"string","example":"2500","description":"Amount of money to pay for the invoice"},"merchant_invoice_fee":{"type":"string","example":"10","description":"Fee for  the invoice"},"status":{"type":"string","example":"Created","description":"Current status of the invoice"},"remark":{"type":"string","example":"Gate error","description":"Description of invoice status"},"currency_id":{"type":"string","example":"RUB","description":"Currency of the invoice"},"external_id":{"type":"string","example":"code123","description":"the information about the client"},"comment":{"type":"string","example":"My first invoice","description":"the description of the invoice"},"created_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the invoice creation"},"updated_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the invoice update"}},"required":["transaction_uid","amount","merchant_invoice_fee","status","remark","currency_id","external_id","comment","created_at","updated_at"]},"GetInvoiceByExternalId":{"type":"object","properties":{"external_id":{"type":"string","example":"code123","description":"External id that you specified when creating the invoice"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Gate id you specified when creating the invoice"}},"required":["external_id"]},"CreateInvoiceDto":{"type":"object","properties":{"amount":{"type":"number","example":2500,"description":"Amount of money for invoice"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Id of the gate used for transaction"},"comment":{"type":"string","example":"My first invoice","description":"Comment for invoice"},"currency_id":{"type":"string","enum":["USD","EGP","RUB","KZT","EUR","UAH","MXN","INR","TRY","UZS","AZN","MDL","VND","KRW","AED","IDR","PKR","PEN","CLP","MAD","BYN","COP","NGN","ZAR","SAR","XOF","CAD","AUD","GBP","PLN","NZD","NOK","DKK","SEK","HUF","PHP","TJS","RSD"],"example":"RUB","description":"Currency of the invoice"},"external_id":{"type":"string","example":"h2gH123","description":"Client information must be unique"},"succeed_url":{"type":"string","example":"https://smarts-gates.net/succeed","description":"The URL to which the payer will be redirected after successful payment of the invoice"},"failed_url":{"type":"string","example":"https://smarts-gates.net/failed","description":"The URL to which the payer will be redirected after an unsuccessful invoice payment"},"callback_url":{"type":"string","example":"https://smarts-gates.net/callback","description":"URL address to which the transaction status notification will be sent"},"client_ip":{"type":"string","description":"Ip address of the buyer"},"issue_payment_token":{"type":"boolean","example":false,"description":"Create payment recurrent token of the card(available for some gates)"},"form_language":{"type":"string","enum":["ru","en","ua","es","it","de","pt","bg","pl","fr"],"example":"en","description":"Language of the form"},"email":{"type":"string","example":"rep@test.com","description":"Payers's email, needed for some gates"},"phone":{"type":"string","example":"79090096666","description":"Payers's phone number with country code, '+' - is optional"},"project_url":{"type":"string","example":"https://smarts-gates.net","description":"Url of your project needed for some gates"},"personal_data":{"type":"object","description":"Additional parameters are needed for some gates, for example, when personal data needs to be provided to the API, not through a form. Example:{\"first_name\": \"Alex\"}"}},"required":["amount","currency_id","external_id"]},"CreateInvoiceResponseDto":{"type":"object","properties":{"transaction_uid":{"type":"string","example":"6f15174c-241a-41d9-91be-001454f9c13b","description":"Unique id of the invoice"},"amount":{"type":"string","example":"2500","description":"Amount of money to pay for the invoice"},"status":{"type":"string","enum":["Created","Pending","Failed","Succeed"],"example":"Created","description":"Current status of the invoice"},"remark":{"type":"string","example":"","description":"Current remark of the invoice"},"currency_id":{"type":"string","example":"RUB","description":"Currency of the invoice"},"invoice_url":{"type":"string","example":"http://smart-gates.ru/123232112321","description":"Url for  invoice payment"},"external_id":{"type":"number","example":"code123","description":"the information about the client"},"comment":{"type":"string","example":"My first invoice","description":"the description of the invoice"},"created_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the invoice creation"}},"required":["transaction_uid","amount","status","remark","currency_id","invoice_url","external_id","comment","created_at"]},"CreateInvoiceH2HDto":{"type":"object","properties":{"amount":{"type":"number","example":2500,"description":"Amount of money for invoice"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Id of the gate used for transaction"},"comment":{"type":"string","example":"My first invoice","description":"Comment for invoice"},"currency_id":{"type":"string","enum":["USD","EGP","RUB","KZT","EUR","UAH","MXN","INR","TRY","UZS","AZN","MDL","VND","KRW","AED","IDR","PKR","PEN","CLP","MAD","BYN","COP","NGN","ZAR","SAR","XOF","CAD","AUD","GBP","PLN","NZD","NOK","DKK","SEK","HUF","PHP","TJS","RSD"],"example":"RUB","description":"Currency of the invoice"},"external_id":{"type":"string","example":"h2gH123","description":"Client information must be unique"},"succeed_url":{"type":"string","example":"https://smarts-gates.net/succeed","description":"The URL to which the payer will be redirected after successful payment of the invoice"},"failed_url":{"type":"string","example":"https://smarts-gates.net/failed","description":"The URL to which the payer will be redirected after an unsuccessful invoice payment"},"callback_url":{"type":"string","example":"https://smarts-gates.net/callback","description":"URL address to which the transaction status notification will be sent"},"card_cvv":{"type":"string","example":"111","description":"Cvv of the credit card"},"card_month":{"type":"string","example":"11","description":"Expiration month of the credit card"},"card_year":{"type":"string","example":"2042","description":"Expiration year of the credit card"},"card_number":{"type":"string","example":"1111222233334444","description":"Card number of the credit card"},"cardholder":{"type":"string","example":"JHON SMITH","description":"Cardholder of the credit card"},"client_ip":{"type":"string","example":"192.168.0.1","description":"Ip address of the buyer"},"additional_data":{"type":"object","example":{"accept_header":"*/*","java_enabled":true,"language":"en-EN","color_depth":48,"screen_height":1920,"screen_width":1080,"time_zone_offset":"-300","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"},"description":"Additional params needed for some gates"},"form_language":{"type":"string","enum":["ru","en","ua","es","it","de","pt","bg","pl","fr"],"example":"en","description":"Language of the form"},"project_url":{"type":"string","example":"https://smarts-gates.net","description":"Url of your project needed for some gates"},"email":{"type":"string","example":"rep@test.com","description":"Payers's email, needed for some gates"},"init_payment_token":{"type":"boolean","example":true,"description":"Possibility to create a payment token"},"date_of_birth":{"type":"string","example":"1995-08-24","description":"Your customer’s date of birth (must be 18+ y.o.).In ISO 8601 format"}},"required":["amount","currency_id","external_id","card_cvv","card_month","card_year","card_number","cardholder"]},"CreateInvoiceH2HResponseDto":{"type":"object","properties":{"transaction_uid":{"type":"string","example":"6f15174c-241a-41d9-91be-001454f9c13b","description":"Unique id of the invoice"},"amount":{"type":"string","example":"2500","description":"Amount of money to pay for the invoice"},"status":{"type":"string","enum":["Created","Pending","Failed","Succeed"],"example":"Created","description":"Current status of the invoice"},"currency_id":{"type":"string","example":"RUB","description":"Currency of the invoice"},"invoice_3ds_url":{"type":"string","example":"http://3ds.com/123232112321","description":"3ds url for  invoice payment"},"external_id":{"type":"number","example":"code123","description":"the information about the client"},"comment":{"type":"string","example":"My first invoice","description":"the description of the invoice"},"created_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the invoice creation"}},"required":["transaction_uid","amount","status","currency_id","invoice_3ds_url","external_id","comment","created_at"]},"CreateInvoiceTokenDto":{"type":"object","properties":{"amount":{"type":"number","example":2500,"description":"Amount of money for invoice"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Id of the gate used for transaction"},"comment":{"type":"string","example":"My first invoice","description":"Comment for invoice"},"currency_id":{"type":"string","enum":["USD","EGP","RUB","KZT","EUR","UAH","MXN","INR","TRY","UZS","AZN","MDL","VND","KRW","AED","IDR","PKR","PEN","CLP","MAD","BYN","COP","NGN","ZAR","SAR","XOF","CAD","AUD","GBP","PLN","NZD","NOK","DKK","SEK","HUF","PHP","TJS","RSD"],"example":"RUB","description":"Currency of the invoice"},"external_id":{"type":"string","example":"h2gH123","description":"Client information must be unique"},"card_cvv":{"type":"string","example":"111","description":"Cvv of the credit card"},"succeed_url":{"type":"string","example":"https://smarts-gates.net/succeed","description":"The URL to which the payer will be redirected after successful payment of the invoice"},"failed_url":{"type":"string","example":"https://smarts-gates.net/failed","description":"The URL to which the payer will be redirected after an unsuccessful invoice payment"},"callback_url":{"type":"string","example":"https://smarts-gates.net/callback","description":"URL address to which the transaction status notification will be sent"},"recurrent_token":{"type":"string","example":"deeb5921-e284-4c61-ae0c-82acbb3f4efb","description":"Card token to pay for invoice"},"client_ip":{"type":"string","example":"192.168.0.1","description":"Ip address of the buyer"},"form_language":{"type":"string","enum":["ru","en","ua","es","it","de","pt","bg","pl","fr"],"example":"en","description":"Language of the form"},"project_url":{"type":"string","example":"https://smarts-gates.net","description":"Url of your project needed for some gates"},"additional_data":{"type":"object","example":{"account":"rep@test.com","email":"rep@test.com","first_name":"Jhon","last_name":"Smith","country_code":"USA","country_name":"England","city":"London","state":"Example state","zip":"625111","address":"Bank street, house 7","doc_number":"12345","doc_type":"CC","phone":"1111234567890","service_provider":"FREEMONEY","date_of_birth":"24-12-1986"},"description":"An optional parameter required to modify the stored token data. Existing token parameters will be overwritten by the submitted data."}},"required":["amount","gate_id","comment","currency_id","external_id","card_cvv","recurrent_token"]},"CreateInvoiceApmDto":{"type":"object","properties":{"amount":{"type":"number","example":2500,"description":"Amount of money for invoice"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Id of the gate used for transaction"},"comment":{"type":"string","example":"My first invoice","description":"Comment for invoice"},"currency_id":{"type":"string","enum":["USD","EGP","RUB","KZT","EUR","UAH","MXN","INR","TRY","UZS","AZN","MDL","VND","KRW","AED","IDR","PKR","PEN","CLP","MAD","BYN","COP","NGN","ZAR","SAR","XOF","CAD","AUD","GBP","PLN","NZD","NOK","DKK","SEK","HUF","PHP","TJS","RSD"],"example":"RUB","description":"Currency of the invoice"},"external_id":{"type":"string","example":"h2gH123","description":"Client information must be unique"},"succeed_url":{"type":"string","example":"https://smarts-gates.net/succeed","description":"The URL to which the payer will be redirected after successful payment of the invoice"},"failed_url":{"type":"string","example":"https://smarts-gates.net/failed","description":"The URL to which the payer will be redirected after an unsuccessful invoice payment"},"callback_url":{"type":"string","example":"https://smarts-gates.net/callback","description":"URL address to which the transaction status notification will be sent"},"client_ip":{"type":"string","example":"192.168.0.1","description":"Payer's ip address"},"account":{"type":"string","example":"rep@test.com","description":"User's account that is associated with the wallet(E-mail for example)"},"email":{"type":"string","example":"rep@test.com","description":"Payers's email"},"first_name":{"type":"string","example":"Jhon","description":"Payers's first name "},"last_name":{"type":"string","example":"Smith","description":"Payers's last name"},"country_code":{"type":"string","description":"Your customer’s billing country code in ISO 3166-1 alpha-3 format"},"country_name":{"type":"string","example":"England","description":"Your customer's country name"},"city":{"type":"string","example":"London","description":"Customer city of residence.Needed for some gates"},"state":{"type":"string","example":"Kurskaya oblast","description":"Customer state of residence.Needed for some gates"},"zip":{"type":"string","example":"625111","description":"Payers's postal zip"},"address":{"type":"string","example":"Bank street, house 7","description":"Customer address. Needed for some gates"},"doc_number":{"type":"string","example":"Bank street, house 7","description":"When making a payment in South Africa, you must additionally pass the user's identification document number in the doc_number parameter.\n     This can be a passport number (1 letter and 8 digits) or a user identification number (13 digits).\n     When performing a purchase in MXN currency you need to add doc_number parameter containing the customer's document number: CURP (contains 18 digits) for Mexico.\n     In COP currency you need to add doc_number parameter, only digits without spaces and punctuation.\n     Set this parameter to the number of the Citizenship Card (CC—Cédula de Ciudadanía) or to the Colombia Unique Taxpayer Number (NIT—Número de Identificación Tributaria)\n     "},"doc_type":{"type":"string","example":"CC","description":"Type of the document, needed for some  COP currency gates possible values: CC, NIT"},"phone":{"type":"string","example":"79090096666","description":"Payers's phone number with country code, '+' - is optional"},"service_provider":{"type":"string","example":"FREEMONEY","description":"Phone service provider FREEMONEY, EXPRESSO, ORANGE, MTN - for XOF currency, ETISALAT, ORANGE, VODAFONE, WEPAY - for the currency EGP "},"date_of_birth":{"type":"string","example":"1995-08-24","description":"Your customer’s date of birth (must be 18+ y.o.).In ISO 8601 format"},"code":{"type":"string","example":"1","description":"Payers's phone country code"},"card_cvv":{"type":"string","example":"111","description":"Cvv of the credit card"},"card_month":{"type":"string","example":"11","description":"Expiration month of the credit card"},"card_year":{"type":"string","example":"2042","description":"Expiration year of the credit card"},"card_number":{"type":"string","example":"1111222233334444","description":"Card number of the credit card"},"cardholder":{"type":"string","example":"JHON SMITH","description":"Cardholder of the credit card"},"form_language":{"type":"string","enum":["ru","en","ua","es","it","de","pt","bg","pl","fr"],"example":"en","description":"Language of the form"},"init_payment_token":{"type":"boolean","example":true,"description":"Possibility to create a payment token"},"project_url":{"type":"string","example":"https://smarts-gates.net","description":"Url of your project needed for some gates"}},"required":["amount","comment","currency_id","external_id"]},"GetWithdrawsDto":{"type":"object","properties":{"limit":{"type":"number","example":10,"description":"How many withdraw to show"},"updated_at_gte":{"type":"string","example":"2010-09-15T15:05:25.775Z","description":"Show the withdraw with timestamps greater or equal to argument"}}},"MerchantWithdraw":{"type":"object","properties":{"transaction_uid":{"type":"string","example":"268b2841-ca68-4b55-bf09-25641f1f304a","description":"Id of the withdraw"},"external_id":{"type":"string","example":"my_external_id_0001","description":"External id of the withdraw"},"amount":{"type":"string","example":"100","description":"Amount of money to withdraw"},"merchant_withdraw_fee":{"type":"string","example":"10","description":"Fee for  the withdraw"},"status":{"type":"string","example":"Created","description":"Current status of the withdraw"},"remark":{"type":"string","example":"Gate error","description":"Description of withdraw status "},"currency_id":{"type":"string","example":"RUB","description":"Currency of the withdraw"},"comment":{"type":"string","example":"My first withdraw","description":"the description of the withdraw"},"created_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the withdraw creation"},"updated_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the withdraw update"}},"required":["transaction_uid","external_id","amount","merchant_withdraw_fee","status","remark","currency_id","comment","created_at","updated_at"]},"GetWithdrawByExternalId":{"type":"object","properties":{"external_id":{"type":"string","example":"my_external_id_0001","description":"External id that you specified when creating the withdraw"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Gate id you specified when creating the withdraw"}},"required":["external_id"]},"CreateMassWithdrawDto":{"type":"object","properties":{"amount":{"type":"number","example":3,"description":"Amount of money to  withdraw"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Id of the gate used for transaction"},"comment":{"type":"string","example":"My first withdraw","description":"Comment for withdraw"},"external_id":{"type":"string","example":"h2gH123","description":"Client order number, must be unique for the merchant`"},"currency_id":{"type":"string","enum":["USD","EGP","RUB","KZT","EUR","UAH","MXN","INR","TRY","UZS","AZN","MDL","VND","KRW","AED","IDR","PKR","PEN","CLP","MAD","BYN","COP","NGN","ZAR","SAR","XOF","CAD","AUD","GBP","PLN","NZD","NOK","DKK","SEK","HUF","PHP","TJS","RSD"],"example":"EUR","description":"Currency of the withdraw"},"card_number":{"type":"string","example":"1233454564655655","description":"Number of the card to which money will be sended"},"card_holder":{"type":"string","example":"JHON SMITH","description":"Name and surname of the cardholder"},"card_year":{"type":"string","example":"2023","description":"Expiration year of the card"},"card_month":{"type":"string","example":"01","description":"Expiration month of the card"},"card_cvv":{"type":"string","example":"111","description":"Cvv code of the card"},"callback_url":{"type":"string","example":"https://smarts-gates.net/callback","description":"URL address to which the transaction status notification will be sent"},"withdraw_url":{"type":"string","example":"https://smarts-gates.net/callback","description":"URL for withdraw transaction(for some gates)"},"additional_params":{"type":"object","example":{"iban":"TR1234567891234567"}},"project_url":{"type":"string","example":"https://smarts-gates.net","description":"Url of your project needed for some gates"},"account":{"type":"string","example":"test","description":"Your account"},"client_ip":{"type":"string","example":"192.168.0.1","description":"Payer's ip address"}},"required":["amount","comment","external_id","currency_id","card_number"]},"CreateMassWithdrawResponseDto":{"type":"object","properties":{"transaction_uid":{"type":"string","example":"6f15174c-241a-41d9-91be-001454f9c13b","description":"Unique id of the withdraw"},"amount":{"type":"string","example":"3","description":"Amount of money to withdraw"},"status":{"type":"string","enum":["Created","Pending","Failed","Succeed"],"example":"Created","description":"Current status of the withdraw"},"currency_id":{"type":"string","example":"RUB","description":"Currency of the withdraw"},"comment":{"type":"string","example":"My first withdraw","description":"the description of the withdraw"},"external_id":{"type":"string","example":"h2gH123","description":"Client order number, must be unique for the merchant`"},"created_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the withdraw creation"}},"required":["transaction_uid","amount","status","currency_id","comment","external_id","created_at"]},"CreateWithdrawApmDto":{"type":"object","properties":{"amount":{"type":"number","example":3,"description":"Amount of money to  withdraw"},"gate_id":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Id of the gate used for transaction"},"client_ip":{"type":"string","example":"192.168.0.1","description":"Payer's ip address"},"comment":{"type":"string","example":"My first withdraw","description":"Comment for withdraw"},"external_id":{"type":"string","example":"h2gH123","description":"Client order number, must be unique for the merchant`"},"currency_id":{"type":"string","enum":["USD","EGP","RUB","KZT","EUR","UAH","MXN","INR","TRY","UZS","AZN","MDL","VND","KRW","AED","IDR","PKR","PEN","CLP","MAD","BYN","COP","NGN","ZAR","SAR","XOF","CAD","AUD","GBP","PLN","NZD","NOK","DKK","SEK","HUF","PHP","TJS","RSD"],"example":"EUR","description":"Currency of the withdraw"},"callback_url":{"type":"string","example":"https://smarts-gates.net/callback","description":"URL address to which the transaction status notification will be sent"},"bank_name":{"type":"string","example":"banco_continentals","description":"Name of the bank"},"bank_id":{"type":"string","example":"1861","description":"Bank identifier. Please contact us to get available codes"},"account_number":{"type":"string","example":"0011012302006125433","description":"Account ID"},"account":{"type":"string","example":"test","description":"Your account"},"first_name":{"type":"string","example":"Agustínus","description":"Receiver name"},"last_name":{"type":"string","example":"Garcías","description":"Receiver last_name"},"middle_name":{"type":"string","example":"Ivanovic","description":"Receiver middle_name"},"email":{"type":"string","example":"garcia@gmail.com","description":"Receiver email"},"phone":{"type":"string","example":"1111234567890","description":"Payers's phone number with country code and without '+'"},"service_provider":{"type":"string","example":"FREEMONEY","description":"Phone service provider needed for EGP and XOF currency.  ETISALAT, ORANGE, VODAFONE, WEPAY - for the currency EGP. FREEMONEY, EXPRESSO, ORANGE, MTN - for XOF currency  "},"doc_number":{"type":"string","example":"123456789","description":"When making a payment in South Africa(ZAR currency), you must additionally pass the user's identification document number in the doc_number parameter.\n     This can be a passport number (1 letter and 8 digits) or a user identification number (13 digits).When performing a purchase in MXN currency you need to add doc_number parameter containing the customer's document number: CURP (contains 18 digits) for Mexico.When performing in COP currency set this parameter to the number of the Citizenship Card (CC—Cédula de Ciudadanía) or to the Colombia Unique Taxpayer Number (NIT—Número de Identificación Tributaria)"},"card_number":{"type":"string","example":"1111222233334444","description":"Card number of the credit card"},"country":{"type":"string","example":"EN","description":"Country code in ISO 3166-1 alpha-2 format"},"date_of_birth":{"type":"string","example":"24-12-1986","description":"Your customer’s date of birth (must be 18+ y.o.).In ISO 8601 format"},"city":{"type":"string","example":"London","description":"Customer city of residence.Needed for some gates"},"address":{"type":"string","example":"Bank street, house 7","description":"Customer address. Needed for some gates"},"country_code":{"type":"string","description":"Your customer’s billing country code. May be 2 or 3 letters for different gates"}},"required":["amount","comment","external_id","currency_id","card_number","country"]},"DeleteTokenDto":{"type":"object","properties":{"token":{"type":"string","example":"0a0d3a63-aa66-4249-a6fa-895aa219e9ee","description":"Token id"}},"required":["token"]},"GetTokensDto":{"type":"object","properties":{"limit":{"type":"number","example":10,"description":"How many tokens to show"},"updated_at_gte":{"type":"string","example":"2010-09-15T15:05:25.775Z","description":"Show the tokens with timestamps greater or equal to argument"}}},"RecurrentToken":{"type":"object","properties":{"request_uid":{"type":"string","example":"268b2841-ca68-4b55-bf09-25641f1f304a","description":"Id of the request"},"token":{"type":"string","example":"343f42f8-aa66-4249-a6fa-895aa219e9ee","description":"Payment token id"},"sanitized_mask":{"type":"string","example":"220220******5664","description":"Sanitized mask of the card"},"status":{"type":"string","example":"Created","description":"Current status of the invoice"},"currency_id":{"type":"string","example":"RUB","description":"Currency of the invoice"},"created_at":{"type":"string","example":"2022-09-15T07:26:13.893Z","description":"Time stamp of the invoice creation"}},"required":["request_uid","token","sanitized_mask","status","currency_id","created_at"]}}}}