Payment Cards

Payment cards are a type of payment instrument used for credit and debit card sales. Rebilly securely vaults the full payment card number, and can pass it onward securely to any gateway account to transact business.

Retrieve a list of Payment Cards

Retrieve a list of Payments Cards.

Authorizations:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

expand
string

Expand a response to get a full related object included inside of the _embedded path in the response. It accepts a comma-separated list of objects to expand. See the expand guide for more info.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array ()
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Request samples

$paymentCards = $client->paymentCards()->search([
    'filter' => 'status:active',
]);

Response samples

Content type
application/json
[
  • {
    }
]

Create a Payment Card

Create a Payment Card.

Authorizations:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

PaymentCard resource.

One of
customerId
required
string <= 50 characters

The Customer's ID.

token
required
string

PaymentCardToken ID.

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).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Request samples

Content type
application/json
Example
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string",
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "payment-card",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "fingerprint": "string",
  • "bin": "string",
  • "last4": "string",
  • "expYear": 0,
  • "expMonth": 0,
  • "brand": "Visa",
  • "bankCountry": "string",
  • "bankName": "string",
  • "billingAddress": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "stickyGatewayAccountId": "string",
  • "expirationReminderTime": "2019-08-24T14:15:22Z",
  • "expirationReminderNumber": 0,
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Retrieve a Payment Card

Retrieve a Payment Card with specified identifier string.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Request samples

$paymentCard = $client->paymentCards()->load('paymentCardId');

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "payment-card",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "fingerprint": "string",
  • "bin": "string",
  • "last4": "string",
  • "expYear": 0,
  • "expMonth": 0,
  • "brand": "Visa",
  • "bankCountry": "string",
  • "bankName": "string",
  • "billingAddress": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "stickyGatewayAccountId": "string",
  • "expirationReminderTime": "2019-08-24T14:15:22Z",
  • "expirationReminderNumber": 0,
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Update a payment card's values

Update any of the payment card's values except for the pan.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

Payment card.

cvv
string

Card's cvv (card verification value).

expMonth
integer

Card's expiration month.

expYear
integer

Card's expiration year.

object

The billing address.

stickyGatewayAccountId
string <= 50 characters

Sticky gateway account ID.

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).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Request samples

Content type
application/json
{
  • "cvv": "string",
  • "expMonth": 0,
  • "expYear": 0,
  • "billingAddress": {
    },
  • "stickyGatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "payment-card",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "fingerprint": "string",
  • "bin": "string",
  • "last4": "string",
  • "expYear": 0,
  • "expMonth": 0,
  • "brand": "Visa",
  • "bankCountry": "string",
  • "bankName": "string",
  • "billingAddress": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "stickyGatewayAccountId": "string",
  • "expirationReminderTime": "2019-08-24T14:15:22Z",
  • "expirationReminderNumber": 0,
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Create a payment card with predefined ID

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

Payment card.

One of
customerId
required
string <= 50 characters

The Customer's ID.

token
required
string

PaymentCardToken ID.

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).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Request samples

Content type
application/json
Example
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string",
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "payment-card",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "fingerprint": "string",
  • "bin": "string",
  • "last4": "string",
  • "expYear": 0,
  • "expMonth": 0,
  • "brand": "Visa",
  • "bankCountry": "string",
  • "bankName": "string",
  • "billingAddress": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "stickyGatewayAccountId": "string",
  • "expirationReminderTime": "2019-08-24T14:15:22Z",
  • "expirationReminderNumber": 0,
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Deactivate a Payment Card

Deactivate a Payment Card.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The payment instrument ID.

method
string
Value: "payment-card"

The method of payment instrument.

customerId
string <= 50 characters

The сustomer's ID.

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

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).

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
Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"

Payment Card brand.

bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

The billing address.

createdTime
string <date-time>

Payment instrument created time.

updatedTime
string <date-time>

Payment instrument updated time.

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).

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

stickyGatewayAccountId
string

Default gateway account ID used for transactions.

expirationReminderTime
string <date-time> Nullable

Time expiration reminder event will be triggered.

expirationReminderNumber
integer

Number of expiration reminder events triggered.

Array of SelfLink (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.

Request samples

$client->paymentCards()->deactivate('paymentCardId');

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "method": "payment-card",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "fingerprint": "string",
  • "bin": "string",
  • "last4": "string",
  • "expYear": 0,
  • "expMonth": 0,
  • "brand": "Visa",
  • "bankCountry": "string",
  • "bankName": "string",
  • "billingAddress": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "riskMetadata": {
    },
  • "stickyGatewayAccountId": "string",
  • "expirationReminderTime": "2019-08-24T14:15:22Z",
  • "expirationReminderNumber": 0,
  • "_links": [
    ],
  • "_embedded": [
    ]
}

Payment card created Webhook

Authorizations:
Request Body schema: application/json

Payment card webhook request body resource.

paymentCardId
string

The payment card ID.

eventType
string (GlobalWebhookEventType)
Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-onboarding-completed" "gateway-account-onboarding-failed" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "lead-source-changed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "payment-instrument-modified" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"

Rebilly webhooks event type.

object
Array of PaymentCardLink (object) non-empty

The links related to resource.

Responses

Request samples

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

Payment card expiration reminder Webhook

Authorizations:
Request Body schema: application/json

Payment card webhook request body resource.

paymentCardId
string

The payment card ID.

eventType
string (GlobalWebhookEventType)
Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-onboarding-completed" "gateway-account-onboarding-failed" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "lead-source-changed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "payment-instrument-modified" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"

Rebilly webhooks event type.

object
Array of PaymentCardLink (object) non-empty

The links related to resource.

Responses

Request samples

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

Payment card expired Webhook

Authorizations:
Request Body schema: application/json

Payment card webhook request body resource.

paymentCardId
string

The payment card ID.

eventType
string (GlobalWebhookEventType)
Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-onboarding-completed" "gateway-account-onboarding-failed" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "lead-source-changed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "payment-instrument-modified" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"

Rebilly webhooks event type.

object
Array of PaymentCardLink (object) non-empty

The links related to resource.

Responses

Request samples

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