Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

クレジット・カード情報を更新

patch

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}

リクエスト

パス・パラメータ

CreditCardPuid(required): string

クレジット・カードの公開一意識別子。
SubscriptionProductPuid(required): string

サブスクリプション製品の公開一意識別子。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

AddToBillingAccountFlag: boolean

パーティを請求アカウントとして追加できるかどうかを示します。
AuthorizedAmount: number

トランザクションが承認された金額。
AuthRequestId: string

カード承認リクエスト識別子。
CardHolderName: string

タイトル: Cardholder Name

クレジット・カード所有者の名前。
CreditCardPuid: string

最大長: 120

クレジット・カードの公開一意識別子。
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

クレジット・カード音声承認情報。

{
    "type":"object",
    "properties":{
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The unique identifier of the instrument assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the credit card.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The public unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            }
        },
        "RenewalCreditCardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes, if any, associated with the credit card.",
            "nullable":true
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : subscriptionProducts-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

クレジット・カードの公開一意識別子。
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

クレジット・カード音声承認情報。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the credit card was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CardIssuerName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the card issuer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The unique identifier of the instrument assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the credit card.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"The postal code of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true,
            "x-queryable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            },
            "x-queryable":true
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The public unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalCreditCardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditCardId":{
            "type":"integer",
            "description":"The unique identifier of the credit card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18,
                "SUPPORTS_RANGE_PAGING":"true"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes, if any, associated with the credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the credit card.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the credit card.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "CardBillingAddressId":{
            "type":"number",
            "description":"The ID of the card billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"The city of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine2":{
            "maxLength":255,
            "type":"string",
            "description":"The address line 2 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "maxLength":255,
            "type":"string",
            "description":"The address line 1 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"The state of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"The country of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the credit card was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the credit card.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、クレジット・カード詳細を含むサブスクリプション製品を更新する方法を示しています。

cURLコマンド

curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/PR_Credit_Card_2-PRDT-18097/child/creditCards/PR_Credit_Card_2-PRDT-18097-CCRD-12

リクエスト本文の例

次に、JSON形式のリクエスト本文の内容を示します。

{
    "TokenNumber": "9909000211126789",
    "ExpirationDate": "2024-01-01",
    "FirstName": "Ross",
    "LastName": "Dan",
    "IssuerCode": "VISA",
    "MaskedNumber": "XXXXXXXXXXXX4154"

}

レスポンス本文の例

次に、JSON形式のレスポンス本文の内容を示します。

{
    "CreditCardId": 300100592401250,
    "CreditCardPuid": "PR_Credit_Card_2-PRDT-18097-CCRD-12",
    "SubscriptionProductId": 300100592401246,
    "InstrAssignmentId": 151222,
    "Notes": null,
    "CreatedBy": "CONMGR",
    "CreationDate": "2021-02-11T19:19:01.361+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2021-02-11T19:23:55+00:00",
    "LastUpdateLogin": "BAF7C1159BEBCCBCE0531C5CF00AEC6C",
    "TokenNumber": "9909000211126789",
    "ExpirationDate": "2024-01-01",
    "FirstName": "Ross",
    "LastName": "Dan",
    "IssuerCode": "VISA",
    "MaskedNumber": "XXXXXXXXXXXX4154",
    "AuthRequestId": null,
    "VoiceAuthCode": null,
    "AuthorizedAmount": null,
    "PaymentSystemOrderNumber": null,
    "RenewalCreditCardFlag": null,
...
}

「トップに戻る」