Download a Report

GET /reports/{report_id}/download

Download a Report

cURL

curl --request GET \
  --url https://api-sandbox.y.uno/v2/reports/{report_id}/download \
  --header 'X-Organization-Code: <x-organization-code>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

import requests

url = "https://api-sandbox.y.uno/v2/reports/{report_id}/download"

headers = {
    "X-Organization-Code": "<x-organization-code>",
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Organization-Code': '<x-organization-code>',
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>'
  }
};

fetch('https://api-sandbox.y.uno/v2/reports/{report_id}/download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v2/reports/{report_id}/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Organization-Code: <x-organization-code>",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v2/reports/{report_id}/download"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Organization-Code", "<x-organization-code>")
	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v2/reports/{report_id}/download")
  .header("X-Organization-Code", "<x-organization-code>")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v2/reports/{report_id}/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Organization-Code"] = '<x-organization-code>'
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "type": "TRANSACTIONS",
  "download_link": "https://s3.amazonaws.com/.../report.csv",
  "status": "AVAILABLE"
}

{
  "code": "INVALID_REQUEST",
  "messages": [
    "Invalid request"
  ]
}

{
  "code": "INVALID_CREDENTIALS",
  "messages": [
    "Invalid credentials"
  ]
}

{
  "code": "AUTHORIZATION_REQUIRED",
  "messages": [
    "The merchant has no authorization to use this API."
  ]
}

Recent endpoint update

This endpoint was recently updated to version 2 (see “V2” in the URL). Version 1 has been deprecated, we recommend switching to V2 as soon as possible.

To retrieve the file content, use your API credentials to access the file specified by the report object id.

Downloading reports

The API response will include a link with to download the report. Open the link through your browser to access the data.

Explore the following links to access various report examples:

Payments

Settlements & Fees

Transaction Report

Reconciliation Overview

Communications

Authorizations

public-api-key · string · header · default: <Your public-api-key> · required

private-secret-key · string · header · default: <Your private-secret-key> · required

Headers

X-Organization-Code · string · required

Organization code associated to the request.

Path Parameters

report_id · string · required

The report unique identifier.

Response

200

application/json

200

type · string

Example:

"TRANSACTIONS"

download_link · string

Example:

"https://s3.amazonaws.com/.../report.csv"

status · string

Example:

"AVAILABLE"