instruments

Revoke a payment method's wallet credential (payments-api provider contract)

Called when payments-api cancels a saved wallet method or an off_session intent. Finds the method's active instrument, releases the credential at its wallet (Maya: delete the link; GCash: unbind), marks it revoked, and answers the instrument shape; only data.id is read. No active instrument answers success (nothing left to revoke; a repeat lands here). An instrument of another organization or mode is 404. A wallet that refuses answers 502, never 404: payments-api reads 404 as already gone and would record the method revoked over a live binding.

delete/v1/instruments/payment_method/{payment_method_id}

Request

  • Base URL
    https://ewallets-api.paymongo.com
  • URL
    https://ewallets-api.paymongo.com/v1/instruments/payment_method/{payment_method_id}
  • Auth
    HTTP bearer

Path parameters

payment_method_idstring required

payments-api's payment method id

Headers

PayMongo-Livemode'true' | 'false' required

true or false

PayMongo-Correlation-Idstring

Correlation id, echoed

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.