Partner API

List Merchants

GET

https://api.sandbox.softlemons.com

/api/v1/merchants

List merchants linked to the authenticated partner. Partner API keys only.

List Merchants › Responses

success

boolean

message

string

code

string

object[]

Merchants linked to the authenticated partner. Each entry includes the acquirer, transaction stats and the partnership status.

GET/api/v1/merchants

curl https://api.sandbox.softlemons.com/api/v1/merchants \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "success": true,
  "message": "Merchants retrieved successfully",
  "code": "",
  "data": [
    {
      "id": 1,
      "name": "Demo Store Ltd",
      "mcc": "5734",
      "status": "active",
      "address": "1 High Street",
      "city": "London",
      "country_code": "GB",
      "email": "merchant@example.com",
      "phone": "+441234567890",
      "website": "https://demo-store.example.com",
      "acquirer_id": 1,
      "acquirer": {
        "id": 1,
        "code": "qashpay",
        "name": "QashPay",
        "bank_name": "Example Bank",
        "bank_country_code": "GB",
        "settlement_currency_code": "EUR",
        "status": "active",
        "created_at": "2025-01-15T09:00:00.000000Z",
        "updated_at": "2025-01-15T09:00:00.000000Z"
      },
      "transactions_count": 128,
      "transaction_stats": {
        "total_count": 128,
        "total_volume": 645000
      },
      "partnership": {
        "status": "active",
        "notes": null,
        "approved_at": "2025-02-01T12:00:00.000000Z"
      },
      "created_at": "2025-01-20T09:00:00.000000Z",
      "updated_at": "2025-05-20T09:18:47.000000Z"
    }
  ]
}

json

application/json

Get Merchant

GET

https://api.sandbox.softlemons.com

/api/v1/merchants/{merchant_id}

Get a specific merchant linked to the authenticated partner. Partner API keys only.

Get Merchant › path Parameters

merchant_id

integer · required

The ID of the merchant.

Get Merchant › Responses

success

boolean

message

string

code

string

object

The merchant profile with acquirer details and transaction stats.

GET/api/v1/merchants/{merchant_id}

curl https://api.sandbox.softlemons.com/api/v1/merchants/:merchant_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "success": true,
  "message": "Merchant retrieved successfully",
  "code": "",
  "data": {
    "id": 1,
    "name": "Demo Store Ltd",
    "mcc": "5734",
    "status": "active",
    "address": "1 High Street",
    "city": "London",
    "country_code": "GB",
    "email": "merchant@example.com",
    "phone": "+441234567890",
    "website": "https://demo-store.example.com",
    "acquirer_id": 1,
    "acquirer": {
      "id": 1,
      "code": "qashpay",
      "name": "QashPay",
      "bank_name": "Example Bank",
      "bank_country_code": "GB",
      "settlement_currency_code": "EUR",
      "status": "active",
      "created_at": "2025-01-15T09:00:00.000000Z",
      "updated_at": "2025-01-15T09:00:00.000000Z"
    },
    "transactions_count": 128,
    "transaction_stats": {
      "total_count": 128,
      "total_volume": 645000,
      "successful_count": 117,
      "failed_count": 11
    },
    "created_at": "2025-01-20T09:00:00.000000Z",
    "updated_at": "2025-05-20T09:18:47.000000Z"
  }
}

json

application/json

Get Merchant Transactions

GET

https://api.sandbox.softlemons.com

/api/v1/merchants/{merchant_id}/transactions

Get transactions for a merchant linked to the authenticated partner. Partner API keys only.

Get Merchant Transactions › path Parameters

merchant_id

integer · required

The ID of the merchant.

Get Merchant Transactions › query Parameters

status

string

Filter transactions by status.

from

string

Filter transactions created on or after this date.

to

string

Filter transactions created on or before this date.

per_page

integer

Number of transactions per page. Maximum 100.

Get Merchant Transactions › Responses

success

boolean

message

string

code

string

object

The transaction list ordered newest first, plus pagination info.

GET/api/v1/merchants/{merchant_id}/transactions

curl https://api.sandbox.softlemons.com/api/v1/merchants/:merchant_id/transactions \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "success": true,
  "message": "Transactions retrieved successfully",
  "code": "",
  "data": {
    "transactions": [
      {
        "id": 123456,
        "merchant_id": 1,
        "merchant_trans_id": "ORDER-100045",
        "amount": 5000,
        "amount_formatted": "50.00 EUR",
        "currency": "EUR",
        "status": "success",
        "transaction_type": "sale",
        "description": null,
        "acquirer_provider": "qashpay",
        "acquirer_trans_id": "514009742001",
        "acquirer_auth_code": "012345",
        "related_trans_id": null,
        "refunded_amount": 0,
        "customer": null,
        "cardholder": {
          "card_last_four": "1111",
          "card_brand": "visa",
          "card_expiry_month": 12,
          "card_expiry_year": 2030,
          "created_at": "2025-05-20T09:18:47.000000Z",
          "updated_at": "2025-05-20T09:18:47.000000Z"
        },
        "payment_instrument": {
          "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": "2025-05-20T09:18:48.000000Z",
          "updated_at": "2025-05-20T09:18:48.000000Z"
        },
        "ip_address": "203.0.113.10",
        "created_at": "2025-05-20T09:18:47.000000Z",
        "updated_at": "2025-05-20T09:18:48.000000Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "last_page": 1,
      "per_page": 25,
      "total": 1
    }
  }
}

json

application/json

Payment Sessions

List Merchants

GET

https://api.sandbox.softlemons.com

/api/v1/merchants

List merchants linked to the authenticated partner. Partner API keys only.

List Merchants › Responses

success

boolean

message

string

code

string

object[]

Merchants linked to the authenticated partner. Each entry includes the acquirer, transaction stats and the partnership status.

Get Merchant

GET

https://api.sandbox.softlemons.com

/api/v1/merchants/{merchant_id}

Get a specific merchant linked to the authenticated partner. Partner API keys only.

Get Merchant › path Parameters

merchant_id

integer · required

The ID of the merchant.

Get Merchant › Responses

success

boolean

message

string

code

string

object

The merchant profile with acquirer details and transaction stats.

Get Merchant Transactions

GET

https://api.sandbox.softlemons.com

/api/v1/merchants/{merchant_id}/transactions

Get transactions for a merchant linked to the authenticated partner. Partner API keys only.

Get Merchant Transactions › path Parameters

merchant_id

integer · required

The ID of the merchant.

Get Merchant Transactions › query Parameters

status

string

Filter transactions by status.

from

string

Filter transactions created on or after this date.

to

string

Filter transactions created on or before this date.

per_page

integer

Number of transactions per page. Maximum 100.

Get Merchant Transactions › Responses

success

boolean

message

string

code

string

object

The transaction list ordered newest first, plus pagination info.