Create Transfer Fee

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonOptional

bpsFeeRequiredstring

Basis point percentage fee.

fixedFeestring

Fixed point fee.

targetCustomerIdRequiredstring

The customer's id that the fee will be applied to.

curl -X POST "https://api.sandbox.spherepay.co/v1/transfer/fee" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "bpsFee": "20",
    "targetCustomerId": "{{customer_id}}"
  }'

{
  "ok": true,
  "object": "object",
  "statusCode": 200,
  "error": null,
  "message": "success",
  "data": {
    "newTransferFee": {
      "id": "payoutFee_56dd365b206449f89fb626b1b2ea9ae0",
      "setter": "merchant",
      "application": {
        "id": "application_82a87bdbece9407fb861357754e85ac0"
      },
      "targetCustomer": {
        "id": "customer_68f1c089703945e7bbff6f04bf1c5041"
      },
      "payoutType": null,
      "cryptoCurrency": null,
      "fiatCurrency": null,
      "active": true,
      "activeSince": "2025-04-12T17:57:22.609Z",
      "deactivated": null,
      "bpsFee": "20",
      "fixedFee": "0",
      "inheritFixedFees": false,
      "customerType": null,
      "updated": "2025-04-12T17:57:22.656Z",
      "created": "2025-04-12T17:57:22.656Z"
    },
    "deactivatedTransferFee": {
      "id": "payoutFee_cbb956037ef74aefb287cb75438b289d",
      "setter": "merchant",
      "application": {},
      "targetCustomer": {},
      "payoutType": null,
      "cryptoCurrency": null,
      "fiatCurrency": null,
      "active": false,
      "activeSince": "2025-04-09T17:32:00.849Z",
      "deactivated": "2025-04-12T17:57:22.608Z",
      "bpsFee": "20",
      "fixedFee": "0",
      "inheritFixedFees": false,
      "customerType": null,
      "updated": "2025-04-12T17:57:22.640Z",
      "created": "2025-04-09T17:32:00.862Z"
    }
  },
  "ts": "2025-04-12T17:57:22.671Z",
  "request": "request_db4b26c3b5a0414b9032d2f19d8c6796"
}

Create Transfer Fee

Authorization

Request Body

Response

TypeScript