Sign up a new Payt account
curl --request POST \
--url https://api.paytsoftware.com/v1/sign_up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'administration%5Bcity%5D=<string>' \
--data-urlencode 'administration%5Bcommercial_registration_number%5D=<string>' \
--data-urlencode 'administration%5Bcountry_code%5D=<string>' \
--data-urlencode 'administration%5Bemail_address%5D=<string>' \
--data-urlencode 'administration%5Bhouse_number%5D=<string>' \
--data-urlencode 'administration%5Bname%5D=<string>' \
--data-urlencode 'administration%5Bphone_number%5D=<string>' \
--data-urlencode 'administration%5Bpostal_code%5D=<string>' \
--data-urlencode 'administration%5Bstreet_name%5D=<string>' \
--data-urlencode 'user%5Bfirst_name%5D=<string>' \
--data-urlencode 'user%5Blast_name%5D=<string>' \
--data-urlencode 'user%5Bemail_address%5D=<string>' \
--data-urlencode 'connection%5Bresource_label%5D=<string>' \
--data-urlencode 'connection%5Bresource_identifier%5D=<string>' \
--data-urlencode 'administration%5Bsender_email_address%5D=<string>' \
--data-urlencode 'administration%5Bbank_account_bic%5D=<string>' \
--data-urlencode 'administration%5Bbank_account_name%5D=<string>' \
--data-urlencode 'administration%5Bbank_account_number%5D=<string>' \
--data-urlencode 'administration%5Bcontact_name%5D=<string>' \
--data-urlencode administration%5Bcurrency_code%5D=EUR \
--data-urlencode administration%5Btimezone%5D=Europe/Amsterdam \
--data-urlencode 'administration%5Bvat_number%5D=<string>' \
--data-urlencode user%5Blocale%5D=en-GB \
--data-urlencode 'connection%5Bcredentials_label%5D=<string>'import requests
url = "https://api.paytsoftware.com/v1/sign_up"
payload = {
"administration[city]": "<string>",
"administration[commercial_registration_number]": "<string>",
"administration[country_code]": "<string>",
"administration[email_address]": "<string>",
"administration[house_number]": "<string>",
"administration[name]": "<string>",
"administration[phone_number]": "<string>",
"administration[postal_code]": "<string>",
"administration[street_name]": "<string>",
"user[first_name]": "<string>",
"user[last_name]": "<string>",
"user[email_address]": "<string>",
"connection[resource_label]": "<string>",
"connection[resource_identifier]": "<string>",
"administration[sender_email_address]": "<string>",
"administration[bank_account_bic]": "<string>",
"administration[bank_account_name]": "<string>",
"administration[bank_account_number]": "<string>",
"administration[contact_name]": "<string>",
"administration[currency_code]": "EUR",
"administration[timezone]": "Europe/Amsterdam",
"administration[vat_number]": "<string>",
"user[locale]": "en-GB",
"connection[credentials_label]": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/x-www-form-urlencoded"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({
'administration[city]': '<string>',
'administration[commercial_registration_number]': '<string>',
'administration[country_code]': '<string>',
'administration[email_address]': '<string>',
'administration[house_number]': '<string>',
'administration[name]': '<string>',
'administration[phone_number]': '<string>',
'administration[postal_code]': '<string>',
'administration[street_name]': '<string>',
'user[first_name]': '<string>',
'user[last_name]': '<string>',
'user[email_address]': '<string>',
'connection[resource_label]': '<string>',
'connection[resource_identifier]': '<string>',
'administration[sender_email_address]': '<string>',
'administration[bank_account_bic]': '<string>',
'administration[bank_account_name]': '<string>',
'administration[bank_account_number]': '<string>',
'administration[contact_name]': '<string>',
'administration[currency_code]': 'EUR',
'administration[timezone]': 'Europe/Amsterdam',
'administration[vat_number]': '<string>',
'user[locale]': 'en-GB',
'connection[credentials_label]': '<string>'
})
};
fetch('https://api.paytsoftware.com/v1/sign_up', 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.paytsoftware.com/v1/sign_up",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/x-www-form-urlencoded"
],
]);
$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.paytsoftware.com/v1/sign_up"
payload := strings.NewReader("administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
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.paytsoftware.com/v1/sign_up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paytsoftware.com/v1/sign_up")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E"
response = http.request(request)
puts response.read_body{
"administration": {
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"contact_name": "<string>",
"commercial_registration_number": "<string>",
"country_code": "<string>",
"city": "<string>",
"house_number": "<string>",
"internal_name": "<string>",
"street_name": "<string>",
"postal_code": "<string>",
"timezone": "<string>",
"currency_code": "<string>",
"administration_url": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"bank_account_bic": "<string>",
"vat_number": "<string>",
"import_origin_identifier": "<string>",
"last_successful_import_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"reminding_paused_at": "2023-11-07T05:31:56Z"
},
"company": {
"id": "<string>",
"name": "<string>",
"trial_ends_on": "<string>",
"trial": true
},
"user": {
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"sign_up_token": "<string>",
"sign_up_url": "<string>"
},
"access_grant": {
"code": "<string>",
"expires_in": 123,
"created_at": "<string>",
"grant_type": "<string>"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}sign_up
Sign up a new Payt account
NOTE: This endpoint uses Basic authentication, just as the token endpoints.
Creates a Payt account containing a user, company and administration.
An OAuth authorization_code will be returned with which the first access_token can be created. This means that in order to complete the API authorization the confirm step must be made as described here.
If connection parameters are given then these are added to the newly created administration and are validated during the signup. If the connection parameters are invalid a validation error will be returned.
POST
/
v1
/
sign_up
Sign up a new Payt account
curl --request POST \
--url https://api.paytsoftware.com/v1/sign_up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'administration%5Bcity%5D=<string>' \
--data-urlencode 'administration%5Bcommercial_registration_number%5D=<string>' \
--data-urlencode 'administration%5Bcountry_code%5D=<string>' \
--data-urlencode 'administration%5Bemail_address%5D=<string>' \
--data-urlencode 'administration%5Bhouse_number%5D=<string>' \
--data-urlencode 'administration%5Bname%5D=<string>' \
--data-urlencode 'administration%5Bphone_number%5D=<string>' \
--data-urlencode 'administration%5Bpostal_code%5D=<string>' \
--data-urlencode 'administration%5Bstreet_name%5D=<string>' \
--data-urlencode 'user%5Bfirst_name%5D=<string>' \
--data-urlencode 'user%5Blast_name%5D=<string>' \
--data-urlencode 'user%5Bemail_address%5D=<string>' \
--data-urlencode 'connection%5Bresource_label%5D=<string>' \
--data-urlencode 'connection%5Bresource_identifier%5D=<string>' \
--data-urlencode 'administration%5Bsender_email_address%5D=<string>' \
--data-urlencode 'administration%5Bbank_account_bic%5D=<string>' \
--data-urlencode 'administration%5Bbank_account_name%5D=<string>' \
--data-urlencode 'administration%5Bbank_account_number%5D=<string>' \
--data-urlencode 'administration%5Bcontact_name%5D=<string>' \
--data-urlencode administration%5Bcurrency_code%5D=EUR \
--data-urlencode administration%5Btimezone%5D=Europe/Amsterdam \
--data-urlencode 'administration%5Bvat_number%5D=<string>' \
--data-urlencode user%5Blocale%5D=en-GB \
--data-urlencode 'connection%5Bcredentials_label%5D=<string>'import requests
url = "https://api.paytsoftware.com/v1/sign_up"
payload = {
"administration[city]": "<string>",
"administration[commercial_registration_number]": "<string>",
"administration[country_code]": "<string>",
"administration[email_address]": "<string>",
"administration[house_number]": "<string>",
"administration[name]": "<string>",
"administration[phone_number]": "<string>",
"administration[postal_code]": "<string>",
"administration[street_name]": "<string>",
"user[first_name]": "<string>",
"user[last_name]": "<string>",
"user[email_address]": "<string>",
"connection[resource_label]": "<string>",
"connection[resource_identifier]": "<string>",
"administration[sender_email_address]": "<string>",
"administration[bank_account_bic]": "<string>",
"administration[bank_account_name]": "<string>",
"administration[bank_account_number]": "<string>",
"administration[contact_name]": "<string>",
"administration[currency_code]": "EUR",
"administration[timezone]": "Europe/Amsterdam",
"administration[vat_number]": "<string>",
"user[locale]": "en-GB",
"connection[credentials_label]": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/x-www-form-urlencoded"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({
'administration[city]': '<string>',
'administration[commercial_registration_number]': '<string>',
'administration[country_code]': '<string>',
'administration[email_address]': '<string>',
'administration[house_number]': '<string>',
'administration[name]': '<string>',
'administration[phone_number]': '<string>',
'administration[postal_code]': '<string>',
'administration[street_name]': '<string>',
'user[first_name]': '<string>',
'user[last_name]': '<string>',
'user[email_address]': '<string>',
'connection[resource_label]': '<string>',
'connection[resource_identifier]': '<string>',
'administration[sender_email_address]': '<string>',
'administration[bank_account_bic]': '<string>',
'administration[bank_account_name]': '<string>',
'administration[bank_account_number]': '<string>',
'administration[contact_name]': '<string>',
'administration[currency_code]': 'EUR',
'administration[timezone]': 'Europe/Amsterdam',
'administration[vat_number]': '<string>',
'user[locale]': 'en-GB',
'connection[credentials_label]': '<string>'
})
};
fetch('https://api.paytsoftware.com/v1/sign_up', 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.paytsoftware.com/v1/sign_up",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/x-www-form-urlencoded"
],
]);
$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.paytsoftware.com/v1/sign_up"
payload := strings.NewReader("administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
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.paytsoftware.com/v1/sign_up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paytsoftware.com/v1/sign_up")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "administration%5Bcity%5D=%3Cstring%3E&administration%5Bcommercial_registration_number%5D=%3Cstring%3E&administration%5Bcountry_code%5D=%3Cstring%3E&administration%5Bemail_address%5D=%3Cstring%3E&administration%5Bhouse_number%5D=%3Cstring%3E&administration%5Bname%5D=%3Cstring%3E&administration%5Bphone_number%5D=%3Cstring%3E&administration%5Bpostal_code%5D=%3Cstring%3E&administration%5Bstreet_name%5D=%3Cstring%3E&user%5Bfirst_name%5D=%3Cstring%3E&user%5Blast_name%5D=%3Cstring%3E&user%5Bemail_address%5D=%3Cstring%3E&connection%5Bresource_label%5D=%3Cstring%3E&connection%5Bresource_identifier%5D=%3Cstring%3E&administration%5Bsender_email_address%5D=%3Cstring%3E&administration%5Bbank_account_bic%5D=%3Cstring%3E&administration%5Bbank_account_name%5D=%3Cstring%3E&administration%5Bbank_account_number%5D=%3Cstring%3E&administration%5Bcontact_name%5D=%3Cstring%3E&administration%5Bcurrency_code%5D=EUR&administration%5Btimezone%5D=Europe%2FAmsterdam&administration%5Bvat_number%5D=%3Cstring%3E&user%5Blocale%5D=en-GB&connection%5Bcredentials_label%5D=%3Cstring%3E"
response = http.request(request)
puts response.read_body{
"administration": {
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"contact_name": "<string>",
"commercial_registration_number": "<string>",
"country_code": "<string>",
"city": "<string>",
"house_number": "<string>",
"internal_name": "<string>",
"street_name": "<string>",
"postal_code": "<string>",
"timezone": "<string>",
"currency_code": "<string>",
"administration_url": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"bank_account_bic": "<string>",
"vat_number": "<string>",
"import_origin_identifier": "<string>",
"last_successful_import_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"reminding_paused_at": "2023-11-07T05:31:56Z"
},
"company": {
"id": "<string>",
"name": "<string>",
"trial_ends_on": "<string>",
"trial": true
},
"user": {
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"sign_up_token": "<string>",
"sign_up_url": "<string>"
},
"access_grant": {
"code": "<string>",
"expires_in": 123,
"created_at": "<string>",
"grant_type": "<string>"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
OAuth2 access token or static API token. See Authorization for how to obtain one.
Body
application/x-www-form-urlencoded
Part of the administration address
Offical national commercial registration number
ISO 3166 Alpha-2 country code, Part of the administration address
Email address of the administration
Part of the administration address
Name of the administration
Phone number of the administration
Part of the administration address
Part of the administration address
First name of the user
Last name of the user
Email address the user will use to login into Payt
Description of the resource in your app with which the administration is connected. This can be a code, name or combination thereof. It should be uniquely recognizable for the enduser.
The unique identifier of the connected resource. This identifier will be used to query your API.
Sender email address which will be used for outgoing communication
BIC of the bank. The BIC must match the bank_account_number. If it is not then the bank_account properties will be ignored.
Name of the bank account holder. The name must be as it is registered by the bank. If it is not then the bank_account properties will be ignored.
Number of the bank account. This must be an existing organizational bank account. If it is not then the bank_account properties will be ignored.
The name of the contact person for this administration
The accounting or reporting currency, ISO 4217
Timezone in which the administration primarily operates, canonical tz name
VAT number of the administration
Locale in which the user will use Payt, 'ISO 639-1' + 'ISO 3166 Alpha-2 country code' (nl|de|en-GB|es|fr|nl-BE).
Description of the owner of the credentials. This can be a code, number or name and should be uniquely recognizable by the enduser. This field becomes required if the credentials owner is not the resource itself.
Response
Payt account created
Last modified on August 13, 2026
Was this page helpful?
⌘I