Payment-Refund details

GET/payment/{payment_reference}/refunds

Get the details of the refund, including current status via payment reference.

Path Parameters

payment_referencestringrequired

Unique payment reference number given by the Payment Request

Response

Success

refund_currencystring

The local currency equivalent of the refund. This should be a 3-character ISO 4217 currency code. Please ignore if the refund is in cryptocurrency.

refund_amountnumber<float>

The local currency amount to be refunded. Please ignore if the refund is in cryptocurrency.

remain_amountnumber<float>

The remaining local currency amount of the payment after being refunded. Please ignore if the refund is in cryptocurrency.

refund_crypto_currencystring

Cryptocurrency that will be paid out. Please ignore if the refund is in local currency.

refund_crypto_amountnumber<float>

The cryptocurrency amount to be refunded. Please ignore if the refund is in local currency.

remain_crypto_amountnumber<float>

The remaining cryptocurrency amount of the payment after being refunded. Please ignore if the refund is in local currency.

refundsobject[]

Show refunds properties

payout_referencestring

Unique payout reference number

type"withdraw" | "refund"

The type of payout:

refund - A partial or complete refund of a prior successful payment.
withdraw - A settlement of the merchant’s accumulated USD balance in cryptocurrency.

local_currencystring

The local currency equivalent of the payout. This should be a 3-character ISO 4217 currency code. Please ignore if the payout is in cryptocurrency.

local_amountnumber<float>

The local currency amount to be paid out. Please ignore if the payout is in cryptocurrency.

crypto_currencystring

Cryptocurrency that will be paid out. Please ignore if the payout is in local currency.

crypto_amountnumber<float>

Amount of cryptocurrency to be paid out if the settlement is in cryptocurrency.

display_crypto_currencystring

Cryptocurrency that will displayed. Please ignore if the payout is in local currency.

network_fee_crypto_amountnumber<float>

Amount of cryptocurrency representing the network fee. This is denominated in crypto_currency.

net_crypto_amountnumber<float>

Amount of cryptocurrency after deduction of the network_fee_crypto_amount.

exchange_ratenumber<float>

The exchange rate that will be used to exchange local currency to cryptocurrency or vice-versa.

crypto_addressstring

Address that recipient will receive the payout at.

status"new" | "confirm" | "done" | "cancel"

The current status of the payout:

new - The payout has just been created, but the recipient has not entered in their receiving crypto address and the exchange rate has not been fixed.
confirm - The recipient has confirmed their receiving crypto address and the exchange rate has been fixed.
done - The crypto payout has been broadcast to the blockchain.
cancel - The crypto payout has been cancelled.

status_datestring<date-time>

Date and time the status was updated

merchant_namestring

Name of the merchant

remarksstring

Remarks for the payout

account_type"local"

Account type the funds are drawn from: local - Funds are drawn from a local currency account

convert_type"local-local" | "local-crypto"

Type of conversion the funds underwent:

local-local - Funds are drawn from a local currency account and paid out as local currency.
local-crypto - Funds are drawn from a local currency account and paid out as cryptocurrency.

order_idstring

Your system unique order id. You will get this in the notification webhook data, if you insert your unique order_id in the request body during the payout/settlement creation.

Not authorized

messagestring

No permission to view details of this refund

messagestring

Refund not found

messagestring

const response = await fetch(`https://api.triple-a.io/api/v2/payment/${payment_reference}/refunds`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>' } }); const data = await response.json();

import requests response = requests.request( "GET", "https://api.triple-a.io/api/v2/payment/{payment_reference}/refunds", headers={ "Authorization": "Bearer <token>" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.triple-a.io/api/v2/payment/<payment_reference>/refunds"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://api.triple-a.io/api/v2/payment/<payment_reference>/refunds", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.triple-a.io/api/v2/payment/<payment_reference>/refunds")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.triple-a.io/api/v2/payment/<payment_reference>/refunds") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

{ "refund_currency": "USD", "refund_amount": 6, "remain_amount": 0, "refund_crypto_currency": "testBTC", "refund_crypto_amount": 0, "remain_crypto_amount": 0, "refunds": [ { "payout_reference": "DNU-645266-PYT", "type": "refund", "local_currency": "USD", "local_amount": "1", "crypto_currency": "testBTC", "crypto_amount": "0.00005168", "display_crypto_currency": "testBTC", "network_fee_crypto_amount": "0", "net_crypto_amount": "0.00005168", "exchange_rate": "19349.85", "crypto_address": "1NcAyv8YVCnQGCrDb4kiUm1jj6GLyowxER", "status": "cancel", "status_date": "2022-06-18T10:50:34.741Z", "merchant_name": "A to Z Toys and Games", "remarks": "Refund for a water pistol", "account_type": "local", "convert_type": "local-crypto", "order_id": "your_order_id" } ] }