# Payment card created

Endpoint: POST payment-card-created
Version: latest
Security: SecretApiKey, JWT

## Security:

  - `SecretApiKey` (unknown)
    apiKey in header REB-APIKEY

  - `JWT` (unknown)
    http bearer JWT

## Request body:

  - `application/json` (unknown)
    Payload of payment card-related webhook event.

## Request fields (application/json):

  - `paymentCardId` (string)
    ID of the payment instrument.

  - `eventType` (string)
    Type of event that triggered the webhook.
    Enum: "payment-card-created", "payment-card-expiration-reminder", "payment-card-expired"

  - `_embedded` (object)
    Embedded objects related to the payment card event.

  - `_embedded.paymentCard` (object)
    Payment card information.

  - `_embedded.paymentCard.customerId` (string)
    ID of the customer resource.
    Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF

  - `_embedded.paymentCard.status` (string)
    Status of the payment instrument.
An `active` status means that a payment instrument has been used at least once for an approved transaction.
To remove an instrument from use, set this value to `deactivated`.
For more information, see [Deactivate a payment instrument](./PostPaymentInstrumentDeactivation).
    Enum: "active", "inactive", "expired", "deactivated", "verification-needed"

  - `_embedded.paymentCard.pan` (string)
    Primary Account Number (PAN) of the payment card.

  - `_embedded.paymentCard.expYear` (integer)
    Expiration year of the payment card.

  - `_embedded.paymentCard.expMonth` (integer)
    Expiration month of the payment card.

  - `_embedded.paymentCard.cvv` (string)
    Card Verification Value (CVV) of the payment card.

  - `_embedded.paymentCard.brand` (string)
    Brand of payment card.
    Enum: "Visa", "MasterCard", "American Express", "Discover", "Maestro", "Solo", "Electron", "JCB", "Voyager", "Diners Club", "Switch", "Laser", "China UnionPay", "AstroPay Card"

  - `_embedded.paymentCard.billingAddress` (object)
    Contact's information.

  - `_embedded.paymentCard.billingAddress.firstName` (string | null)
    Contact's first name.
    Example: Benjamin

  - `_embedded.paymentCard.billingAddress.lastName` (string | null)
    Contact's last name.
    Example: Franklin

  - `_embedded.paymentCard.billingAddress.organization` (string | null)
    Contact's organization.
    Example: Rebilly

  - `_embedded.paymentCard.billingAddress.address` (string | null)
    First line of the contact's street address.
    Example: 36 Craven St

  - `_embedded.paymentCard.billingAddress.address2` (string | null)
    Second line of the contact's street address.

  - `_embedded.paymentCard.billingAddress.city` (string | null)
    Contact's city of residence.
    Example: Austin

  - `_embedded.paymentCard.billingAddress.region` (string | null)
    Contact's region of residence.
    Example: Texas

  - `_embedded.paymentCard.billingAddress.country` (string | null)
    Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
    Example: GB

  - `_embedded.paymentCard.billingAddress.postalCode` (string | null)
    Contact's postal code.
    Example: WC2N 5NF

  - `_embedded.paymentCard.billingAddress.phoneNumbers` (array)
    List of phone numbers associated with the contact.

  - `_embedded.paymentCard.billingAddress.phoneNumbers.label` (string, required)
    Phone number label or name.
    Example: main

  - `_embedded.paymentCard.billingAddress.phoneNumbers.value` (string, required)
    Phone number value.
    Example: 1-512-777-0269

  - `_embedded.paymentCard.billingAddress.phoneNumbers.primary` (boolean)
    Specifies if the phone number is the contact's primary phone number.
    Example: true

  - `_embedded.paymentCard.billingAddress.emails` (array)
    List of email addresses associated with the contact.

  - `_embedded.paymentCard.billingAddress.emails.label` (string, required)
    Email label or name.
    Example: main

  - `_embedded.paymentCard.billingAddress.emails.value` (string, required)
    Email address value.
    Example: rebilly@example.com

  - `_embedded.paymentCard.billingAddress.emails.primary` (boolean)
    Specifies if the email address is the contact's primary email address.
    Example: true

  - `_embedded.paymentCard.billingAddress.dob` (string | null)
    Contact's date of birth in ISO-8601 `YYYY-MM-DD` format.
    Example: 1980-04-01

  - `_embedded.paymentCard.billingAddress.jobTitle` (string | null)
    Contact's job title.
    Example: CEO

  - `_embedded.paymentCard.useAsBackup` (boolean)
    Specifies if this payment instrument can be used as a backup for invoice payment retries.

  - `_embedded.paymentCard.customFields` (object)
    Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields).
    Example: {"foo":"bar"}

  - `_embedded.paymentCard.referenceData` (object)
    Payment instrument reference data.
    Example: {"gatewayTransactionId":"GAT123"}

  - `_embedded.paymentCard.riskMetadata` (any)

  - `_embedded.paymentCard.riskMetadata.ipAddress` (string | null)
    Customer's IP address.
    Example: 93.92.91.90

  - `_embedded.paymentCard.riskMetadata.fingerprint` (string | null)
    Customer's device fingerprint.
A device fingerprint is a unique token that is used to identify the customer.
The device fingerprint is generated based on device attributes, such as: hardware,
software, IP address, language, browser, and more.
    Example: pIUt3xbgX3l9g3YDiLbx

  - `_embedded.paymentCard.riskMetadata.httpHeaders` (any)

  - `_embedded.paymentCard.riskMetadata.browserData` (object | null)
    Browser data used for 3D Secure and risk scoring.

  - `_embedded.paymentCard.riskMetadata.browserData.colorDepth` (integer, required)
    Browser color depth in bits per pixel.
This value is obtained using the `screen.colorDepth` property.
    Example: 24

  - `_embedded.paymentCard.riskMetadata.browserData.isJavaEnabled` (boolean, required)
    Specifies if Java is enabled in a browser.
This value is obtained from the `navigator.javaEnabled` property.

  - `_embedded.paymentCard.riskMetadata.browserData.language` (string, required)
    Browser language settings.
This value is obtained from the `navigator.language` property.
    Example: en-US

  - `_embedded.paymentCard.riskMetadata.browserData.screenWidth` (integer, required)
    Width of the browser screen.
This value is obtained from the `screen.width` property.
    Example: 1920

  - `_embedded.paymentCard.riskMetadata.browserData.screenHeight` (integer, required)
    Height of the browser screen.
This value is obtained from the `screen.height` property.
    Example: 1080

  - `_embedded.paymentCard.riskMetadata.browserData.timeZoneOffset` (integer, required)
    Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the `(new Date()).getTimezoneOffset()` property.
    Example: 300

  - `_embedded.paymentCard.riskMetadata.browserData.isAdBlockEnabled` (boolean)
    Specifies if the usage of ad block has been detected in the browser.

  - `_embedded.paymentCard.riskMetadata.extraData` (object | null)
    Third-party data used for risk scoring.

  - `_embedded.paymentCard.riskMetadata.extraData.kountFraudSessionId` (string)
    Alpha-numeric `fraudSessionId` as provided by the Kount SDK.
    Example: abcdefg12345abababab123456789012

  - `_embedded.paymentCard.riskMetadata.extraData.payPalMerchantSessionId` (string)
    PayPal `MerchantSessionID` as generated by the PayPal Fraudnet SDK.
    Example: dd65ratxc5qv15iph3vyoq7l6davuowa

  - `_embedded.paymentCard.riskMetadata.extraData.threatMetrixSessionId` (string)
    Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.
    Example: dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa

  - `_links` (array)
    Links to related resources.

  - `_links.href` (string)
    URL of the link.

  - `_links.rel` (string)
    Relationship type of the link.
    Enum: "paymentCard"

## Response 2xx:

  - `2xx` (unknown)
    Returns any 2xx status to indicate that data is received.