Softlemon API Documentation
  • Merchant API
  • Partner API
  • Guides
Information
Transactions
    Initiate TransactionpostCapture TransactionpostRefund TransactionpostTransaction StatusgetVoid Transactionpost
Payment Instruments
    List payment instrumentsgetRevoke a payment instrumentdelete
Payment Sessions
    Create a payment sessionpostGet a payment sessiongetList available payment methodsget
Card Verification
    Initiate Card Verificationpost
Webhook Management
    Get webhook configurationgetCreate or update the webhook endpointputDelete the webhook endpointdeleteRotate the webhook signing secretpostSend a test pingpostList webhook eventsgetGet a webhook eventgetReplay a webhook eventpost
API Operations
    Get API Key Informationget
Schemas
Softlemon Merchant API
Softlemon Merchant API

Payment Instruments


List payment instruments

GET
https://api.sandbox.softlemons.com
/api/v1/payment-instruments

List the cards stored in the vault for a merchant. An instrument is created automatically when a card transaction succeeds and the acquirer returns a vault token. Use the vault_token value to charge the stored card again, as described in the returning customers guide.

Merchant API keys list their own instruments. Partner API keys must include merchant_id for a linked merchant.

List payment instruments › query Parameters

status
​string · enum

Filter by status.

Enum values:
active
expired
revoked
merchant_id
​integer

Required for partner API keys. Must be a merchant linked to the authenticated partner.

per_page
​integer

Number of instruments per page (1-100, default 25).

page
​integer

Page number (1+).

List payment instruments › Responses

success
​boolean
message
​string
code
​string
​object
GET/api/v1/payment-instruments
curl https://api.sandbox.softlemons.com/api/v1/payment-instruments \ --header 'Authorization: Bearer <token>'
Example Responses
{ "success": true, "message": "Payment instruments retrieved", "code": "", "data": { "payment_instruments": [ { "payment_instrument_id": "pi_01k24d5re8xh1v0c9jc0m8w3ns", "vault_token": "8ac7a4a29852f6f101985300a1b41c2f", "type": "card", "status": "active", "card_brand": "visa", "card_last_four": "1111", "card_expiry_month": 12, "card_expiry_year": 2030, "created_at": "2026-08-01T09:18:47.000000Z", "updated_at": "2026-08-01T09:18:47.000000Z" }, { "payment_instrument_id": "pi_01k1zx9v2m5re8ah3t6wd0q7bc", "vault_token": "5fb2c8d10474e2a90198a3f2b17d33aa", "type": "card", "status": "revoked", "card_brand": "mastercard", "card_last_four": "4444", "card_expiry_month": 6, "card_expiry_year": 2028, "created_at": "2026-07-14T15:02:10.000000Z", "updated_at": "2026-07-30T11:41:05.000000Z" } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 25, "total": 2 } } }
json
application/json

Revoke a payment instrument

DELETE
https://api.sandbox.softlemons.com
/api/v1/payment-instruments/{paymentInstrument_public_id}

Revoke a stored card so its vault token can no longer initiate transactions. Revocation is idempotent: revoking an already revoked instrument succeeds without changing anything. If the same card is stored again later, the instrument reactivates with the same token.

Merchant API keys revoke their own instruments. Partner API keys can revoke instruments of linked merchants.

Revoke a payment instrument › path Parameters

paymentInstrument_public_id
​string · required

The payment instrument id.

Revoke a payment instrument › Responses

success
​boolean
message
​string
code
​string
​object
DELETE/api/v1/payment-instruments/{paymentInstrument_public_id}
curl https://api.sandbox.softlemons.com/api/v1/payment-instruments/:paymentInstrument_public_id \ --request DELETE \ --header 'Authorization: Bearer <token>'
Example Responses
{ "success": true, "message": "Payment instrument revoked", "code": "", "data": { "payment_instrument": { "payment_instrument_id": "pi_01k24d5re8xh1v0c9jc0m8w3ns", "vault_token": "8ac7a4a29852f6f101985300a1b41c2f", "type": "card", "status": "revoked", "card_brand": "visa", "card_last_four": "1111", "card_expiry_month": 12, "card_expiry_year": 2030, "created_at": "2026-08-01T09:18:47.000000Z", "updated_at": "2026-08-08T10:22:31.000000Z" } } }
json
application/json

TransactionsPayment Sessions