Retrieving information about the number for the service

SMS

Operations

Service list

Request

Retrieving a list of available SMS services on the account

Security

bearerAuth

curl -i -X GET \
  https://docs.simpay.pl/_mock/en/apis/sms \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

successbooleanrequired

Request status

Example: true

dataArray of objects(smsServiceList)required

Example: [{"id":"d151e4f9","type":"ONE_TIME_CODE","status":"service_active","name":"TEST","prefix":"SIM","suffix":"TESTSIMPAY","adult":false,"created_at":"2021-11-08T18:18:53+01:00"}]

data[].idstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

data[].typestring(ServiceType)required

SMS Service Type

Enum"ONE_TIME_CODE""CODE_PACK""API_URL"

data[].statusstring(ServiceStatus)required

Service Status

Enum"service_new""service_active""service_blocked""service_rejected""service_verify""service_ongoing_registration"

data[].namestringrequired

Service name

data[].prefixstringrequired

Service prefix, i.e. the first part of the SMS content, e.g. SIM

data[].suffixstringrequired

Service suffix, i.e. the second part of the SMS content

data[].descriptionstring

Service description

data[].adultbooleanrequired

Information on whether the service is 18+

data[].created_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

paginationobject(Pagination)required

pagination.totalintegerrequired

Total number of records

Example: 1

pagination.countintegerrequired

Number of records on the current page

Example: 1

pagination.per_pageintegerrequired

Maximum number of records per page

Example: 15

pagination.current_pageintegerrequired

Current page

Example: 1

pagination.total_pagesintegerrequired

Total number of pages

Example: 1

pagination.linksobjectrequired

URLs to pages

pagination.links.next_pagestring or null(url)required

URL to the next page

Example: null

pagination.links.prev_pagestring or null(url)required

URL to the previous page

Example: null

Response

application/json

{
  "success": true,
  "data": [
    { … }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "per_page": 15,
    "current_page": 1,
    "total_pages": 1,
    "links": { … }
  }
}

Retrieving service information

Request

Security

bearerAuth

Path

serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

curl -i -X GET \
  'https://docs.simpay.pl/_mock/en/apis/sms/{serviceId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

successbooleanrequired

Request status

Example: true

dataArray of objects(smsService)required

Example: {"id":"d151e4f9","type":"ONE_TIME_CODE","status":"service_active","name":"TEST","prefix":"SIM","suffix":"TESTSIMPAY","adult":false,"numbers":[7055,7155,7255],"created_at":"2021-11-08T18:18:53+01:00"}

data[].idstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

data[].typestring(ServiceType)required

SMS Service Type

Enum"ONE_TIME_CODE""CODE_PACK""API_URL"

data[].statusstring(ServiceStatus)required

Service Status

Enum"service_new""service_active""service_blocked""service_rejected""service_verify""service_ongoing_registration"

data[].namestringrequired

Service name

data[].prefixstringrequired

Service prefix, i.e. the first part of the SMS content, e.g. SIM

data[].suffixstringrequired

Service suffix, i.e. the second part of the SMS content

data[].descriptionstring

Service description

data[].adultbooleanrequired

Information on whether the service is 18+

data[].numbersArray of integers(ServicesNumbers)required

Items Enum705571557255735574557555763677464784647936

data[].created_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

Response

application/json

{
  "success": true,
  "data": {
    "id": "d151e4f9",
    "type": "ONE_TIME_CODE",
    "status": "service_active",
    "name": "TEST",
    "prefix": "SIM",
    "suffix": "TESTSIMPAY",
    "adult": false,
    "numbers": [ … ],
    "created_at": "2021-11-08T18:18:53+01:00"
  }
}

Verifying code correctness

Request

Security

bearerAuth

Path

serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

Bodyapplication/jsonrequired

One of:

codestring(SmsCode)[ 6 .. 6 ]^[A-Z0-9]{6}$required

SMS code

numberinteger(ServiceNumbers)required

Number to send SMS messages to

Enum705571557255735574557555763677464784647936

curl -i -X POST \
  'https://docs.simpay.pl/_mock/en/apis/sms/{serviceId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "AB12D6",
    "number": 7055
  }'

Responses

Bodyapplication/json

One of:

successbooleanrequired

Request status

Example: true

dataArray of objects(smsServiceCheckCodeUsedData)required

Example: {"used":true,"code":"ABC1D6","test":true,"from":"48123123123","number":7055,"value":0.5,"send_at":"2021-11-14T19:00:36+01:00"}

data[].usedbooleanrequired

Information on whether the code has been used

data[].codestringrequired

SMS code

data[].testbooleanrequired

Information whether the code is a test code

data[].fromintegerrequired

Number from which the SMS was sent

data[].numberinteger(ServiceNumbers)required

Number to send SMS messages to

Enum705571557255735574557555763677464784647936

data[].valuenumber(float)required

Net amount of the SMS

data[].used_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

Response

application/json

{
  "success": true,
  "data": {
    "used": true,
    "code": "ABC1D6",
    "test": true,
    "from": "48123123123",
    "number": 7055,
    "value": 0.5,
    "send_at": "2021-11-14T19:00:36+01:00"
  }
}

Retrieving a list of transactions

Request

Security

bearerAuth

Path

serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

curl -i -X GET \
  'https://docs.simpay.pl/_mock/en/apis/sms/{serviceId}/transactions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

successbooleanrequired

Request status

Example: true

dataArray of objects(ServiceTransaction)required

Example: [{"id":1,"from":48123123123,"code":"ABC1D6","used":false,"send_number":7055,"value":0.5,"send_at":"2021-11-14T19:00:36+01:00"}]

data[].idintegerrequired

SMS transaction ID

data[].fromintegerrequired

Number from which the SMS was sent

data[].codestringrequired

SMS code

data[].usedbooleanrequired

Information on whether the code has been used

data[].send_numberinteger(ServiceNumbers)required

Number to send SMS messages to

Enum705571557255735574557555763677464784647936

data[].valuenumber(float)required

Net amount of the SMS

data[].send_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

paginationobject(Pagination)required

pagination.totalintegerrequired

Total number of records

Example: 1

pagination.countintegerrequired

Number of records on the current page

Example: 1

pagination.per_pageintegerrequired

Maximum number of records per page

Example: 15

pagination.current_pageintegerrequired

Current page

Example: 1

pagination.total_pagesintegerrequired

Total number of pages

Example: 1

pagination.linksobjectrequired

URLs to pages

pagination.links.next_pagestring or null(url)required

URL to the next page

Example: null

pagination.links.prev_pagestring or null(url)required

URL to the previous page

Example: null

Response

application/json

{
  "success": true,
  "data": [
    { … }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "per_page": 15,
    "current_page": 1,
    "total_pages": 1,
    "links": { … }
  }
}

Retrieving transaction information

Request

Security

bearerAuth

Path

serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

transactionIdintegerrequired

curl -i -X GET \
  'https://docs.simpay.pl/_mock/en/apis/sms/{serviceId}/transactions/{transactionId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

successbooleanrequired

Request status

Example: true

dataobject(ServiceTransaction)required

data.idintegerrequired

SMS transaction ID

data.fromintegerrequired

Number from which the SMS was sent

data.codestringrequired

SMS code

data.usedbooleanrequired

Information on whether the code has been used

data.send_numberinteger(ServiceNumbers)required

Number to send SMS messages to

Enum705571557255735574557555763677464784647936

data.valuenumber(float)required

Net amount of the SMS

data.send_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

Response

application/json

{
  "success": true,
  "data": {
    "id": 1,
    "from": 48123123123,
    "code": "ABC1D6",
    "used": false,
    "send_number": 7055,
    "value": 0.5,
    "send_at": "2021-11-14T19:00:36+01:00"
  }
}

Retrieving information about numbers for the service

Request

Security

bearerAuth

Path

serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

curl -i -X GET \
  'https://docs.simpay.pl/_mock/en/apis/sms/{serviceId}/numbers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

successbooleanrequired

Request status

Example: true

dataArray of objects(smsNumber)required

Example: [{"number":7055,"value":2,"value_net":2.46,"adult":false}]

data[].numberinteger(ServiceNumbers)required

Number to send SMS messages to

Enum705571557255735574557555763677464784647936

data[].valuenumber(float)required

data[].value_netnumber(float)required

data[].adultbooleanrequired

paginationobject(Pagination)required

pagination.totalintegerrequired

Total number of records

Example: 1

pagination.countintegerrequired

Number of records on the current page

Example: 1

pagination.per_pageintegerrequired

Maximum number of records per page

Example: 15

pagination.current_pageintegerrequired

Current page

Example: 1

pagination.total_pagesintegerrequired

Total number of pages

Example: 1

pagination.linksobjectrequired

URLs to pages

pagination.links.next_pagestring or null(url)required

URL to the next page

Example: null

pagination.links.prev_pagestring or null(url)required

URL to the previous page

Example: null

Response

application/json

{
  "success": true,
  "data": [
    { … }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "per_page": 15,
    "current_page": 1,
    "total_pages": 1,
    "links": { … }
  }
}