Create payment request

post

https://api.staging.vitesse.io/v1/payment-initiation/paymentRequests

Creates a payment request in the Vitesse Platform by initiating a payment transaction with the specified parameters.

Body Params

SendAccountId

int64 | null

The ID of the funding account from which you want to send funds.

TransactionId

string | null

PaymentMethod

string | null

An optional route type to specify the type of payment. Valid values are the following:

BankAccount
PostalCheque
Echeck
Card

SendValue

number | null

The amount you want to send in the currency defined in SendCurrency. You can use ReceiveValue instead, but not both.

SendCurrency

string | null

The currency in which you want to make the transaction. Use an ISO 4217 currency code, for example, GBP.

ReceiveValue

number | null

The amount you want the recipient to receive in ReceiveCurrency. You can use SendValue instead, but not both.

ReceiveCurrency

string | null

The currency you want the recipient to receive, specified as an ISO 4217 currency code.

UseFxRateGroup

boolean

Specifies whether to use FX rate group for the transaction.If true, the rate group is used to calculate the exchange rate. If false, the rate group is not used.

StoredRecipient

Recipient

PaymentDescription

string | null

The description of the payment request.

PaymentPurpose

string | null

The purpose of the payment request.

PaymentCode

string | null

The code of the payment request.

RecipientReference

string | null

The reference for the payment, visible to the recipient and displayed on their bank statement.

CorrelationId

string | null

The correlation ID of the payment request.

ExternalReference1

string | null

The external reference 1 of the payment request.

ExternalReference2

string | null

The external reference 2 of the payment request.

ExternalReference3

string | null

The external reference 3 of the payment request.

Originator

Details about the originator of the payment request.

Scheduler

Details about payment scheduling.

Extra

string

Headers

Idempotency-Key

string | null

A unique identifier for the request, used to prevent duplicate requests. Use a unique string up to 255 characters long.

Responses

200A successful response with identifier of created payment request.

400The request was unacceptable, often due to missing a required parameter.

401Authentication required.

403Forbidden.

422Business rule violation.