Skip to main content
WEBHOOK
payment.succeeded
{
  "Ewallet (Zapper)": {
    "id": "evt_1383773372",
    "type": "payment.succeeded",
    "data": {
      "id": "pay_1723812793",
      "status": "succeeded",
      "amount": 300,
      "currency": "ZAR",
      "country": "ZA",
      "external_reference": "order_id_2331120",
      "payment_method_details": {
        "type": "ewallet",
        "ewallet": {
          "name": "zapper"
        }
      },
      "metadata": {
        "order_id": "o_b5MuE6le7p9W5Ufsf8tQk"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "Card (Mastercard credit)": {
    "id": "evt_81239839123",
    "type": "payment.succeeded",
    "data": {
      "id": "pay_123123123",
      "status": "succeeded",
      "amount": 300,
      "currency": "ZAR",
      "country": "ZA",
      "external_reference": "order_id_2331120",
      "payment_method_details": {
        "type": "card",
        "card": {
          "type": "credit",
          "scheme": "mastercard",
          "bin": "527346",
          "last4": "3333"
        }
      },
      "metadata": {
        "order_id": "o_b5MuE6le7p9W5Ufsf8tQk"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "Bank transfer (ABSA)": {
    "id": "evt_1383773372",
    "type": "payment.succeeded",
    "data": {
      "id": "pay_1723812793",
      "status": "succeeded",
      "amount": 300,
      "currency": "ZAR",
      "country": "ZA",
      "external_reference": "order_id_2331120",
      "payment_method_details": {
        "type": "bank_transfer",
        "bank_transfer": {
          "bank": "absa"
        }
      },
      "metadata": {
        "order_id": "o_b5MuE6le7p9W5Ufsf8tQk"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "Bank transfer (Capitec)": {
    "id": "evt_1383773372",
    "type": "payment.succeeded",
    "data": {
      "id": "pay_1723812793",
      "status": "succeeded",
      "amount": 300,
      "currency": "ZAR",
      "country": "ZA",
      "external_reference": "order_id_2331120",
      "payment_method_details": {
        "type": "bank_transfer",
        "bank_transfer": {
          "bank": "capitec",
          "phone_number": "+27821234567"
        }
      },
      "metadata": {
        "order_id": "o_b5MuE6le7p9W5Ufsf8tQk"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

The public key (pk_test_TYooMQauvdEDq54NiTt6F5zVxjGmZcjdZa) or secret key (sk_test_4eC39HqLyjWDarjtT1zdp7dc) used for making authenticated calls to the API.

Body

application/json

Event payload for payment lifecycle webhooks.

​
id
string
required

Unique identifier for the event.

​
type
enum<string>
required

Type of event being emitted.

Available options:
payment.succeeded,
payment.attempt_failed
​
data
object
required

Payment data associated with the event.