Deactivate a payment instrument

Deactivates a payment instrument with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
201

Payment instrument deactivated.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
id
string <= 50 characters

ID of the payment instrument.

customerId
string (CustomerId) <= 50 characters

ID of the customer resource.

method
string

Method of payment instrument.

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.

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

Unique value that is used to identify the payment instrument. This value is generated from the bin and the last4 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

Expiration year of the payment card.

expMonth
integer

Expiration month of the payment card.

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"
bankCountry
string

Bank country of the payment instrument.

bankName
string

Bank name of the payment instrument.

object

Contact's billing address.

useAsBackup
boolean (UseAsBackup)
Default: false

Specifies if 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> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically 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.

stickyGatewayAccountId
string or null

ID of the sticky gateway account. All future payments are processed by this gateway account.

For more information, see Gateway routing.

expirationReminderTime
string or null <date-time>

Date and time when an expiration reminder event is 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 objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

409

Conflict.

post/payment-instruments/{id}/deactivation
Request samples 
$client->paymentInstruments()->deactivate('paymentInstrumentId');
Response samples
application/json
{
  • "id": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
  • "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  • "method": "payment-card",
  • "status": "active",
  • "fingerprint": "string",
  • "bin": "string",
  • "last4": "string",
  • "expYear": 0,
  • "expMonth": 0,
  • "brand": "Visa",
  • "bankCountry": "string",
  • "bankName": "string",
  • "billingAddress": {
    },
  • "useAsBackup": false,
  • "billingPortalUrl": "string",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "stickyGatewayAccountId": "string",
  • "expirationReminderTime": "2019-08-24T14:15:22Z",
  • "expirationReminderNumber": 0,
  • "referenceData": {
    },
  • "digitalWallet": "Apple Pay",
  • "riskMetadata": {
    },
  • "_links": [
    ],
  • "_embedded": {
    }
}