Deliverect · JSON Structure

Pay Api Payplatform Payments Request Structure

Deliverect Request Payment

Type: object Properties: 7 Required: 5
RestaurantDeliveryOnline OrderingPoint of SaleOrder ManagementIntegration

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

Properties

gatewayProfileId amount currency returnUrl reference logoUrl payer

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/deliverect/refs/heads/main/json-structure/pay-api-payplatform-payments-request-structure.json",
  "name": "PayplatformPaymentsRequest",
  "description": "Deliverect Request Payment",
  "type": "object",
  "properties": {
    "gatewayProfileId": {
      "type": "string",
      "example": "609a1b2c3d4e5f6a7b8c9d0e"
    },
    "amount": {
      "type": "int32",
      "example": 1250
    },
    "currency": {
      "type": "string",
      "example": "EUR"
    },
    "returnUrl": {
      "type": "string",
      "example": "https://example.com/path/abc123"
    },
    "reference": {
      "type": "string",
      "example": "string"
    },
    "logoUrl": {
      "type": "string",
      "example": "https://example.com/path/abc123"
    },
    "payer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Deliverect's Pizza Place"
        },
        "email": {
          "type": "string",
          "example": "customer@example.com"
        },
        "reference": {
          "type": "string",
          "example": "string"
        }
      }
    }
  },
  "required": [
    "gatewayProfileId",
    "amount",
    "currency",
    "returnUrl",
    "reference"
  ]
}