Erstellen einer Rechnung
Anfrage
Abfrageparameter
Name | Parametertyp | Standardwert | Definition |
---|---|---|---|
amount* | string | Zu bezahlende Summe.Wenn der Betrag Pennys enthalten, senden Sie sie mit einem Separator '.' Beispiel: 10.28 | |
currency* | string | Währungscode | |
order_id* | stringmin: 1max: 128alpha_dash | Bestell -ID in Ihrem System bestellenDer Parameter sollte eine Zeichenfolge sein, die aus alphabetischen Zeichen, Zahlen, Unterstrichen und Strichen besteht. Es sollte keine Räume oder Sonderzeichen enthalten.Die order_id muss innerhalb der Händler -Rechnungen/statischen Geldbörsen/Wiederholungszahlungen eindeutig seinWenn wir eine vorhandene Rechnung mit order_id finden, geben wir seine Details zurück, eine neue Rechnung wird nicht erstellt. | |
network | string | null | Blockchain -Netzwerkcode |
url_return | stringmin: 6max: 255url | null | Vor der Zahlung kann der Benutzer auf die Schaltfläche im Zahlungsformular klicken und in dieser URL zur Store -Seite zurückkehren. |
url_success | stringmin: 6max: 255url | null | Nach erfolgreicher Zahlung kann der Benutzer im Zahlungsformular auf die Schaltfläche klicken und zu dieser URL zurückkehren. |
url_callback | stringmin: 6max: 255url | null | URL, an die Webhooks mit Zahlungsstatus gesendet werden |
is_payment_multiple | boolean | true | Ob der Benutzer den verbleibenden Betrag bezahlen darf. Dies ist nützlich, wenn der Benutzer nicht den gesamten Betrag der Rechnung für eine Transaktion bezahlt hat und dass Sie es ihm erlauben möchten, den vollen Betrag zu zahlen. Wenn Sie diese Funktion deaktivieren, wird die Rechnung nach Erhalt der ersten Zahlung abgeschlossen und Sie erhalten Geld für Ihren Restbetrag. |
lifetime | integermin: 300max: 43200 | 3600 | Die Lebensdauer der ausgestellten Rechnung (in Sekunden) |
to_currency | string | Der Parameter wird verwendet, um die Zielwährung für die Konvertierung des Rechnungsbetrags anzugeben. Beim Erstellen einer Rechnung stellen Sie einen Betrag und eine Währung bereit, und die API wandelt diesen Betrag in den äquivalenten Wert in der to_currency um.Zum Beispiel eine Rechnung für 20 USD in Bitcoin: amount: 20 currecny: USD to_currency : btcDie API wird basierend auf dem aktuellen Wechselkurs 20 USD in BTC in ihre Äquivalent umwandeln, und der Benutzer zahlt in BTCDie to_currency sollte immer der Kryptowährungscode sein, nicht ein Fiat -Währungscode. | |
subtract | integermin: 0max: 100 | 0 | Prozentsatz der Zahlungskommission, die dem Kunden angeklagt istWenn Sie eine Rate von 1% haben, muss der Kunde 101 USDT zahlen, wenn Sie eine Rechnung für 100 USDT mit Subtrahiert = 100 erstellen (der Kunde zahlt 100% Provision). |
accuracy_payment_percent | numericmin: 0max: 5 | 0 | Akzeptable Ungenauigkeit bei der Zahlung.Wenn Sie beispielsweise den Wert 5 bestehen, wird die Rechnung als bezahlt markiert, selbst wenn der Kunde nur 95% des Betrags bezahlt hat.Der tatsächliche Zahlungsbetrag wird dem Guthaben gutgeschrieben |
additional_data | stringmax: 255 | null | Zusätzliche Informationen für Sie (nicht dem Kunden angezeigt) |
currencies | array | Die Auswahl der verfügbaren Währungen aus den Einstellungen Ihres Händlers wird verwendet (wenn der Parameter nicht festgelegt ist, werden alle unterstützten Kryptowährungen standardmäßig verwendet).Die verfügbaren Währungen sind im Abschnitt Händlereinstellungen festgelegt. | Liste der zulässigen Währungen für die Zahlung. Dies ist nützlich, wenn Sie die Liste der Münzen einschränken möchten, mit denen Ihre Kunden Rechnungen bezahlen können. Struktur |
except_currencies | array | null | Liste der ausgeschlossenen Währungen für die Zahlung Struktur |
course_source | stringmin: 4max: 20Verfügbare Werte• Binance• BinanceP2P• Exmo• Kucoin | Wenn nicht bestanden, werden Kryptomus -Wechselkurse verwendet. | Der Service, aus dem die Wechselkurse zur Konvertierung in der Rechnung angenommen werden. |
from_referral_code | string | null | Der Händler, der die Anfrage stellt, stellt eine Verbindung zu einem Empfehlungsmittel per Code her.Sie sind beispielsweise eine Anwendung, die Rechnungen über die Kryptomus -API generiert und Ihre Kunden andere Geschäfte sind. Sie geben in Ihrer Bewerbung ihre API -Schlüssel- und Händler -ID ein. Sie senden Anfragen mit ihren Anmeldeinformationen und übergeben Ihren Empfehlungscode.Daher werden Ihre Kunden zu Empfehlungen auf Ihrem Kryptomuskonto und Sie erhalten Einnahmen aus ihrem Umsatz. |
discount_percent | integermin: -99max: 100 | null | Positive Zahlen: Ermöglicht Ihnen einen Rabatt festzulegen. Um einen Rabatt von 5% für die Zahlung festzulegen, sollten Sie einen Wert bestehen: 5Negative Zahlen: Ermöglicht Ihnen, benutzerdefinierte zusätzliche Provision festzulegen.Um eine zusätzliche Kommission von 10% für die Zahlung festzulegen, sollten Sie einen Wert verabschieden: -10Der Rabattprozentsatz beim Erstellen einer Rechnung wird nur dann berücksichtigt, wenn die Rechnung eine bestimmte Kryptowährung hat. |
is_refresh | boolean | false | Mit diesem Parameter können Sie die Lebensdauer aktualisieren und eine neue Adresse für die Rechnung abrufen, wenn die Lebensdauer abgelaufen ist.Dazu müssen Sie alle erforderlichen Parameter übergeben, und die Rechnung mit bestandenem Order_id wird aktualisiert.Nur address , payment_status und expired_at werden geändert. Unabhängig von den übergebenen Parametern werden keine anderen Felder geändert. |
Parametertyp
stringDefinition
Zu bezahlende Summe.Wenn der Betrag Pennys enthalten, senden Sie sie mit einem Separator '.'
Beispiel: 10.28Parametertyp
stringDefinition
WährungscodeParametertyp
stringmin: 1max: 128alpha_dashDefinition
Bestell -ID in Ihrem System bestellenDer Parameter sollte eine Zeichenfolge sein, die aus alphabetischen Zeichen, Zahlen, Unterstrichen und Strichen besteht. Es sollte keine Räume oder Sonderzeichen enthalten.Die order_id muss innerhalb der Händler -Rechnungen/statischen Geldbörsen/Wiederholungszahlungen eindeutig seinWenn wir eine vorhandene Rechnung mit order_id finden, geben wir seine Details zurück, eine neue Rechnung wird nicht erstellt.Parametertyp
stringDefinition
Blockchain -NetzwerkcodeParametertyp
stringmin: 6max: 255urlDefinition
Vor der Zahlung kann der Benutzer auf die Schaltfläche im Zahlungsformular klicken und in dieser URL zur Store -Seite zurückkehren.Parametertyp
stringmin: 6max: 255urlDefinition
Nach erfolgreicher Zahlung kann der Benutzer im Zahlungsformular auf die Schaltfläche klicken und zu dieser URL zurückkehren.Parametertyp
stringmin: 6max: 255urlDefinition
URL, an die Webhooks mit Zahlungsstatus gesendet werdenParametertyp
booleanDefinition
Ob der Benutzer den verbleibenden Betrag bezahlen darf. Dies ist nützlich, wenn der Benutzer nicht den gesamten Betrag der Rechnung für eine Transaktion bezahlt hat und dass Sie es ihm erlauben möchten, den vollen Betrag zu zahlen. Wenn Sie diese Funktion deaktivieren, wird die Rechnung nach Erhalt der ersten Zahlung abgeschlossen und Sie erhalten Geld für Ihren Restbetrag.Parametertyp
integermin: 300max: 43200Definition
Die Lebensdauer der ausgestellten Rechnung (in Sekunden)Parametertyp
stringDefinition
Der Parameter wird verwendet, um die Zielwährung für die Konvertierung des Rechnungsbetrags anzugeben. Beim Erstellen einer Rechnung stellen Sie einen Betrag und eine Währung bereit, und die API wandelt diesen Betrag in den äquivalenten Wert in der to_currency um.Zum Beispiel eine Rechnung für 20 USD in Bitcoin:
amount: 20
currecny: USD
to_currency : btcDie API wird basierend auf dem aktuellen Wechselkurs 20 USD in BTC in ihre Äquivalent umwandeln, und der Benutzer zahlt in BTCDie to_currency sollte immer der Kryptowährungscode sein, nicht ein Fiat -Währungscode.Parametertyp
integermin: 0max: 100Definition
Prozentsatz der Zahlungskommission, die dem Kunden angeklagt istWenn Sie eine Rate von 1% haben, muss der Kunde 101 USDT zahlen, wenn Sie eine Rechnung für 100 USDT mit Subtrahiert = 100 erstellen (der Kunde zahlt 100% Provision).Parametertyp
numericmin: 0max: 5Definition
Akzeptable Ungenauigkeit bei der Zahlung.Wenn Sie beispielsweise den Wert 5 bestehen, wird die Rechnung als bezahlt markiert, selbst wenn der Kunde nur 95% des Betrags bezahlt hat.Der tatsächliche Zahlungsbetrag wird dem Guthaben gutgeschriebenParametertyp
stringmax: 255Definition
Zusätzliche Informationen für Sie (nicht dem Kunden angezeigt)Parametertyp
arrayDefinition
Liste der zulässigen Währungen für die Zahlung. Dies ist nützlich, wenn Sie die Liste der Münzen einschränken möchten, mit denen Ihre Kunden Rechnungen bezahlen können. StrukturParametertyp
arrayDefinition
Liste der ausgeschlossenen Währungen für die Zahlung StrukturParametertyp
stringmin: 4max: 20
Verfügbare Werte- Binance- BinanceP2P- Exmo- KucoinDefinition
Der Service, aus dem die Wechselkurse zur Konvertierung in der Rechnung angenommen werden.Parametertyp
stringDefinition
Der Händler, der die Anfrage stellt, stellt eine Verbindung zu einem Empfehlungsmittel per Code her.Sie sind beispielsweise eine Anwendung, die Rechnungen über die Kryptomus -API generiert und Ihre Kunden andere Geschäfte sind.
Sie geben in Ihrer Bewerbung ihre API -Schlüssel- und Händler -ID ein. Sie senden Anfragen mit ihren Anmeldeinformationen und übergeben Ihren Empfehlungscode.Daher werden Ihre Kunden zu Empfehlungen auf Ihrem Kryptomuskonto und Sie erhalten Einnahmen aus ihrem Umsatz.Parametertyp
integermin: -99max: 100Definition
Positive Zahlen:
Ermöglicht Ihnen einen Rabatt festzulegen.
Um einen Rabatt von 5% für die Zahlung festzulegen, sollten Sie einen Wert bestehen: 5Negative Zahlen:
Ermöglicht Ihnen, benutzerdefinierte zusätzliche Provision festzulegen.Um eine zusätzliche Kommission von 10% für die Zahlung festzulegen, sollten Sie einen Wert verabschieden: -10Der Rabattprozentsatz beim Erstellen einer Rechnung wird nur dann berücksichtigt, wenn die Rechnung eine bestimmte Kryptowährung hat.Parametertyp
booleanDefinition
Mit diesem Parameter können Sie die Lebensdauer aktualisieren und eine neue Adresse für die Rechnung abrufen, wenn die Lebensdauer abgelaufen ist.Dazu müssen Sie alle erforderlichen Parameter übergeben, und die Rechnung mit bestandenem Order_id wird aktualisiert.Nur address , payment_status und expired_at werden geändert. Unabhängig von den übergebenen Parametern werden keine anderen Felder geändert.
* - obligatorischer Parameter
Die Struktur von Währungen
Name | Definition |
---|---|
currency* | Währungscode |
network | Blockchain -Netzwerkcode |
Definition
WährungscodeDefinition
Blockchain -Netzwerkcode
* - obligatorischer Parameter
Die Struktur von except_currencies
Name | Definition |
---|---|
currency* | Währungscode |
network | Blockchain -Netzwerkcode |
Definition
WährungscodeDefinition
Blockchain -Netzwerkcode
* - obligatorischer Parameter
Beispiel anfordern
Im Folgenden finden Sie ein Beispielbeispiel mit der minimalen erforderlichen Anzahl von Parametern. In diesem Fall wird eine Rechnung mit dem Fiat -Währung USD erstellt. Auf der Zahlungsseite kann der Benutzer die Kryptowährung und das Netzwerk für die Zahlung dieser Rechnung auswählen.
curl https://api.cryptomus.com/v1/payment \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"amount": "15",
"currency": "USD",
"order_id": "1"
}'
KOPIERENAntwort
Antwortparameter
Name | Definition |
---|---|
uuid | Rechnung |
order_id | Bestell -ID in Ihrem System bestellen |
amount | Die Höhe der Rechnung |
payment_amount | Betrag vom Kunden bezahlt |
payer_amount | Der Betrag in zahler_currency , dass der Kunde zahlen muss, einschließlich eines Rabatts oder einer zusätzlichen Provision. |
discount_percent | Prozentsatz des Rabatts oder der zusätzlichen Provision, die in Anfrageparametern verabschiedet wurden |
discount | Tatsächliche Menge an Rabatt oder zusätzliche Provision in Kryptowährung.Wenn beispielsweise der Rechnungsbetrag 15 USDT und Rabatt_percent -5 beträgt, beträgt der Rabattwert -0,75dh amount + discount = payer_amount |
payer_currency | Die Währung, in der der Kunde die Zahlung leisten muss. |
currency | Rechnungswährungscode |
merchant_amount | Betrag in Krypto, der Ihrem Restbetrag gutgeschrieben wird. Wenn die Rechnungszahlung nicht angegeben ist, ist der Wert null. |
network | Blockchain -Netzwerkcode |
address | Brieftaschenadresse für die Zahlung |
from | Die Adresse der Brieftasche, aus der die Zahlung erfolgt wurde |
txid | Transaktion Hash |
payment_status | Zahlungsstatus Alle Zahlungsstatus |
url | URL -Zahlungsseite |
expired_at | Zeitstempel des Ablaufs der Rechnung |
is_final | Ob die Rechnung abgeschlossen ist.Wenn die Rechnung abgeschlossen ist, ist es unmöglich, eine Rechnung zu bezahlen (sie wird entweder bezahlt oder abgelaufen) |
additional_data | Weitere Informationen |
created_at | Schöpfungsdatum der Rechnung. Timezone ist UTC+3 |
updated_at | Letzte Rechnung aktualisiertes Datum. Timezone ist UTC+3 |
Definition
RechnungDefinition
Bestell -ID in Ihrem System bestellenDefinition
Die Höhe der RechnungDefinition
Betrag vom Kunden bezahltDefinition
Der Betrag in zahler_currency , dass der Kunde zahlen muss, einschließlich eines Rabatts oder einer zusätzlichen Provision.Definition
Prozentsatz des Rabatts oder der zusätzlichen Provision, die in Anfrageparametern verabschiedet wurdenDefinition
Tatsächliche Menge an Rabatt oder zusätzliche Provision in Kryptowährung.Wenn beispielsweise der Rechnungsbetrag 15 USDT und Rabatt_percent -5 beträgt, beträgt der Rabattwert -0,75dh amount + discount = payer_amountDefinition
Die Währung, in der der Kunde die Zahlung leisten muss.Definition
RechnungswährungscodeDefinition
Betrag in Krypto, der Ihrem Restbetrag gutgeschrieben wird. Wenn die Rechnungszahlung nicht angegeben ist, ist der Wert null.Definition
Blockchain -NetzwerkcodeDefinition
Brieftaschenadresse für die ZahlungDefinition
Die Adresse der Brieftasche, aus der die Zahlung erfolgt wurdeDefinition
Transaktion HashDefinition
Zahlungsstatus Alle ZahlungsstatusDefinition
URL -ZahlungsseiteDefinition
Zeitstempel des Ablaufs der RechnungDefinition
Ob die Rechnung abgeschlossen ist.Wenn die Rechnung abgeschlossen ist, ist es unmöglich, eine Rechnung zu bezahlen (sie wird entweder bezahlt oder abgelaufen)Definition
Weitere InformationenDefinition
Schöpfungsdatum der Rechnung. Timezone ist UTC+3Definition
Letzte Rechnung aktualisiertes Datum. Timezone ist UTC+3
Antwortbeispiel
1{
2 "state": 0,
3 "result": {
4 "uuid": "26109ba0-b05b-4ee0-93d1-fd62c822ce95",
5 "order_id": "1",
6 "amount": "15.00",
7 "payment_amount": null,
8 "payer_amount": null,
9 "discount_percent": null,
10 "discount": "0.00000000",
11 "payer_currency": null,
12 "currency": "USD",
13 "merchant_amount": null,
14 "network": null,
15 "address": null,
16 "from": null,
17 "txid": null,
18 "payment_status": "check",
19 "url": "https://pay.cryptomus.com/pay/26109ba0-b05b-4ee0-93d1-fd62c822ce95",
20 "expired_at": 1689098133,
21 "status": "check",
22 "is_final": false,
23 "additional_data": null,
24 "created_at": "2023-07-11T20:23:52+03:00",
25 "updated_at": "2023-07-11T21:24:17+03:00"
26 }
27}
KOPIERENMehr Beispiele
Fordern Sie Daten an, um eine Rechnung für 20 USDT im Tron -Netzwerk zu erstellen. Die Rechnung wird zum Zeitpunkt der Schöpfung eine Adresse haben.
1{
2 "amount": "20",
3 "currency": "USDT",
4 "order_id": "1",
5 "network": "tron"
6}
KOPIERENFordern Sie Daten an, um eine Rechnung für 25 USD zu erstellen und Clients zu ermöglichen, nur nach USDT in einem Netzwerk zu bezahlen.
1{
2 "amount": "25",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "USDT"
6}
KOPIERENFordern Sie Daten an, um eine Rechnung für 25 USD zu erstellen und Clients nur nach USDT im Tron Network zu bezahlen. Die Rechnung wird zum Zeitpunkt der Schöpfung eine Adresse haben.
1{
2 "amount": "25",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "USDT",
6 "network": "tron"
7}
KOPIERENFordern Sie Daten an, um eine Rechnung für 20 USDT zu erstellen und Kunden in allen verfügbaren Netzwerken zu bezahlen
1{
2 "amount": "20",
3 "currency": "USDT",
4 "order_id": "1"
5}
KOPIERENFordern Sie Daten an, um eine Rechnung für 20 USD zu erstellen und Kunden nur in Bitcoin zu bezahlen. Die Rechnung wird zum Zeitpunkt der Schöpfung eine Adresse haben.
1{
2 "amount": "20",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "BTC"
6}
KOPIERENFordern Sie Daten an, um eine Rechnung für 0,5 BTC zu erstellen und Clients nur in Bitcoin zu bezahlen. Die Rechnung wird zum Zeitpunkt der Schöpfung eine Adresse haben.
1{
2 "amount": "0.5",
3 "currency": "BTC",
4 "order_id": "1"
5}
KOPIERENMögliche Fehler
Validierungsfehler
Code : 422
Beispielantworten:
Wenn ein Parameter erforderlich ist und nicht übergeben wird:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}
KOPIERENWenn Sie den nicht unterstützten Netzwerkcode zur Verfügung gestellt haben
1{
2 "state": 1,
3 "message": "The network was not found"
4}
KOPIERENWenn wir den Währungscode nicht unterstützen, den Sie in Währung Parameter angegeben haben:
1{
2 "state": 1,
3 "message": "The currency was not found"
4}
KOPIERENWenn Ihre Zahlungen blockiert sind. In diesem Fall müssen Sie sich an den Support wenden.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}
KOPIERENWenn wir den Zahlungsdienst der Währung nicht finden, die in to_currency Parameter übergeben wurde:
1{
2 "state": 1,
3 "message": "Not found service to_currency"
4}
KOPIERENWenn versehentlich etwas passiert, wenn man in to_currency konvertiert wird:
1{
2 "state": 1,
3 "message": "Error convert to_currency"
4}
KOPIERENWenn der Zahlungsbetrag geringer ist als der minimal unterstützte Betrag für die Kryptowährung, erhalten Sie diese Fehlermeldung:
1{
2 "state": 1,
3 "message": "Minimum amount 0.5 USDT"
4}
KOPIERENWenn der Zahlungsbetrag größer als der maximal unterstützte Betrag für die Kryptowährung ist, erhalten Sie diese Fehlermeldung:
1{
2 "state": 1,
3 "message": "Maximum amount 10000000 USDT"
4}
KOPIERENWenn Sie keine aktive Händler -Brieftasche mit einer Kryptowährung der Zahlung haben, erhalten Sie diesen Fehler:
1{
2 "state": 1,
3 "message": "Wallet not found"
4}
KOPIERENWenn technische Arbeiten erfolgen und die Zahlung vorübergehend nicht verfügbar ist, können Sie diese Fehlermeldungen erhalten:
1{
2 "state": 1,
3 "message": "Gateway error"
4}
KOPIEREN
1{
2 "state": 1,
3 "message": "The terminal was not found"
4}
KOPIEREN
1{
2 "state": 1,
3 "message": "Server error"
4}
KOPIERENInterner Serverfehler
Code : 500
Beispielantworten:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}
KOPIEREN