Transactions

Create Account Transfer

Use the Create Account Transfer endpoint to move funds between accounts in the same program. You can combine a fee with the payment or adjustment, depending on what transaction types you have set up with SoFi Tech Solutions. The accounts can belong to the same customer or different customers. If the accounts are in different programs, verify that the program parameters permit transferring funds between the programs.

Pass the sending account in the accountNo parameter and the receiving account in the transferToAccountNo parameter. The receiving account should be in status: N (active) and the active flag set to Y.

To permit this endpoint to drive the sending account negative, set the ALWNB parameter on the sending product.

Consult the <a href="doc:creating-an-internal-transfer" target="_blank">Creating an Internal Transfer</a> guide for instructions on using this endpoint.

post/createAccountTransfer

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/createAccountTransfer
  • 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>. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

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

amountnumber float required

Currency amount as a whole or decimal amount. Pattern: Positive integer or decimal number Example: 100.00, 100, or 100.73

transferToAccountNostring required

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

messagestring nullable

A message for the transfer recipient. The C2DSC provider parameter must be set to 1 to populate this parameter. If you do not populate this parameter, it defaults to the value in the BMNAM product parameter. The system truncates this field to 80 characters. Pattern: Max 2000 Windows-1252 characters Example: "Thanks again for lunch!"

senderMessagestring nullable

A message for the transfer sender. The C2DSC provider parameter must be set to populate this parameter. If you do not populate this parameter, it defaults to the value in message. Pattern: Max 80 Windows-1252 characters Example: "Thanks again for lunch!"

typestring nullable

Transaction type for the transfer. Use the values provided by SoFi Tech Solutions for your program. Pattern: Max 3 alphanumeric characters, case-sensitive Example: "MRM"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "amount": 25.5,
  "transferToAccountNo": "074103447228",
  "message": "Thanks again for lunch!",
  "senderMessage": "Thanks again for lunch!",
  "type": "MRM"
}

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.