Credit Card field mapping between Zuora and Worldpay
The following tables describe the objects and field mapping between Zuora and Worldpay for Credit Card payment method creation and payment creation.
Request
| Zuora UI | API field passed to Worldpay (XPath) | Source of this infoRmation in Zuora (object.field) | Zuora PaymentMethod API field |
|---|---|---|---|
| Gateway setup > Merchant Code | /paymentService/@merchantCode |
|
|
| Gateway setup > user name | http basic auth: user |
|
|
| Gateway setup page > xml password | http basic auth: password |
|
|
|
|
/order/@orderCode | AuthBean.orderId, or 32-digit random string
PaymentBean.orderId, or PaymentBean.paymentNumber |
Payment.GatewayOrderId,
Payment.PaymentNumber |
|
|
/order/description | AuthBean.referenceId
PaymentBean.referenceId |
PaymentMethod.id
Payment.id |
| New Customer Account > Currency | /amount/@currencyCode | CustomerInfo.currency.code | Account.Currency |
| New Customer Account > Currency | /amount/@exponent | CustomerInfo.currency.exponent | Account.Currency |
| Gateway setup > Default Authorization Amount | /amount/@value | AuthBean.amount | |
| Credit Card Type | <VISA-SSL> <ECMC-SSL> etc. tag | CreditCard.cardType | PaymentMethod.CreditCardType |
| Card Number | /paymentDetails/cardNumber | CreditCard.cardNumber | PaymentMethod.CreditCardNumber |
| Expiration Date | /paymentDetails/expiryDate/date/@month | CreditCard.expirationDate | PaymentMethod.CreditCardExpirationMonth |
| Expiration Date | /paymentDetails/expiryDate/date/@year | CreditCard.expirationDate | PaymentMethod.CreditCardExpirationYear |
| Card Holder Name | /paymentDetails/cardHolderName | CreditCard.cardHolderName | PaymentMethod.CreditCardHolderName |
| Card Security Code | /paymentDetails/cvc | CreditCard.cardSecurityCode | <paymentmethod.cardsecuritycode/> |
| Billing City | /cardAddress/address/city | CreditCard.cardCity | PaymentMethod.CreditCardCity |
| Billing Country | /cardAddress/address/countryCode | CreditCard.cardCountry | PaymentMethod.CreditCardCountry |
| Billing Postal Code | /cardAddress/address/postalCode | CreditCard.cardZip | PaymentMethod.CreditCardPostalCode |
| Billing State/Province | /cardAddress/address/state | CreditCard.cardState.name | PaymentMethod.CreditCardState |
| Billing Address | /cardAddress/address/address1 | CreditCard.cardAddress1 | PaymentMethod.CreditCardAddress1 |
| Billing Address | /cardAddress/address/address2 | CreditCard.cardAddress2 | PaymentMethod.CreditCardAddress2 |
| Phone | /cardAddress/address/telephoneNumber | CreditCard.phone | PaymentMethod.Phone |
Response
| Zuora UI | Worldpay API (XPath) | Description |
|---|---|---|
| Reference Id | /(orderStatus|captureReceived)/@orderCode | transactionId, orderId |
| N/A | <lastEvent> | For PaymentMethod creation only: successful if lastEvent is AUTHORISED, otherwise fails. |
| N/A | <reply><ok> | Payment request (sale call) is successful if this tag is present in response, otherwise fails. |
| N/A | /error/@code | error code |
| N/A | /error | error description |
| N/A | /AVSResultCode/@description | |
| N/A | /CVCResultCode/@description |