Create payment
curl --request POST \
--url https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 123,
"creditor": {
"iban": "<string>",
"id": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
}
},
"currencyIsoCode": "<string>",
"debtor": {
"iban": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bic": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
}
},
"mandateInformation": {
"dateOfSignature": "2023-12-25",
"id": "<string>",
"amendmentInformation": {
"creditorCode": "<string>",
"debtorIban": "<string>",
"originalMandateId": "<string>"
},
"eSignature": "<string>"
},
"settlementDate": "2023-12-25",
"endToEndId": "<string>",
"metadata": [
"billing-run-2026-07"
],
"purpose": {
"information": "<string>",
"structured": {
"issuer": "<string>",
"reference": "<string>"
},
"unstructured": "<string>"
},
"ultimateCreditor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
}
},
"ultimateDebtor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
}
}
}
'import requests
url = "https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment"
payload = {
"amount": 123,
"creditor": {
"iban": "<string>",
"id": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
}
},
"currencyIsoCode": "<string>",
"debtor": {
"iban": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bic": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
}
},
"mandateInformation": {
"dateOfSignature": "2023-12-25",
"id": "<string>",
"amendmentInformation": {
"creditorCode": "<string>",
"debtorIban": "<string>",
"originalMandateId": "<string>"
},
"eSignature": "<string>"
},
"settlementDate": "2023-12-25",
"endToEndId": "<string>",
"metadata": ["billing-run-2026-07"],
"purpose": {
"information": "<string>",
"structured": {
"issuer": "<string>",
"reference": "<string>"
},
"unstructured": "<string>"
},
"ultimateCreditor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
}
},
"ultimateDebtor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
}
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Idempotency-Key': '<idempotency-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
creditor: {
iban: '<string>',
id: '<string>',
name: '<string>',
address: {
addressLine: '<string>',
buildingName: '<string>',
buildingNumber: '<string>',
country: '<string>',
countrySubDivision: '<string>',
department: '<string>',
districtName: '<string>',
floor: '<string>',
postBox: '<string>',
postCode: '<string>',
room: '<string>',
streetName: '<string>',
subDepartment: '<string>',
townLocationName: '<string>',
townName: '<string>'
}
},
currencyIsoCode: '<string>',
debtor: {
iban: '<string>',
name: '<string>',
address: {
addressLine: '<string>',
buildingName: '<string>',
buildingNumber: '<string>',
country: '<string>',
countrySubDivision: '<string>',
department: '<string>',
districtName: '<string>',
floor: '<string>',
postBox: '<string>',
postCode: '<string>',
room: '<string>',
streetName: '<string>',
subDepartment: '<string>',
townLocationName: '<string>',
townName: '<string>'
},
bic: '<string>',
organisationIdentification: {
bic: '<string>',
lei: '<string>',
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
},
privateIdentification: {
birthInformation: {
city: '<string>',
country: '<string>',
date: '2023-12-25',
province: '<string>'
},
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
}
},
mandateInformation: {
dateOfSignature: '2023-12-25',
id: '<string>',
amendmentInformation: {
creditorCode: '<string>',
debtorIban: '<string>',
originalMandateId: '<string>'
},
eSignature: '<string>'
},
settlementDate: '2023-12-25',
endToEndId: '<string>',
metadata: ['billing-run-2026-07'],
purpose: {
information: '<string>',
structured: {issuer: '<string>', reference: '<string>'},
unstructured: '<string>'
},
ultimateCreditor: {
name: '<string>',
organisationIdentification: {
bic: '<string>',
lei: '<string>',
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
},
privateIdentification: {
birthInformation: {
city: '<string>',
country: '<string>',
date: '2023-12-25',
province: '<string>'
},
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
}
},
ultimateDebtor: {
name: '<string>',
organisationIdentification: {
bic: '<string>',
lei: '<string>',
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
},
privateIdentification: {
birthInformation: {
city: '<string>',
country: '<string>',
date: '2023-12-25',
province: '<string>'
},
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
}
}
})
};
fetch('https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment', 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://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment",
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([
'amount' => 123,
'creditor' => [
'iban' => '<string>',
'id' => '<string>',
'name' => '<string>',
'address' => [
'addressLine' => '<string>',
'buildingName' => '<string>',
'buildingNumber' => '<string>',
'country' => '<string>',
'countrySubDivision' => '<string>',
'department' => '<string>',
'districtName' => '<string>',
'floor' => '<string>',
'postBox' => '<string>',
'postCode' => '<string>',
'room' => '<string>',
'streetName' => '<string>',
'subDepartment' => '<string>',
'townLocationName' => '<string>',
'townName' => '<string>'
]
],
'currencyIsoCode' => '<string>',
'debtor' => [
'iban' => '<string>',
'name' => '<string>',
'address' => [
'addressLine' => '<string>',
'buildingName' => '<string>',
'buildingNumber' => '<string>',
'country' => '<string>',
'countrySubDivision' => '<string>',
'department' => '<string>',
'districtName' => '<string>',
'floor' => '<string>',
'postBox' => '<string>',
'postCode' => '<string>',
'room' => '<string>',
'streetName' => '<string>',
'subDepartment' => '<string>',
'townLocationName' => '<string>',
'townName' => '<string>'
],
'bic' => '<string>',
'organisationIdentification' => [
'bic' => '<string>',
'lei' => '<string>',
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
],
'privateIdentification' => [
'birthInformation' => [
'city' => '<string>',
'country' => '<string>',
'date' => '2023-12-25',
'province' => '<string>'
],
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
]
],
'mandateInformation' => [
'dateOfSignature' => '2023-12-25',
'id' => '<string>',
'amendmentInformation' => [
'creditorCode' => '<string>',
'debtorIban' => '<string>',
'originalMandateId' => '<string>'
],
'eSignature' => '<string>'
],
'settlementDate' => '2023-12-25',
'endToEndId' => '<string>',
'metadata' => [
'billing-run-2026-07'
],
'purpose' => [
'information' => '<string>',
'structured' => [
'issuer' => '<string>',
'reference' => '<string>'
],
'unstructured' => '<string>'
],
'ultimateCreditor' => [
'name' => '<string>',
'organisationIdentification' => [
'bic' => '<string>',
'lei' => '<string>',
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
],
'privateIdentification' => [
'birthInformation' => [
'city' => '<string>',
'country' => '<string>',
'date' => '2023-12-25',
'province' => '<string>'
],
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
]
],
'ultimateDebtor' => [
'name' => '<string>',
'organisationIdentification' => [
'bic' => '<string>',
'lei' => '<string>',
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
],
'privateIdentification' => [
'birthInformation' => [
'city' => '<string>',
'country' => '<string>',
'date' => '2023-12-25',
'province' => '<string>'
],
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment"
payload := strings.NewReader("{\n \"amount\": 123,\n \"creditor\": {\n \"iban\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n }\n },\n \"currencyIsoCode\": \"<string>\",\n \"debtor\": {\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n },\n \"bic\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"mandateInformation\": {\n \"dateOfSignature\": \"2023-12-25\",\n \"id\": \"<string>\",\n \"amendmentInformation\": {\n \"creditorCode\": \"<string>\",\n \"debtorIban\": \"<string>\",\n \"originalMandateId\": \"<string>\"\n },\n \"eSignature\": \"<string>\"\n },\n \"settlementDate\": \"2023-12-25\",\n \"endToEndId\": \"<string>\",\n \"metadata\": [\n \"billing-run-2026-07\"\n ],\n \"purpose\": {\n \"information\": \"<string>\",\n \"structured\": {\n \"issuer\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"unstructured\": \"<string>\"\n },\n \"ultimateCreditor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"ultimateDebtor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-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://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"creditor\": {\n \"iban\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n }\n },\n \"currencyIsoCode\": \"<string>\",\n \"debtor\": {\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n },\n \"bic\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"mandateInformation\": {\n \"dateOfSignature\": \"2023-12-25\",\n \"id\": \"<string>\",\n \"amendmentInformation\": {\n \"creditorCode\": \"<string>\",\n \"debtorIban\": \"<string>\",\n \"originalMandateId\": \"<string>\"\n },\n \"eSignature\": \"<string>\"\n },\n \"settlementDate\": \"2023-12-25\",\n \"endToEndId\": \"<string>\",\n \"metadata\": [\n \"billing-run-2026-07\"\n ],\n \"purpose\": {\n \"information\": \"<string>\",\n \"structured\": {\n \"issuer\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"unstructured\": \"<string>\"\n },\n \"ultimateCreditor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"ultimateDebtor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"creditor\": {\n \"iban\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n }\n },\n \"currencyIsoCode\": \"<string>\",\n \"debtor\": {\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n },\n \"bic\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"mandateInformation\": {\n \"dateOfSignature\": \"2023-12-25\",\n \"id\": \"<string>\",\n \"amendmentInformation\": {\n \"creditorCode\": \"<string>\",\n \"debtorIban\": \"<string>\",\n \"originalMandateId\": \"<string>\"\n },\n \"eSignature\": \"<string>\"\n },\n \"settlementDate\": \"2023-12-25\",\n \"endToEndId\": \"<string>\",\n \"metadata\": [\n \"billing-run-2026-07\"\n ],\n \"purpose\": {\n \"information\": \"<string>\",\n \"structured\": {\n \"issuer\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"unstructured\": \"<string>\"\n },\n \"ultimateCreditor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"ultimateDebtor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"amount": 123,
"creditor": {
"id": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bankName": "<string>",
"bic": "<string>",
"iban": "<string>",
"name": "<string>"
},
"currencyIsoCode": "<string>",
"debtor": {
"iban": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bankName": "<string>",
"bic": "<string>",
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
}
},
"endToEndId": "<string>",
"id": 123,
"mandateInformation": {
"amendmentInformation": {
"creditorCode": "<string>",
"debtorIban": "<string>",
"originalMandateId": "<string>"
},
"dateOfSignature": "2023-12-25",
"eSignature": "<string>",
"id": "<string>"
},
"purpose": {
"information": "<string>",
"structured": {
"issuer": "<string>",
"reference": "<string>"
},
"unstructured": "<string>"
},
"sequenceType": "<string>",
"settlementDate": "2023-12-25",
"ultimateCreditor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
}
},
"ultimateDebtor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
}
}
}
}{
"code": "<string>",
"data": {
"errors": [
{
"code": "<string>",
"field_name": "<string>",
"message": "<string>",
"value": "<string>"
}
],
"message": "<string>"
},
"message": "<string>"
}{
"code": "<string>",
"data": {
"errors": [
{
"code": "<string>",
"field_name": "<string>",
"message": "<string>",
"value": "<string>"
}
],
"message": "<string>"
},
"message": "<string>"
}SEPA Direct Debit
Create SEPA Direct Debit payment
Creates a SEPA Direct Debit payment and submits it to the clearing system.
POST
/
v1
/
createSepaDDPayment
Create payment
curl --request POST \
--url https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 123,
"creditor": {
"iban": "<string>",
"id": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
}
},
"currencyIsoCode": "<string>",
"debtor": {
"iban": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bic": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
}
},
"mandateInformation": {
"dateOfSignature": "2023-12-25",
"id": "<string>",
"amendmentInformation": {
"creditorCode": "<string>",
"debtorIban": "<string>",
"originalMandateId": "<string>"
},
"eSignature": "<string>"
},
"settlementDate": "2023-12-25",
"endToEndId": "<string>",
"metadata": [
"billing-run-2026-07"
],
"purpose": {
"information": "<string>",
"structured": {
"issuer": "<string>",
"reference": "<string>"
},
"unstructured": "<string>"
},
"ultimateCreditor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
}
},
"ultimateDebtor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": {
"proprietary": "<string>"
},
"issuer": "<string>"
}
}
}
}
'import requests
url = "https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment"
payload = {
"amount": 123,
"creditor": {
"iban": "<string>",
"id": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
}
},
"currencyIsoCode": "<string>",
"debtor": {
"iban": "<string>",
"name": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bic": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
}
},
"mandateInformation": {
"dateOfSignature": "2023-12-25",
"id": "<string>",
"amendmentInformation": {
"creditorCode": "<string>",
"debtorIban": "<string>",
"originalMandateId": "<string>"
},
"eSignature": "<string>"
},
"settlementDate": "2023-12-25",
"endToEndId": "<string>",
"metadata": ["billing-run-2026-07"],
"purpose": {
"information": "<string>",
"structured": {
"issuer": "<string>",
"reference": "<string>"
},
"unstructured": "<string>"
},
"ultimateCreditor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
}
},
"ultimateDebtor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"scheme": { "proprietary": "<string>" },
"issuer": "<string>"
}
}
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Idempotency-Key': '<idempotency-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
creditor: {
iban: '<string>',
id: '<string>',
name: '<string>',
address: {
addressLine: '<string>',
buildingName: '<string>',
buildingNumber: '<string>',
country: '<string>',
countrySubDivision: '<string>',
department: '<string>',
districtName: '<string>',
floor: '<string>',
postBox: '<string>',
postCode: '<string>',
room: '<string>',
streetName: '<string>',
subDepartment: '<string>',
townLocationName: '<string>',
townName: '<string>'
}
},
currencyIsoCode: '<string>',
debtor: {
iban: '<string>',
name: '<string>',
address: {
addressLine: '<string>',
buildingName: '<string>',
buildingNumber: '<string>',
country: '<string>',
countrySubDivision: '<string>',
department: '<string>',
districtName: '<string>',
floor: '<string>',
postBox: '<string>',
postCode: '<string>',
room: '<string>',
streetName: '<string>',
subDepartment: '<string>',
townLocationName: '<string>',
townName: '<string>'
},
bic: '<string>',
organisationIdentification: {
bic: '<string>',
lei: '<string>',
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
},
privateIdentification: {
birthInformation: {
city: '<string>',
country: '<string>',
date: '2023-12-25',
province: '<string>'
},
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
}
},
mandateInformation: {
dateOfSignature: '2023-12-25',
id: '<string>',
amendmentInformation: {
creditorCode: '<string>',
debtorIban: '<string>',
originalMandateId: '<string>'
},
eSignature: '<string>'
},
settlementDate: '2023-12-25',
endToEndId: '<string>',
metadata: ['billing-run-2026-07'],
purpose: {
information: '<string>',
structured: {issuer: '<string>', reference: '<string>'},
unstructured: '<string>'
},
ultimateCreditor: {
name: '<string>',
organisationIdentification: {
bic: '<string>',
lei: '<string>',
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
},
privateIdentification: {
birthInformation: {
city: '<string>',
country: '<string>',
date: '2023-12-25',
province: '<string>'
},
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
}
},
ultimateDebtor: {
name: '<string>',
organisationIdentification: {
bic: '<string>',
lei: '<string>',
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
},
privateIdentification: {
birthInformation: {
city: '<string>',
country: '<string>',
date: '2023-12-25',
province: '<string>'
},
otherIdentification: {id: '<string>', scheme: {proprietary: '<string>'}, issuer: '<string>'}
}
}
})
};
fetch('https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment', 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://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment",
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([
'amount' => 123,
'creditor' => [
'iban' => '<string>',
'id' => '<string>',
'name' => '<string>',
'address' => [
'addressLine' => '<string>',
'buildingName' => '<string>',
'buildingNumber' => '<string>',
'country' => '<string>',
'countrySubDivision' => '<string>',
'department' => '<string>',
'districtName' => '<string>',
'floor' => '<string>',
'postBox' => '<string>',
'postCode' => '<string>',
'room' => '<string>',
'streetName' => '<string>',
'subDepartment' => '<string>',
'townLocationName' => '<string>',
'townName' => '<string>'
]
],
'currencyIsoCode' => '<string>',
'debtor' => [
'iban' => '<string>',
'name' => '<string>',
'address' => [
'addressLine' => '<string>',
'buildingName' => '<string>',
'buildingNumber' => '<string>',
'country' => '<string>',
'countrySubDivision' => '<string>',
'department' => '<string>',
'districtName' => '<string>',
'floor' => '<string>',
'postBox' => '<string>',
'postCode' => '<string>',
'room' => '<string>',
'streetName' => '<string>',
'subDepartment' => '<string>',
'townLocationName' => '<string>',
'townName' => '<string>'
],
'bic' => '<string>',
'organisationIdentification' => [
'bic' => '<string>',
'lei' => '<string>',
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
],
'privateIdentification' => [
'birthInformation' => [
'city' => '<string>',
'country' => '<string>',
'date' => '2023-12-25',
'province' => '<string>'
],
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
]
],
'mandateInformation' => [
'dateOfSignature' => '2023-12-25',
'id' => '<string>',
'amendmentInformation' => [
'creditorCode' => '<string>',
'debtorIban' => '<string>',
'originalMandateId' => '<string>'
],
'eSignature' => '<string>'
],
'settlementDate' => '2023-12-25',
'endToEndId' => '<string>',
'metadata' => [
'billing-run-2026-07'
],
'purpose' => [
'information' => '<string>',
'structured' => [
'issuer' => '<string>',
'reference' => '<string>'
],
'unstructured' => '<string>'
],
'ultimateCreditor' => [
'name' => '<string>',
'organisationIdentification' => [
'bic' => '<string>',
'lei' => '<string>',
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
],
'privateIdentification' => [
'birthInformation' => [
'city' => '<string>',
'country' => '<string>',
'date' => '2023-12-25',
'province' => '<string>'
],
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
]
],
'ultimateDebtor' => [
'name' => '<string>',
'organisationIdentification' => [
'bic' => '<string>',
'lei' => '<string>',
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
],
'privateIdentification' => [
'birthInformation' => [
'city' => '<string>',
'country' => '<string>',
'date' => '2023-12-25',
'province' => '<string>'
],
'otherIdentification' => [
'id' => '<string>',
'scheme' => [
'proprietary' => '<string>'
],
'issuer' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment"
payload := strings.NewReader("{\n \"amount\": 123,\n \"creditor\": {\n \"iban\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n }\n },\n \"currencyIsoCode\": \"<string>\",\n \"debtor\": {\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n },\n \"bic\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"mandateInformation\": {\n \"dateOfSignature\": \"2023-12-25\",\n \"id\": \"<string>\",\n \"amendmentInformation\": {\n \"creditorCode\": \"<string>\",\n \"debtorIban\": \"<string>\",\n \"originalMandateId\": \"<string>\"\n },\n \"eSignature\": \"<string>\"\n },\n \"settlementDate\": \"2023-12-25\",\n \"endToEndId\": \"<string>\",\n \"metadata\": [\n \"billing-run-2026-07\"\n ],\n \"purpose\": {\n \"information\": \"<string>\",\n \"structured\": {\n \"issuer\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"unstructured\": \"<string>\"\n },\n \"ultimateCreditor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"ultimateDebtor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-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://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"creditor\": {\n \"iban\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n }\n },\n \"currencyIsoCode\": \"<string>\",\n \"debtor\": {\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n },\n \"bic\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"mandateInformation\": {\n \"dateOfSignature\": \"2023-12-25\",\n \"id\": \"<string>\",\n \"amendmentInformation\": {\n \"creditorCode\": \"<string>\",\n \"debtorIban\": \"<string>\",\n \"originalMandateId\": \"<string>\"\n },\n \"eSignature\": \"<string>\"\n },\n \"settlementDate\": \"2023-12-25\",\n \"endToEndId\": \"<string>\",\n \"metadata\": [\n \"billing-run-2026-07\"\n ],\n \"purpose\": {\n \"information\": \"<string>\",\n \"structured\": {\n \"issuer\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"unstructured\": \"<string>\"\n },\n \"ultimateCreditor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"ultimateDebtor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"creditor\": {\n \"iban\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n }\n },\n \"currencyIsoCode\": \"<string>\",\n \"debtor\": {\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"addressLine\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"buildingNumber\": \"<string>\",\n \"country\": \"<string>\",\n \"countrySubDivision\": \"<string>\",\n \"department\": \"<string>\",\n \"districtName\": \"<string>\",\n \"floor\": \"<string>\",\n \"postBox\": \"<string>\",\n \"postCode\": \"<string>\",\n \"room\": \"<string>\",\n \"streetName\": \"<string>\",\n \"subDepartment\": \"<string>\",\n \"townLocationName\": \"<string>\",\n \"townName\": \"<string>\"\n },\n \"bic\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"mandateInformation\": {\n \"dateOfSignature\": \"2023-12-25\",\n \"id\": \"<string>\",\n \"amendmentInformation\": {\n \"creditorCode\": \"<string>\",\n \"debtorIban\": \"<string>\",\n \"originalMandateId\": \"<string>\"\n },\n \"eSignature\": \"<string>\"\n },\n \"settlementDate\": \"2023-12-25\",\n \"endToEndId\": \"<string>\",\n \"metadata\": [\n \"billing-run-2026-07\"\n ],\n \"purpose\": {\n \"information\": \"<string>\",\n \"structured\": {\n \"issuer\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"unstructured\": \"<string>\"\n },\n \"ultimateCreditor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n },\n \"ultimateDebtor\": {\n \"name\": \"<string>\",\n \"organisationIdentification\": {\n \"bic\": \"<string>\",\n \"lei\": \"<string>\",\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n },\n \"privateIdentification\": {\n \"birthInformation\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"province\": \"<string>\"\n },\n \"otherIdentification\": {\n \"id\": \"<string>\",\n \"scheme\": {\n \"proprietary\": \"<string>\"\n },\n \"issuer\": \"<string>\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"amount": 123,
"creditor": {
"id": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bankName": "<string>",
"bic": "<string>",
"iban": "<string>",
"name": "<string>"
},
"currencyIsoCode": "<string>",
"debtor": {
"iban": "<string>",
"address": {
"addressLine": "<string>",
"buildingName": "<string>",
"buildingNumber": "<string>",
"country": "<string>",
"countrySubDivision": "<string>",
"department": "<string>",
"districtName": "<string>",
"floor": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"room": "<string>",
"streetName": "<string>",
"subDepartment": "<string>",
"townLocationName": "<string>",
"townName": "<string>"
},
"bankName": "<string>",
"bic": "<string>",
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
}
},
"endToEndId": "<string>",
"id": 123,
"mandateInformation": {
"amendmentInformation": {
"creditorCode": "<string>",
"debtorIban": "<string>",
"originalMandateId": "<string>"
},
"dateOfSignature": "2023-12-25",
"eSignature": "<string>",
"id": "<string>"
},
"purpose": {
"information": "<string>",
"structured": {
"issuer": "<string>",
"reference": "<string>"
},
"unstructured": "<string>"
},
"sequenceType": "<string>",
"settlementDate": "2023-12-25",
"ultimateCreditor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
}
},
"ultimateDebtor": {
"name": "<string>",
"organisationIdentification": {
"bic": "<string>",
"lei": "<string>",
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
},
"privateIdentification": {
"birthInformation": {
"city": "<string>",
"country": "<string>",
"date": "2023-12-25",
"province": "<string>"
},
"otherIdentification": {
"id": "<string>",
"issuer": "<string>",
"scheme": {
"code": "<string>",
"proprietary": "<string>"
}
}
}
}
}
}{
"code": "<string>",
"data": {
"errors": [
{
"code": "<string>",
"field_name": "<string>",
"message": "<string>",
"value": "<string>"
}
],
"message": "<string>"
},
"message": "<string>"
}{
"code": "<string>",
"data": {
"errors": [
{
"code": "<string>",
"field_name": "<string>",
"message": "<string>",
"value": "<string>"
}
],
"message": "<string>"
},
"message": "<string>"
}Overview
This endpoint creates SEPA Direct Debit payments for collecting funds from customer accounts. The payment is validated and submitted to the clearing system for processing.Settlement Date
ThesettlementDate is the exact day the debtor is charged - the collection settles on that day. You choose it when creating the payment.
You choose settlement date when creating the payment, and collection cannot be the same day you submit the request. It must be at least the next business day (submissions accepted up to 11:15 EEST if settlement day is set for tomorrow) and no more than 14 calendar days ahead.
“Business day” follows the TARGET calendar: weekends plus six fixed holidays (1 January, Good Friday, Easter Monday, 1 May, 25 and 26 December). National holidays that are not TARGET holidays are normal settlement days. The calendar is published years in advance and is not subject to short-notice changes.
Mandate
mandateInformation carries the reference data for the direct-debit mandate agreed between the creditor and the debtor. Holding a valid mandate is the creditor’s responsibility - Inventi does not verify it.
Creditor Identifier
creditor.id carries the SEPA Creditor Identifier (CI) - the scheme-wide identifier of the party collecting the funds. Together with the mandate reference (mandateInformation.id) it uniquely identifies the mandate: the debtor’s bank uses this pair to match every collection against the signed mandate, so both values must match the mandate exactly. Collections with an incorrect CI are returned with reason code BE05 (originator not identified) or MD01 (no valid mandate).
A creditor obtains the CI once, before signing the first mandate, and keeps it permanently - it stays the same even if the creditor later starts collecting through a different payment service provider.
You create the CI yourself - Inventi does not issue or assign Creditor Identifiers. For creditors registered in Lithuania, no application to any authority is needed: the CI is constructed directly from the creditor’s existing registration data:
| Positions | Content |
|---|---|
| 1-2 | ISO country code (LT) |
| 3-4 | Check digits, calculated according to ISO 7064 Mod 97-10 (the same algorithm as for an IBAN) |
| 5-7 | Creditor Business Code - freely chosen by the creditor to distinguish business lines, ZZZ if not used |
| 8-16 | Legal entities: the 9-digit legal entity code issued by the State Enterprise Centre of Registers. Private persons: P followed by a number assigned by the creditor’s payment service provider |
LT11ZZZ123456789
Creditors registered in other SEPA countries receive their CI under their own national rules - in some countries it is issued by the national bank or a business registry rather than the creditor’s payment service provider. See the EPC Creditor Identifier Overview for the country-by-country issuance process and format.Headers
Unique identifier in scope of payment creation endpoints required to prevent unintended duplicate direct debit payments
Body
application/json
Amount in minor currency units
Party on the credit side of the transaction to which the tax applies
Show child attributes
Show child attributes
For SEPA Direct Debit payments, only allowed value is 'EUR'
Party that owes an amount of money to the (ultimate) creditor
Show child attributes
Show child attributes
Provides further details of the direct debit mandate signed between the creditor and the debtor.
Show child attributes
Show child attributes
Identifies the direct debit sequence, such as first, recurrent, final or one-off.
Available options:
FRST, RCUR, FNAL, OOFF Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money
becomes available to the agent to which it is due.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain
Required string length:
1 - 35For linking the payment to your internal records, for example a billing run, order, or customer ID. Set at creation only and cannot be changed afterwards. Stored only in the payment gateway: never forwarded to the clearing system and never visible to the counterparty. Returned in transaction details and filterable in Transactions list v2 using exact match on the full value. Do not store sensitive personal data, card numbers, or secrets here. Examples: ["billing-run-2026-07"] or ["salary", "executive", "vacation"].
Maximum array length:
10Maximum string length:
140Example:
["billing-run-2026-07"]
Underlying reason for the payment transaction. Usage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.
Show child attributes
Show child attributes
Ultimate party to which an amount of money is due.
Show child attributes
Show child attributes
Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
Show child attributes
Show child attributes
Response
A new SEPA direct debit payment has been created
Result of sepa direct debit payment request creation
Show child attributes
Show child attributes
Last modified on September 1, 2026