Skip to content

LoyaltyDish supports 3 payment types: Credit card, PayPal and Cash.

Checkout mutation

mutation (
  $id: ID!
  $paymentType: String!
  $cashReceived: Decimal
  $cashReceivedCurrency: String
  $change: Decimal
  $changeCurrency: String
  $consumerPaypalEmail: String
  $paymentGatewayParams: JSONString
){
  checkoutOrder(
    input: {
      id: $id
      paymentType: $paymentType
      cashReceived: $cashReceived
      cashReceivedCurrency: $cashReceivedCurrency
      change: $change
      changeCurrency: $changeCurrency
      consumerPaypalEmail: $consumerPaypalEmail
      paymentGatewayParams: $paymentGatewayParams
    }
  ) {
    errors
    success
    order {
      id
    }
  }
}

Credit card checkout

paymentGatewayParams depends in the payment gateway you configured for your system Currently, there are 3 available payment gateways: Stripe, Square, Razorpay 

// Stripe params schema
{
  "payment_method_id": {
      "type": "string",
  }
}

// Square params schema
{
  "source_id": {
      "type": "string",
  }
}

// Razorpay params schema
{
  "payment_id": {
    "type": "string",
  }
}


mutation (
  $id: ID!
  $paymentType: String!
  $paymentGatewayParams: JSONString
){
  checkoutOrder(
    input: {
      id: $id
      paymentType: $paymentType
      paymentGatewayParams: $paymentGatewayParams
    }
  ) {
    errors
    success
    order {
      id
    }
  }
}

{
  "id": 15,
  "paymentType": "CREDIT_CARD",
  "paymentGatewayParams": "{\"payment_method_id\": \"pm_1LUGLo2eZvKYlo2CO9peySAz\""
}

{
    "data": {
        "checkoutOrder": {
            "success": true,
            "errors": null,
            "order": {
              "id": "U3RvcmVOb2RlOjE5"
            }
        }
    }
}

PayPal checkout

mutation (
  $id: ID!
  $paymentType: String!
  $consumerPaypalEmail: String
){
  checkoutOrder(
    input: {
      id: $id
      paymentType: $paymentType
      consumerPaypalEmail: $consumerPaypalEmail
    }
  ) {
    errors
    success
    order {
      id
    }
  }
}

{
  "id": 15,
  "paymentType": "PAYPAL",
  "consumerPaypalEmail": "customer@gmail.com"
}

{
    "data": {
        "checkoutOrder": {
            "success": true,
            "errors": null,
            "order": {
              "id": "U3RvcmVOb2RlOjE5"
            }
        }
    }
}

Cash checkout

mutation (
  $id: ID!
  $paymentType: String!
  $cashReceived: Decimal
  $cashReceivedCurrency: String
  $change: Decimal
  $changeCurrency: String
){
  checkoutOrder(
    input: {
      id: $id
      paymentType: $paymentType
      cashReceived: $cashReceived
      cashReceivedCurrency: $cashReceivedCurrency
      change: $change
      changeCurrency: $changeCurrency
    }
  ) {
    errors
    success
    order {
      id
    }
  }
}

{
  "id": 15,
  "paymentType": "CASH",
  "cashReceived": "20.00",
  "cashReceivedCurrency": "USD",
  "change": "15.00",
  "changeCurrency": "USD"
}

{
    "data": {
        "checkoutOrder": {
            "success": true,
            "errors": null,
            "order": {
              "id": "U3RvcmVOb2RlOjE5"
            }
        }
    }
}

Terminal card reader checkout

Create Stripe reader connection token

mutation ($stripeLocationId: String){
  stripeCreateReaderConnectionToken(input: {
    stripeLocationId: $stripeLocationId
  }){
    success
    errors
    token
  }
}

{}

{
    "data": {
        "stripeCreateReaderConnectionToken": {
            "success": true,
            "errors": null,
            "token": "pst_test_YWNjdF8xSElEakxJVUJ2N0xaUnlRLDF0U1BETHNNdGdncWhwNWxlRFM0Q0g4VktYS1pYZ1Y_00SE66kdOD"
        }
    }
}

Complete order

mutation (
  $id: ID!
  $paymentType: String!
  $paymentGatewayParams: JSONString
){
  checkoutOrder(
    input: {
      id: $id
      paymentType: $paymentType
      paymentGatewayParams: $paymentGatewayParams
    }
  ) {
    errors
    success
    order {
      id
    }
  }
}

{
  "id": 15,
  "paymentType": "CREDIT_CARD",
  "paymentGatewayParams": "{
    \"payment_method_id\": \"pm_1LUGLo2eZvKYlo2CO9peySAz\"
  }"
}

{
    "data": {
        "checkoutOrder": {
            "success": true,
            "errors": null,
            "order": {
              "id": "U3RvcmVOb2RlOjE5"
            }
        }
    }
}

Send order receipt

mutation SendOrderReceipt(
    $orderId: String!, 
    $customerEmail: String, 
    $customerPhoneNumber: String
) {
    sendOrderReceipt(input: {
        orderId: $orderId
        customerEmail: $customerEmail
        customerPhoneNumber: $customerPhoneNumber
    }) {
        errors
        success
    }
}

{
  "orderId": "123083118",
  "customerEmail": "customer@email.com"
}

{
    "data": {
        "sendOrderReceipt": {
            "errors": null,
            "success": true
        }
    }
}