{ "components": { "schemas": { "AffiliationCashbackM2MDetailedReport": { "properties": { "amount": {}, "brand_id": {}, "brand_name": {}, "brand_reference": {}, "cancellation_reason": {}, "cancelled_date": {}, "consumer_cancelled_date": {}, "consumer_id": {}, "consumer_paid_date": {}, "consumer_pooled_date": {}, "consumer_status": {}, "consumer_validation_date": {}, "created_at": {}, "fees": {}, "id": {}, "offer_id": {}, "offer_name": {}, "offer_reference": {}, "paid_in_date": {}, "paid_out_date": {}, "pending_validation_date": {}, "playground": {}, "segments": {}, "status": {}, "strategy_id": {}, "strategy_reference": {}, "transaction_amount": {}, "transaction_executed_at": {}, "transaction_external_id": {}, "transaction_id": {}, "updated_at": {}, "validated_date": {} }, "type": "object" }, "AffiliationProgramOfferM2m": { "properties": { "application_channel": { "enum": [ "BOTH", "ONLINE", "OFFLINE" ], "maxLength": 7 }, "application_url": { "nullable": true }, "brand": { "$ref": "#/components/schemas/OfferBrand" }, "brand_id": {}, "completed_at": { "format": "date-time", "nullable": true, "type": "string" }, "deactivated_at": { "format": "date-time", "nullable": true, "type": "string" }, "deep_link_url": { "description": "Link that need to be clicked by the consumer to access the online offer", "type": "string" }, "description": { "minLength": 1 }, "end_date": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "highlight_level": { "enum": [ "HIGHEST", "HIGH", "NORMAL" ], "maxLength": 7, "nullable": true }, "id": { "format": "uuid", "type": "string" }, "legal_terms": {}, "max_fixed_reward_amount": { "description": "\n Maximum fixed rate amount that a consumer can access, this value is enter manually\n by the program manager, only check that it is inferior or equal of maximum define\n on the associated strategy\n ", "nullable": true, "type": "number" }, "max_reward_rate": { "description": "\n Maximum reward rate that a consumer can access, this value is enter manually\n by the program manager, only check that it is inferior or equal of maximum define\n on the associated strategy\n ", "nullable": true, "type": "number" }, "name": { "minLength": 1 }, "picture": { "$ref": "#/components/schemas/Image" }, "picture_id": { "format": "uuid", "nullable": true, "type": "string" }, "publication_date": { "format": "date-time", "readOnly": true, "type": "string" }, "reference": { "type": "string" }, "segments": { "items": {}, "type": "array" }, "start_date": { "format": "date-time", "readOnly": true, "type": "string" }, "status": { "type": "string" }, "strategy_id": {}, "timezone": {}, "type": { "enum": [ "CASHBACK", "UNIQUE_COUPON", "GENERIC_COUPON", "VOUCHER", "AFFILIATION", "LBS_CASHBACK" ], "maxLength": 14 } }, "required": [ "deep_link_url", "description", "id", "name", "reference", "type" ], "type": "object" }, "AffiliationVentilationFileListing": { "properties": { "amount": {}, "invoicing_cycle": { "type": "string" } }, "type": "object" }, "AggregatedReport": { "properties": { "amount": {}, "cashbacks": {}, "consumers": {}, "fees": {}, "playground": {}, "transaction_amount": {} }, "type": "object" }, "CashbackM2MDetailedReport": { "properties": { "amount": {}, "brand_id": {}, "brand_name": {}, "brand_reference": {}, "cancellation_reason": {}, "cancelled_date": {}, "consumer_cancelled_date": {}, "consumer_id": {}, "consumer_paid_date": {}, "consumer_pooled_date": {}, "consumer_status": {}, "consumer_validation_date": {}, "created_at": {}, "fees": {}, "id": {}, "invoice_reference": {}, "offer_cashback_rate": {}, "offer_id": {}, "offer_name": {}, "offer_reference": {}, "paid_in_date": {}, "paid_out_date": {}, "payout_id": {}, "pending_validation_date": {}, "playground": {}, "segments": {}, "status": {}, "strategy_channel": {}, "strategy_id": {}, "strategy_reference": {}, "transaction_amount": {}, "transaction_executed_at": {}, "transaction_external_id": {}, "transaction_id": {}, "updated_at": {}, "validated_date": {} }, "type": "object" }, "CashbackProgramOfferM2m": { "properties": { "application_channel": { "enum": [ "BOTH", "ONLINE", "OFFLINE" ], "maxLength": 7 }, "application_url": { "nullable": true }, "brand": { "$ref": "#/components/schemas/OfferBrand" }, "brand_id": {}, "cashback_rate": {}, "completed_at": { "format": "date-time", "readOnly": true, "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "deactivated_at": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "minLength": 1 }, "end_date": { "format": "date-time", "nullable": true, "type": "string" }, "highlight_level": { "enum": [ "HIGHEST", "HIGH", "NORMAL" ], "maxLength": 7, "nullable": true }, "id": { "format": "uuid", "type": "string" }, "is_ab_tested": { "type": "boolean" }, "is_main_source_transaction": { "type": "boolean" }, "is_targeted": {}, "legal_terms": { "minLength": 1 }, "max_amount": { "nullable": true, "type": "number" }, "max_cashbacks_per_consumer": { "nullable": true, "type": "integer" }, "min_amount": { "nullable": true, "type": "number" }, "name": { "minLength": 1 }, "picture": {}, "picture_id": {}, "publication_date": { "format": "date-time", "nullable": true, "type": "string" }, "reference": { "type": "string" }, "segments": { "items": {}, "type": "array" }, "start_date": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "readOnly": true, "type": "string" }, "strategy_id": {}, "timezone": {}, "translation": {}, "type": { "enum": [ "CASHBACK", "UNIQUE_COUPON", "GENERIC_COUPON", "VOUCHER", "AFFILIATION", "LBS_CASHBACK" ], "maxLength": 14 } }, "required": [ "description", "id", "legal_terms", "name", "reference", "type" ], "type": "object" }, "ConsumerRewardBatchStatus": { "properties": { "comment": { "default": null, "nullable": true, "type": "string" }, "reward_ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "reward_ids" ], "type": "object" }, "ConsumerRewardStatus": { "properties": { "comment": { "type": "string" } }, "required": [ "comment" ], "type": "object" }, "Image": { "properties": { "content_type": { "type": "string" }, "created_at": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "links": { "$ref": "#/components/schemas/Links" }, "name": { "type": "string" }, "owner": { "description": "ID of the uploader of the file", "format": "uuid", "nullable": true, "type": "string" }, "path": { "description": "Path of the image file", "nullable": true, "readOnly": true, "type": "string" } }, "type": "object" }, "LBSAnimationStrategy": { "properties": { "cost_per_acquisition": {}, "merchant_id": {}, "merchant_name": {}, "strategy_actual_end_date": {}, "strategy_budget": {}, "strategy_channel": {}, "strategy_consumers": {}, "strategy_consumers_cancelled": {}, "strategy_consumers_paid_in": {}, "strategy_consumers_paid_out": {}, "strategy_consumers_pending_validation": {}, "strategy_consumers_validated": {}, "strategy_end_date": {}, "strategy_id": {}, "strategy_objective": {}, "strategy_remaining_budget": {}, "strategy_start_date": {}, "strategy_status": {}, "updated_at": {} }, "type": "object" }, "LBSAnimationStrategyAndSiret": { "properties": { "cashbacks_cancelled": {}, "cashbacks_paid_in": {}, "cashbacks_paid_out": {}, "cashbacks_pending_validation": {}, "cashbacks_validated": {}, "consumers": {}, "consumers_cancelled": {}, "consumers_paid_in": {}, "consumers_paid_out": {}, "consumers_pending_validation": {}, "consumers_validated": {}, "fees": {}, "siret": {}, "strategy_id": {}, "transaction_amounts_cancelled": {}, "transaction_amounts_paid_in": {}, "transaction_amounts_paid_out": {}, "transaction_amounts_pending_validation": {}, "transaction_amounts_validated": {}, "updated_at": {} }, "type": "object" }, "LBSM2MDetailedReport": { "properties": { "amount": {}, "cancellation_reason": {}, "cancelled_date": {}, "consumer_cancelled_date": {}, "consumer_id": {}, "consumer_paid_date": {}, "consumer_pooled_date": {}, "consumer_status": {}, "consumer_validation_date": {}, "created_at": {}, "fees": {}, "id": {}, "invoice_reference": {}, "merchant_name": {}, "offer_cashback_rate": {}, "offer_id": {}, "offer_name": {}, "offer_reference": {}, "paid_in_date": {}, "paid_out_date": {}, "payout_id": {}, "pending_validation_date": {}, "playground": {}, "segments": {}, "siret": {}, "status": {}, "strategy_channel": {}, "strategy_id": {}, "strategy_reference": {}, "transaction_amount": {}, "transaction_executed_at": {}, "transaction_external_id": {}, "transaction_id": {}, "updated_at": {}, "validated_date": {} }, "type": "object" }, "Links": { "properties": { "download": { "format": "url", "type": "string" }, "preview": { "format": "url", "type": "string" } }, "type": "object" }, "OfferBrand": { "properties": { "cashback_validation_delay_days": {}, "description": { "nullable": true }, "id": { "format": "uuid", "type": "string" }, "legal_terms": { "nullable": true }, "logo": { "$ref": "#/components/schemas/Image" }, "name": { "type": "string" }, "primary_language": { "readOnly": true }, "secondary_languages": { "readOnly": true }, "universes": { "items": { "$ref": "#/components/schemas/UniverseOffer" }, "type": "array" } }, "type": "object" }, "ProgramCouponGenericOfferM2m": { "properties": { "application_channel": { "enum": [ "BOTH", "ONLINE", "OFFLINE" ], "maxLength": 7 }, "application_url": {}, "brand": { "$ref": "#/components/schemas/OfferBrand" }, "brand_id": { "format": "uuid", "type": "string" }, "completed_at": { "format": "date-time", "nullable": true, "type": "string" }, "coupon_diffusion_type": { "enum": [ "QR", "EAN", "CODE" ], "maxLength": 4, "type": "string" }, "coupon_generic_code": { "type": "string" }, "deactivated_at": { "format": "date-time", "nullable": true, "type": "string" }, "description": {}, "end_date": { "format": "date-time", "nullable": true, "type": "string" }, "highlight_level": { "enum": [ "HIGHEST", "HIGH", "NORMAL" ], "maxLength": 7, "nullable": true }, "id": { "format": "uuid", "type": "string" }, "legal_terms": {}, "name": {}, "picture": { "$ref": "#/components/schemas/Image" }, "picture_id": { "format": "uuid", "nullable": true, "type": "string" }, "publication_date": { "format": "date-time", "nullable": true, "type": "string" }, "reference": { "type": "string" }, "segments": { "items": {}, "type": "array" }, "start_date": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "type": "string" }, "strategy_id": { "default": null }, "timezone": {}, "type": { "enum": [ "CASHBACK", "UNIQUE_COUPON", "GENERIC_COUPON", "VOUCHER", "AFFILIATION", "LBS_CASHBACK" ], "maxLength": 14 } }, "required": [ "coupon_generic_code", "id", "reference", "type" ], "type": "object" }, "ProgramCouponUniqueOfferM2m": { "properties": { "application_channel": { "enum": [ "BOTH", "ONLINE", "OFFLINE" ], "maxLength": 7 }, "application_url": {}, "brand": { "$ref": "#/components/schemas/OfferBrand" }, "brand_id": { "format": "uuid", "type": "string" }, "completed_at": { "format": "date-time", "nullable": true, "type": "string" }, "coupon_diffusion_type": { "enum": [ "QR", "EAN", "CODE" ], "maxLength": 4, "type": "string" }, "deactivated_at": { "format": "date-time", "nullable": true, "type": "string" }, "description": {}, "end_date": { "format": "date-time", "nullable": true, "type": "string" }, "highlight_level": { "enum": [ "HIGHEST", "HIGH", "NORMAL" ], "maxLength": 7, "nullable": true }, "id": { "format": "uuid", "type": "string" }, "legal_terms": {}, "name": {}, "picture": { "$ref": "#/components/schemas/Image" }, "picture_id": { "format": "uuid", "nullable": true, "type": "string" }, "publication_date": { "format": "date-time", "nullable": true, "type": "string" }, "reference": { "type": "string" }, "segments": { "items": {}, "type": "array" }, "start_date": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "type": "string" }, "strategy_id": { "default": null }, "timezone": {}, "type": { "enum": [ "CASHBACK", "UNIQUE_COUPON", "GENERIC_COUPON", "VOUCHER", "AFFILIATION", "LBS_CASHBACK" ], "maxLength": 14 } }, "required": [ "id", "reference", "type" ], "type": "object" }, "ProgramOfferM2m": { "discriminator": { "mapping": { "AFFILIATION": "#/components/schemas/AffiliationProgramOfferM2m", "CASHBACK": "#/components/schemas/CashbackProgramOfferM2m", "GENERIC_COUPON": "#/components/schemas/ProgramCouponGenericOfferM2m", "UNIQUE_COUPON": "#/components/schemas/ProgramCouponUniqueOfferM2m", "VOUCHER": "#/components/schemas/VoucherProgramOfferM2m" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CashbackProgramOfferM2m" }, { "$ref": "#/components/schemas/ProgramCouponGenericOfferM2m" }, { "$ref": "#/components/schemas/ProgramCouponUniqueOfferM2m" }, { "$ref": "#/components/schemas/AffiliationProgramOfferM2m" }, { "$ref": "#/components/schemas/VoucherProgramOfferM2m" } ] }, "ProposedVoucher": { "properties": { "price": { "description": "The buying price of a voucher including program fees", "nullable": true, "readOnly": true, "type": "number" }, "value": { "description": "The value to spent in merchant shop", "nullable": true, "readOnly": true, "type": "number" } }, "type": "object" }, "UniverseOffer": { "properties": { "children": { "nullable": true }, "id": { "format": "uuid", "type": "string" }, "name": { "nullable": true, "type": "string" }, "parent_id": {} }, "type": "object" }, "VentilationFileListing": { "properties": { "amount": {}, "execution_date": {}, "fee_invoice_id": {}, "fee_invoice_reference": {}, "id": {}, "invoicing_cycle": { "type": "string" }, "payout_id": {}, "status": {} }, "type": "object" }, "VoucherProgramOfferM2m": { "properties": { "application_channel": { "enum": [ "BOTH", "ONLINE", "OFFLINE" ], "maxLength": 7 }, "application_url": { "nullable": true }, "brand": { "$ref": "#/components/schemas/OfferBrand" }, "brand_id": {}, "completed_at": { "format": "date-time", "readOnly": true, "type": "string" }, "deactivated_at": { "format": "date-time", "nullable": true, "type": "string" }, "description": {}, "end_date": { "format": "date-time", "nullable": true, "type": "string" }, "highlight_level": { "enum": [ "HIGHEST", "HIGH", "NORMAL" ], "maxLength": 7, "nullable": true }, "id": { "format": "uuid", "type": "string" }, "legal_terms": { "minLength": 1 }, "max_discount_rate": { "description": "maximum discount rate", "nullable": true, "type": "number" }, "max_value": { "description": "maximum value of the vouchers", "type": "number" }, "min_value": { "description": "minimal value of the vouchers", "type": "number" }, "name": { "minLength": 1 }, "picture": { "$ref": "#/components/schemas/Image" }, "picture_id": { "format": "uuid", "nullable": true, "type": "string" }, "proposed_vouchers": { "items": { "$ref": "#/components/schemas/ProposedVoucher" }, "readOnly": true, "type": "array" }, "publication_date": { "format": "date-time", "nullable": true, "type": "string" }, "reference": { "type": "string" }, "segments": { "items": {}, "type": "array" }, "start_date": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "readOnly": true, "type": "string" }, "strategy_id": {}, "timezone": {}, "translation": {}, "type": { "enum": [ "CASHBACK", "UNIQUE_COUPON", "GENERIC_COUPON", "VOUCHER", "AFFILIATION", "LBS_CASHBACK" ], "maxLength": 14 }, "voucher_modes": { "description": "Describe the mode of voucher proposal, can be one or another or both", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "legal_terms", "name", "reference", "type", "voucher_modes" ], "type": "object" } }, "securitySchemes": { "ApiKeyAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "info": { "title": "PayLead API", "version": "1.1.3" }, "openapi": "3.0.2", "paths": { "/connectors/m2m/lbs/reports/strategy": { "get": { "description": "Generates LBS strategies with main parameters and aggregated metrics (number of Cashbacks and unique Consumers by status).", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LBSAnimationStrategy" }, "type": "array" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the LBS Strategies", "tags": [ "LBS" ] } }, "/connectors/m2m/lbs/reports/strategy/report.csv": { "get": { "description": "Generates a CSV file of the LBS strategies with main parameters and aggregated metrics (number of Cashbacks and unique Consumers by status).", "responses": { "200": { "content": { "text/csv": { "example": "strategy_id,strategy_channel,merchant_id,merchant_name,strategy_objective,strategy_status,strategy_start_date,strategy_end_date,strategy_actual_end_date,cost_per_acquisition,strategy_budget,strategy_remaining_budget,strategy_consumers,strategy_consumers_pending_validation,strategy_consumers_validated,strategy_consumers_paid_in,strategy_consumers_paid_out,strategy_consumers_cancelled,updated_at", "schema": { "type": "string" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the LBS Strategies in CSV", "tags": [ "LBS" ] } }, "/connectors/m2m/lbs/reports/strategy/stores": { "get": { "description": "Lists the LBS stores (siret) with aggregated strategy metrics (number of Cashbacks, unique Consumers by status and fee amount).", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LBSAnimationStrategyAndSiret" }, "type": "array" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the performance reporting of a Strategy per store", "tags": [ "LBS" ] } }, "/connectors/m2m/lbs/reports/strategy/stores/report.csv": { "get": { "description": "Exports a CSV file of the LBS stores (siret) with aggregated strategy metrics (number of Cashbacks, unique Consumers by status and fee amount).", "responses": { "200": { "content": { "text/csv": { "example": "strategy_id,siret,consumers,cashbacks_pending_validation,transaction_amounts_pending_validation,consumers_pending_validation,cashbacks_validated,transaction_amounts_validated,consumers_validated,cashbacks_paid_in,transaction_amounts_paid_in,consumers_paid_in,cashbacks_paid_out,transaction_amounts_paid_out,consumers_paid_out,cashbacks_cancelled,transaction_amounts_cancelled,consumers_cancelled,fees,updated_at", "schema": { "type": "string" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the performance reporting of a Strategy per store via CSV", "tags": [ "LBS" ] } }, "/connectors/m2m/offers": { "get": { "description": "Lists all the Offers of the Program with the main parameters.", "parameters": [ { "description": "Filter by brand__id", "in": "query", "name": "brand__id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter by end_date", "in": "query", "name": "end_date", "schema": { "type": "string" } }, { "description": "the page number", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "the number of elements per page", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "start_date", "end_date", "type", "brand__id", "status", "-start_date", "-end_date", "-type", "-brand__id", "-status" ], "type": "string" } }, { "description": "Filter by start_date\n\nFiltering on start date\nbetween --\nafter --\nbefore --\n", "examples": { "between": { "summary": "between 2020-05-25 and 2021-01-13", "value": "2020-05-25T00:00--2021-01-13T00:00" }, "older": { "summary": "before 2021-05-25", "value": "--2021-05-25T00:00" } }, "in": "query", "name": "start_date", "schema": { "type": "string" } }, { "description": "Filter by status", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Filter by type", "in": "query", "name": "type", "schema": { "enum": [ "CASHBACK", "UNIQUE_COUPON", "GENERIC_COUPON", "VOUCHER", "AFFILIATION", "LBS_CASHBACK" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ProgramOfferM2m" }, "type": "array" }, "meta": { "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the list of Offers", "tags": [ "Offers" ] } }, "/connectors/m2m/reports/affiliation/cashbacks": { "get": { "description": "Lists the Affiliation Cashbacks of the Program with details (amount, Transaction parameters, fee amount, dates, ...).", "parameters": [ { "description": "the page number", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "the number of elements per page", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "updated_at", "-updated_at" ], "type": "string" } }, { "description": "Filter by updated_at", "in": "query", "name": "updated_at", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AffiliationCashbackM2MDetailedReport" }, "type": "array" }, "meta": { "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get all the affiliation Cashbacks", "tags": [ "Affiliation Cashback" ] } }, "/connectors/m2m/reports/affiliation/cashbacks/metrics": { "get": { "description": "Retrieves the aggregated metrics of Affiliation Cashbacks (total amount, number of Cashbacks, number of unique Consumers, total fees).", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AggregatedReport" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the affiliation Cashbacks metrics", "tags": [ "Affiliation Cashback" ] } }, "/connectors/m2m/reports/affiliation/cashbacks/report.csv": { "get": { "description": "Generates a CSV file listing the Affiliation Cashbacks of the Program.", "parameters": [ { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "updated_at", "-updated_at" ], "type": "string" } }, { "description": "Filter by updated_at", "in": "query", "name": "updated_at", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "id,created_at,updated_at,transaction_executed_at,transaction_id,transaction_external_id,status,consumer_status,consumer_id,segments,fees,amount,transaction_amount,playground,brand_id,brand_reference,brand_name,strategy_id,strategy_reference,offer_id,offer_reference,offer_name,cancelled_date,pending_validation_date,validated_date,paid_in_date,paid_out_date,consumer_validation_date,consumer_pooled_date,consumer_paid_date,consumer_cancelled_date,cancellation_reason", "schema": { "type": "string" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the affiliation Cashbacks metrics in CSV", "tags": [ "Affiliation Cashback" ] } }, "/connectors/m2m/reports/cashbacks": { "get": { "description": "ALO Cashback reporting", "parameters": [ { "description": "the page number", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "Filter by payout_id", "in": "query", "name": "payout_id", "schema": { "format": "uuid", "type": "string" } }, { "description": "the number of elements per page", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "updated_at", "payout_id", "-updated_at", "-payout_id" ], "type": "string" } }, { "description": "Filter by updated_at", "in": "query", "name": "updated_at", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CashbackM2MDetailedReport" }, "type": "array" }, "meta": { "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the list of Cashbacks", "tags": [ "Cashback" ] } }, "/connectors/m2m/reports/cashbacks/metrics": { "get": { "description": "ALO Cashback aggregated metrics (total amount, number of Cashbacks, number of unique Consumers, total fees).", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AggregatedReport" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the Cashbacks metrics", "tags": [ "Cashback" ] } }, "/connectors/m2m/reports/cashbacks/report.csv": { "get": { "description": "ALO cashback reporting in a CSV file.", "parameters": [ { "description": "Filter by payout_id", "in": "query", "name": "payout_id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "updated_at", "payout_id", "-updated_at", "-payout_id" ], "type": "string" } }, { "description": "Filter by updated_at", "in": "query", "name": "updated_at", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "id,created_at,updated_at,transaction_executed_at,transaction_id,transaction_external_id,status,consumer_status,consumer_id,segments,fees,amount,transaction_amount,playground,brand_id,brand_reference,brand_name,strategy_id,strategy_reference,strategy_channel,offer_id,offer_reference,offer_name,offer_cashback_rate,invoice_reference,payout_id,cancelled_date,pending_validation_date,validated_date,paid_in_date,paid_out_date,consumer_validation_date,consumer_pooled_date,consumer_paid_date,consumer_cancelled_date,cancellation_reason", "schema": { "type": "string" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the Cashbacks metrics in CSV", "tags": [ "Cashback" ] } }, "/connectors/m2m/reports/lbs/cashbacks": { "get": { "description": "LBS Cashback reporting", "parameters": [ { "description": "Filter by payout_id", "in": "query", "name": "payout_id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "updated_at", "payout_id", "-updated_at", "-payout_id" ], "type": "string" } }, { "description": "Filter by updated_at", "in": "query", "name": "updated_at", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LBSM2MDetailedReport" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the LBS Cashbacks", "tags": [ "LBS" ] } }, "/connectors/m2m/reports/lbs/cashbacks/metrics": { "get": { "description": "LBS Cashback aggregated metrics (total amount, number of Cashbacks, number of unique Consumers, total fees).", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AggregatedReport" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get aggregated metrics about LBS cashbacks", "tags": [ "LBS" ] } }, "/connectors/m2m/reports/lbs/cashbacks/report.csv": { "get": { "description": "LBS Cashback reporting in a CSV file.", "parameters": [ { "description": "Filter by payout_id", "in": "query", "name": "payout_id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "updated_at", "payout_id", "-updated_at", "-payout_id" ], "type": "string" } }, { "description": "Filter by updated_at", "in": "query", "name": "updated_at", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "id,created_at,updated_at,transaction_executed_at,transaction_id,transaction_external_id,status,consumer_status,consumer_id,segments,fees,amount,transaction_amount,playground,merchant_name,siret,strategy_id,strategy_reference,strategy_channel,offer_id,offer_reference,offer_name,offer_cashback_rate,invoice_reference,payout_id,cancelled_date,pending_validation_date,validated_date,paid_in_date,paid_out_date,consumer_validation_date,consumer_pooled_date,consumer_paid_date,consumer_cancelled_date,cancellation_reason", "schema": { "type": "string" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the LBS Cashbacks metrics in CSV", "tags": [ "LBS" ] } }, "/connectors/m2m/rewards/{reward_id}/{target_consumer_status}": { "post": { "description": "Sets the \"Consumer Reward status\" of an existing Reward.", "parameters": [ { "description": "Unique ID of the reward.", "in": "path", "name": "reward_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Target consumer status to give to the target reward", "in": "path", "name": "target_consumer_status", "required": true, "schema": { "enum": [ "validation", "pooled", "paid", "cancelled" ], "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerRewardStatus" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerRewardStatus" } } }, "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Update the Cashback Consumer status", "tags": [ "Status" ] } }, "/connectors/m2m/rewards/{target_consumer_status}": { "post": { "description": "Sets the \"Consumer Reward status\" of one or many existing Rewards", "parameters": [ { "description": "Target consumer status to give to the target reward", "in": "path", "name": "target_consumer_status", "required": true, "schema": { "enum": [ "validation", "pooled", "paid", "cancelled" ], "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerRewardBatchStatus" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerRewardBatchStatus" } } }, "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported Media Type" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Update the Consumer status of several Cashbacks", "tags": [ "Status" ] } }, "/connectors/m2m/ventilations/rewards/affiliation": { "get": { "description": "Lists the ventilation of Affiliation Cashbacks with amounts per Consumer.", "parameters": [ { "description": "Filter by invoicing_cycle", "in": "query", "name": "invoicing_cycle", "schema": { "type": "string" } }, { "description": "the page number", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "the number of elements per page", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "invoicing_cycle", "-invoicing_cycle" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AffiliationVentilationFileListing" }, "type": "array" }, "meta": { "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "description": "OK", "links": { "get.AffiliationVentilationCsvResource": { "operationId": "get.AffiliationVentilationCsvResource", "parameters": { "invoicing_cycle": "$response.body#/items/0/invoicing_cycle" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the affiliation Cashbacks ventilation file", "tags": [ "Affiliation Cashback" ] } }, "/connectors/m2m/ventilations/rewards/affiliation/{invoicing_cycle}": { "get": { "description": "Lists the Affiliation Rewards per consumer filtered by invoicing cycle.", "operationId": "get.AffiliationVentilationCsvResource", "parameters": [ { "in": "path", "name": "invoicing_cycle", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "AffiliationVentilationFile", "schema": { "type": "string" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the affiliation Cashbacks bound to an invoicing_cycle", "tags": [ "Cashback" ] } }, "/connectors/m2m/ventilations/rewards/cashbacks": { "get": { "description": "Lists the ventilation of ALO Cashbacks in amounts per Consumer.", "parameters": [ { "description": "Filter by execution_date", "in": "query", "name": "execution_date", "schema": { "type": "string" } }, { "description": "Filter by fee_invoice_id", "in": "query", "name": "fee_invoice_id", "schema": { "format": "uuid", "type": "string" } }, { "description": "the page number", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "Filter by payout_id", "in": "query", "name": "payout_id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Filter by payout_status", "in": "query", "name": "payout_status", "schema": { "enum": [ "TODO", "PENDING", "CREATED", "VALIDATED", "REJECTED", "ERROR", "DEACTIVATED" ], "type": "string" } }, { "description": "the number of elements per page", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Sort by given attribute", "in": "query", "name": "sort", "schema": { "enum": [ "status", "payout_status", "execution_date", "fee_invoice_id", "payout_id", "-status", "-payout_status", "-execution_date", "-fee_invoice_id", "-payout_id" ], "type": "string" } }, { "description": "Filter by status", "in": "query", "name": "status", "schema": { "enum": [ "PENDING", "VALIDATED", "PAID", "ERROR" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/VentilationFileListing" }, "type": "array" }, "meta": { "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "description": "OK", "links": { "get.VentilationCsvConnectorResource": { "operationId": "get.VentilationCsvConnectorResource", "parameters": { "invoicing_cycle": "$response.body#/items/0/invoicing_cycle" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the Cashbacks ventilation file", "tags": [ "Affiliation Cashback" ] } }, "/connectors/m2m/ventilations/rewards/cashbacks/{invoicing_cycle}": { "get": { "description": "Lists the ventilation of ALO Cashbacks in amounts per Consumer.", "operationId": "get.VentilationCsvConnectorResource", "parameters": [ { "in": "path", "name": "invoicing_cycle", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "VentilationFile", "schema": { "type": "string" } } }, "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Not allowed to access the resource" }, "404": { "description": "Not found" }, "405": { "description": "Method not allowed" }, "422": { "description": "Unprocessable Entity" } }, "summary": "Get the Cashbacks ventilation file", "tags": [ "Cashback" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://api.sandbox.paylead.tech" } ] }