Update a credit card
patch
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}
Request
Path Parameters
-
CreditCardPuid(required): string
The public unique identifier of the credit card.
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AddToBillingAccountFlag: boolean
Indicates whether the party can be added as a billing account.
-
AuthorizedAmount: number
The amount the transaction was authorized for.
-
AuthRequestId: string
The card authorization request identifier.
-
CardHolderName: string
Title:
Cardholder Name
The name of the credit card holder. -
CreditCardPuid: string
Maximum Length:
120
The public unique identifier of the credit card. -
ExpirationDate: string
(date)
The credit card expiration date used for processing.
-
FirstName: string
The first name of the credit card holder.
-
InstrAssignmentId: integer
(int64)
Title:
Number
The unique identifier of the instrument assignment. -
IssuerCode: string
The credit card issuing company.
-
LastName: string
The last name of the credit card holder.
-
MaskedNumber: string
The masked credit card number.
-
Notes: string
Title:
Notes
Maximum Length:300
The notes, if any, associated with the credit card. -
PaymentSystemOrderNumber: string
The order number for the credit card payment.
-
RenewalCreditCardFlag: boolean
Maximum Length:
1
Indicates whether the credit card is used as Renewal Payment Method. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The public unique identifier of the subscription product.
-
TokenNumber: string
The credit card token number used for processing.
-
VoiceAuthCode: string
The credit card voice authorization information.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionProducts-creditCards-item-response
Type:
Show Source
object
-
AddressLine1: string
Read Only:
true
Maximum Length:255
The address line 1 of the billing address. -
AddressLine2: string
Read Only:
true
Maximum Length:255
The address line 2 of the billing address. -
AddToBillingAccountFlag: boolean
Indicates whether the party can be added as a billing account.
-
AuthorizedAmount: number
The amount the transaction was authorized for.
-
AuthRequestId: string
The card authorization request identifier.
-
CardBillingAddressId: number
Read Only:
true
The ID of the card billing address. -
CardHolderName: string
Title:
Cardholder Name
The name of the credit card holder. -
CardIssuerName: string
Read Only:
true
Maximum Length:255
The name of the card issuer. -
City: string
Read Only:
true
Maximum Length:255
The city of the billing address. -
Country: string
Read Only:
true
Maximum Length:255
The country of the billing address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the credit card. -
CreationDate: string
(date-time)
Read Only:
true
The date when the credit card was created. -
CreditCardId: integer
(int64)
The unique identifier of the credit card.
-
CreditCardPuid: string
Maximum Length:
120
The public unique identifier of the credit card. -
ExpirationDate: string
(date)
The credit card expiration date used for processing.
-
FirstName: string
The first name of the credit card holder.
-
InstrAssignmentId: integer
(int64)
Title:
Number
The unique identifier of the instrument assignment. -
IssuerCode: string
The credit card issuing company.
-
LastName: string
The last name of the credit card holder.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the credit card was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the credit card. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the credit card. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaskedNumber: string
The masked credit card number.
-
Notes: string
Title:
Notes
Maximum Length:300
The notes, if any, associated with the credit card. -
PaymentSystemOrderNumber: string
The order number for the credit card payment.
-
PostalCode: string
Read Only:
true
Maximum Length:255
The postal code of the billing address. -
RenewalCreditCardFlag: boolean
Maximum Length:
1
Indicates whether the credit card is used as Renewal Payment Method. -
State: string
Read Only:
true
Maximum Length:255
The state of the billing address. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The public unique identifier of the subscription product.
-
TokenNumber: string
The credit card token number used for processing.
-
VoiceAuthCode: string
The credit card voice authorization information.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to update a subscription product with credit card details by submitting a PATCH request on the REST resource using cURL.
cURL Command
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
Example of Request Body
The following shows the contents of the request body in JSON format.
{ "TokenNumber": "9909000211126789", "ExpirationDate": "2024-01-01", "FirstName": "Ross", "LastName": "Dan", "IssuerCode": "VISA", "MaskedNumber": "XXXXXXXXXXXX4154" }
Example of Response Body
The following shows the contents of the response body in JSON format.
{ "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, ... }