--- updatedAt: 2025-06-12T00:06:18.000Z agentTools: projectIndex: https://developers.tap.company/llms.txt --- # Download Refunds This endpoint allows you to retrieve a list of refunds with detailed information for each refund. The response returned can be saved in a CSV file. Each row represents a refund with its respective details, and the first row contains the headers describing each field. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "refunds.", "version": "1.0" }, "servers": [ { "url": "https://api.tap.company/v2/refunds" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer", "x-default": "sk_test_XKokBfNWv6FIYuTMg5sLPjhJ" } } }, "security": [ { "sec0": [] } ], "paths": { "/download": { "post": { "summary": "Download Refunds", "description": "This endpoint allows you to retrieve a list of refunds with detailed information for each refund. The response returned can be saved in a CSV file. Each row represents a refund with its respective details, and the first row contains the headers describing each field.", "operationId": "download-refunds", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "object", "description": "Retrieve charges for a selected period", "properties": { "date": { "type": "object", "description": "Retrieve Refunds during a selected date.", "properties": { "from": { "type": "integer", "description": "From date (Refunds created date), Measured in seconds since the Unix epoch", "format": "int32" }, "to": { "type": "integer", "description": "To date (Refunds created date), Measured in seconds since the Unix epoch", "format": "int32" } } } } }, "merchants": { "type": "array", "description": "List of merchant IDs for which the charges are being queried", "default": [ "599242" ], "items": { "type": "string" } }, "payouts": { "type": "object", "description": "Retrieve charges based on payouts", "properties": {} }, "status": { "type": "string", "description": "Retrieve the selected list of charges info by charge status. Values can be: INITIATED, IN_PROGRESS, ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, CAPTURED, VOID, TIMEDOUT or UNKNOWN" }, "sources": { "type": "array", "description": "Array of sources (you can specify the list of Source ID's to retrieve).", "items": { "type": "string" } }, "payment_methods": { "type": "array", "description": "Array of payment methods (you can specify the list of payment method Source ID's to retrieve).", "items": { "type": "string" } }, "customers": { "type": "array", "description": "Array of customers (you can specify the list of Customer ID's to retrieve).", "items": { "type": "string" } }, "charges": { "type": "array", "description": "Array of charges (you can specify the list of Source ID's to retrieve).", "items": { "type": "string" } }, "starting_after": { "type": "string", "description": "A cursor for use in pagination. The starting_after parameter takes a charge ID that determines your position in the list. For example, if your list request returns 50 charges that end with cus_foo, you can use starting_after=cus_foo in your next call to retrieve the next page of the list." }, "charge_created": { "type": "string", "description": "Created date (charge created date), Measured in Unix Epoch Timestamp (milliseconds)." }, "mobile": { "type": "string", "description": "Filter the results based on customer mobile number" }, "email": { "type": "string", "description": "filter the results based on customer email" }, "limit": { "type": "string", "description": "The maximum number of charges to return in a single call. Default: 25; Maximum: 50." }, "order": { "type": "string", "description": "Sort the results Ascending or Descending by date" }, "order_by": { "type": "string", "description": "Defaults to date" }, "metadata": { "type": "object", "description": "Filter the results based on meta data values", "properties": { "key": { "type": "string", "description": "Any key that will help you to identify the value, and the value is the data related to this process and you want to refer to it.", "default": "value" }, "": { "type": "string" } } }, "currency": { "type": "string", "description": "Filter the charges based on charge currency" }, "reference": { "type": "object", "properties": { "merchant": { "type": "string", "description": "The merchant reference associated with this refund.", "default": "1234" }, "idempotent": { "type": "string", "description": "The idempotent string to restrict duplicate payments. If the same idempotent string is passed, a new refund will not be initiated, whereas the response of the first refund will be returned." } } }, "dispute": { "type": "boolean", "description": "To filter the disputes in the refunds, `false` will return the refunds without the disputes, and `true` will return the disputes only", "default": false }, "additional_fields": { "type": "array", "description": "To return additional columns in the refunds report", "default": [ "dispute" ], "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "200", "content": { "text/plain": { "examples": { "Result": { "value": "{}payout_id,settlement_id,charge_id,currency,amount,status,authorization_id,status_code,status_message,gateway_code,gateway_message,issuer_code,issuer_message,charge_date,capture_date,post_date,settlement_date,payout_date,track_id,reference_gateway,reference_acquirer,reference_transaction,reference_order,receipt,customer_id,customer_name,customer_phone_code,customer_phone,customer_email,first_eight,last_four,issuer_country,payment_method,payment_scheme,payment_type,merchant_id,product,post_currency,post_amount,fee,fee_vat,net_amount,metadata_1,metadata_2,metadata_3,metadata_4,metadata_5\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 12:43 AM,28/07/2024 12:44 AM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,CREDIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 10:33 AM,28/07/2024 10:35 AM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,MASTERCARD,MASTERCARD,CREDIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 11:50 AM,28/07/2024 11:52 AM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,MASTERCARD,DEBIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 11:58 AM,28/07/2024 11:59 AM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,VISA,VISA,CREDIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 12:02 PM,28/07/2024 12:03 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,DEBIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 12:12 PM,28/07/2024 12:13 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,CREDIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 12:16 PM,28/07/2024 12:16 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,DEBIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 01:38 PM,28/07/2024 01:38 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,CREDIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 02:50 PM,28/07/2024 02:50 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,MASTERCARD,DEBIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 02:57 PM,28/07/2024 02:57 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,CREDIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,160.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 03:00 PM,28/07/2024 03:00 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,CREDIT,599242,GOSELL,AED,160.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,200.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 06:25 PM,28/07/2024 06:26 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,DEBIT,599242,GOSELL,AED,200.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,950.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 06:28 PM,28/07/2024 06:28 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,VISA,CREDIT,599242,GOSELL,AED,950.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,160.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 07:39 PM,28/07/2024 07:39 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,MASTERCARD,DEBIT,599242,GOSELL,AED,160.000,xxx,0.000,xxx,,,,,\npayout_xxxx,settlement_xxxx,chg_xxxx,AED,160.000,CAPTURED,xxxx,\"000 \",Captured,\"0 \",Transaction Approved,\"00 \",Approved,28/07/2024 07:41 PM,28/07/2024 07:42 PM,28/07/2024,04/08/2024,04/08/2024,tck_xxxx,\"xxxx\",xxxx,\"xxxx-xxxx-xxxx-xxx\",\"xxxx-xxxx-xxxx-xxxx\",\"xxxx\",cus_xxxx,John Doe,965,\"xxxxx\",test@hotmail.com,xxxxxx,xxxx,QA,APPLE_PAY,MASTERCARD,DEBIT,599242,GOSELL,AED,160.000,xxx,0.000,xxx,,,,," } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```