Refunds
post/payments/refund

Request

  • Base URL
    https://api-sandbox.tamara.co
  • Auth
    HTTP bearer

Request body

order_idstring uuid required

Unique Tamara order_id from the response of the creation of the checkout session whether online or in-store.

Example request

{
  "order_id": "8fe4cce9-d0aa-4020-a863-c708547795e9",
  "refunds": [
    {
      "capture_id": "b38599ce-350e-418c-8c88-1e015f6e2dfd",
      "total_amount": {
        "amount": 300,
        "currency": "SAR"
      },
      "refund_id": "b38599ce-350e-418c-8c88-1e015f6e2dfd",
      "tax_amount": {
        "amount": "50.00",
        "currency": "SAR"
      },
      "shipping_amount": {
        "amount": "50.00",
        "currency": "SAR"
      },
      "discount_amount": {
        "amount": "50.00",
        "currency": "SAR"
      },
      "items": [
        {
          "name": "Lego City 8601",
          "quantity": 1,
          "reference_id": "123",
          "sku": "SA-12436",
          "item_url": "SA-12436",
          "image_url": "SA-12436",
          "unit_price": {
            "amount": 490,
            "currency": "SAR"
          },
          "tax_amount": {
            "amount": 10,
            "currency": "SAR"
          },
          "discount_amount": {
            "amount": 100,
            "currency": "SAR"
          },
          "total_amount": {
            "amount": "100",
            "currency": "SAR"
          },
          "type": "Digital"
        }
      ]
    }
  ]
}

Response

Refund Successful

order_idstring uuid
status'fully_refunded' | 'partially_refunded'

Changes