For processing payment via our own payment API suite.

• Enum: dpay
• Pre-requisites: Dpay integrated in Deliverect

The dpay payment type can be used only after; the payment has been initiated through the Deliverect Pay API, a paymentId has been issued, and authorisation has been successfully confirmed.

During dpay checkout, use the "paymentId" from the payment request as the externalId as shown in the examples to the right.

For further details on requesting payments via Deliverect Pay, see the guide below;

If the payment process is fully managed by the commerce platform, e.g. via a direct payment gateway integration.

• Enum: third_party
• Pre-requisites: None

Use the third_party type for payments handled externally e.g. via your own payment provider rather than via Deliverect Pay. Provide the corresponding transaction ID or equivalent as the externalId as a reference.

Unpaid orders

In order to send unpaid orders, set the order type to "third_party" and "isPrepaid": false.

Instrument Type

Payment type to be associated with the third-party payment in the order in "instrumentType" field.

• CASH = "cash"
• CARD = "card"
• CASH ON DELIVERY = "cash_on_delivery"
• CARD ON DELIVERY = "card_on_delivery"
• ONLINE = "online"
• INVOICE = "invoice"
• OTHER = "other"

For redeeming a gift card balance against the order, in full or in part.

• Enum: gift_card
• Pre-requisites: A gift card provider profile linked in Deliverect

Using the Gift Card API to retrieve a Gift Card balance and validate if it can be applied, the type gift_card can be specified to complete the redemption of a gift card balance. Gift card payments are always "isPrepaid": true, since the value is drawn from the card at redemption.

A gift_card payment requires a metadata object with the following fields:

• giftCardProviderProfileLinkId — the ID of the gift card provider profile link configured in Deliverect, identifying which provider integration should process the redemption.
• giftCardNumber — the gift card number entered or scanned by the customer.
• giftCardVerificationCode — the card's verification code (PIN/CVC), used by the provider to authorise the redemption.

The example below shows an order paid entirely with a gift card:

  {
    "basket": {
      "id": "62********************3x"
    },
    "order": {
      "channelOrderId": "TEST****629",
      "channelOrderDisplayId": "T**629",
      "by": "Web App"
    },
    "note": "ORDER LEVEL NOTE",
    "payments": [
      {
        "type": "gift_card",
        "externalId": "63********************f4",
        "isPrepaid": true,
        "amount": 900,
        "metadata": {
          "giftCardProviderProfileLinkId": "67********************t8",
          "giftCardNumber": "62*************44",
          "giftCardVerificationCode": "64**32"
        }
      }
    ]
  }

An order can be settled with a combination of payment types by adding multiple entries to the payments array. Each entry follows the same rules as it would on its own(e.g. a dpay entry still requires a confirmed paymentId, a gift_card entry still requires its metadata and the sum of all amount values must equal the basket total.

The example below splits a 900 total across three methods: 300 charged via Deliverect Pay but not yet collected ("isPrepaid": false), 300 redeemed from a gift card, and 300 already captured by an external provider via card:

  {
    "basket": {
      "id": "62********************3x"
    },
    "order": {
      "channelOrderId": "TEST****629",
      "channelOrderDisplayId": "T**629",
      "by": "Mobile App",
      "courier": "restaurant"
    },
    "note": "ORDER LEVEL NOTE",
    "payments": [
      {
        "type": "dpay",
        "externalId": "68********************4e",
        "isPrepaid": false,
        "amount": 300,
        "metadata": {}
      },
      {
        "type": "gift_card",
        "externalId": "63********************f4",
        "isPrepaid": true,
        "amount": 300,
        "metadata": {
          "giftCardProviderProfileLinkId": "67********************t8",
          "giftCardNumber": "62*************44",
          "giftCardVerificationCode": "64**32"
        }
      },
      {
        "type": "third_party",
        "externalId": "66********************h3",
        "isPrepaid": true,
        "instrumentType": "card",
        "amount": 300,
        "metadata": {}
      }
    ]
  }