Retrieve Payout by Merchant Reference

GET /payouts

Retrieve Payout by Merchant Reference

cURL

curl --request GET \
  --url https://api-sandbox.y.uno/v1/payouts \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

import requests

url = "https://api-sandbox.y.uno/v1/payouts"

headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/payouts', 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/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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/v1/payouts"

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

	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/v1/payouts")
  .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/v1/payouts")

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

request = Net::HTTP::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'

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

200

[
  {
    "id": "565c9733-000d-4066-a4bf-b084908dc74c",
    "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c",
    "status": "SUCCEEDED",
    "merchant_reference": "MR-Test-12345",
    "purpose": "",
    "country": "US",
    "description": "Test",
    "amount": {
      "currency": "USD",
      "value": 100
    },
    "beneficiary": {
      "merchant_beneficiary_id": "test_merchant_deposit_id",
      "national_entity": "INDIVIDUAL",
      "first_name": "John",
      "last_name": "Doe",
      "legal_name": "John Doe",
      "email": "[e-mail]",
      "country": "US",
      "date_of_birth": "1980-01-01",
      "document": {
        "document_type": "SSN",
        "document_number": "123-45-6789"
      },
      "phone": {
        "country_code": "1",
        "number": "1234567890"
      },
      "address": {
        "address_line_1": "123 Main St",
        "address_line_2": "Apt 1",
        "country": "US",
        "state": "NY",
        "city": "New York",
        "zip_code": "10001"
      }
    },
    "metadata": [],
    "created_at": "2024-05-27T15:17:30.952178Z",
    "updated_at": "2024-05-27T15:17:32.901454Z",
    "transactions": [
      {
        "id": "bd594d5c-d7b7-48b1-9678-0b5052a69863",
        "status": "SUCCEEDED",
        "type": "ASTROPAY_PAYOUT",
        "response_code": "SUCCEEDED",
        "merchant_reference": "MR-Test-12345",
        "purpose": "",
        "description": "Test",
        "amount": {
          "currency": "USD",
          "value": 100
        },
        "withdrawal_method": {
          "type": "ASTROPAY_PAYOUT",
          "detail": {
            "bank_transfer": null,
            "wallet": {
              "code": "h15sg84U6rCl",
              "email": null,
              "country": null,
              "document": null,
              "phone": null
            }
          }
        },
        "provider_data": {
          "id": "ASTROPAY",
          "transaction_id": "32376",
          "account_id": "",
          "beneficiary_id": "test_merchant_deposit_id",
          "status": "APPROVED",
          "status_detail": "APPROVED",
          "raw_response": "\"{\\n  \\\"cashout_id\\\" : 32376,\\n  \\\"merchant_cashout_id\\\" : \\\"bd594d5c-d7b7-48b1-9678-0b5052a69863\\\",\\n  \\\"status\\\" : \\\"APPROVED\\\",\\n  \\\"user_id\\\" : \\\"h15sg84U6rCl\\\"\\n}\""
        },
        "created_at": "2024-05-27T15:17:31.265607Z",
        "updated_at": "2024-05-27T15:17:32.901448Z"
      }
    ]
  }
]

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

This request enables you to retrieve details of a payout based on the merchant_reference, which needs to be provided as a query param.

Authorizations

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

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

Query Parameters

merchant_reference · string · required

Identification of the payout defined by the merchant.

Response

200

application/json

200

id · string

Example:

"565c9733-000d-4066-a4bf-b084908dc74c"

account_id · string

Example:

"f7c5fe77-721b-49c2-84d3-957748df3c2c"

status · string

Example:

"SUCCEEDED"

merchant_reference · string

Example:

"MR-Test-12345"

purpose · string

Example:

""

country · string

Example:

"US"

description · string

Example:

"Test"

amount · object

Show child attributes

beneficiary · object

Show child attributes

metadata · array

created_at · string

Example:

"2024-05-27T15:17:30.952178Z"

updated_at · string

Example:

"2024-05-27T15:17:32.901454Z"

transactions · object[]

Show child attributes