Push Card to Apple Wallet

post

https://api.cloud.mbanq.com/v1/cards/{cardId}/provision

Use this API to provision a card into Apple Wallet, enabling the cardholder to make contactless payments using their iPhone, Apple Watch, iPad, or Mac.

Pass the cardId as a path parameter to identify the card to be provisioned, and include the required Apple Wallet integration details in the request body.

Note: This operation initiates the card provisioning flow with Apple. The cardholder must complete the in-app or device-level verification step on their Apple device to finalize the card addition.

A successful response confirms that the card has been provisioned to Apple Wallet and is ready for use in digital transactions.

Path Params

cardId

integer

required

Defaults to 1

The unique identifier of the card. Example: 1

Body Params

walletProvider

string

required

Defaults to APPLE_PAY

The digital wallet provider to which the card will be added. Example: APPLE_PAY

certificate1

string

The first certificate required for the Apple Wallet integration, usually containing an encoded string representing the certificate data. Example: 308203fd308203a3a003020102020830a28d640e85f68d300a06082a8648ce3d0403023081803134303206035504030..

certificate2

string

The second certificate required for the Apple Wallet integration, usually containing an encoded string representing the certificate data. Example: 308202f73082027ca00302010202086fefd8f5e9a3a7ee300a06082a8648ce3d0403023067311b301906035504030c12..

nonce

string

A unique value used to prevent replay attacks during the push to Apple Wallet. Example: b2dfff53

nonceSignature

string

The digital signature of the nonce value to ensure its integrity and authenticity. Example: 40ac2a1b3950ee2850d1f2e283432bf3f6784a862161aa381353059914bda57a8d0498670da05fdffbdb106af0a990..

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The card was successfully added to the Apple Wallet.

400The request failed validation. Common causes include trying to provision an inactive card or one already in the wallet.

401Authentication credentials were missing or incorrect.

403The authenticated user does not have permission to provision cards.

404The request fails if the card Id is incorrect.