請求書の作成

post
https://api.cryptomus.com/v1/payment
コピー

リクエスト

クエリパラメーター

名前パラメータータイプデフォルト値意味
amount*string支払われる金額。金額にペニーがある場合は、「セパレーター」で送ってください。
例:10.28
currency*string通貨コード
order_id*stringmin: 1max: 128alpha_dashシステムでIDを注文しますパラメーターは、アルファベット文字、数字、アンダースコア、およびダッシュで構成される文字列である必要があります。スペースや特殊文字を含めるべきではありません。 order_id は、商人の請求書/静的ウォレット/再発支払いの中で一意でなければなりません order_id を備えた既存の請求書が見つかった場合、その詳細を返します。新しい請求書は作成されません。
networkstringnullブロックチェーンネットワークコード
url_returnstringmin: 6max: 255urlnull支払う前に、ユーザーは支払いフォームのボタンをクリックして、このURLのストアページに戻ることができます。
url_successstringmin: 6max: 255urlnull支払いが成功した後、ユーザーは支払いフォームのボタンをクリックして、このURLに戻ることができます。
url_callbackstringmin: 6max: 255urlnull支払いステータスのWebhookが送信されるURL
is_payment_multiplebooleantrueユーザーが残りの金額を支払うことを許可されているかどうか。これは、ユーザーが1つのトランザクションに対して請求書の全額を支払っていない場合に役立ち、お客様が全額まで支払うことを許可したい場合があります。この機能を無効にすると、請求書は最初の支払いを受け取った後に最終決定され、残高に資金が受け取られます。
lifetimeintegermin: 300max: 432003600発行された請求書の寿命(秒単位)
to_currencystringこのパラメーターは、請求書の金額を変換するためのターゲット通貨を指定するために使用されます。請求書を作成するとき、金額と通貨を提供すると、APIはその金額をto_currencyの同等の値に変換します。たとえば、ビットコインで20 USDの請求書を作成するには:
amount:20
currency:usd
to_currency :btc
APIは、現在の為替レートに基づいて20米ドルをBTCの同等物に変換し、ユーザーはBTCで支払います to_currency は、常にフィアット通貨コードではなく、暗号通貨コードである必要があります。
subtractintegermin: 0max: 1000クライアントに請求された支払い委員会の割合1%のレートがある場合、Subtract = 100(クライアントが100%の手数料を支払う)で100 USDTの請求書を作成する場合、クライアントは101 USDTを支払う必要があります。
accuracy_payment_percentnumericmin: 0max: 50支払いにおける許容不正確。たとえば、値5を渡すと、クライアントが金額の95%しか支払っていない場合でも、請求書は支払われたものとしてマークされます。実際の支払い額は残高にクレジットされます
additional_datastringmax: 255nullあなたのための追加情報(クライアントには示されていません)
currenciesarray商人の設定から利用可能な通貨の配列が使用されます(パラメーターが設定されていない場合、すべてのサポートされている暗号通貨がデフォルトで使用されます)。利用可能な通貨は、マーチャント設定セクションに設定されています。支払いのための許可された通貨のリスト。これは、顧客が請求書を支払うために使用できるコインのリストを制限する場合に役立ちます。 構造
except_currenciesarraynull支払いのための除外された通貨のリスト 構造
course_sourcestringmin: 4max: 20利用可能な値BinanceBinanceP2PExmoKucoin合格しない場合、Cryptomusの為替レートが使用されます。請求書での変換のために為替レートが取られるサービス。
from_referral_codestringnullリクエストを行う商人は、コードごとにリファラーに接続します。たとえば、Cryptomus APIを介して請求書を生成するアプリケーションであり、顧客は他の店舗です。
アプリケーションにAPIキーとマーチャントIDを入力し、資格情報と紹介コードを渡すリクエストを送信します。
したがって、クライアントはCryptomusアカウントの紹介になり、売上高から収入を受け取ります。
discount_percentintegermin: -99max: 100null正の数:
では、割引を設定できます。
支払いのために5%の割引を設定するには、値を渡す必要があります:5
負の数:
では、カスタム追加の手数料を設定できます。
支払いのために10%の追加手数料を設定するには、値を渡す必要があります:-10請求書を作成する際の割引率は、請求書に特定の暗号通貨がある場合にのみ考慮されます。
is_refreshbooleanfalseこのパラメーターを使用して、寿命が期限切れになった場合、寿命を更新し、請求書の新しいアドレスを取得できます。そのためには、必要なすべてのパラメーターを渡す必要があり、渡されたOrder_idの請求書は更新されます。address payment_status expired_at が変更されます。渡されたパラメーターに関係なく、他のフィールドは変更されません。

パラメータータイプ

string

意味

支払われる金額。金額にペニーがある場合は、「セパレーター」で送ってください。
例:10.28

パラメータータイプ

string

意味

通貨コード

パラメータータイプ

stringmin: 1max: 128alpha_dash

意味

システムでIDを注文しますパラメーターは、アルファベット文字、数字、アンダースコア、およびダッシュで構成される文字列である必要があります。スペースや特殊文字を含めるべきではありません。 order_id は、商人の請求書/静的ウォレット/再発支払いの中で一意でなければなりません order_id を備えた既存の請求書が見つかった場合、その詳細を返します。新しい請求書は作成されません。

パラメータータイプ

string

意味

ブロックチェーンネットワークコード

パラメータータイプ

stringmin: 6max: 255url

意味

支払う前に、ユーザーは支払いフォームのボタンをクリックして、このURLのストアページに戻ることができます。

パラメータータイプ

stringmin: 6max: 255url

意味

支払いが成功した後、ユーザーは支払いフォームのボタンをクリックして、このURLに戻ることができます。

パラメータータイプ

stringmin: 6max: 255url

意味

支払いステータスのWebhookが送信されるURL

パラメータータイプ

boolean

意味

ユーザーが残りの金額を支払うことを許可されているかどうか。これは、ユーザーが1つのトランザクションに対して請求書の全額を支払っていない場合に役立ち、お客様が全額まで支払うことを許可したい場合があります。この機能を無効にすると、請求書は最初の支払いを受け取った後に最終決定され、残高に資金が受け取られます。

パラメータータイプ

integermin: 300max: 43200

意味

発行された請求書の寿命(秒単位)

パラメータータイプ

string

意味

このパラメーターは、請求書の金額を変換するためのターゲット通貨を指定するために使用されます。請求書を作成するとき、金額と通貨を提供すると、APIはその金額をto_currencyの同等の値に変換します。たとえば、ビットコインで20 USDの請求書を作成するには:
amount:20
currency:usd
to_currency :btc
APIは、現在の為替レートに基づいて20米ドルをBTCの同等物に変換し、ユーザーはBTCで支払います to_currency は、常にフィアット通貨コードではなく、暗号通貨コードである必要があります。

パラメータータイプ

integermin: 0max: 100

意味

クライアントに請求された支払い委員会の割合1%のレートがある場合、Subtract = 100(クライアントが100%の手数料を支払う)で100 USDTの請求書を作成する場合、クライアントは101 USDTを支払う必要があります。

パラメータータイプ

numericmin: 0max: 5

意味

支払いにおける許容不正確。たとえば、値5を渡すと、クライアントが金額の95%しか支払っていない場合でも、請求書は支払われたものとしてマークされます。実際の支払い額は残高にクレジットされます

パラメータータイプ

stringmax: 255

意味

あなたのための追加情報(クライアントには示されていません)

パラメータータイプ

array

意味

支払いのための許可された通貨のリスト。これは、顧客が請求書を支払うために使用できるコインのリストを制限する場合に役立ちます。 構造

パラメータータイプ

array

意味

支払いのための除外された通貨のリスト 構造

パラメータータイプ

stringmin: 4max: 20
利用可能な値
- Binance- BinanceP2P- Exmo- Kucoin

意味

請求書での変換のために為替レートが取られるサービス。

パラメータータイプ

string

意味

リクエストを行う商人は、コードごとにリファラーに接続します。たとえば、Cryptomus APIを介して請求書を生成するアプリケーションであり、顧客は他の店舗です。
アプリケーションにAPIキーとマーチャントIDを入力し、資格情報と紹介コードを渡すリクエストを送信します。
したがって、クライアントはCryptomusアカウントの紹介になり、売上高から収入を受け取ります。

パラメータータイプ

integermin: -99max: 100

意味

正の数:
では、割引を設定できます。
支払いのために5%の割引を設定するには、値を渡す必要があります:5
負の数:
では、カスタム追加の手数料を設定できます。
支払いのために10%の追加手数料を設定するには、値を渡す必要があります:-10請求書を作成する際の割引率は、請求書に特定の暗号通貨がある場合にのみ考慮されます。

パラメータータイプ

boolean

意味

このパラメーターを使用して、寿命が期限切れになった場合、寿命を更新し、請求書の新しいアドレスを取得できます。そのためには、必要なすべてのパラメーターを渡す必要があり、渡されたOrder_idの請求書は更新されます。address payment_status expired_at が変更されます。渡されたパラメーターに関係なく、他のフィールドは変更されません。

* - 必須パラメーター

の構造 通貨

名前意味
currency*通貨コード
networkブロックチェーンネットワークコード

意味

通貨コード

意味

ブロックチェーンネットワークコード

* - 必須パラメーター

の構造 except_currencies

名前意味
currency*通貨コード
networkブロックチェーンネットワークコード

意味

通貨コード

意味

ブロックチェーンネットワークコード

* - 必須パラメーター

請求書は、通貨またはto_currencyパラメーターが暗号通貨であり、ネットワークパラメーターが渡される場合にのみ、作成時に特定の暗号通貨と住所を持ちます(または、暗号通貨には1つのネットワーク、たとえばBTCのみ)。

リクエスト例

以下は、必要なパラメーターの最小数のサンプル例です。この場合、請求書はFiat Currency USDで作成されます。支払いページで、ユーザーは暗号通貨とネットワークを選択してこの請求書を支払うことができます。


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"
}'
コピー

応答

応答パラメーター

名前意味
uuid請求書UUID
order_idシステムでIDを注文します
amount請求書の金額
payment_amountクライアントが支払う金額
payer_amount割引または追加手数料を含む、顧客が支払わなければならない payer_currency の金額。
discount_percent要求パラメーターで渡された割引または追加手数料の割合
discount暗号通貨での実際の割引または追加手数料。たとえば、請求書の金額が15 USDTで、割引_percentが-5の場合、割引値は-0.75になりますつまり、amount + discount = payer_amount
payer_currency顧客が支払いをしなければならない通貨。
currency請求書通貨コード
merchant_amountあなたの残高にクレジットされる暗号の金額。請求書payer_currencyが指定されていない場合、値はnullになります。
networkブロックチェーンネットワークコード
address支払いのためのウォレットアドレス
from支払いが行われたウォレットの住所
txidトランザクションハッシュ
payment_status支払い状況 すべての支払いステータス
urlURL支払いページ
expired_at請求書の満了のタイムスタンプ
is_final請求書が確定しているかどうか。請求書が確定した場合、請求書を支払うことは不可能です(支払いまたは期限切れのいずれか)
additional_data追加情報
created_at請求書の作成日。タイムゾーンはUTC+3です
updated_at最後の請求書更新日。タイムゾーンはUTC+3です

意味

請求書UUID

意味

システムでIDを注文します

意味

請求書の金額

意味

クライアントが支払う金額

意味

割引または追加手数料を含む、顧客が支払わなければならない payer_currency の金額。

意味

要求パラメーターで渡された割引または追加手数料の割合

意味

暗号通貨での実際の割引または追加手数料。たとえば、請求書の金額が15 USDTで、割引_percentが-5の場合、割引値は-0.75になりますつまり、amount + discount = payer_amount

意味

顧客が支払いをしなければならない通貨。

意味

請求書通貨コード

意味

あなたの残高にクレジットされる暗号の金額。請求書payer_currencyが指定されていない場合、値はnullになります。

意味

ブロックチェーンネットワークコード

意味

支払いのためのウォレットアドレス

意味

支払いが行われたウォレットの住所

意味

トランザクションハッシュ

意味

支払い状況 すべての支払いステータス

意味

URL支払いページ

意味

請求書の満了のタイムスタンプ

意味

請求書が確定しているかどうか。請求書が確定した場合、請求書を支払うことは不可能です(支払いまたは期限切れのいずれか)

意味

追加情報

意味

請求書の作成日。タイムゾーンはUTC+3です

意味

最後の請求書更新日。タイムゾーンはUTC+3です

応答の例


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}
コピー

その他の例

データをリクエストして、Tron Networkで20 USDTの請求書を作成します。請求書には、作成時に住所があります。


1{
2	"amount": "20",
3	"currency": "USDT",
4	"order_id": "1",
5	"network": "tron"
6}
コピー

データをリクエストして、25米ドルの請求書を作成し、クライアントが任意のネットワーク内のUSDTのみでのみ支払うことができます。


1{
2	"amount": "25",
3	"currency": "USD",
4	"order_id": "1",
5	"to_currency": "USDT"
6}
コピー

データをリクエストして、25 USDの請求書を作成し、クライアントがTronネットワークのUSDTのみでのみ支払うことができます。請求書には、作成時に住所があります。


1{
2	"amount": "25",
3	"currency": "USD",
4	"order_id": "1",
5	"to_currency": "USDT",
6	"network": "tron"
7}
コピー

20 USDTの請求書を作成するためのデータをリクエストし、クライアントが利用可能なすべてのネットワークで支払うことを許可します


1{
2	"amount": "20",
3	"currency": "USDT",
4	"order_id": "1"
5}
コピー

データをリクエストして、20米ドルの請求書を作成し、クライアントがビットコインのみで支払うことができるようにします。請求書には、作成時に住所があります。


1{
2	"amount": "20",
3	"currency": "USD",
4	"order_id": "1",
5	"to_currency": "BTC"
6}
コピー

データをリクエストして、0.5 BTCの請求書を作成し、クライアントがビットコインのみで支払うことができるようにします。請求書には、作成時に住所があります。


1{
2	"amount": "0.5",
3	"currency": "BTC",
4	"order_id": "1"
5}
コピー

可能なエラー

検証エラー

コード : 422

回答の例:

何らかのパラメーターが必要で、渡されない場合:


1{
2	"state": 1,
3	"errors": {
4		"amount": ["validation.required"]
5	}
6}
コピー

サポートされていないネットワークコードを提供した場合


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

通貨コードをサポートしていない場合は、通貨パラメーターで提供されています。


1{
2    "state": 1,
3    "message": "The currency was not found"
4}
コピー

支払いがブロックされている場合。この場合、サポートに連絡する必要があります。


1{
2    "state": 1,
3    "message": "You are forbidden"
4}
コピー

to_currency パラメーターで渡された通貨の支払いサービスが見つからない場合:


1{
2    "state": 1,
3    "message": "Not found service to_currency"
4}
コピー

誤って何かが発生した場合、 to_currency に変換するとき:


1{
2    "state": 1,
3    "message": "Error convert to_currency"
4}
コピー

支払い額が暗号通貨の最低サポート額より少ない場合、このエラーメッセージを受け取ります。


1{
2    "state": 1,
3    "message": "Minimum amount 0.5 USDT"
4}
コピー

支払い額が暗号通貨の最大サポート額よりも大きい場合、このエラーメッセージを受け取ります。


1{
2    "state": 1,
3    "message": "Maximum amount 10000000 USDT"
4}
コピー

支払いの暗号通貨を備えたアクティブなマーチャントウォレットがない場合は、このエラーを受け取ります。


1{
2    "state": 1,
3    "message": "Wallet not found"
4}
コピー

技術作業が発生し、支払いが一時的に利用できない場合、このエラーメッセージを受信できます。


1{
2    "state": 1,
3    "message": "Gateway error"
4}
コピー


1{
2    "state": 1,
3    "message": "The terminal was not found"
4}
コピー


1{
2    "state": 1,
3    "message": "Server error"
4}
コピー

内部サーバーエラー

コード : 500

回答の例:


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