Documentation

BankPay

  1. Home
  2. Docs
  3. BankPay
  4. API
  5. Service Fees

Service Fees

Service Fee object

{
    "created_at": "2020-08-17T20:02:52Z",
    "fee_amount": "9.00",
    "id": "service_fee_1Xjrntj8hezL0P7mWcYvW8wTYCrFdXgn",
    "is_accepted": true,
    "updated_at": "2020-08-17T20:04:26Z"
}
  • id string

Permanent unique identifier of the service fee.

  • is_accepted boolean

The whether the service fee was accepted or not.

  • fee_amount datetime string

The amount of the service fee.

  • created_at datetime string

The timestamp when the service fee was created.

  • updated_at datetime string

The timestamp when the service fee was updated.

Read Service Fee

Success

Request

GET /api/service-fees/{service_fee_id}
Authorization: Bearer {PUBLISHABLE_KEY}

Response

{
    "data": {
        "created_at": "2020-08-17T20:02:52Z",
        "fee_amount": "9.00",
        "id": "service_fee_1Xjrntj8hezL0P7mWcYvW8wTYCrFdXgn",
        "is_accepted": false,
        "updated_at": "2020-08-17T20:04:26Z"
    },
    "meta": {
        "type": "service_fee"
    }
}

Example Errors

Service Fee not found

Request

GET /api/service-fees/{service_fee_id}
Authorization: Bearer {PUBLISHABLE_KEY}

Response

HTTP/1.1 200 OK
{
    "message": "not_found"
}

Update Service Fee

Success

Request

PATCH /api/service-fees/{service_fee_id}
Authorization: Bearer {PUBLISHABLE_KEY}
{
    "action": "accept"
}

Response

{
    "data": {
        "created_at": "2020-08-17T20:02:52Z",
        "fee_amount": "9.00",
        "id": "service_fee_1Xjrntj8hezL0P7mWcYvW8wTYCrFdXgn",
        "is_accepted": true,
        "updated_at": "2020-08-17T20:04:26Z"
    },
    "meta": {
        "type": "service_fee"
    }
}

Example Errors

Service Fee not found

Request

GET /api/service-fees/{service_fee_id}
Authorization: Bearer {PUBLISHABLE_KEY}

Response

HTTP/1.1 200 OK
{
    "message": "not_found"
}
Service Fee already accepted

Request

GET /api/service-fees/{service_fee_id}
Authorization: Bearer {PUBLISHABLE_KEY}
{
    "action": "accept"
}

Response

HTTP/1.1 200 OK
{
    "action": "accept",
    "conflict": "already_accepted",
    "message": "Service fee already accepted."
}

Back to Top

How can we help?