POST/v2/transfer/send

Send - FVNet Payment

Executes an FVNet USD payment to another FV Bank account holder identified by email or account number. Same request body as Preview - FVNet Payment.

Prerequisites: • Recipient email or account number resolves to a single active, FVNet-eligible FV Bank user • Sufficient availableBalance in the merchant USD account • Prefer calling Preview first to confirm fees and parties

Returns TransactionNumber for use with Get Transaction Details and payment webhooks.

Headers

FieldTypeRequiredPossible valuesDescription
AuthorizationstringRequiredBearer {SessionToken}Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request.

Request body

FieldTypeRequiredPossible valuesDescription
RecipientstringRequireduser@example.com | 780008000490Recipient FV Bank account holder identified by email address or Metro account number (digits only). Must match a single active, FVNet-eligible user (not an operator).
PurposestringRequiredAsset_Purchase | Contract_Payment | Other | Education_Payment | Payroll | dividends | Mortgage_Payments | Materials_Purchase | Loan_Payments | Professional_Service_Payments | Invoice_Payment | Investment_Purchase | Savings | Rent_Utility_Payments | reimbursements | Tax_Payments | Personal_Family_Payment | settlement_trade | treasury_movement | gift_donation | remittanceRegulatory purpose code for the payment. Must be one of the allowed values.
AmountstringRequired1.00 | 2.00 | 3.00 | 4.00 | 5.00 | ... NPayment amount in USD, as a decimal string greater than 0 (e.g. `300` or `1.00`).
DescriptionstringRequiredTest API PaymentShort memo or narrative for the transaction (max 150 characters).
CryptoBuySellActivitystringRequiredYes | NoWhether the transaction involves buying or selling cryptocurrency: `Yes` or `No`.
SupportingDocumentstringOptional{fileID}Optional File ID from Upload File (`customField`: Payment_Invoice). Include when a supporting document is required for the payment.

Example request

{
  "Recipient": "user25868@mailinator.com",
  "Purpose": "Loan_Payments",
  "Amount": "300",
  "Description": "lorem ipsum dummy textlorem ipsum dum",
  "CryptoBuySellActivity": "Yes",
  "SupportingDocument": "{fileID}"
}

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422API 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 | UnProcessableEntityHuman-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
ResponseDataobjectPlease refer to below example for response bodyContains TransactionNumber for use with Get Transaction Details.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "TransactionNumber": "FV000007938"
  }
}

Status updates may be delivered via payment webhooks.

Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose