---
title: "Create a stored credential profile"
method: POST
path: "/v1/payment-methods/{payment-method-id}/profiles"
tags: ["Payment Methods"]
---

# Create a stored credential profile

`POST /v1/payment-methods/{payment-method-id}/profiles`

Creates a stored credential profile within a payment method.

The stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in a transaction, Zuora may include information from the stored credential profile to inform the payment processor that the transaction is related to your pre-existing consent agreement with the customer.

## Path parameters

- `payment-method-id` string, required

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- CreateStoredCredentialProfileRequest
  - `action` 'Activate' | 'Persist' — Specifies how Zuora activates the stored credential profile. Only applicable if you set the `status` field to `Active`. - `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.
  - `agreedOn` string, date — The date on which the profile is agreed. The date format is `yyyy-mm-dd`.
  - `authGateway` string — Specifies the ID of the payment gateway that Zuora will use when activating the stored credential profile.
  - `cardSecurityCode` string — The security code of the credit card.
  - `consentAgreementRef` string — Specifies your reference for the consent agreement that you have established with the customer.
  - `consentAgreementSrc` 'External', required — Specifies how the consent agreement has been established with the customer. The allowed value is `External`.
  - `networkTransactionId` string — The ID of a network transaction. Only applicable if you set the `action` field to `Persist`.
  - `status` 'Agreed' | 'Active', required — Specifies the status of the stored credential profile. - `Active` - Use this value if you are creating the stored credential profile after receiving the customer's consent, or if the stored credential profile represents a stored credential profile in an external system. You can use the `action` field to specify how Zuora activates the stored credential profile. - `Agreed` - Use this value if you are migrating the payment method to the stored credential transaction framework. In this case, Zuora will not send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile.
  - `type` 'Recurring' | 'Unscheduled', required — Indicates the type of the stored credential profile to process recurring or unsecheduled transactions.

## Response `200`

OK

- ModifiedStoredCredentialProfileResponse
  - `number` integer — The number that identifies the stored credential profile within the payment method.
  - `paymentMethodId` string — ID of the payment method.
  - `success` boolean

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)