Payment Validations

5min
To ensure data safety and a consistent behaviour, extensive data validation is done on any payment request.
The following is the possible validation responses for the payment request and each of its sources:
﻿
Create Payment
This is a list of all fields and possible errors that can occur during the payment creation request.
JSON
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "amount": [
      "This field is required.",
      "The value must be an integer.",
      "The value must be less than or equal to 100."
    ],
    "currency":  [
      "This field is required.",
      "The value must be a string."
    ],
    "description": [
      "The value must be a string."
    ],
    "metadata": [
      "The field must be an object.",
      "The value length must be less than or equal to 30."
    ],
    "source":  [
      "This field is required.",
      "The field must be an object."
    ],
    "source.type": [
      "This field is required.",
      "The value must be a string.",
      "The value must be one of creditcard, card, applepay, stcpay or token"
    ]
  }
}
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "amount": [
      "This field is required.",
      "The value must be an integer.",
      "The value must be less than or equal to 100."
    ],
    "currency":  [
      "This field is required.",
      "The value must be a string."
    ],
    "description": [
      "The value must be a string."
    ],
    "metadata": [
      "The field must be an object.",
      "The value length must be less than or equal to 30."
    ],
    "source":  [
      "This field is required.",
      "The field must be an object."
    ],
    "source.type": [
      "This field is required.",
      "The value must be a string.",
      "The value must be one of creditcard, card, applepay, stcpay or token"
    ]
  }
}
﻿
﻿
Card
In additon to errors in the Create Payment section, the following errors can occur in the card source payments:
JSON
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "callback_url": [
      "This field is required.",
      "The value must be a string.",
      "The field must contain a valid URL."
    ],
    "source.name": [
      "This field is required.",
      "The value must be a string.",
      "Card holder name must be two our more word of the latin alphabet."
    ],
    "source.number": [
      "This field is required.",
      "The value must be a string."
    ],
    "source.month": [
      "This field is required.",
      "The value must be an integer.",
      "Invalid expiry month."
    ],
    "source.year": [
      "This field is required.",
      "The value must be an integer.",
      "Invalid expiry year."
    ],
    "source.cvc": [
      "This field is required.",
      "The field must contain digits between 3 and 4."
    ],
    "source.statement_descriptor": [
      "The value must be a string."
    ],
    "source.3ds": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.manual": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.save_card": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ]
  }
}
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "callback_url": [
      "This field is required.",
      "The value must be a string.",
      "The field must contain a valid URL."
    ],
    "source.name": [
      "This field is required.",
      "The value must be a string.",
      "Card holder name must be two our more word of the latin alphabet."
    ],
    "source.number": [
      "This field is required.",
      "The value must be a string."
    ],
    "source.month": [
      "This field is required.",
      "The value must be an integer.",
      "Invalid expiry month."
    ],
    "source.year": [
      "This field is required.",
      "The value must be an integer.",
      "Invalid expiry year."
    ],
    "source.cvc": [
      "This field is required.",
      "The field must contain digits between 3 and 4."
    ],
    "source.statement_descriptor": [
      "The value must be a string."
    ],
    "source.3ds": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.manual": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.save_card": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ]
  }
}
﻿
﻿
Apple Pay
In additon to errors in the Create Payment section, the following errors can occur in the applepay source payments:
JSON
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "source.token": [
      "This field is required."
    ],
    "source.statement_descriptor": [
      "The value must be a string."
    ],
    "source.manual": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.save_card": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ]
  }
}
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "source.token": [
      "This field is required."
    ],
    "source.statement_descriptor": [
      "The value must be a string."
    ],
    "source.manual": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.save_card": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ]
  }
}
﻿
﻿
STC Pay
In additon to errors in the Create Payment section, the following errors can occur in the stcpay source payments:
JSON
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "source.mobile": [
      "This field is required.",
      "The value must be a string.",
      "The value must be a valid Saudi mobile number using any format like '05x', '009665x', '+9665x' or '9665x'"
    ],
    "source.cashier": [
      "The value must be a string."
    ],
    "source.branch": [
      "The value must be a string."
    ]
  }
}
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "source.mobile": [
      "This field is required.",
      "The value must be a string.",
      "The value must be a valid Saudi mobile number using any format like '05x', '009665x', '+9665x' or '9665x'"
    ],
    "source.cashier": [
      "The value must be a string."
    ],
    "source.branch": [
      "The value must be a string."
    ]
  }
}
﻿
﻿
Token
In additon to errors in the Create Payment section, the following errors can occur in the token source payments:
JSON
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "callback_url": [
      "This field is required.",
      "The value must be a string.",
      "The field must contain a valid URL."
    ],
    "source.token": [
      "This field is required.",
      "The value must be a string."
    ],
    "source.cvc": [
      "This field is required.",
      "The field must contain digits between 3 and 4."
    ],
    "source.statement_descriptor": [
      "The value must be a string."
    ],
    "source.3ds": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.manual": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ]
  }
}
{
  "type": "validation_error",
  "message": "Data validation failed",
  "errors": {
    "callback_url": [
      "This field is required.",
      "The value must be a string.",
      "The field must contain a valid URL."
    ],
    "source.token": [
      "This field is required.",
      "The value must be a string."
    ],
    "source.cvc": [
      "This field is required.",
      "The field must contain digits between 3 and 4."
    ],
    "source.statement_descriptor": [
      "The value must be a string."
    ],
    "source.3ds": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ],
    "source.manual": [
      "This field is required.",
      "The value must be a boolean, yes, no, on, off, 0 or 1."
    ]
  }
}
﻿
﻿
Updated 28 Feb 2024
Did this page help you?
Token Payment
Payment Object