Welcome to Wikipay API v1

This API allows developers to easily integrate with Multicaixa to accept payments. You have endpoints to generate numeric references for payments and to receive notification of payments when they occur.

The Wikipay API is organized around REST. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. JSON will be returned in all responses from the API, including errors.

API Format

All request bodies should have content type application/json and be valid JSON. The Content-Type header must be set in all requests that include a JSON body:

Content-Type: application/json

Authentication

You authenticate to the Wikipay API by providing your API Key in the Authorization header of every request:

Authorization: [YOUR_API_KEY]

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Errors

References

A reference must be created whenever you want to receive a payment of a given amount.

To create one you must specify at least an amount and an expiry date. Additionaly you can specify any number of custom_fields. A reference will have the following attributes (all attributes, except custom_fields, have JSON strings as values):

Get

This endpoint retrieves all references in the system, sorted by descending order of creation date.

curl "https://api.wikipay.ao/v1/reference" \
  -H 'Authorization: sferdfbGE47fb22eZvKYlo2Cc0fo87EHa' \
  -H 'Content-Type: application/json' \


                                                                

{
  "references": [
    {
      "status": " Paid",
      "number": "002 000 319",
      "id": "00424002000319",
      "expiry_date": "2021-06-08 23:59:00",
      "custom_fields": {
        "name": "",
        "tel": "",
        "email": "",
        "invoice": ""
      },
      "amount": "666.00"
    },
    {
      "status": " Expired",
      "number": null,
      "id": "1",
      "expiry_date": "2021-06-08 23:59:00",
      "custom_fields": {
        "name": "",
        "tel": "",
        "email": "",
        "invoice": ""
      },
      "amount": "666.98"
    }
  ],
  "meta": {
    "total_count": 10,
    "offset": 0,
    "limit": 20
  }
}

                                                                

Creat

This endpoint generates a new payment reference for a given amount.

curl -XPOST 'https://api.wikipay.ao/v1/reference/create' \
  -H 'Authorization: sferdfbGE47fb22eZvKYlo2Cc0fo87EHa' \
  -H 'Content-Type: application/json' \
  -d '{
"reference": 
{
  "amount": "5.00",
  "expiry_date": "2021-06-16T21:58:00z",
  "custom_fields": {
    "nome": "D",
    "encomenda": "2021/0333",
    "telefone": "1",
    "email": "1"
  }
}
}' \


                                                                

{
  "reference": {
    "amount": "5.00",
    "created_at": "",
    "custom_fields": {
      "nome": "D",
      "encomenda": "2021/0333",
      "telefone": "1",
      "email": "1"
    },
    "entity_id": "00999",
    "expiry_date": "2021-06-16T21:58:00z",
    "id": "A8KFqnMLD0Zn2UpZqK",
    "number": "741 820 581",
    "product_bitmap": 1,
    "status": "",
    "updated_at": ""
  }
}

                                                                

Payment

This endpoint can be used to fetch any new payment events that occured in the system. It works conceptually as a queue, and all payments are returned in the order they ocurred.

You can retrieve up to 100 payments in a single call. Each request will return all unacknowledged payments unless visibility_timeout is specified, in which case all payments returned will be reserved for visibility_timeoutseconds, meaning that they are not returned in a subsequent call to the endpoint. If an acknowledgement indicating that they have been sucessfully processed is not sent within that timeframe, they will become available again.

A Payment event will have the following attributes (all attributes, except custom_fields, have JSON strings as values):

Get

This endpoint retrieves all Payment events that have not been acknowledged.

curl "https://api.wikipay.ao/v1/payment" \
  -H 'Authorization: sferdfbGE47fb22eZvKYlo2Cc0fo87EHa' \
  -H 'Content-Type: application/json' \


                                                                

{
  "payments": [
    {
      "terminal_type": "01",
      "terminal_transaction_id": "00123",
      "terminal_location": "Luanda",
      "terminal_id": "00456",
      "reference_number": "000000002001002",
      "reference_id": "8uVigNJ7Jj4hvVMdhQ",
      "id": "449500352608",
      "entity_id": "00424",
      "datetime": "2015-05-10T17:43:10Z",
      "fee": "150",
      "period_id": "1",
      "period_end_datetime": "2015-05-10 20:00:00",
      "custom_fields": {
        "name": "",
        "tel": "",
        "email": "",
        "invoice": ""
      },
      "amount": "5000.09"
    },
    {
      "terminal_type": "01",
      "terminal_transaction_id": "00123",
      "terminal_location": "Luanda",
      "terminal_id": "00456",
      "reference_number": "000000002000319",
      "reference_id": "8uVigNJ7Jj4hvVMdhQ",
      "id": "449500352608",
      "entity_id": "00424",
      "datetime": "2015-05-10T17:43:10Z",
      "fee": "150",
      "period_id": "1",
      "period_end_datetime": "2015-05-10 20:00:00",
      "custom_fields": {
        "name": "",
        "tel": "",
        "email": "",
        "invoice": ""
      },
      "amount": "5000"
    }
  ],
  "meta": {
    "total_count": 2,
    "offset": 0,
    "limit": 20
  }
}

                                                                

Create a Mock Payment

Webhook