Payment card expiredWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Payment card webhook request body resource.

paymentCardId
string

The payment card ID.

eventType
string (GlobalWebhookEventType)

Rebilly webhooks event type.

Enum: "aml-list-possibly-matched" "application-instance-disabled" "application-instance-disabled" "application-instance-enabled" "application-instance-enabled" "balance-transaction-settled" "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" … 76 more
object
object (PaymentCard)
id
string <= 50 characters

The payment instrument ID.

method
string

The method of payment instrument.

Value: "payment-card"
status
string

Payment instrument status. When an instrument is active it means it has been used at least once for an approved transaction. To remove an instrument from being in use, set it as deactivated (see the deactivation endpoint).

Enum: "active" "inactive" "expired" "deactivated" "verification-needed"
fingerprint
string

A unique value to identify the payment instrument regardless of variable values. It contains alphanumeric values.

bin
string <bin>

The card's bin (the PAN's first 6 digits).

last4
string

The PAN's last 4 digits.

expYear
integer

Card's expiration year.

expMonth
integer

Card's expiration month.

brand
string

Payment Card brand.

Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

useAsBackup
boolean
Default: false

Allow using this payment instrument as a backup for invoice payment retries.

billingPortalUrl
string

URL to the billing portal where the card can be updated.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

customerId
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

stickyGatewayAccountId
string or null

Sticky gateway account ID. All future payments will be processed by this gateway account.

expirationReminderTime
string or null <date-time>

Time expiration reminder event will be triggered.

expirationReminderNumber
integer or null

Number of expiration reminder events triggered.

object

Payment instrument reference data.

digitalWallet
string or null

Digital wallet type.

Enum: "Apple Pay" "Google Pay"
object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

Array of Self (object) or CustomerLink (object) or AuthTransactionLink (object) or ApprovalUrlLink (object) non-empty

The links related to resource.

Array of AuthTransactionEmbed (object) or CustomerEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Array of PaymentCardLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "paymentCard"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "paymentCardId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}