Skip to content

Disabling Instruments

You can disable Payment Instruments to help make seller and buyer data more manageable.

Disabling Instruments

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

curl -i -X PUT \
  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
  https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": false
  }'
Payment Instrument - Disabled
{
  "id": "PIwbvcQGrEP33HShmYM7BR8o",
  "created_at": "2023-02-28T19:05:56.24Z",
  "updated_at": "2023-02-28T21:16:18.80Z",
  "application": "APgPDQrLD52TYvqazjHJJchM",
  "created_via": "API",
  "currency": "USD",
  "disabled_code": "USER_INITIATED",
  "disabled_message": "The card has been disabled by a user.",
  "enabled": false,
  "fingerprint": "FPRd5moHxL3Ltuvk4cczxetCg",
  "identity": "IDpYDM7J9n57q849o9E9yNrG",
  "instrument_type": "BANK_ACCOUNT",
  "account_type": "SAVINGS",
  "bank_account_validation_check": "NOT_ATTEMPTED",
  "bank_code": "123123123",
  "country": "USA",
  "masked_account_number": "XXXXX3123",
  "name": null,
  "tags": {
    "card_name": "Personal Card"
  },
  "type": "BANK_ACCOUNT",
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o"
    },
    "authorizations": {
      "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations"
    },
    "transfers": {
      "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers"
    },
    "verifications": {
      "href": "https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications"
    },
    "application": {
      "href": "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    },
    "identity": {
      "href": "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
    }
  }
}

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"
                    }
                }
            }
        ]
    }
}