GAgalileo-ft
Account-Level Controls

Set Account-Level Merchant Control

Changed on

Use the Set Account-Level Merchant Control endpoint to create or modify an account-level merchant ID (MID) control. See <a href="doc:set-merchant-id-controls" target="_blank">Set Merchant ID Controls</a> for instructions on using this endpoint.

post/setAccountLevelMerchantControl

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/setAccountLevelMerchantControl
  • Auth
    none declared

Request body application/x-www-form-urlencoded

accountNostring required

The <glossary:PRN> for the account. Do not use the <glossary:CAD> or <glossary:PAN>. Pattern: PRN (12-digit numeric string) Example: "344101254935"

allowDeny'a' | 'd' nullable

Whether the merchant ID is ALLOW (a) or DENY (d). This parameter is required for new controls but optional for updates. Pattern: a or d Example: "d"

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"

endDatestring date nullable

End date-time for the control. Must be later than startDate. Cannot be in the past. Default: 3000-01-01 00:00:00. Pattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD Example: "2024-03-10 23:59:59"

merchantIdstring required

The merchant ID. Not case-sensitive. Pattern: Max 15 alphanumeric characters Example: "000534LECR08003"

startDatestring date nullable

Start date-time for the control. Can be set up to six months in the future. Cannot be in the past. Must be earlier than endDate. Default: Current <a href="ref:system-time" target="_blank">system time</a> Pattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD Example: "2024-03-03 00:00:00"

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"

Example request

{
  "accountNo": "344101254935",
  "allowDeny": "d",
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "endDate": "2024-03-10 23:59:59",
  "merchantId": "000534LECR08003",
  "startDate": "2024-03-03 00:00:00",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Successful response

errorsstring[]

A list of errors generated while the request was processed

processing_timenumber nullable required

The time elapsed in processing the transaction

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.

rtokenstring nullable required

A system-generated ID used for tracking

statusstring nullable required

The condition of a process or response

status_codeinteger nullable required

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

system_timestampstring date-time nullable required

A system generated timestamp

Changes

  • 1ede7567a879Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 60

    • info

      added the success response with the status