GAgalileo-ft
Location Management

Modify Location Fee

Use the Modify Location Fee endpoint to modify a fee that was created with the <a href="ref:post_createlocationfee" target="_blank">Create Location Fee</a> endpoint. You cannot change feeType (FBD or DEL) with this endpoint. Instead, you must create a new fee with Create Location Fee and use this endpoint to deactivate the old fee.

For this endpoint, amount and amountType are not required, but if one of them is populated, then both are required.

post/modifyLocationFee

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/modifyLocationFee
  • 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

Identifier for the location that was created with Create Location. This value is returned by Get Locations in the location_id field when locationType: 0 or locationType: 2, or in the provider_specified_id field when locationType: 1. Pattern: Must be a number if type is 0; Must be less than or equal to 15 characters if type is 1. Example: "a455-3483"

locationType0 | 1 | 2 required

Location type, as specified by Create 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 as specified by Create Location Fee. This value must be the original value provided at the time of the fee creation: FBD (FBE direct deposit fee) or DEL (ACH direct deposit fee) Pattern: FBD or DEL Example: "FBD"

amountnumber float nullable

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: 1, 1.10, 0.5 Example: 1.23

amountType'percent' | 'flat' nullable

Specify whether the value in amount is a flat rate (flat) or a percentage (percent). When this parameter is populated then amount is required. Pattern: flat or percent Example: 'flat'

minFeenumber float nullable

The minimum amount for the fee, if the amount type is a percentage. Pattern: 10, 20.5, 2.33 Example: 1.10

maxFeenumber float nullable

The maximum amount for the fee, if the amount type is a percentage. Pattern: 10, 20.5, 2.33 Example: 1.10

active'Y' | 'N' nullable

Specify whether to activate the fee (Y) or deactivate the fee (N). Pattern: Y or N Example: "Y"

Example request

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

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.