Create a payment method

POST /api/v2/payment-methods

Create a payment method

cURL

curl --request POST \
  --url https://api.itemshop.dev/api/v2/payment-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "imojeTransfer",
  "displayName": "imoje",
  "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
  "config": {
    "MERCHANT_ID": "...",
    "SERVICE_KEY": "...",
    "SANDBOXMODE": true
  },
  "fees": {
    "percentage": 1.9,
    "fixedAmount": 0.3,
    "minimumFee": 0.3
  },
  "channelFees": [
    {
      "channel": "blik",
      "percentage": 1.5,
      "minimumFee": 0.2
    }
  ],
  "channels": [
    {
      "channel": "blik",
      "displayName": "BLIK",
      "icon": "<string>",
      "active": true
    }
  ],
  "currencies": [
    "PLN"
  ],
  "defaultCurrency": "PLN",
  "limits": {
    "minAmount": 1,
    "maxAmount": 9999
  },
  "commission": {
    "enabled": true,
    "percentage": 1.5,
    "amount": 0.5
  },
  "flags": {
    "logErrors": true,
    "disabled": true,
    "allowCurrencyConversion": true,
    "blockPromotions": true,
    "blockPromoCodes": true
  },
  "testMode": true,
  "assignToAllProducts": true
}
'

201

{
  "success": true,
  "data": {
    "_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "name": "imojeTransfer",
    "displayName": "imoje",
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "isActive": true,
    "fees": {
      "percentage": 1.9,
      "minimumFee": 123
    }
  },
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Provider name (e.g. imojeTransfer, zen)

Example:

"imojeTransfer"

displayName · string · required

Display name

Required string length: 1 - 100

Example:

"imoje"

shopId · string · required

Shop ID (ObjectId)

Pattern: ^[0-9a-fA-F]{24}$

Example:

"664f1a2b3c4d5e6f7a8b9c0d"

config · object · required

Provider config (API keys, etc.)

Example:

{
  "MERCHANT_ID": "...",
  "SERVICE_KEY": "...",
  "SANDBOXMODE": true
}

fees · object

Fees

Show child attributes

channelFees · object[]

Per-channel fees

Show child attributes

channels · object[]

Payment channels

Show child attributes

currencies · string[]

Supported currencies

Example:

["PLN"]

defaultCurrency · string

Default currency

Pattern: ^[A-Za-z]{3}$

Example:

"PLN"

limits · object

Amount limits

Show child attributes

commission · object

Operator commission

Show child attributes

flags · object

Gateway flags

Show child attributes

testMode · boolean

Test mode

assignToAllProducts · boolean · default: true

Assign this method to all existing products at the standard price

Response

201

application/json

OK

success · boolean

Example:

true

data · object

Show child attributes

message · string