Get Refund Payments | Refunds API

curl --request GET \
  --url https://api.atoa.me/api/refund/{paymentRequestId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.atoa.me/api/refund/{paymentRequestId}', 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.atoa.me/api/refund/{paymentRequestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.atoa.me/api/refund/{paymentRequestId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.atoa.me/api/refund/{paymentRequestId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "refundId": "a7c82e45-9f31-42b6-8d15-7e63f1b92c4d",
    "paymentRequestId": "5e8b2c73-1f64-4a97-9c38-d2f6ae15b8c2",
    "paymentIdempotencyId": "ATOA1234567890123",
    "status": "INITIATED",
    "paidAmount": "250.75",
    "refundAmount": "25.50",
    "currency": "GBP",
    "refundNotes": "Customer requested refund",
    "orderId": "987654321",
    "refundType": "PARTIAL",
    "createdAt": "2023-11-15T14:32:45.789Z",
    "updatedAt": "2023-11-15T14:32:45.789Z",
    "metadata": {
      "refundReason": "damaged-item",
      "ticketId": "SUP-9981"
    }
}
]

{
  "name": "BAD_REQUEST",
  "status": 400,
  "message": "No payment request found",
  "errors": []
}

{
  "name": "UNAUTHORIZED",
  "message": "Unauthorized",
  "status": 401,
  "errors": "[]"
}

{
  "name": "NOT_FOUND",
  "message": "No refunds found for this payment request",
  "status": 404,
  "errors": []
}

GET

api

refund

{paymentRequestId}

Get Refund Payments | Refunds API

curl --request GET \
  --url https://api.atoa.me/api/refund/{paymentRequestId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.atoa.me/api/refund/{paymentRequestId}', 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.atoa.me/api/refund/{paymentRequestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.atoa.me/api/refund/{paymentRequestId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.atoa.me/api/refund/{paymentRequestId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "refundId": "a7c82e45-9f31-42b6-8d15-7e63f1b92c4d",
    "paymentRequestId": "5e8b2c73-1f64-4a97-9c38-d2f6ae15b8c2",
    "paymentIdempotencyId": "ATOA1234567890123",
    "status": "INITIATED",
    "paidAmount": "250.75",
    "refundAmount": "25.50",
    "currency": "GBP",
    "refundNotes": "Customer requested refund",
    "orderId": "987654321",
    "refundType": "PARTIAL",
    "createdAt": "2023-11-15T14:32:45.789Z",
    "updatedAt": "2023-11-15T14:32:45.789Z",
    "metadata": {
      "refundReason": "damaged-item",
      "ticketId": "SUP-9981"
    }
}
]

{
  "name": "BAD_REQUEST",
  "status": 400,
  "message": "No payment request found",
  "errors": []
}

{
  "name": "UNAUTHORIZED",
  "message": "Unauthorized",
  "status": 401,
  "errors": "[]"
}

{
  "name": "NOT_FOUND",
  "message": "No refunds found for this payment request",
  "status": 404,
  "errors": []
}

This API is used to get the refund details for a given payment request id. It returns information about the refund transaction including the amount, status, and related payment details.

Authorization

Bearer <token>

Using a sandbox token with a production payment request ID, or a production token with a sandbox payment request ID, will result in an error.

Request Body Schema

string

required

The payment request id is required for this step, which you’ll receive it from the process-payment API when generating a payment request.

Response The API returns a refund payment object with the following fields:

string

A unique UUID for the refund transaction.

string

The ID of the original payment request. Refer to process-payment

string

The unique identifier for the payment transaction.

string

The current status of the refund payment
(e.g., INITIATED,PENDING,COMPLETED,FAILED) - INITIATED : The refund request has been raised - PENDING : The refund is being ready to be processed - COMPLETED : The refund payment has been completed - FAILED : The refund payment has failed - CANCELLED : The refund payment has been cancelled

number

The original amount that was paid.

number

The amount that was refunded.

string

The three-letter currency code (e.g., GBP).

string

The notes associated with the refund.

string

The ID of the order associated with this refund.

string

The type of refund (e.g., PARTIAL, FULL).

string

The timestamp when the refund was created.

string

The timestamp when the refund was last updated.

object

Only present when metadata was supplied on the refund. See Initiate Refund for the field limits.

[
  {
    "refundId": "a7c82e45-9f31-42b6-8d15-7e63f1b92c4d",
    "paymentRequestId": "5e8b2c73-1f64-4a97-9c38-d2f6ae15b8c2",
    "paymentIdempotencyId": "ATOA1234567890123",
    "status": "INITIATED",
    "paidAmount": "250.75",
    "refundAmount": "25.50",
    "currency": "GBP",
    "refundNotes": "Customer requested refund",
    "orderId": "987654321",
    "refundType": "PARTIAL",
    "createdAt": "2023-11-15T14:32:45.789Z",
    "updatedAt": "2023-11-15T14:32:45.789Z",
    "metadata": {
      "refundReason": "damaged-item",
      "ticketId": "SUP-9981"
    }
}
]

{
  "name": "BAD_REQUEST",
  "status": 400,
  "message": "No payment request found",
  "errors": []
}

{
  "name": "UNAUTHORIZED",
  "message": "Unauthorized",
  "status": 401,
  "errors": "[]"
}

{
  "name": "NOT_FOUND",
  "message": "No refunds found for this payment request",
  "status": 404,
  "errors": []
}

Overview

Reference

Webhook

Card on File

Get Refund Payments | Refunds API

Authorization

​Authorization

Authorization