Used in Shop Integration and Gateway Integration

Overview

This webhook is used to validate a user who has selected a product in the shop. They will be asked to provide their user ID, and the Carry1st Platform will call this webhook to validate it. Once the Pay1st Partner has implemented the webhook, it needs to be configured as part of the Product Settings.

API Description

URL Format

GET: https://<webhook_url>?playerId=<GAME_ID>

List of URL Query Parameters

Parameter	Format	Description
playerId	String	The user identifier. This should be a unique identifier used to identify a user in the Pay1st Partner's system.
productBundleId	String (Optional)	The identifier for the product bundle selected by the customer from Carry1st.
productBundleExternalId	String (Optional)	The SKU of the product bundle selected by the customer from the partner's side.
externalReference	String (Optional)	Any reference that is supplied by the merchant.
amount	Decimal (Optional)	The amount to be purchased by the customer.
currencyCode	String (Optional)	The currency code for the amount provided.
countryCode	String (Optional)	The country code for the user.
quantity	Integer (Optional)	The quantity selected by the customer for a product bundle.

Success Response

Valid HTTP Success Status Codes:

200 - Success

HTTP Response Body:

{
	"userId": "TEST123",
  "externalReference": "EXT_REF",
	"amount": 1000,
  "currencyCode": "NGN"
}

Error Response

See Error Handling for more details on handling error responses.