BokaMera.API.Host

<back to all web services

TestPaysonApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/payment/payson/apisettings/testTest payson api settingsTest payson api settings for the logged in company
TestPaysonApiSettings Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
SecurityUserIdbodystringNoThe payson security user id
SecurityPasswordbodystringNoThe payson security user password
ReceiverEmailbodystringNoThe payson receiver email
ReceiverFirstnamebodystringNoThe payson receiver firstname
ReceiverLastnamebodystringNoThe payson receiver lastname
PaysonApiSettingsTestResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNoIf the settings works or not

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/payson/apisettings/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestPaysonApiSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ReceiverEmail>String</ReceiverEmail>
  <ReceiverFirstname>String</ReceiverFirstname>
  <ReceiverLastname>String</ReceiverLastname>
  <SecurityPassword>String</SecurityPassword>
  <SecurityUserId>String</SecurityUserId>
</TestPaysonApiSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaysonApiSettingsTestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Success>false</Success>
</PaysonApiSettingsTestResponse>