Create an Order
curl --request POST \
--url https://api.getivy.de/api/service/order/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"amount": 1,
"referenceId": "<string>",
"expiresAt": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"phone": "<string>"
},
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getivy.de/api/service/order/create"
payload = {
"amount": 1,
"referenceId": "<string>",
"expiresAt": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"phone": "<string>"
},
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-Ivy-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-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1,
referenceId: '<string>',
expiresAt: '<string>',
customer: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
email: 'jsmith@example.com',
phone: '<string>'
},
subaccountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getivy.de/api/service/order/create', 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.getivy.de/api/service/order/create",
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' => 1,
'referenceId' => '<string>',
'expiresAt' => '<string>',
'customer' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'email' => 'jsmith@example.com',
'phone' => '<string>'
],
'subaccountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-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://api.getivy.de/api/service/order/create"
payload := strings.NewReader("{\n \"amount\": 1,\n \"referenceId\": \"<string>\",\n \"expiresAt\": \"<string>\",\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n },\n \"subaccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-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://api.getivy.de/api/service/order/create")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"referenceId\": \"<string>\",\n \"expiresAt\": \"<string>\",\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n },\n \"subaccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/order/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1,\n \"referenceId\": \"<string>\",\n \"expiresAt\": \"<string>\",\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n },\n \"subaccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"status": "failed",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"instantPaymentScheme": true,
"payerFinancialAddress": {
"type": "iban",
"aba": {
"routingNumber": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bic": {
"accountNumber": "<string>",
"bic": "<string>",
"accountHolderName": "<string>",
"localBankCode": "<string>"
},
"iban": {
"iban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
}
},
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<unknown>"
],
"billingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "DE",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"shippingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "DE",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"paymentStatus": "not_settled",
"refunds": [
{
"id": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"transactionId": "<string>"
}
],
"refundAmount": 1,
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"merchantFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"aba": {
"accountHolderName": "<string>",
"routingNumber": "<string>",
"accountNumber": "<string>"
},
"bic": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"bic": "<string>",
"localBankCode": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"aba": {
"accountHolderName": "<string>",
"routingNumber": "<string>",
"accountNumber": "<string>"
},
"bic": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"bic": "<string>",
"localBankCode": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>"
},
"paymentMethodType": "customer_balance",
"statusHistoryList": [
{
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"previousStatus": "failed"
}
],
"subaccountId": "<string>",
"subaccountLegalName": "<string>",
"statusClassification": {
"primary": "payment_authorisation_failed",
"secondary": "timeout"
},
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>",
"transactionId": "<string>"
}Order
Create an Order
Create a new order. By creating a new order, you will create a new settlement destination which you can use to settle expected incoming payments efficiently. After creating the order, Ivy provides you with a destination for the expected incoming payment. As soon as a payment with the same details arrives, Ivy will update the status of the order.
POST
/
api
/
service
/
order
/
create
Create an Order
curl --request POST \
--url https://api.getivy.de/api/service/order/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"amount": 1,
"referenceId": "<string>",
"expiresAt": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"phone": "<string>"
},
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getivy.de/api/service/order/create"
payload = {
"amount": 1,
"referenceId": "<string>",
"expiresAt": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"phone": "<string>"
},
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-Ivy-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-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1,
referenceId: '<string>',
expiresAt: '<string>',
customer: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
email: 'jsmith@example.com',
phone: '<string>'
},
subaccountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getivy.de/api/service/order/create', 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.getivy.de/api/service/order/create",
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' => 1,
'referenceId' => '<string>',
'expiresAt' => '<string>',
'customer' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'email' => 'jsmith@example.com',
'phone' => '<string>'
],
'subaccountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-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://api.getivy.de/api/service/order/create"
payload := strings.NewReader("{\n \"amount\": 1,\n \"referenceId\": \"<string>\",\n \"expiresAt\": \"<string>\",\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n },\n \"subaccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-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://api.getivy.de/api/service/order/create")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"referenceId\": \"<string>\",\n \"expiresAt\": \"<string>\",\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n },\n \"subaccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/order/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1,\n \"referenceId\": \"<string>\",\n \"expiresAt\": \"<string>\",\n \"customer\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n },\n \"subaccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"status": "failed",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"instantPaymentScheme": true,
"payerFinancialAddress": {
"type": "iban",
"aba": {
"routingNumber": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bic": {
"accountNumber": "<string>",
"bic": "<string>",
"accountHolderName": "<string>",
"localBankCode": "<string>"
},
"iban": {
"iban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
}
},
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<unknown>"
],
"billingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "DE",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"shippingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "DE",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"paymentStatus": "not_settled",
"refunds": [
{
"id": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"transactionId": "<string>"
}
],
"refundAmount": 1,
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"merchantFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"aba": {
"accountHolderName": "<string>",
"routingNumber": "<string>",
"accountNumber": "<string>"
},
"bic": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"bic": "<string>",
"localBankCode": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"aba": {
"accountHolderName": "<string>",
"routingNumber": "<string>",
"accountNumber": "<string>"
},
"bic": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"bic": "<string>",
"localBankCode": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>"
},
"paymentMethodType": "customer_balance",
"statusHistoryList": [
{
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"previousStatus": "failed"
}
],
"subaccountId": "<string>",
"subaccountLegalName": "<string>",
"statusClassification": {
"primary": "payment_authorisation_failed",
"secondary": "timeout"
},
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>",
"transactionId": "<string>"
}Headers
Body
application/json
Response
200 - application/json
Order created successfully
The status of the order. As soon as this value is 'paid', you can ship the order.
Available options:
failed, canceled, processing, waiting_for_payment, waiting_for_bank_confirmation, paid, in_refund, refunded, refund_failed, partially_refunded, in_dispute, disputed, refused, finalizing Was this page helpful?