Erstellen einer Rechnung

post
https://api.cryptomus.com/v1/payment
KOPIEREN

Anfrage

Abfrageparameter

NameParametertypStandardwertDefinition
amount*stringZu bezahlende Summe.Wenn der Betrag Pennys enthalten, senden Sie sie mit einem Separator '.'
Beispiel: 10.28
currency*stringWährungscode
order_id*stringmin: 1max: 128alpha_dashBestell -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.
networkstringnullBlockchain -Netzwerkcode
url_returnstringmin: 6max: 255urlnullVor der Zahlung kann der Benutzer auf die Schaltfläche im Zahlungsformular klicken und in dieser URL zur Store -Seite zurückkehren.
url_successstringmin: 6max: 255urlnullNach erfolgreicher Zahlung kann der Benutzer im Zahlungsformular auf die Schaltfläche klicken und zu dieser URL zurückkehren.
url_callbackstringmin: 6max: 255urlnullURL, an die Webhooks mit Zahlungsstatus gesendet werden
is_payment_multiplebooleantrueOb 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.
lifetimeintegermin: 300max: 432003600Die Lebensdauer der ausgestellten Rechnung (in Sekunden)
to_currencystringDer 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 : btc
Die 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.
subtractintegermin: 0max: 1000Prozentsatz 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_percentnumericmin: 0max: 50Akzeptable 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_datastringmax: 255nullZusätzliche Informationen für Sie (nicht dem Kunden angezeigt)
currenciesarrayDie 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_currenciesarraynullListe der ausgeschlossenen Währungen für die Zahlung Struktur
course_sourcestringmin: 4max: 20Verfügbare WerteBinanceBinanceP2PExmoKucoinWenn nicht bestanden, werden Kryptomus -Wechselkurse verwendet.Der Service, aus dem die Wechselkurse zur Konvertierung in der Rechnung angenommen werden.
from_referral_codestringnullDer 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_percentintegermin: -99max: 100nullPositive Zahlen:
Ermöglicht Ihnen einen Rabatt festzulegen.
Um einen Rabatt von 5% für die Zahlung festzulegen, sollten Sie einen Wert bestehen: 5
Negative 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_refreshbooleanfalseMit 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

string

Definition

Zu bezahlende Summe.Wenn der Betrag Pennys enthalten, senden Sie sie mit einem Separator '.'
Beispiel: 10.28

Parametertyp

string

Definition

Währungscode

Parametertyp

stringmin: 1max: 128alpha_dash

Definition

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

string

Definition

Blockchain -Netzwerkcode

Parametertyp

stringmin: 6max: 255url

Definition

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: 255url

Definition

Nach erfolgreicher Zahlung kann der Benutzer im Zahlungsformular auf die Schaltfläche klicken und zu dieser URL zurückkehren.

Parametertyp

stringmin: 6max: 255url

Definition

URL, an die Webhooks mit Zahlungsstatus gesendet werden

Parametertyp

boolean

Definition

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: 43200

Definition

Die Lebensdauer der ausgestellten Rechnung (in Sekunden)

Parametertyp

string

Definition

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 : btc
Die 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: 100

Definition

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: 5

Definition

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

Parametertyp

stringmax: 255

Definition

Zusätzliche Informationen für Sie (nicht dem Kunden angezeigt)

Parametertyp

array

Definition

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

Parametertyp

array

Definition

Liste der ausgeschlossenen Währungen für die Zahlung Struktur

Parametertyp

stringmin: 4max: 20
Verfügbare Werte
- Binance- BinanceP2P- Exmo- Kucoin

Definition

Der Service, aus dem die Wechselkurse zur Konvertierung in der Rechnung angenommen werden.

Parametertyp

string

Definition

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: 100

Definition

Positive Zahlen:
Ermöglicht Ihnen einen Rabatt festzulegen.
Um einen Rabatt von 5% für die Zahlung festzulegen, sollten Sie einen Wert bestehen: 5
Negative 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

boolean

Definition

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

NameDefinition
currency*Währungscode
networkBlockchain -Netzwerkcode

Definition

Währungscode

Definition

Blockchain -Netzwerkcode

* - obligatorischer Parameter

Die Struktur von except_currencies

NameDefinition
currency*Währungscode
networkBlockchain -Netzwerkcode

Definition

Währungscode

Definition

Blockchain -Netzwerkcode

* - obligatorischer Parameter

Die Rechnung hat zum Zeitpunkt der Erstellung eine bestimmte Kryptowährung und Adresse nur dann, wenn der Währungsparameter Währung oder to_currency eine Kryptowährung ist und der Netzwerkparameter übergeben wird (oder eine Kryptowährung hat nur ein Netzwerk, z. B. BTC).

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"
}'
KOPIEREN

Antwort

Antwortparameter

NameDefinition
uuidRechnung
order_idBestell -ID in Ihrem System bestellen
amountDie Höhe der Rechnung
payment_amountBetrag vom Kunden bezahlt
payer_amountDer Betrag in zahler_currency , dass der Kunde zahlen muss, einschließlich eines Rabatts oder einer zusätzlichen Provision.
discount_percentProzentsatz des Rabatts oder der zusätzlichen Provision, die in Anfrageparametern verabschiedet wurden
discountTatsä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_currencyDie Währung, in der der Kunde die Zahlung leisten muss.
currencyRechnungswährungscode
merchant_amountBetrag in Krypto, der Ihrem Restbetrag gutgeschrieben wird. Wenn die Rechnungszahlung nicht angegeben ist, ist der Wert null.
networkBlockchain -Netzwerkcode
addressBrieftaschenadresse für die Zahlung
fromDie Adresse der Brieftasche, aus der die Zahlung erfolgt wurde
txidTransaktion Hash
payment_statusZahlungsstatus Alle Zahlungsstatus
urlURL -Zahlungsseite
expired_atZeitstempel des Ablaufs der Rechnung
is_finalOb die Rechnung abgeschlossen ist.Wenn die Rechnung abgeschlossen ist, ist es unmöglich, eine Rechnung zu bezahlen (sie wird entweder bezahlt oder abgelaufen)
additional_dataWeitere Informationen
created_atSchöpfungsdatum der Rechnung. Timezone ist UTC+3
updated_atLetzte Rechnung aktualisiertes Datum. Timezone ist UTC+3

Definition

Rechnung

Definition

Bestell -ID in Ihrem System bestellen

Definition

Die Höhe der Rechnung

Definition

Betrag vom Kunden bezahlt

Definition

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 wurden

Definition

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

Definition

Die Währung, in der der Kunde die Zahlung leisten muss.

Definition

Rechnungswährungscode

Definition

Betrag in Krypto, der Ihrem Restbetrag gutgeschrieben wird. Wenn die Rechnungszahlung nicht angegeben ist, ist der Wert null.

Definition

Blockchain -Netzwerkcode

Definition

Brieftaschenadresse für die Zahlung

Definition

Die Adresse der Brieftasche, aus der die Zahlung erfolgt wurde

Definition

Transaktion Hash

Definition

Zahlungsstatus Alle Zahlungsstatus

Definition

URL -Zahlungsseite

Definition

Zeitstempel des Ablaufs der Rechnung

Definition

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 Informationen

Definition

Schöpfungsdatum der Rechnung. Timezone ist UTC+3

Definition

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}
KOPIEREN

Mehr 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}
KOPIEREN

Fordern 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}
KOPIEREN

Fordern 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}
KOPIEREN

Fordern 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}
KOPIEREN

Fordern 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}
KOPIEREN

Fordern 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}
KOPIEREN

Mö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}
KOPIEREN

Wenn Sie den nicht unterstützten Netzwerkcode zur Verfügung gestellt haben


1{
2    "state": 1,
3    "message": "The network was not found"
4}
KOPIEREN

Wenn 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}
KOPIEREN

Wenn 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}
KOPIEREN

Wenn 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}
KOPIEREN

Wenn versehentlich etwas passiert, wenn man in to_currency konvertiert wird:


1{
2    "state": 1,
3    "message": "Error convert to_currency"
4}
KOPIEREN

Wenn 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}
KOPIEREN

Wenn 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}
KOPIEREN

Wenn 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}
KOPIEREN

Wenn 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}
KOPIEREN

Interner Serverfehler

Code : 500

Beispielantworten:


1{
2	"message": "Server error, #1",
3	"code": 500,
4	"error": null
5}
KOPIEREN