Skip to main content
Version: v2

Payment Metadata

Overview​

This document provides an overview of the payment metadata in the Wallet Payment Service. It explains the various metadata fields associated with a payment, which are essential for tracking, processing, and managing payments efficiently.

Payment Metadata Fields​

There are two main categories of metadata fields:

  • CCG Specific Metadata: Fields specific to the CCG (Convenient Checkout Gateway) system.
  • Merchant Specific Metadata: Fields tailored to the merchant's requirements.

Note:

  • The metadata fields in the payment object are optional and can be included as needed.
  • The metadata is stored within the payment object and can be accessed through the API.

CCG Specific Metadata​

  • CCG Specific Metadata fields are used to track and manage payments within the CCG system.
  • CCG Specific Metadata fields populate by default when the payment is created and are updated as the payment progresses through its lifecycle.
  • CCG Specific Metadata fields are excluded when validating the payment metadata during capture or cancel operations.
  • CCG Specific Metadata fields populate in merchant payout reports.
| **Field**                  | **Description**                                                                                     |
|----------------------------|-----------------------------------------------------------------------------------------------------|
| `referenceId`              | A unique identifier for the payment reference (i.e., paymentId)                                    |
| `merchantTransactionId`    | A unique identifier for the payment transaction                                                    |
| `checkoutId`               | Unique identifier for the checkout session (populated only for CCG Widget based payments)          |
| `merchantGroupId`          | Merchant group ID associated with the payment                                                      |
| `merchantId`               | MerchantId associated with the payment                                                             |
| `merchantName`             | Name of the merchant associated with the payment                                                   |
| `ccg_processor`            | The processor used for the payment (e.g., STRIPE)                                                  |
| `ccg_paymentmethodlast4`   | Last four digits of the payment method used                                                        |
| `ccg_nameoncard`           | Name on the card used for the payment (populated only when the payment is performed using a stored card payment method in the wallet). |
| `ccg_nameonaccount`        | Name on the bank account used for the payment (populated only when the payment is performed using a stored bank account payment method in the wallet). |
| `ccg_paymentmethodnickname`| Nickname of the payment method used (populated only when a nickname exists in the payment method and the payment is performed using that stored payment method in the wallet). |
| `ccg_paymentMethodId`      | Payment method ID associated with the payment (populated only when the payment is performed using a stored payment method in the wallet). |

Merchant Specific Metadata​

  • Merchant Specific Metadata fields are used to track and manage payments within the merchant system.
  • Merchant Specific Metadata fields populate in the payments only when provided by the user in the request payload while submitting the payment.
  • Merchant Specific Metadata fields populate in merchant payout reports only when the merchant is configured with metadataKeys during onboarding and the particular payment transaction includes those metadataKeys.

Sample MetaDataKeys​

| **Field**     | **Description**                              |
|---------------|----------------------------------------------|
| `orderId`     | Order ID for which the payment was received. |
| `shippingId`  | Shipping ID of the order.                    |