SOCODEE Payment

1. Socodee Meter Inquiry
api/reporting/transactionstatus/xxxx

This method returns information about the provided meter number.

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Request Formats
api/reporting/transactionstatus/xxxx

where xxxx is the meter number

Response Information
Sample Response
{ "customerName":"string", "currency":"USD", "amount":3 }

2. Socodee Payment Request

api/reporting/transactionstatus/xxxx

This method initiates a purchase request for electricity units to the provided meter number. On successful payment response, the tokens returned in the “AdditionalInformation” property should be sent to the customer to enable them load their meter with the response.

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

The table below provides information about the properties expected in the payload to be sent to this request:

PropertyDataType (maxSize)RequiredDescription
OrderObjectYesInformation about the operation to be performed
Order.customerFullNameString(180)NoFull Name for customer
Order.customerPhoneNumberString(180)NoPhone Number of the customer
Order.transactionReferenceString(20)YesReference transaction ID from source request to be used in reconciliations
Order.customerEmailAddressString(180)NoEmail address of the customer
Order.currencyString(3)YesChar 3 ISO currency code
Order.amountDecimal(8,2)YesAmount involved in the transaction
DestinationObjectYesInformation about the beneficiary
Destination.meternumberStringYesThe meter number
Destination.phoneNumberString(14)Yesphone number in international format (+243XXXX…)
Request Formats
Sample Request
{
  "order": {
    "customerFullName": "string",
    "customerPhoneNumber": "string",
    "customerEmailAddress": "string",
    "transactionReference": "string",
    "amount": 0,
    "currency": "USD”
  },

  "destination": {
    "meterNumber": "string",
    "phoneNumber": "string"
  }
}
Response Information
Sample Response
{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “statusCode”:”200”,
  “statusDescription”:”SUCCESS”,
  “additionalInformation”:{
  “token”:[“098271047832190472”,” 098271047832199782”,” 098271047832109812”],
  “deviceId”:” 45036882525”,
  “KWH”:”50.76”,
  “CustomerName”:”Fabrice K”
}

3. Socodee Transaction Inquiry

GET api/socodee/transactionstatus/{transactionid}

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Request Formats
api/socodee/transactionstatus/xxxx

where xxxx is the transactionId received in the transaction request

Response Information
Sample Response
{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “statusDescription”:”string”, //APPROVED,DECLINED,PENDING
  “statusCode”:”200” ,
  “additionalInformation”:{
  “token”:[“098271047832190472”,” 098271047832199782”,” 098271047832109812”],
  “deviceId”:” 45036882525”,
  “KWH”:”50.76”,
  “CustomerName”:”Fabrice K”
  }
}
GET api/socodee/transactionstatus/{transactionid}

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Request Formats
api/socodee/transactionstatus/xxxx

where xxxx is the transactionId received in the transaction request

Response Information
Sample Response
{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “statusDescription”:”string”, //APPROVED,DECLINED,PENDING
  “statusCode”:”200” ,
  “transactionDate”:”string”,
  “additionalInformation”:{
  “token”:[“098271047832190472”,” 098271047832199782”,” 098271047832109812”],
  “deviceId”:” 45036882525”,
  “KWH”:”50.76”,
  “CustomerName”:”Fabrice K”
  }
}
GET api/socodee/transactionstatusbyreference/{ transactionReference }

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Request Formats
api/socodee/transactionstatusbyreference/xxxx

where xxxx is the transactionReference sent in the original transaction request

Response Information
Sample Response
{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “statusDescription”:”string”, //APPROVED,DECLINED,PENDING
  “statusCode”:”200” ,
  “transactionDate”:”string”,
  “additionalInformation”:{
  “token”:[“098271047832190472”,” 098271047832199782”,” 098271047832109812”],
  “deviceId”:” 45036882525”,
  “KWH”:”50.76”,
  “CustomerName”:”Fabrice K”
  }
}