Refund

POST

/payment-invoices/cpi_CGM3Mvn3ZTNKz4Sf/refund

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic *****************

Header Params

Host

string

required

Example:

Body Params application/json

data

object

required

type

string

required

string

required

attributes

object

required

Example

{
  "data": {
    "type": "refund",
    "id": "cpi_CGM3Mvn3ZTNKz4Sf",
    "attributes": {
      "amount": 10,
      "reference_id": "reference_id",
      "description": "Refund by order"
    }
  }
}

Responses

🟢200Success

application/json

Body

object {0}

Example

{
  "data": {
    "type": "payment-invoices",
    "id": "cpi_wkkZXA7pzuHNKsfb",
    "attributes": {
      "status": "refunded",
      "resolution": "ok",
      "moderation_required": false,
      "amount": 100,
      "payment_amount": 100,
      "currency": "EUR",
      "service_amount": null,
      "payment_service_amount": null,
      "exchange_rate": null,
      "service_currency": "EUR",
      "reference_id": "f517aa44-656f-46b8-9419-d0c25837d4de",
      "test_mode": true,
      "fee": 0,
      "deposit": 100,
      "processed": 1728475989,
      "processed_amount": 100,
      "refunded_amount": 100,
      "refunded_fee": 0,
      "refunded": 1728480524,
      "processed_fee": 0,
      "processed_deposit": 100,
      "failed": null,
      "metadata": {
        "key": "value"
      },
      "flow_data": {
        "action": "https://checkout.example.com/hpp/cgi_NiKK95XBi6bKR9sx",
        "method": "GET",
        "params": [],
        "metadata": {
          "sid": "cgi_NiKK95XBi6bKR9sx",
          "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzaWQiOiJjZ2lfTmlLSzk1WEJpNmJLUjlzeCIsImV4cGlyZXMiOm51bGwsImV4cCI6MTcyODQ3OTU3M30.aQuFYi3CYLReUChCFshnBIPEdJ8-OYBm04ZKTrLYulE"
        }
      },
      "flow": "hpp",
      "payment_flow": "charge",
      "created": 1728475973,
      "updated": 1728480524,
      "payload": {
        "token": null,
        "auth_type": "card",
        "client_ip": "123.123.12.1",
        "payment_card": {
          "last": "0000",
          "mask": "551928******0000",
          "type": "debit",
          "brand": "standard",
          "first": "551928",
          "holder": "Jack Smith",
          "card_id": "card_yozHU7Q4atoe9SJl",
          "network": "mastercard",
          "expiry_year": "30",
          "issuer_name": "U.S. BANK, N.A.",
          "expiry_month": "04",
          "issuer_country": "US"
        }
      },
      "description": "Invoice Example",
      "descriptor": null,
      "callback_url": "https://example.com",
      "return_url": "https://example.com",
      "return_urls": {
        "fail": "https://example.com/3",
        "pending": "https://example.com/2",
        "success": "https://example.com/1"
      },
      "original_data": {
        "original_resolution": "ok",
        "original_resolution_message": null
      },
      "rrn": "58709027",
      "arn": "95343982",
      "approval_code": null,
      "reserved_amount": null,
      "reserve_expires": null,
      "unreserved": null,
      "source": "merchant_api",
      "callback_logs": [],
      "charged_back_amount": null,
      "charged_back": null,
      "resolution_message": null,
      "hpp_url": "https://api.example.com/redirect/hpp/?cpi=cpi_wkkZXA7pzuHNKsfb",
      "refunds": [],
      "reserves": [],
      "reserve_options": null,
      "processed_unreserve": null,
      "processed_reserve_cancel": null,
      "reserve_cancelled": null
    },
    "relationships": {
      "payment-service": {
        "data": {
          "type": "payment-services",
          "id": "payment_card_eur_hpp"
        }
      },
      "payment-method": {
        "data": {
          "type": "payment-methods",
          "id": "payment_card"
        }
      },
      "customer": {
        "data": {
          "type": "customers",
          "id": "cus_UmjAaFyifjsKNHpY"
        }
      },
      "active-payment": {
        "data": {
          "type": "payments",
          "id": "pay_ZCkwdx2djkU3dOkZWmvfxK54"
        }
      }
    },
    "links": {
      "self": "/api/payment-invoices/cpi_wkkZXA7pzuHNKsfb"
    }
  }
}

Modified at 2024-10-09 13:30:04

Get list of Payment Invoices

Cards Whitelist API