クレジット・カードの作成
post
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards
リクエスト
パス・パラメータ
- SubscriptionNumber(required): string
サブスクリプションの代替識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
AddToBillingAccountFlag: boolean
パーティを請求アカウントとして追加できるかどうかを示します。
-
AuthorizedAmount: number
トランザクションが承認された金額。
-
AuthRequestId: string
カード承認リクエスト識別子。
-
CardHolderName: string
タイトル:
Cardholder Nameクレジット・カード所有者の名前。 -
CreditCardId: integer (int64)
クレジット・カードの一意の識別子。
-
CreditCardPuid: string
最大長:
120クレジット・カードPUID。 -
ExpirationDate: 文字列(日付)
処理に使用されるクレジット・カード有効期限。
-
FirstName: string
クレジット・カード所有者の名。
-
InstrAssignmentId: integer (int64)
タイトル:
Number割当の一意の識別子。 -
IssuerCode: string
クレジット・カード発行会社。
-
LastName: string
クレジット・カード所有者の姓。
-
MaskedNumber: string
マスクされたクレジット・カード番号。
-
Notes: string
タイトル:
Notes最大長:300クレジット・カードに関連付けられたノート。 -
PaymentSystemOrderNumber: string
クレジット・カード支払のオーダー番号。
-
RenewalCreditCardFlag: boolean
最大長:
1クレジット・カードが更改支払方法として使用されるかどうかを示します。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TokenNumber: string
処理に使用されるクレジット・カード・トークン番号。
-
VoiceAuthCode: string
クレジット・カード音声承認情報。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptions-creditCards-item-response
タイプ:
ソースを表示
object-
AddressLine1: string
読取り専用:
true最大長:255請求先住所の住所行1。 -
AddressLine2: string
読取り専用:
true最大長:255請求先住所の住所行2。 -
AddToBillingAccountFlag: boolean
パーティを請求アカウントとして追加できるかどうかを示します。
-
AuthorizedAmount: number
トランザクションが承認された金額。
-
AuthRequestId: string
カード承認リクエスト識別子。
-
CardBillingAddressId: number
読取り専用:
trueカード請求先住所のID。 -
CardHolderName: string
タイトル:
Cardholder Nameクレジット・カード所有者の名前。 -
CardIssuerName: string
読取り専用:
true最大長:255カード会社の名前。 -
City: string
読取り専用:
true最大長:255請求先住所の市区町村。 -
Country: string
読取り専用:
true最大長:255請求先住所の国。 -
CreatedBy: string
読取り専用:
true最大長:64レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
trueレコードが作成された日付。 -
CreditCardId: integer (int64)
クレジット・カードの一意の識別子。
-
CreditCardPuid: string
最大長:
120クレジット・カードPUID。 -
ExpirationDate: 文字列(日付)
処理に使用されるクレジット・カード有効期限。
-
FirstName: string
クレジット・カード所有者の名。
-
InstrAssignmentId: integer (int64)
タイトル:
Number割当の一意の識別子。 -
IssuerCode: string
クレジット・カード発行会社。
-
LastName: string
クレジット・カード所有者の姓。
-
LastUpdateDate: string (date-time)
読取り専用:
trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true最大長:64レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true最大長:32レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
MaskedNumber: string
マスクされたクレジット・カード番号。
-
Notes: string
タイトル:
Notes最大長:300クレジット・カードに関連付けられたノート。 -
PaymentSystemOrderNumber: string
クレジット・カード支払のオーダー番号。
-
PostalCode: string
読取り専用:
true最大長:255請求先住所の郵便番号。 -
RenewalCreditCardFlag: boolean
最大長:
1クレジット・カードが更改支払方法として使用されるかどうかを示します。 -
State: string
読取り専用:
true最大長:255請求先住所の状態。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionProductId: integer (int64)
サブスクリプション製品の一意の識別子。
-
TokenNumber: string
処理に使用されるクレジット・カード・トークン番号。
-
VoiceAuthCode: string
クレジット・カード音声承認情報。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object-
href: string
タイトル:
hyperlink reference関連リソースへのURI。 -
kind: string
タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 -
name: string
タイトル:
name関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、クレジット・カード詳細を含むサブスクリプションを作成する方法を示しています。
cURLコマンド
curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"BusinessUnitId":204,
"LegalEntityId":204,
"SubscriptionProfileId":300100172161474,
"SubscriptionNumber" :"PR_Credit_Card_1",
"PrimaryPartyId":1006,
"InvoicingRuleId": -2,
"BillingFrequency": "0zF",
"TransactionTypeName": "ORA_OSS_Invoice",
"Currency":"USD",
"StartDate":"2019-10-01",
"EndDate":"2019-12-31",
"DefinitionOrganizationId":204,
"ApprovalNote":"Test Note",
"ShortDescription":"",
"Description":"",
"BillToAccountId":1006,
"BillToSiteUseId":1025,
"PaymentMethod":"ORA_CREDIT_CARD",
"QuoteToContactId":2448,
"QuoteToCcEmail":"",
"CustomerAcceptance":"NOTREQUIRED",
"InternalApproval":"NOTREQUIRED",
"RenewalProcess":"MANUAL",
"PartialPeriodType": "ORA_ACTUAL",
"PartialPeriodStart": "ORA_SERVICE",
"AccountingRuleId": 300100033038413,
"PaymentTermsId": 1064,
"creditCards": [
{
"TokenNumber": "9909000272777999",
"ExpirationDate": "2021-12-31",
"FirstName": "Cooper",
"LastName": "Len",
"IssuerCode": "VISA",
"MaskedNumber": "XXXXXXXXXXXX5747"
}
],
"products":[
{
"LineNumber":"P1",
"InventoryItemId":300100167848146,
"ProductName":"QP_Item3",
"Quantity":1,
"GenerateBillingSchedule":"Y",
"charges":[
{
"ChargeDefinition":"USAGE_CHARGESPM",
"PriceType":"RECURRING",
"PricePeriodicity":"0zF",
"UnitListPrice":10,
"ChargeName":"USAGE SPM CHARGE",
"MeterDefinitionId":300100176337392
},
{
"ChargeDefinition":"ACTIVATIONFEE",
"PriceType":"ONE_TIME",
"UnitListPrice":2000,
"ChargeName":"Activation Fee"
},
{
"ChargeDefinition":"MONTHLYFEE",
"PriceType":"RECURRING",
"UnitListPrice":200,
"PricePeriodicity":"0zF",
"ChargeName":"Monthly Fee"
}
]
},
{
"LineNumber":"P2",
"ProductName":"Gold Support",
"Quantity":1,
"coveredLevels":[
{
"LineNumber":"01",
"Type" : "ORA_ASSET",
"AssetName":"QP_STD4_101",
"GenerateBillingSchedule":"Y",
"PriceUnitOfMeasureName": "YEAR",
"charges":[
{
"ChargeDefinition":"QP_SALE_PRICE",
"PriceType":"ONE_TIME",
"PricePeriodicity":"0zG",
"UnitListPrice":1000
},
{
"ChargeDefinition":"QP_RECURRING_SALE_PRICE",
"PriceType":"RECURRING",
"PricePeriodicity":"0zG",
"UnitListPrice":100
}
]
}
]
}
]
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"SubscriptionId": 300100592393512,
"SubscriptionNumber": "PR_Credit_Card_1",
"BusinessUnitId": 204,
"BusinessUnitName": "Vision Operations",
"LegalEntityId": 204,
"LegalEntityName": "Vision Operations",
"SubscriptionProfileId": 300100172161474,
"SubscriptionProfileName": "zOSS_SP_CalendarMonthActual_Advance_Month",
"PrimaryPartyId": 1006,
"PrimaryPartyName": "Computer Service and Rentals",
"PricedOnDate": "2021-02-11T00:00:00+00:00",
"PricingStrategyId": null,
"PricingStrategyExplanation": null,
"PricingSegment": null,
"PricingSegmentExplanation": null,
"SegmentExplanationMessage": null,
"Currency": "USD",
"CurrencyName": "US Dollar",
"CurrencyConversionRate": null,
"CurrencyConversionRateType": null,
"CurrencyConversionRateDate": null,
"StartDate": "2019-10-01",
"Duration": 1,
"Period": "0zF",
"EndDate": "2019-12-31",
"DefinitionOrganizationId": 204,
"DefinitionOrganizationName": "Vision Operations",
"PartialPeriodType": "ORA_ACTUAL",
"PartialPeriodStart": "ORA_CALENDAR",
"CloseReason": null,
"ClosedDate": null,
"CloseCreditMethod": null,
"ApprovalNote": "Test Note",
"CancelReason": null,
"CanceledDate": null,
"ApprovedDate": null,
"RenewedDate": null,
"ShortDescription": "",
"Description": "",
"Status": "ORA_DRAFT",
"UserStatus": null,
"BillService": "ORA_BILL",
"BillServiceName": "Bill",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zF",
"BillingFrequencyName": "QUARTER",
"AccountingRuleId": 300100033038413,
"AccountingRuleName": "3 Months, Deferred",
"TransactionTypeName": "ORA_OSS_Invoice",
"BillingSystem": null,
"SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
"CoverageInvoiceText": null,
"BillToAccountId": 1006,
"BillToAccountNumber": "1006",
"BillToAccountDescription": "Computer Service and Rentals",
"BillToSiteUseId": 1025,
"BillToAddress": "301 Summit Hill Drive, , CHATTANOOGA, TN 37401",
"ShipToParty": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToSite": null,
"PaymentMethod": "ORA_CREDIT_CARD",
"PaymentMethodName": "Credit card",
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"TaxClassificationCode": null,
"TaxClassificationMeaning": null,
"ExemptCertificateNumber": null,
"ExemptReason": null,
"ExemptReasonMeaning": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"DocumentFiscalClassification": null,
"CustomerAcceptance": "NOTREQUIRED",
"InternalApproval": "NOTREQUIRED",
"LayoutTemplate": null,
"CommunicationChannel": null,
"PrimarySalesPerson": null,
"NegotiationLanguage": null,
"QuoteToContactId": 2448,
"EnableRenewalRemindersFlag": null,
"RenewalProcess": "MANUAL",
"DaysBeforeExpiry": null,
"QuoteToCcEmail": "",
"RenewalPricingMethodUsed": null,
"RenewalProcessUsed": null,
"PriceAdjustmentPercentUsed": null,
"DaysBeforeExpiryUsed": null,
"AssigneeId": null,
"AssigneeType": null,
"TotalContractValue": null,
"EstimatedTax": null,
"CreditedAmount": null,
"ClosedAmount": null,
"CanceledAmount": null,
"InvoicedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"RenewalTemplateId": null,
"NotificationTemplateId": null,
"RenewalSubscriptionProfileId": null,
"DefaultLanguage": null,
"GenerateBillingSchedule": null,
"TransactionType": "ORA_SUBSCRIPTION",
"PricingSystem": "ORA_FUSION",
"PricingError": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"RenewalCustomerAcceptance": null,
"RenewalInternalApproval": null,
"RenewalPriceAdjustmentBasis": null,
"RenewalPriceAdjustmentPercent": null,
"RenewalPriceAdjustmentType": null,
"AttachmentEntityName": "OSS_DOC_SUBSCRIPTION_AGREEMENT",
"AttachmentEntityName1": "OSS_DOC_SUPPORTING_DOCUMENTS",
"CreatedBy": "CONMGR",
"CreationDate": "2021-02-11T19:06:36+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2021-02-11T19:06:37.664+00:00",
"LastUpdateLogin": "BB143FEE98D18EE8E0531C5CF00A450E",
"WarrantyYN": null,
"RenewalType": null,
"CustomerTrxTypeSequenceId": 806,
"UsageCapture": "ORA_THIRD_PARTY",
"LineAutonumberEnabledYn": false,
"RenewalPaymentMethod": null,
"RenewalPoNumber": null,
"RenewalWireNumber": null,
"RenewalPaymentMethodName": null,
"UserStatusName": null,
"RepriceFlag": null,
"products": [
{
"SubscriptionProductId": 300100592393516,
"SubscriptionId": 300100592393512,
"LineNumber": "P1",
"SubscriptionProductPuid": "PR_Credit_Card_1-PRDT-18094",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "PR_Credit_Card_1",
"SalesProductType": "SUBSCRIPTION",
"Description": "QP Item for SPT Subscription",
"InventoryItemId": 300100012368232,
"ItemUnitOfMeasure": "Ea",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-10-01",
"EndDate": "2019-12-31",
"CloseReason": null,
"CloseCreditMethod": null,
"CancelReason": null,
"ClosedDate": null,
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Status": "ORA_DRAFT",
"Currency": "USD",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zF",
"BillingFrequencyName": "QUARTER",
"AccountingRuleId": 300100033038413,
"AccountingRuleName": "3 Months, Deferred",
"TransactionTypeName": "ORA_OSS_Invoice",
"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
"BillToAccountId": 1006,
"BillToAccountNumber": "1006",
"BillToAccountDescription": "Computer Service and Rentals",
"BillToSiteUseId": 1025,
"BillToAddress": "301 Summit Hill Drive, , CHATTANOOGA, TN 37401",
"ShipToPartyId": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": "ORA_CREDIT_CARD",
"PaymentMethodName": "Credit card",
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"PrePaymentNumber": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"ExemptCertificateNumber": null,
"ExemptReason": null,
"OutputTaxClassification": null,
"ProductFiscClassification": null,
"TaxError": null,
"CoverageScheduleId": null,
"RenewalType": "RENEW",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"TotalContractValue": null,
"EstimatedTax": null,
"PricingError": null,
"PriceAsOf": "2021-02-11",
"PriceTransactionOn": "2021-02-11",
"InvoicedAmount": null,
"CreditedAmount": null,
"CanceledAmount": null,
"ClosedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": 1,
"Period": "0zF",
"GenerateBillingSchedule": "Y",
"ExternalAssetKey": null,
"ExternalParentAssetKey": null,
"ExternalPriceListId": null,
"ExternalRootAssetKey": null,
"PriceListName": null,
"NextPricingDate": null,
"PricingTermsStartDate": null,
"PricingTermsPricingMethod": null,
"PricingTermsPeriod": null,
"PricingTermsDuration": null,
"PricingTermsAdjustmentPCT": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"AmendCreditMethod": null,
"AmendCreditMethodName": null,
"AmendDescription": null,
"AmendEffectiveDate": null,
"AmendReason": null,
"AmendReasonName": null,
"StatusMeaning": "Draft",
"EnablePricingTermsFlag": null,
"NextBillStartDate": null,
"TaxClassificationMeaning": null,
"CreatedBy": "CONMGR",
"CreationDate": "2021-02-11T19:06:36.259+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2021-02-11T19:06:37.693+00:00",
"LastUpdateLogin": "BB143FEE98D18EE8E0531C5CF00A450E",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
"SuspendReason": null,
"SuspendedDate": null,
"SuspendCreditMethod": null,
"ResumeDate": null,
"ResumeDuration": null,
"ResumePeriod": null,
"AutoExtendFlag": null,
"ChurnProbability": null,
"EarlyTerminationPenalty": null,
"EarlyTerminationFee": null,
"GracePeriod": null,
"PenaltyValue": null,
"PenaltyChargeName": "Penalty Fee",
"EarlyTerminationPenaltyName": null,
"ChurnPredictionTrend": null,
"PriceAdjustmentType": null,
"PriceAdjustmentBasis": null,
"PriceAdjustmentPercent": null,
"DisplaySequence": null,
"RelatedInventoryItemId": null,
"RelatedProductName": null,
"ProductChangeReason": null,
"ProductChangeSchedule": null,
"ProductChangeScheduleFrom": null,
"DropOneTimeChargeFlag": null,
"RelatedProductDescription": null,
"GenerateBillFullPeriodFlag": null,
"RenewalPaymentMethod": null,
"RenewalPoNumber": null,
"RenewalWireNumber": null,
"RenewalPaymentMethodName": null,
"CustomerTrxTypeSequenceId": 806,
"RepriceFlag": null,
"AlignBillingFrom": null,
"PendingActivationFlag": null,
"charges": [
{
"BillLineId": null,
"ChargeDefinition": "USAGE_CHARGESPM",
"ChargeId": 300100592393517,
"ChargePuid": "PR_Credit_Card_1-PRDT-18094-CHRG-17127",
"CoveredLevelId": null,
"PrePaymentNumber": null,
"PricePeriodicity": "0zF",
"PriceType": "RECURRING",
"RollupFlag": false,
"SequenceNumber": null,
"SubscriptionId": 300100592393512,
"SubscriptionProductId": 300100592393516,
"ChargeName": "USAGE SPM CHARGE",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 10,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "QUARTER",
"ChargeDefinitionName": null,
"ServiceId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2021-02-11T19:06:36.362+00:00",
"LastUpdateDate": "2021-02-11T19:06:37.542+00:00",
"LastUpdateLogin": "BB143FEE98D18EE8E0531C5CF00A450E",
"LastUpdatedBy": "CONMGR",
"MeterDefinitionId": null,
"MeterId": null,
"InitialMeterReadingId": null,
"AggregationMethod": null,
"AssetMeterYn": null,
"TrueUpPeriod": "ORA_OSS_USAGE_BILLING_PERIOD",
"TrueUpPeriodName": "Billing period",
"EstimatedAmount": null,
"EstimatedMethodName": "None",
"EstimatedQuantity": null,
"EstimationMethod": "ORA_OSS_USAGE_EST_NONE",
"MinimumAmount": null,
"MinimumQuantity": null,
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"PeriodicBillingFlag": null,
...
}