Subscription Notification

post

https://gw.banxispay.com/api/subscriptions

Notification from Banxis where merchant would receive subscription notifications when provided a notification_url while creating new a new subscription using the /api/v1.3/subscription endpoint (or via the Atlas Back Office).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

merchant_id

string

required

length ≤ 50

Merchant API client account identifier.

application_key

string

required

length ≤ 32

Identifier of your application (website).

version

string

required

length ≤ 3

API version.

timestamp

integer

required

Request time (unix timestamp, seconds).

event

string

enum

Defines the type of event being reported. Changes the schema of 'event_data'.

cid

string

length ≤ 50

Unique customer id in your system.

Note: Personally Identifiable Information (PII), such as email addresses, is strictly forbidden. If your user identifier contains any PII, you must hash or encrypt it before sending it to the API.

plan_id

string

length ≤ 32

Subscription Plan ID

subscription_id

string

length ≤ 32

Subscription ID

subscription_status

string

enum

length ≤ 8

Status of subscription. List of possible statuses:

Active - customer subscription in active status.
Inactive - customer subscription inactive.
Expired - customer subscription expired.
Canceled - customer subscription removed.

Allowed:

event_data

Data payload specific to the 'event' type.

Headers

gt-authentication

string

required

Authentication HTTP header of an incoming webhook subscription request from Banxis.
Verify the signature with the below attributes from the webhook customer sync request.

event
merchant_id
application_key
cid
plan_id
subscription_id
subscription_status
timestamp

Response

200OK - Successful response