Create Location Fee

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/createLocationFee

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

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
595-01	Location was not found
595-02	Fee has already been created
595-03	locationType 1 name is maximum of 15 characters
595-04	locationType 0 and 2 require location to be an integer value.

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

location

string

required

Unique location identifier (location) as returned by the Create Location endpoint. This value is also returned by the Get Locations 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"

locationType

int32

enum

required

Type of ID in location:

0 — Galileo location ID
1 — Partner location ID
2 — Don't validate

Pattern: 0, 1, or 2
Example: 0

Allowed:

feeType

string

enum

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"

Allowed:

amount

float

required

0.01 to 999999999999.99

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

string

enum

required

Specify which type of value is in amount:

flat — Flat rate
percent — Percentage

Pattern: String
Example: "flat"

Allowed:

minFee

float | null

0 to 999999999999.99

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

maxFee

float | null

0 to 999999999999.99

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

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default