B2B Mobile Transaction API Guide

Release 10.1

Note: As of December 2019, Loyalty processing is no longer available in the WLW platform.

Marked loyalty items as deprecated.

Release 9-11

Corrected mis-labelled error codes 404 and 503.

Release 9-7

Added PaymentAccount to the continuePaymentAccountEnrollment method so that the paymentAccountUri can be returned in the response as part of a multi-step enrollment. The uri field of the EntityIdentifier object stores the paymentAccountUri in the responses of both startPaymentAccountEnrollmentRequest and continuePaymentAccountEnrollment in multi-step processing.

Release 9-5

Corrected the name of the refreshCustomerCardBalances method.
Added link to updateMobileTransaction fuel access detail object.
Added deviceIdentifier to the fuelAccessDetail object in continuePaymentAccountEnrollment.
Changed accountTypeUri requirement to Required in TenderType.
Changed checkoutToken requirement to Optional in updateMobileTransaction.
Changed siteDetails attribute in transactionMetadata to siteLocation
Clarified boolean settings must be in lowercase.
Added notes about deviceUri and deviceUniqueId in releaseMobileDeviceCheckoutToken, obtainMobileDeviceCheckoutToken, retrieveMobileTransactionMetadata, updateMobileTransaction, startPaymentAccountEnrollment, and cancelMobileTransaction. Also changed deviceUri requirement in updateCustomerCard to Optional.

Release 9-4

Two new endpoints were added to the B2B Mobile Transaction Guide:

updateCustomerCard
refreshCustomerBalances
Status codes were added to these methods.

Release 9-1

Corrected description and categorization of updateDeviceBlockStatus and retrieveCustomerBlockedDevices.
Introduced a new API endpoint to allow a mobile wallet developer to invoke a separate process, such as 3DS verification, into a transaction's lifecycle either before or after the submit payment authorization request.
Updated the list of payment status codes to include additional ranges of codes.

Release 8-10

November 2018

The userreceipt portion of the URL for retrieveUserReceiptByPaydiantRefId was incorrectly shown as plural. The corrected URL is /b2b-gateway/records/userreceipt/.

Release 8-9

October 2018

Introduced support for a mobile app server to utilize an API webhook allowing the WLW platform to push fuel event updates to the app server in lieu of polling for each retrieveTransactionMetadata fuel event update.

Release 8-8

September 2018

Introduced two new API endpoints in support of transaction history retrieval.
- retrieveUserReceiptByPaydiantRefId
- retrievePaginatedUserReceipts

Release 8-7

August 2018

Initial online release of this document.

Overview of the B2B Mobile Transaction APIs

Release 10.1

Note: As of December 2019, Loyalty processing is no longer available in the WLW platform.

Marked loyalty items as deprecated.

Release 9-11

Corrected mis-labelled error codes 404 and 503.

Release 9-7

Added PaymentAccount to the continuePaymentAccountEnrollment method so that the paymentAccountUri can be returned in the response as part of a multi-step enrollment. The uri field of the EntityIdentifier object stores the paymentAccountUri in the responses of both startPaymentAccountEnrollmentRequest and continuePaymentAccountEnrollment in multi-step processing.

Release 9-5

Corrected the name of the refreshCustomerCardBalances method.
Added link to updateMobileTransaction fuel access detail object.
Added deviceIdentifier to the fuelAccessDetail object in continuePaymentAccountEnrollment.
Changed accountTypeUri requirement to Required in TenderType.
Changed checkoutToken requirement to Optional in updateMobileTransaction.
Changed siteDetails attribute in transactionMetadata to siteLocation
Clarified boolean settings must be in lowercase.
Added notes about deviceUri and deviceUniqueId in releaseMobileDeviceCheckoutToken, obtainMobileDeviceCheckoutToken, retrieveMobileTransactionMetadata, updateMobileTransaction, startPaymentAccountEnrollment, and cancelMobileTransaction. Also changed deviceUri requirement in updateCustomerCard to Optional.

Release 9-4

Two new endpoints were added to the B2B Mobile Transaction Guide:

updateCustomerCard
refreshCustomerBalances
Status codes were added to these methods.

Release 9-1

Corrected description and categorization of updateDeviceBlockStatus and retrieveCustomerBlockedDevices.
Introduced a new API endpoint to allow a mobile wallet developer to invoke a separate process, such as 3DS verification, into a transaction's lifecycle either before or after the submit payment authorization request.
Updated the list of payment status codes to include additional ranges of codes.

Release 8-10

November 2018

The userreceipt portion of the URL for retrieveUserReceiptByPaydiantRefId was incorrectly shown as plural. The corrected URL is /b2b-gateway/records/userreceipt/.

Release 8-9

October 2018

Introduced support for a mobile app server to utilize an API webhook allowing the WLW platform to push fuel event updates to the app server in lieu of polling for each retrieveTransactionMetadata fuel event update.

Release 8-8

September 2018

Introduced two new API endpoints in support of transaction history retrieval.
- retrieveUserReceiptByPaydiantRefId
- retrievePaginatedUserReceipts

Release 8-7

August 2018

Initial online release of this document.

Overview of the B2B Mobile Transaction APIs

B2B Mobile Transaction API Guide

Release 10.1

Release 9-11

Release 9-7

Release 9-5

Release 9-4

Release 9-1

Release 8-10

Release 8-9

Release 8-8

Release 8-7

Next

On this page

On this page

On this page

B2B Mobile Transaction API Guide

Release 10.1

Release 9-11

Release 9-7

Release 9-5

Release 9-4

Release 9-1

Release 8-10

Release 8-9

Release 8-8

Release 8-7

Next

On this page

On this page

B2B Mobile Transaction API Guide

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

B2B Mobile Transaction API Guide

On this page

On this page