Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Data Structures‎ > ‎

Off Platform Purchase Information

Data Structure holding information about a purchase that was charged off of the Group Commerce platform.

Fields:
Field Data Type Nulls Description
amountCharged decimal Y The amount charged externally to the consumer for the payment transaction.
creditValueUsed
decimal
Y
The credit value used externally for the payment transaction.
paymentType int
Y
The payment type for the external payment transaction PaymentType values are not defined in the GroupCommerce platform - you define your own (e.g. 1 - credit card, 2 - mobile)
transactionId string
Y
A reference id for the external payment transaction.
 

Sample JSON Response:
{
    "amountCharged": 10,
    "creditValueUsed": null,
    "paymentType": 2,
    "transactionId": "test"
}



Sample XML Response:
<offPlatformPurchaseInformation>
        <amountCharged>10</amountCharged>
        <creditValueUsed i:nil="true" />
        <paymentType>2</paymentType>
        <transactionId>test</transactionId>
</offPlatformPurchaseInformation>

Comments