GAgalileo-ft
Location Management

Create Location Fee

Use the Create Location Fee endpoint to create a fee to assess at a location. A fee can be assessed as a flat rate or a percentage. When the fee is a percentage, you can specify minimum and maximum amounts. The fee becomes active upon creation and can be deactivated using the Modify Location Fee endpoint.

These are the fee types:

  • FBD — FBE direct deposit fee
  • DEL — ACH direct deposit fee
post/createLocationFee

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/createLocationFee
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

locationstring required

Unique location identifier (location) as returned by the <a href="ref:post_createlocation" target="_blank">Create Location</a> endpoint. This value is also returned by the <a href="ref:post_getlocations" target="_blank">Get Locations</a> endpoint depending on the value of locationType when the location was created:

  • 0 or 2 — Returned in the location_id field
  • 1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0 or locationType: 2; max 15 characters if locationType: 1 Example: "a455-3483"

locationType0 | 1 | 2 required

Type of ID in location:

  • 0 — SoFi Tech Solutions location ID
  • 1 — Partner location ID
  • 2 — Don't validate

Pattern: 0, 1, or 2 Example: 0

feeType'FBD' | 'DEL' required

Type of fee to assess at this location. To set up both fee types at the same location, call this endpoint twice:

  • FBD — Federal benefit enrollment direct-deposit fee
  • DEL — ACH direct-deposit fee

Pattern: 3-character code Example: "FBD"

amountnumber float required

Specify either a flat amount or a percentage. For a flat amount the valid range is between .01 and 999. For a percentage the valid range is .01 (1%) to 1 (100%). When this parameter is populated then amountType is required. Pattern: Positive integer or decimal number Example: 1.23

amountType'percent' | 'flat' required

Specify which type of value is in amount:

  • flat — Flat rate
  • percent — Percentage

Pattern: String Example: "flat"

minFeenumber float nullable

The minimum amount for the fee, when amountType: percent. Pattern: Positive integer or decimal number Example: 1.10

maxFeenumber float nullable

The maximum amount for the fee, when amountType: percent. Pattern: Positive integer or decimal number Example: 1.10

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "location": "a455-3483",
  "feeType": "FBD",
  "amountType": "flat"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.