Worldpay CardPayments API
The CardPayments API from Worldpay — 2 operation(s) for cardpayments.
Worldpay CardPayments API is one of 45 APIs that Worldpay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CardPayments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 81 schemas. It is described by OpenAPI 3.0.1, at version 3.
Requests are made against 2 base URLs: https://try.access.worldpay.com, https://access.worldpay.com.
2 operations
2 paths
81 schemas
2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldpay CardPayments API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
CardPayments 2
POST
/cardPayments/customerInitiatedTransactions
Take a card payment
POST
/cardPayments/merchantInitiatedTransactions
Take a repeat card payment
Schemas 81
The contract defines 81 schemas that model the data the API accepts and returns. The most detailed are customerInitiatedTransaction (13 properties), responsePaymentInstrument (11 properties), payments_authorize_201_response (11 properties), payments_authorize_201_refusal (11 properties). Each schema is shown below with its type and property counts.
paymentFacilitator
object
An object containing Payment Facilitator information. This information is required for every authorization only if you are a Payment Facilitator.
3 properties
2 required
mit_subscription
object
2 properties
1 required
card_wallet_applepay
object
3 properties
2 required
consumerBillPayment
boolean
Consumer Bill Payment is a flag which identifies a bill payment paid by providers on behalf of consumers.
mit_reauthorization
object
3 properties
1 required
payments_authorize_201_response_mit
object
10 properties
1 required
transactionReference
string
A unique reference generated by you that is used to identify a payment throughout its lifecycle.
payments_sentForSettlement_201_response_mit
object
9 properties
1 required
order
object
An object containing details about the order.
8 properties
card_networkToken_applepay
object
5 properties
3 required
ValidationErrorResponse
object
3 properties
fundsTransfer_bankAccount
object
6 properties
2 required
debtRepayment
boolean
Debt Repayment Indicator is a flag which identifies a payment with the purpose of repaying a debt.
exemption
object
An object for applying exemptions. If you are applying a TRA (Transaction Risk Assessment) exemption granted by us, use the riskProfile object
1 required
fundsTransfer_email
object
2 properties
2 required
cardHolderName
string
The cardholder's name as it appears on their card.
mit_resubmission
object
3 properties
1 required
routing
object
An object containing specific routing preferences.
2 properties
card_wallet_googlepay
object
3 properties
2 required
fundsTransfer
object
Contains details of the funds transfer request, which is a money movement for a reason other than the purchase of goods or services (also known as Account Fund…
4 properties
1 required
paymentId
string
Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
exemption_authentication-outage
object
1 property
payments_links_list_sentForSettlement
object
4 properties
tokenNumber
string
The network token number.
card_checkout
object
3 properties
2 required
fundsTransfer_wallet
object
2 properties
2 required
payments_authorize_201_response
object
11 properties
1 required
cit_cardOnFile
object
2 properties
2 required
mit_unscheduled
object
2 properties
1 required
mit_delayedCharge
object
3 properties
1 required
mit_installment
object
3 properties
2 required
payments_sentForSettlement_201_response
object
10 properties
1 required
fundsTransfer_card
object
2 properties
2 required
entity
string
Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries.
exemption_type
string
ErrorResponse
object
2 properties
payments_authorize_201_refusal_mit
object
10 properties
1 required
cit_subscription
object
2 properties
1 required
cardNumber
string
Your customer's card number. Sometimes referred to as Primary Account Number (PAN).
payments_links_list_authorized
object
6 properties
card_token
object
3 properties
2 required
issuer
object
An object containing information returned by the issuer.
1 property
1 required
southKorea_corporateAuth
object
3 properties
3 required
narrative
object
The text that appears on your customer's statement. Used to identify the merchant.
2 properties
1 required
mit_noShow
object
3 properties
1 required
updatedPaymentInstrument
object
Details of the updated payment instrument.
10 properties
cvc
string
CVC is a unique set of 3 or 4 numbers used to verify the card. Our API checks to see if the CVC supplied matches the CVC held by the issuing bank.
advice
object
Advice on the outcome of this request.
1 property
1 required
southKorea_personalAuth
object
3 properties
3 required
amounts
object
An object containing transaction amounts. Returned for partial authorizations.
4 properties
fundsTransfer_merchantWallet
object
2 properties
2 required
card_token_mit
object
2 properties
2 required
taxReference
string
Merchant's tax reference.
card_plain_mit
object
5 properties
3 required
card_networkToken
object
5 properties
3 required
card_networkToken_googlepay
object
5 properties
3 required
merchantInitiatedTransaction
object
10 properties
3 required
riskFactors
array
Any risk factors which have been identified for the authorization. This section will not appear if no risks are identified.
expiryDateToken
object
Contains your customer's token expiry date.
2 properties
2 required
fundsTransfer_storedValueWallet
object
2 properties
2 required
industryData
object
An object containing industry specific order data.
8 properties
6 required
requestAccountUpdater
boolean
Allows you to request a real-time account update when using a previously stored card. You can only use this with customerAgreement transactions with a storedCa…
scheme
object
An object containing information returned by the card scheme.
1 property
1 required
card_plain
object
6 properties
3 required
mcc
string
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…
exemptionOutcome
object
An exemption result and reason if either a risk profile was included in your authorization request, or if you included the exemption object in the request.
2 properties
2 required
fundsTransfer_phone
object
2 properties
2 required
fundsTransfer_stagedDigitalWallet
object
2 properties
2 required
expiryDateCard
object
Contains your customer's card expiry date.
2 properties
2 required
shipping
object
An object containing shipping details.
2 properties
recipient
object
Additional transaction recipient data.
4 properties
payments_authorize_201_refusal
object
11 properties
1 required
billingAddress
object
Contains the billing address information.
8 properties
2 required
cit_installment
object
4 properties
2 required
responsePaymentInstrument
object
Details of the paymentInstrument used.
11 properties
exemption_external
object
2 properties
commandId
string
Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
value
object
An object that contains information about the value of the payment.
2 properties
2 required
fundsTransfer_socialNetwork
object
2 properties
2 required
orderReference
string
A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example…
customerInitiatedTransaction
object
13 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Worldpay 12
Other APIs Worldpay publishes across the network.
Worldpay Tokens API
Worldpay Card Payouts API
Worldpay Account Payouts API
Worldpay FraudSight API
Worldpay 3DS API
Worldpay APMs API
Worldpay FX API
Worldpay Hosted Payment Pages API
Worldpay Events API
Worldpay Beneficiary Account Verifications API
Worldpay Split Payments API
Worldpay Statements API
#CardPayments