To take a payment, you must first create an authorization request. Your response contains links to your next available actions.
Operations
Create an authorization
Request
Take online card payments using our Card Payments API.
Headers
Content-Typestringrequired
Example:
application/vnd.worldpay.payments-v6+json
Acceptstring
Example:
application/vnd.worldpay.payments-v6.hal+json
Bodyapplication/vnd.worldpay.payments-v6+json
instructionobjectrequired
An object that contains all information related to the payment.
valueobjectrequired
An object that contains information about the value of the payment.
narrativeobjectrequired
The text that appears on your customer's statement. Used to identify the merchant.
paymentInstrumentobjectrequired
debtRepaymentboolean
DRI is a flag which identifies a payment as being for the purpose of repaying a debt.
merchantobjectrequired
An object that contains information about the merchant.
entitystringrequired
Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries.
mccstring
You can apply a merchant category code mcc to an individual request. You can only provide an mcc if we have enabled the dynamic mcc feature during boarding. If enabled but not provided, merchant.mcc defaults to a configured value.
paymentFacilitatorobject
An object containing Payment Facilitator information. This information is required for every authorization only if you are a Payment Facilitator.
transactionReferencestringrequired
A unique reference generated by you that is used to identify a payment throughout its lifecycle.
channelstring
The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of moto to process an authorization as a Mail Order or Telephone Order (MOTO) transaction. If channel is not provided, the authorization will be processed as ecommerce by default
Value"moto"
customerobject
An object that contains riskProfile and authentication of the customer.
riskProfilestring
Used to apply the SCA exemption in the payment request and update the FraudSight data model to benefit future payments.
authenticationany
An object containing 3DS or Network Token authnentication of the customer