Create deferred transaction request

post

https://staging-api.vitessepsp.com/api/deferredtransactionrequests

Creates a deferred transaction request and returns the created transaction.

Body Params

Creates a transaction request. SendCurrency and SendAccountId are required. Supply either SendValue or ReceiveValue. Supply either Recipient or StoredRecipient.

SendAccountId

int32

required

Identifies the account from which the payment is instructed.

SendAccount

string

length between 0 and 256

The name of the account from which the payment is instructed.

SendCurrency

string

required

length between 3 and 3

The currency used to fund the payment, in ISO 4217 currency code format.

SendValue

double

The exact amount to send in the specified SendCurrency. Supply either SendValue or ReceiveValue.

ReceiveValue

double

The exact amount the recipient should receive in the ReceiveCurrency. Supply either ReceiveValue or SendValue.

Recipient

object

Recipient details for the transaction. Either use Recipient or StoredRecipient, not both. Use Recipient to include inline recipient details in the transaction. Use StoredRecipient to reference a stored recipient details.

StoredRecipient

object

Stored recipient details for the transaction request. Either use StoredRecipient or Recipient, not both. Use StoredRecipient to reference a stored recipient details. Use Recipient to include inline recipient details in the transaction.

RequestedValueDate

date-time

The requested date on which the recipient should receive the payment, subject to processing and settlement times.

DateSearchMode

string

Optional date search direction. Valid values are Backward and Forward.

RouteType

string

enum

The payment route used to deliver the payment. If omitted, the default route is BankAccount. For more information, see Route types.

TransactionRequestType

string

enum

The transaction request type.

Allowed:

ExternalReference1

string

length between 0 and 128

An optional custom reference used to store internal metadata, such as a policy number, claim ID, case reference, or reconciliation identifier.

ExternalReference2

string

length between 0 and 128

An optional custom reference used to store internal metadata, such as a policy number, claim ID, case reference, or reconciliation identifier.

ExternalReference3

string

length between 0 and 128

An optional custom reference used to store internal metadata, such as a policy number, claim ID, case reference, or reconciliation identifier.

CorrelationId

string

length between 0 and 64

Identifies related requests, logs, and events for tracing purposes.

Source

string

length between 0 and 64

RateGroupId

int32

Identifies the foreign exchange rate group used when calculating exchange rates.

ProgrammeId

uuid

Identifies the programme associated with the transaction request.

Originator

object

Details about the person or organisation providing the funds for a payment. Whether this object is required depends on your merchant configuration.

UltimateOriginator

object

Details about the person or organisation providing the funds for a payment. Whether this object is required depends on your merchant configuration.

DynamicRiskSharing

object

Dynamic risk sharing details for the transaction. Use either MapKey or Splits, but not both.

ECheque

object

Electronic cheque details for the transaction request.

PostalCheque

object

Postal cheque details for the transaction request.

PostalRecipient

object

Postal recipient details for cheque delivery.

Attachments

object

Supporting files attached to the transaction request.

LatePaymentMode

string

Specifies how the transaction should be handled if payment cannot be completed on time.

Extra

object

Additional optional custom metadata used for reconciliation, tracking, reporting, or linking the transaction to internal systems.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200OK

201Created

400BadRequest