Versioning and Change log

We have created a migration guide which consolidates the changes for an easier upgrade from version 6 to version 7.

• header change to "Content-Type: application/vnd.worldpay.payments-v6+json"
• new mandatory field intent for all recurring resources
• removed code and type from error messages

• header change to "Content-Type: application/vnd.worldpay.payments-v5+json"
• new mandatory field type
• new mandatory field version
• xid to transactionId

• Header change to "Content-Type: application/vnd.worldpay.payments-v0.4+json"
• New mandatory field entityReference

You can now submit a consumerBillPayment flag in your authorization request. If you are registered with Visa as a Consumer of the Bill Payment Service (CBPS), you must set this to true for any payments associated with the CBPS.

We now provide additional values in the authentication and 3DS verification responses when the card brand is Cartes Bancaires. These additional values must then be applied in the authorization request.

You can now receive a rawCode in all refusal responses. See raw response codes for more information.

You now receive a paymentInstrument object in authorized responses to your authorization request, and Sent for Settlement responses to your sale request for card/plain, card/token, and card/checkout.

You can now use our card/networkToken paymentInstrument with our one time authorization and migrateCardOnFileAuthorize endpoints.

You can now use our card/networkToken+applepay paymentInstrument with our one time authorization endpoint.

You can now submit a new intent value of subscription in your card on file request.

The response of a partial refund request returns a link to allow you to perform another partial refund. The json path to the link in the response is $._links.payments:partialRefund.href.

We have added a new set of Mastercard refusalAdvice magic values. This enables to you to test the different refusal outcomes in your Payment response.

You can now supply payment facilitator subMerchant email and telephone number in your authorization request.

The payment facilitator state field in the authorization request now supports 1-3 alphanumeric characters.

MOTO payments (v6) (11/29/2022)

riskProfile in card on file (with verification) payment requests (v6) (07/04/2022)

Card network token for card on file sale endpoint (v6) (11/09/2021)

Optional scheme reference parameter for token requests (v6) (09/10/2021)

Additional exemption result for card on file payments (v6) (06/18/2021)

Additional exemption result for one off payments(v6) (05/25/2021)

Additional risk factor result (v6) (04/09/2021)

Cardholder name is now an optional field (v6) (03/09/2021)

riskProfile in payment requests (v6) (01/21/2021)

Apple Pay decrypted for recurring (v6) (11/27/2020)

Apple Pay decrypted for card on file (v6) (11/17/2020)

Additional element for Mobile Wallet requests (v6) (10/06/2020)

Additional element for Mobile Wallet responses (v6) (09/22/2020)

New optional request parameter for repeat payments (v6) (05/28/2020)

New action link in partialSettle response (v6) (05/20/2020)

Additional allowed character for transactionReference (v6) (05/05/2020)

New paymentInstrument for card on file payments (v5 + v6) (04/24/2020)

Additional fields in wallet response (v6) (04/16/2020)

Additional action link (v6) (03/03/2020)

New optional field (v6) (02/11/2020)

Additional fields in response (v6) (02/04/2020)

CVC for token requests (v6) (01/28/2020)

New optional field (v6) (01/16/2020)

Additional action links (v6) (11/21/2019)

Extended error description for card expiry (v5) (11/13/2019)

Formatting update for transactionReference (v5) (10/15/2019)