Terraswitch
  • Terraswitch - Get Started
  • Test & Live Environments
  • Onboarding as a Business
  • GUIDES
    • 🎾Authentication
    • 🧀Webhooks
    • 🫓Status & Responses
    • 🏉API Rate Limits
    • 🚀Transactions & Destinations
    • 🍊Testing Credentials
    • 🚐Crafting Metadata
  • API ENDPOINTS
    • Account
      • Get Account Details
      • Get Banks
      • Get Beneficiaries
      • Add Bank
      • Change Settlement Bank
    • Wallet
      • Get Wallet Details
      • Get Wallet Transactions
    • Collections
      • Checkout
        • Initialize Transaction
      • Transfer
        • Generate Account
      • Charge
        • Create Charge
        • Authorize Charge
        • Charge Authorization
      • Bank
        • Pay with Opay
    • Payout
      • Bank Transfer
      • Withdraw Money
    • Products
      • List Products
      • Search Products
      • Filter Products
      • Fetch Product
      • Create Product
      • Update Product
    • Subaccounts
      • List Subaccounts
      • Search Subaccounts
      • Filter Subaccounts
      • Fetch Subaccount
      • Create Subaccount
      • Update Subaccount
    • Payment Links
      • List Payment Links
      • List Payment Link Transactions
      • Search Payment Links
      • Filter Payment Links
      • Fetch Payment Link
      • Create Payment Link
      • Update Payment Link
      • Attach Payment Resource
      • Remove Subaccount
      • Enable Payment Link
      • Disable Payment Link
    • Invoices
      • List Invoices
      • Search Invoices
      • Filter Invoices
      • Fetch Invoice
      • Create Invoice
      • Update Invoice
      • Remove Invoice Item
    • Transactions
      • List Transactions
      • Search Transactions
      • Filter Transactions
      • Verify Transaction
    • Refunds
      • List Refunds
      • Fetch Refund
      • Create Refund
    • Bills Payment
      • List Mobile Networks
      • List Bill Categories
      • List Bill Sub-Categories
      • List Mobile Data Plans
      • Validate Biller
      • Validate Bill Status
      • Validate Top-Up Status
      • Buy Airtime
      • Buy Data
      • Pay Bill
    • Resources
      • List Banks
      • List Countries
      • Resolve Bank Account
Powered by GitBook
On this page
  1. API ENDPOINTS
  2. Refunds

Fetch Refund

Get a single product on your Terraswitch account

GET {{ BASE_URL }}/v1/corporate/refund/{code}

Url Parameters

Property
Data Type
Description
Example
Required

code

string

The refund code

"VPF-19a0a4fc"

Yes

import Axios from 'axios';

// set the api url
const API_URL = `${BASE_URL}/v1/corporate/refund/${code}`;

// make request using axios
Axios({
    method: "GET",
    url: `${API_URL}`,
    headers: {
        lg: 'en',
        ch: 'web'
        Authorization: `Bearer ${API_KEY}`,
        'Content-Type': 'application/json',
    }
}).then((resp) => {
    console.log(resp)
}).catch((err) => {
    console.log(err)
})
{
    "error": false,
    "errors": [],
    "data": {
        "code": "VPF-19a0a4fc",
        "amount": 1000,
        "option": "instant",
        "reason": "Transaction was successful but needs to be refunded",
        "status": "successful",
        "type": "full",
        "paidAt": {
            "day": "2024-01-14",
            "time": "07:13:00",
            "ISO": "2024-01-14T07:13:00.933Z"
        },
        "bank": {
            "accountName": "AGBELEYE OLUWATOBI EMMANUEL",
            "accountNo": "0252872742",
            "bankCode": "058",
            "name": "guaranty"
        },
        "createdAt": "2024-01-14T07:12:12.721Z",
        "updatedAt": "2024-01-14T07:13:00.943Z",
        "transaction": {
            "reference": "VPX0c94e97c-b5534eaf",
            "amount": 1000,
            "fee": 100,
            "feature": "wallet-transfer",
            "createdAt": "2024-01-12T20:23:59.787Z"
        }
    },
    "message": "successful",
    "status": 200
}
PreviousList RefundsNextCreate Refund

Last updated 5 months ago