Transactions

Create transaction

post/transactions

Request

Headers

paypalFraudIdstring

PayPal Fraud Id

x-vfi-api-idempotencyKeystring

A value you specify that uniquely identifies the transaction. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the transaction. <br/><b>Required</b> when billingAgreementId is passed in the payload

Request body */*

paymentProviderContractstring required

Payment Provider contract

intent'AUTHORIZE' | 'CAPTURE'

Intent of this transaction

dynamicDescriptorstring

If an Order is paid using the "PayPal Wallet" the statement descriptor will appear in following format on the payer card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+dynamicDescriptor. The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. <br /> For example, <br/> * The PayPal prefix toggle is PAYPAL <br/> * The merchant descriptor in the profile is Janes Gift <br/> * The soft descriptor is 800-123-1234 </br> Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.

merchantReferencestring

The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.

descriptionstring

Purchase description

Response

Created

idstring required

Transaction UUID from create transaction API

createdAtstring date required

Transaction creation date (ISO-8601)

status'INITIATED' | 'AUTHORISED'

Transaction status

orderIdstring

PayPal order identifier

instoreReferencestring required

Reference to the transaction for internal usage for instore

approvalUrlstring

The URL where the customer should be redirected to approve the payment

Changes

No recorded changes to this operation across all 1 revision of this API.