Payment card createdWebhook

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 webhook 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

Payment instrument identifier string.

method
string

Method of payment instrument.

Value: "payment-card"
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 the deactivation endpoint.

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

A unique value that is used to identify the payment instrument regardless of variable values. This value contains alphanumeric characters.

bin
string <bin>

Bank Identification Number (BIN) of the payment card. This value is the same as the first 6 digits of the associated Primary Account Number (PAN).

last4
string

Last 4 digits of the associated Primary Account Number (PAN).

expYear
integer

Year in which the payment card expires.

expMonth
integer

Month in which the payment card expires.

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

Contact's billing address.

useAsBackup
boolean (UseAsBackup)
Default: false

Specifies whether this payment instrument can be used as a backup for invoice payment retries.

billingPortalUrl
string

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

createdTime
string <date-time>

Date and time at which the payment instrument was created.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp. This value updates when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

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.

customerId
string (CustomerId) <= 50 characters

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.

For more information, see Gateway routing.

expirationReminderTime
string or null <date-time>

Date and time at which an expiration reminder event will be triggered.

expirationReminderNumber
integer or null

Number of expiration reminder events that have 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 3D Secure and risk scoring.

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

Related resource links.

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

Available embedded objects that are requested by the expand querystring parameter.

Array of PaymentCardLink (object) non-empty

Related resource links.

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

Type of link.

Value: "paymentCard"
href
required
string

Link URL.

Responses
2xx

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

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