Administration services

TAP's Administration Service API facilitates CRUD (Create, read, update, delete) operations for merchant setup (merchant onboarding).

C#PHPNodeShell

Scroll down for code samples, example requests and responses.
Select a language for code samples from the tabs or the mobile navigation menu.

Adds a new Merchant.

POST /ms/naa/admin/customer/v1/merchant

This operation adds a new Merchant.

Parameters

Authorizationstringrequired
Bearer Base64(consumer-key:consumer-secret)

Adds a new Merchant.

C#
PHP
Node
Shell

var client = new RestClient("https://api-gateway-pp.paas-test.bbsas.no/ms/naa/admin/customer/v1/merchant");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "SOME_STRING_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

merchantIdstringrequired
The unique merchantId.
namestringrequired
The name of the merchant.
orgNumberstringoptional
The optional merchant organisation number.
vatNumberstringoptional
The optional merchant vat number.
activeinteger (int32)required
Merchant status indicating 0 as active and 1 as inactive.
merchantCategoryCodestringoptional
The optional 4 character Merchant Category Code.
merchantCitystringoptional
The optional merchant's city.
countryCodestringoptional
The optional 2 character merchant's country code.
prefixstringoptional
The valid External Source prefix. This value is provided by TAP.
createdBystringrequired
Created by to identify caller of the API.
createdOnstringoptional
The optional created on indicating date of creation.
updatedBystringrequired
Updated by to identify caller of the API during update.
updatedOnstringoptional
The optional updated on indicating date of updation.
enableInvoicinginteger (int32)optional
Enable Invoicing status indicating 0 as Enable and 1 as disable.

Request body

{
    "merchantId": "string",
    "name": "string",
    "orgNumber": "string",
    "vatNumber": "string",
    "active": 1,
    "merchantCategoryCode": "string",
    "merchantCity": "string",
    "countryCode": "string",
    "prefix": "string",
    "createdBy": "string",
    "createdOn": "string",
    "updatedBy": "string",
    "updatedOn": "string",
    "enableInvoicing": 1
}

Responses

201The merchant has been created.optional
- idstringrequired
  Merchant id
400optional
The server did not understand or could not validate the input parameters.
500optional
The server experienced a runtime exception while processing the request. Try again later or contact customer support.

201

{
    "id": "string"
}

Modifies an existing active merchant.

PUT /ms/naa/admin/customer/v1/merchant/{merchantId}

This operation modifies an existing active merchant.

Parameters

Authorizationstringrequired
Bearer Base64(consumer-key:consumer-secret)
merchantIdstringrequired
MerchantId to be updated.

Modifies an existing active merchant.

C#
PHP
Node
Shell

var client = new RestClient("https://api-gateway-pp.paas-test.bbsas.no/ms/naa/admin/customer/v1/merchant/{merchantId}");
var request = new RestRequest(Method.PUT);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "SOME_STRING_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

merchantIdstringrequired
The unique merchantId.
namestringrequired
The name of the merchant.
orgNumberstringoptional
The optional merchant organisation number.
vatNumberstringoptional
The optional merchant vat number.
activeinteger (int32)required
Merchant status indicating 0 as active and 1 as inactive.
merchantCategoryCodestringoptional
The optional 4 character Merchant Category Code.
merchantCitystringoptional
The optional merchant's city.
countryCodestringoptional
The optional 2 character merchant's country code.
prefixstringoptional
The valid External Source prefix. This value is provided by TAP.
createdBystringrequired
Created by to identify caller of the API.
createdOnstringoptional
The optional created on indicating date of creation.
updatedBystringrequired
Updated by to identify caller of the API during update.
updatedOnstringoptional
The optional updated on indicating date of updation.
enableInvoicinginteger (int32)optional
Enable Invoicing status indicating 0 as Enable and 1 as disable.

Request body

{
    "merchantId": "string",
    "name": "string",
    "orgNumber": "string",
    "vatNumber": "string",
    "active": 1,
    "merchantCategoryCode": "string",
    "merchantCity": "string",
    "countryCode": "string",
    "prefix": "string",
    "createdBy": "string",
    "createdOn": "string",
    "updatedBy": "string",
    "updatedOn": "string",
    "enableInvoicing": 1
}

Responses

200The merchant has been modified.optional
- idstringrequired
  Merchant id
400optional
The server did not understand or could not validate the input parameters.
404The merchant was not found.optional
500optional
The server experienced a runtime exception while processing the request. Try again later or contact customer support.

200

{
    "id": "string"
}

Delete a merchant

DELETE /ms/naa/admin/customer/v1/merchant/{merchantId}

This operation deletes an existing merchant.

Parameters

Authorizationstringrequired
Bearer Base64(consumer-key:consumer-secret)
merchantIdstringrequired
MerchantId to be deleted.
userIdstringrequired
User/System id performing action.

Delete a merchant

C#
PHP
Node
Shell

var client = new RestClient("https://api-gateway-pp.paas-test.bbsas.no/ms/naa/admin/customer/v1/merchant/{merchantId}?userId=SOME_STRING_VALUE");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "SOME_STRING_VALUE");
IRestResponse response = client.Execute(request);

Responses

202The merchant has been deleted.optional
404The merchant was not found.optional
500optional
The server experienced a runtime exception while processing the request. Try again later or contact customer support.