Get Transaction Status

Get Transaction Status

application/json

Request Body

• merchant_key uuid required

  Key for Merchant identification

• payment_id uuid required

  Possible values: <= 255 characters

  Payment ID (public)

• hash string required

  Special signature to validate your request to Payment Platform Addition in Signature section Must be SHA1 of MD5 encoded string

Responses

• 200
• 400

---

OK

application/json

• Schema
• Example (from schema)
• Success
• Rejected

---

Schema

• status string

  Possible values: [prepare, settled, pending, 3ds, redirect, decline, refund, reversal, chargeback]

  Payment status

• payment_id uuid

  Transaction ID (public)

• reason string

  Decline reason translation for unsuccessful payment. It displays only if the transaction is unsuccessful

• date ISO 8601

  Transaction date

• order object

  Information about an order

  number string

  Order ID

  amount float

  Possible values: <= 255 characters

  Pay attention that amount will be exponent so if you pass 1 it will be 1.00

  currency ISO 4217

  Possible values: <= 3 characters

  Currency code in the ISO 4217 standard (e.g. 'SAR').

  description string

  Product name

• customer object

  Customer's information. Send an object if a payment method needs

  name Latin basic [a-z A-Z]

  Customer's name Condition: If the parameter is NOT specified in the request, then it will be displayed on the Checkout page (if a payment method needs) - the "Cardholder" field

  email email

  Possible values: <= 254 characters

  Customer's email address Condition: If the parameter is NOT specified in the request, then it will be displayed on the Checkout page (if a payment method needs) - the "E-mail" field

{
  "status": "settled",
  "payment_id": "dc66cdd8-d702-11ea-9a2f-0242c0a87002",
  "reason": "The operation was rejected. Please contact the site support",
  "date": "2020-08-05",
  "order": {
    "number": "string",
    "amount": 22,
    "currency": "string",
    "description": "gift"
  },
  "customer": {
    "name": "string",
    "email": "user@example.com"
  }
}

settled

{
  "payment_id": "24f7401c-fc47-11ec-8d07-0242ac120015",
  "date": "2022-07-05 09:45:03",
  "status": "settled",
  "order": {
    "number": "f0a51dfa-fc43-11ec-8128-0242ac120004-1",
    "amount": "3.01",
    "currency": "SAR",
    "description": "bloodline"
  },
  "customer": {
    "name": "John Doe",
    "email": "success@gmail.com"
  }
}

declined

{
  "payment_id": "03e46e96-de42-11eb-aea7-0242ac140002",
  "date": "2021-07-06 10:07:47",
  "status": "decline",
  "reason": "Declined by processing",
  "order": {
    "number": "order-1234",
    "amount": "1.00",
    "currency": "SAR",
    "description": "Important gift"
  },
  "customer": {
    "name": "John Doe",
    "email": "test@mail.com"
  }
}

Invalid data submitted or request processing error

application/json

• Schema
• Example (from schema)

---

Schema

• error_code integer
• error_message string

  what cause the error

• errors object[]

  error_code integer

  error_message string

  what cause the error

{
  "error_code": 0,
  "error_message": "string",
  "errors": {
    "error_code": 0,
    "error_message": "Request data is invalid",
    "errors": [
      {
        "error_code": 100000,
        "error_message": "operation: The value you selected is not a valid choice."
      },
      {
        "error_code": 100000,
        "error_message": "order.amount: This value should be greater than 0."
      },
      {
        "error_code": 100000,
        "error_message": "cancel_url: This value is not a valid URL."
      },
      {
        "error_code": 100000,
        "error_message": "hash: Hash is not valid."
      }
    ]
  }
}

Loading...