logo
API docs by Redocly

Pokkit Score Partner API (1.0.0)

Download OpenAPI specification:

E-mail: info@pokkit.co.za License: Apache 2.0

Introduction

The Pokkit Score Partner API allows integration partners to retrieve information and status for customers belonging to their partner customer group.

API Usage

  1. Client ID and Client Secret required for authentication will be provided to you by the Pokkit administrator.
  2. Obtain an access token from the Pokkit authorization server.
  3. Retrieve basic customer information and status using the /score/customer-basic-info endpoint.
  4. Retrieve full customer information - including transaction history, active voucher details, investment information and score history - using the /score/customer-info endpoint.

Customers are identified by their Pokkit member number, ID/Passport number or mobile number - at least one must be provided with each request, together with your partner code.

Development Environment: https://dev-score.pokkit.io

Partner

Customer information endpoints for integration partners

Retrieve basic customer information and status

Returns basic customer information and status for a customer belonging to the specified partner. At least one of memberNumber, idNumber or mobileNumber must be provided.

Authorizations:
OAuth2
query Parameters
partnerCode
required
string
Example: partnerCode=KUDOUGH

The partner code configured for the partner

memberNumber
string
Example: memberNumber=2543296814

The customer's Pokkit member number

idNumber
string
Example: idNumber=1234567890987

The customer's ID/Passport/Permit number

mobileNumber
string
Example: mobileNumber=0821231231

The customer's 10-digit mobile number

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": "Customer successfully retrieved!",
  • "customer": {
    }
}

Retrieve full customer information

Returns basic customer information and status plus transaction history, active voucher details, investment information and score history for a customer belonging to the specified partner. At least one of memberNumber, idNumber or mobileNumber must be provided.

Authorizations:
OAuth2
query Parameters
partnerCode
required
string
Example: partnerCode=KUDOUGH

The partner code configured for the partner

memberNumber
string
Example: memberNumber=2543296814

The customer's Pokkit member number

idNumber
string
Example: idNumber=1234567890987

The customer's ID/Passport/Permit number

mobileNumber
string
Example: mobileNumber=0821231231

The customer's 10-digit mobile number

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": "Customer successfully retrieved!",
  • "customer": {
    },
  • "transactions": [
    ],
  • "activeVouchers": [
    ],
  • "investment": {
    },
  • "scores": [
    ]
}