{"swagger":"2.0","basePath":"\/","info":{"title":"Console API","version":"DYNAMIC","description":"Manage your exports"},"paths":{"\/api\/export-files\/{id}":{"get":{"summary":"Download the export file","description":"ExportFile description","parameters":[{"name":"id","in":"path","required":true,"type":"integer","description":"Export file ID"},{"name":"hash","in":"query","required":true,"type":"string","description":"Export file secured hash"}],"responses":{"200":{"description":"Get the export zip file","schema":{"type":"file"}}},"produces":["application\/zip"],"tags":["ExportFile"],"operationId":"getExportFileItem"}},"\/api\/export-files\/{id}\/email":{"get":{"summary":"Send by email the export file","parameters":[{"name":"id","in":"path","required":true,"type":"integer","description":"Export file ID"},{"name":"hash","in":"query","required":true,"type":"string","description":"Export file secured hash"}],"responses":{"200":{"description":"The file has been send again by email"}},"produces":["application\/json"],"tags":["ExportFile"],"operationId":"get_by_emailExportFileItem"}},"\/api\/export-files\/{id}\/regenerate":{"get":{"summary":"Generate file again in the same conditions it has been generated the first times","parameters":[{"name":"id","in":"path","required":true,"type":"integer","description":"Export file ID"},{"name":"hash","in":"query","required":true,"type":"string","description":"Export file secured hash"},{"name":"send_by_email","in":"query","required":false,"type":"boolean","description":"Should send (or not) export file by email"}],"responses":{"200":{"description":"The file has been send again by email","schema":{"type":"object","description":"response","properties":{"fileId":{"type":"integer","description":"File id","example":123455},"dateCreated":{"type":"string","format":"date-time","description":"The date the file was created"},"filename":{"type":"string","description":"Name of the file","example":"ALL_ACCOUNTS_12345"},"hash":{"type":"string","description":"Hash of the file","example":"74162c7a52b2e0af0be04aa4216246217df386017fbb20e76588d8fc892c91ea0e490b99084486f93cc4b2c771fcf6e12afc9eece7412271de59aea65742099"},"status":{"type":"string","description":"Status of the file","example":"created"},"nbItems":{"type":"integer","description":"The number of lines in the file","example":123}}}}},"produces":["application\/json"],"tags":["ExportFile"],"operationId":"regenerate_export_fileExportFileItem"}},"\/api\/exports":{"get":{"parameters":[{"name":"module","in":"query","required":true,"type":"string","description":"Module","enum":["transaction","financial_report","account"]},{"name":"dateCreated","in":"query","type":"date","description":"Date de cr\u00e9ation de l'export"},{"name":"status","in":"query","type":"string","enum":["active","inactive","expired"],"description":"Status de l'export"},{"name":"filePrefix","description":"Nom de l'export","type":"string","pattern":"^([\\w]|[\u00e0-\u00fa]|[\u00c0-\u00da]|[-_\\[\\]]){1,30}$"},{"name":"recurrence","type":"string","enum":["once","daily","weekly","monthly","monthly_day","annually","settlement"],"description":"Export recurrence"},{"name":"receiveByEmail","in":"query","type":"boolean","description":"If true, you will receive your export by email"},{"name":"config","type":"json","description":"Json object to configure export
Module transaction: To export payment operations set granularity = operation","example":"{granularity: operation} | {granularity: transaction}"},{"name":"withExportFiles","in":"query","type":"boolean","description":"Includes or not list of export files in response, true by default"}],"produces":["application\/json"],"tags":["Export"],"operationId":"getExportCollection","summary":"Retrieves the collection of Export resources.","responses":{"200":{"description":"Export collection response","schema":{"type":"array","items":{"$ref":"#\/definitions\/Export-export"}}}}},"post":{"summary":"Creates a new export","produces":["application\/json"],"consumes":["application\/json"],"tags":["Export"],"operationId":"postExportCollection","parameters":[{"name":"export","in":"body","description":"The new Export resource","schema":{"$ref":"#\/definitions\/Export-export_denormalization"}}],"responses":{"201":{"description":"Export resource created","schema":{"$ref":"#\/definitions\/Export-export"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/api\/exports\/trending-balance":{"get":{"tags":["Export"],"operationId":"get_trending_balanceExportCollection","produces":["application\/json","text\/html","application\/zip","application\/pdf"],"summary":"Retrieves the collection of Export resources.","responses":{"200":{"description":"Export collection response","schema":{"type":"array","items":{"$ref":"#\/definitions\/Export-export_trending_balance"}}}}}},"\/api\/exports\/{exportId}\/files":{"get":{"parameters":[{"name":"exportId","in":"path","required":true,"type":"integer","description":"Export ID"},{"name":"dateCreated","in":"query","type":"date","description":"Date de creation du fichier"},{"name":"status","in":"query","type":"string","enum":["created","stocked","sent","expired","send_error","generate_error"],"description":"Status de l'export"},{"name":"filename","in":"query","type":"string","description":"Nom du fichier"},{"name":"dateRegenerated","in":"query","type":"date","description":"Date de regeneration du fichier"}],"description":"Files list","produces":["application\/json"],"tags":["ExportFile"],"operationId":"getExportFileCollection","summary":"Retrieves the collection of ExportFile resources.","responses":{"200":{"description":"ExportFile collection response","schema":{"type":"array","items":{"$ref":"#\/definitions\/ExportFile-file"}}}}},"post":{"tags":["ExportFile"],"operationId":"postExportFileCollection","consumes":["application\/json","text\/html","application\/zip","application\/pdf"],"produces":["application\/json","text\/html","application\/zip","application\/pdf"],"summary":"Creates a ExportFile resource.","parameters":[{"name":"exportFile","in":"body","description":"The new ExportFile resource","schema":{"$ref":"#\/definitions\/ExportFile"}}],"responses":{"201":{"description":"ExportFile resource created","schema":{"$ref":"#\/definitions\/ExportFile-file"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/api\/exports\/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"type":"integer","description":"Export ID"},{"name":"withExportFiles","in":"query","type":"boolean","description":"Includes or not list of export files in response, true by default"}],"produces":["application\/json"],"tags":["Export"],"operationId":"getExportItem","summary":"Retrieves a Export resource.","responses":{"200":{"description":"Export resource response","schema":{"$ref":"#\/definitions\/Export-export"}},"404":{"description":"Resource not found"}}},"delete":{"parameters":[{"name":"id","in":"path","required":true,"type":"integer","description":"Export ID to delete"}],"produces":["application\/json"],"tags":["Export"],"operationId":"deleteExportItem","summary":"Removes the Export resource.","responses":{"204":{"description":"Export resource deleted"},"404":{"description":"Resource not found"}}},"put":{"parameters":[{"name":"id","in":"path","required":true,"type":"integer","description":"Export ID to edit"},{"name":"export","in":"body","required":true,"description":"The Export resource","schema":{"$ref":"#\/definitions\/Export-export"}}],"produces":["application\/json"],"consumes":["application\/json"],"tags":["Export"],"operationId":"putExportItem","summary":"Replaces the Export resource.","responses":{"200":{"description":"Export resource updated","schema":{"$ref":"#\/definitions\/Export-export"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/api\/login":{"post":{"summary":"Generates token to authenticate user","parameters":[{"name":"body","in":"body","type":"object","description":"JSON with your username and password","schema":{"$ref":"#\/definitions\/Login"}}],"responses":{"200":{"description":"JWT token generated","schema":{"$ref":"#\/definitions\/LoginResponse"}}},"produces":["application\/json"],"consumes":["application\/json"],"tags":["Login"],"operationId":"api_login_checkLoginCollection"}}},"securityDefinitions":{"apiKey":{"type":"apiKey","in":"header","description":"Value for the X-Authorization header.
See \/login<\/b> endpoint to generate an Access token.
Example: \"Bearer ACCESS_TOKEN\"","name":"X-Authorization"}},"security":[{"apiKey":[]}],"definitions":{"Export-export":{"type":"object","description":"Class Export","properties":{"exportId":{"type":"integer","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"dateUpdated":{"type":"string","format":"date-time"},"exportFiles":{"readOnly":true,"description":"List of generated files","type":"array","items":{"$ref":"#\/definitions\/ExportFile-export"}},"filePrefix":{"type":"string","minLength":1,"maxLength":30,"pattern":"^([\\w]|[\u00e0-\u00fa]|[\u00c0-\u00da]|[-_\\[\\]]){1,30}$","example":"ALL_ACCOUNTS","description":"Prefix of the generated file. It will be completed with the export date"},"emails":{"type":"string","description":"Filled with your email when \"receiveByEmail\" field is set to true","readOnly":true},"module":{"type":"string","enum":["transaction","financial_report","account"]},"status":{"type":"string","enum":["active","inactive","expired"]},"columns":{"type":"json","example":"{\"merchant_order_id\":\"Order ID\"}","description":"Columns in the header of your CSV export.","Available columns for":{"transaction":["account_name","acquirer_chargeback_date","acquirer_connection_id","acquirer_trxid","acquirer_return_code","acquirer_return_message","amount","auth","auth_method","author","authorized_by_payment_means_date","balance","basket_item_count","billing_country","billing_postcode","billing_street","business_name","captured_amount","captured_date","card_category","card_country","card_token","card_type","card_type","chargeback_amount","chargeback_refund_amount","cms_name","collected_date","created_date","custom_data","customer_account_number","customer_device","customer_email","customer_name","customer_operating_system","delivery_country","delivery_city","delivery_postcode","delivery_street","device_id","dispute_reason","dsp2_status","eci","eci_out","external_reference","fraud_reported_by_acquirer","fraud_reported_by_acquirer_date","financial_institution","iban_creditor","iban_debitor","ip_address","ip_country","is_acquirer_tra_activated","issuer_financial_institution_country","issuer_name","merchant_order_id","mid","mix_payment","one_click","operation_amount","operation_date","operation_id","operation_merchant_id","operation_status","operation_type","order_currency","order_date","payment_means","payment_method","payment_operation_mode","phone_number","provider_return_code","provider_return_message","recurring_payment","refund_method","refunded_amount","refund_reasons","remittance_reference","retraction_delay","route_reference","sca_preference","sca_source","sentinel_result","sentinel_review_result","sentinel_reviewer","sentinel_score","settled_date","shipping_country","shipping_city","shipping_postcode","shipping_street","status","store_name","three_ds_v2_attempt","tpe_reference","trxid"],"financial_report":["account_id","account_name","acquirer_registration_id","transaction_id","authorization_date","business_name","capture_date","settlement_id","settlement_date","payment_means","payment_method","invoice_number","invoice_status","transaction_currency","financial_operation_currency","financial_operation_description","amount_incl_tax","amount_excl_tax","amount_tax","reserve_release_date","reserve_released","interchange_amount","schemefee_amount","financial_operation_date","financial_operation_mode","acquirer_name","financial_operation_type","custom_data"]}},"filters":{"type":"json","description":"Filters applied to your export, should be a valid json
\n Available filters:\n module : transaction<\/h2>\n \n - payment_means: visa, mastercard...<\/li>\n
- account<\/li>\n
- account_name<\/li>\n
- amount<\/li>\n
- acquirer_chargeback_date<\/li>\n
- acquirer_connection_id<\/li>\n
- acquirer_trxid<\/li>\n
- acquirer_return_code<\/li>\n
- acquirer_return_message<\/li>\n
- auth<\/li>\n
- auth_method<\/li>\n
- auth_date<\/li>\n
- author<\/li>\n
- authentication_indicator<\/li>\n
- authorization_code<\/li>\n
- balance<\/li>\n
- basket_amount<\/li>\n
- basket_item_count<\/li>\n
- basket_item_quantity<\/li>\n
- billing_country<\/li>\n
- billing_postcode<\/li>\n
- billing_street<\/li>\n
- business_id<\/li>\n
- business_name<\/li>\n
- cancel_reason<\/li>\n
- captured_amount<\/li>\n
- captured_date<\/li>\n
- card_category<\/li>\n
- card_country<\/li>\n
- card_token<\/li>\n
- card_type<\/li>\n
- chargedback_amount<\/li>\n
- chargeback_refund_amount<\/li>\n
- customer_company_name<\/li>\n
- cms_name<\/li>\n
- columns<\/li>\n
- customer_account_number<\/li>\n
- customer_birthdate<\/li>\n
- customer_city<\/li>\n
- customer_country<\/li>\n
- customer_device<\/li>\n
- customer_email<\/li>\n
- customer_gender<\/li>\n
- customer_id<\/li>\n
- customer_language<\/li>\n
- customer_mandate_id<\/li>\n
- customer_name<\/li>\n
- customer_operating_system<\/li>\n
- customer_type<\/li>\n
- cvc_result<\/li>\n
- dsp2_status<\/li>\n
- from<\/li>\n
- to<\/li>\n
- debit_agreement_id<\/li>\n
- device_id<\/li>\n
- device_fingerprint<\/li>\n
- eci<\/li>\n
- eci_out<\/li>\n
- external_reference<\/li>\n
- fraud_reported_by_acquirer<\/li>\n
- fraud_reported_by_acquirer_date<\/li>\n
- interval<\/li>\n
- ip_address<\/li>\n
- ip_country<\/li>\n
- is_acquirer_tra_activated<\/li>\n
- issuer_financial_institution_country<\/li>\n
- issuer_name<\/li>\n
- financial_institution<\/li>\n
- master_transaction_id<\/li>\n
- merchant_order_id<\/li>\n
- mix_payment<\/li>\n
- one_click<\/li>\n
- order_currency<\/li>\n
- order_date<\/li>\n
- order_id<\/li>\n
- order_amount<\/li>\n
- payment_means<\/li>\n
- payment_method<\/li>\n
- phone_number<\/li>\n
- provider_return_code<\/li>\n
- provider_return_message<\/li>\n
- recurring_payment<\/li>\n
- refund_method<\/li>\n
- refunded_amount<\/li>\n
- refunded_date<\/li>\n
- route_reference<\/li>\n
- sca_preference<\/li>\n
- sca_source<\/li>\n
- sdd_display_page<\/li>\n
- sentinel_profile<\/li>\n
- sentinel_result<\/li>\n
- sentinel_review_result<\/li>\n
- sentinel_review_date<\/li>\n
- sentinel_reviewer<\/li>\n
- sentinel_rule<\/li>\n
- sentinel_rule_family<\/li>\n
- sentinel_score<\/li>\n
- session_id<\/li>\n
- shipping_country<\/li>\n
- shipping_city<\/li>\n
- shipping_postcode<\/li>\n
- shipping_street<\/li>\n
- status<\/li>\n
- status_period<\/li>\n
- store_name<\/li>\n
- search_type<\/li>\n
- tpe_reference<\/li>\n
- trxid<\/li>\n
- user_agent<\/li>\n
- website<\/li>\n
- qsearch<\/li>\n
- authorized_by_payment_means_date<\/li>\n
- blocked_date<\/li>\n
- captured_date<\/li>\n
- chargeback_date<\/li>\n
- collected_date<\/li>\n
- created_date<\/li>\n
- retraction_delay<\/li>\n
- settled_date<\/li>\n
- to_be_reviewed_date<\/li>\n
- operation_amount<\/li>\n
- payment_operation_mode<\/li>\n
- iban_creditor<\/li>\n
- iban_debitor<\/li>\n
- operation_id<\/li>\n
- operation_date<\/li>\n
- operation_merchant_id<\/li>\n
- operation_status<\/li>\n
- operation_type<\/li>\n
- remittance_reference<\/li>\n
- delivery_company<\/li>\n
- delivery_method<\/li>\n
- delivery_number<\/li>\n
- delivery_time<\/li>\n
- discount<\/li>\n
- item_category<\/li>\n
- item_name<\/li>\n
- item_quantity<\/li>\n
- item_reference<\/li>\n
- item_type<\/li>\n
- tax_rate<\/li>\n
- three_ds_v2_attempt<\/li>\n
- unit_price<\/li>\n <\/ul>\n
module : financial_report<\/h2>\n \n - account_id<\/li>\n
- acquirer_registration_id<\/li>\n
- acquirer_name<\/li>\n
- amount_excl_tax<\/li>\n
- amount_incl_tax<\/li>\n
- authorization_date<\/li>\n
- capture_date<\/li>\n
- custom_data<\/li>\n
- financial_operation_date<\/li>\n
- financial_operation_description<\/li>\n
- financial_operation_type<\/li>\n
- interchange_amount<\/li>\n
- invoice_number<\/li>\n
- invoice_status<\/li>\n
- financial_operation_currency<\/li>\n
- transaction_currency<\/li>\n
- payment_means<\/li>\n
- payment_method<\/li>\n
- financial_operation_mode<\/li>\n
- reserve_release_date<\/li>\n
- schemefee_amount<\/li>\n
- settlement_date<\/li>\n
- settlement_id<\/li>\n
- amount_tax<\/li>\n
- transaction_id<\/li>\n
- reserve_released<\/li>\n <\/ul>\n Available date interval:\n
\n - pd: Past day<\/li>\n
- cw: Current week<\/li>\n
- pw: Past week<\/li>\n
- cm: Current month<\/li>\n
- pm: Past month<\/li>\n
- cq: Current quarter<\/li>\n
- pq: Past quarter<\/li>\n
- cy: Current year<\/li>\n
- yy: Last twelve months<\/li>\n
- custom: Custom<\/li>\n <\/ul>\n Example date field:\n
\n - Predefined date interval : \"{\"created_date_interval\":\"pd\"}\"<\/li>\n
- Custom date interval : \"{\"authorized_by_payment_means_date_interval\":\"custom\",\"authorized_by_payment_means_date_from\":\"2019-01-01\",\"authorized_by_payment_means_date_to\":\"2019-06-15\"}\"<\/li>\n <\/ul>\n ","example":"{\"payment_means\":\"visa--mastercard\",\"order_by\":\"created_date\",\"direction\":\"desc\",\"created_date_interval\":\"pd\",\"authorized_by_payment_means_date_interval\":\"custom\",\"authorized_by_payment_means_date_from\":\"2019-01-01\",\"authorized_by_payment_means_date_to\":\"2019-06-15\"}"},"urlFilters":{"type":"string","readOnly":true},"separator":{"type":"string","enum":["semicolon","comma"],"description":"CSV separator"},"recurrence":{"type":"string","enum":["once","daily","weekly","monthly","monthly_day","annually","settlement"],"description":"Export recurrence"},"recurrenceDay":{"type":"string","enum":["1","2","3","4","5","6","7","first_day","last_day"],"description":"Day number of week or month (for 'first_day' and 'last_day') when export should be generated"},"nbOccurrence":{"type":"integer","description":"Number of time the export should be generated"},"endRecurrenceDay":{"type":"datetime","description":"A dummy date","format":"date-time"},"receiveByEmail":{"type":"boolean","description":"If true, you will receive your export by email"},"user":{"type":"string"},"userId":{"readOnly":true,"type":"integer"},"config":{"type":"json","description":"Json object to configure export
\n Module transaction: To export payment operations set granularity = operation\n ","example":"{granularity: operation} | {granularity: transaction}"},"error":{"type":"json","description":"Error specification"}}},"Export-export_denormalization":{"type":"object","description":"Class Export","properties":{"exportId":{"type":"integer","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"dateUpdated":{"type":"string","format":"date-time"},"exportFiles":{"readOnly":true,"description":"List of generated files","type":"array","items":{"$ref":"#\/definitions\/ExportFile-export_denormalization"}},"filePrefix":{"type":"string","minLength":1,"maxLength":30,"pattern":"^([\\w]|[\u00e0-\u00fa]|[\u00c0-\u00da]|[-_\\[\\]]){1,30}$","example":"ALL_ACCOUNTS","description":"Prefix of the generated file. It will be completed with the export date"},"emails":{"type":"string","description":"Filled with your email when \"receiveByEmail\" field is set to true","readOnly":true},"module":{"type":"string","enum":["transaction","financial_report","account"]},"status":{"type":"string","enum":["active","inactive","expired"]},"columns":{"type":"json","example":"{\"merchant_order_id\":\"Order ID\"}","description":"Columns in the header of your CSV export.","Available columns for":{"transaction":["account_name","acquirer_chargeback_date","acquirer_connection_id","acquirer_trxid","acquirer_return_code","acquirer_return_message","amount","auth","auth_method","author","authorized_by_payment_means_date","balance","basket_item_count","billing_country","billing_postcode","billing_street","business_name","captured_amount","captured_date","card_category","card_country","card_token","card_type","card_type","chargeback_amount","chargeback_refund_amount","cms_name","collected_date","created_date","custom_data","customer_account_number","customer_device","customer_email","customer_name","customer_operating_system","delivery_country","delivery_city","delivery_postcode","delivery_street","device_id","dispute_reason","dsp2_status","eci","eci_out","external_reference","fraud_reported_by_acquirer","fraud_reported_by_acquirer_date","financial_institution","iban_creditor","iban_debitor","ip_address","ip_country","is_acquirer_tra_activated","issuer_financial_institution_country","issuer_name","merchant_order_id","mid","mix_payment","one_click","operation_amount","operation_date","operation_id","operation_merchant_id","operation_status","operation_type","order_currency","order_date","payment_means","payment_method","payment_operation_mode","phone_number","provider_return_code","provider_return_message","recurring_payment","refund_method","refunded_amount","refund_reasons","remittance_reference","retraction_delay","route_reference","sca_preference","sca_source","sentinel_result","sentinel_review_result","sentinel_reviewer","sentinel_score","settled_date","shipping_country","shipping_city","shipping_postcode","shipping_street","status","store_name","three_ds_v2_attempt","tpe_reference","trxid"],"financial_report":["account_id","account_name","acquirer_registration_id","transaction_id","authorization_date","business_name","capture_date","settlement_id","settlement_date","payment_means","payment_method","invoice_number","invoice_status","transaction_currency","financial_operation_currency","financial_operation_description","amount_incl_tax","amount_excl_tax","amount_tax","reserve_release_date","reserve_released","interchange_amount","schemefee_amount","financial_operation_date","financial_operation_mode","acquirer_name","financial_operation_type","custom_data"]}},"filters":{"type":"json","description":"Filters applied to your export, should be a valid json
\n Available filters:\n module : transaction<\/h2>\n \n - payment_means: visa, mastercard...<\/li>\n
- account<\/li>\n
- account_name<\/li>\n
- amount<\/li>\n
- acquirer_chargeback_date<\/li>\n
- acquirer_connection_id<\/li>\n
- acquirer_trxid<\/li>\n
- acquirer_return_code<\/li>\n
- acquirer_return_message<\/li>\n
- auth<\/li>\n
- auth_method<\/li>\n
- auth_date<\/li>\n
- author<\/li>\n
- authentication_indicator<\/li>\n
- authorization_code<\/li>\n
- balance<\/li>\n
- basket_amount<\/li>\n
- basket_item_count<\/li>\n
- basket_item_quantity<\/li>\n
- billing_country<\/li>\n
- billing_postcode<\/li>\n
- billing_street<\/li>\n
- business_id<\/li>\n
- business_name<\/li>\n
- cancel_reason<\/li>\n
- captured_amount<\/li>\n
- captured_date<\/li>\n
- card_category<\/li>\n
- card_country<\/li>\n
- card_token<\/li>\n
- card_type<\/li>\n
- chargedback_amount<\/li>\n
- chargeback_refund_amount<\/li>\n
- customer_company_name<\/li>\n
- cms_name<\/li>\n
- columns<\/li>\n
- customer_account_number<\/li>\n
- customer_birthdate<\/li>\n
- customer_city<\/li>\n
- customer_country<\/li>\n
- customer_device<\/li>\n
- customer_email<\/li>\n
- customer_gender<\/li>\n
- customer_id<\/li>\n
- customer_language<\/li>\n
- customer_mandate_id<\/li>\n
- customer_name<\/li>\n
- customer_operating_system<\/li>\n
- customer_type<\/li>\n
- cvc_result<\/li>\n
- dsp2_status<\/li>\n
- from<\/li>\n
- to<\/li>\n
- debit_agreement_id<\/li>\n
- device_id<\/li>\n
- device_fingerprint<\/li>\n
- eci<\/li>\n
- eci_out<\/li>\n
- external_reference<\/li>\n
- fraud_reported_by_acquirer<\/li>\n
- fraud_reported_by_acquirer_date<\/li>\n
- interval<\/li>\n
- ip_address<\/li>\n
- ip_country<\/li>\n
- is_acquirer_tra_activated<\/li>\n
- issuer_financial_institution_country<\/li>\n
- issuer_name<\/li>\n
- financial_institution<\/li>\n
- master_transaction_id<\/li>\n
- merchant_order_id<\/li>\n
- mix_payment<\/li>\n
- one_click<\/li>\n
- order_currency<\/li>\n
- order_date<\/li>\n
- order_id<\/li>\n
- order_amount<\/li>\n
- payment_means<\/li>\n
- payment_method<\/li>\n
- phone_number<\/li>\n
- provider_return_code<\/li>\n
- provider_return_message<\/li>\n
- recurring_payment<\/li>\n
- refund_method<\/li>\n
- refunded_amount<\/li>\n
- refunded_date<\/li>\n
- route_reference<\/li>\n
- sca_preference<\/li>\n
- sca_source<\/li>\n
- sdd_display_page<\/li>\n
- sentinel_profile<\/li>\n
- sentinel_result<\/li>\n
- sentinel_review_result<\/li>\n
- sentinel_review_date<\/li>\n
- sentinel_reviewer<\/li>\n
- sentinel_rule<\/li>\n
- sentinel_rule_family<\/li>\n
- sentinel_score<\/li>\n
- session_id<\/li>\n
- shipping_country<\/li>\n
- shipping_city<\/li>\n
- shipping_postcode<\/li>\n
- shipping_street<\/li>\n
- status<\/li>\n
- status_period<\/li>\n
- store_name<\/li>\n
- search_type<\/li>\n
- tpe_reference<\/li>\n
- trxid<\/li>\n
- user_agent<\/li>\n
- website<\/li>\n
- qsearch<\/li>\n
- authorized_by_payment_means_date<\/li>\n
- blocked_date<\/li>\n
- captured_date<\/li>\n
- chargeback_date<\/li>\n
- collected_date<\/li>\n
- created_date<\/li>\n
- retraction_delay<\/li>\n
- settled_date<\/li>\n
- to_be_reviewed_date<\/li>\n
- operation_amount<\/li>\n
- payment_operation_mode<\/li>\n
- iban_creditor<\/li>\n
- iban_debitor<\/li>\n
- operation_id<\/li>\n
- operation_date<\/li>\n
- operation_merchant_id<\/li>\n
- operation_status<\/li>\n
- operation_type<\/li>\n
- remittance_reference<\/li>\n
- delivery_company<\/li>\n
- delivery_method<\/li>\n
- delivery_number<\/li>\n
- delivery_time<\/li>\n
- discount<\/li>\n
- item_category<\/li>\n
- item_name<\/li>\n
- item_quantity<\/li>\n
- item_reference<\/li>\n
- item_type<\/li>\n
- tax_rate<\/li>\n
- three_ds_v2_attempt<\/li>\n
- unit_price<\/li>\n <\/ul>\n
module : financial_report<\/h2>\n \n - account_id<\/li>\n
- acquirer_registration_id<\/li>\n
- acquirer_name<\/li>\n
- amount_excl_tax<\/li>\n
- amount_incl_tax<\/li>\n
- authorization_date<\/li>\n
- capture_date<\/li>\n
- custom_data<\/li>\n
- financial_operation_date<\/li>\n
- financial_operation_description<\/li>\n
- financial_operation_type<\/li>\n
- interchange_amount<\/li>\n
- invoice_number<\/li>\n
- invoice_status<\/li>\n
- financial_operation_currency<\/li>\n
- transaction_currency<\/li>\n
- payment_means<\/li>\n
- payment_method<\/li>\n
- financial_operation_mode<\/li>\n
- reserve_release_date<\/li>\n
- schemefee_amount<\/li>\n
- settlement_date<\/li>\n
- settlement_id<\/li>\n
- amount_tax<\/li>\n
- transaction_id<\/li>\n
- reserve_released<\/li>\n <\/ul>\n Available date interval:\n
\n - pd: Past day<\/li>\n
- cw: Current week<\/li>\n
- pw: Past week<\/li>\n
- cm: Current month<\/li>\n
- pm: Past month<\/li>\n
- cq: Current quarter<\/li>\n
- pq: Past quarter<\/li>\n
- cy: Current year<\/li>\n
- yy: Last twelve months<\/li>\n
- custom: Custom<\/li>\n <\/ul>\n Example date field:\n
\n - Predefined date interval : \"{\"created_date_interval\":\"pd\"}\"<\/li>\n
- Custom date interval : \"{\"authorized_by_payment_means_date_interval\":\"custom\",\"authorized_by_payment_means_date_from\":\"2019-01-01\",\"authorized_by_payment_means_date_to\":\"2019-06-15\"}\"<\/li>\n <\/ul>\n ","example":"{\"payment_means\":\"visa--mastercard\",\"order_by\":\"created_date\",\"direction\":\"desc\",\"created_date_interval\":\"pd\",\"authorized_by_payment_means_date_interval\":\"custom\",\"authorized_by_payment_means_date_from\":\"2019-01-01\",\"authorized_by_payment_means_date_to\":\"2019-06-15\"}"},"urlFilters":{"type":"string","readOnly":true},"separator":{"type":"string","enum":["semicolon","comma"],"description":"CSV separator"},"recurrence":{"type":"string","enum":["once","daily","weekly","monthly","monthly_day","annually","settlement"],"description":"Export recurrence"},"recurrenceDay":{"type":"string","enum":["1","2","3","4","5","6","7","first_day","last_day"],"description":"Day number of week or month (for 'first_day' and 'last_day') when export should be generated"},"nbOccurrence":{"type":"integer","description":"Number of time the export should be generated"},"endRecurrenceDay":{"type":"datetime","description":"A dummy date","format":"date-time"},"receiveByEmail":{"type":"boolean","description":"If true, you will receive your export by email"},"user":{"type":"string"},"userId":{"readOnly":true,"type":"integer"},"totalHits":{"type":"integer"},"config":{"type":"json","description":"Json object to configure export
\n Module transaction: To export payment operations set granularity = operation\n ","example":"{granularity: operation} | {granularity: transaction}"},"withExportFiles":{"type":"string"},"error":{"type":"json","description":"Error specification"}}},"Export-export_trending_balance":{"type":"object","description":"Class Export","properties":{"exportId":{"type":"integer","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"emails":{"type":"string","description":"Filled with your email when \"receiveByEmail\" field is set to true","readOnly":true},"filters":{"type":"json","description":"Filters applied to your export, should be a valid json
\n Available filters:\n module : transaction<\/h2>\n \n - payment_means: visa, mastercard...<\/li>\n
- account<\/li>\n
- account_name<\/li>\n
- amount<\/li>\n
- acquirer_chargeback_date<\/li>\n
- acquirer_connection_id<\/li>\n
- acquirer_trxid<\/li>\n
- acquirer_return_code<\/li>\n
- acquirer_return_message<\/li>\n
- auth<\/li>\n
- auth_method<\/li>\n
- auth_date<\/li>\n
- author<\/li>\n
- authentication_indicator<\/li>\n
- authorization_code<\/li>\n
- balance<\/li>\n
- basket_amount<\/li>\n
- basket_item_count<\/li>\n
- basket_item_quantity<\/li>\n
- billing_country<\/li>\n
- billing_postcode<\/li>\n
- billing_street<\/li>\n
- business_id<\/li>\n
- business_name<\/li>\n
- cancel_reason<\/li>\n
- captured_amount<\/li>\n
- captured_date<\/li>\n
- card_category<\/li>\n
- card_country<\/li>\n
- card_token<\/li>\n
- card_type<\/li>\n
- chargedback_amount<\/li>\n
- chargeback_refund_amount<\/li>\n
- customer_company_name<\/li>\n
- cms_name<\/li>\n
- columns<\/li>\n
- customer_account_number<\/li>\n
- customer_birthdate<\/li>\n
- customer_city<\/li>\n
- customer_country<\/li>\n
- customer_device<\/li>\n
- customer_email<\/li>\n
- customer_gender<\/li>\n
- customer_id<\/li>\n
- customer_language<\/li>\n
- customer_mandate_id<\/li>\n
- customer_name<\/li>\n
- customer_operating_system<\/li>\n
- customer_type<\/li>\n
- cvc_result<\/li>\n
- dsp2_status<\/li>\n
- from<\/li>\n
- to<\/li>\n
- debit_agreement_id<\/li>\n
- device_id<\/li>\n
- device_fingerprint<\/li>\n
- eci<\/li>\n
- eci_out<\/li>\n
- external_reference<\/li>\n
- fraud_reported_by_acquirer<\/li>\n
- fraud_reported_by_acquirer_date<\/li>\n
- interval<\/li>\n
- ip_address<\/li>\n
- ip_country<\/li>\n
- is_acquirer_tra_activated<\/li>\n
- issuer_financial_institution_country<\/li>\n
- issuer_name<\/li>\n
- financial_institution<\/li>\n
- master_transaction_id<\/li>\n
- merchant_order_id<\/li>\n
- mix_payment<\/li>\n
- one_click<\/li>\n
- order_currency<\/li>\n
- order_date<\/li>\n
- order_id<\/li>\n
- order_amount<\/li>\n
- payment_means<\/li>\n
- payment_method<\/li>\n
- phone_number<\/li>\n
- provider_return_code<\/li>\n
- provider_return_message<\/li>\n
- recurring_payment<\/li>\n
- refund_method<\/li>\n
- refunded_amount<\/li>\n
- refunded_date<\/li>\n
- route_reference<\/li>\n
- sca_preference<\/li>\n
- sca_source<\/li>\n
- sdd_display_page<\/li>\n
- sentinel_profile<\/li>\n
- sentinel_result<\/li>\n
- sentinel_review_result<\/li>\n
- sentinel_review_date<\/li>\n
- sentinel_reviewer<\/li>\n
- sentinel_rule<\/li>\n
- sentinel_rule_family<\/li>\n
- sentinel_score<\/li>\n
- session_id<\/li>\n
- shipping_country<\/li>\n
- shipping_city<\/li>\n
- shipping_postcode<\/li>\n
- shipping_street<\/li>\n
- status<\/li>\n
- status_period<\/li>\n
- store_name<\/li>\n
- search_type<\/li>\n
- tpe_reference<\/li>\n
- trxid<\/li>\n
- user_agent<\/li>\n
- website<\/li>\n
- qsearch<\/li>\n
- authorized_by_payment_means_date<\/li>\n
- blocked_date<\/li>\n
- captured_date<\/li>\n
- chargeback_date<\/li>\n
- collected_date<\/li>\n
- created_date<\/li>\n
- retraction_delay<\/li>\n
- settled_date<\/li>\n
- to_be_reviewed_date<\/li>\n
- operation_amount<\/li>\n
- payment_operation_mode<\/li>\n
- iban_creditor<\/li>\n
- iban_debitor<\/li>\n
- operation_id<\/li>\n
- operation_date<\/li>\n
- operation_merchant_id<\/li>\n
- operation_status<\/li>\n
- operation_type<\/li>\n
- remittance_reference<\/li>\n
- delivery_company<\/li>\n
- delivery_method<\/li>\n
- delivery_number<\/li>\n
- delivery_time<\/li>\n
- discount<\/li>\n
- item_category<\/li>\n
- item_name<\/li>\n
- item_quantity<\/li>\n
- item_reference<\/li>\n
- item_type<\/li>\n
- tax_rate<\/li>\n
- three_ds_v2_attempt<\/li>\n
- unit_price<\/li>\n <\/ul>\n
module : financial_report<\/h2>\n \n - account_id<\/li>\n
- acquirer_registration_id<\/li>\n
- acquirer_name<\/li>\n
- amount_excl_tax<\/li>\n
- amount_incl_tax<\/li>\n
- authorization_date<\/li>\n
- capture_date<\/li>\n
- custom_data<\/li>\n
- financial_operation_date<\/li>\n
- financial_operation_description<\/li>\n
- financial_operation_type<\/li>\n
- interchange_amount<\/li>\n
- invoice_number<\/li>\n
- invoice_status<\/li>\n
- financial_operation_currency<\/li>\n
- transaction_currency<\/li>\n
- payment_means<\/li>\n
- payment_method<\/li>\n
- financial_operation_mode<\/li>\n
- reserve_release_date<\/li>\n
- schemefee_amount<\/li>\n
- settlement_date<\/li>\n
- settlement_id<\/li>\n
- amount_tax<\/li>\n
- transaction_id<\/li>\n
- reserve_released<\/li>\n <\/ul>\n Available date interval:\n
\n - pd: Past day<\/li>\n
- cw: Current week<\/li>\n
- pw: Past week<\/li>\n
- cm: Current month<\/li>\n
- pm: Past month<\/li>\n
- cq: Current quarter<\/li>\n
- pq: Past quarter<\/li>\n
- cy: Current year<\/li>\n
- yy: Last twelve months<\/li>\n
- custom: Custom<\/li>\n <\/ul>\n Example date field:\n
\n - Predefined date interval : \"{\"created_date_interval\":\"pd\"}\"<\/li>\n
- Custom date interval : \"{\"authorized_by_payment_means_date_interval\":\"custom\",\"authorized_by_payment_means_date_from\":\"2019-01-01\",\"authorized_by_payment_means_date_to\":\"2019-06-15\"}\"<\/li>\n <\/ul>\n ","example":"{\"payment_means\":\"visa--mastercard\",\"order_by\":\"created_date\",\"direction\":\"desc\",\"created_date_interval\":\"pd\",\"authorized_by_payment_means_date_interval\":\"custom\",\"authorized_by_payment_means_date_from\":\"2019-01-01\",\"authorized_by_payment_means_date_to\":\"2019-06-15\"}"},"user":{"type":"string"},"config":{"type":"json","description":"Json object to configure export
\n Module transaction: To export payment operations set granularity = operation\n ","example":"{granularity: operation} | {granularity: transaction}"},"error":{"type":"json","description":"Error specification"}}},"ExportFile":{"type":"object","description":"Class ExportFile","properties":{"fileId":{"type":"integer","readOnly":true},"exportId":{"readOnly":true,"description":"Get exportId.","type":"integer"},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"filename":{"type":"string","readOnly":true},"hash":{"type":"string","readOnly":true},"export":{"type":"string"},"status":{"type":"string","description":"Export file status"},"nbItems":{"type":"string","description":"Export file number of items exported"},"dateRegenerated":{"type":"string","format":"date-time"}},"required":["filename"]},"ExportFile-export":{"type":"object","description":"Class ExportFile","properties":{"fileId":{"type":"integer","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"filename":{"type":"string","readOnly":true},"hash":{"type":"string","readOnly":true},"status":{"type":"string","description":"Export file status"},"nbItems":{"type":"string","description":"Export file number of items exported"}},"required":["filename"]},"ExportFile-export_denormalization":{"type":"object","description":"Class ExportFile"},"ExportFile-file":{"type":"object","description":"Class ExportFile","properties":{"fileId":{"type":"integer","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"filename":{"type":"string","readOnly":true},"hash":{"type":"string","readOnly":true},"status":{"type":"string","description":"Export file status"},"nbItems":{"type":"string","description":"Export file number of items exported"}},"required":["filename"]},"Login":{"type":"object","description":"Login object","properties":{"username":{"type":"string","description":"The username"},"password":{"type":"string","description":"The password"}},"required":["username","password"]},"LoginResponse":{"type":"object","description":"Login response","properties":{"token_type":{"type":"string","description":"The token type"},"expires_in":{"type":"string","description":"The token expiration timestamp"},"access_token":{"type":"string","description":"The jwt token"}}}}}