Verifone · Schema

OP Online Payment Payment Initiation Response

opOnlinePaymentInitiationResponse from Verifone eCommerce API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name	Type	Description
id	string	The ID of the transaction.
payment_url	string	The payment URL can be used to redirect to transfer the money.
amount	integer	Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide
created_at	string	The time at which the transaction was created.
customer	string	The ID of a customer
merchant_reference	string	A reference specified by the merchant to identify the transaction.
processor	string	The name of the processor used for this transaction
payment_product	string	The payment product corresponding to this transaction
payment_product_type	object
status	string	The outcome of the payment request.
status_reason	string	Message provided by the 3rd party service as additional information, when the transaction does not succeed.
geo_location	array	The latitude / longitude resolved from the customer's ip address.
city	string	The city resolved from the customer's ip address.
country_code	string	The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. Note: The country code for Great Britain is `GB` and not `UK`
payout_reference	string	A settlement reference specified by the merchant to identify the transaction including checksum digit.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/ecommerce-api-oponlinepaymentinitiationresponse.json",
  "title": "OP Online Payment Payment Initiation Response",
  "description": "opOnlinePaymentInitiationResponse from Verifone eCommerce API",
  "type": "object",
  "properties": {
    "id": {
      "title": "Transaction ID",
      "type": "string",
      "description": "The ID of the transaction.",
      "format": "uuid-flexible"
    },
    "payment_url": {
      "type": "string",
      "description": "The payment URL can be used to redirect to transfer the money.",
      "format": "uri"
    },
    "amount": {
      "type": "integer",
      "description": "Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field."
    },
    "created_at": {
      "type": "string",
      "description": "The time at which the transaction was created.",
      "format": "date-time"
    },
    "customer": {
      "type": "string",
      "description": "The ID of a customer"
    },
    "merchant_reference": {
      "type": "string",
      "description": "A reference specified by the merchant to identify the transaction.",
      "maxLength": 50
    },
    "processor": {
      "type": "string",
      "description": "The name of the processor used for this transaction",
      "default": "OP_ONLINE_PAYMENT"
    },
    "payment_product": {
      "type": "string",
      "description": "The payment product corresponding to this transaction",
      "default": "OP_ONLINE_PAYMENT"
    },
    "payment_product_type": {
      "$ref": "#/components/schemas/PaymentProductType"
    },
    "status": {
      "type": "string",
      "description": "The outcome of the payment request.",
      "title": "Ecommerce Transaction Status",
      "enum": [
        "INITIATED",
        "AUTHORIZED",
        "AUTHORIZATION_VOIDED",
        "CANCELLED",
        "CUSTOMER_ACCEPTED",
        "REFUNDED",
        "FAILED",
        "PENDING",
        "DECLINED",
        "SETTLEMENT_CANCELLED",
        "SETTLEMENT_REQUESTED",
        "SETTLEMENT_SUBMITTED",
        "SETTLEMENT_COMPLETED",
        "SETTLEMENT_PARTIAL",
        "SETTLEMENT_DECLINED",
        "VOIDED",
        "UNKNOWN"
      ]
    },
    "status_reason": {
      "type": "string",
      "description": "Message provided by the 3rd party service as additional information, when the transaction does not succeed."
    },
    "geo_location": {
      "type": "array",
      "description": "The latitude / longitude resolved from the customer's ip address.",
      "items": {
        "type": "number"
      }
    },
    "city": {
      "type": "string",
      "description": "The city resolved from the customer's ip address."
    },
    "country_code": {
      "title": "Country Code",
      "type": "string",
      "description": "The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as is used in that country's top-level domain names.</blockquote>."
    },
    "payout_reference": {
      "maxLength": 20,
      "minLength": 4,
      "pattern": "^[0-9]{4,20}$",
      "type": "string",
      "description": "A settlement reference specified by the merchant to identify the transaction including checksum digit."
    }
  }
}