Developer Docs
  • 👋Get Started
  • Add Payment Methods in Optty
  • Custom API | Headless
    • 🖥️Direct API Integration
      • Environments
      • Order Flow
      • 1️⃣Create Access Token
      • 2️⃣Get APM Options
      • 3️⃣Create Order
      • 4️⃣Handle Payment Response
      • 5️⃣Refund Order
      • 🔥Handling Exceptions
  • Platforms
    • ◾BigCommerce
      • 🚀Activate Optty
      • ⚡Add Optty Widgets
        • 1️⃣Install the App
        • 2️⃣Create Widget Token
        • 3️⃣Edit Your Template
        • 4️⃣Widget Configuration
      • 💳Refunds
    • Magento 2
      • Install Optty Module
      • Configure the Optty Extension
      • One Step Checkout
    • Salesforce Commerce Cloud
      • Component Overview
      • Implementation Guide
      • Operation and Management
      • User Guide
    • 🟪WooCommerce
      • 🚀Install Optty
      • ⚡Setup Widgets
      • 💳Refunds
  • Widget
    • Widget Setup and Integration
    • Create Order Widget Integration
    • Handle Order Payment Widget Integration
  • API References
    • Create Order
      • Create Order Response
    • Refund Order
    • Void Order
    • Capture Order
    • Transaction Details
    • Create Customer Session
    • Best Practice
  • Go Live
  • Universal Payment Platform
    • Support Articles
Powered by GitBook
On this page
  • Sandbox Testing Environment
  • Production Environment
  • Refund Order
  1. Custom API | Headless
  2. Direct API Integration

Refund Order

This method is used to request a refund for an order paid via an Optty integrated APM. The request is passed through to and handled by the appropriate APM provider.

Sandbox Testing Environment

Merchant URL

https://api.qa.optty.com

Production Environment

Merchant URL

https://api.optty.com

Refund Order

POST /orders/[orderReference]/refund

Use this method to execute a refund for an order that has been paid via a payment method that has been integrated through Optty

Headers

Name
Type
Description

Authorization*

String

Bearer <token>

Request Body

Name
Type
Description

refundReference*

string

Unique refund reference for tracking purposes in Optty. Use a unique ID for every refund

refundAmount*

object

An object containing the currency and amount to be refunded to the customer

refundAmount.amount*

number

Amount to refund

eg: 100

refundAmount.currency

string

The currency in which the refund amount is in, using ISO 4217 format

eg: USD, AED, GBP

refundDescription

string

Brief description of the refund

Content-type application/json:

{
    "refundReference": "TgEHcPtpN2HSrTMK-0-00",
    "bnplProvider": "KLARNA_AU",
    "refundedAmount": 100,
    "refundStatus": "SUCCESSFUL",
    "description": {},
    "refundDate": "Fri, 08 Oct 2021 06:22:20 GMT",
    "bnplRefundId": "8ba78198-bc4c-48ae-9040-57c687bed51d"
}

PreviousHandle Payment ResponseNextHandling Exceptions

Last updated 3 months ago

🖥️
5️⃣