Skip to main content
POST
/
customers
/
{customer_id}
/
sepa-mandates
Create a SEPA mandate
curl --request POST \
  --url https://commerce1.on-hellgate.dev/customers/{customer_id}/sepa-mandates \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "bic": "<string>",
  "country_code": "<string>",
  "document": "<string>",
  "iban": "<string>",
  "mandate_name": "<string>",
  "reference": "<string>",
  "sequence_type": "<string>",
  "signed_on": "2023-12-25",
  "address": "<string>",
  "city": "<string>",
  "postal_code": "<string>"
}
'
import requests

url = "https://commerce1.on-hellgate.dev/customers/{customer_id}/sepa-mandates"

payload = {
    "bic": "<string>",
    "country_code": "<string>",
    "document": "<string>",
    "iban": "<string>",
    "mandate_name": "<string>",
    "reference": "<string>",
    "sequence_type": "<string>",
    "signed_on": "2023-12-25",
    "address": "<string>",
    "city": "<string>",
    "postal_code": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bic: '<string>',
    country_code: '<string>',
    document: '<string>',
    iban: '<string>',
    mandate_name: '<string>',
    reference: '<string>',
    sequence_type: '<string>',
    signed_on: '2023-12-25',
    address: '<string>',
    city: '<string>',
    postal_code: '<string>'
  })
};

fetch('https://commerce1.on-hellgate.dev/customers/{customer_id}/sepa-mandates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://commerce1.on-hellgate.dev/customers/{customer_id}/sepa-mandates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bic' => '<string>',
    'country_code' => '<string>',
    'document' => '<string>',
    'iban' => '<string>',
    'mandate_name' => '<string>',
    'reference' => '<string>',
    'sequence_type' => '<string>',
    'signed_on' => '2023-12-25',
    'address' => '<string>',
    'city' => '<string>',
    'postal_code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://commerce1.on-hellgate.dev/customers/{customer_id}/sepa-mandates"

	payload := strings.NewReader("{\n  \"bic\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"document\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"mandate_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"sequence_type\": \"<string>\",\n  \"signed_on\": \"2023-12-25\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"postal_code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://commerce1.on-hellgate.dev/customers/{customer_id}/sepa-mandates")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bic\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"document\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"mandate_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"sequence_type\": \"<string>\",\n  \"signed_on\": \"2023-12-25\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"postal_code\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://commerce1.on-hellgate.dev/customers/{customer_id}/sepa-mandates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bic\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"document\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"mandate_name\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"sequence_type\": \"<string>\",\n  \"signed_on\": \"2023-12-25\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"postal_code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "address": "<string>",
  "bic": "<string>",
  "city": "<string>",
  "country_code": "<string>",
  "iban": "<string>",
  "mandate_name": "<string>",
  "method": "<string>",
  "postal_code": "<string>",
  "reference": "<string>",
  "sequence_type": "<string>",
  "signed_on": "<string>",
  "status": "<string>",
  "token": "<string>"
}
{
  "classifier": "<string>",
  "code": 123,
  "message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Headers

X-Account-ID
string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

Path Parameters

customer_id
string
required

Customer ID

Body

application/json

Body

bic
string
required
country_code
string
required
document
string
required
iban
string
required
mandate_name
string
required
method
enum<string>
required
Available options:
CORE,
B2B
reference
string
required
sequence_type
string
required
signed_on
string<date>
required
address
string
city
string
postal_code
string

Response

Success

address
string
bic
string
city
string
country_code
string
iban
string
mandate_name
string
method
string
postal_code
string
reference
string
sequence_type
string
signed_on
string
status
string
token
string