Instant Issue

Void Create Account

Use the Void Create Account endpoint to cancel an account (move the account into status: B, Voided account) that was created by <a href="ref:post_createaccount" target="_blank">Create Account</a>. Pass either the transactionId of the original Create Account call or the optional accountNo parameter to identify and void the created account. The accountNo parameter can be the PRN that was returned by Create Account or a PAN that you can retrieve using <a href="ref:post_getaccountcards" target="_blank">Get Account Cards</a>.

📘 Note

Use Void Create Account only for instant-issue (prepaid) card accounts. To reverse an account creation for other account types, use the <glossary:CST>.

post/voidCreateAccount

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/voidCreateAccount
  • 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 nullable

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

typestring required

Type of void being performed:

  • "1" — Cancel account
  • "2" — Reset account (for instant issue)

Pattern: String Example: "1"

verifyOnlyboolean

Pass 1 to test the validity of the parameter data without committing the information to the system. Pattern: Integer Example: 0

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "type": "1"
}

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

response_dataobject required

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

Changes

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