Krypto-Rechnung zur Aufladung erstellen

POST 
/api/invoice/crypto-invoice/deposit

Erstellt eine Krypto-Rechnung zur Aufladung für eine Sandbox-Bestellung des Händlers.

Anfrage

application/json

Body

Request-Bodyerforderlich

Daten zum Erstellen einer Krypto-Rechnung zur Aufladung.

receiverCurrencystringerforderlich
Währung des Empfängers.
Mögliche Werte: [USD, EUR, USDT, USDC]
Beispiel: USD
senderCurrencystringerforderlich
Währung des Absenders.
Mögliche Werte: [BTC, ETH, SOL, TRX, XRP, TON, LTC, AVAX, BNB, POL, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, USDT_TON, USDC, USDC_ERC20, USDC_BEP20, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Beispiel: USD
amountnumbererforderlich
Betrag.
Mögliche Werte: >= 0
Beispiel: 10.25
transferActionstringerforderlich
Überweisungsaktion.
Mögliche Werte: [GIVE, GET]
Beispiel: GIVE
notestringnullable
Notiz.
Mögliche Werte: <= 255 Zeichen
Beispiel: Sandbox transfer note
sciNamestringnullable
SCI-Name.
Beispiel: test-value
orderIdstringnullable
Bestell-ID.
Mögliche Werte: <= 64 Zeichen
Beispiel: ORDER_123456
subMerchantURLstringnullable
URL des Sub-Händlers.
Beispiel: test-value

Beispiel

{
  "receiverCurrency": "USD",
  "senderCurrency": "BTC",
  "amount": 10.25,
  "transferAction": "GIVE",
  "note": "Sandbox transfer note",
  "sciName": "test-value",
  "orderId": "ORDER_123456",
  "subMerchantURL": "test-value"
}

Antworten

200

OK

application/json

Schema

Schema

receiverCurrencystringerforderlich
Währung des Empfängers.
Mögliche Werte: [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Beispiel: USD
senderCurrencystringerforderlich
Währung des Absenders.
Mögliche Werte: [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Beispiel: USD
amountnumbererforderlich
Betrag.
Mögliche Werte: >= 0
Beispiel: 10.25
transferActionstringerforderlich
Überweisungsaktion.
Mögliche Werte: [GIVE, GET]
Beispiel: GIVE
notestringnullable
Notiz.
Mögliche Werte: <= 255 Zeichen
Beispiel: Sandbox transfer note
sciNamestringnullable
SCI-Name.
Beispiel: test-value
orderIdstringnullable
Bestell-ID.
Mögliche Werte: <= 64 Zeichen
Beispiel: ORDER_123456
subMerchantURLstringnullable
URL des Sub-Händlers.
Beispiel: test-value
addressstringnullable
Adresse.
Beispiel: test-value
addressOldFormatstringnullable
Adresse im alten Format.
Beispiel: test-value
destinationTagstringnullable
Destination Tag.
Beispiel: test-value
senderAmountnumbernullable
Betrag des Absenders.
Beispiel: 10.25
receiverAmountnumbernullable
Betrag des Empfängers.
Beispiel: 10.25
expirationDatedate-timenullable

Ablaufzeitpunkt.

expirationDateMillisint64nullable

Ablaufzeitpunkt in Millisekunden.

Beispiel

{
  "receiverCurrency": "USD",
  "senderCurrency": "USD",
  "amount": 10.25,
  "transferAction": "GIVE",
  "note": "Sandbox transfer note",
  "sciName": "test-value",
  "orderId": "ORDER_123456",
  "subMerchantURL": "test-value",
  "address": "test-value",
  "addressOldFormat": "test-value",
  "destinationTag": "test-value",
  "senderAmount": 10.25,
  "receiverAmount": 10.25,
  "expirationDate": "2026-01-15T10:30:00",
  "expirationDateMillis": "2026-01-15T10:30:00"
}

400

Ungültige Anfrage. Die Anfrage ist fehlerhaft oder enthält ungültige Parameter.

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: disabled
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: FORM
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Nicht autorisiert. Die Authentifizierungs-Header des Händlers fehlen oder sind ungültig.

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: userDoesNotExistException
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: GENERAL
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Nicht gefunden. Die angeforderte Ressource existiert nicht.

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: resourceNotFound
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: GENERAL
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: Resource not found
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Interner Serverfehler. Unerwarteter Fehler, wenden Sie sich an den Support

application/json

Schema

Schema

statusstringerforderlich
Antwortstatus.
Mögliche Werte: [error]
Beispiel: error
data objecterforderlich
Daten der Fehlerantwort.
errors object[]erforderlich
Liste der für die Anfrage zurückgegebenen Fehler.
Array [
errorMessagestringerforderlich
Stabiler maschinenlesbarer Fehlercode.
Beispiel: internalServerError
errorTypestringerforderlich
Fehlerkategorie.
Beispiel: GENERAL
errorIdstringerforderlich
Kurze eindeutige Fehlerkennung für Support und Logs.
Beispiel: errTest1234
errorDescriptionstringerforderlich
Lesbare Fehlerbeschreibung.
Beispiel: Internal server error
errorFieldstringnullable
Feld der Anfrage, auf das sich der Fehler bezieht, falls vorhanden.
Beispiel: null
paramsobject[]erforderlich
Zusätzliche Fehlerparameter.
requestParamsobjecterforderlich
Für die Diagnose erfasste Anfrageparameter.
]

Beispiel

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}