This webhook is used to validate a user who has selected a game/product in the shop.
Used in Shop 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 | Mandatory | Description |
|---|---|---|---|
| playerId | String | Y | The user identifier. This should be a unique identifier used to identify a user in the Pay1st Partner's system. |
| productBundleId | String | The identifier for the product bundle selected by the customer from Carry1st. | |
| productBundleExternalId | String | The SKU of the product bundle selected by the customer from the partner's side. | |
| externalReference | String | Any reference that is supplied by the merchant. | |
| amount | Decimal | The amount to be purchased by the customer. | |
| currencyCode | String | The currency code for the amount provided. | |
| countryCode | String | The country code for the user. | |
| quantity | Integer | The quantity selected by the customer for a product bundle. |
Response
Example Successful Response
The Partner should send the following HTTP response JSON payload:
{
"userId": "TEST123",
"externalReference": "EXT_REF",
"amount": 1000,
"currencyCode": "NGN"
}HTTP Response Codes
These are the HTTP response codes that should be returned by the partner:
| HTTP Status Code | Name | Description |
|---|---|---|
| 200 | Success | This indicates that User Validation is successful |
| 400 | Bad Request | This indicates that an error occurred in the request. See Handling Error Codes |
Error Handling
See Handling Error Codes for more details on handling error responses.