v1

latestOpenAPI 3.1.02026-07-2419077.8 KB

Update an Authorize

This endpoint updates the required details for any specified authorized transactions.

put/{authorize_id}

Path parameters

authorize_idstring required

Request body

descriptionstring

The description of the authorize.

Response

200

idstring
objectstring
live_modeboolean
api_versionstring
methodstring
statusstring
amountinteger
currencystring
threeDSecureboolean
save_cardboolean
merchant_idstring
productstring
statement_descriptorstring
descriptionstring

Example response

{
  "id": "auth_TS065220221533k5FK1505634",
  "object": "authorize",
  "api_version": "V2",
  "method": "UPDATE",
  "status": "AUTHORIZED",
  "amount": 1,
  "currency": "KWD",
  "threeDSecure": true,
  "statement_descriptor": "sample",
  "transaction": {
    "authorization_id": "067245",
    "timezone": "UTC+03:00",
    "created": "1652628981168",
    "expiry": {
      "period": 30,
      "type": "MINUTE"
    },
    "amount": 1,
    "currency": "KWD"
  },
  "reference": {
    "track": "tck_TS055220221533Kb9e1505666",
    "payment": "5215221533056668493",
    "gateway": "123456789",
    "acquirer": "213509067245",
    "transaction": "txn_0001",
    "order": "ord_0001"
  },
  "response": {
    "code": "001",
    "message": "Authorized"
  },
  "acquirer": {
    "response": {
      "code": "00",
      "message": "Approved"
    }
  },
  "card": {
    "object": "card",
    "first_six": "512345",
    "last_four": "0008"
  },
  "receipt": {
    "id": "205215221533050296",
    "email": true,
    "sms": true
  },
  "customer": {
    "id": "cus_TS072120221536Ol2j1505528",
    "first_name": "Test",
    "last_name": "Test",
    "email": "test@test.com",
    "phone": {
      "country_code": "965",
      "number": "50000000"
    }
  },
  "source": {
    "object": "token",
    "type": "CARD_NOT_PRESENT",
    "payment_type": "CREDIT",
    "payment_method": "MASTERCARD",
    "channel": "INTERNET",
    "id": "tok_6Y1J1922931uU8T15B148555"
  },
  "redirect": {
    "status": "SUCCESS",
    "url": "http://your_website.com/redirecturl"
  },
  "post": {
    "status": "PENDING",
    "url": "http://your_website.com/posturl"
  },
  "auto": {
    "status": "SCHEDULED",
    "type": "VOID",
    "time": 100
  },
  "description": "Test Updated",
  "metadata": {
    "udf1": "test_data_1",
    "udf2": "test_data_2",
    "udf3": "test_data_3"
  }
}