POST/transactions/{userId}/payments/preview

Preview FVNet Payment

Previews an FV Net payment before execution. Returns fee breakdown and transaction details without actually processing the payment. Use Perform FVNet Payment to execute.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique user ID initiating the payment.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`TransferType`	string	Required	FVNet	Must be `FVNet` for this payment type.
`Username`	string	Required	—	Username of the FV Net recipient.
`Amount`	string	Required	—	Payment amount.
`PaymentPurpose`	string	Required	Refer to the Payment Purpose endpoint to get the list of possible values.	Purpose code for the payment.
`IsCryptoTransaction`	string	Required	true \| false	Whether this is a crypto transaction.
`Description`	string	Optional	—	Payment description.
`SupportingDocument`	string	Optional	—	File ID of a previously uploaded document (see File Upload endpoint). Optional for FVNet payments.

Example request

{
  "TransferType": "FVNet",
  "Username": "<username>",
  "Amount": "100.00",
  "Description": "Test",
  "PaymentPurpose": "Asset_Purchase",
  "IsCryptoTransaction": "false",
  "SupportingDocument": "-870429145188356199"
}

{
  "TransferType": "FVNet",
  "Username": "<username>",
  "Amount": "100.00",
  "Description": "Test",
  "PaymentPurpose": "Asset_Purchase",
  "IsCryptoTransaction": "false",
  "SupportingDocument": "-870429145188356199"
}

Update `PaymentPurpose` as needed. To attach a supporting document, add `SupportingDocument` using the file ID returned by the **File Upload** endpoint and update the `Username` with the actual username of the recipient.

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 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).
`ResponseMessage`	string	Success \| 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.
`ResponseData`	object	Please refer to below example for response body	Preview details for the FV Net payment.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Currency": "USD",
    "TransferType": {
      "Name": "Payment - FV Net"
    },
    "MainAmount": "100.00",
    "Fees": 0,
    "TotalAmount": "100.00",
    "FromAccount": {
      "Id": "-2050372247559426224",
      "Number": "572232890",
      "Type": "Account (USD)"
    },
    "Receiver": {
      "Username": "<username>",
      "Name": "Nithin"
    },
    "PaymentPurpose": "Asset_Purchase",
    "Description": "Test",
    "TransactionCryptoBuySellActivity": "No"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Currency": "USD",
    "TransferType": {
      "Name": "Payment - FV Net"
    },
    "MainAmount": "100.00",
    "Fees": 0,
    "TotalAmount": "100.00",
    "FromAccount": {
      "Id": "-2050372247559426224",
      "Number": "572232890",
      "Type": "Account (USD)"
    },
    "Receiver": {
      "Username": "<username>",
      "Name": "Nithin"
    },
    "PaymentPurpose": "Asset_Purchase",
    "Description": "Test",
    "TransactionCryptoBuySellActivity": "No"
  }
}

This endpoint previews the FV Net payment without executing it. Use Perform FVNet Payment to execute.

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