Custom Attributes

Contents

• Overview
• Example
• Revision History

Overview

While the endpoints mentioned in the previous API sections have a definite list of attributes associated to each entity, they can be extended using custom attributes. These custom attributes are designed as name value pairs which can be agreed based on the implementation and the specific requirement (as needed). The following example illustrates the use of custom attributes.

Example

POST /transaction HTTP/1.1
Content-Type: application/json
{
  "extAccountIdType": "MSISDN",
  "extAccountId": "9251234567",
  "pin": "447064",
  "description": "Monthly payment for PartnerOne charges for May 2019",
  "productIds": ["837346"],
  "amount": "15",
  "currency": "USD",
  "type": "prepaid",
  "taxIncluded": "Y",
  "extTransactionId": "78984515198",
  "extendedAttributes": {
    "attrib1": "abc",
    "attrib2": "cde",
    "attrib3": "def"
  }
}

Revision History

Version	Description
2019.08	Initial release.
2019.12	Reformatted the Custom Attributes example.
	Added Contents and Revision History sections.