54.5. プロデューサーエンドポイント:
プロデューサーエンドポイントは、エンドポイント接頭辞の後にエンドポイント名と次に説明する関連オプションを使用できます。一部のエンドポイントには省略形のエイリアスを使用できます。エンドポイント URI には接頭辞が含まれている必要があります。
必須ではないエンドポイントオプションは [] で示されます。エンドポイントに必須のオプションがない場合、[] オプションのセットの 1 つを提供する必要があります。プロデューサーエンドポイントは、特別なオプション inBody を使用することもできます。このオプションには、値が Camel Exchange In メッセージに含まれるエンドポイントオプションの名前が含まれている必要があります。
エンドポイントオプションは、エンドポイント URI またはメッセージヘッダーで動的に指定できます。メッセージヘッダー名は CamelBraintree.<option> の形式である必要があります。inBody オプションはメッセージヘッダーをオーバーライドすることに注意してください。つまり、エンドポイントオプション inBody=option は CamelBraintree.option ヘッダーをオーバーライドします。
エンドポイントとオプションの詳細は、https://developers.braintreepayments.com/reference/overview の Braintree のリファレンスを参照してください。
54.5.1. エンドポイント接頭辞 addOn
次のエンドポイントは、次のように接頭辞 addOn を使用して呼び出すことができます。
braintree://addOn/endpoint
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| all | List<com.braintreegateway.Addon> |
54.5.2. エンドポイント接頭辞 address
次のエンドポイントは、次のように接頭辞 address を使用して呼び出すことができます。
braintree://address/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| create | customerId, request | com.braintreegateway.Result<com.braintreegateway.Address> | |
| delete | customerId, id | com.braintreegateway.Result<com.braintreegateway.Address> | |
| find | customerId, id | com.braintreegateway.Address | |
| update | customerId, id, request | com.braintreegateway.Result<com.braintreegateway.Address> |
address の URI オプション
| 名前 | タイプ |
|---|---|
| customerId | String |
| request | com.braintreegateway.AddressRequest |
| id | String |
54.5.3. エンドポイント接頭辞 clientToken
次のエンドポイントは、次のように接頭辞 clientToken を使用して呼び出すことができます。
braintree://clientToken/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| generate | request | String |
clientToken の URI オプション
| 名前 | タイプ |
|---|---|
| request | com.braintreegateway.ClientTokenrequest |
54.5.4. エンドポイント接頭辞 creditCardVerification
次のエンドポイントは、次のように接頭辞 creditCardverification を使用して呼び出すことができます。
braintree://creditCardVerification/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| find | id | com.braintreegateway.CreditCardVerification | |
| search | query | com.braintreegateway.ResourceCollection<com.braintreegateway.CreditCardVerification> |
creditCardVerification の URI オプション
| 名前 | タイプ |
|---|---|
| id | String |
| query | com.braintreegateway.CreditCardVerificationSearchRequest |
54.5.5. エンドポイント接頭辞 customer
次のエンドポイントは、次のように接頭辞 customer を使用して呼び出すことができます。
braintree://customer/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| all | |||
| create | request | com.braintreegateway.Result<com.braintreegateway.Customer> | |
| delete | id | com.braintreegateway.Result<com.braintreegateway.Customer> | |
| find | id | com.braintreegateway.Customer | |
| search | query | com.braintreegateway.ResourceCollection<com.braintreegateway.Customer> | |
| update | id、request | com.braintreegateway.Result<com.braintreegateway.Customer> |
customer の URI オプション
| 名前 | タイプ |
|---|---|
| id | String |
| request | com.braintreegateway.CustomerRequest |
| query | com.braintreegateway.CustomerSearchRequest |
54.5.6. エンドポイント接頭辞 discount
次のエンドポイントは、次のように接頭辞 discount を使用して呼び出すことができます。
braintree://discount/endpoint
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| all |
| List<com.braintreegateway.Discount> |
+
+
54.5.7. エンドポイント接頭辞 dispute
次のエンドポイントは、次のように接頭辞の dispute で呼び出すことができます。
braintree://dispute/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| accept |
| id | com.braintreegateway.Result |
| addFileEvidence |
| disputeId, documentId | com.braintreegateway.Result<DisputeEvidence> |
| addFileEvidence |
| disputeId, fileEvidenceRequest | com.braintreegateway.Result<DisputeEvidence> |
| addTextEvidence |
| disputeId, content | com.braintreegateway.Result<DisputeEvidence> |
| addTextEvidence |
| disputeId, textEvidenceRequest | com.braintreegateway.Result<DisputeEvidence> |
| finalize |
| id | com.braintreegateway.Result |
| find |
| id | com.braintreegateway.Dispute |
| removeEvidence |
| id | com.braintreegateway.Result |
| search |
| disputeSearchRequest | com.braintreegateway.PaginatedCollection<com.braintreegateway.Dispute> |
dispute のための URI オプション
| 名前 | タイプ |
|---|---|
| id | String |
| disputeId | String |
| documentId | String |
| fileEvidenceRequest | com.braintreegateway.FileEvidenceRequest |
| content | String |
| textEvidenceRequest | |
| com.braintreegateway.TextEvidenceRequest | disputeSearchRequest |
54.5.8. エンドポイント接頭辞 documentUpload
次のエンドポイントは、次のように接頭辞 documentUpload で呼び出すことができます。
braintree://documentUpload/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| create |
| request | com.braintreegateway.Result<com.braintreegateway.DocumentUpload> |
documentUpload の URI オプション
| 名前 | タイプ |
|---|---|
| request | com.braintreegateway.DocumentUploadRequest |
54.5.9. エンドポイント接頭辞 merchantAccount
次のエンドポイントは、次のように接頭辞 merchantAccount で呼び出すことができます。
braintree://merchantAccount/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| create |
| request | com.braintreegateway.Result<com.braintreegateway.MerchantAccount> |
| createForCurrency | currencyRequest | com.braintreegateway.Result<com.braintreegateway.MerchantAccount> | |
| find |
| id | com.braintreegateway.MerchantAccount |
| update |
| id、request | com.braintreegateway.Result<com.braintreegateway.MerchantAccount> |
merchantAccount の URI オプション
| 名前 | タイプ |
|---|---|
| id | String |
| request | com.braintreegateway.MerchantAccountRequest |
| currencyRequest | com.braintreegateway.MerchantAccountCreateForCurrencyRequest |
54.5.10. エンドポイント接頭辞 paymentMethod
次のエンドポイントは、次のように paymentMethod 接頭辞を付けて呼び出すことができます。
braintree://paymentMethod/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| create |
| request | com.braintreegateway.Result<com.braintreegateway.PaymentMethod> |
| delete |
| token, deleteRequest | com.braintreegateway.Result<com.braintreegateway.PaymentMethod> |
| find |
| token | com.braintreegateway.PaymentMethod |
| update |
| token, request | com.braintreegateway.Result<com.braintreegateway.PaymentMethod> |
paymentMethod の URI オプション
| 名前 | タイプ |
|---|---|
| token | String |
| request | com.braintreegateway.PaymentMethodRequest |
| deleteRequest | com.braintreegateway.PaymentMethodDeleteRequest |
54.5.11. エンドポイント接頭辞 paymentMethodNonce
次のエンドポイントは、次のように接頭辞 paymentMethodNonce で呼び出すことができます。
braintree://paymentMethodNonce/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| create |
| paymentMethodToken | com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> |
| find |
| paymentMethodNonce | com.braintreegateway.PaymentMethodNonce |
paymentMethodNonce の URI オプション
| 名前 | タイプ |
|---|---|
| paymentMethodToken | String |
| paymentMethodNonce | String |
54.5.12. エンドポイント接頭辞 plan
次のエンドポイントは、次のように接頭辞 plan で呼び出すことができます。
braintree://plan/endpoint
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| all |
|
| List<com.braintreegateway.Plan> |
54.5.13. エンドポイント接頭辞 report
次のエンドポイントは、次のように接頭辞 report で呼び出すことができます。
braintree://plan/report?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| transactionLevelFees |
| request | com.braintreegateway.Result<com.braintreegateway.TransactionLevelFeeReport> |
report の URI オプション
| 名前 | タイプ |
|---|---|
| request | com.braintreegateway.TransactionLevelFeeReportRequest |
54.5.14. エンドポイント接頭辞 settlementBatchSummary
次のエンドポイントは、次のように、settlementBatchSummary 接頭辞を使用して呼び出すことができます。
braintree://settlementBatchSummary/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| generate |
| request | com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> |
settlementBatchSummary の URI オプション
| 名前 | タイプ |
|---|---|
| settlementDate | Calendar |
| groupByCustomField | String |
54.5.15. エンドポイント接頭辞 subscription
次のエンドポイントは、次のように接頭辞 subscription で呼び出すことができます。
braintree://subscription/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| cancel |
| id | com.braintreegateway.Result<com.braintreegateway.Subscription> |
| create |
| request | com.braintreegateway.Result<com.braintreegateway.Subscription> |
| delete |
| customerId, id | com.braintreegateway.Result<com.braintreegateway.Subscription> |
| find |
| id | com.braintreegateway.Subscription |
| retryCharge |
| subscriptionId, amount | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| search |
| searchRequest | com.braintreegateway.ResourceCollection<com.braintreegateway.Subscription> |
| update |
| id、request | com.braintreegateway.Result<com.braintreegateway.Subscription> |
subscription の URI オプション
| 名前 | タイプ |
|---|---|
| id | String |
| request | com.braintreegateway.SubscriptionRequest |
| customerId | String |
| subscriptionId | String |
| amount | BigDecimal |
| searchRequest | com.braintreegateway.SubscriptionSearchRequest. |
54.5.16. エンドポイント接頭辞 transaction
次のエンドポイントは、次のように接頭辞 transaction で呼び出すことができます。
braintree://transaction/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| cancelRelease |
| id | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| cloneTransaction |
| id, cloneRequest | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| credit |
| request | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| find |
| id | com.braintreegateway.Transaction |
| holdInEscrow |
| id | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| releaseFromEscrow |
| id | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| refund |
| id, amount, refundRequest | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| sale |
| request | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| search |
| query | com.braintreegateway.ResourceCollection<com.braintreegateway.Transaction> |
| submitForPartialSettlement |
| id, amount | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| submitForSettlement |
| id, amount, request | com.braintreegateway.Result<com.braintreegateway.Transaction> |
| voidTransaction |
| id | com.braintreegateway.Result<com.braintreegateway.Transaction> |
transaction の URI オプション
| 名前 | タイプ |
|---|---|
| id | String |
| request | com.braintreegateway.TransactionCloneRequest |
| cloneRequest | com.braintreegateway.TransactionCloneRequest |
| refundRequest | com.braintreegateway.TransactionRefundRequest |
| amount | BigDecimal |
| query | com.braintreegateway.TransactionSearchRequest |
54.5.17. エンドポイント接頭辞 webhookNotification
次のエンドポイントは、次のように接頭辞 webhookNotification で呼び出すことができます。
braintree://webhookNotification/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| parse |
| signature, payload | com.braintreegateway.WebhookNotification |
| verify |
| challenge | String |
webhookNotification の URI オプション
| 名前 | タイプ |
|---|---|
| signature | String |
| payload | String |
| challenge | String |
