Tamara · Schema

TamaraCapture

A capture of funds against an authorised Tamara order.

BNPLBuy Now Pay LaterFintechPaymentsCheckoutShariah CompliantMENASaudi ArabiaUAEInstallmentsPay LaterMerchant ServicesOrdersRefundsCapturesWebhooksDisputesChannel PartnersE-commercePOS

Properties

Name Type Description
capture_id string
order_id string
status string
captured_amount object
shipping_info object
created_at string
View JSON Schema on GitHub

JSON Schema

tamara-capture-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tamara/main/json-schema/tamara-capture-schema.json",
  "title": "TamaraCapture",
  "description": "A capture of funds against an authorised Tamara order.",
  "type": "object",
  "required": ["capture_id", "order_id", "status", "captured_amount"],
  "properties": {
    "capture_id": { "type": "string", "format": "uuid" },
    "order_id": { "type": "string", "format": "uuid" },
    "status": { "type": "string", "enum": ["fully_captured", "partially_captured"] },
    "captured_amount": {
      "type": "object",
      "required": ["amount", "currency"],
      "properties": {
        "amount": { "type": "number" },
        "currency": { "type": "string", "enum": ["SAR", "AED", "BHD", "KWD", "OMR"] }
      }
    },
    "shipping_info": {
      "type": "object",
      "properties": {
        "shipped_at": { "type": "string", "format": "date-time" },
        "shipping_company": { "type": "string" },
        "tracking_number": { "type": "string" },
        "tracking_url": { "type": "string", "format": "uri" }
      }
    },
    "created_at": { "type": "string", "format": "date-time" }
  }
}