Deliverect · JSON Structure

Pay Api Pay Endpoints Request Payment Structure

Deliverect Request Payment

Type: object Properties: 9 Required: 5

RestaurantDeliveryOnline OrderingPoint of SaleOrder ManagementIntegration

PayEndpointsRequestPayment is a JSON Structure definition published by Deliverect, describing 9 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

gatewayProfileId mode amount currency payableReference payer payable billingAddress captureMode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/deliverect/refs/heads/main/json-structure/pay-api-pay-endpoints-request-payment-structure.json",
  "name": "PayEndpointsRequestPayment",
  "description": "Deliverect Request Payment",
  "type": "object",
  "properties": {
    "gatewayProfileId": {
      "type": "string",
      "example": "609a1b2c3d4e5f6a7b8c9d0e",
      "description": "\"id\" retrieved via Get Payment Gateways endpoint"
    },
    "mode": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "offline",
            "redirect",
            "terminal",
            "token"
          ],
          "example": "offline"
        },
        "returnUrl": {
          "type": "string",
          "example": "https://example.com/path/abc123"
        },
        "tokenId": {
          "type": "string",
          "example": "609a1b2c3d4e5f6a7b8c9d0e",
          "description": "\"id\" retrieved via [Get Customer Tokens endpoint](https://developers.deliverect.com/reference/pay_endpoints-get-customer-tokens). Used only when `type=\"token\"`"
        }
      }
    },
    "amount": {
      "type": "int32",
      "example": 1250
    },
    "currency": {
      "type": "string",
      "example": "EUR"
    },
    "payableReference": {
      "type": "string",
      "example": "string",
      "description": "This field is deprecated. Use the `payable` field instead."
    },
    "payer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Deliverect's Pizza Place"
        },
        "email": {
          "type": "string",
          "example": "customer@example.com"
        },
        "reference": {
          "type": "string",
          "example": "string"
        },
        "ip": {
          "type": "string",
          "example": "string",
          "description": "The payer's IP address"
        }
      }
    },
    "payable": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "609a1b2c3d4e5f6a7b8c9d0e",
          "description": "A unique reference to the payable subject."
        }
      }
    },
    "billingAddress": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string",
          "example": "BE"
        },
        "city": {
          "type": "string",
          "example": "string"
        },
        "postalCode": {
          "type": "string",
          "example": "string"
        },
        "street": {
          "type": "string",
          "example": "string"
        },
        "houseNumber": {
          "type": "string",
          "example": "string"
        },
        "stateOrProvince": {
          "type": "string",
          "example": "string"
        }
      }
    },
    "captureMode": {
      "type": "string",
      "enum": [
        "immediate",
        "manual"
      ],
      "default": "immediate",
      "example": "immediate"
    }
  },
  "required": [
    "gatewayProfileId",
    "mode",
    "amount",
    "currency",
    "payable"
  ]
}