Payment notice

API change history

Payment notice for a single booked appointment for a patient.

Register payment

Register payment for a given appointment for a given patient. This API can only be used to set payment status to PAID

Try it

Request URL

Request headers

(optional)
string

The patient number when acting as a care giver or partner.

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.
string
OAuth 2.0 access token obtained from OAuth2 Authorization. Supported grant types: Authorization code, Client credentials.

Request body

The payment

{
  "status": "PAID",
  "contactId": "string",
  "paymentType": "CASH"
}
{
  "type": "object",
  "required": [
    "contactId",
    "status",
    "paymentType"
  ],
  "properties": {
    "status": {
      "description": "Status of the payment",
      "type": "string",
      "enum": [
        "PAID"
      ]
    },
    "contactId": {
      "description": "Id of the appointment that should be set as paid.",
      "type": "string"
    },
    "paymentType": {
      "description": "Type of payment",
      "type": "string",
      "enum": [
        "CASH",
        "CARD"
      ]
    }
  }
}

Response 200

Request succeeded for the given patient.

[
  {
    "ResultCode": "OK",
    "Comment": "string",
    "Any": [
      {}
    ]
  }
]
{
  "description": "List of payments",
  "type": "array",
  "items": {
    "properties": {
      "ResultCode": {
        "type": "string",
        "enum": [
          "OK",
          "ERROR",
          "INFO"
        ]
      },
      "Comment": {
        "type": "string"
      },
      "Any": {
        "type": "array",
        "items": {
          "type": "object"
        }
      }
    }
  }
}

Response 401

Invalid access token. The client must request a new token from the authorization server.

{
  "statusCode": 401,
  "message": "Invalid access token."
}
{
  "description": "Generic error response for all systems and applications errors.",
  "properties": {
    "error": {
      "description": "Error reason in text.",
      "type": "string"
    },
    "path": {
      "description": "Path to requested resource.",
      "type": "string"
    },
    "status": {
      "description": "HTTP status.",
      "type": "integer"
    },
    "timestamp": {
      "description": "Timestamp (milliseconds since epoch).",
      "type": "integer"
    }
  },
  "type": "object"
}

Response 403

Insufficient OAuth2 scope for access.

{
  "statusCode": 403,
  "message": "Insufficient scope."
}
{
  "description": "Generic error response for all systems and applications errors.",
  "properties": {
    "error": {
      "description": "Error reason in text.",
      "type": "string"
    },
    "path": {
      "description": "Path to requested resource.",
      "type": "string"
    },
    "status": {
      "description": "HTTP status.",
      "type": "integer"
    },
    "timestamp": {
      "description": "Timestamp (milliseconds since epoch).",
      "type": "integer"
    }
  },
  "type": "object"
}

Response 429

Too many requests in a given amount of time.

{
  "statusCode": 429,
  "message": "Rate limit is exceeded. Try again in 5 seconds."
}
{
  "description": "Generic error response for all systems and applications errors.",
  "properties": {
    "error": {
      "description": "Error reason in text.",
      "type": "string"
    },
    "path": {
      "description": "Path to requested resource.",
      "type": "string"
    },
    "status": {
      "description": "HTTP status.",
      "type": "integer"
    },
    "timestamp": {
      "description": "Timestamp (milliseconds since epoch).",
      "type": "integer"
    }
  },
  "type": "object"
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.openservices.cambio.se/patients/paymentnotice/"
-H "patient: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("patient", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            var uri = "https://api.openservices.cambio.se/patients/paymentnotice/?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.openservices.cambio.se/patients/paymentnotice/");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("patient", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{access token}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.openservices.cambio.se/patients/paymentnotice/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("patient","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.openservices.cambio.se/patients/paymentnotice/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"patient"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.openservices.cambio.se/patients/paymentnotice/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'patient' => '',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'patient': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.openservices.cambio.se')
    conn.request("POST", "/patients/paymentnotice/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'patient': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.openservices.cambio.se')
    conn.request("POST", "/patients/paymentnotice/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.openservices.cambio.se/patients/paymentnotice/')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['patient'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body