Disabling Instruments

Disable Payment Instruments that are no longer being used.

You can disable Payment Instruments to help make seller and buyer data more manageable. For example, you might want to disable old payment instruments after creating new ones with the Account Updater.

Disabling Instruments

To disable a Payment Instrument, make a PUT request setting enabled to false:

Disable Payment Instrument Request
curl https://finix.sandbox-payments-api.com/payment_instruments/PIr247oEh3RScPo2nuNa1d8G \
    -H 'Content-Type: application/json' \
    -H 'Finix-Version: 2022-02-01' \
    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
    -X PUT \
    -d '{
        "enabled": false
    }'
Disabled Payment Instrument
{
    "id": "PIr247oEh3RScPo2nuNa1d8G",
    "created_at": "2022-09-26T22:05:58.33Z",
    "updated_at": "2022-09-26T22:05:58.33Z",
    "application": "APgPDQrLD52TYvqazjHJJchM",
    "created_via": "API",
    "currency": "USD",
    "enabled": false, 
    "fingerprint": "FPRogKWsRQks2HGaau5eGR9AF",
    "identity": "IDaPBS2jFMsTCJfb6yAtsfcH",
    "instrument_type": "PAYMENT_CARD",
    "address": {
        "line1": "900 Metro Center Blv",
        "line2": null,
        "city": "San Francisco",
        "region": "CA",
        "postal_code": "94404",
        "country": "USA"
    },
    "address_verification": "UNKNOWN",
    "bin": "489514",
    "brand": "VISA",
    "card_type": "UNKNOWN",
    "expiration_month": 3,
    "expiration_year": 2029,
    "issuer_country": "UNKNOWN",
    "last_four": "0006",
    "name": "Ayisha Kline",
    "security_code_verification": "UNKNOWN",
    "tags": {
        "card_name": "Business Card"
    },
    "type": "PAYMENT_CARD",
    "_links": {
        "self": {
            "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIr247oEh3RScPo2nuNa1d8G"
        },
        "authorizations": {
            "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIr247oEh3RScPo2nuNa1d8G/authorizations"
        },
        "transfers": {
            "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIr247oEh3RScPo2nuNa1d8G/transfers"
        },
        "verifications": {
            "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIr247oEh3RScPo2nuNa1d8G/verifications"
        },
        "application": {
            "href": "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity": {
            "href": "https://finix.sandbox-payments-api.com/identities/IDaPBS2jFMsTCJfb6yAtsfcH"
        },
        "updates": {
            "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIr247oEh3RScPo2nuNa1d8G/updates"
        }
    }
}

Troubleshooting

Transfer and Authorization requests submitted with a disabled Payment Instrument return a message stating an enabled Payment Instrument is required and to try again. For details on why a Payment Instrument would fail and get disabled, see Failure Codes.

Failed Authorization Request
{
    "total": 1,
    "_embedded": {
        "errors": [
            {
                "logref": "d6210f60e1102624",
                "message": "Payment could not be submitted since Payment Instrument PIr247oEh3RScPo2nuNa1d8G is marked as disabled. Please use a Payment Instrument that’s enabled and try again.",
                "code": "DECLINED",
                "_links": {
                    "self": {
                        "href": "https://finix.sandbox-payments-api.com/authorizations"
                    }
                }
            }
        ]
    }
}