GAgalileo-ft
Accounts and Cards

Modify Status

Changed on

Use the Modify Status endpoint to change the status of an account, a card, or both. This endpoint does not change any other kind of status.

  • Consult the <a href="ref:api-reference-modify-status-types" target="_blank">Modify Status Types</a> enumeration to see what is affected by each type value.
  • Use this endpoint with type: 7 to activate a virtual card; for physical card activation use the <a href="ref:post_activatecard" target="_blank">Activate Card</a> endpoint.
  • See the <a href="doc:lost-stolen-or-damaged-cards" target="_blank">Lost, Stolen, or Damaged Cards</a> guide for instructions on using types 8 and 9.
post/modifyStatus

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/modifyStatus
  • 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"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

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"

accountNostring required

The <glossary:PRN>, <glossary:PAN> or <glossary:CAD> of the account. Pattern: PAN, PRN, or CAD Example: "074103447228"

typeinteger required

Specifies the account and/or card status to set. See the <a href="ref:api-reference-modify-status-types" target="_blank">Modify Status Types</a> enumeration for valid values. Pattern: Predefined integer value range Example: 2

startDatestring date-time nullable

Valid only with type: 17 (freeze card). If you pass a value for startDate, you must also populate endDate. Default is current date-time. Pattern: YYYY-MM-DD hh:mm:ss Example: "2020-02-02 12:22:02"

endDatestring date-time nullable

Valid only with type: 17 (freeze card). If you pass a value for endDate, you must also populate startDate. Must be later than startDate. Default is current date-time plus 24 hours. Pattern: YYYY-MM-DD hh:mm:ss Example: "2020-02-12 10:00:00"

bypassRepFee'Y' | 'N' nullable

Valid only when type: 19. Pass Y to bypass the card replacement fee (REP). Pattern: String Example: "Y"

cardNumberLastFourstring nullable

If multiple cards are associated with this account, use this value to ensure that the correct card is selected. Pattern: 4 digits Example: "0789"

closureReason'inactivity' | 'paid_user' | 'chargeoff' | 'collection' | 'deleted_fraud' | 'external_application_fraud_first_party_synthetic_id' | 'external_application_fraud_first_party_income_misrepresentation' | 'external_application_fraud_first_party_employment_misrepresentation' | 'external_application_fraud_first_party_other_misrepresentation' | 'external_credit_fraud_first_party_loan_stacking' | 'external_credit_fraud_first_party_forced_post_transaction' | 'external_credit_fraud_first_party_bustout' | 'external_credit_fraud_first_party_other' | 'external_deposit_fraud_first_party' | 'external_mule_fraud_first_party_witting_mule' | 'external_mule_fraud_first_party_unwitting_mule' | 'external_profile_level_application_fraud_third_party_id_theft_existing_member' | 'external_profile_level_application_fraud_third_party_id_theft_unknown_entity' | 'external_account_takeover_fraud_third_party_social_engineering_phishing' | 'external_account_takeover_fraud_third_party_compromised_credentials' | 'external_account_takeover_fraud_third_party_sim_swap' | 'external_account_takeover_fraud_third_party_password_profile_recovery_exploits' | 'external_account_takeover_fraud_third_party_other_account_takeover' | 'external_account_unauthorized_transaction_third_party_family_friendly_fraud' | 'external_account_unauthorized_transaction_third_party_elder_abuse_financial_exploitation' | 'external_account_unauthorized_transaction_third_party_unemployment_benefit_fraud' | 'external_account_unauthorized_transaction_third_party_compromised_account_number' | 'external_account_unauthorized_transaction_third_party_other' | 'external_account_unauthorized_transaction_third_party_compromised_card_number' | 'external_account_unauthorized_transaction_third_party_lost_stolen' | 'external_account_authorized_transaction_third_party_scam_charity' | 'external_account_authorized_transaction_third_party_scam_investment' | 'external_account_authorized_transaction_third_party_scam_goods_services' | 'external_account_authorized_transaction_third_party_scam_jobs' | 'external_account_authorized_transaction_third_party_scam_property_real_estate' | 'external_account_authorized_transaction_third_party_scam_romance' | 'external_account_authorized_transaction_third_party_scam_known_family_friend' | 'external_account_authorized_transaction_third_party_scam_other' | 'internal_asset_misappropriation_fraud' | 'internal_theft_fraud_access_abuse' | 'internal_member_information_abuse_theft' | 'internal_insider_insider_collusion' | 'internal_insider_outsider_collusion' | 'paid_chargeoff' | 'paid_collection' | 'deleted_no_fraud' | 'deceased' nullable

Specifies the account closure reason. See the <a href="page:account-closure-reasons" target="_blank">Account Closure Reasons</a> enumeration for valid values. Populate this parameter only when type contains 2, 13, 16 or 20. Pattern: String Example: "inactivity"

bypassMailFee'Y' nullable

Controls whether to charge the express mail fee for the reissued card. Default: blank. Pattern: "Y" or blank Example: "Y"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "type": 2,
  "startDate": "2020-02-02 12:22:02",
  "endDate": "2020-02-12 10:00:00",
  "bypassRepFee": "Y",
  "cardNumberLastFour": "0789",
  "closureReason": "inactivity",
  "bypassMailFee": "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

  • 1ede7567a879Revision changes
    • info

      added the new external_deposit_fraud_first_party enum value to the request property