List refunds for a payout - Spendin API

List refunds for a payout

curl --request GET \
  --url https://api.spendin.app/v1/payouts/{payout_id}/refunds \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.spendin.app/v1/payouts/{payout_id}/refunds', 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.spendin.app/v1/payouts/{payout_id}/refunds",
  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-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.spendin.app/v1/payouts/{payout_id}/refunds"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.spendin.app/v1/payouts/{payout_id}/refunds")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "id": "<string>",
    "payout_id": "<string>",
    "inflow_id": {},
    "received_amount": 42.32,
    "received_currency": "USDT",
    "network_fee_amount": 1,
    "network_fee_currency": "USDT",
    "refund_amount": 41.32,
    "refund_currency": "USDT",
    "destination_provider_name": "USDT (TRC-20)",
    "destination_masked": "TXyz...abcd",
    "processor_reference": {},
    "failure_reason": {},
    "attempt_number": 1,
    "dispatched_at": {},
    "settled_at": {},
    "created_at": "<string>"
  }
]

GET

/

v1

/

payouts

/

{payout_id}

/

refunds

List refunds for a payout

curl --request GET \
  --url https://api.spendin.app/v1/payouts/{payout_id}/refunds \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.spendin.app/v1/payouts/{payout_id}/refunds', 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.spendin.app/v1/payouts/{payout_id}/refunds",
  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-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.spendin.app/v1/payouts/{payout_id}/refunds"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.spendin.app/v1/payouts/{payout_id}/refunds")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "id": "<string>",
    "payout_id": "<string>",
    "inflow_id": {},
    "received_amount": 42.32,
    "received_currency": "USDT",
    "network_fee_amount": 1,
    "network_fee_currency": "USDT",
    "refund_amount": 41.32,
    "refund_currency": "USDT",
    "destination_provider_name": "USDT (TRC-20)",
    "destination_masked": "TXyz...abcd",
    "processor_reference": {},
    "failure_reason": {},
    "attempt_number": 1,
    "dispatched_at": {},
    "settled_at": {},
    "created_at": "<string>"
  }
]

Authorizations

X-API-Key

string

header

required

Path Parameters

payout_id

string<uuid>

required

Response

200 - application/json

id

string

required

payout_id

string

required

The failed payout this refund returns

inflow_id

object | null

required

The inflow whose money is being sent back

status

enum<string>

required

Available options:

PENDING,

PROCESSING,

SUCCESSFUL,

FAILED

received_amount

number

required

What the merchant originally sent us

Example:

42.32

received_currency

string

required

Example:

"USDT"

network_fee_amount

number

required

Cost of sending the refund back out

Example:

1

network_fee_currency

string

required

Example:

"USDT"

refund_amount

number

required

received_amount minus network_fee_amount

Example:

41.32

refund_currency

string

required

Example:

"USDT"

destination_type

enum<string>

required

Available options:

BANK_ACCOUNT,

CRYPTO_ADDRESS

destination_provider_name

string

required

Example:

"USDT (TRC-20)"

destination_masked

string

required

Masked account number or address

Example:

"TXyz...abcd"

destination_network

enum<string> | null

required

Available options:

TRON,

BSC

processor_reference

object | null

required

failure_reason

object | null

required

attempt_number

number

required

Example:

1

dispatched_at

object | null

required

settled_at

object | null

required

created_at

string

required

⌘I