Merge pull request #120 from tolu-paystack/docs/add-transfer-export

Add Transfer Export endpoint

Author: tolu-paystack

dist/api/transfers/export/requests.js

@@ -0,0 +1,65 @@
+const sh = `#!/bin/sh
+url="https://api.paystack.co/transfer/export"
+authorization="Authorization: Bearer YOUR_SECRET_KEY"
+
+curl "$url" -H "$authorization" -X GET
+`
+
+const js = `const https = require('https')
+
+const options = {
+  hostname: 'api.paystack.co',
+  port: 443,
+  path: '/transfer/export',
+  method: 'GET',
+  headers: {
+    Authorization: 'Bearer SECRET_KEY'
+  }
+}
+
+https.request(options, res => {
+  let data = ''
+
+  res.on('data', (chunk) => {
+    data += chunk
+  });
+
+  res.on('end', () => {
+    console.log(JSON.parse(data))
+  })
+}).on('error', error => {
+  console.error(error)
+})
+`
+
+const php = `<?php
+  $curl = curl_init();
+  
+  curl_setopt_array($curl, array(
+    CURLOPT_URL => "https://api.paystack.co/transfer/export",
+    CURLOPT_RETURNTRANSFER => true,
+    CURLOPT_ENCODING => "",
+    CURLOPT_MAXREDIRS => 10,
+    CURLOPT_TIMEOUT => 30,
+    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+    CURLOPT_CUSTOMREQUEST => "GET",
+    CURLOPT_HTTPHEADER => array(
+      "Authorization: Bearer SECRET_KEY",
+      "Cache-Control: no-cache",
+    ),
+  ));
+  
+  $response = curl_exec($curl);
+  $err = curl_error($curl);
+
+  curl_close($curl);
+  
+  if ($err) {
+    echo "cURL Error #:" . $err;
+  } else {
+    echo $response;
+  }
+?>
+`
+
+export {sh, js, php}

dist/api/transfers/export/response.json

@@ -0,0 +1,7 @@
+{
+  "status": true,
+  "message": "Export successful",
+  "data": {
+    "path": "https://files.paystack.co/exports/100032/1460290758207.csv"
+  }
+}

src/api/transfers/export/config.yml

@@ -0,0 +1,4 @@
+languages:
+  - sh
+  - js
+  - php

src/api/transfers/export/index.js

@@ -0,0 +1,25 @@
+const https = require('https')
+
+const options = {
+  hostname: 'api.paystack.co',
+  port: 443,
+  path: '/transfer/export',
+  method: 'GET',
+  headers: {
+    Authorization: 'Bearer SECRET_KEY'
+  }
+}
+
+https.request(options, res => {
+  let data = ''
+
+  res.on('data', (chunk) => {
+    data += chunk
+  });
+
+  res.on('end', () => {
+    console.log(JSON.parse(data))
+  })
+}).on('error', error => {
+  console.error(error)
+})

src/api/transfers/export/index.php

@@ -0,0 +1,28 @@
+<?php
+  $curl = curl_init();
+  
+  curl_setopt_array($curl, array(
+    CURLOPT_URL => "https://api.paystack.co/transfer/export",
+    CURLOPT_RETURNTRANSFER => true,
+    CURLOPT_ENCODING => "",
+    CURLOPT_MAXREDIRS => 10,
+    CURLOPT_TIMEOUT => 30,
+    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+    CURLOPT_CUSTOMREQUEST => "GET",
+    CURLOPT_HTTPHEADER => array(
+      "Authorization: Bearer SECRET_KEY",
+      "Cache-Control: no-cache",
+    ),
+  ));
+  
+  $response = curl_exec($curl);
+  $err = curl_error($curl);
+
+  curl_close($curl);
+  
+  if ($err) {
+    echo "cURL Error #:" . $err;
+  } else {
+    echo $response;
+  }
+?>

src/api/transfers/export/index.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+url="https://api.paystack.co/transfer/export"
+authorization="Authorization: Bearer YOUR_SECRET_KEY"
+
+curl "$url" -H "$authorization" -X GET

src/api/transfers/export/response.json

@@ -0,0 +1,7 @@
+{
+  "status": true,
+  "message": "Export successful",
+  "data": {
+    "path": "https://files.paystack.co/exports/100032/1460290758207.csv"
+  }
+}