### Get Customer Charges API Request Source: https://www.flow.cl/docs/apiFlow_v=7 This service retrieves a paginated list of charges made to a customer. It supports filtering by customer ID, date range, status, and charge description. Pagination is controlled by 'start' and 'limit' parameters. ```json { "apiKey": "string", "customerId": "string", "start": 0, "limit": 10, "filter": "string", "fromDate": "yyyy-mm-dd", "status": 0, "s": "string" } ``` -------------------------------- ### Get Overdue Invoices - API Source: https://www.flow.cl/docs/apiFlow_v=7 Retrieves a paginated list of overdue invoices. Requires an apiKey and a signature (s). Supports filtering by start record, limit, invoice subject, and plan ID. ```openapi /invoice/getOverDue: get: tags: - invoice summary: "Obtiene los invoices vencidos" description: "Este servicio permite obtener la lista de invoices vencidos, es decir, aquellos no pagados cuyo due_date este vencido." parameters: - in: query name: apiKey description: apiKey del comercio required: true schema: type: string - in: query name: start description: Número de registro de inicio de la página. Si se omite el valor por omisión es 0. required: false schema: type: integer - in: query name: limit description: Número de registros por página. Si se omite el valor por omisión es 10. El valor máximo es de 100 registros por página. required: false schema: type: integer - in: query name: filter description: Filtro por asunto del Invoice (Importe). required: false schema: type: string - in: query name: planId description: Identificador del Plan, si se agrega se filtrará para los invoices de este plan. required: false schema: type: string - in: query name: s description: la firma de los parámetros efectuada con su secretKey required: true schema: type: string responses: '200': description: "Lista paginada de Invoices vencidos" content: application/json: schema: $ref: '#/components/schemas/List' '400': description: Error del Api content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Error de negocio content: application/json: schema: $ref: '#/components/schemas/Error' ``` -------------------------------- ### GET /subscription/list Source: https://www.flow.cl/docs/api Retrieves a paginated list of subscriptions for a given plan. ```APIDOC ## GET /subscription/list ### Description Retrieves a paginated list of subscriptions for a given plan. ### Method GET ### Endpoint /subscription/list ### Parameters #### Query Parameters - **apiKey** (string) - Required - The API key of the commerce. - **subscriptionId** (string) - Required - The ID of the subscription. - **trial_period_days** (number) - Required - The number of trial days to set. - **s** (string) - Required - The signature of the parameters made with your secretKey. ### Request Example ```json { "apiKey": "your_api_key", "subscriptionId": "sub_12345", "trial_period_days": 15, "s": "generated_signature" } ``` ### Response #### Success Response (200) - **total** (integer) - The total number of subscriptions. - **hasMore** (integer) - Indicates if there are more subscriptions available (1 for true, 0 for false). - **data** (array) - A list of subscription objects. #### Response Example ```json { "total": 200, "hasMore": 1, "data": [ { "item_list_1": "..." }, { "item_list_2": "..." } ] } ``` #### Error Responses - **400** - Bad Request: Error from the API. - **401** - Unauthorized: Business logic error. ``` -------------------------------- ### Subscription List Response Sample Source: https://www.flow.cl/docs/api Example JSON structure for a successful response when listing subscriptions. It includes total count, a flag for more data, and the data payload. ```JSON { "total": 200, "hasMore": 1, "data": "[{item list 1}{item list 2}{item list n..}]" } ``` -------------------------------- ### GET /customer/getChargeAttemps Source: https://www.flow.cl/docs/apiFlow_v=7 This service retrieves a paginated list of failed charge attempts for a customer. ```APIDOC ## GET /customer/getChargeAttemps ### Description Retrieves a paginated list of failed charge attempts made to a customer. ### Method GET ### Endpoint /customer/getChargeAttemps ### Parameters #### Query Parameters - **apiKey** (string) - Required - apiKey of the commerce - **customerId** (string) - Required - Identifier of the customer - **start** (integer) - Optional - Starting record number for pagination. Defaults to 0. - **limit** (integer) - Optional - Number of records per page. Defaults to 10. Maximum is 100. ### Response #### Success Response (200) - **List** - Paginated list of failed charge attempts made to a customer #### Response Example ```json { "attempts": [ { "description": "Failed Attempt", "amount": 50, "date": "2023-10-27", "errorCode": "500" } ], "total": 1 } ``` #### Error Response (400) - **Error** - API Error #### Error Response (401) - **Error** - Business Error ``` -------------------------------- ### List Subscriptions (GET) Source: https://www.flow.cl/docs/api Retrieves a paginated list of subscriptions for a given plan. It handles successful responses with data and errors from the API or business logic. ```HTTP GET /subscription/list Production server (uses live data) https://www.flow.cl/api/subscription/list Sandbox server (uses test data) https://sandbox.flow.cl/api/subscription/list ``` -------------------------------- ### GET /customer/getCharges Source: https://www.flow.cl/docs/apiFlow_v=7 This service retrieves a paginated list of charges made to a customer. It supports filtering by various criteria. ```APIDOC ## GET /customer/getCharges ### Description Retrieves a paginated list of charges made to a customer, with optional filtering. ### Method GET ### Endpoint /customer/getCharges ### Parameters #### Query Parameters - **apiKey** (string) - Required - apiKey of the commerce - **customerId** (string) - Required - Identifier of the customer - **start** (integer) - Optional - Starting record number for pagination. Defaults to 0. - **limit** (integer) - Optional - Number of records per page. Defaults to 10. Maximum is 100. - **filter** (string) - Optional - Filter by charge description - **fromDate** (string) - Optional - Filter by start date (yyyy-mm-dd) - **status** (integer) - Optional - Filter by charge status - **s** (string) - Required - The signature of the parameters made with your secretKey ### Response #### Success Response (200) - **List** - Paginated list of charges made to a customer #### Response Example ```json { "charges": [ { "description": "Sample Charge", "amount": 100, "date": "2023-10-27", "status": 1 } ], "total": 1 } ``` #### Error Response (400) - **Error** - API Error #### Error Response (401) - **Error** - Business Error ``` -------------------------------- ### POST /websites/flow_cl Source: https://www.flow.cl/docs/apiFlow_v=7 This service allows reversing a previously made charge to a customer. The charge can only be reversed within 24 hours of its creation, with the 24-hour period starting from 14:00 hrs. ```APIDOC ## POST /websites/flow_cl ### Description Reverses a previously made charge to a customer within 24 hours of its creation. ### Method POST ### Endpoint /websites/flow_cl ### Parameters #### Request Body - **apiKey** (string) - Required - apiKey of the commerce - **commerceOrder** (string) - Optional - Identifier of the commerce order - **flowOrder** (number) - Optional - Identifier of the Flow order - **s** (string) - Required - The signature of the parameters made with your secretKey ### Request Example ```json { "apiKey": "your_api_key", "commerceOrder": "order_123", "s": "signature" } ``` ### Response #### Success Response (200) - **ReverseChargeResponse** - The ReverseChargeResponse object #### Response Example ```json { "message": "Charge reversed successfully" } ``` #### Error Response (400) - **Error** - API Error #### Error Response (401) - **Error** - Business Error ``` -------------------------------- ### Settlement Get By ID v2 Source: https://www.flow.cl/docs/api_changelog Retrieves a settlement using its number with the new Flow settlement format. ```APIDOC ## GET /settlement/getByIdv2 ### Description This endpoint retrieves a settlement made, based on a settlement number, using the new settlement format used by Flow since June 1, 2021. ### Method GET ### Endpoint /settlement/getByIdv2 ### Parameters #### Query Parameters - **settlementNumber** (string) - Required - The settlement number. ### Response #### Success Response (200) - **settlementId** (string) - The ID of the settlement. - **date** (string) - The date of the settlement. #### Response Example ```json { "settlementId": "s456", "date": "2021-06-08" } ``` ``` -------------------------------- ### GET /payment/getStatusByCommerceId Source: https://www.flow.cl/docs/api Retrieves the status of a payment using the commerce ID. ```APIDOC ## GET /payment/getStatusByCommerceId ### Description Retrieves the status of a payment using the `commerceId`. ### Method GET ### Endpoint `/api/payment/getStatusByCommerceId` ### Parameters #### Query Parameters - **apiKey** (string) - Required - The API key of the merchant. - **commerceId** (string) - Required - The merchant's order ID. - **s** (string) - Required - The signature of the parameters, generated using your secret key. ### Responses *The response structure for this endpoint is similar to `/payment/getStatus` but uses `commerceId` for retrieval.* ### Response Example (200) ```json { "flowOrder": 3567899, "commerceOrder": "sf12377", "requestDate": "2017-07-21 12:32:11", "status": 1, "subject": "game console", "currency": "CLP", "amount": 12000, "payer": "pperez@gamil.com", "optional": { "RUT": "7025521-9", "ID": "899564778" }, "pending_info": { "media": "Multicaja", "date": "2017-07-21 10:30:12" }, "paymentData": { "date": "2017-07-21 12:32:11", "media": "webpay", "conversionDate": "2017-07-21", "conversionRate": 1.1, "amount": 12000, "currency": "CLP", "fee": 551, "balance": 11499, "transferDate": "2017-07-24" }, "merchantId": "string" } ``` ``` -------------------------------- ### Get Customer Charge Attempts API Request Source: https://www.flow.cl/docs/apiFlow_v=7 This service retrieves a paginated list of failed charge attempts made to a customer. It requires an API key and customer ID, with optional parameters for pagination. ```json { "apiKey": "string", "customerId": "string", "start": 0, "limit": 10 } ``` -------------------------------- ### POST /subscription/changeTrial Source: https://www.flow.cl/docs/api Modifies the trial period days for a subscription. This can only be done for subscriptions that have not yet started or are still within their trial period. ```APIDOC ## POST /subscription/changeTrial ### Description Modifies the trial period days for a subscription. This can only be done for subscriptions that have not yet started or are still within their trial period. ### Method POST ### Endpoint /subscription/changeTrial ### Parameters #### Request Body - **apiKey** (string) - Required - The API key of the commerce. - **subscriptionId** (string) - Required - The identifier of the subscription. - **trial_period_days** (number) - Required - The number of trial days to set. - **s** (string) - Required - The signature of the parameters made with your secretKey. ### Request Example ```json { "apiKey": "your_api_key", "subscriptionId": "sub_12345", "trial_period_days": 15, "s": "generated_signature" } ``` ### Response #### Success Response (200) - **Subscription** (object) - The updated subscription object. #### Response Example ```json { "subscriptionId": "sub_12345", "trial_period_days": 15, "status": "active" } ``` #### Error Responses - **400** - Bad Request: Error from the API. - **401** - Unauthorized: Business logic error. ``` -------------------------------- ### GET /invoice/getOverDue Source: https://www.flow.cl/docs/apiFlow_v=7 Retrieves a list of overdue invoices. This service allows you to obtain the list of overdue invoices, meaning those not paid whose due_date has passed. ```APIDOC ## GET /invoice/getOverDue ### Description Retrieves a list of overdue invoices. This service allows you to obtain the list of overdue invoices, meaning those not paid whose due_date has passed. ### Method GET ### Endpoint /invoice/getOverDue ### Parameters #### Query Parameters - **apiKey** (string) - Required - apiKey of the merchant - **start** (integer) - Optional - Starting record number for pagination. Defaults to 0. - **limit** (integer) - Optional - Number of records per page. Defaults to 10. Maximum is 100 records per page. - **filter** (string) - Optional - Filter by Invoice subject (Amount). - **planId** (string) - Optional - Plan identifier; if added, filters for invoices of this plan. - **s** (string) - Required - Signature of the parameters made with your secretKey ### Response #### Success Response (200) - **List** (object) - Paged list of overdue Invoices #### Error Response (400, 401) - **Error** (object) - API or business error details ``` -------------------------------- ### Get Settlement by Date - API Source: https://www.flow.cl/docs/apiFlow_v=7 Retrieves settlement data for a specific date. Requires an API key, date, and a signature (s). Note: This endpoint is deprecated for settlements after 2021-06-01 in favor of /settlement/search. ```openapi /settlement/getByDate: get: tags: - settlement summary: Obtiene la liquidación efectuada para esa fecha. description: 'Este método se utiliza para obtener la liquidación de la fecha enviada como parámetro.
Nota: Si su liquidación es anterior al 01-06-2021 utilizar este servicio, en caso contrario se recomienda utilizar el servicio /settlement/search' deprecated: true parameters: - in: query name: apiKey description: apiKey del comercio required: true schema: type: string - in: query name: date description: Fecha de la liquidación required: true schema: type: string format: yyyy-mm-dd - in: query name: s description: la firma de los parámetros efectuada con su secretKey. required: true schema: type: string responses: '200': ``` -------------------------------- ### Modify Trial Days (POST) Source: https://www.flow.cl/docs/api Allows modification of the trial period days for a subscription. This is only possible for subscriptions that have not started or are still within their trial period. It requires an API key, subscription ID, and the new trial period days. ```HTTP POST /subscription/changeTrial Production server (uses live data) https://www.flow.cl/api/subscription/changeTrial Sandbox server (uses test data) https://sandbox.flow.cl/api/subscription/changeTrial ``` -------------------------------- ### GET /payment/getStatus Source: https://www.flow.cl/docs/api Retrieves the status of a payment using a transaction token. This method is intended for use on the merchant's callback page to receive payment notifications. ```APIDOC ## GET /payment/getStatus ### Description Retrieves the status of a payment using a transaction token. This method is intended for use on the merchant's callback page to receive payment notifications. Flow sends a POST request to the merchant's callback page with a token that must be used with this service. ### Method GET ### Endpoint `/api/payment/getStatus` ### Parameters #### Query Parameters - **apiKey** (string) - Required - The API key of the merchant. - **token** (string) - Required - The transaction token sent by Flow. - **s** (string) - Required - The signature of the parameters, generated using your secret key. ### Responses #### Success Response (200) - **PaymentStatus** (object) - An object containing the payment status details. #### Error Response (400) - **error** (object) - An error object if the API request fails. #### Error Response (401) - **error** (object) - An error object indicating an internal business error. ### Response Example (200) ```json { "flowOrder": 3567899, "commerceOrder": "sf12377", "requestDate": "2017-07-21 12:32:11", "status": 1, "subject": "game console", "currency": "CLP", "amount": 12000, "payer": "pperez@gamil.com", "optional": { "RUT": "7025521-9", "ID": "899564778" }, "pending_info": { "media": "Multicaja", "date": "2017-07-21 10:30:12" }, "paymentData": { "date": "2017-07-21 12:32:11", "media": "webpay", "conversionDate": "2017-07-21", "conversionRate": 1.1, "amount": 12000, "currency": "CLP", "fee": 551, "balance": 11499, "transferDate": "2017-07-24" }, "merchantId": "string" } ``` ``` -------------------------------- ### Get Payment Status Source: https://www.flow.cl/docs/api Retrieves the status of a payment using a token provided by Flow. This is typically used on a merchant's callback page to receive payment notifications. It requires the API key, transaction token, and a signature. ```http GET https://www.flow.cl/api/payment/getStatus GET https://sandbox.flow.cl/api/payment/getStatus ``` ```json { "flowOrder": 3567899, "commerceOrder": "sf12377", "requestDate": "2017-07-21 12:32:11", "status": 1, "subject": "game console", "currency": "CLP", "amount": 12000, "payer": "pperez@gamil.com", "optional": { "RUT": "7025521-9", "ID": "899564778" }, "pending_info": { "media": "Multicaja", "date": "2017-07-21 10:30:12" }, "paymentData": { "date": "2017-07-21 12:32:11", "media": "webpay", "conversionDate": "2017-07-21", "conversionRate": 1.1, "amount": 12000, "currency": "CLP", "fee": 551, "balance": 11499, "transferDate": "2017-07-24" }, "merchantId": "string" } ``` -------------------------------- ### Get Payment Status by Commerce ID Source: https://www.flow.cl/docs/api Retrieves the status of a payment using the commerce ID. This endpoint allows merchants to check the status of a transaction based on their own order identifier. ```http GET /payment/getStatus ``` -------------------------------- ### GET /settlement/getByDate Source: https://www.flow.cl/docs/apiFlow_v=7 Retrieves the settlement made for a given date. This method is used to obtain the settlement for the date sent as a parameter. Note: If your settlement is prior to 01-06-2021, use this service; otherwise, it is recommended to use the /settlement/search service. ```APIDOC ## GET /settlement/getByDate ### Description Retrieves the settlement made for a given date. This method is used to obtain the settlement for the date sent as a parameter. Note: If your settlement is prior to 01-06-2021, use this service; otherwise, it is recommended to use the /settlement/search service. ### Method GET ### Endpoint /settlement/getByDate ### Parameters #### Query Parameters - **apiKey** (string) - Required - apiKey of the merchant - **date** (string) - Required - Date of the settlement (format: yyyy-mm-dd) - **s** (string) - Required - Signature of the parameters made with your secretKey. ### Response #### Success Response (200) - The response body will contain the settlement details for the specified date. ``` -------------------------------- ### Payment Create Email Source: https://www.flow.cl/docs/api_changelog Creates a payment order and sends an email with payment instructions. ```APIDOC ## POST /payment/createEmail ### Description Creates a payment order and sends an email to the customer with payment instructions, specifying the expected currency. ### Method POST ### Endpoint /payment/createEmail ### Parameters #### Request Body - **amount** (number) - Required - The amount of the payment. - **currency** (string) - Required - The currency for the payment (e.g., USD, EUR). - **email** (string) - Required - The email address of the customer. ### Response #### Success Response (200) - **orderId** (string) - The ID of the created order. #### Response Example ```json { "orderId": "order_abc" } ``` ``` -------------------------------- ### Payment Create Source: https://www.flow.cl/docs/api_changelog Creates a payment order with a specified currency. ```APIDOC ## POST /payment/create ### Description Creates a payment order, allowing the merchant to specify the currency expected for the payment. ### Method POST ### Endpoint /payment/create ### Parameters #### Request Body - **amount** (number) - Required - The amount of the payment. - **currency** (string) - Required - The currency for the payment (e.g., USD, EUR). ### Response #### Success Response (200) - **orderId** (string) - The ID of the created order. #### Response Example ```json { "orderId": "order_xyz" } ``` ``` -------------------------------- ### Discount Object Source: https://www.flow.cl/docs/apiFlow_v=7 Details of a discount applied to a subscription or customer. ```APIDOC ## Discount Object ### Description Represents a discount applied to a subscription or customer. ### Properties - **id** (number) - Identifier of the discount. - **type** (string) - Type of discount. Can be 'Subscription discount' or 'Customer discount'. - **created** (string) - Date the discount was created. - **start** (string) - Start date of the discount. - **end** (string) - End date of the discount. - **deleted** (string) - Date the discount was deleted, or null if active. - **status** (number) - Status of the discount: 1 for Active, 0 for Inactive. - **coupon** (object) - Coupon details associated with the discount. ``` -------------------------------- ### Customer Subscriptions Source: https://www.flow.cl/docs/api_changelog Retrieves the list of subscriptions for a given customer. ```APIDOC ## GET /customer/getSubscriptions ### Description This endpoint retrieves the list of subscriptions for a customer. ### Method GET ### Endpoint /customer/getSubscriptions ### Parameters #### Query Parameters - **customerId** (string) - Required - The ID of the customer. ### Response #### Success Response (200) - **subscriptions** (array) - A list of subscriptions. - **planExternalId** (string) - The external ID assigned by the merchant to the plan. #### Response Example ```json { "subscriptions": [ { "planExternalId": "plan_abc" } ] } ``` ``` -------------------------------- ### Settlement API Source: https://www.flow.cl/docs/apiFlow_v=7 Endpoints related to settlement operations, including retrieving settlement details and summaries. ```APIDOC ## GET /websites/flow_cl/settlements ### Description Retrieves a list of settlements for a given Flow account. ### Method GET ### Endpoint /websites/flow_cl/settlements ### Parameters #### Query Parameters - **date** (string) - Optional - The date of the settlement to retrieve (format: YYYY-MM-DD). - **limit** (integer) - Optional - The maximum number of settlements to return. - **offset** (integer) - Optional - The number of settlements to skip before returning results. ### Response #### Success Response (200) - **settlements** (array) - An array of settlement objects. - **id** (number) - Identifier of the settlement. - **date** (string) - Date of the settlement. - **rut** (string) - RUT (tax identification number) of the account holder. - **name** (string) - Name of the Flow account user. - **email** (string) - Email address of the Flow user. - **initialBalance** (number) - Initial balance of the account. - **transferred** (number) - Amount to be transferred to the merchant's bank account. - **billed** (number) - Amount to be billed by Flow for this settlement. - **finalBalance** (number) - Final balance of the settlement. A negative final balance means the merchant owes money to Flow, while a positive balance means Flow owes money to the merchant. - **transferredSummary** (array) - Summary of fund transfers. - **billedSummary** (array) - Summary of billing. - **transfersDetail** (array) - Details of bank transfers. - **paymentsDetail** (array) - Details of settlement payments. - **generalReturnsDetail** (array) - Details of general returns. - **refundReturnsDetail** (array) - Details of returned refunds. - **refundWithholdingDetail** (array) - Details of withheld refunds. - **generalWithholdingDetail** (array) - Details of withheld amounts. - **refundBilledDetail** (array) - Details of refunded amounts billed. #### Response Example ```json { "settlements": [ { "id": 1001, "date": "2018-06-15", "rut": "9999999-9", "name": "Francisco Castillo", "email": "fcastillo@gmail.com", "initialBalance": -1000, "transferred": 120000, "billed": 2164, "finalBalance": 0, "transferredSummary": [], "billedSummary": [], "transfersDetail": [], "paymentsDetail": [], "generalReturnsDetail": [], "refundReturnsDetail": [], "refundWithholdingDetail": [], "generalWithholdingDetail": [], "refundBilledDetail": [] } ] } ``` ``` -------------------------------- ### Reverse Charge API Request Source: https://www.flow.cl/docs/apiFlow_v=7 This service allows reversing a previously made charge to a customer. The reversal must be invoked within 24 hours of the charge being made. Parameters can include commerceOrder or flowOrder. ```json { "apiKey": "string", "commerceOrder": "string", "flowOrder": 0, "s": "string" } ``` -------------------------------- ### Error Object Source: https://www.flow.cl/docs/apiFlow_v=7 Structure for API error responses. ```APIDOC ## Error Object ### Description Provides details about an error that occurred during an API request. ### Properties - **code** (number) - Error code. - **message** (string) - Error message describing the issue. ``` -------------------------------- ### Settlement Search Source: https://www.flow.cl/docs/api_changelog Enables searching for settlements within a specified date range. ```APIDOC ## GET /settlement/search ### Description This endpoint allows searching for settlements within a specified date range. ### Method GET ### Endpoint /settlement/search ### Parameters #### Query Parameters - **startDate** (string) - Required - The start date for the search (YYYY-MM-DD). - **endDate** (string) - Required - The end date for the search (YYYY-MM-DD). ### Response #### Success Response (200) - **settlements** (array) - A list of settlements. - **settlementId** (string) - The ID of the settlement. - **date** (string) - The date of the settlement. #### Response Example ```json { "settlements": [ { "settlementId": "s123", "date": "2021-06-07" } ] } ``` ``` -------------------------------- ### Payment Status Extended Source: https://www.flow.cl/docs/api_changelog Retrieves extended information about a payment order using its token. ```APIDOC ## GET /payment/getStatusExtended ### Description This endpoint retrieves extended information about a payment order using its token. ### Method GET ### Endpoint /payment/getStatusExtended ### Parameters #### Query Parameters - **token** (string) - Required - The token of the payment order. ### Response #### Success Response (200) - **paymentData** (object) - Contains details about the payment. - **currency** (string) - The currency used for the payment. - **installments** (integer) - The number of installments. - **authorizationCode** (string) - The authorization code. #### Response Example ```json { "paymentData": { "currency": "USD", "installments": 3, "authorizationCode": "123456" } } ``` ``` -------------------------------- ### Item Types Source: https://www.flow.cl/docs/apiFlow_v=7 Defines the different types of items that can be associated with a transaction or settlement. ```APIDOC ## Item Types ### Description Represents different types of items that can be included in a transaction or settlement. ### Item Types - **1**: Cargo por plan (Plan charge) - **2**: Descuento (Discount) - **3**: Item pendiente (Pending item) - **9**: Otros (Others) ``` -------------------------------- ### Payment Transactions Source: https://www.flow.cl/docs/api_changelog Lists transactions made on a specific day. ```APIDOC ## GET /payment/getTransactions ### Description This endpoint lists the transactions made on a specific day. ### Method GET ### Endpoint /payment/getTransactions ### Parameters #### Query Parameters - **date** (string) - Required - The date for which to list transactions (YYYY-MM-DD). ### Response #### Success Response (200) - **transactions** (array) - A list of transactions. - **transactionId** (string) - The ID of the transaction. - **amount** (number) - The amount of the transaction. #### Response Example ```json { "transactions": [ { "transactionId": "txn_123", "amount": 100.50 } ] } ``` ``` -------------------------------- ### Payment Status By Flow Order Extended Source: https://www.flow.cl/docs/api_changelog Retrieves extended information about a payment order using its Flow order number. ```APIDOC ## GET /payment/getStatusByFlowOrderExtended ### Description This endpoint retrieves extended information about a payment order using its Flow order number. ### Method GET ### Endpoint /payment/getStatusByFlowOrderExtended ### Parameters #### Query Parameters - **flowOrderNumber** (string) - Required - The Flow order number. ### Response #### Success Response (200) - **paymentData** (object) - Contains details about the payment. - **currency** (string) - The currency used for the payment. - **installments** (integer) - The number of installments. - **authorizationCode** (string) - The authorization code. #### Response Example ```json { "paymentData": { "currency": "EUR", "installments": 6, "authorizationCode": "abcdef" } } ``` ``` -------------------------------- ### Retry Invoice Collection - API Source: https://www.flow.cl/docs/apiFlow_v=7 Attempts to retry the collection for a given overdue invoice. Requires an API key, invoice ID, and a signature (s). ```openapi /invoice/retryToCollect: post: tags: - invoice summary: "Reintenta el cobro de un invoice vencido" description: "Este servicio permite reintentar el cobro de un Invoice vencido." responses: '200': description: "El objeto Invoice" content: application/json: schema: $ref: '#/components/schemas/Invoice' '400': description: Error del Api content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Error de negocio content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: apiKey: description: apiKey del comercio type: string invoiceId: description: Identificador del Invoice (Importe) type: number s: description: la firma de los parámetros efectuada con su secretKey. type: string required: - apiKey - invoiceId - s ``` -------------------------------- ### POST /invoice/retryToCollect Source: https://www.flow.cl/docs/apiFlow_v=7 Retries the collection of an overdue invoice. This service allows you to retry the collection of an overdue Invoice. ```APIDOC ## POST /invoice/retryToCollect ### Description Retries the collection of an overdue invoice. This service allows you to retry the collection of an overdue Invoice. ### Method POST ### Endpoint /invoice/retryToCollect ### Parameters #### Request Body - **apiKey** (string) - Required - apiKey of the merchant - **invoiceId** (number) - Required - Invoice identifier (Amount) - **s** (string) - Required - Signature of the parameters made with your secretKey. ### Request Example ```json { "apiKey": "your_api_key", "invoiceId": 12345, "s": "your_signature" } ``` ### Response #### Success Response (200) - **Invoice** (object) - The Invoice object #### Error Response (400, 401) - **Error** (object) - API or business error details ``` -------------------------------- ### Invoice Outside Payment Source: https://www.flow.cl/docs/api_changelog Allows a merchant to mark an invoice as paid outside of the system. ```APIDOC ## POST /invoice/outsidePayment ### Description This endpoint allows a merchant to mark an invoice associated with a subscription as paid outside the system. ### Method POST ### Endpoint /invoice/outsidePayment ### Parameters #### Request Body - **invoiceId** (string) - Required - The ID of the invoice. - **amount** (number) - Required - The amount paid. ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "paid" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.