Subscription Object Details

Status Changelog Dashboard Create a Ticket

Search…

Subscription Schema
Key
Type                      
Required                  
Description
_id
String
N.A. Included in API response
Object ID of Subscription
client_id
String
N.A. Included in API response
ID of your client object
is_active
Boolean
No
true if subscription is active else false.
scope
Array of Strings
Yes
See Allowed Scopes for more details.
url
Array of Objects
Yes
URL Destination for webhooks
Allowed Scopes
Scope
Effect
USERS|POST
When a user is created with your gateway, you will receive a webhook
USER|PATCH
When a user in your platform is updated, you will receive a webhook
NODES|POST
When a node is created with your gateway credentials, you will receive a webhook
NODE|PATCH
When a node is updated with your gateway credentials, you will receive a webhook
TRANS|POST
When a transaction is created within your gateway credentials, you will receive a webhook
TRANS|POST|JIT
When a transaction is created within your gateway credentials that requires Transaction Decisioning, you will receive a webhook.
TRAN|PATCH
When a transaction is updated with your gateway credentials, you will receive a webhook
SUBNETS|POST
When a subnet is created with your gateway credentials, you will receive a webhook
SUBNET|PATCH
Whenever a subnet is updated with your gateway credentials, you will receive a webhook
​

API References - Previous

Subscriptions

Webhook Object Details

Last modified 4mo ago

Export as PDF

Copy link

Contents

Subscription Schema

Allowed Scopes

Subscription Schema

Allowed Scopes

​