GET/deposit/deposit-instructions/{userId}

Get Deposit Instructions

Returns bank deposit instructions for funding a user's account. Includes domestic wire, ACH, and international wire instructions.

Path variables

FieldTypeRequiredPossible valuesDescription
userIdstringRequired

Unique user ID for whom to retrieve deposit instructions.

Headers

FieldTypeRequiredPossible valuesDescription
session-tokenstringRequired

SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503

API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).

ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity

Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.

ResponseDataobjectPlease refer to below example for response body

Deposit instructions per rail (wire, ACH, international) for the specified user.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "DepositInstructions": [
      {
        "Currency": "USD",
        "DepositInstructions": [
          {
            "Title": "SWIFT Deposit",
            "Type": "International Wire",
            "Note": "FV Bank SWIFT Wiring Instructions - When making an international wire transfer deposit to FV Bank, it is important to use the correct SWIFT/BIC details and ensure that Puerto Rico is selected as the final beneficiary bank country. Additionally, you must include your FV Bank account number in the format 780001XXXXXX to ensure timely processing of your funds.",
            "Bank Name": "FV Bank International Inc.",
            "SWIFT": "ITTLPRS2XXX",
            "Bank Address": "270 Muñoz Rivera Avenue, Suite 1120, San Juan, PR 00918",
            "Account number": "****3012",
            "Beneficiary Name": "John Doe",
            "Intermediary Bank Name": "Convera USA, LLC",
            "Intermediary Bank SWIFT code": "TGBPUS3WXXX",
            "MT103": {
              "Instructions": "If your bank supports sending in MT103 format, here are the instructions.",
              "SubHeading": "MT103 Field Requirements:",
              "Fields": {
                "Field 56A (Intermediary Institution)": "TGBPUS3WXXX (Convera USA, LLC)",
                "Field 57A (Account with Institution)": "ITTLPRS2XXX (FV Bank International)",
                "Field 59 (Beneficiary Customer)": "John Doe ****3012",
                "Field 70 (Remittance Information)": "[Any additional reference or payment details]",
                "Field 71A (Details of Charges)": "Specify OUR, sender pays fees"
              }
            },
            "Gateway": "convera"
          },
          {
            "Title": "SWIFT Deposit",
            "Type": "International Wire",
            "Note": "FV Bank SWIFT Wiring Instructions - When making an international wire transfer deposit to FV Bank, it is important to use the correct SWIFT/BIC details and ensure that Puerto Rico is selected as the final beneficiary bank country. Additionally, you must include your FV Bank account number in the format 780001XXXXXX to ensure timely processing of your funds.",
            "Bank Name": "FV Bank International Inc.",
            "SWIFT": "ITTLPRS2XXX",
            "Bank Address": "270 Muñoz Rivera Avenue, Suite 1120, San Juan, PR 00918",
            "Account number": "****3012",
            "Beneficiary Name": "John Doe",
            "Intermediary Bank Name": "ZHEJIANG CHOUZHOU COMMERCIAL BANK CO.,LTD",
            "Intermediary Bank SWIFT code": "CZCBCN2XAXXX",
            "Gateway": "zccb"
          }
        ],
        "Type": "USD to USD",
        "PaymentFilters": [
          {
            "value": "",
            "text": "Select..."
          },
          {
            "value": "all",
            "text": "All"
          },
          {
            "value": "ACH",
            "text": "ACH - USA Only"
          },
          {
            "value": "Domestic Wire",
            "text": "Domestic USA Wire Deposit"
          },
          {
            "value": "International Wire",
            "text": "International Wire Deposit"
          }
        ]
      },
      {
        "Currency": "USDC",
        "DepositInstructions": [
          {
            "Title": "USDC Wallet Address",
            "Blockchain": "ETH (ERC20) Blockchain"
          }
        ],
        "Type": "USDC to USD"
      },
      {
        "Currency": "USDT",
        "DepositInstructions": [
          {
            "Title": "USDT Wallet Address",
            "WalletAddress": "0x466e****...****8220",
            "Blockchain": "ETH (ERC20) Blockchain"
          }
        ],
        "Type": "USDT to USD"
      },
      {
        "Currency": "PYUSD",
        "DepositInstructions": [
          {
            "Title": "PYUSD Wallet Address",
            "WalletAddress": "0xDa1F****...****f43F",
            "Blockchain": "ETH (ERC20) Blockchain"
          },
          {
            "Title": "PYUSD Wallet Address",
            "WalletAddress": "5fgg****...****j72P",
            "Blockchain": "SOL Blockchain"
          }
        ],
        "Type": "PYUSD to USD"
      }
    ],
    "ProductAvailability": {
      "USDC": true,
      "USDT": true,
      "PYUSD": true,
      "BUIDL": false
    }
  }
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose