POST
/
api
/
service
/
order
/
create
curl --request POST \
  --url https://api.sand.getivy.de/api/service/order/create \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "amount": 123,
  "currency": "EUR",
  "referenceId": "<string>",
  "expiresAt": "<string>",
  "customer": {
    "id": "<string>",
    "email": "<string>"
  },
  "subaccountId": "<string>"
}'
{
  "id": "<string>",
  "merchantId": "<string>",
  "payerFinancialAddress": {
    "type": "iban",
    "iban": {
      "accountHolderName": "<string>",
      "iban": "<string>",
      "bic": "<string>"
    },
    "sortCode": {
      "accountHolderName": "<string>",
      "sortCode": "<string>",
      "accountNumber": "<string>"
    },
    "bankCode": {
      "accountHolderName": "<string>",
      "code": "<string>",
      "accountNumber": "<string>"
    },
    "bban": {
      "accountHolderName": "<string>",
      "bban": "<string>",
      "bic": "<string>"
    }
  },
  "appId": "<string>",
  "merchantAppId": "<string>",
  "shopName": "<string>",
  "referenceId": "<string>",
  "displayId": "<string>",
  "offsetProject": "<string>",
  "metadata": {},
  "category": "<string>",
  "co2Grams": 1,
  "applicationFeeAmount": 1,
  "price": {
    "total": 1.01,
    "currency": "EUR",
    "subTotal": 123,
    "shipping": 123,
    "totalNet": 123,
    "vat": 123
  },
  "lineItems": [
    {
      "name": "<string>",
      "referenceId": "<string>",
      "singleNet": 123,
      "singleVat": 123,
      "amount": 123,
      "quantity": 1,
      "image": "<string>",
      "category": "5045",
      "EAN": "<string>",
      "co2Grams": 1
    }
  ],
  "shopLogo": "<string>",
  "guest": false,
  "climateActionMode": {
    "type": "transaction",
    "amount": 123
  },
  "impactOffsetProjects": [
    "<any>"
  ],
  "billingAddress": {
    "firstName": "<string>",
    "lastName": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "region": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "country": "AF"
  },
  "shippingAddress": {
    "firstName": "<string>",
    "lastName": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "region": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "country": "AF"
  },
  "paymentStatus": "not_settled",
  "status": "failed",
  "refunds": [
    {
      "id": "<string>",
      "description": "<string>",
      "referenceId": "<string>",
      "amount": 1,
      "status": "pending",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    }
  ],
  "refundAmount": 1,
  "createdAt": "<any>",
  "updatedAt": "<any>",
  "shopperEmail": "<string>",
  "shopper": {
    "email": "<string>",
    "phoneNumber": "<string>"
  },
  "trees": 123,
  "merchantFinancialAddress": {
    "type": "iban",
    "iban": {
      "accountHolderName": "<string>",
      "iban": "<string>",
      "bic": "<string>"
    },
    "sortCode": {
      "accountHolderName": "<string>",
      "sortCode": "<string>",
      "accountNumber": "<string>"
    },
    "bankCode": {
      "accountHolderName": "<string>",
      "code": "<string>",
      "accountNumber": "<string>"
    },
    "bban": {
      "accountHolderName": "<string>",
      "bban": "<string>",
      "bic": "<string>"
    },
    "paymentReference": "<string>"
  },
  "bankStatementReference": "<string>",
  "destination": {
    "bankAccount": {
      "type": "iban",
      "iban": {
        "accountHolderName": "<string>",
        "iban": "<string>",
        "bic": "<string>"
      },
      "sortCode": {
        "accountHolderName": "<string>",
        "sortCode": "<string>",
        "accountNumber": "<string>"
      },
      "bankCode": {
        "accountHolderName": "<string>",
        "code": "<string>",
        "accountNumber": "<string>"
      },
      "bban": {
        "accountHolderName": "<string>",
        "bban": "<string>",
        "bic": "<string>"
      },
      "paymentReference": "<string>"
    },
    "bankStatementReference": "<string>"
  },
  "paymentMethodType": "sepa_debit",
  "setupPaymentMandate": true,
  "statusHistoryList": [
    {
      "previousStatus": "failed",
      "currentStatus": "failed",
      "reason": "ORDER_CREATED",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    }
  ],
  "mandate": {
    "setup": false,
    "referenceId": "<string>",
    "accountHolderName": "<string>",
    "userNotificationEmail": "<string>",
    "additionalDisplayInformation": {
      "price": {
        "amount": 123,
        "currency": "EUR"
      },
      "cadence": "BI_WEEKLY"
    },
    "reference": "<string>",
    "creditor": {
      "name": "<string>",
      "id": "<string>"
    }
  },
  "subaccountId": "<string>",
  "subaccountLegalName": "<string>",
  "instantPaymentScheme": true,
  "statusClassification": {
    "primary": "payment_authorisation_failed",
    "secondary": "timeout"
  },
  "paymentMode": "direct",
  "customerId": "<string>",
  "bankId": "<string>"
}

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json

Response

200 - application/json

Order created successfully

The response is of type object.