Customer Sync Notification

post

https://{merchant_server}/api/sync

Notification from Banxis where the merchant receives the customer's details from their CRM when an agent attempts to access the Virtual Terminal for a customer from the Backoffice.

To enable this retrieval, the CRM must implement an API callback endpoint that will be available to receive the request from Banxis and respond with the appropriate customer information.

Important: Ensure that you have provided the callback URL to your technical support representative before attempting to use the Virtual Terminal.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

cid

string

required

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.

order_id

string

length ≤ 50

Transaction or session identifier in your system.

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).

Headers

gt-authentication

string

required

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

merchant_id
application_key
timestamp
cid

The optional order_id request field is not included in the signature for v1.3

Response

200OK - Successful response