Receeve Debt Servicing Platform v1.53.1

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

This is the API definition for interacting with Receeve's debt servicing platform. For more details please visit the "Integration Documentation" at http://knowledge.receeve.com/

Email: Support

Security

Authentication Use Case

getOauth2Token

Code samples

# You can also use wget
curl -X POST /v1/oauth2/token \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic NGExdm42azRhYzRocDV1dTNxMnF2NTU1NTU6MTE5NXVpdjlzdWI0Z2tjZ2RsOHRpb2UyMDlsdmNtdml2dTU1YjFlZjYwcjdsaFhYWFhYWA==' \
  -H 'Content-Type: application/x-www-form-urlencoded'

POST /v1/oauth2/token HTTP/1.1

Accept: application/json
Authorization: Basic NGExdm42azRhYzRocDV1dTNxMnF2NTU1NTU6MTE5NXVpdjlzdWI0Z2tjZ2RsOHRpb2UyMDlsdmNtdml2dTU1YjFlZjYwcjdsaFhYWFhYWA==
Content-Type: application/x-www-form-urlencoded


const headers = {
  'Accept':'application/json',
  'Authorization':'Basic NGExdm42azRhYzRocDV1dTNxMnF2NTU1NTU6MTE5NXVpdjlzdWI0Z2tjZ2RsOHRpb2UyMDlsdmNtdml2dTU1YjFlZjYwcjdsaFhYWFhYWA==',
  'Content-Type':'application/x-www-form-urlencoded'
};

fetch('/v1/oauth2/token',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Basic NGExdm42azRhYzRocDV1dTNxMnF2NTU1NTU6MTE5NXVpdjlzdWI0Z2tjZ2RsOHRpb2UyMDlsdmNtdml2dTU1YjFlZjYwcjdsaFhYWFhYWA==',
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.post '/v1/oauth2/token',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Basic NGExdm42azRhYzRocDV1dTNxMnF2NTU1NTU6MTE5NXVpdjlzdWI0Z2tjZ2RsOHRpb2UyMDlsdmNtdml2dTU1YjFlZjYwcjdsaFhYWFhYWA==',
  'Content-Type': 'application/x-www-form-urlencoded'
}

r = requests.post('/v1/oauth2/token', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Basic NGExdm42azRhYzRocDV1dTNxMnF2NTU1NTU6MTE5NXVpdjlzdWI0Z2tjZ2RsOHRpb2UyMDlsdmNtdml2dTU1YjFlZjYwcjdsaFhYWFhYWA==',
    'Content-Type' => 'application/x-www-form-urlencoded',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/oauth2/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/oauth2/token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Basic NGExdm42azRhYzRocDV1dTNxMnF2NTU1NTU6MTE5NXVpdjlzdWI0Z2tjZ2RsOHRpb2UyMDlsdmNtdml2dTU1YjFlZjYwcjdsaFhYWFhYWA=="},
        "Content-Type": []string{"application/x-www-form-urlencoded"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/oauth2/token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/oauth2/token

Get OAuth2 token

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Basic Auth where you need to provide auth client id and client secret.
Content-Type	header	string	true	must be application/x-www-form-urlencoded

Detailed descriptions

Authorization: Basic Auth where you need to provide auth client id and client secret. Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "access_token": "eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request to get oauth2 token was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» access_token	string	false	none	Access Token used in all the other API Endpoints
» expires_in	integer	false	none	Time in seconds until the token expires, please refresh the token before it expires.
» token_type	string	false	none	OAuth2 token type

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Account

A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an account

Account

getAccount

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_account?accountReference=ACC \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_account?accountReference=ACC HTTP/1.1

Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_account?accountReference=ACC',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_account',
  params: {
  'accountReference' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_account', params={
  'accountReference': 'ACC'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_account', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_account?accountReference=ACC");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_account", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_account

It retrieves the Account information

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
accountReference	query	string	true	Account reference in your system

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

"{\n    \"currency\": \"EUR\",\n    \"paymentReference\": \"paymentReference1\",\n    \"meta\": {\n        \"invoiceExternalNumber\": 111\n    },\n    \"scores\": [\n        {\n            \"type\": \"INTERNAL\",\n            \"value\": \"V1\"\n        }\n    ],\n    \"debtors\": [\n        {\n            \"lastName\": \"LAST_NAME_1\",\n            \"firstName\": \"FIRST_NAME_1\",\n            \"debtorReference\": \"EXTERNAL_DEBTOR_REF_001\",\n            \"contactInformation\": {\n                \"country\": \"DE\",\n                \"email\": \"first.last@acme.com\"\n            }\n        }\n    ],\n    \"products\": [\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_1\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_1\"\n        },\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_2\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_2\"\n        }\n    ],\n    \"ledgerEntries\": [\n        {\n            \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n            \"invoiceDetails\": {\n                \"amount\": 100000,\n                \"dueDate\": \"2022-01-08\",\n                \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n            },\n            \"context\": {\n                \"productReference\": \"PRODUCT_REFERENCE_1\"\n            }\n        }\n    ]\n}\n"

Responses

Status	Meaning	Description	Schema
200	OK	Request for get_account is successful	Account
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

createAccounts

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/create_accounts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/create_accounts HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "ACCOUNT_REFERENCE_002": {
        "currency": "EUR",
        "paymentReference": "ACCOUNT_PAYMENT_REFERENCE",
        "meta": {
            "accountMetaKey002": "value002",
            "invoiceExternalNumber": 111
        },
        "scores": [
            {
                "type": "INTERNAL",
                "value": "V1"
            }
        ],
        "debtors": [
            {
                "lastName": "LAST_NAME_1",
                "firstName": "FIRST_NAME",
                "debtorReference": "EXTERNAL_DEBTOR_REF_002",
                "contactInformation": {
                    "country": "NL",
                    "email": "first.last@acme.com"
                }
            }
        ],
        "products": [
            {
                "productReference": "PRODUCT_REFERENCE_1",
                "paymentReference": "PRODUCT_PAYMENT_REFERENCE_1"
            },
            {
                "productReference": "PRODUCT_REFERENCE_2",
                "paymentReference": "PRODUCT_PAYMENT_REFERENCE_2"
            }
        ],
        "ledgerEntries": [
            {
                "ledgerEntryReference": "INVOICE_LEDGER_ENTRY_REFERENCE_002_1",
                "invoiceDetails": {
                    "amount": 100000,
                    "dueDate": "2022-01-08",
                    "paymentReference": "INVOICE_PAYMENT_REFERENCE_1"
                },
                "context": {
                    "productReference": "PRODUCT_REFERENCE_1"
                }
            }
        ]
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/create_accounts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/create_accounts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/create_accounts', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/create_accounts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/create_accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/create_accounts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/create_accounts

Create Accounts in Receeve

The intetion of this endpoint is to create an Account in the platform, and it offer the possibility to include other related entities like the Debtor, the Account Score, Products, etc. But all those other sub-entities are optional and can be included in subsequent calls. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"ACCOUNT_REFERENCE_002\": {\n        \"currency\": \"EUR\",\n        \"paymentReference\": \"ACCOUNT_PAYMENT_REFERENCE\",\n        \"meta\": {\n            \"accountMetaKey002\": \"value002\",\n            \"invoiceExternalNumber\": 111\n        },\n        \"scores\": [\n            {\n                \"type\": \"INTERNAL\",\n                \"value\": \"V1\"\n            }\n        ],\n        \"debtors\": [\n            {\n                \"lastName\": \"LAST_NAME_1\",\n                \"firstName\": \"FIRST_NAME\",\n                \"debtorReference\": \"EXTERNAL_DEBTOR_REF_002\",\n                \"contactInformation\": {\n                    \"country\": \"NL\",\n                    \"email\": \"first.last@acme.com\"\n                }\n            }\n        ],\n        \"products\": [\n            {\n                \"productReference\": \"PRODUCT_REFERENCE_1\",\n                \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_1\"\n            },\n            {\n                \"productReference\": \"PRODUCT_REFERENCE_2\",\n                \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_2\"\n            }\n        ],\n        \"ledgerEntries\": [\n            {\n                \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n                \"invoiceDetails\": {\n                    \"amount\": 100000,\n                    \"dueDate\": \"2022-01-08\",\n                    \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n                },\n                \"context\": {\n                    \"productReference\": \"PRODUCT_REFERENCE_1\"\n                }\n            }\n        ]\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
async	query	boolean	false	The request is added to the queue without expecting the response
sequential	query	boolean	false	The request body items are executed one after another one
body	body	object	true	none
» additionalProperties	body	any	false	Input for create_account endpoint.
»» anonymous	body	Account	false	A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an Account.
»»» meta	body	Metadata	false	Additional information related to the entity.
»»» paymentReference	body	PaymentReference	false	Payment reference used in online transactions.
»»» portfolioReference	body	PortfolioReference	false	This is a optional grouping field for reporting purposes.
»»» currency	body	Currency	false	3-digit currency code (ISO 4217)
»»» scores	body	[AccountScore]	false	List of provided scores related with the Account.
»»»» type	body	string	true	Type of score
»»»» value	body	any	true	none
»»»»» anonymous	body	string	false	The score's value
»»»»» anonymous	body	object	false	composed value
»»»»» anonymous	body	null	false	No value
»»»» meta	body	Metadata	false	Additional information related to the entity.
»»» debtors	body	[allOf]	false	List of debtors related with the Account.
»»»» anonymous	body	BaseDebtor	false	none
»»»»» birthday	body	string(date)	false	Birthday of the debtor
»»»»» gender	body	string	false	Gender of the debtor
»»»»» firstName	body	string	false	First name of the debtor (required if type is 'natural')
»»»»» lastName	body	string	false	Last name of the debtor (required if type is 'natural')
»»»»» middleName	body	string	false	Middle name of the debtor
»»»»» title	body	string	false	Title of the debtor
»»»»» companyName	body	string	false	Company Name of the debtor (required if type is 'legal')
»»»»» debtorReference	body	DebtorReference	false	Your customer ID for this person or company
»»»»» SSN	body	string	false	National Identification Number of the debtor
»»»»» type	body	string	false	Type of the debtor (default: natural)
»»»»» contactInformation	body	BaseContactInformation	false	none
»»»»»» country	body	string	false	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»»» city	body	string	false	City
»»»»»» mobileNumber	body	string	false	Mobile Number
»»»»»» postalCode	body	string	false	Postal Code
»»»»»» houseNumber	body	string	false	House number as part of the address
»»»»»» addressLine1	body	string	false	Address Line 1
»»»»»» addressLine2	body	string	false	Address Line 2
»»»»»» addressLine3	body	string	false	Address Line 3
»»»»»» landLine	body	string	false	Land Line
»»»»»» state	body	string	false	State
»»»»»» email	body	string	false	Email Address
»»»»»» additionalContactInformation	body	[oneOf]	false	none
»»»»»»» anonymous	body	object	false	none
»»»»»»»» email	body	string	true	Email Address
»»»»»»» anonymous	body	object	false	none
»»»»»»»» mobileNumber	body	string	true	Mobile Number
»»»»»»» anonymous	body	object	false	none
»»»»»»»» landLine	body	string	true	Land Line Number
»»»»»»» anonymous	body	object	false	none
»»»»»»»» workPhoneNumber	body	string	true	Work Phone Number
»»»» anonymous	body	object	false	none
»»»»» contactInformation	body	any	true	Contact information of the debtor, used for communication purposes.
»»»»»» anonymous	body	BaseContactInformation	false	none
»»»»»» anonymous	body	object	false	none
»»» products	body	[Product]	false	List of products related with the Account.
»»»» productReference	body	ProductReference	true	Identifier for a product in your system. It is used for grouping purposes.
»»»» paymentReference	body	PaymentReference	false	Payment reference used in online transactions.
»»»» type	body	string	false	Type of product
»»»» name	body	string	false	Product name
»»»» code	body	string	false	Product code
»»»» meta	body	Metadata	false	Additional information related to the entity.
»»» ledgerEntries	body	[oneOf]	false	Ledger used to create Managed Claims.
»»»» anonymous	body	FeeLedgerEntry	false	none
»»»»» ledgerEntryReference	body	string	true	Reference of the Fee Ledger Entry
»»»»» feeDetails	body	object	true	none
»»»»»» type	body	string	false	Type of fee
»»»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»»»»» createdAt	body	integer	false	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»»» context	body	object	true	Describes the specific context of the entry
»»»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	body	string	false	Relationship of the fee with another ledger entry
»»»» anonymous	body	InvoiceLedgerEntry	false	An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.
»»»»» ledgerEntryReference	body	LedgerEntryReference	true	Reference of the Ledger Entry (unique per Account)
»»»»» invoiceDetails	body	object	true	none
»»»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»»»»» createdAt	body	LedgerEntryCreatedAt	false	Timestamp when the ledger entry was created in milliseconds
»»»»»» dueDate	body	DueDate(date)	true	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»» paymentReference	body	PaymentReference	false	Payment reference used in online transactions.
»»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»»» context	body	object	true	Describes the specific context of the Ledger Entry
»»»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» externalDebtorReference	body	DebtorReference	false	Your customer ID for this person or company
»»»» anonymous	body	PaymentLedgerEntry	false	none
»»»»» ledgerEntryReference	body	string	true	Reference of the Payment Ledger Entry
»»»»» paymentDetails	body	object	true	none
»»»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»»»»» paymentReference	body	PaymentReference	false	Payment reference used in online transactions.
»»»»»» createdAt	body	integer	false	Timestamp when the ledger entry was created in milliseconds
»»»»»» paymentProvider	body	string	false	Name of the provider used for the transaction
»»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»»» context	body	object	true	Describes the specific context of the entry
»»»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	body	string	false	Defines the target of the payment ledger entry
»»»» anonymous	body	AdjustmentLedgerEntry	false	none
»»»»» ledgerEntryReference	body	string	true	Reference of the Adjustment Ledger Entry
»»»»» adjustmentDetails	body	object	true	none
»»»»»» reason	body	string	false	Reason for the adjustment
»»»»»» amount	body	RelativeAmount	true	Monetary value in cents (positive or negative number)
»»»»»» dueDate	body	DueDate(date)	false	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»» createdAt	body	integer	false	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»»» context	body	object	true	Describes the specific context of the entry
»»»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	body	string	false	Defines the target of the payment ledger entry
»»»» anonymous	body	ChargebackLedgerEntry	false	none
»»»»» ledgerEntryReference	body	string	true	Reference of the Chargeback Ledger Entry
»»»»» chargebackDetails	body	object	true	none
»»»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»»»»» createdAt	body	integer	false	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»»» context	body	object	true	Describes the specific context of the entry
»»»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	body	string	true	Defines the target of the chargeback ledger entry
»»»» anonymous	body	DiscountLedgerEntry	false	none
»»»»» ledgerEntryReference	body	string	true	Reference of the Discount Ledger Entry
»»»»» discountDetails	body	object	true	none
»»»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»»»»» createdAt	body	integer	false	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»»» context	body	object	true	Describes the specific context of the entry
»»»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	body	string	true	Defines the target of the discount ledger entry
»»»» anonymous	body	ReportingLedgerEntry	false	none
»»»»» ledgerEntryReference	body	string	true	Reference of the Reporting Ledger Entry
»»»»» reportingDetails	body	object	true	none
»»»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»»»»» createdAt	body	integer	false	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»»» context	body	object	true	Describes the specific context of the entry
»»»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»» anonymous	body	object	false	none
»»» currency	body	Currency	true	3-digit currency code (ISO 4217)

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

»»» paymentReference: Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

»»»» paymentReference: Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

»»»»»» paymentReference: Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

Enumerated Values

Parameter	Value
»»»» type	INTERNAL
»»»» type	EXTERNAL
»»»» type	COLLECTION
»»»» type	BEHAVIORAL
»»»»» type	natural
»»»»» type	legal

Example responses

200 Response

"{\n    \"ACCOUNT_REFERENCE_002\": {\n        \"messages\": [\n            \"Successfully created Account ACCOUNT_REFERENCE_002\"\n        ],\n        \"success\": true,\n        \"data\": {\n            \"currency\": \"EUR\",\n            \"paymentReference\": \"ACCOUNT_PAYMENT_REFERENCE\",\n            \"meta\": {\n                \"accountMetaKey002\": \"value002\",\n                \"invoiceExternalNumber\": 111\n            },\n            \"scores\": [\n                {\n                    \"type\": \"INTERNAL\",\n                    \"value\": \"V1\"\n                }\n            ],\n            \"debtors\": [\n                {\n                    \"lastName\": \"LAST_NAME_1\",\n                    \"firstName\": \"FIRST_NAME\",\n                    \"debtorReference\": \"EXTERNAL_DEBTOR_REF_002\",\n                    \"contactInformation\": {\n                        \"country\": \"NL\",\n                        \"email\": \"first.last@acme.com\"\n                    }\n                }\n            ],\n            \"products\": [\n                {\n                    \"productReference\": \"PRODUCT_REFERENCE_1\",\n                    \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_1\"\n                },\n                {\n                    \"productReference\": \"PRODUCT_REFERENCE_2\",\n                    \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_2\"\n                }\n            ],\n            \"ledgerEntries\": [\n                {\n                    \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n                    \"invoiceDetails\": {\n                        \"amount\": 100000,\n                        \"dueDate\": \"2022-01-08\",\n                        \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n                    },\n                    \"context\": {\n                        \"productReference\": \"PRODUCT_REFERENCE_1\"\n                    }\n                }\n            ]\n        },\n        \"messageIds\": [\n            \"ef61c1b5-fd4a-41df-a1a3-bc4e4e4ca11a\"\n        ]\n    }\n}\n"

Responses

Status	Meaning	Description	Schema
200	OK	Response for matching the payment with the account	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	Account	false	none	A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an Account.
»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»» portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
»»»» currency	Currency	false	none	3-digit currency code (ISO 4217)
»»»» scores	[AccountScore]	false	none	List of provided scores related with the Account.
»»»»» type	string	true	none	Type of score
»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	string	false	none	The score's value

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	composed value

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	null	false	none	No value

continued

Name	Type	Required	Restrictions	Description
»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»» debtors	[allOf]	false	none	List of debtors related with the Account.

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	BaseDebtor	false	none	none
»»»»»» birthday	string(date)	false	none	Birthday of the debtor
»»»»»» gender	string	false	none	Gender of the debtor
»»»»»» firstName	string	false	none	First name of the debtor (required if type is 'natural')
»»»»»» lastName	string	false	none	Last name of the debtor (required if type is 'natural')
»»»»»» middleName	string	false	none	Middle name of the debtor
»»»»»» title	string	false	none	Title of the debtor
»»»»»» companyName	string	false	none	Company Name of the debtor (required if type is 'legal')
»»»»»» debtorReference	DebtorReference	false	none	Your customer ID for this person or company
»»»»»» SSN	string	false	none	National Identification Number of the debtor
»»»»»» type	string	false	none	Type of the debtor (default: natural)
»»»»»» contactInformation	BaseContactInformation	false	none	none
»»»»»»» country	string	false	none	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»»»» city	string	false	none	City
»»»»»»» mobileNumber	string	false	none	Mobile Number
»»»»»»» postalCode	string	false	none	Postal Code
»»»»»»» houseNumber	string	false	none	House number as part of the address
»»»»»»» addressLine1	string	false	none	Address Line 1
»»»»»»» addressLine2	string	false	none	Address Line 2
»»»»»»» addressLine3	string	false	none	Address Line 3
»»»»»»» landLine	string	false	none	Land Line
»»»»»»» state	string	false	none	State
»»»»»»» email	string	false	none	Email Address
»»»»»»» additionalContactInformation	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» email	string	true	none	Email Address

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» mobileNumber	string	true	none	Mobile Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» landLine	string	true	none	Land Line Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» workPhoneNumber	string	true	none	Work Phone Number

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» contactInformation	any	true	none	Contact information of the debtor, used for communication purposes.

allOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	BaseContactInformation	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none

continued

Name	Type	Required	Restrictions	Description
»»»» products	[Product]	false	none	List of products related with the Account.
»»»»» productReference	ProductReference	true	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»» type	string	false	none	Type of product
»»»»» name	string	false	none	Product name
»»»»» code	string	false	none	Product code
»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»» ledgerEntries	[oneOf]	false	none	Ledger used to create Managed Claims.

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	FeeLedgerEntry	false	none	none
»»»»»» ledgerEntryReference	string	true	none	Reference of the Fee Ledger Entry
»»»»»» feeDetails	object	true	none	none
»»»»»»» type	string	false	none	Type of fee
»»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»»» ledgerEntryReference	string	false	none	Relationship of the fee with another ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	InvoiceLedgerEntry	false	none	An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.
»»»»»» ledgerEntryReference	LedgerEntryReference	true	none	Reference of the Ledger Entry (unique per Account)
»»»»»» invoiceDetails	object	true	none	none
»»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»»» createdAt	LedgerEntryCreatedAt	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»»» dueDate	DueDate(date)	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»»» context	object	true	none	Describes the specific context of the Ledger Entry
»»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»»» externalDebtorReference	DebtorReference	false	none	Your customer ID for this person or company

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	PaymentLedgerEntry	false	none	none
»»»»»» ledgerEntryReference	string	true	none	Reference of the Payment Ledger Entry
»»»»»» paymentDetails	object	true	none	none
»»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»»» paymentProvider	string	false	none	Name of the provider used for the transaction
»»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»»» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	AdjustmentLedgerEntry	false	none	none
»»»»»» ledgerEntryReference	string	true	none	Reference of the Adjustment Ledger Entry
»»»»»» adjustmentDetails	object	true	none	none
»»»»»»» reason	string	false	none	Reason for the adjustment
»»»»»»» amount	RelativeAmount	true	none	Monetary value in cents (positive or negative number)
»»»»»»» dueDate	DueDate(date)	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»»» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	ChargebackLedgerEntry	false	none	none
»»»»»» ledgerEntryReference	string	true	none	Reference of the Chargeback Ledger Entry
»»»»»» chargebackDetails	object	true	none	none
»»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»»» ledgerEntryReference	string	true	none	Defines the target of the chargeback ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	DiscountLedgerEntry	false	none	none
»»»»»» ledgerEntryReference	string	true	none	Reference of the Discount Ledger Entry
»»»»»» discountDetails	object	true	none	none
»»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»»» ledgerEntryReference	string	true	none	Defines the target of the discount ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	ReportingLedgerEntry	false	none	none
»»»»»» ledgerEntryReference	string	true	none	Reference of the Reporting Ledger Entry
»»»»»» reportingDetails	object	true	none	none
»»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL
type	natural
type	legal

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

updateAccountMeta

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/update_account_meta \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/update_account_meta HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "ACCOUNT_REFERENCE_002": {
        "updateAccountMeta002": "updateAccountMetaValue002"
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/update_account_meta',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/update_account_meta',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/update_account_meta', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/update_account_meta', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/update_account_meta");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/update_account_meta", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/update_account_meta

Update Account Meta

The intetion of this endpoint is to update the Account level metadata, the given information is merged with the previous data. Notice that the metadata that is provided in the Account level, is inherited by the Claims that are created for that Account. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"ACCOUNT_REFERENCE_002\": {\n        \"updateAccountMeta002\": \"updateAccountMetaValue002\"\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
async	query	boolean	false	The request is added to the queue without expecting the response
sequential	query	boolean	false	The request body items are executed one after another one
body	body	object	true	none
» additionalProperties	body	Metadata	false	Additional information related to the entity.

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

addAccountLedgerEntries

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/add_account_ledger_entries \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/add_account_ledger_entries HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "context": {},
        "invoiceDetails": {
            "amount": 13025,
            "dueDate": "2020-01-01",
            "meta": {}
        },
        "ledgerEntryReference": "INVOICE_LEDGER_ENTRY_REFERENCE_002_2"
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/add_account_ledger_entries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/add_account_ledger_entries',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/add_account_ledger_entries', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/add_account_ledger_entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/add_account_ledger_entries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/add_account_ledger_entries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/add_account_ledger_entries

Add account ledger entries

The intetion of this endpoint is to add Ledger Entries to the Account. Those Entries are used to create or update the Claims that are associated with the Account. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"context\": {},\n        \"invoiceDetails\": {\n            \"amount\": 13025,\n            \"dueDate\": \"2020-01-01\",\n            \"meta\": {}\n        },\n        \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_2\"\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
async	query	boolean	false	The request is added to the queue without expecting the response
sequential	query	boolean	false	The request body items are executed one after another one
body	body	array[any]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

"{\n    \"ACCOUNT_REFERENCE_002\": {\n        \"success\": true,\n        \"data\": [\n            {\n                \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n                \"context\": {},\n                \"invoiceDetails\": {\n                    \"amount\": 13025,\n                    \"dueDate\": \"2020-01-01\",\n                    \"meta\": {}\n                },\n                \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_2\"\n            }\n        ],\n        \"messageIds\": [\n            \"cddddeb1-f352-46f3-a59d-0008a84e9bd5\"\n        ],\n        \"messages\": [\n            \"Successfully added Ledger Entries: INVOICE_LEDGER_ENTRY_REFERENCE_002_2\"\n        ]\n    }\n}\n"

Responses

Status	Meaning	Description	Schema
200	OK	Response when adding account ledger entries is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	Response of any action that adds ledger entries to an account.

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[oneOf]	false	none	[A Ledger Entry is a record of a transaction in the Ledger.]

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	FeeLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Fee Ledger Entry
»»»»» feeDetails	object	true	none	none
»»»»»» type	string	false	none	Type of fee
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	false	none	Relationship of the fee with another ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	InvoiceLedgerEntry	false	none	An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.
»»»»» ledgerEntryReference	LedgerEntryReference	true	none	Reference of the Ledger Entry (unique per Account)
»»»»» invoiceDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	LedgerEntryCreatedAt	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» dueDate	DueDate(date)	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the Ledger Entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» externalDebtorReference	DebtorReference	false	none	Your customer ID for this person or company

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	PaymentLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Payment Ledger Entry
»»»»» paymentDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» paymentProvider	string	false	none	Name of the provider used for the transaction
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	AdjustmentLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Adjustment Ledger Entry
»»»»» adjustmentDetails	object	true	none	none
»»»»»» reason	string	false	none	Reason for the adjustment
»»»»»» amount	RelativeAmount	true	none	Monetary value in cents (positive or negative number)
»»»»»» dueDate	DueDate(date)	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	ChargebackLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Chargeback Ledger Entry
»»»»» chargebackDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	true	none	Defines the target of the chargeback ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	DiscountLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Discount Ledger Entry
»»»»» discountDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	true	none	Defines the target of the discount ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	ReportingLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Reporting Ledger Entry
»»»»» reportingDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

addAccountProducts

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/add_account_products \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/add_account_products HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "productReference": "PRODUCT_REFERENCE_002_2",
        "type": "Computer",
        "name": "MacBook Air",
        "code": "2022"
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/add_account_products',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/add_account_products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/add_account_products', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/add_account_products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/add_account_products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/add_account_products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/add_account_products

Add Account Products

The intetion of this endpoint is to Add Products to the Account. The products are used as contextual information to the Claims that are created for that Account. And can be used for further Use Cases within the platform. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"productReference\": \"PRODUCT_REFERENCE_002_2\",\n        \"type\": \"Computer\",\n        \"name\": \"MacBook Air\",\n        \"code\": \"2022\"\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
async	query	boolean	false	The request is added to the queue without expecting the response
sequential	query	boolean	false	The request body items are executed one after another one
body	body	array[any]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

"{\n    \"ACCOUNT_REFERENCE_002\": {\n        \"success\": true,\n        \"data\": [\n            {\n                \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n                \"productReference\": \"PRODUCT_REFERENCE_002_2\",\n                \"type\": \"Computer\",\n                \"name\": \"MacBook Air\",\n                \"code\": \"2022\",\n                \"meta\": {}\n            }\n        ],\n        \"messageIds\": [\n            \"931120dd-06bf-4ec9-9f44-2167585e76d1\"\n        ],\n        \"messages\": [\n            \"Successfully added Product PRODUCT_REFERENCE_002_2\"\n        ]\n    }\n}\n"

Responses

Status	Meaning	Description	Schema
200	OK	Request for add/update account product is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[Product]	false	none	[A product is a service or item used to give context to the Claim or Ledger Entry]
»»»» productReference	ProductReference	true	none	Identifier for a product in your system. It is used for grouping purposes.
»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»» type	string	false	none	Type of product
»»»» name	string	false	none	Product name
»»»» code	string	false	none	Product code
»»»» meta	Metadata	false	none	Additional information related to the entity.

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

updateAccountProducts

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/update_account_products \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/update_account_products HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "productReference": "PRODUCT_REFERENCE_002_2",
        "type": "Computer",
        "name": "MacBook Air",
        "code": "2022"
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/update_account_products',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/update_account_products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/update_account_products', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/update_account_products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/update_account_products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/update_account_products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/update_account_products

Update Account Products

The intetion of this endpoint is to update existing Products of the Account. The products are used as contextual information to the Claims that are created for that Account. And can be used for further Use Cases within the platform. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"productReference\": \"PRODUCT_REFERENCE_002_2\",\n        \"type\": \"Computer\",\n        \"name\": \"MacBook Air\",\n        \"code\": \"2022\"\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
async	query	boolean	false	The request is added to the queue without expecting the response
sequential	query	boolean	false	The request body items are executed one after another one
body	body	array[any]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

"{\n    \"ACCOUNT_REFERENCE_002\": {\n        \"success\": true,\n        \"data\": [\n            {\n                \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n                \"productReference\": \"PRODUCT_REFERENCE_002_2\",\n                \"type\": \"Computer\",\n                \"name\": \"MacBook Air\",\n                \"code\": \"2022\",\n                \"meta\": {}\n            }\n        ],\n        \"messageIds\": [\n            \"931120dd-06bf-4ec9-9f44-2167585e76d1\"\n        ],\n        \"messages\": [\n            \"Successfully added Product PRODUCT_REFERENCE_002_2\"\n        ]\n    }\n}\n"

Responses

Status	Meaning	Description	Schema
200	OK	Request for add/update account product is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[Product]	false	none	[A product is a service or item used to give context to the Claim or Ledger Entry]
»»»» productReference	ProductReference	true	none	Identifier for a product in your system. It is used for grouping purposes.
»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»» type	string	false	none	Type of product
»»»» name	string	false	none	Product name
»»»» code	string	false	none	Product code
»»»» meta	Metadata	false	none	Additional information related to the entity.

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

addAccountDebtors

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/add_account_debtors \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/add_account_debtors HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "contactInformation": {
            "country": "DE",
            "email": "first.last@acme.com"
        },
        "firstName": "First_2",
        "lastName": "Last_2"
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/add_account_debtors',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/add_account_debtors',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/add_account_debtors', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/add_account_debtors', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/add_account_debtors");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/add_account_debtors", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/add_account_debtors

Add Account Debtors

The intetion of this endpoint is to Add Debtors to the Account. The Debtor represents the entity that owes money described by the Account. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"debtorReference\": \"EXTERNAL_DEBTOR_REF_002\",\n        \"contactInformation\": {\n            \"country\": \"DE\",\n            \"email\": \"first.last@acme.com\"\n        },\n        \"firstName\": \"First_2\",\n        \"lastName\": \"Last_2\"\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
async	query	boolean	false	The request is added to the queue without expecting the response
sequential	query	boolean	false	The request body items are executed one after another one
body	body	array[any]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      {
        "birthday": "1980-06-28",
        "gender": "M",
        "firstName": "John",
        "lastName": "White",
        "middleName": "Benedict",
        "title": "Doctor",
        "companyName": "Acme Brick Co.",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "SSN": "AAA-GG-SSSS",
        "type": "natural",
        "contactInformation": {
          "country": "DE",
          "city": "Delbrück",
          "mobileNumber": 495555555555,
          "postalCode": 33129,
          "houseNumber": "24A",
          "addressLine1": "Boikweg 24",
          "addressLine2": "c/o Acme",
          "addressLine3": "first floor",
          "landLine": 495555555555,
          "state": "Dortmund",
          "email": "testEmail@example.com",
          "additionalContactInformation": [
            {
              "email": "testEmail@example.com"
            }
          ]
        }
      }
    ]
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      {
        "birthday": "1980-06-28",
        "gender": "M",
        "firstName": "John",
        "lastName": "White",
        "middleName": "Benedict",
        "title": "Doctor",
        "companyName": "Acme Brick Co.",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "SSN": "AAA-GG-SSSS",
        "type": "natural",
        "contactInformation": {
          "country": "DE",
          "city": "Delbrück",
          "mobileNumber": 495555555555,
          "postalCode": 33129,
          "houseNumber": "24A",
          "addressLine1": "Boikweg 24",
          "addressLine2": "c/o Acme",
          "addressLine3": "first floor",
          "landLine": 495555555555,
          "state": "Dortmund",
          "email": "testEmail@example.com",
          "additionalContactInformation": [
            {
              "email": "testEmail@example.com"
            }
          ]
        }
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for debtor add/update account debtor request is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[allOf]	false	none	[The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required. ]

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	BaseDebtor	false	none	none
»»»»» birthday	string(date)	false	none	Birthday of the debtor
»»»»» gender	string	false	none	Gender of the debtor
»»»»» firstName	string	false	none	First name of the debtor (required if type is 'natural')
»»»»» lastName	string	false	none	Last name of the debtor (required if type is 'natural')
»»»»» middleName	string	false	none	Middle name of the debtor
»»»»» title	string	false	none	Title of the debtor
»»»»» companyName	string	false	none	Company Name of the debtor (required if type is 'legal')
»»»»» debtorReference	DebtorReference	false	none	Your customer ID for this person or company
»»»»» SSN	string	false	none	National Identification Number of the debtor
»»»»» type	string	false	none	Type of the debtor (default: natural)
»»»»» contactInformation	BaseContactInformation	false	none	none
»»»»»» country	string	false	none	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»»» city	string	false	none	City
»»»»»» mobileNumber	string	false	none	Mobile Number
»»»»»» postalCode	string	false	none	Postal Code
»»»»»» houseNumber	string	false	none	House number as part of the address
»»»»»» addressLine1	string	false	none	Address Line 1
»»»»»» addressLine2	string	false	none	Address Line 2
»»»»»» addressLine3	string	false	none	Address Line 3
»»»»»» landLine	string	false	none	Land Line
»»»»»» state	string	false	none	State
»»»»»» email	string	false	none	Email Address
»»»»»» additionalContactInformation	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» email	string	true	none	Email Address

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» mobileNumber	string	true	none	Mobile Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» landLine	string	true	none	Land Line Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» workPhoneNumber	string	true	none	Work Phone Number

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» contactInformation	any	true	none	Contact information of the debtor, used for communication purposes.

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	BaseContactInformation	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none

Enumerated Values

Property	Value
type	natural
type	legal

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

updateAccountDebtors

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/update_account_debtors \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/update_account_debtors HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "contactInformation": {
            "country": "DE",
            "email": "first.last@acme.com"
        },
        "firstName": "First_2",
        "lastName": "Last_2"
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/update_account_debtors',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/update_account_debtors',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/update_account_debtors', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/update_account_debtors', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/update_account_debtors");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/update_account_debtors", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/update_account_debtors

Update Account Debtors

The intetion of this endpoint is to Update Debtors to the Account. The Debtor represents the entity that owes money described by the Account. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"debtorReference\": \"EXTERNAL_DEBTOR_REF_002\",\n        \"contactInformation\": {\n            \"country\": \"DE\",\n            \"email\": \"first.last@acme.com\"\n        },\n        \"firstName\": \"First_2\",\n        \"lastName\": \"Last_2\"\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
async	query	boolean	false	The request is added to the queue without expecting the response
sequential	query	boolean	false	The request body items are executed one after another one
body	body	array[any]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

getAccountClaims

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_account_claims?accountReference=ACC \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_account_claims?accountReference=ACC HTTP/1.1

Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_account_claims?accountReference=ACC',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_account_claims',
  params: {
  'accountReference' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_account_claims', params={
  'accountReference': 'ACC'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_account_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_account_claims?accountReference=ACC");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_account_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_account_claims

It retrieves the claims from a given account

The intetion of this endpoint is to fetch the Claims from a given Account. For more details about the Account, and the relationship with the other entities please visit the Account page.

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
accountReference	query	string	true	Account reference in your system
status	query	string	false	Claim Status filter
paginationId	query	string	false	Get the Account Claims by Pagination
limit	query	integer	false	amount of events per page, default is 1000

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Enumerated Values

Parameter	Value
status	ACTIVE
status	RESOLVED

Example responses

200 Response

[
  {
    "amount": 13025,
    "currency": "EUR",
    "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
    "productReference": "PRODUCT_REFERENCE_1",
    "creditorReference": "string",
    "totalFees": 13025,
    "currentDueDate": "2019-06-28",
    "originalDueDate": "2019-06-28",
    "scores": [
      {
        "type": "INTERNAL",
        "value": "risky",
        "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
      }
    ],
    "reason": "string",
    "paymentReference": "paymentReference1",
    "accountNumber": "string",
    "accountReference": "ACCOUNT_REFERENCE_002",
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
    "fees": [
      {
        "name": "Interest",
        "amount": 13025
      }
    ],
    "primaryDebtor": {
      "birthday": "1980-06-28",
      "gender": "M",
      "firstName": "John",
      "lastName": "White",
      "middleName": "Benedict",
      "title": "Doctor",
      "companyName": "Acme Brick Co.",
      "debtorReference": "EXTERNAL_DEBTOR_REF_002",
      "SSN": "AAA-GG-SSSS",
      "type": "natural",
      "contactInformation": {
        "country": "DE",
        "city": "Delbrück",
        "mobileNumber": 495555555555,
        "postalCode": 33129,
        "houseNumber": "24A",
        "addressLine1": "Boikweg 24",
        "addressLine2": "c/o Acme",
        "addressLine3": "first floor",
        "landLine": 495555555555,
        "state": "Dortmund",
        "email": "testEmail@example.com",
        "additionalContactInformation": [
          {
            "email": "testEmail@example.com"
          }
        ]
      }
    },
    "claimReference": "string",
    "status": "ACTIVE"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Request of get_account_claims is Successfull	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL
type	natural
type	legal
status	ACTIVE
status	RESOLVED

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

SetAccountScores

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/set_account_scores \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/set_account_scores HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "type": "EXTERNAL",
        "value": "SCORE1",
        "meta": {}
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/set_account_scores',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/set_account_scores',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/set_account_scores', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/set_account_scores', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/set_account_scores");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/set_account_scores", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/set_account_scores

Set Account Scores

The intention of the endpoint is to set the scores for the Account. The scores provide further contextual information about the Account that can be used to improve the performance of the processes in the Collection Strategy. For more details about the Account, and the relationship with the other entities please visit the Account page.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"type\": \"EXTERNAL\",\n        \"value\": \"SCORE1\",\n        \"meta\": {}\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	array[any]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n    \"messages\": [\n        \"Successfully set the score of EXTERNAL\"\n    ],\n    \"success\": true,\n    \"data\": [\n        {\n            \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n            \"type\": \"EXTERNAL\",\n            \"value\": \"SCORE1\",\n            \"meta\": {}\n        }\n    ],\n    \"messageIds\": [\n        \"0fdf533f-e453-4b64-9e4a-e1e2a2b81bf4\"\n    ]\n}\n",
  "property2": "{\n    \"messages\": [\n        \"Successfully set the score of EXTERNAL\"\n    ],\n    \"success\": true,\n    \"data\": [\n        {\n            \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n            \"type\": \"EXTERNAL\",\n            \"value\": \"SCORE1\",\n            \"meta\": {}\n        }\n    ],\n    \"messageIds\": [\n        \"0fdf533f-e453-4b64-9e4a-e1e2a2b81bf4\"\n    ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request for set_account_score is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	Response of the set_account_score endpoint

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[AccountScore]	false	none	[An account score is a score that is calculated for a specific account. It can be used to determine the risk of a debtor or any other information that is relevant for the account.]
»»»» type	string	true	none	Type of score
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	string	false	none	The score's value

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	composed value

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	null	false	none	No value

continued

Name	Type	Required	Restrictions	Description
»»»» meta	Metadata	false	none	Additional information related to the entity.

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

MatchAccountPayment

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/match_account_payment \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/match_account_payment HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "currency": "EUR",
        "matchStrategy": "ORDERED_INVOICES_WITH_FEES_THEN_ACCOUNT_ENTRIES",
        "totalAmount": 100000,
        "providerName": "trustly",
        "trackingId": "TRACKING_ID_2",
        "paymentReference": "PAYMENT_REFERENCE_2",
        "context": {
            "productReference": "PRODUCT_REFERENCE_2"
        },
        "meta": {}
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/match_account_payment',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/match_account_payment',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/match_account_payment', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/match_account_payment', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/match_account_payment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/match_account_payment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/match_account_payment

Register a payment for an account

The intention of the endpoint is to register a payment for an account. The payment amount will be matched to the different claims of the account using the indicated matching strategy.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"currency\": \"EUR\",\n        \"matchStrategy\": \"ORDERED_INVOICES_WITH_FEES_THEN_ACCOUNT_ENTRIES\",\n        \"totalAmount\": 100000,\n        \"providerName\": \"trustly\",\n        \"trackingId\": \"TRACKING_ID_2\",\n        \"paymentReference\": \"PAYMENT_REFERENCE_2\",\n        \"context\": {\n            \"productReference\": \"PRODUCT_REFERENCE_2\"\n        },\n        \"meta\": {}\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	array[any]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      "{\n    \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n    \"invoiceDetails\": {\n        \"amount\": 100000,\n        \"dueDate\": \"2022-01-08\",\n        \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n    },\n    \"context\": {\n        \"productReference\": \"PRODUCT_REFERENCE_1\"\n    }\n}\n"
    ]
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      "{\n    \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n    \"invoiceDetails\": {\n        \"amount\": 100000,\n        \"dueDate\": \"2022-01-08\",\n        \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n    },\n    \"context\": {\n        \"productReference\": \"PRODUCT_REFERENCE_1\"\n    }\n}\n"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for matching the payment with the account	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[oneOf]	false	none	[A Ledger Entry is a record of a transaction in the Ledger.]

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	FeeLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Fee Ledger Entry
»»»»» feeDetails	object	true	none	none
»»»»»» type	string	false	none	Type of fee
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	false	none	Relationship of the fee with another ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	InvoiceLedgerEntry	false	none	An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.
»»»»» ledgerEntryReference	LedgerEntryReference	true	none	Reference of the Ledger Entry (unique per Account)
»»»»» invoiceDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	LedgerEntryCreatedAt	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» dueDate	DueDate(date)	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the Ledger Entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» externalDebtorReference	DebtorReference	false	none	Your customer ID for this person or company

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	PaymentLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Payment Ledger Entry
»»»»» paymentDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» paymentProvider	string	false	none	Name of the provider used for the transaction
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	AdjustmentLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Adjustment Ledger Entry
»»»»» adjustmentDetails	object	true	none	none
»»»»»» reason	string	false	none	Reason for the adjustment
»»»»»» amount	RelativeAmount	true	none	Monetary value in cents (positive or negative number)
»»»»»» dueDate	DueDate(date)	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	ChargebackLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Chargeback Ledger Entry
»»»»» chargebackDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	true	none	Defines the target of the chargeback ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	DiscountLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Discount Ledger Entry
»»»»» discountDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»»» ledgerEntryReference	string	true	none	Defines the target of the discount ledger entry

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	ReportingLedgerEntry	false	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Reporting Ledger Entry
»»»»» reportingDetails	object	true	none	none
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»»» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» context	object	true	none	Describes the specific context of the entry
»»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

updateAccountLedgerEntriesAmounts

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/update_account_ledger_entries_amounts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/update_account_ledger_entries_amounts HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "ledgerEntries": [
            {
                "ledgerEntryReference": "INVOICE_LEDGER_ENTRY_REFERENCE_002_1",
                "amount": 10000,
                "reason": "CHARGEBACK",
                "meta": {}
            },
            {
                "ledgerEntryReference": "INVOICE_LEDGER_ENTRY_REFERENCE_002_2",
                "amount": 0,
                "reason": "PAYMENT",
                "meta": {}
            }
        ]
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/update_account_ledger_entries_amounts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/update_account_ledger_entries_amounts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/update_account_ledger_entries_amounts', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/update_account_ledger_entries_amounts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/update_account_ledger_entries_amounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/update_account_ledger_entries_amounts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/update_account_ledger_entries_amounts

Updates the amounts of Account ledger entries

The intention of the endpoint is to update the amounts of the Account ledger entries. This is an abstraction over adding directly the Ledger Entries to the Account, the objective is to simplify the process of updating the amounts of the ledger entries, using the target amount in the request, instead of the individual entries. Notes: - The calculations are executed first, and the claims related to those invoices will be updated only once. - The reason field is mandatory, and it will be used to identify the reason of the update, PAYMENT and CHARGEBACK are special values that will affect the creation of the ledger entries, creating Payment Ledger Entries and Chargeback Ledger Entries, any other reason is mapped to Adjustment Ledger Entries. - The last value in the array is the one that will be used to update the claim refered by the ledgerEntryReference, but the previous values are used to give context of the changes.

Body parameter

"[\n    {\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"ledgerEntries\": [\n            {\n                \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n                \"amount\": 10000,\n                \"reason\": \"CHARGEBACK\",\n                \"meta\": {}\n            },\n            {\n                \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_2\",\n                \"amount\": 0,\n                \"reason\": \"PAYMENT\",\n                \"meta\": {}\n            }\n        ]\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	UpdateAccountLedgerEntriesAmountsInput	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "ledgerEntries": [
          {
            "ledgerEntryReference": "string",
            "amount": 13025,
            "reason": "INVALID",
            "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
          }
        ]
      }
    ]
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      {
        "accountReference": "ACCOUNT_REFERENCE_002",
        "ledgerEntries": [
          {
            "ledgerEntryReference": "string",
            "amount": 13025,
            "reason": "INVALID",
            "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
          }
        ]
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request for update_account_ledger_entries_amounts is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[UpdateAccountLedgerEntriesAmountsInput]	false	none	[Input for update_account_ledger_entries_amounts endpoint.]
»»»» accountReference	AccountReference	true	none	Account reference in your system
»»»» ledgerEntries	[object]	true	none	none
»»»»» ledgerEntryReference	string	true	none	Reference of the Ledger Entry (Invoice or Fee)
»»»»» amount	integer	true	none	Amount in cents
»»»»» reason	string	true	none	Reason for the adjustment
»»»»» meta	Metadata	true	none	Additional information related to the entity.

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

getDebtorAccountsAndClaims

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_debtor_accounts_and_claims?debtorReference=string \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_debtor_accounts_and_claims?debtorReference=string HTTP/1.1

Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_debtor_accounts_and_claims?debtorReference=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_debtor_accounts_and_claims',
  params: {
  'debtorReference' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_debtor_accounts_and_claims', params={
  'debtorReference': 'string'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_debtor_accounts_and_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_debtor_accounts_and_claims?debtorReference=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_debtor_accounts_and_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_debtor_accounts_and_claims

It retrieves information about a debtor's accounts and claims

The intention of the endpoint is to retrieve information about a debtor's accounts and claims.

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
debtorReference	query	string	true	Identifier of the debtor

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

[
  [
    {
      "accountReference": "ACCOUNT_REFERENCE_002",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
      "paymentReference": "paymentReference1",
      "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
      "currency": "EUR",
      "claims": [
        {
          "amount": 13025,
          "currency": "EUR",
          "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
          "productReference": "PRODUCT_REFERENCE_1",
          "creditorReference": "string",
          "totalFees": 13025,
          "currentDueDate": "2019-06-28",
          "originalDueDate": "2019-06-28",
          "scores": [
            {
              "type": "INTERNAL",
              "value": "risky",
              "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
            }
          ],
          "reason": "string",
          "paymentReference": "paymentReference1",
          "accountNumber": "string",
          "accountReference": "ACCOUNT_REFERENCE_002",
          "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
          "fees": [
            {
              "name": "Interest",
              "amount": 13025
            }
          ],
          "primaryDebtor": {
            "birthday": "1980-06-28",
            "gender": "M",
            "firstName": "John",
            "lastName": "White",
            "middleName": "Benedict",
            "title": "Doctor",
            "companyName": "Acme Brick Co.",
            "debtorReference": "EXTERNAL_DEBTOR_REF_002",
            "SSN": "AAA-GG-SSSS",
            "type": "natural",
            "contactInformation": {
              "country": "DE",
              "city": "Delbrück",
              "mobileNumber": 495555555555,
              "postalCode": 33129,
              "houseNumber": "24A",
              "addressLine1": "Boikweg 24",
              "addressLine2": "c/o Acme",
              "addressLine3": "first floor",
              "landLine": 495555555555,
              "state": "Dortmund",
              "email": "testEmail@example.com",
              "additionalContactInformation": [
                {
                  "email": "testEmail@example.com"
                }
              ]
            }
          }
        }
      ],
      "debtors": [
        {
          "birthday": "1980-06-28",
          "gender": "M",
          "firstName": "John",
          "lastName": "White",
          "middleName": "Benedict",
          "title": "Doctor",
          "companyName": "Acme Brick Co.",
          "debtorReference": "EXTERNAL_DEBTOR_REF_002",
          "SSN": "AAA-GG-SSSS",
          "type": "natural",
          "contactInformation": {
            "country": "DE",
            "city": "Delbrück",
            "mobileNumber": 495555555555,
            "postalCode": 33129,
            "houseNumber": "24A",
            "addressLine1": "Boikweg 24",
            "addressLine2": "c/o Acme",
            "addressLine3": "first floor",
            "landLine": 495555555555,
            "state": "Dortmund",
            "email": "testEmail@example.com",
            "additionalContactInformation": [
              {
                "email": "testEmail@example.com"
              }
            ]
          }
        }
      ]
    }
  ]
]

Responses

Status	Meaning	Description	Schema
200	OK	Request for get_debtor_accounts_and_claims is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DebtorAccountsAndClaims]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» accountReference	AccountReference	true	none	Account reference in your system
»» meta	Metadata	false	none	Additional information related to the entity.
»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»» portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
»» currency	Currency	true	none	3-digit currency code (ISO 4217)

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» claims	[allOf]	true	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	BaseClaim	false	none	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.
»»»» amount	Amount	false	none	Monetary value in cents (natural nuumber)
»»»» currency	Currency	false	none	3-digit currency code (ISO 4217)
»»»» portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»» creditorReference	string	false	none	Reference of the person/company to whom money is owed
»»»» totalFees	Amount	false	none	Monetary value in cents (natural nuumber)
»»»» currentDueDate	DueDate(date)	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»» originalDueDate	OriginalDueDate(date)	false	none	Original due date in your system. This is the day when it went past due. DPD 0.
»»»» scores	[ClaimScore]	false	none	List of scores
»»»»» type	string	true	none	Type of score
»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	string	false	none	The score's value

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	composed value

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	null	false	none	No value

continued

Name	Type	Required	Restrictions	Description
»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»» reason	string	false	none	Reason for updating a claim (the reason must not be part of the Entity)
»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»» accountNumber	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	AccountReference	false	none	Account reference in your system

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	number	false	none	Account number in your system (DEPRECATED, use accountReference)

continued

Name	Type	Required	Restrictions	Description
»»»» accountReference	AccountReference	false	none	Account reference in your system
»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»» fees	[Fee]	false	none	List of fees. If neither fees nor totalFees are provided - we treat totalFees as 0. Using this field overwrites the totalFees value if you provided it as well.
»»»»» name	string	true	none	Name of the fee.
»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»» primaryDebtor	BaseDebtor	false	none	none
»»»»» birthday	string(date)	false	none	Birthday of the debtor
»»»»» gender	string	false	none	Gender of the debtor
»»»»» firstName	string	false	none	First name of the debtor (required if type is 'natural')
»»»»» lastName	string	false	none	Last name of the debtor (required if type is 'natural')
»»»»» middleName	string	false	none	Middle name of the debtor
»»»»» title	string	false	none	Title of the debtor
»»»»» companyName	string	false	none	Company Name of the debtor (required if type is 'legal')
»»»»» debtorReference	DebtorReference	false	none	Your customer ID for this person or company
»»»»» SSN	string	false	none	National Identification Number of the debtor
»»»»» type	string	false	none	Type of the debtor (default: natural)
»»»»» contactInformation	BaseContactInformation	false	none	none
»»»»»» country	string	false	none	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»»» city	string	false	none	City
»»»»»» mobileNumber	string	false	none	Mobile Number
»»»»»» postalCode	string	false	none	Postal Code
»»»»»» houseNumber	string	false	none	House number as part of the address
»»»»»» addressLine1	string	false	none	Address Line 1
»»»»»» addressLine2	string	false	none	Address Line 2
»»»»»» addressLine3	string	false	none	Address Line 3
»»»»»» landLine	string	false	none	Land Line
»»»»»» state	string	false	none	State
»»»»»» email	string	false	none	Email Address
»»»»»» additionalContactInformation	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» email	string	true	none	Email Address

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» mobileNumber	string	true	none	Mobile Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» landLine	string	true	none	Land Line Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» workPhoneNumber	string	true	none	Work Phone Number

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» primaryDebtor	any	true	none	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	BaseDebtor	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» contactInformation	any	true	none	Contact information of the debtor, used for communication purposes.

allOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	BaseContactInformation	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» debtors	[allOf]	true	none	[The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required. ]

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL
type	natural
type	legal

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Claim

A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.

Account Claims

createClaims

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/create_claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/create_claims HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "CLAIM_REF_002_1": {
        "amount": 1000,
        "currency": "EUR",
        "currentDueDate": "2019-02-15",
        "originalDueDate": "2019-09-09",
        "productReference": "PRODUCT_REFERENCE_002",
        "accountReference": "ACCOUNT_REFERENCE_002",
        "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
        "totalFees": 0,
        "primaryDebtor": {
            "debtorReference": "EXTERNAL_DEBTOR_REF_002",
            "firstName": "F_N",
            "lastName": "L_N",
            "contactInformation": {
              "email": "first.last@acme.com",
              "country": "DE"
            }
        },
        "meta": {}
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/create_claims',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/create_claims',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/create_claims', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/create_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/create_claims");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/create_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/create_claims

Create claims in Receeve

The intetion of this endpoint is to create Claims in Receeve. Notes: - This endpoint throws an error if the Claim already exists (even if it was deleted). - The claims created with this endpoint are not managed by the Ledger. For more details about the Claim, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"CLAIM_REF_002_1\": {\n        \"amount\": 1000,\n        \"currency\": \"EUR\",\n        \"currentDueDate\": \"2019-02-15\",\n        \"originalDueDate\": \"2019-09-09\",\n        \"productReference\": \"PRODUCT_REFERENCE_002\",\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"portfolioReference\": \"EXTERNAL_PORTFOLIO_REFERENCE_002\",\n        \"totalFees\": 0,\n        \"primaryDebtor\": {\n            \"debtorReference\": \"EXTERNAL_DEBTOR_REF_002\",\n            \"firstName\": \"F_N\",\n            \"lastName\": \"L_N\",\n            \"contactInformation\": {\n              \"email\": \"first.last@acme.com\",\n              \"country\": \"DE\"\n            }\n        },\n        \"meta\": {}\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	object	true	none
» additionalProperties	body	any	false	Input for create_claims endpoint.

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
      "productReference": "PRODUCT_REFERENCE_1",
      "creditorReference": "string",
      "totalFees": 13025,
      "currentDueDate": "2019-06-28",
      "originalDueDate": "2019-06-28",
      "scores": [
        {
          "type": "INTERNAL",
          "value": "risky",
          "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
        }
      ],
      "reason": "string",
      "paymentReference": "paymentReference1",
      "accountNumber": "string",
      "accountReference": "ACCOUNT_REFERENCE_002",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
      "fees": [
        {
          "name": "Interest",
          "amount": 13025
        }
      ],
      "primaryDebtor": {
        "birthday": "1980-06-28",
        "gender": "M",
        "firstName": "John",
        "lastName": "White",
        "middleName": "Benedict",
        "title": "Doctor",
        "companyName": "Acme Brick Co.",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "SSN": "AAA-GG-SSSS",
        "type": "natural",
        "contactInformation": {
          "country": "DE",
          "city": "Delbrück",
          "mobileNumber": 495555555555,
          "postalCode": 33129,
          "houseNumber": "24A",
          "addressLine1": "Boikweg 24",
          "addressLine2": "c/o Acme",
          "addressLine3": "first floor",
          "landLine": 495555555555,
          "state": "Dortmund",
          "email": "testEmail@example.com",
          "additionalContactInformation": [
            {
              "email": "testEmail@example.com"
            }
          ]
        }
      }
    }
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
      "productReference": "PRODUCT_REFERENCE_1",
      "creditorReference": "string",
      "totalFees": 13025,
      "currentDueDate": "2019-06-28",
      "originalDueDate": "2019-06-28",
      "scores": [
        {
          "type": "INTERNAL",
          "value": "risky",
          "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
        }
      ],
      "reason": "string",
      "paymentReference": "paymentReference1",
      "accountNumber": "string",
      "accountReference": "ACCOUNT_REFERENCE_002",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
      "fees": [
        {
          "name": "Interest",
          "amount": 13025
        }
      ],
      "primaryDebtor": {
        "birthday": "1980-06-28",
        "gender": "M",
        "firstName": "John",
        "lastName": "White",
        "middleName": "Benedict",
        "title": "Doctor",
        "companyName": "Acme Brick Co.",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "SSN": "AAA-GG-SSSS",
        "type": "natural",
        "contactInformation": {
          "country": "DE",
          "city": "Delbrück",
          "mobileNumber": 495555555555,
          "postalCode": 33129,
          "houseNumber": "24A",
          "addressLine1": "Boikweg 24",
          "addressLine2": "c/o Acme",
          "addressLine3": "first floor",
          "landLine": 495555555555,
          "state": "Dortmund",
          "email": "testEmail@example.com",
          "additionalContactInformation": [
            {
              "email": "testEmail@example.com"
            }
          ]
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response of creating a set of claims	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	any	false	none	Used when creating or importing claims

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	BaseClaim	false	none	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.
»»»»» amount	Amount	false	none	Monetary value in cents (natural nuumber)
»»»»» currency	Currency	false	none	3-digit currency code (ISO 4217)
»»»»» portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»» creditorReference	string	false	none	Reference of the person/company to whom money is owed
»»»»» totalFees	Amount	false	none	Monetary value in cents (natural nuumber)
»»»»» currentDueDate	DueDate(date)	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»» originalDueDate	OriginalDueDate(date)	false	none	Original due date in your system. This is the day when it went past due. DPD 0.
»»»»» scores	[ClaimScore]	false	none	List of scores
»»»»»» type	string	true	none	Type of score
»»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	The score's value

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	composed value

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	null	false	none	No value

continued

Name	Type	Required	Restrictions	Description
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» reason	string	false	none	Reason for updating a claim (the reason must not be part of the Entity)
»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»» accountNumber	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	AccountReference	false	none	Account reference in your system

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	number	false	none	Account number in your system (DEPRECATED, use accountReference)

continued

Name	Type	Required	Restrictions	Description
»»»»» accountReference	AccountReference	false	none	Account reference in your system
»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» fees	[Fee]	false	none	List of fees. If neither fees nor totalFees are provided - we treat totalFees as 0. Using this field overwrites the totalFees value if you provided it as well.
»»»»»» name	string	true	none	Name of the fee.
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»» primaryDebtor	BaseDebtor	false	none	none
»»»»»» birthday	string(date)	false	none	Birthday of the debtor
»»»»»» gender	string	false	none	Gender of the debtor
»»»»»» firstName	string	false	none	First name of the debtor (required if type is 'natural')
»»»»»» lastName	string	false	none	Last name of the debtor (required if type is 'natural')
»»»»»» middleName	string	false	none	Middle name of the debtor
»»»»»» title	string	false	none	Title of the debtor
»»»»»» companyName	string	false	none	Company Name of the debtor (required if type is 'legal')
»»»»»» debtorReference	DebtorReference	false	none	Your customer ID for this person or company
»»»»»» SSN	string	false	none	National Identification Number of the debtor
»»»»»» type	string	false	none	Type of the debtor (default: natural)
»»»»»» contactInformation	BaseContactInformation	false	none	none
»»»»»»» country	string	false	none	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»»»» city	string	false	none	City
»»»»»»» mobileNumber	string	false	none	Mobile Number
»»»»»»» postalCode	string	false	none	Postal Code
»»»»»»» houseNumber	string	false	none	House number as part of the address
»»»»»»» addressLine1	string	false	none	Address Line 1
»»»»»»» addressLine2	string	false	none	Address Line 2
»»»»»»» addressLine3	string	false	none	Address Line 3
»»»»»»» landLine	string	false	none	Land Line
»»»»»»» state	string	false	none	State
»»»»»»» email	string	false	none	Email Address
»»»»»»» additionalContactInformation	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» email	string	true	none	Email Address

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» mobileNumber	string	true	none	Mobile Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» landLine	string	true	none	Land Line Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» workPhoneNumber	string	true	none	Work Phone Number

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» originalDueDate	OriginalDueDate(date)	true	none	Original due date in your system. This is the day when it went past due. DPD 0.
»»»»» currentDueDate	DueDate(date)	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	The `accountReference` is optional, but `primaryDebtor` and `currency` are required
»»»»»» primaryDebtor	any	true	none	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

allOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	BaseDebtor	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» contactInformation	any	true	none	Contact information of the debtor, used for communication purposes.

allOf

Name	Type	Required	Restrictions	Description
»»»»»»»»» anonymous	BaseContactInformation	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»»»»» anonymous	object	false	none	none

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	The `primaryDebtor` and the `currency` of the `Account` is used if not specified in the `Claim`

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL
type	natural
type	legal

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

recreateClaims

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/recreate_claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/recreate_claims HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "CLAIM_REF_002_1": {
        "amount": 1000,
        "currency": "EUR",
        "currentDueDate": "2019-02-15",
        "originalDueDate": "2019-09-09",
        "productReference": "PRODUCT_REFERENCE_002",
        "accountReference": "ACCOUNT_REFERENCE_002",
        "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
        "totalFees": 0,
        "primaryDebtor": {
            "debtorReference": "EXTERNAL_DEBTOR_REF_002",
            "firstName": "F_N",
            "lastName": "L_N",
            "contactInformation": {
              "email": "first.last@acme.com",
              "country": "DE"
            }
        },
        "meta": {}
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/recreate_claims',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/recreate_claims',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/recreate_claims', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/recreate_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/recreate_claims");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/recreate_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/recreate_claims

Recreate claims in Receeve, applicable for already deleted claims.

The intetion of this endpoint is to recreate Claims in Receeve. Notes: - This endpoint throws an error if the Claim is not deleted. - The claims created with this endpoint are not managed by the Ledger. - Recreating the claim will restart the claim lifecycle and the other related entities, this is specially important for the Collections Strategy, that will start from the beginning. For more details about the Claim, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"CLAIM_REF_002_1\": {\n        \"amount\": 1000,\n        \"currency\": \"EUR\",\n        \"currentDueDate\": \"2019-02-15\",\n        \"originalDueDate\": \"2019-09-09\",\n        \"productReference\": \"PRODUCT_REFERENCE_002\",\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"portfolioReference\": \"EXTERNAL_PORTFOLIO_REFERENCE_002\",\n        \"totalFees\": 0,\n        \"primaryDebtor\": {\n            \"debtorReference\": \"EXTERNAL_DEBTOR_REF_002\",\n            \"firstName\": \"F_N\",\n            \"lastName\": \"L_N\",\n            \"contactInformation\": {\n              \"email\": \"first.last@acme.com\",\n              \"country\": \"DE\"\n            }\n        },\n        \"meta\": {}\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	object	true	none
» additionalProperties	body	any	false	Used when creating or importing claims
»» anonymous	body	BaseClaim	false	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.
»»» amount	body	Amount	false	Monetary value in cents (natural nuumber)
»»» currency	body	Currency	false	3-digit currency code (ISO 4217)
»»» portfolioReference	body	PortfolioReference	false	This is a optional grouping field for reporting purposes.
»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»» creditorReference	body	string	false	Reference of the person/company to whom money is owed
»»» totalFees	body	Amount	false	Monetary value in cents (natural nuumber)
»»» currentDueDate	body	DueDate(date)	false	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»» originalDueDate	body	OriginalDueDate(date)	false	Original due date in your system. This is the day when it went past due. DPD 0.
»»» scores	body	[ClaimScore]	false	List of scores
»»»» type	body	string	true	Type of score
»»»» value	body	any	true	none
»»»»» anonymous	body	string	false	The score's value
»»»»» anonymous	body	object	false	composed value
»»»»» anonymous	body	null	false	No value
»»»» meta	body	Metadata	false	Additional information related to the entity.
»»» reason	body	string	false	Reason for updating a claim (the reason must not be part of the Entity)
»»» paymentReference	body	PaymentReference	false	Payment reference used in online transactions.
»»» accountNumber	body	any	false	none
»»»» anonymous	body	AccountReference	false	Account reference in your system
»»»» anonymous	body	number	false	Account number in your system (DEPRECATED, use accountReference)
»»» accountReference	body	AccountReference	false	Account reference in your system
»»» meta	body	Metadata	false	Additional information related to the entity.
»»» fees	body	[Fee]	false	List of fees. If neither fees nor totalFees are provided - we treat totalFees as 0. Using this field overwrites the totalFees value if you provided it as well.
»»»» name	body	string	true	Name of the fee.
»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»» primaryDebtor	body	BaseDebtor	false	none
»»»» birthday	body	string(date)	false	Birthday of the debtor
»»»» gender	body	string	false	Gender of the debtor
»»»» firstName	body	string	false	First name of the debtor (required if type is 'natural')
»»»» lastName	body	string	false	Last name of the debtor (required if type is 'natural')
»»»» middleName	body	string	false	Middle name of the debtor
»»»» title	body	string	false	Title of the debtor
»»»» companyName	body	string	false	Company Name of the debtor (required if type is 'legal')
»»»» debtorReference	body	DebtorReference	false	Your customer ID for this person or company
»»»» SSN	body	string	false	National Identification Number of the debtor
»»»» type	body	string	false	Type of the debtor (default: natural)
»»»» contactInformation	body	BaseContactInformation	false	none
»»»»» country	body	string	false	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»» city	body	string	false	City
»»»»» mobileNumber	body	string	false	Mobile Number
»»»»» postalCode	body	string	false	Postal Code
»»»»» houseNumber	body	string	false	House number as part of the address
»»»»» addressLine1	body	string	false	Address Line 1
»»»»» addressLine2	body	string	false	Address Line 2
»»»»» addressLine3	body	string	false	Address Line 3
»»»»» landLine	body	string	false	Land Line
»»»»» state	body	string	false	State
»»»»» email	body	string	false	Email Address
»»»»» additionalContactInformation	body	[oneOf]	false	none
»»»»»» anonymous	body	object	false	none
»»»»»»» email	body	string	true	Email Address
»»»»»» anonymous	body	object	false	none
»»»»»»» mobileNumber	body	string	true	Mobile Number
»»»»»» anonymous	body	object	false	none
»»»»»»» landLine	body	string	true	Land Line Number
»»»»»» anonymous	body	object	false	none
»»»»»»» workPhoneNumber	body	string	true	Work Phone Number
»» anonymous	body	object	false	none
»»» originalDueDate	body	OriginalDueDate(date)	true	Original due date in your system. This is the day when it went past due. DPD 0.
»»» currentDueDate	body	DueDate(date)	true	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»» anonymous	body	any	false	none
»»» anonymous	body	object	false	The `accountReference` is optional, but `primaryDebtor` and `currency` are required
»»»» primaryDebtor	body	any	true	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal).
»»»»» anonymous	body	BaseDebtor	false	none
»»»»» anonymous	body	object	false	none
»»»»»» contactInformation	body	any	true	Contact information of the debtor, used for communication purposes.
»»»»»»» anonymous	body	BaseContactInformation	false	none
»»»»»»» anonymous	body	object	false	none
»»» anonymous	body	object	false	The `primaryDebtor` and the `currency` of the `Account` is used if not specified in the `Claim`

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

»»» paymentReference: Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

»»»» primaryDebtor: The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

Enumerated Values

Parameter	Value
»»»» type	INTERNAL
»»»» type	EXTERNAL
»»»» type	COLLECTION
»»»» type	BEHAVIORAL
»»»» type	natural
»»»» type	legal

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
      "productReference": "PRODUCT_REFERENCE_1",
      "creditorReference": "string",
      "totalFees": 13025,
      "currentDueDate": "2019-06-28",
      "originalDueDate": "2019-06-28",
      "scores": [
        {
          "type": "INTERNAL",
          "value": "risky",
          "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
        }
      ],
      "reason": "string",
      "paymentReference": "paymentReference1",
      "accountNumber": "string",
      "accountReference": "ACCOUNT_REFERENCE_002",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
      "fees": [
        {
          "name": "Interest",
          "amount": 13025
        }
      ],
      "primaryDebtor": {
        "birthday": "1980-06-28",
        "gender": "M",
        "firstName": "John",
        "lastName": "White",
        "middleName": "Benedict",
        "title": "Doctor",
        "companyName": "Acme Brick Co.",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "SSN": "AAA-GG-SSSS",
        "type": "natural",
        "contactInformation": {
          "country": "DE",
          "city": "Delbrück",
          "mobileNumber": 495555555555,
          "postalCode": 33129,
          "houseNumber": "24A",
          "addressLine1": "Boikweg 24",
          "addressLine2": "c/o Acme",
          "addressLine3": "first floor",
          "landLine": 495555555555,
          "state": "Dortmund",
          "email": "testEmail@example.com",
          "additionalContactInformation": [
            {
              "email": "testEmail@example.com"
            }
          ]
        }
      }
    }
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
      "productReference": "PRODUCT_REFERENCE_1",
      "creditorReference": "string",
      "totalFees": 13025,
      "currentDueDate": "2019-06-28",
      "originalDueDate": "2019-06-28",
      "scores": [
        {
          "type": "INTERNAL",
          "value": "risky",
          "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
        }
      ],
      "reason": "string",
      "paymentReference": "paymentReference1",
      "accountNumber": "string",
      "accountReference": "ACCOUNT_REFERENCE_002",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
      "fees": [
        {
          "name": "Interest",
          "amount": 13025
        }
      ],
      "primaryDebtor": {
        "birthday": "1980-06-28",
        "gender": "M",
        "firstName": "John",
        "lastName": "White",
        "middleName": "Benedict",
        "title": "Doctor",
        "companyName": "Acme Brick Co.",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "SSN": "AAA-GG-SSSS",
        "type": "natural",
        "contactInformation": {
          "country": "DE",
          "city": "Delbrück",
          "mobileNumber": 495555555555,
          "postalCode": 33129,
          "houseNumber": "24A",
          "addressLine1": "Boikweg 24",
          "addressLine2": "c/o Acme",
          "addressLine3": "first floor",
          "landLine": 495555555555,
          "state": "Dortmund",
          "email": "testEmail@example.com",
          "additionalContactInformation": [
            {
              "email": "testEmail@example.com"
            }
          ]
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response of recreating a set of claims	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	any	false	none	Used when creating or importing claims

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	BaseClaim	false	none	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.
»»»»» amount	Amount	false	none	Monetary value in cents (natural nuumber)
»»»»» currency	Currency	false	none	3-digit currency code (ISO 4217)
»»»»» portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
»»»»» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
»»»»» creditorReference	string	false	none	Reference of the person/company to whom money is owed
»»»»» totalFees	Amount	false	none	Monetary value in cents (natural nuumber)
»»»»» currentDueDate	DueDate(date)	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»»» originalDueDate	OriginalDueDate(date)	false	none	Original due date in your system. This is the day when it went past due. DPD 0.
»»»»» scores	[ClaimScore]	false	none	List of scores
»»»»»» type	string	true	none	Type of score
»»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	The score's value

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	composed value

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	null	false	none	No value

continued

Name	Type	Required	Restrictions	Description
»»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» reason	string	false	none	Reason for updating a claim (the reason must not be part of the Entity)
»»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
»»»»» accountNumber	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	AccountReference	false	none	Account reference in your system

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	number	false	none	Account number in your system (DEPRECATED, use accountReference)

continued

Name	Type	Required	Restrictions	Description
»»»»» accountReference	AccountReference	false	none	Account reference in your system
»»»»» meta	Metadata	false	none	Additional information related to the entity.
»»»»» fees	[Fee]	false	none	List of fees. If neither fees nor totalFees are provided - we treat totalFees as 0. Using this field overwrites the totalFees value if you provided it as well.
»»»»»» name	string	true	none	Name of the fee.
»»»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»»» primaryDebtor	BaseDebtor	false	none	none
»»»»»» birthday	string(date)	false	none	Birthday of the debtor
»»»»»» gender	string	false	none	Gender of the debtor
»»»»»» firstName	string	false	none	First name of the debtor (required if type is 'natural')
»»»»»» lastName	string	false	none	Last name of the debtor (required if type is 'natural')
»»»»»» middleName	string	false	none	Middle name of the debtor
»»»»»» title	string	false	none	Title of the debtor
»»»»»» companyName	string	false	none	Company Name of the debtor (required if type is 'legal')
»»»»»» debtorReference	DebtorReference	false	none	Your customer ID for this person or company
»»»»»» SSN	string	false	none	National Identification Number of the debtor
»»»»»» type	string	false	none	Type of the debtor (default: natural)
»»»»»» contactInformation	BaseContactInformation	false	none	none
»»»»»»» country	string	false	none	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»»»» city	string	false	none	City
»»»»»»» mobileNumber	string	false	none	Mobile Number
»»»»»»» postalCode	string	false	none	Postal Code
»»»»»»» houseNumber	string	false	none	House number as part of the address
»»»»»»» addressLine1	string	false	none	Address Line 1
»»»»»»» addressLine2	string	false	none	Address Line 2
»»»»»»» addressLine3	string	false	none	Address Line 3
»»»»»»» landLine	string	false	none	Land Line
»»»»»»» state	string	false	none	State
»»»»»»» email	string	false	none	Email Address
»»»»»»» additionalContactInformation	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» email	string	true	none	Email Address

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» mobileNumber	string	true	none	Mobile Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» landLine	string	true	none	Land Line Number

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	object	false	none	none
»»»»»»»»» workPhoneNumber	string	true	none	Work Phone Number

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» originalDueDate	OriginalDueDate(date)	true	none	Original due date in your system. This is the day when it went past due. DPD 0.
»»»»» currentDueDate	DueDate(date)	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	The `accountReference` is optional, but `primaryDebtor` and `currency` are required
»»»»»» primaryDebtor	any	true	none	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

allOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	BaseDebtor	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	object	false	none	none
»»»»»»»» contactInformation	any	true	none	Contact information of the debtor, used for communication purposes.

allOf

Name	Type	Required	Restrictions	Description
»»»»»»»»» anonymous	BaseContactInformation	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»»»»»» anonymous	object	false	none	none

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	The `primaryDebtor` and the `currency` of the `Account` is used if not specified in the `Claim`

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL
type	natural
type	legal

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

updateClaims

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/update_claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/update_claims HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "CLAIM_REF_002_1": {
        "amount": 5000
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/update_claims',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/update_claims',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/update_claims', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/update_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/update_claims");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/update_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/update_claims

Update claims in the platform

The intetion of this endpoint is to update existing Claims in Receeve. Notes: - This endpoint throws an error if the Claim does not exist. - The claims updated with this endpoint are not managed by the Ledger. To update Claims related with the Ledger, use the Ledger related API endpoints. - The payload is identical to other Claim related endpoints (like create_claims) but it can receive partial information, only the fields that are updated will be changed. For more details about the Claim, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"CLAIM_REF_002_1\": {\n        \"amount\": 5000\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
forceAmountCheck	query	boolean	false	The force claim status update when amount is updated
body	body	object	true	none
» additionalProperties	body	any	false	Input for update_claims endpoint.
»» anonymous	body	BaseClaim	false	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.
»»» amount	body	Amount	false	Monetary value in cents (natural nuumber)
»»» currency	body	Currency	false	3-digit currency code (ISO 4217)
»»» portfolioReference	body	PortfolioReference	false	This is a optional grouping field for reporting purposes.
»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»» creditorReference	body	string	false	Reference of the person/company to whom money is owed
»»» totalFees	body	Amount	false	Monetary value in cents (natural nuumber)
»»» currentDueDate	body	DueDate(date)	false	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»» originalDueDate	body	OriginalDueDate(date)	false	Original due date in your system. This is the day when it went past due. DPD 0.
»»» scores	body	[ClaimScore]	false	List of scores
»»»» type	body	string	true	Type of score
»»»» value	body	any	true	none
»»»»» anonymous	body	string	false	The score's value
»»»»» anonymous	body	object	false	composed value
»»»»» anonymous	body	null	false	No value
»»»» meta	body	Metadata	false	Additional information related to the entity.
»»» reason	body	string	false	Reason for updating a claim (the reason must not be part of the Entity)
»»» paymentReference	body	PaymentReference	false	Payment reference used in online transactions.
»»» accountNumber	body	any	false	none
»»»» anonymous	body	AccountReference	false	Account reference in your system
»»»» anonymous	body	number	false	Account number in your system (DEPRECATED, use accountReference)
»»» accountReference	body	AccountReference	false	Account reference in your system
»»» meta	body	Metadata	false	Additional information related to the entity.
»»» fees	body	[Fee]	false	List of fees. If neither fees nor totalFees are provided - we treat totalFees as 0. Using this field overwrites the totalFees value if you provided it as well.
»»»» name	body	string	true	Name of the fee.
»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»» primaryDebtor	body	BaseDebtor	false	none
»»»» birthday	body	string(date)	false	Birthday of the debtor
»»»» gender	body	string	false	Gender of the debtor
»»»» firstName	body	string	false	First name of the debtor (required if type is 'natural')
»»»» lastName	body	string	false	Last name of the debtor (required if type is 'natural')
»»»» middleName	body	string	false	Middle name of the debtor
»»»» title	body	string	false	Title of the debtor
»»»» companyName	body	string	false	Company Name of the debtor (required if type is 'legal')
»»»» debtorReference	body	DebtorReference	false	Your customer ID for this person or company
»»»» SSN	body	string	false	National Identification Number of the debtor
»»»» type	body	string	false	Type of the debtor (default: natural)
»»»» contactInformation	body	BaseContactInformation	false	none
»»»»» country	body	string	false	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»» city	body	string	false	City
»»»»» mobileNumber	body	string	false	Mobile Number
»»»»» postalCode	body	string	false	Postal Code
»»»»» houseNumber	body	string	false	House number as part of the address
»»»»» addressLine1	body	string	false	Address Line 1
»»»»» addressLine2	body	string	false	Address Line 2
»»»»» addressLine3	body	string	false	Address Line 3
»»»»» landLine	body	string	false	Land Line
»»»»» state	body	string	false	State
»»»»» email	body	string	false	Email Address
»»»»» additionalContactInformation	body	[oneOf]	false	none
»»»»»» anonymous	body	object	false	none
»»»»»»» email	body	string	true	Email Address
»»»»»» anonymous	body	object	false	none
»»»»»»» mobileNumber	body	string	true	Mobile Number
»»»»»» anonymous	body	object	false	none
»»»»»»» landLine	body	string	true	Land Line Number
»»»»»» anonymous	body	object	false	none
»»»»»»» workPhoneNumber	body	string	true	Work Phone Number
»» anonymous	body	object	false	Additional modifiers when updating claims
»»» options	body	object	false	none
»»»» forceAmountCheck	body	boolean	false	Let the claim status the same, regardless of the changes in the amount

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

»»» paymentReference: Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

Enumerated Values

Parameter	Value
»»»» type	INTERNAL
»»»» type	EXTERNAL
»»»» type	COLLECTION
»»»» type	BEHAVIORAL
»»»» type	natural
»»»» type	legal

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

importClaims

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/import_claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/import_claims HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "API_CLAIM_REF_002": {
        "amount": 3002,
        "totalFees": 40,
        "currency": "EUR",
        "currentDueDate": "2019-02-15",
        "originalDueDate": "2019-09-09",
        "productReference": "PRODUCT_REFERENCE_002",
        "accountReference": "ACCOUNT_REFERENCE_002",
        "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
        "primaryDebtor": {
            "debtorReference": "EXTERNAL_DEBTOR_REF_002",
            "firstName": "F_N",
            "lastName": "L_N",
            "contactInformation": {
              "email": "first.last@acme.com",
              "country": "DE"
            }
        },
        "meta": {
            "claimMeta1": "value1",
            "claimMeta2": "value2"
        }
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/import_claims',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/import_claims',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/import_claims', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/import_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/import_claims");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/import_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/import_claims

Insert or Update Claims in the platform

The intetion of this endpoint is to create/update Claims in Receeve. It will create a new Claim if the Claim does not exist, or update the existing Claim if it already exists (abstraction over the create_claims and update_claims endpoints). Notes: - The claims updated with this endpoint are not managed by the Ledger. To update Claims related with the Ledger, use the Ledger related API endpoints. - Notice that the payload is identical to other Claim related endpoints (like create_claims), and it requires the full Claim information in the payload, that will be used to upsert the Claim. For more details about the Claim, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"API_CLAIM_REF_002\": {\n        \"amount\": 3002,\n        \"totalFees\": 40,\n        \"currency\": \"EUR\",\n        \"currentDueDate\": \"2019-02-15\",\n        \"originalDueDate\": \"2019-09-09\",\n        \"productReference\": \"PRODUCT_REFERENCE_002\",\n        \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        \"portfolioReference\": \"EXTERNAL_PORTFOLIO_REFERENCE_002\",\n        \"primaryDebtor\": {\n            \"debtorReference\": \"EXTERNAL_DEBTOR_REF_002\",\n            \"firstName\": \"F_N\",\n            \"lastName\": \"L_N\",\n            \"contactInformation\": {\n              \"email\": \"first.last@acme.com\",\n              \"country\": \"DE\"\n            }\n        },\n        \"meta\": {\n            \"claimMeta1\": \"value1\",\n            \"claimMeta2\": \"value2\"\n        }\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	object	true	none
» additionalProperties	body	any	false	Input for update_claims endpoint.
»» anonymous	body	any	false	Used when creating or importing claims
»»» anonymous	body	BaseClaim	false	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.
»»»» amount	body	Amount	false	Monetary value in cents (natural nuumber)
»»»» currency	body	Currency	false	3-digit currency code (ISO 4217)
»»»» portfolioReference	body	PortfolioReference	false	This is a optional grouping field for reporting purposes.
»»»» productReference	body	ProductReference	false	Identifier for a product in your system. It is used for grouping purposes.
»»»» creditorReference	body	string	false	Reference of the person/company to whom money is owed
»»»» totalFees	body	Amount	false	Monetary value in cents (natural nuumber)
»»»» currentDueDate	body	DueDate(date)	false	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»»» originalDueDate	body	OriginalDueDate(date)	false	Original due date in your system. This is the day when it went past due. DPD 0.
»»»» scores	body	[ClaimScore]	false	List of scores
»»»»» type	body	string	true	Type of score
»»»»» value	body	any	true	none
»»»»»» anonymous	body	string	false	The score's value
»»»»»» anonymous	body	object	false	composed value
»»»»»» anonymous	body	null	false	No value
»»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»» reason	body	string	false	Reason for updating a claim (the reason must not be part of the Entity)
»»»» paymentReference	body	PaymentReference	false	Payment reference used in online transactions.
»»»» accountNumber	body	any	false	none
»»»»» anonymous	body	AccountReference	false	Account reference in your system
»»»»» anonymous	body	number	false	Account number in your system (DEPRECATED, use accountReference)
»»»» accountReference	body	AccountReference	false	Account reference in your system
»»»» meta	body	Metadata	false	Additional information related to the entity.
»»»» fees	body	[Fee]	false	List of fees. If neither fees nor totalFees are provided - we treat totalFees as 0. Using this field overwrites the totalFees value if you provided it as well.
»»»»» name	body	string	true	Name of the fee.
»»»»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»»»» primaryDebtor	body	BaseDebtor	false	none
»»»»» birthday	body	string(date)	false	Birthday of the debtor
»»»»» gender	body	string	false	Gender of the debtor
»»»»» firstName	body	string	false	First name of the debtor (required if type is 'natural')
»»»»» lastName	body	string	false	Last name of the debtor (required if type is 'natural')
»»»»» middleName	body	string	false	Middle name of the debtor
»»»»» title	body	string	false	Title of the debtor
»»»»» companyName	body	string	false	Company Name of the debtor (required if type is 'legal')
»»»»» debtorReference	body	DebtorReference	false	Your customer ID for this person or company
»»»»» SSN	body	string	false	National Identification Number of the debtor
»»»»» type	body	string	false	Type of the debtor (default: natural)
»»»»» contactInformation	body	BaseContactInformation	false	none
»»»»»» country	body	string	false	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
»»»»»» city	body	string	false	City
»»»»»» mobileNumber	body	string	false	Mobile Number
»»»»»» postalCode	body	string	false	Postal Code
»»»»»» houseNumber	body	string	false	House number as part of the address
»»»»»» addressLine1	body	string	false	Address Line 1
»»»»»» addressLine2	body	string	false	Address Line 2
»»»»»» addressLine3	body	string	false	Address Line 3
»»»»»» landLine	body	string	false	Land Line
»»»»»» state	body	string	false	State
»»»»»» email	body	string	false	Email Address
»»»»»» additionalContactInformation	body	[oneOf]	false	none
»»»»»»» anonymous	body	object	false	none
»»»»»»»» email	body	string	true	Email Address
»»»»»»» anonymous	body	object	false	none
»»»»»»»» mobileNumber	body	string	true	Mobile Number
»»»»»»» anonymous	body	object	false	none
»»»»»»»» landLine	body	string	true	Land Line Number
»»»»»»» anonymous	body	object	false	none
»»»»»»»» workPhoneNumber	body	string	true	Work Phone Number
»»» anonymous	body	object	false	none
»»»» originalDueDate	body	OriginalDueDate(date)	true	Original due date in your system. This is the day when it went past due. DPD 0.
»»»» currentDueDate	body	DueDate(date)	true	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
»»» anonymous	body	any	false	none
»»»» anonymous	body	object	false	The `accountReference` is optional, but `primaryDebtor` and `currency` are required
»»»»» primaryDebtor	body	any	true	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal).
»»»»»» anonymous	body	BaseDebtor	false	none
»»»»»» anonymous	body	object	false	none
»»»»»»» contactInformation	body	any	true	Contact information of the debtor, used for communication purposes.
»»»»»»»» anonymous	body	BaseContactInformation	false	none
»»»»»»»» anonymous	body	object	false	none
»»»» anonymous	body	object	false	The `primaryDebtor` and the `currency` of the `Account` is used if not specified in the `Claim`
»» anonymous	body	object	false	Additional modifiers when updating claims
»»» options	body	object	false	none
»»»» forceAmountCheck	body	boolean	false	Let the claim status the same, regardless of the changes in the amount

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

»»»» paymentReference: Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

»»»»» primaryDebtor: The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

Enumerated Values

Parameter	Value
»»»»» type	INTERNAL
»»»»» type	EXTERNAL
»»»»» type	COLLECTION
»»»»» type	BEHAVIORAL
»»»»» type	natural
»»»»» type	legal

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

resolveClaims

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/resolve_claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/resolve_claims HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
  "[\n  {\n    \"ref\": \"API_CLAIM_REF_002_1\",\n    \"reason\": \"CLAIM_SOLD\"\n  }\n]\n"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/resolve_claims',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/resolve_claims',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/resolve_claims', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/resolve_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/resolve_claims");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/resolve_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/resolve_claims

Resolves Claims with a reason

The intetion of this endpoint is to resolve active Claims in Receeve. Notes: - The claim state will change to resolved, but it will not affect other properties of the claim like the amount, due date, etc. - To resolve the claim and update the amount to zero, please use the update_claims endpoint with the reason CLAIM_PAID as described in the Integration Documentation. For more details about the Claim, and the relationship with the other entities please visit the Account page.

Body parameter

[
  "[\n  {\n    \"ref\": \"API_CLAIM_REF_002_1\",\n    \"reason\": \"CLAIM_SOLD\"\n  }\n]\n"
]

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	array[object]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

creditClaims

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/credit_claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/credit_claims HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "API_CLAIM_REF_002_1": {
        "amount": 1000,
        "currency": "EUR",
        "originator": "DCA",
        "date": 1647526514000,
        "descriptionText": "The claim received a partial payment through the DCA"
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/credit_claims',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/credit_claims',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/credit_claims', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/credit_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/credit_claims");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/credit_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/credit_claims

Credit claims

The intention of this endpoint is to credit claims in Receeve. Notes: - Crediting the claim will decrease the amount of the claim. - If the claim amount is zero, the claim will be resolved. For more details about the Claim, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"API_CLAIM_REF_002_1\": {\n        \"amount\": 1000,\n        \"currency\": \"EUR\",\n        \"originator\": \"DCA\",\n        \"date\": 1647526514000,\n        \"descriptionText\": \"The claim received a partial payment through the DCA\"\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	object	true	none
» additionalProperties	body	CreditDebitClaimInput	false	none
»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»» currency	body	Currency	true	3-digit currency code (ISO 4217)
»» originator	body	string	true	none
»» date	body	number	false	date of credit/debit (unix timestamp in msec)
»» descriptionText	body	string	false	some description for credit/debit

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Enumerated Values

Parameter	Value
»» originator	DCA
»» originator	CLIENT

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "originator": "DCA",
      "date": 1647526514000,
      "descriptionText": "string"
    }
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "originator": "DCA",
      "date": 1647526514000,
      "descriptionText": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response of Credit/Debit Claim	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	CreditDebitClaimInput	false	none	none
»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»» currency	Currency	true	none	3-digit currency code (ISO 4217)
»»»» originator	string	true	none	none
»»»» date	number	false	none	date of credit/debit (unix timestamp in msec)
»»»» descriptionText	string	false	none	some description for credit/debit

Enumerated Values

Property	Value
originator	DCA
originator	CLIENT

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

debitClaims

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/debit_claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/debit_claims HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
    "API_CLAIM_REF_002_1": {
        "amount": 1000,
        "currency": "EUR",
        "originator": "CLIENT",
        "date": 1647526514000
    }
}
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/debit_claims',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/debit_claims',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/debit_claims', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/debit_claims', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/debit_claims");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/debit_claims", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/debit_claims

Debit claims

The intention of this endpoint is to debit claims in Receeve. Notes: - Debiting the claim will increase the amount of the claim. For more details about the Claim, and the relationship with the other entities please visit the Account page.

Body parameter

"{\n    \"API_CLAIM_REF_002_1\": {\n        \"amount\": 1000,\n        \"currency\": \"EUR\",\n        \"originator\": \"CLIENT\",\n        \"date\": 1647526514000\n    }\n}\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	object	true	none
» additionalProperties	body	CreditDebitClaimInput	false	none
»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»» currency	body	Currency	true	3-digit currency code (ISO 4217)
»» originator	body	string	true	none
»» date	body	number	false	date of credit/debit (unix timestamp in msec)
»» descriptionText	body	string	false	some description for credit/debit

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Enumerated Values

Parameter	Value
»» originator	DCA
»» originator	CLIENT

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "originator": "DCA",
      "date": 1647526514000,
      "descriptionText": "string"
    }
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "originator": "DCA",
      "date": 1647526514000,
      "descriptionText": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response of Credit/Debit Claim	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	CreditDebitClaimInput	false	none	none
»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»» currency	Currency	true	none	3-digit currency code (ISO 4217)
»»»» originator	string	true	none	none
»»»» date	number	false	none	date of credit/debit (unix timestamp in msec)
»»»» descriptionText	string	false	none	some description for credit/debit

Enumerated Values

Property	Value
originator	DCA
originator	CLIENT

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Journey

This is the overall strategy to resolve the outstanding payment or debt.

Strategy

pauseJourneys

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/pause_journeys \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/pause_journeys HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "ref": "CLAIM_REF_002"
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/pause_journeys',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/pause_journeys',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/pause_journeys', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/pause_journeys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/pause_journeys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/pause_journeys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/pause_journeys

(DEPRECATED) Pause Journeys for particular claims. You may restart them at a later date if you choose. It will resume where it left off.

Body parameter

"[\n    {\n        \"ref\": \"CLAIM_REF_002\"\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	array[object]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

resumeJourneys

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/resume_journeys \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/resume_journeys HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
    {
        "ref": "CLAIM_REF_002"
    }
]
';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/resume_journeys',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/resume_journeys',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/resume_journeys', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/resume_journeys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/resume_journeys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/resume_journeys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/resume_journeys

(DEPRECATED) Resume Journeys for particular claims.

Body parameter

"[\n    {\n        \"ref\": \"CLAIM_REF_002\"\n    }\n]\n"

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	array[object]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

stopJourneys

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/stop_journeys \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/stop_journeys HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
  {
    "ref": "CLAIM_REF_002",
    "reason": "CLAIM_PAID",
    "description": "Direct bank transfer received"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/stop_journeys',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/stop_journeys',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/stop_journeys', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/stop_journeys', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/stop_journeys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/stop_journeys", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/stop_journeys

(DEPRECATED) Stop Journeys for particular claims. This ends all processing on those claims.

Body parameter

[
  {
    "ref": "CLAIM_REF_002",
    "reason": "CLAIM_PAID",
    "description": "Direct bank transfer received"
  }
]

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	array[object]	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

LandingPage

The Landing Page of the Debtor, used to display, pay the Claims (or other use cases).

getLandingPageURL

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_landing_page_url?claimReference=ACCOUNT_REFERENCE_002 \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_landing_page_url?claimReference=ACCOUNT_REFERENCE_002 HTTP/1.1

Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_landing_page_url?claimReference=ACCOUNT_REFERENCE_002',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_landing_page_url',
  params: {
  'claimReference' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_landing_page_url', params={
  'claimReference': 'ACCOUNT_REFERENCE_002'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_landing_page_url', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_landing_page_url?claimReference=ACCOUNT_REFERENCE_002");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_landing_page_url", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_landing_page_url

Get Landing Page URL

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
claimReference	query	string	true	Receeve Claim Reference
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "URL": "https://domain.com/c/btXXskwXX"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request for get_landing_page_url is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
404	Not Found	Not found	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» URL	string	true	none	URL of Landing Page

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 404

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Event

Event that happened in Receeve systems, for example, claim created or email delivered.

getEvents

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_events?eventType=event.claim.created&date=2019-05-28 \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_events?eventType=event.claim.created&date=2019-05-28 HTTP/1.1

Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_events?eventType=event.claim.created&date=2019-05-28',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_events',
  params: {
  'eventType' => 'string',
'date' => 'string(date)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_events', params={
  'eventType': 'event.claim.created',  'date': '2019-05-28'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_events', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_events?eventType=event.claim.created&date=2019-05-28");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_events", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_events

Get events by event type and timeframe. Paginated.

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
eventType	query	string	true	type of event that happened in Receeve system
date	query	string(date)	true	date which to get the events for
limit	query	integer	false	amount of events per page, default is 1000
page	query	integer	false	number of page to retrieve the events for, default is 1

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "events": [
    {
      "messageId": "51a35d12-9145-4c97-8285-08156681e47",
      "timestamp": "2020-04-17T08:14:29.863Z",
      "details": {
        "messageType": "event.claim.created.v1",
        "claimRef": "ABCDEF123",
        "receeveClaimRef": "ABCDEF123-2020-01-15",
        "amount": 2000,
        "currency": "EUR",
        "dueDate": "2019-06-28"
      }
    }
  ],
  "limit": 1000,
  "page": 1,
  "numberOfPages": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	Request for get_events is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» events	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	ClaimCreatedEvent	false	none	none
»»» messageId	string	true	none	message identifier in Receeve system
»»» timestamp	string	true	none	UTC timestamp
»»» details	object	true	none	none
»»»» messageType	string	true	none	type of event that happened in Receeve system
»»»» claimRef	string	true	none	reference to the Claim in external(your) system
»»»» receeveClaimRef	string	true	none	reference to the Claim in Receeve system
»»»» amount	integer	true	none	Amount of the claim without fees in cents
»»»» currency	Currency	true	none	3-digit currency code (ISO 4217)
»»»» dueDate	DueDate(date)	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

Name	Type	Required	Restrictions	Description
»» anonymous	ClaimDebtPaymentProcessingEvent	false	none	none
»»» messageId	string	true	none	message identifier in Receeve system
»»» timestamp	string	true	none	UTC timestamp
»»» details	object	true	none	none
»»»» messageType	string	true	none	type of event that happened in Receeve system
»»»» claimRef	string	true	none	reference to the Claim in external(your) system
»»»» receeveClaimRef	string	true	none	reference to the Claim in Receeve system
»»»» providerName	string	true	none	Name of payment provider
»»»» amount	integer	true	none	Amount of the payment transaction in cents
»»»» currency	Currency	true	none	3-digit currency code (ISO 4217)
»»»» trackingId	string	true	none	Tracking id from payment provider
»»»» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

continued

Name	Type	Required	Restrictions	Description
» limit	integer	true	none	amount of events per current page
» page	integer	true	none	current page number
» numberOfPages	integer	true	none	amount of pages with limit that is given for that request

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Message

Communication message in .eml format that was sent to Debtor.

getMessage

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_message?messageURL=%2FOperations%2Femail%2FMessage%2F3b97bd7a-1c07-44d4-b33f-2250f6419e95.eml \
  -H 'Accept: text/plain' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_message?messageURL=%2FOperations%2Femail%2FMessage%2F3b97bd7a-1c07-44d4-b33f-2250f6419e95.eml HTTP/1.1

Accept: text/plain
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'text/plain',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_message?messageURL=%2FOperations%2Femail%2FMessage%2F3b97bd7a-1c07-44d4-b33f-2250f6419e95.eml',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_message',
  params: {
  'messageURL' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_message', params={
  'messageURL': '/Operations/email/Message/3b97bd7a-1c07-44d4-b33f-2250f6419e95.eml'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_message', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_message?messageURL=%2FOperations%2Femail%2FMessage%2F3b97bd7a-1c07-44d4-b33f-2250f6419e95.eml");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_message", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_message

Get message in .eml format.

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
messageURL	query	string	true	URL of the message

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

"Content-Type: text/plain; charset=utf-8 Message-ID: <f533311e-9dd6-5209-2969-1ad8d3e64636@169.169.169.93> Content-Transfer-Encoding: quoted-printable Date: Thu, 12 Mar 2020 14:19:04 +0000 MIME-Version: 1.0\nSMS Text =E2=82=AC20.42"

400 Response

{
  "message": "Missing required request parameters: [Authorization]"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request for get_message is successful	string
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

getCommunicationMessageURLs

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_communication_message_urls?claimReference=ACCOUNT_REFERENCE_002 \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_communication_message_urls?claimReference=ACCOUNT_REFERENCE_002 HTTP/1.1

Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_communication_message_urls?claimReference=ACCOUNT_REFERENCE_002',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_communication_message_urls',
  params: {
  'claimReference' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_communication_message_urls', params={
  'claimReference': 'ACCOUNT_REFERENCE_002'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_communication_message_urls', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_communication_message_urls?claimReference=ACCOUNT_REFERENCE_002");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_communication_message_urls", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_communication_message_urls

Get communication message URLs by communication type, timeframe. Paginated.

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
claimReference	query	string	true	Receeve Claim Reference
communicationType	query	string	false	type of communication that happened in Receeve system. Leave it unspecified to get message URLs related to all communication types.
startDate	query	string(date)	false	date from which to start getting the events
limit	query	integer	false	amount of events per page, default is 1000
page	query	integer	false	number of page to retrieve the events for, default is 1

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Enumerated Values

Parameter	Value
communicationType	email
communicationType	letter
communicationType	SMS

Example responses

200 Response

{
  "communicationMessageURLs": [
    {
      "communicationType": "email",
      "messageURL": "/Operations/email/Message/3b97bd7a-1c07-44d4-b33f-2250f6419e95.eml",
      "dateTime": 1621536535901,
      "bundleId": "00000000-0000-0000-0000-000000000000",
      "bundleName": "Default Email Template"
    }
  ],
  "limit": 1000,
  "page": 1,
  "numberOfPages": 2
}

Responses

Status	Meaning	Description	Schema
200	OK	Request for get_communication_message_urls is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» communicationMessageURLs	[CommunicationMessageURL]	true	none	none
»» communicationType	string	true	none	type of communication that happened in Receeve system
»» messageURL	string	true	none	URL of the message
»» dateTime	integer	true	none	Timestamp when the communication event occured
»» bundleId	string(uuid)	true	none	template id of communication that happened in Receeve system
»» bundleName	string	true	none	template display name of communication that happened in Receeve system
» limit	integer	true	none	amount of events per current page
» page	integer	true	none	current page number
» numberOfPages	integer	true	none	amount of pages with limit that is given for that request

Enumerated Values

Property	Value
communicationType	email
communicationType	letter
communicationType	SMS

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

PromiseToPay

createPromisesToPay

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/create_promises_to_pay \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/create_promises_to_pay HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
  "property1": {
    "amount": 13025,
    "currency": "EUR",
    "dueDate": "2019-06-28"
  },
  "property2": {
    "amount": 13025,
    "currency": "EUR",
    "dueDate": "2019-06-28"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/create_promises_to_pay',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/create_promises_to_pay',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/create_promises_to_pay', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/create_promises_to_pay', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/create_promises_to_pay");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/create_promises_to_pay", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/create_promises_to_pay

Create promises to pay, a Promise to Pay enables a debt to be paid partially by a certain minimum amount and by a particular due date.

Body parameter

{
  "property1": {
    "amount": 13025,
    "currency": "EUR",
    "dueDate": "2019-06-28"
  },
  "property2": {
    "amount": 13025,
    "currency": "EUR",
    "dueDate": "2019-06-28"
  }
}

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	object	true	none
» additionalProperties	body	PromiseToPay	false	A promise to pay is a commitment from a debtor to pay a certain amount at a certain date.
»» amount	body	Amount	true	Monetary value in cents (natural nuumber)
»» currency	body	Currency	true	3-digit currency code (ISO 4217)
»» dueDate	body	DueDate(date)	true	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "dueDate": "2019-06-28"
    }
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": {
      "amount": 13025,
      "currency": "EUR",
      "dueDate": "2019-06-28"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response of creating a set of promises to pay	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	PromiseToPay	false	none	A promise to pay is a commitment from a debtor to pay a certain amount at a certain date.
»»»» amount	Amount	true	none	Monetary value in cents (natural nuumber)
»»»» currency	Currency	true	none	3-digit currency code (ISO 4217)
»»»» dueDate	DueDate(date)	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

CustomTriggers

executeCustomTriggers

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/execute_custom_triggers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/execute_custom_triggers HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{
  "property1": "callDebtor",
  "property2": "callDebtor"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/execute_custom_triggers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/execute_custom_triggers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/execute_custom_triggers', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/execute_custom_triggers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/execute_custom_triggers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/execute_custom_triggers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/execute_custom_triggers

Execute custom triggers that can be configured in Reactions

Body parameter

{
  "property1": "callDebtor",
  "property2": "callDebtor"
}

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	object	true	none
» additionalProperties	body	any	false	none
»» anonymous	body	string	false	Custom Trigger Name
»» anonymous	body	object	false	ClaimReference as key and the Custom Trigger Name as the value
»»» triggerName	body	string	true	Custom Trigger Name
»»» triggerContext	body	object	false	key-value pairs to attach additional information to the trigger

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

AccountMandate

createAccountMandates

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/create_account_mandates \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/create_account_mandates HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
  {
    "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
    "accountReference": "ACCOUNT_REFERENCE_002",
    "providerName": "ferratumCheckoutCreditCardV2",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "productReferences": [
      "PRODUCT_REFERENCE_1"
    ],
    "mandateRepresentation": {
      "holderName": "string",
      "bankName": "string",
      "accountNumber": "string"
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/create_account_mandates',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/create_account_mandates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/create_account_mandates', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/create_account_mandates', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/create_account_mandates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/create_account_mandates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/create_account_mandates

Create account mandates in the platform

Body parameter

[
  {
    "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
    "accountReference": "ACCOUNT_REFERENCE_002",
    "providerName": "ferratumCheckoutCreditCardV2",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "productReferences": [
      "PRODUCT_REFERENCE_1"
    ],
    "mandateRepresentation": {
      "holderName": "string",
      "bankName": "string",
      "accountNumber": "string"
    }
  }
]

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	AccountMandateInput	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      {
        "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
        "accountReference": "ACCOUNT_REFERENCE_002",
        "providerName": "ferratumCheckoutCreditCardV2",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "productReferences": [
          "PRODUCT_REFERENCE_1"
        ],
        "mandateRepresentation": {
          "holderName": "string",
          "bankName": "string",
          "accountNumber": "string"
        }
      }
    ]
  },
  "property2": {
    "0": "{",
    "1": "\n",
    "2": " ",
    "3": " ",
    "4": "\"",
    "5": "s",
    "6": "u",
    "7": "c",
    "8": "c",
    "9": "e",
    "10": "s",
    "11": "s",
    "12": "\"",
    "13": ":",
    "14": " ",
    "15": "t",
    "16": "r",
    "17": "u",
    "18": "e",
    "19": ",",
    "20": "\n",
    "21": " ",
    "22": " ",
    "23": "\"",
    "24": "m",
    "25": "e",
    "26": "s",
    "27": "s",
    "28": "a",
    "29": "g",
    "30": "e",
    "31": "s",
    "32": "\"",
    "33": ":",
    "34": " ",
    "35": "[",
    "36": "\n",
    "37": " ",
    "38": " ",
    "39": " ",
    "40": " ",
    "41": " ",
    "42": " ",
    "43": "\"",
    "44": "S",
    "45": "u",
    "46": "c",
    "47": "c",
    "48": "e",
    "49": "s",
    "50": "s",
    "51": "f",
    "52": "u",
    "53": "l",
    "54": "l",
    "55": "y",
    "56": " ",
    "57": "p",
    "58": "r",
    "59": "o",
    "60": "c",
    "61": "e",
    "62": "s",
    "63": "s",
    "64": "e",
    "65": "d",
    "66": " ",
    "67": "a",
    "68": "c",
    "69": "t",
    "70": "i",
    "71": "o",
    "72": "n",
    "73": "\"",
    "74": "\n",
    "75": " ",
    "76": " ",
    "77": "]",
    "78": ",",
    "79": "\n",
    "80": " ",
    "81": " ",
    "82": "\"",
    "83": "m",
    "84": "e",
    "85": "s",
    "86": "s",
    "87": "a",
    "88": "g",
    "89": "e",
    "90": "I",
    "91": "d",
    "92": "s",
    "93": "\"",
    "94": ":",
    "95": " ",
    "96": "[",
    "97": "\n",
    "98": " ",
    "99": " ",
    "100": " ",
    "101": " ",
    "102": " ",
    "103": " ",
    "104": "\"",
    "105": "e",
    "106": "6",
    "107": "6",
    "108": "d",
    "109": "6",
    "110": "2",
    "111": "e",
    "112": "d",
    "113": "-",
    "114": "2",
    "115": "3",
    "116": "3",
    "117": "1",
    "118": "-",
    "119": "4",
    "120": "c",
    "121": "e",
    "122": "d",
    "123": "-",
    "124": "8",
    "125": "c",
    "126": "0",
    "127": "3",
    "128": "-",
    "129": "5",
    "130": "e",
    "131": "7",
    "132": "2",
    "133": "9",
    "134": "e",
    "135": "9",
    "136": "8",
    "137": "4",
    "138": "a",
    "139": "d",
    "140": "c",
    "141": "\"",
    "142": "\n",
    "143": " ",
    "144": " ",
    "145": "]",
    "146": "\n",
    "147": "}",
    "148": "\n",
    "data": [
      {
        "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
        "accountReference": "ACCOUNT_REFERENCE_002",
        "providerName": "ferratumCheckoutCreditCardV2",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "productReferences": [
          "PRODUCT_REFERENCE_1"
        ],
        "mandateRepresentation": {
          "holderName": "string",
          "bankName": "string",
          "accountNumber": "string"
        }
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Response of creating a set of account mandates	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»»» success	boolean	true	none	Status of the action
»»» messages	[string]	true	none	none
»»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» data	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	BaseAccountMandateInput	false	none	none
»»»»»» mandateId	string	true	none	mandate id (can be the mandate id of external system)
»»»»»» accountReference	AccountReference	true	none	Account reference in your system
»»»»»» providerName	string	true	none	Name of payment provider
»»»»»» debtorReference	DebtorReference	true	none	Your customer ID for this person or company
»»»»»» productReferences	[ProductReference]	true	none	Product References
»»»»»» mandateRepresentation	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	MandateAccountTypeRepresentation	false	none	none
»»»»»»»» holderName	string	false	none	none
»»»»»»»» bankName	string	true	none	none
»»»»»»»» accountNumber	string	true	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	MandateCardTypeRepresentation	false	none	none
»»»»»»»» cardIssuer	string	true	none	none
»»»»»»»» lastDigits	string	true	none	none
»»»»»»»» holderName	string	false	none	none
»»»»»»»» expiryMonth	string	false	none	none
»»»»»»»» expiryYear	string	false	none	none
»»»»»»»» bankName	string	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» providerName	string	true	none	none

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	BaseAccountMandateInput	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» providerName	string	true	none	none
»»»»»» clientIpAddress	string	true	none	The customer ip address is needed for Paylands mandate to work

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	BaseAccountMandateInput	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» providerName	string	true	none	none

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	BaseAccountMandateInput	false	none	none

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» providerName	string	true	none	none

Enumerated Values

Property	Value
providerName	ferratumCheckoutCreditCardV2
providerName	paylandsenBizum
providerName	paylandsenCards
providerName	split
providerName	trustly

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

deleteAccountMandates

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/delete_account_mandates \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/delete_account_mandates HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '[
  {
    "accountReference": "ACCOUNT_REFERENCE_002",
    "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/delete_account_mandates',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/delete_account_mandates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/delete_account_mandates', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/delete_account_mandates', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/delete_account_mandates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/delete_account_mandates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/delete_account_mandates

Delete account mandates in the platform

Body parameter

[
  {
    "accountReference": "ACCOUNT_REFERENCE_002",
    "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34"
  }
]

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
sequential	query	boolean	false	The request body items are executed one after another one
async	query	boolean	false	The request is added to the queue without expecting the response
body	body	AccountMandateDeleteInput	true	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

getAccountMandates

Code samples

# You can also use wget
curl -X GET /v1/{clientId}/get_account_mandates?accountReference=ACC \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

GET /v1/{clientId}/get_account_mandates?accountReference=ACC HTTP/1.1

Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw


const headers = {
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/get_account_mandates?accountReference=ACC',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.get '/v1/{clientId}/get_account_mandates',
  params: {
  'accountReference' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.get('/v1/{clientId}/get_account_mandates', params={
  'accountReference': 'ACC'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/{clientId}/get_account_mandates', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/get_account_mandates?accountReference=ACC");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/{clientId}/get_account_mandates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/{clientId}/get_account_mandates

Get account mandates

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
accountReference	query	string	true	Account reference in your system
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

[
  {
    "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
    "accountReference": "ACCOUNT_REFERENCE_002",
    "providerName": "trustly",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "productReferences": [
      "PRODUCT_REFERENCE_1"
    ],
    "mandateRepresentation": {
      "holderName": "string",
      "bankName": "string",
      "accountNumber": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Request for get_account_mandates is successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AccountMandate]	false	none	none
» mandateId	string	true	none	mandate id (can be the mandate id of external system)
» accountReference	AccountReference	true	none	Account reference in your system
» providerName	string	true	none	Name of payment provider
» debtorReference	DebtorReference	false	none	Your customer ID for this person or company
» productReferences	[ProductReference]	false	none	Product References
» mandateRepresentation	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	MandateAccountTypeRepresentation	false	none	none
»»» holderName	string	false	none	none
»»» bankName	string	true	none	none
»»» accountNumber	string	true	none	none

xor

Name	Type	Required	Restrictions	Description
»» anonymous	MandateCardTypeRepresentation	false	none	none
»»» cardIssuer	string	true	none	none
»»» lastDigits	string	true	none	none
»»» holderName	string	false	none	none
»»» expiryMonth	string	false	none	none
»»» expiryYear	string	false	none	none
»»» bankName	string	false	none	none

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Files

uploadFiles

Code samples

# You can also use wget
curl -X POST /v1/{clientId}/upload_files \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'

POST /v1/{clientId}/upload_files HTTP/1.1

Content-Type: multipart/form-data
Accept: application/json
Authorization: eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw

const inputBody = '{}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
};

fetch('/v1/{clientId}/upload_files',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data',
  'Accept' => 'application/json',
  'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

result = RestClient.post '/v1/{clientId}/upload_files',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'Authorization': 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw'
}

r = requests.post('/v1/{clientId}/upload_files', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/{clientId}/upload_files', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/{clientId}/upload_files");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"eyJraWQiOiJLMlJOeGR3RGJJT3R5SXQ2cVFxalhJU3dcL0FxZ0k2a2xCbkx1RHgzaHlscz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0YTF2bjZrNGFjNGhwNXV1M3EycXZ1NGNnYyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiZGVmYXVsdFwvRGVmYXVsdCIsImF1dGhfdGltZSI6MTY4MDc3MTU5NywiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfTzZVSjF6VHg1IiwiZXhwIjoxNjgwNzc1MTk3LCJpYXQiOjE2ODA3NzE1OTcsInZlcnNpb24iOjIsImp0aSI6ImIwYzk2MThmLWVkYjYtNDMxNS04ZDAyLTEzYjg2MzQyNWYwMyIsImNsaWVudF9pZCI6IjRhMXZuNms0YWM0aHA1dXUzcTJxdnU0Y2djIn0.FJTJbvKqDHc_Q2o4CHpTYCsim-snv1sQmld9T0DlXJsDOP5IVFFB_sSsuYl0DLfp1PEBc-r75oHmGrrL4en-uq104pW9t4D-4Byye78NzAm2DTRc1H9bF3M8_9V-ZEvttPnPP1qlbqLxSEBPPSJ69eXCs6v5ScPQRKqKxfqCnuCoJuWX-Jd5eM8oocdqObFTtRiLdoQs5Sa8xi-OEMGMrQBkxXW3kk-tKWtovSRoA6UsLRZG3_UK7sl7wE3Wl5qA2gl_PNIXTTFsR9WLbDpqIC8grctz2ayTmAaaR7538FesJFySzglVD0iNZiNbcPbIK4mNi1gaw18Av1uQ_mu3vw"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/{clientId}/upload_files", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/{clientId}/upload_files

It upload the files corresponding to the account

Body parameter

{}

Parameters

Name	In	Type	Required	Description
clientId	path	string(uuid)	true	A receeve system identifier that will be assigned automatically.
Authorization	header	string	true	OAuth2 Token (obtained from /oauth2/token )
triggerName	query	string	false	This is name of Custom Trigger that should be triggered when this API is called.
body	body	object	true	none
» file	body	string(binary)	true	The file to upload
» accountId	body	string	true	The account id
» documentType	body	string	false	Type of the document as specified in the backoffice e.g 'CSV', 'Invoice'
» externalClaimRef	body	string	false	External claim reference
» productReference	body	string	false	Product reference
» anonymous	body	object	false	none
» anonymous	body	object	false	none

Detailed descriptions

clientId: A receeve system identifier that will be assigned automatically. It will be used for situations like Support related interventions or data segmentation.

Authorization: OAuth2 Token (obtained from /oauth2/token ) Reference: https://knowledge.receeve.com/integration-authentication-use-case

Example responses

200 Response

{
  "property1": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n",
  "property2": "{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful	Inline
400	Bad Request	Incorrectly formed request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Access is denied	Inline
429	Too Many Requests	Request was throttled	Inline
500	Internal Server Error	Internal error occured	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	ActionResponse1	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)
»» success	boolean	true	none	Status of the action
»» messages	[string]	true	none	none
»» messageIds	[string]	true	none	Identifier of the messages (used for tracing)

Status Code 400

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 401

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 403

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 429

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» message	string	false	none	none

Schemas

AccountReference

"ACCOUNT_REFERENCE_002"

Account reference in your system

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Account reference in your system

PaymentReference

"paymentReference1"

Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

ClaimResolutionReason

"CLAIM_PAID"

The reason for the claim resolution.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The reason for the claim resolution.

Enumerated Values

Property	Value
anonymous	CLAIM_SOLD
anonymous	CLAIM_PAID
anonymous	FRAUDULENT
anonymous	CLAIM_DISCARDED
anonymous	CLAIM_DISCHARGED
anonymous	CLAIM_INVALIDATED

PortfolioReference

"EXTERNAL_PORTFOLIO_REFERENCE_002"

This is a optional grouping field for reporting purposes.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	This is a optional grouping field for reporting purposes.

ProductReference

"PRODUCT_REFERENCE_1"

Identifier for a product in your system. It is used for grouping purposes.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Identifier for a product in your system. It is used for grouping purposes.

DebtorReference

"EXTERNAL_DEBTOR_REF_002"

Your customer ID for this person or company

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Your customer ID for this person or company

Currency

"EUR"

3-digit currency code (ISO 4217)

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	3-digit currency code (ISO 4217)

Amount

Monetary value in cents (natural nuumber)

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Monetary value in cents (natural nuumber)

RelativeAmount

-13025

Monetary value in cents (positive or negative number)

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Monetary value in cents (positive or negative number)

DueDate

"2019-06-28"

Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(date)	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

OriginalDueDate

"2019-06-28"

Original due date in your system. This is the day when it went past due. DPD 0.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(date)	false	none	Original due date in your system. This is the day when it went past due. DPD 0.

Metadata

"{\n  \"sourceSystem\": \"system1\"\n}\n"

Additional information related to the entity.

Properties

None

LedgerEntryReference

"INVOICE_LEDGER_ENTRY_REFERENCE_002"

Reference of the Ledger Entry (unique per Account)

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Reference of the Ledger Entry (unique per Account)

LedgerEntryCreatedAt

1621536535901

Timestamp when the ledger entry was created in milliseconds

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Timestamp when the ledger entry was created in milliseconds

EntityWithAccountReference

"{\n    \"accountReference\": \"ACCOUNT_REFERENCE_002\"\n}\n"

Schema definition used in composition with other Entities, that have a reference to an Account

Properties

Name	Type	Required	Restrictions	Description
accountReference	AccountReference	true	none	Account reference in your system

Fee

{
  "name": "Interest",
  "amount": 13025
}

Additional expected payment amount.

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Name of the fee.
amount	Amount	true	none	Monetary value in cents (natural nuumber)

Account

"{\n    \"currency\": \"EUR\",\n    \"paymentReference\": \"paymentReference1\",\n    \"meta\": {\n        \"invoiceExternalNumber\": 111\n    },\n    \"scores\": [\n        {\n            \"type\": \"INTERNAL\",\n            \"value\": \"V1\"\n        }\n    ],\n    \"debtors\": [\n        {\n            \"lastName\": \"LAST_NAME_1\",\n            \"firstName\": \"FIRST_NAME_1\",\n            \"debtorReference\": \"EXTERNAL_DEBTOR_REF_001\",\n            \"contactInformation\": {\n                \"country\": \"DE\",\n                \"email\": \"first.last@acme.com\"\n            }\n        }\n    ],\n    \"products\": [\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_1\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_1\"\n        },\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_2\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_2\"\n        }\n    ],\n    \"ledgerEntries\": [\n        {\n            \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n            \"invoiceDetails\": {\n                \"amount\": 100000,\n                \"dueDate\": \"2022-01-08\",\n                \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n            },\n            \"context\": {\n                \"productReference\": \"PRODUCT_REFERENCE_1\"\n            }\n        }\n    ]\n}\n"

A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an Account.

Properties

Name	Type	Required	Restrictions	Description
meta	Metadata	false	none	Additional information related to the entity.
paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
currency	Currency	false	none	3-digit currency code (ISO 4217)
scores	[AccountScore]	false	none	List of provided scores related with the Account.
debtors	[Debtor]	false	none	List of debtors related with the Account.
products	[Product]	false	none	List of products related with the Account.
ledgerEntries	[LedgerEntry]	false	none	Ledger used to create Managed Claims.

Debtor

{
  "birthday": "1980-06-28",
  "gender": "M",
  "firstName": "John",
  "lastName": "White",
  "middleName": "Benedict",
  "title": "Doctor",
  "companyName": "Acme Brick Co.",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "SSN": "AAA-GG-SSSS",
  "type": "natural",
  "contactInformation": {
    "country": "DE",
    "city": "Delbrück",
    "mobileNumber": 495555555555,
    "postalCode": 33129,
    "houseNumber": "24A",
    "addressLine1": "Boikweg 24",
    "addressLine2": "c/o Acme",
    "addressLine3": "first floor",
    "landLine": 495555555555,
    "state": "Dortmund",
    "email": "testEmail@example.com",
    "additionalContactInformation": [
      {
        "email": "testEmail@example.com"
      }
    ]
  }
}

The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseDebtor	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» contactInformation	ContactInformation	true	none	Contact information of the debtor, used for communication purposes.

ContactInformation

{
  "country": "DE",
  "city": "Delbrück",
  "mobileNumber": 495555555555,
  "postalCode": 33129,
  "houseNumber": "24A",
  "addressLine1": "Boikweg 24",
  "addressLine2": "c/o Acme",
  "addressLine3": "first floor",
  "landLine": 495555555555,
  "state": "Dortmund",
  "email": "testEmail@example.com",
  "additionalContactInformation": [
    {
      "email": "testEmail@example.com"
    }
  ]
}

Contact information of the debtor, used for communication purposes.

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseContactInformation	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

BaseContactInformation

{
  "country": "DE",
  "city": "Delbrück",
  "mobileNumber": 495555555555,
  "postalCode": 33129,
  "houseNumber": "24A",
  "addressLine1": "Boikweg 24",
  "addressLine2": "c/o Acme",
  "addressLine3": "first floor",
  "landLine": 495555555555,
  "state": "Dortmund",
  "email": "testEmail@example.com",
  "additionalContactInformation": [
    {
      "email": "testEmail@example.com"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
country	string	false	none	2-digit country code (ISO 3166-1). This is required for the localization and payment providers.
city	string	false	none	City
mobileNumber	string	false	none	Mobile Number
postalCode	string	false	none	Postal Code
houseNumber	string	false	none	House number as part of the address
addressLine1	string	false	none	Address Line 1
addressLine2	string	false	none	Address Line 2
addressLine3	string	false	none	Address Line 3
landLine	string	false	none	Land Line
state	string	false	none	State
email	string	false	none	Email Address
additionalContactInformation	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» email	string	true	none	Email Address

xor

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» mobileNumber	string	true	none	Mobile Number

xor

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» landLine	string	true	none	Land Line Number

xor

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» workPhoneNumber	string	true	none	Work Phone Number

BaseDebtor

{
  "birthday": "1980-06-28",
  "gender": "M",
  "firstName": "John",
  "lastName": "White",
  "middleName": "Benedict",
  "title": "Doctor",
  "companyName": "Acme Brick Co.",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "SSN": "AAA-GG-SSSS",
  "type": "natural",
  "contactInformation": {
    "country": "DE",
    "city": "Delbrück",
    "mobileNumber": 495555555555,
    "postalCode": 33129,
    "houseNumber": "24A",
    "addressLine1": "Boikweg 24",
    "addressLine2": "c/o Acme",
    "addressLine3": "first floor",
    "landLine": 495555555555,
    "state": "Dortmund",
    "email": "testEmail@example.com",
    "additionalContactInformation": [
      {
        "email": "testEmail@example.com"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
birthday	string(date)	false	none	Birthday of the debtor
gender	string	false	none	Gender of the debtor
firstName	string	false	none	First name of the debtor (required if type is 'natural')
lastName	string	false	none	Last name of the debtor (required if type is 'natural')
middleName	string	false	none	Middle name of the debtor
title	string	false	none	Title of the debtor
companyName	string	false	none	Company Name of the debtor (required if type is 'legal')
debtorReference	DebtorReference	false	none	Your customer ID for this person or company
SSN	string	false	none	National Identification Number of the debtor
type	string	false	none	Type of the debtor (default: natural)
contactInformation	BaseContactInformation	false	none	none

Enumerated Values

Property	Value
type	natural
type	legal

Product

{
  "productReference": "PRODUCT_REFERENCE_1",
  "paymentReference": "paymentReference1",
  "type": "Computer",
  "name": "Macbook Pro",
  "code": "111-22222-3333",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
}

A product is a service or item used to give context to the Claim or Ledger Entry

Properties

Name	Type	Required	Restrictions	Description
productReference	ProductReference	true	none	Identifier for a product in your system. It is used for grouping purposes.
paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
type	string	false	none	Type of product
name	string	false	none	Product name
code	string	false	none	Product code
meta	Metadata	false	none	Additional information related to the entity.

BaseClaim

{
  "amount": 13025,
  "currency": "EUR",
  "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
  "productReference": "PRODUCT_REFERENCE_1",
  "creditorReference": "string",
  "totalFees": 13025,
  "currentDueDate": "2019-06-28",
  "originalDueDate": "2019-06-28",
  "scores": [
    {
      "type": "INTERNAL",
      "value": "risky",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ],
  "reason": "string",
  "paymentReference": "paymentReference1",
  "accountNumber": "string",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
  "fees": [
    {
      "name": "Interest",
      "amount": 13025
    }
  ],
  "primaryDebtor": {
    "birthday": "1980-06-28",
    "gender": "M",
    "firstName": "John",
    "lastName": "White",
    "middleName": "Benedict",
    "title": "Doctor",
    "companyName": "Acme Brick Co.",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "SSN": "AAA-GG-SSSS",
    "type": "natural",
    "contactInformation": {
      "country": "DE",
      "city": "Delbrück",
      "mobileNumber": 495555555555,
      "postalCode": 33129,
      "houseNumber": "24A",
      "addressLine1": "Boikweg 24",
      "addressLine2": "c/o Acme",
      "addressLine3": "first floor",
      "landLine": 495555555555,
      "state": "Dortmund",
      "email": "testEmail@example.com",
      "additionalContactInformation": [
        {
          "email": "testEmail@example.com"
        }
      ]
    }
  }
}

A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.

Properties

Name	Type	Required	Restrictions	Description
amount	Amount	false	none	Monetary value in cents (natural nuumber)
currency	Currency	false	none	3-digit currency code (ISO 4217)
portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
creditorReference	string	false	none	Reference of the person/company to whom money is owed
totalFees	Amount	false	none	Monetary value in cents (natural nuumber)
currentDueDate	DueDate	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
originalDueDate	OriginalDueDate	false	none	Original due date in your system. This is the day when it went past due. DPD 0.
scores	[ClaimScore]	false	none	List of scores
reason	string	false	none	Reason for updating a claim (the reason must not be part of the Entity)
paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
accountNumber	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	AccountReference	false	none	Account reference in your system

and

Name	Type	Required	Restrictions	Description
» anonymous	number	false	none	Account number in your system (DEPRECATED, use accountReference)

continued

Name	Type	Required	Restrictions	Description
accountReference	AccountReference	false	none	Account reference in your system
meta	Metadata	false	none	Additional information related to the entity.
fees	[Fee]	false	none	List of fees. If neither fees nor totalFees are provided - we treat totalFees as 0. Using this field overwrites the totalFees value if you provided it as well.
primaryDebtor	BaseDebtor	false	none	none

Claim

{
  "amount": 13025,
  "currency": "EUR",
  "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
  "productReference": "PRODUCT_REFERENCE_1",
  "creditorReference": "string",
  "totalFees": 13025,
  "currentDueDate": "2019-06-28",
  "originalDueDate": "2019-06-28",
  "scores": [
    {
      "type": "INTERNAL",
      "value": "risky",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ],
  "reason": "string",
  "paymentReference": "paymentReference1",
  "accountNumber": "string",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
  "fees": [
    {
      "name": "Interest",
      "amount": 13025
    }
  ],
  "primaryDebtor": {
    "birthday": "1980-06-28",
    "gender": "M",
    "firstName": "John",
    "lastName": "White",
    "middleName": "Benedict",
    "title": "Doctor",
    "companyName": "Acme Brick Co.",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "SSN": "AAA-GG-SSSS",
    "type": "natural",
    "contactInformation": {
      "country": "DE",
      "city": "Delbrück",
      "mobileNumber": 495555555555,
      "postalCode": 33129,
      "houseNumber": "24A",
      "addressLine1": "Boikweg 24",
      "addressLine2": "c/o Acme",
      "addressLine3": "first floor",
      "landLine": 495555555555,
      "state": "Dortmund",
      "email": "testEmail@example.com",
      "additionalContactInformation": [
        {
          "email": "testEmail@example.com"
        }
      ]
    }
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseClaim	false	none	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» primaryDebtor	Debtor	true	none	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

ClaimScore

{
  "type": "INTERNAL",
  "value": "risky",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
}

An Claim Score is a score that is calculated for a specific claim.

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	Type of score
value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	The score's value

xor

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	composed value

xor

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	No value

continued

Name	Type	Required	Restrictions	Description
meta	Metadata	false	none	Additional information related to the entity.

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL

AccountScore

{
  "type": "INTERNAL",
  "value": "risky",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
}

An account score is a score that is calculated for a specific account. It can be used to determine the risk of a debtor or any other information that is relevant for the account.

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	Type of score
value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	The score's value

xor

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	composed value

xor

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	No value

continued

Name	Type	Required	Restrictions	Description
meta	Metadata	false	none	Additional information related to the entity.

Enumerated Values

Property	Value
type	INTERNAL
type	EXTERNAL
type	COLLECTION
type	BEHAVIORAL

LedgerEntry

"{\n    \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n    \"invoiceDetails\": {\n        \"amount\": 100000,\n        \"dueDate\": \"2022-01-08\",\n        \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n    },\n    \"context\": {\n        \"productReference\": \"PRODUCT_REFERENCE_1\"\n    }\n}\n"

A Ledger Entry is a record of a transaction in the Ledger.

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	FeeLedgerEntry	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	InvoiceLedgerEntry	false	none	An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.

xor

Name	Type	Required	Restrictions	Description
anonymous	PaymentLedgerEntry	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	AdjustmentLedgerEntry	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	ChargebackLedgerEntry	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	DiscountLedgerEntry	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	ReportingLedgerEntry	false	none	none

InvoiceLedgerEntry

{
  "ledgerEntryReference": "INVOICE_LEDGER_ENTRY_REFERENCE_002",
  "invoiceDetails": {
    "amount": 13025,
    "createdAt": 1621536535901,
    "dueDate": "2019-06-28",
    "paymentReference": "paymentReference1",
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
  },
  "context": {
    "productReference": "PRODUCT_REFERENCE_1",
    "externalDebtorReference": "EXTERNAL_DEBTOR_REF_002"
  }
}

An Invoice Ledger Entry is a type of Ledger Entry that represents a claim in the system.

Properties

Name	Type	Required	Restrictions	Description
ledgerEntryReference	LedgerEntryReference	true	none	Reference of the Ledger Entry (unique per Account)
invoiceDetails	object	true	none	none
» amount	Amount	true	none	Monetary value in cents (natural nuumber)
» createdAt	LedgerEntryCreatedAt	false	none	Timestamp when the ledger entry was created in milliseconds
» dueDate	DueDate	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
» meta	Metadata	false	none	Additional information related to the entity.
context	object	true	none	Describes the specific context of the Ledger Entry
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
» externalDebtorReference	DebtorReference	false	none	Your customer ID for this person or company

FeeLedgerEntry

{
  "ledgerEntryReference": "string",
  "feeDetails": {
    "type": "COLLECTION_FEE",
    "amount": 13025,
    "createdAt": 1621536535901,
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
  },
  "context": {
    "productReference": "PRODUCT_REFERENCE_1",
    "ledgerEntryReference": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
ledgerEntryReference	string	true	none	Reference of the Fee Ledger Entry
feeDetails	object	true	none	none
» type	string	false	none	Type of fee
» amount	Amount	true	none	Monetary value in cents (natural nuumber)
» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
» meta	Metadata	false	none	Additional information related to the entity.
context	object	true	none	Describes the specific context of the entry
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
» ledgerEntryReference	string	false	none	Relationship of the fee with another ledger entry

PaymentLedgerEntry

{
  "ledgerEntryReference": "string",
  "paymentDetails": {
    "amount": 13025,
    "paymentReference": "paymentReference1",
    "createdAt": 1621536535901,
    "paymentProvider": "string",
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
  },
  "context": {
    "productReference": "PRODUCT_REFERENCE_1",
    "ledgerEntryReference": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
ledgerEntryReference	string	true	none	Reference of the Payment Ledger Entry
paymentDetails	object	true	none	none
» amount	Amount	true	none	Monetary value in cents (natural nuumber)
» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
» paymentProvider	string	false	none	Name of the provider used for the transaction
» meta	Metadata	false	none	Additional information related to the entity.
context	object	true	none	Describes the specific context of the entry
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

ChargebackLedgerEntry

{
  "ledgerEntryReference": "string",
  "chargebackDetails": {
    "amount": 13025,
    "createdAt": 1621536535901,
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
  },
  "context": {
    "productReference": "PRODUCT_REFERENCE_1",
    "ledgerEntryReference": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
ledgerEntryReference	string	true	none	Reference of the Chargeback Ledger Entry
chargebackDetails	object	true	none	none
» amount	Amount	true	none	Monetary value in cents (natural nuumber)
» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
» meta	Metadata	false	none	Additional information related to the entity.
context	object	true	none	Describes the specific context of the entry
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
» ledgerEntryReference	string	true	none	Defines the target of the chargeback ledger entry

DiscountLedgerEntry

{
  "ledgerEntryReference": "string",
  "discountDetails": {
    "amount": 13025,
    "createdAt": 1621536535901,
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
  },
  "context": {
    "productReference": "PRODUCT_REFERENCE_1",
    "ledgerEntryReference": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
ledgerEntryReference	string	true	none	Reference of the Discount Ledger Entry
discountDetails	object	true	none	none
» amount	Amount	true	none	Monetary value in cents (natural nuumber)
» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
» meta	Metadata	false	none	Additional information related to the entity.
context	object	true	none	Describes the specific context of the entry
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
» ledgerEntryReference	string	true	none	Defines the target of the discount ledger entry

AdjustmentLedgerEntry

{
  "ledgerEntryReference": "string",
  "adjustmentDetails": {
    "reason": "INVALID",
    "amount": -13025,
    "dueDate": "2019-06-28",
    "createdAt": 1621536535901,
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
  },
  "context": {
    "productReference": "PRODUCT_REFERENCE_1",
    "ledgerEntryReference": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
ledgerEntryReference	string	true	none	Reference of the Adjustment Ledger Entry
adjustmentDetails	object	true	none	none
» reason	string	false	none	Reason for the adjustment
» amount	RelativeAmount	true	none	Monetary value in cents (positive or negative number)
» dueDate	DueDate	false	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
» meta	Metadata	false	none	Additional information related to the entity.
context	object	true	none	Describes the specific context of the entry
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
» ledgerEntryReference	string	false	none	Defines the target of the payment ledger entry

ReportingLedgerEntry

{
  "ledgerEntryReference": "string",
  "reportingDetails": {
    "amount": 13025,
    "createdAt": 1621536535901,
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
  },
  "context": {
    "productReference": "PRODUCT_REFERENCE_1"
  }
}

Properties

Name	Type	Required	Restrictions	Description
ledgerEntryReference	string	true	none	Reference of the Reporting Ledger Entry
reportingDetails	object	true	none	none
» amount	Amount	true	none	Monetary value in cents (natural nuumber)
» createdAt	integer	false	none	Timestamp when the ledger entry was created in milliseconds
» meta	Metadata	false	none	Additional information related to the entity.
context	object	true	none	Describes the specific context of the entry
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.

PromiseToPay

{
  "amount": 13025,
  "currency": "EUR",
  "dueDate": "2019-06-28"
}

A promise to pay is a commitment from a debtor to pay a certain amount at a certain date.

Properties

Name	Type	Required	Restrictions	Description
amount	Amount	true	none	Monetary value in cents (natural nuumber)
currency	Currency	true	none	3-digit currency code (ISO 4217)
dueDate	DueDate	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

AccountMandate

{
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "providerName": "trustly",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "productReferences": [
    "PRODUCT_REFERENCE_1"
  ],
  "mandateRepresentation": {
    "holderName": "string",
    "bankName": "string",
    "accountNumber": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
mandateId	string	true	none	mandate id (can be the mandate id of external system)
accountReference	AccountReference	true	none	Account reference in your system
providerName	string	true	none	Name of payment provider
debtorReference	DebtorReference	false	none	Your customer ID for this person or company
productReferences	[ProductReference]	false	none	Product References
mandateRepresentation	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	MandateAccountTypeRepresentation	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	MandateCardTypeRepresentation	false	none	none

MandateCardTypeRepresentation

{
  "cardIssuer": "VISA",
  "lastDigits": "1404",
  "holderName": "string",
  "expiryMonth": 5,
  "expiryYear": 2023,
  "bankName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
cardIssuer	string	true	none	none
lastDigits	string	true	none	none
holderName	string	false	none	none
expiryMonth	string	false	none	none
expiryYear	string	false	none	none
bankName	string	false	none	none

MandateAccountTypeRepresentation

{
  "holderName": "string",
  "bankName": "string",
  "accountNumber": "string"
}

Properties

Name	Type	Required	Restrictions	Description
holderName	string	false	none	none
bankName	string	true	none	none
accountNumber	string	true	none	none

CreateAccountInput

"{\n    \"currency\": \"EUR\",\n    \"paymentReference\": \"paymentReference1\",\n    \"meta\": {\n        \"invoiceExternalNumber\": 111\n    },\n    \"scores\": [\n        {\n            \"type\": \"INTERNAL\",\n            \"value\": \"V1\"\n        }\n    ],\n    \"debtors\": [\n        {\n            \"lastName\": \"LAST_NAME_1\",\n            \"firstName\": \"FIRST_NAME_1\",\n            \"debtorReference\": \"EXTERNAL_DEBTOR_REF_001\",\n            \"contactInformation\": {\n                \"country\": \"DE\",\n                \"email\": \"first.last@acme.com\"\n            }\n        }\n    ],\n    \"products\": [\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_1\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_1\"\n        },\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_2\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_2\"\n        }\n    ],\n    \"ledgerEntries\": [\n        {\n            \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n            \"invoiceDetails\": {\n                \"amount\": 100000,\n                \"dueDate\": \"2022-01-08\",\n                \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n            },\n            \"context\": {\n                \"productReference\": \"PRODUCT_REFERENCE_1\"\n            }\n        }\n    ]\n}\n"

Input for create_account endpoint.

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	Account	false	none	A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an Account.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» currency	Currency	true	none	3-digit currency code (ISO 4217)

UpdateClaimOptions

{
  "options": {
    "forceAmountCheck": false
  }
}

Additional modifiers when updating claims

Properties

Name	Type	Required	Restrictions	Description
options	object	false	none	none
» forceAmountCheck	boolean	false	none	Let the claim status the same, regardless of the changes in the amount

CreateClaimInput

{
  "amount": 13025,
  "currency": "EUR",
  "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
  "productReference": "PRODUCT_REFERENCE_1",
  "creditorReference": "string",
  "totalFees": 13025,
  "currentDueDate": "2019-06-28",
  "originalDueDate": "2019-06-28",
  "scores": [
    {
      "type": "INTERNAL",
      "value": "risky",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ],
  "reason": "string",
  "paymentReference": "paymentReference1",
  "accountNumber": "string",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
  "fees": [
    {
      "name": "Interest",
      "amount": 13025
    }
  ],
  "primaryDebtor": {
    "birthday": "1980-06-28",
    "gender": "M",
    "firstName": "John",
    "lastName": "White",
    "middleName": "Benedict",
    "title": "Doctor",
    "companyName": "Acme Brick Co.",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "SSN": "AAA-GG-SSSS",
    "type": "natural",
    "contactInformation": {
      "country": "DE",
      "city": "Delbrück",
      "mobileNumber": 495555555555,
      "postalCode": 33129,
      "houseNumber": "24A",
      "addressLine1": "Boikweg 24",
      "addressLine2": "c/o Acme",
      "addressLine3": "first floor",
      "landLine": 495555555555,
      "state": "Dortmund",
      "email": "testEmail@example.com",
      "additionalContactInformation": [
        {
          "email": "testEmail@example.com"
        }
      ]
    }
  }
}

Input for create_claims endpoint.

Properties

None

UpdateClaimInput

{
  "amount": 13025,
  "currency": "EUR",
  "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
  "productReference": "PRODUCT_REFERENCE_1",
  "creditorReference": "string",
  "totalFees": 13025,
  "currentDueDate": "2019-06-28",
  "originalDueDate": "2019-06-28",
  "scores": [
    {
      "type": "INTERNAL",
      "value": "risky",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ],
  "reason": "string",
  "paymentReference": "paymentReference1",
  "accountNumber": "string",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
  "fees": [
    {
      "name": "Interest",
      "amount": 13025
    }
  ],
  "primaryDebtor": {
    "birthday": "1980-06-28",
    "gender": "M",
    "firstName": "John",
    "lastName": "White",
    "middleName": "Benedict",
    "title": "Doctor",
    "companyName": "Acme Brick Co.",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "SSN": "AAA-GG-SSSS",
    "type": "natural",
    "contactInformation": {
      "country": "DE",
      "city": "Delbrück",
      "mobileNumber": 495555555555,
      "postalCode": 33129,
      "houseNumber": "24A",
      "addressLine1": "Boikweg 24",
      "addressLine2": "c/o Acme",
      "addressLine3": "first floor",
      "landLine": 495555555555,
      "state": "Dortmund",
      "email": "testEmail@example.com",
      "additionalContactInformation": [
        {
          "email": "testEmail@example.com"
        }
      ]
    }
  },
  "options": {
    "forceAmountCheck": false
  }
}

Input for update_claims endpoint.

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseClaim	false	none	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.

and

Name	Type	Required	Restrictions	Description
anonymous	UpdateClaimOptions	false	none	Additional modifiers when updating claims

ImportClaimInput

{
  "amount": 13025,
  "currency": "EUR",
  "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
  "productReference": "PRODUCT_REFERENCE_1",
  "creditorReference": "string",
  "totalFees": 13025,
  "currentDueDate": "2019-06-28",
  "originalDueDate": "2019-06-28",
  "scores": [
    {
      "type": "INTERNAL",
      "value": "risky",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ],
  "reason": "string",
  "paymentReference": "paymentReference1",
  "accountNumber": "string",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
  "fees": [
    {
      "name": "Interest",
      "amount": 13025
    }
  ],
  "primaryDebtor": {
    "birthday": "1980-06-28",
    "gender": "M",
    "firstName": "John",
    "lastName": "White",
    "middleName": "Benedict",
    "title": "Doctor",
    "companyName": "Acme Brick Co.",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "SSN": "AAA-GG-SSSS",
    "type": "natural",
    "contactInformation": {
      "country": "DE",
      "city": "Delbrück",
      "mobileNumber": 495555555555,
      "postalCode": 33129,
      "houseNumber": "24A",
      "addressLine1": "Boikweg 24",
      "addressLine2": "c/o Acme",
      "addressLine3": "first floor",
      "landLine": 495555555555,
      "state": "Dortmund",
      "email": "testEmail@example.com",
      "additionalContactInformation": [
        {
          "email": "testEmail@example.com"
        }
      ]
    }
  },
  "options": {
    "forceAmountCheck": false
  }
}

Input for update_claims endpoint.

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ClaimInput	false	none	Used when creating or importing claims

and

Name	Type	Required	Restrictions	Description
anonymous	UpdateClaimOptions	false	none	Additional modifiers when updating claims

ClaimInput

{
  "amount": 13025,
  "currency": "EUR",
  "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
  "productReference": "PRODUCT_REFERENCE_1",
  "creditorReference": "string",
  "totalFees": 13025,
  "currentDueDate": "2019-06-28",
  "originalDueDate": "2019-06-28",
  "scores": [
    {
      "type": "INTERNAL",
      "value": "risky",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ],
  "reason": "string",
  "paymentReference": "paymentReference1",
  "accountNumber": "string",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
  "fees": [
    {
      "name": "Interest",
      "amount": 13025
    }
  ],
  "primaryDebtor": {
    "birthday": "1980-06-28",
    "gender": "M",
    "firstName": "John",
    "lastName": "White",
    "middleName": "Benedict",
    "title": "Doctor",
    "companyName": "Acme Brick Co.",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "SSN": "AAA-GG-SSSS",
    "type": "natural",
    "contactInformation": {
      "country": "DE",
      "city": "Delbrück",
      "mobileNumber": 495555555555,
      "postalCode": 33129,
      "houseNumber": "24A",
      "addressLine1": "Boikweg 24",
      "addressLine2": "c/o Acme",
      "addressLine3": "first floor",
      "landLine": 495555555555,
      "state": "Dortmund",
      "email": "testEmail@example.com",
      "additionalContactInformation": [
        {
          "email": "testEmail@example.com"
        }
      ]
    }
  }
}

Used when creating or importing claims

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseClaim	false	none	A claim is an outstanding payment that is owed. You can always update this balance if multiple payments are missed and you want to aggregate the amounts.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» originalDueDate	OriginalDueDate	true	none	Original due date in your system. This is the day when it went past due. DPD 0.
» currentDueDate	DueDate	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

and

Name	Type	Required	Restrictions	Description
anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	The `accountReference` is optional, but `primaryDebtor` and `currency` are required
»» primaryDebtor	Debtor	true	none	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	The `primaryDebtor` and the `currency` of the `Account` is used if not specified in the `Claim`

UpdateAccountLedgerEntriesAmountsInput

{
  "accountReference": "ACCOUNT_REFERENCE_002",
  "ledgerEntries": [
    {
      "ledgerEntryReference": "string",
      "amount": 13025,
      "reason": "INVALID",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ]
}

Input for update_account_ledger_entries_amounts endpoint.

Properties

Name	Type	Required	Restrictions	Description
accountReference	AccountReference	true	none	Account reference in your system
ledgerEntries	[object]	true	none	none
» ledgerEntryReference	string	true	none	Reference of the Ledger Entry (Invoice or Fee)
» amount	integer	true	none	Amount in cents
» reason	string	true	none	Reason for the adjustment
» meta	Metadata	true	none	Additional information related to the entity.

MatchAccountPaymentInput

{
  "providerName": "trustly",
  "trackingId": 3889445415,
  "totalAmount": 13025,
  "currency": "EUR",
  "paymentReference": "paymentReference1",
  "meta": {},
  "context": {
    "productReference": "PRODUCT_REFERENCE_1",
    "feeLedgerEntriesOrder": [
      "string"
    ]
  },
  "matchStrategy": "ORDERED_LEDGER_ENTRIES"
}

Input for match_account_payment endpoint.

Properties

Name	Type	Required	Restrictions	Description
providerName	string	false	none	Name of payment provider
trackingId	string	false	none	This is the orderID or other identifier from the payment provider
totalAmount	Amount	true	none	Monetary value in cents (natural nuumber)
currency	Currency	true	none	3-digit currency code (ISO 4217)
paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
meta	object	false	none	Additional information related to the transaction
context	object	false	none	Context used to do the matching of the payment
» productReference	ProductReference	false	none	Identifier for a product in your system. It is used for grouping purposes.
» feeLedgerEntriesOrder	[string]	false	none	Order of fee ledger entry types used for the payment priority (only for CUSTOM_ORDERED_FEES, ignored otherwise)
matchStrategy	string	true	none	none

Enumerated Values

Property	Value
matchStrategy	ORDERED_LEDGER_ENTRIES
matchStrategy	ORDERED_INVOICES_WITH_FEES_THEN_ACCOUNT_ENTRIES
matchStrategy	ACCOUNT_ENTRIES_THEN_ORDERED_INVOICES_WITH_FEES
matchStrategy	CUSTOM_ORDERED_FEES

AccountMandateDeleteInput

{
  "accountReference": "ACCOUNT_REFERENCE_002",
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34"
}

Input for delete_account_mandates endpoint.

Properties

Name	Type	Required	Restrictions	Description
accountReference	AccountReference	true	none	Account reference in your system
mandateId	string	true	none	mandate id (can be the mandate id of external system)

BaseAccountMandateInput

{
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "providerName": "trustly",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "productReferences": [
    "PRODUCT_REFERENCE_1"
  ],
  "mandateRepresentation": {
    "holderName": "string",
    "bankName": "string",
    "accountNumber": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
mandateId	string	true	none	mandate id (can be the mandate id of external system)
accountReference	AccountReference	true	none	Account reference in your system
providerName	string	true	none	Name of payment provider
debtorReference	DebtorReference	true	none	Your customer ID for this person or company
productReferences	[ProductReference]	true	none	Product References
mandateRepresentation	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	MandateAccountTypeRepresentation	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	MandateCardTypeRepresentation	false	none	none

PaylandsAccountMandateInput

{
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "providerName": "paylandsenBizum",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "productReferences": [
    "PRODUCT_REFERENCE_1"
  ],
  "mandateRepresentation": {
    "holderName": "string",
    "bankName": "string",
    "accountNumber": "string"
  },
  "clientIpAddress": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseAccountMandateInput	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» providerName	string	true	none	none
» clientIpAddress	string	true	none	The customer ip address is needed for Paylands mandate to work

Enumerated Values

Property	Value
providerName	paylandsenBizum
providerName	paylandsenCards

SplitAccountMandateInput

{
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "providerName": "split",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "productReferences": [
    "PRODUCT_REFERENCE_1"
  ],
  "mandateRepresentation": {
    "holderName": "string",
    "bankName": "string",
    "accountNumber": "string"
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseAccountMandateInput	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» providerName	string	true	none	none

Enumerated Values

Property	Value
providerName	split

TrustlyAccountMandateInput

{
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "providerName": "trustly",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "productReferences": [
    "PRODUCT_REFERENCE_1"
  ],
  "mandateRepresentation": {
    "holderName": "string",
    "bankName": "string",
    "accountNumber": "string"
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseAccountMandateInput	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» providerName	string	true	none	none

Enumerated Values

Property	Value
providerName	trustly

FerratumV2AccountMandateInput

{
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "providerName": "ferratumCheckoutCreditCardV2",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "productReferences": [
    "PRODUCT_REFERENCE_1"
  ],
  "mandateRepresentation": {
    "holderName": "string",
    "bankName": "string",
    "accountNumber": "string"
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseAccountMandateInput	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» providerName	string	true	none	none

Enumerated Values

Property	Value
providerName	ferratumCheckoutCreditCardV2

AccountMandateInput

{
  "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "providerName": "ferratumCheckoutCreditCardV2",
  "debtorReference": "EXTERNAL_DEBTOR_REF_002",
  "productReferences": [
    "PRODUCT_REFERENCE_1"
  ],
  "mandateRepresentation": {
    "holderName": "string",
    "bankName": "string",
    "accountNumber": "string"
  }
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	FerratumV2AccountMandateInput	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	PaylandsAccountMandateInput	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	SplitAccountMandateInput	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	TrustlyAccountMandateInput	false	none	none

ActionResponse

"{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"

Response of any action that causes any side effect in the platform (e.g. create, update, delete)

Properties

Name	Type	Required	Restrictions	Description
success	boolean	true	none	Status of the action
messages	[string]	true	none	none
messageIds	[string]	true	none	Identifier of the messages (used for tracing)

DataResponse

"{\n    \"success\": true,\n    \"messages\": [\n        \"Successfully processed action\"\n    ],\n    \"messageIds\": [\n        \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n    ],\n    \"data\": [\n        {\n            \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n        }\n    ]\n}\n"

Response of any action that returns data

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	Debtor	false	none	The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	Product	false	none	A product is a service or item used to give context to the Claim or Ledger Entry

xor

Name	Type	Required	Restrictions	Description
»» anonymous	LedgerEntry	false	none	A Ledger Entry is a record of a transaction in the Ledger.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	AccountScore	false	none	An account score is a score that is calculated for a specific account. It can be used to determine the risk of a debtor or any other information that is relevant for the account.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	AccountMandateInput	false	none	none

xor

Name	Type	Required	Restrictions	Description
»» anonymous	UpdateAccountLedgerEntriesAmountsInput	false	none	Input for update_account_ledger_entries_amounts endpoint.

DebtorResponse

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": [
    {
      "birthday": "1980-06-28",
      "gender": "M",
      "firstName": "John",
      "lastName": "White",
      "middleName": "Benedict",
      "title": "Doctor",
      "companyName": "Acme Brick Co.",
      "debtorReference": "EXTERNAL_DEBTOR_REF_002",
      "SSN": "AAA-GG-SSSS",
      "type": "natural",
      "contactInformation": {
        "country": "DE",
        "city": "Delbrück",
        "mobileNumber": 495555555555,
        "postalCode": 33129,
        "houseNumber": "24A",
        "addressLine1": "Boikweg 24",
        "addressLine2": "c/o Acme",
        "addressLine3": "first floor",
        "landLine": 495555555555,
        "state": "Dortmund",
        "email": "testEmail@example.com",
        "additionalContactInformation": [
          {
            "email": "testEmail@example.com"
          }
        ]
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[Debtor]	false	none	[The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required. ]

AccountMetaResponse

"{\n    \"data\": {\n        \"updateAccountMeta002\": \"updateAccountMetaValue002\"\n    },\n    \"success\": true,\n    \"messageIds\": [\n        \"55d2c314-a91e-4f9c-b80e-5ba524777ae1\"\n    ],\n    \"messages\": [\n        \"Successfully updated Account meta ACCOUNT_REFERENCE_002\"\n    ]\n}\n"

Response of the update_account_meta endpoint.

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	Metadata	false	none	Additional information related to the entity.

CreateClaims

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": {
    "amount": 13025,
    "currency": "EUR",
    "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
    "productReference": "PRODUCT_REFERENCE_1",
    "creditorReference": "string",
    "totalFees": 13025,
    "currentDueDate": "2019-06-28",
    "originalDueDate": "2019-06-28",
    "scores": [
      {
        "type": "INTERNAL",
        "value": "risky",
        "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
      }
    ],
    "reason": "string",
    "paymentReference": "paymentReference1",
    "accountNumber": "string",
    "accountReference": "ACCOUNT_REFERENCE_002",
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
    "fees": [
      {
        "name": "Interest",
        "amount": 13025
      }
    ],
    "primaryDebtor": {
      "birthday": "1980-06-28",
      "gender": "M",
      "firstName": "John",
      "lastName": "White",
      "middleName": "Benedict",
      "title": "Doctor",
      "companyName": "Acme Brick Co.",
      "debtorReference": "EXTERNAL_DEBTOR_REF_002",
      "SSN": "AAA-GG-SSSS",
      "type": "natural",
      "contactInformation": {
        "country": "DE",
        "city": "Delbrück",
        "mobileNumber": 495555555555,
        "postalCode": 33129,
        "houseNumber": "24A",
        "addressLine1": "Boikweg 24",
        "addressLine2": "c/o Acme",
        "addressLine3": "first floor",
        "landLine": 495555555555,
        "state": "Dortmund",
        "email": "testEmail@example.com",
        "additionalContactInformation": [
          {
            "email": "testEmail@example.com"
          }
        ]
      }
    }
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	ClaimInput	false	none	Used when creating or importing claims

RecreateClaims

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": {
    "amount": 13025,
    "currency": "EUR",
    "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
    "productReference": "PRODUCT_REFERENCE_1",
    "creditorReference": "string",
    "totalFees": 13025,
    "currentDueDate": "2019-06-28",
    "originalDueDate": "2019-06-28",
    "scores": [
      {
        "type": "INTERNAL",
        "value": "risky",
        "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
      }
    ],
    "reason": "string",
    "paymentReference": "paymentReference1",
    "accountNumber": "string",
    "accountReference": "ACCOUNT_REFERENCE_002",
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
    "fees": [
      {
        "name": "Interest",
        "amount": 13025
      }
    ],
    "primaryDebtor": {
      "birthday": "1980-06-28",
      "gender": "M",
      "firstName": "John",
      "lastName": "White",
      "middleName": "Benedict",
      "title": "Doctor",
      "companyName": "Acme Brick Co.",
      "debtorReference": "EXTERNAL_DEBTOR_REF_002",
      "SSN": "AAA-GG-SSSS",
      "type": "natural",
      "contactInformation": {
        "country": "DE",
        "city": "Delbrück",
        "mobileNumber": 495555555555,
        "postalCode": 33129,
        "houseNumber": "24A",
        "addressLine1": "Boikweg 24",
        "addressLine2": "c/o Acme",
        "addressLine3": "first floor",
        "landLine": 495555555555,
        "state": "Dortmund",
        "email": "testEmail@example.com",
        "additionalContactInformation": [
          {
            "email": "testEmail@example.com"
          }
        ]
      }
    }
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	ClaimInput	false	none	Used when creating or importing claims

CreatePromisesToPay

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": {
    "amount": 13025,
    "currency": "EUR",
    "dueDate": "2019-06-28"
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	PromiseToPay	false	none	A promise to pay is a commitment from a debtor to pay a certain amount at a certain date.

CreateAccountMandates

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": [
    {
      "mandateId": "d34b443e-968e-4647-80ec-292ee38c8b34",
      "accountReference": "ACCOUNT_REFERENCE_002",
      "providerName": "ferratumCheckoutCreditCardV2",
      "debtorReference": "EXTERNAL_DEBTOR_REF_002",
      "productReferences": [
        "PRODUCT_REFERENCE_1"
      ],
      "mandateRepresentation": {
        "holderName": "string",
        "bankName": "string",
        "accountNumber": "string"
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[AccountMandateInput]	false	none	none

LedgerEntryResponse

"{\n    \"success\": true,\n    \"data\": [\n        {\n            \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n            \"context\": {},\n            \"invoiceDetails\": {\n                \"amount\": 13025,\n                \"dueDate\": \"2020-01-01\",\n                \"meta\": {}\n            },\n            \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_2\"\n        }\n    ],\n    \"messageIds\": [\n        \"cddddeb1-f352-46f3-a59d-0008a84e9bd5\"\n    ],\n    \"messages\": [\n        \"Successfully added Ledger Entries: INVOICE_LEDGER_ENTRY_REFERENCE_002_2\"\n    ]\n}\n"

Response of any action that adds ledger entries to an account.

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[LedgerEntry]	false	none	[A Ledger Entry is a record of a transaction in the Ledger.]

AccountScoreResponse

"{\n    \"messages\": [\n        \"Successfully set the score of EXTERNAL\"\n    ],\n    \"success\": true,\n    \"data\": [\n        {\n            \"accountReference\": \"ACCOUNT_REFERENCE_002\",\n            \"type\": \"EXTERNAL\",\n            \"value\": \"SCORE1\",\n            \"meta\": {}\n        }\n    ],\n    \"messageIds\": [\n        \"0fdf533f-e453-4b64-9e4a-e1e2a2b81bf4\"\n    ]\n}\n"

Response of the set_account_score endpoint

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[AccountScore]	false	none	[An account score is a score that is calculated for a specific account. It can be used to determine the risk of a debtor or any other information that is relevant for the account.]

CreateAccounts

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": "{\n    \"currency\": \"EUR\",\n    \"paymentReference\": \"paymentReference1\",\n    \"meta\": {\n        \"invoiceExternalNumber\": 111\n    },\n    \"scores\": [\n        {\n            \"type\": \"INTERNAL\",\n            \"value\": \"V1\"\n        }\n    ],\n    \"debtors\": [\n        {\n            \"lastName\": \"LAST_NAME_1\",\n            \"firstName\": \"FIRST_NAME_1\",\n            \"debtorReference\": \"EXTERNAL_DEBTOR_REF_001\",\n            \"contactInformation\": {\n                \"country\": \"DE\",\n                \"email\": \"first.last@acme.com\"\n            }\n        }\n    ],\n    \"products\": [\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_1\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_1\"\n        },\n        {\n            \"productReference\": \"PRODUCT_REFERENCE_2\",\n            \"paymentReference\": \"PRODUCT_PAYMENT_REFERENCE_2\"\n        }\n    ],\n    \"ledgerEntries\": [\n        {\n            \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n            \"invoiceDetails\": {\n                \"amount\": 100000,\n                \"dueDate\": \"2022-01-08\",\n                \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n            },\n            \"context\": {\n                \"productReference\": \"PRODUCT_REFERENCE_1\"\n            }\n        }\n    ]\n}\n"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	Account	false	none	A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an Account.

MatchAccountPayment

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": [
    "{\n    \"ledgerEntryReference\": \"INVOICE_LEDGER_ENTRY_REFERENCE_002_1\",\n    \"invoiceDetails\": {\n        \"amount\": 100000,\n        \"dueDate\": \"2022-01-08\",\n        \"paymentReference\": \"INVOICE_PAYMENT_REFERENCE_1\"\n    },\n    \"context\": {\n        \"productReference\": \"PRODUCT_REFERENCE_1\"\n    }\n}\n"
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[LedgerEntry]	false	none	[A Ledger Entry is a record of a transaction in the Ledger.]

AccountProductResponse

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": [
    {
      "productReference": "PRODUCT_REFERENCE_1",
      "paymentReference": "paymentReference1",
      "type": "Computer",
      "name": "Macbook Pro",
      "code": "111-22222-3333",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[Product]	false	none	[A product is a service or item used to give context to the Claim or Ledger Entry]

ClaimResponse

{
  "amount": 13025,
  "currency": "EUR",
  "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
  "productReference": "PRODUCT_REFERENCE_1",
  "creditorReference": "string",
  "totalFees": 13025,
  "currentDueDate": "2019-06-28",
  "originalDueDate": "2019-06-28",
  "scores": [
    {
      "type": "INTERNAL",
      "value": "risky",
      "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
    }
  ],
  "reason": "string",
  "paymentReference": "paymentReference1",
  "accountNumber": "string",
  "accountReference": "ACCOUNT_REFERENCE_002",
  "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
  "fees": [
    {
      "name": "Interest",
      "amount": 13025
    }
  ],
  "primaryDebtor": {
    "birthday": "1980-06-28",
    "gender": "M",
    "firstName": "John",
    "lastName": "White",
    "middleName": "Benedict",
    "title": "Doctor",
    "companyName": "Acme Brick Co.",
    "debtorReference": "EXTERNAL_DEBTOR_REF_002",
    "SSN": "AAA-GG-SSSS",
    "type": "natural",
    "contactInformation": {
      "country": "DE",
      "city": "Delbrück",
      "mobileNumber": 495555555555,
      "postalCode": 33129,
      "houseNumber": "24A",
      "addressLine1": "Boikweg 24",
      "addressLine2": "c/o Acme",
      "addressLine3": "first floor",
      "landLine": 495555555555,
      "state": "Dortmund",
      "email": "testEmail@example.com",
      "additionalContactInformation": [
        {
          "email": "testEmail@example.com"
        }
      ]
    }
  },
  "claimReference": "string",
  "status": "ACTIVE"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	Claim	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» claimReference	string	true	none	The current claim's reference
» status	string	true	none	none

Enumerated Values

Property	Value
status	ACTIVE
status	RESOLVED

ClaimCreatedEvent

{
  "messageId": "51a35d12-9145-4c97-8285-08156681e47",
  "timestamp": "2020-04-17T08:14:29.863Z",
  "details": {
    "messageType": "event.claim.created.v1",
    "claimRef": "ABCDEF123",
    "receeveClaimRef": "ABCDEF123-2020-01-15",
    "amount": 2000,
    "currency": "EUR",
    "dueDate": "2019-06-28"
  }
}

Properties

Name	Type	Required	Restrictions	Description
messageId	string	true	none	message identifier in Receeve system
timestamp	string	true	none	UTC timestamp
details	object	true	none	none
» messageType	string	true	none	type of event that happened in Receeve system
» claimRef	string	true	none	reference to the Claim in external(your) system
» receeveClaimRef	string	true	none	reference to the Claim in Receeve system
» amount	integer	true	none	Amount of the claim without fees in cents
» currency	Currency	true	none	3-digit currency code (ISO 4217)
» dueDate	DueDate	true	none	Current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.

ClaimDebtPaymentProcessingEvent

{
  "messageId": "51a35d12-9145-4c97-8285-08156681e47",
  "timestamp": "2020-04-17T08:14:29.863Z",
  "details": {
    "messageType": "event.claimDebtPayment.processing.v1",
    "claimRef": "ABCDEF123",
    "receeveClaimRef": "ABCDEF123-2020-01-15",
    "providerName": "Trustly",
    "amount": 2000,
    "currency": "EUR",
    "trackingId": "TRACKINGID123",
    "paymentReference": "paymentReference1"
  }
}

Properties

Name	Type	Required	Restrictions	Description
messageId	string	true	none	message identifier in Receeve system
timestamp	string	true	none	UTC timestamp
details	object	true	none	none
» messageType	string	true	none	type of event that happened in Receeve system
» claimRef	string	true	none	reference to the Claim in external(your) system
» receeveClaimRef	string	true	none	reference to the Claim in Receeve system
» providerName	string	true	none	Name of payment provider
» amount	integer	true	none	Amount of the payment transaction in cents
» currency	Currency	true	none	3-digit currency code (ISO 4217)
» trackingId	string	true	none	Tracking id from payment provider
» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.

UpdateAccountLedgerEntriesAmounts

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": [
    {
      "accountReference": "ACCOUNT_REFERENCE_002",
      "ledgerEntries": [
        {
          "ledgerEntryReference": "string",
          "amount": 13025,
          "reason": "INVALID",
          "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
        }
      ]
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	[UpdateAccountLedgerEntriesAmountsInput]	false	none	[Input for update_account_ledger_entries_amounts endpoint.]

CreditDebitClaimActionResponse

{
  "0": "{",
  "1": "\n",
  "2": " ",
  "3": " ",
  "4": "\"",
  "5": "s",
  "6": "u",
  "7": "c",
  "8": "c",
  "9": "e",
  "10": "s",
  "11": "s",
  "12": "\"",
  "13": ":",
  "14": " ",
  "15": "t",
  "16": "r",
  "17": "u",
  "18": "e",
  "19": ",",
  "20": "\n",
  "21": " ",
  "22": " ",
  "23": "\"",
  "24": "m",
  "25": "e",
  "26": "s",
  "27": "s",
  "28": "a",
  "29": "g",
  "30": "e",
  "31": "s",
  "32": "\"",
  "33": ":",
  "34": " ",
  "35": "[",
  "36": "\n",
  "37": " ",
  "38": " ",
  "39": " ",
  "40": " ",
  "41": " ",
  "42": " ",
  "43": "\"",
  "44": "S",
  "45": "u",
  "46": "c",
  "47": "c",
  "48": "e",
  "49": "s",
  "50": "s",
  "51": "f",
  "52": "u",
  "53": "l",
  "54": "l",
  "55": "y",
  "56": " ",
  "57": "p",
  "58": "r",
  "59": "o",
  "60": "c",
  "61": "e",
  "62": "s",
  "63": "s",
  "64": "e",
  "65": "d",
  "66": " ",
  "67": "a",
  "68": "c",
  "69": "t",
  "70": "i",
  "71": "o",
  "72": "n",
  "73": "\"",
  "74": "\n",
  "75": " ",
  "76": " ",
  "77": "]",
  "78": ",",
  "79": "\n",
  "80": " ",
  "81": " ",
  "82": "\"",
  "83": "m",
  "84": "e",
  "85": "s",
  "86": "s",
  "87": "a",
  "88": "g",
  "89": "e",
  "90": "I",
  "91": "d",
  "92": "s",
  "93": "\"",
  "94": ":",
  "95": " ",
  "96": "[",
  "97": "\n",
  "98": " ",
  "99": " ",
  "100": " ",
  "101": " ",
  "102": " ",
  "103": " ",
  "104": "\"",
  "105": "e",
  "106": "6",
  "107": "6",
  "108": "d",
  "109": "6",
  "110": "2",
  "111": "e",
  "112": "d",
  "113": "-",
  "114": "2",
  "115": "3",
  "116": "3",
  "117": "1",
  "118": "-",
  "119": "4",
  "120": "c",
  "121": "e",
  "122": "d",
  "123": "-",
  "124": "8",
  "125": "c",
  "126": "0",
  "127": "3",
  "128": "-",
  "129": "5",
  "130": "e",
  "131": "7",
  "132": "2",
  "133": "9",
  "134": "e",
  "135": "9",
  "136": "8",
  "137": "4",
  "138": "a",
  "139": "d",
  "140": "c",
  "141": "\"",
  "142": "\n",
  "143": " ",
  "144": " ",
  "145": "]",
  "146": "\n",
  "147": "}",
  "148": "\n",
  "data": {
    "amount": 13025,
    "currency": "EUR",
    "originator": "DCA",
    "date": 1647526514000,
    "descriptionText": "string"
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ActionResponse	false	none	Response of any action that causes any side effect in the platform (e.g. create, update, delete)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data	CreditDebitClaimInput	false	none	none

CreditDebitClaimInput

{
  "amount": 13025,
  "currency": "EUR",
  "originator": "DCA",
  "date": 1647526514000,
  "descriptionText": "string"
}

Properties

Name	Type	Required	Restrictions	Description
amount	Amount	true	none	Monetary value in cents (natural nuumber)
currency	Currency	true	none	3-digit currency code (ISO 4217)
originator	string	true	none	none
date	number	false	none	date of credit/debit (unix timestamp in msec)
descriptionText	string	false	none	some description for credit/debit

Enumerated Values

Property	Value
originator	DCA
originator	CLIENT

CommunicationMessageURL

{
  "communicationType": "email",
  "messageURL": "/Operations/email/Message/3b97bd7a-1c07-44d4-b33f-2250f6419e95.eml",
  "dateTime": 1621536535901,
  "bundleId": "00000000-0000-0000-0000-000000000000",
  "bundleName": "Default Email Template"
}

Properties

Name	Type	Required	Restrictions	Description
communicationType	string	true	none	type of communication that happened in Receeve system
messageURL	string	true	none	URL of the message
dateTime	integer	true	none	Timestamp when the communication event occured
bundleId	string(uuid)	true	none	template id of communication that happened in Receeve system
bundleName	string	true	none	template display name of communication that happened in Receeve system

Enumerated Values

Property	Value
communicationType	email
communicationType	letter
communicationType	SMS

DebtorAccountsAndClaims

[
  {
    "accountReference": "ACCOUNT_REFERENCE_002",
    "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
    "paymentReference": "paymentReference1",
    "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
    "currency": "EUR",
    "claims": [
      {
        "amount": 13025,
        "currency": "EUR",
        "portfolioReference": "EXTERNAL_PORTFOLIO_REFERENCE_002",
        "productReference": "PRODUCT_REFERENCE_1",
        "creditorReference": "string",
        "totalFees": 13025,
        "currentDueDate": "2019-06-28",
        "originalDueDate": "2019-06-28",
        "scores": [
          {
            "type": "INTERNAL",
            "value": "risky",
            "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n"
          }
        ],
        "reason": "string",
        "paymentReference": "paymentReference1",
        "accountNumber": "string",
        "accountReference": "ACCOUNT_REFERENCE_002",
        "meta": "{\n  \"sourceSystem\": \"system1\"\n}\n",
        "fees": [
          {
            "name": "Interest",
            "amount": 13025
          }
        ],
        "primaryDebtor": {
          "birthday": "1980-06-28",
          "gender": "M",
          "firstName": "John",
          "lastName": "White",
          "middleName": "Benedict",
          "title": "Doctor",
          "companyName": "Acme Brick Co.",
          "debtorReference": "EXTERNAL_DEBTOR_REF_002",
          "SSN": "AAA-GG-SSSS",
          "type": "natural",
          "contactInformation": {
            "country": "DE",
            "city": "Delbrück",
            "mobileNumber": 495555555555,
            "postalCode": 33129,
            "houseNumber": "24A",
            "addressLine1": "Boikweg 24",
            "addressLine2": "c/o Acme",
            "addressLine3": "first floor",
            "landLine": 495555555555,
            "state": "Dortmund",
            "email": "testEmail@example.com",
            "additionalContactInformation": [
              {
                "email": "testEmail@example.com"
              }
            ]
          }
        }
      }
    ],
    "debtors": [
      {
        "birthday": "1980-06-28",
        "gender": "M",
        "firstName": "John",
        "lastName": "White",
        "middleName": "Benedict",
        "title": "Doctor",
        "companyName": "Acme Brick Co.",
        "debtorReference": "EXTERNAL_DEBTOR_REF_002",
        "SSN": "AAA-GG-SSSS",
        "type": "natural",
        "contactInformation": {
          "country": "DE",
          "city": "Delbrück",
          "mobileNumber": 495555555555,
          "postalCode": 33129,
          "houseNumber": "24A",
          "addressLine1": "Boikweg 24",
          "addressLine2": "c/o Acme",
          "addressLine3": "first floor",
          "landLine": 495555555555,
          "state": "Dortmund",
          "email": "testEmail@example.com",
          "additionalContactInformation": [
            {
              "email": "testEmail@example.com"
            }
          ]
        }
      }
    ]
  }
]

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» accountReference	AccountReference	true	none	Account reference in your system
» meta	Metadata	false	none	Additional information related to the entity.
» paymentReference	PaymentReference	false	none	Payment reference used in online transactions. It is a text reference that can be used to map the money transactions to other external systems.
» portfolioReference	PortfolioReference	false	none	This is a optional grouping field for reporting purposes.
» currency	Currency	true	none	3-digit currency code (ISO 4217)

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» claims	[Claim]	true	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» debtors	[Debtor]	true	none	[The Debtor is the entity that owes the money. It can be a person (natural) or a company (legal). Notes: - If the debtor is a person (natural), then firstName and lastName are required. - If the debtor is a company (legal), then companyName is required. ]

UploadFilesInput

{}

Properties

Name	Type	Required	Restrictions	Description
file	string(binary)	true	none	The file to upload
accountId	string	true	none	The account id
documentType	string	false	none	Type of the document as specified in the backoffice e.g 'CSV', 'Invoice'
externalClaimRef	string	false	none	External claim reference
productReference	string	false	none	Product reference

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

ActionResponse1

"{\n  \"success\": true,\n  \"messages\": [\n      \"Successfully processed action\"\n  ],\n  \"messageIds\": [\n      \"e66d62ed-2331-4ced-8c03-5e729e984adc\"\n  ]\n}\n"

Response of any action that causes any side effect in the platform (e.g. create, update, delete)

Properties

Name	Type	Required	Restrictions	Description
success	boolean	true	none	Status of the action
messages	[string]	true	none	none
messageIds	[string]	true	none	Identifier of the messages (used for tracing)