Conferma API

Introduction
Authentication
Versioning
Headers
Status Codes
Errors
Sorting and Pagination
Webhooks

Digital Wallet API

Cards
Tokens
- Update Token Statuspost
- Retrieve Tokenget

Push Card API

Card

Payments API

Deployments
Funding
- Retrieve Card Pool Account Funding Detailsget

Conferma API

Introduction
Authentication
Versioning
Headers
Status Codes
Errors
Sorting and Pagination
Webhooks

Digital Wallet API

Cards
Tokens
- Update Token Statuspost
- Retrieve Tokenget

Push Card API

Card

Payments API

Deployments
Funding
- Retrieve Card Pool Account Funding Detailsget

Update Status

post https://example.com/cards/{DeploymentID}/status

Enable a card for digital wallet providing all the necessary metadata, or deactivate a currently enabled digital wallet card.
To enable a card, the client must have platform access to the card account in question and the card must belong to a program range that is enabled for Digital Wallet.
When disabling a card, all tokens that may have been provisioned will be terminated. It will not be possible to re-enable the card.

URL Expired

The URL for this request expired after 30 days.

Path Params

DeploymentID

int32

required

Deployment ID for the card. See deployments API for more info.

Body Params

Card Status Request

status

string

Enum for the status actions

recipient

object

The Card Recipient. Details of the individual user who will be accessing the card. These details will be used to power cardholder step up verification and various notifications.

Responses

Response body

object

status

string

Enum indicating the status of the card with respect to Digital Wallet enablement

NotSupported CanEnable Enabled Disabled

supportedWallets

object

Object indicating which wallets are supported for a given card.

appleWalletSupported

boolean

Indicates whether Apple Pay is supported.

googlePayWalletSupported

boolean

Indicates whether Google Pay is supported.

recipient

object

The Card Recipient. Details of the individual user who will be accessing the card. These details will be used to power cardholder step up verification and various notifications.

firstName

string | null

User's first name.

lastName

string | null

User's last name.

emailAddress

string | null

Email address.

phoneNumber

string | null

Phone Number in international format. Dial prefix + dial code + full number without spaces, dashes or leading zeros.

cultureCode

string | null

Culture code in ISO format

Response body

object

errorCode

string | null

Error Code

message

string | null

Error Message

details

array of objects | null

Optional list of field validation errors

details

object

field

string | null

Field Name

issue

string | null

Error details

Response body

object

errorCode

string | null

Error Code

message

string | null

Error Message

details

array of objects | null

Optional list of field validation errors

details

object

field

string | null

Field Name

issue

string | null

Error details

Response body

object

errorCode

string | null

Error Code

message

string | null

Error Message

details

array of objects | null

Optional list of field validation errors

details

object

field

string | null

Field Name

issue

string | null

Error details

Updated over 2 years ago

Webhooks

Retrieve Status

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/cards/DeploymentID/status \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'

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

text/plain

application/json

text/json

Updated over 2 years ago

Webhooks

Retrieve Status

Did this page help you?

Conferma API
Introduction
Authentication
Versioning
Headers
Status Codes
Errors
Sorting and Pagination
Webhooks

Digital Wallet API
Cards
List Tokensget
Create Android Pay Token Requestpost
Create Apple Pay Token Requestpost
Retrieve Statusget
Update Statuspost
Tokens
Retrieve Tokenget
Update Token Statuspost

Push Card API
Card
Get Historyget
Get Card Accountsget
Update Cardput
Create New Cardpost

Payments API
Deployments
List Deployment Audit Historyget
Send Payment Communicationpost
List Deployment Communications Historyget
List Deployment Card Activityget
Update Supplier Referencepost
Cancel Deploymentpost
Retrieve Deployment Virtual Cardget
Update Deploymentput
Retrieve Deploymentget
Create Cardpost
Funding
Retrieve Card Pool Account Funding Detailsget

Conferma API
Introduction
Authentication
Versioning
Headers
Status Codes
Errors
Sorting and Pagination
Webhooks

Digital Wallet API
Cards
List Tokensget
Create Android Pay Token Requestpost
Create Apple Pay Token Requestpost
Retrieve Statusget
Update Statuspost
Tokens
Retrieve Tokenget
Update Token Statuspost

Push Card API
Card
Get Historyget
Get Card Accountsget
Update Cardput
Create New Cardpost

Payments API
Deployments
List Deployment Audit Historyget
Send Payment Communicationpost
List Deployment Communications Historyget
List Deployment Card Activityget
Update Supplier Referencepost
Cancel Deploymentpost
Retrieve Deployment Virtual Cardget
Update Deploymentput
Retrieve Deploymentget
Create Cardpost
Funding
Retrieve Card Pool Account Funding Detailsget

200Success

400Bad Request

401Unauthorized

500Server Error