{ "item": [ { "name": "Settlement Report API Calls", "description": "API Calls to retrieve the Settlement Report data", "item": [ { "id": "acfb56aa-7e42-4917-a73e-1c44dcf1f4aa", "name": "GetSettlementReport", "request": { "name": "GetSettlementReport", "description": { "content": "\nThis API call is used to retrieve the Settlement Report data.\n", "type": "text/plain" }, "url": { "path": [ "settlement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The start date of the transactions to be retrieved.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "(Required) The end date of the transactions to be retrieved. Regardless of the date from/to, the default time values are 00:00 to 23:59. Maximum allowed search is 12 months at once.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "The Merchant ID is the unique alphanumeric merchant identifier and defines the transaction currency. If a MID is not specified, all transactions for all MIDs assigned to the API key in use will be retrieved.", "type": "text/plain" }, "key": "mid", "value": "" }, { "disabled": false, "description": { "content": "The Merchant ID is the unique alphanumeric merchant identifier and defines the transaction currency. If a MID is not specified, all transactions for all MIDs assigned to the API key in use will be retrieved.", "type": "text/plain" }, "key": "mid", "value": "" }, { "disabled": false, "description": { "content": "The sub merchant Id, also known as reporting criteria. If a submerchant Id is not specified, all transactions for all submerchant Ids assigned to the MID will be retrieved. Called reporting_criteria before v4.", "type": "text/plain" }, "key": "submerchant_id", "value": "" }, { "disabled": false, "description": { "content": "The customer Id is the end customer unique identifier. All transactions done by the same customer must have the same customer Id. This parameter is provided by the business partner at the start of each transaction. Called merchant_client_id before v4.", "type": "text/plain" }, "key": "customer_id", "value": "" }, { "disabled": false, "description": { "content": "The invoice number is the 10-digit number of a created invoice. With this parameter, specific transactions by using an invoice number can be retrieved. The result will display all invoice related transactions.", "type": "text/plain" }, "key": "invoice_number", "value": "" }, { "disabled": false, "description": { "content": "Only transactions of the specified type are returned. Valid values are PAYMENT, REFUND, PAYOUT. This parameter can be used multiple times in a request to include more than one transaction type in the result and defaults to PAYMENT. (added in v3).", "type": "text/plain" }, "key": "transaction_type", "value": "" }, { "disabled": false, "description": { "content": "Indicates whether the CSV should include the header line.", "type": "text/plain" }, "key": "include_header", "value": "" }, { "disabled": false, "description": { "content": "If a single my PaysafeCard customer needs to be searched, this parameter can be used. Only numeric values are possible. (added in v3)", "type": "text/plain" }, "key": "customer_psc_id", "value": "" }, { "disabled": false, "description": { "content": "A transaction unique identifier. If a single transaction needs to be searched, this parameter can be used. (added in v3)", "type": "text/plain" }, "key": "transaction_id", "value": "" }, { "disabled": false, "description": { "content": "The payment method used. Valid values are PAYSAFECARD, PAYSAFECASH, GIFTCARD, PAGOEFECTIVO, SAFETYPAY (added in v6)", "type": "text/plain" }, "key": "payment_instrument", "value": "" }, { "disabled": false, "description": { "content": "Last 16 digits of PaysafeCash barcode. (added in v7)", "type": "text/plain" }, "key": "transaction_reference", "value": "" }, { "disabled": false, "description": { "content": "Full PaysafeCash barcode. (added in v7)", "type": "text/plain" }, "key": "barcode_number", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "8f2023a7-644b-4218-9f4c-8fc51d4e671d", "name": "Settlement Report request successful - data returned, if it was available", "originalRequest": { "url": { "path": [ "settlement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The start date of the transactions to be retrieved.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "(Required) The end date of the transactions to be retrieved. Regardless of the date from/to, the default time values are 00:00 to 23:59. Maximum allowed search is 12 months at once.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "The Merchant ID is the unique alphanumeric merchant identifier and defines the transaction currency. If a MID is not specified, all transactions for all MIDs assigned to the API key in use will be retrieved.", "type": "text/plain" }, "key": "mid", "value": "" }, { "disabled": false, "description": { "content": "The sub merchant Id, also known as reporting criteria. If a submerchant Id is not specified, all transactions for all submerchant Ids assigned to the MID will be retrieved. Called reporting_criteria before v4.", "type": "text/plain" }, "key": "submerchant_id", "value": "" }, { "disabled": false, "description": { "content": "The customer Id is the end customer unique identifier. All transactions done by the same customer must have the same customer Id. This parameter is provided by the business partner at the start of each transaction. Called merchant_client_id before v4.", "type": "text/plain" }, "key": "customer_id", "value": "" }, { "disabled": false, "description": { "content": "The invoice number is the 10-digit number of a created invoice. With this parameter, specific transactions by using an invoice number can be retrieved. The result will display all invoice related transactions.", "type": "text/plain" }, "key": "invoice_number", "value": "" }, { "disabled": false, "description": { "content": "Only transactions of the specified type are returned. Valid values are PAYMENT, REFUND, PAYOUT. This parameter can be used multiple times in a request to include more than one transaction type in the result and defaults to PAYMENT. (added in v3).", "type": "text/plain" }, "key": "transaction_type", "value": "" }, { "disabled": false, "description": { "content": "Indicates whether the CSV should include the header line.", "type": "text/plain" }, "key": "include_header", "value": "" }, { "disabled": false, "description": { "content": "If a single my PaysafeCard customer needs to be searched, this parameter can be used. Only numeric values are possible. (added in v3)", "type": "text/plain" }, "key": "customer_psc_id", "value": "" }, { "disabled": false, "description": { "content": "A transaction unique identifier. If a single transaction needs to be searched, this parameter can be used. (added in v3)", "type": "text/plain" }, "key": "transaction_id", "value": "" }, { "disabled": false, "description": { "content": "The payment method used. Valid values are PAYSAFECARD, PAYSAFECASH, GIFTCARD, PAGOEFECTIVO, SAFETYPAY (added in v6)", "type": "text/plain" }, "key": "payment_instrument", "value": "" }, { "disabled": false, "description": { "content": "Last 16 digits of PaysafeCash barcode. (added in v7)", "type": "text/plain" }, "key": "transaction_reference", "value": "" }, { "disabled": false, "description": { "content": "Full PaysafeCash barcode. (added in v7)", "type": "text/plain" }, "key": "barcode_number", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07daa5f6-7312-49ac-8a10-eb0acf895240", "name": "Invalid request parameter. One of the request parameters failed validation. The message and param fields contain more detailed information.", "originalRequest": { "url": { "path": [ "settlement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The start date of the transactions to be retrieved.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "(Required) The end date of the transactions to be retrieved. Regardless of the date from/to, the default time values are 00:00 to 23:59. Maximum allowed search is 12 months at once.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "The Merchant ID is the unique alphanumeric merchant identifier and defines the transaction currency. If a MID is not specified, all transactions for all MIDs assigned to the API key in use will be retrieved.", "type": "text/plain" }, "key": "mid", "value": "" }, { "disabled": false, "description": { "content": "The sub merchant Id, also known as reporting criteria. If a submerchant Id is not specified, all transactions for all submerchant Ids assigned to the MID will be retrieved. Called reporting_criteria before v4.", "type": "text/plain" }, "key": "submerchant_id", "value": "" }, { "disabled": false, "description": { "content": "The customer Id is the end customer unique identifier. All transactions done by the same customer must have the same customer Id. This parameter is provided by the business partner at the start of each transaction. Called merchant_client_id before v4.", "type": "text/plain" }, "key": "customer_id", "value": "" }, { "disabled": false, "description": { "content": "The invoice number is the 10-digit number of a created invoice. With this parameter, specific transactions by using an invoice number can be retrieved. The result will display all invoice related transactions.", "type": "text/plain" }, "key": "invoice_number", "value": "" }, { "disabled": false, "description": { "content": "Only transactions of the specified type are returned. Valid values are PAYMENT, REFUND, PAYOUT. This parameter can be used multiple times in a request to include more than one transaction type in the result and defaults to PAYMENT. (added in v3).", "type": "text/plain" }, "key": "transaction_type", "value": "" }, { "disabled": false, "description": { "content": "Indicates whether the CSV should include the header line.", "type": "text/plain" }, "key": "include_header", "value": "" }, { "disabled": false, "description": { "content": "If a single my PaysafeCard customer needs to be searched, this parameter can be used. Only numeric values are possible. (added in v3)", "type": "text/plain" }, "key": "customer_psc_id", "value": "" }, { "disabled": false, "description": { "content": "A transaction unique identifier. If a single transaction needs to be searched, this parameter can be used. (added in v3)", "type": "text/plain" }, "key": "transaction_id", "value": "" }, { "disabled": false, "description": { "content": "The payment method used. Valid values are PAYSAFECARD, PAYSAFECASH, GIFTCARD, PAGOEFECTIVO, SAFETYPAY (added in v6)", "type": "text/plain" }, "key": "payment_instrument", "value": "" }, { "disabled": false, "description": { "content": "Last 16 digits of PaysafeCash barcode. (added in v7)", "type": "text/plain" }, "key": "transaction_reference", "value": "" }, { "disabled": false, "description": { "content": "Full PaysafeCash barcode. (added in v7)", "type": "text/plain" }, "key": "barcode_number", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.paysafecard.com/v7/reports" } ], "info": { "_postman_id": "48464768-7d77-4873-b690-9ff6f2cfde15", "name": "Settlement Report API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Overview\n\nThis is an API request to retrieve the Settlement Report for merchants.\n\n## Authentication\n\nAuthentication is performed using HTTP Basic Authentication.\n\nThe Authorization header must contain a Base64-encoded value of the provided `API Key`\n\ni.e.: the provided API Key is `psc_abc****************************`\n\nThe value that needs to be provided in the Authorization Header is:\n\n```\nBasic cHNabc*****************************************=\n```\n", "type": "text/plain" } } }