Pawn2ME:Development/APIv1

Pawn2ME Version 1 API Calls

All calls require a store api key. That can be done by an admin via accounts.xceldata.com

/v1/authenticate/send

This endpoint is used to verify the api key. It will also return the name of the store.

POST -> https://api.pawn2me.com/v1/authenticate/send

{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }

Result:

{ "success": true, "key": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "store": "DEMO 1 STORE A" }

/v1/customers/signup-user

In order to use Pawn2ME, customers must first verify their device by activating it, per store.

This endpoint tells the server to send an activation link to a specific sms/email address.

A customer cannot receive notices before activating.

POST -> https://api.pawn2me.com/v1/customers/signup-user

Single Customers

{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "address-type": "sms", "address": "5551234567", "first-name": "Test", "last-name": "Testerson", "id": "D1234567", "language-type": "en" }

Result:

{ "success": true, "id": "D1234567", "address": "5551234567", "address-type": "sms" }

Multiple Customers

{ "customers": [ { "address": "test@test.com", "address-type": "email", "first-name": "TESTLA", "id": "D1234567", "language-type": "EN", "last-name": "TESTERFIELD" }, { "address": "5551234567", "address-type": "sms", "first-name": "TEST", "id": "D9876543", "language-type": "EN", "last-name": "TESTERSON" } ], "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }

Result:

{ "success": true, "customers": [ { "success": true, "id": "D1234567", "address": "test@test.com", "address-type": "email" }, { "success": true, "id": "D9876543", "address": "5551234567", "address-type": "sms" } ] }

/v1/customers/get-updates

This endpoint allows you to know which of your customers are activated or not.

Recording this information allows you to notify the teller that a user is signed up with Pawn2ME and with what account.

The user must have authorized their device to show up as activated. You will only see the activation status of people who signed up at your store.

POST -> https://api.pawn2me.com/v1/customers/get-updates

{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93" }

Result:

{ "success": true, "updates": [ { "id": "D1111111", "added": "2018-02-06 18:06:21", "updated": "2018-02-06 18:14:32", "activated": true, "device": { "type": "sms", "address": "5551234567" } }, { "id": "D9999999", "added": "2018-02-07 23:10:02",

/v1/notices/confirm-batch

In order to send a batch it must be confirmed.

This endpoint tells the server to actually allow sending notices to the previously submitted batch number.

POST -> /v1/notices/confirm-batch

{ "token": "1E17162A-8355-4FF2-8DCD-E5CEE676FD93", "batch-no": "9" }

Result:

{ "success": true, "count": 58 }