Swagger UI is available here and lists the available operations.
The API uses JSON Web Tokens (JWT) as the authentication mechanism.
The JWT must be set as part of the requests, in the Authorization header.
Example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
IMPORTANT : Don't call this API directly from a client-side application, the JWT will be visible to the users and may be abused. If you have a use case where this is relevant, please contact us for suggestions.
POST https://instapay.intele.com/api/batches
Content-Type: application/vnd.instapay.batchrequest.v1+json
Accept: application/vnd.instapay.batchresponse.v1+json
Authorization: Bearer eyJ...
{
"batchReference": "a_unique_reference",
"expires": "2017-01-01T09:00:00.000Z",
"recipients": [
{
"reference":"a_unique_reference",
"msisdn": "+47XXXXXXXX",
"variables": {
"name":"John",
"amount": "1"
},
"type":0,
"payment": {
"amount": 100,
"currency": "NOK"
},
"settings": {
"differentiator": "March billing",
"invoiceNode": "2017-03"
}
},
{
"reference":"a_unique_reference",
"msisdn": "+47XXXXXXXX",
"variables": {
"name":"Jane",
"amount": "2"
},
"type":0,
"payment": {
"amount": 200,
"currency": "NOK"
}
}
],
"messageTemplates":[
{
"type":0,
"text":"Dear {{name}}. On behalf of company X you're receiving this message due to an unpaid invoice. Amount kr. {{amount}},-. Tap the link to pay."
}
],
"directPaymentSettings": {
"businessModel": "STREX-PAYMENT",
"serviceCode": "14001"
},
"action": 1,
"receiptTemplates": [
{
"type": 0,
"text": "Dear {{name}}, the invoice payment has been registered."
}
],
"serviceOverrides": {
"serviceTemplates": [
{
"type": 0,
"text1": "string",
"text2": "string",
"text3": "string",
"text4": "string"
}
]
}
}
Property
Type
Description
Mandatory
batchReference
string
Unique identifier for the batch
Y
recipients
array of Recipient
SMS message recipient(s)
Y
messageTemplates
array of Message Template
SMS template(s)
Y
action
one of Batch Action
Batch action
Y
expires
datetime
Date/time when the batch expires
N
directPaymentSettings
Direct Payment Settings Direct Payment settings, only mandatory if enabled for the service
N
receiptTemplates
array of Receipt Template
Receipt template(s)
N
serviceOverrides
Service Overrides Service overrides, will override default settings
N
Property
Type
Description
Mandatory
reference
string
Unique identifier for the recipient
Y
msisdn
string
MSISDN of the recipient
Y
type
one of Request Type
Request type
Y
payment
Payment Payment details
Y
variables
array of Variable
Variable(s) that should be used in the template
N
settings
one of Recipient settings
Recipient settings
N
Property
Type
Description
Mandatory
amount
int
Amount to pay, in lowest monetary unit
Y
currency
string
Currency
Y
Property
Type
Description
Mandatory
type
one of Request Type
Request type
Y
text
string
Template text, including variable placeholders
Y
TIP : The predefined variable paymentLink may be used in the text. If the variable is omitted the link will be inserted at the end.
Property
Type
Description
Mandatory
differentiator
string
Arbitrary string defined by the client to enable grouping messages in certain statistic reports.
Y
invoiceNode
string
Arbitrary string defined by the client to enable grouping messages on the service invoice to the client.
Y
Value
Description
1
Send SMS message(s)
2
Create link(s)
Property
Type
Description
Mandatory
businessModel
string
Business model, valid values are listed here
Y
serviceCode
string
Service code, valid values are listed here
Y
Property
Type
Description
Mandatory
type
one of Request Type
Request type
Y
text
string
Template text, including variable placeholders
Y
The following predefined variables may be used in templates.
Property
Type
Description
Mandatory
serviceTemplates
array of Service Template
Service template
Y
If set, these will override the default values for the service. Fallback values will be used for those which are not specified.
Property
Type
Description
Mandatory
type
one of Request Type
Request type
Y
text1
string
Template text, including variable placeholders
N
text2
string
Template text, including variable placeholders
N
text3
string
Template text, including variable placeholders
N
text4
string
Template text, including variable placeholders
N
Value
Description
0
Payment
1
Reminder
2
Dunning
3
Lost case
Content-Type: application/vnd.instapay.batchresponse.v1+json
{
"batchReference": "a_unique_reference",
"smsStatuses": [
{
"reference": "a_unique_reference",
"statusCode": 0,
"statusMessage": "Message enqueued for sending"
},
{
"reference": "a_unique_reference",
"statusCode": 0,
"statusMessage": "Message enqueued for sending"
}
],
"paymentLinks": null,
"validationErrors": null
}
Response example, validation errors Content-Type: application/vnd.instapay.batchresponse.v1+json
{
"batchReference": "a_unique_reference",
"smsStatuses": null,
"paymentLinks": null,
"validationErrors": {
"recipients[0].variables": [
"The variable 'amount' is missing"
],
"recipients[0].variables[0]": [
"The variable 'name' is missing in the template"
]
}
}
Code
Description
200
Ok
400
Validation error(s)
401
Unauthorized
500
Internal server error
Property
Type
Description
batchReference
string
Unique identifier for the batch
smsStatuses
array of Recipient Status
SMS recipient status
paymentLinks
array of Payment Link
Payment link(s)
validationErrors
array of Validation Error
Request validation error(s)
Property
Type
Description
reference
string
Unique reference for the recipient
statusCode
int
Status code
statusMessage
string
Status message
Property
Type
Description
reference
string
Unique reference for the recipient
link
string
Payment link
Property
Type
Description
The key path of the invalid input
array of string
Validation error message(s)
IMPORTANT : There will be one property for each key path that failed validation.
GET https://instapay.intele.com/api/batches/{reference}/status
Accept: application/vnd.instapay.batchstatus.v1+json
Authorization: Bearer eyJ...
Parameter
Type
Description
Mandatory
reference
string
Unique reference for the batch
Y
Content-Type: application/vnd.instapay.batchstatus.v1+json
{
"reference": "a_unique_reference",
"smsStatus": {
"sent": 2,
"delivered": 2,
"clicked": 2
},
"paymentProviderStatus": {
"averageConversionTimeInMinutes": 3,
"paymentProviders": [
{
"paymentProvider": 1,
"selected": 2,
"paid": 2
}
]
},
"recipientStatus": [
{
"reference": "a_unique_reference",
"step": 6
},
{
"reference": "a_unique_reference",
"step": 4
}
]
}
Code
Description
200
Ok
401
Unauthorized
404
Batch not found
500
Internal server error
Property
Type
Description
sent
int
Number of sent SMS messages
delivered
int
Number of delivered SMS messages
clicked
int
Number of links that were clicked in the SMS messages
Property
Type
Description
averageConversionTimeInMinutes
int
Average conversion time, in minutes
paymentProviders
array of Payment Provider Payment Status
Payment provider status
Payment Provider Payment Status
Property
Type
Description
paymentProvider
one of Payment Provider
Payment provider
selected
int
Number of recipients that have selected this payment provider
paid
int
Number of recipients that have paid using this payment provider
Value
Description
2
Direct Payment (mobile operator billing)
5
Payment Card
6
Mobile Banking
7
SMS
8
Apple Pay
9
PayPal
Property
Type
Description
reference
string
Unique reference for the recipient
step
one of Step
Current step of the recipient
Value
Description
0
SMS failed
1
SMS enqueued
2
SMS received
3
SMS clicked
4
Picked payment provider
5
Payment failed
6
Paid
It is only possible to refund one specific recipient at a time. You must supply both the batchReference and the recipient's reference in order to make a refund. Please note that the whole amount is refunded.
DELETE https://instapay.intele.com/api/batches/{batchReference}/{recipient.Reference}
Accept: application/vnd.instapay.refundrequest.v1+json
Authorization: Bearer eyJ...
Code
Description
200
Ok
400
Validation error(s)
401
Unauthorized
404
Batch and/or recipient not found
424
Unable to refund - 3rd party rejected the refund
500
Internal server error
