v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Merchant Rates

Admin

Create custom rates for a merchant

post/api/v1/admin/merchants/{merchantId}/rates

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the merchant

Request body

Example request

{
  "rates": [
    {
      "type": "domestic_percent_fee",
      "value": 1,
      "unit": "%",
      "base": "gross_amount",
      "notes": "Standard domestic percentage fee"
    },
    {
      "type": "fixed_transaction_fee",
      "value": 0.2,
      "unit": "currency",
      "base": "gbp",
      "notes": "Standard fixed GBP fee"
    },
    {
      "type": "fixed_transaction_fee",
      "value": 0.27,
      "unit": "currency",
      "base": "eur",
      "notes": "Standard fixed EUR fee"
    }
  ]
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174002",
    "version": "v1-2024-01-13T15:00:00Z",
    "is_active": true,
    "merchantId": "123e4567-e89b-12d3-a456-426614174000",
    "created_by": "system_seed",
    "created_at": "2024-03-19T12:00:00Z",
    "updated_at": "2024-03-19T12:00:00Z",
    "rates": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "defaultRatesId": "123e4567-e89b-12d3-a456-426614174001",
        "merchantRatesId": "123e4567-e89b-12d3-a456-426614174001",
        "type": "domestic_percent_fee",
        "value": 1,
        "unit": "%",
        "base": "gross_amount",
        "conversion_currencies": {
          "source": "EUR",
          "destination": "GBP"
        },
        "notes": "Standard domestic fee"
      }
    ]
  }
}