Managed Cards are a type of financial instrument offered by Weavr.
You can create virtual or physical cards that are issued to the consumer or corporate identity.
A card created in prepaid mode has its own balance, whereas a card created in debit mode does not have its own balance but taps into the balance of its parent managed account.
Creates a managed card for the consumer or corporate identity. The Managed Card Profile (configured in the Multi Portal) specified determines the behaviour and restrictions that the managed card will have.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "profileId": "string",
- "tag": "string",
- "friendlyName": "string",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "renewalType": "RENEW",
- "userId": "string",
- "currency": "str"
}
{- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "string",
- "balances": {
- "availableBalance": 0,
- "actualBalance": 0
}
}
Fetch cards matching the search criteria provided.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "cards": [
- {
- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "string",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "string"
}
], - "count": 0,
- "responseCount": 0
}
Returns all details of the managed card identified by the id
path parameter.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "string",
- "balances": {
- "availableBalance": 0,
- "actualBalance": 0
}
}
Update the details of the managed card identified by the id
path parameter.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "tag": "string",
- "friendlyName": "string",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "bulkDelivery": true,
- "activationCode": "string",
- "productReference": "string",
- "carrierType": "string",
- "renewalType": "RENEW",
- "userId": "string"
}
{- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "string",
- "balances": {
- "availableBalance": 0,
- "actualBalance": 0
}
}
Blocks the managed card identified by the id
path parameter. This is a reversible action and the card can be unblocked using the managedCardUnblock operation.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Unblocks the managed card identified by the id
path parameter.
The managed card must have state.blockedReason
as USER
so that it can be unblocked.
If the managed card was blocked by SYSTEM
, users cannot unblock it.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Destroys the managed card identified by the id
path parameter. Unlike block, this action is not reversible.
A managed card must be empty before it can be destroyed using this operation.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Returns a list of transactions against the managed card identified by the id
path parameter, matching the criteria provided in the request.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "entry": [
- {
- "transactionId": {
- "type": "AUTHORISATION",
- "id": "string"
}, - "entryState": "PENDING",
- "originalAmount": {
- "currency": "str",
- "amount": 0
}, - "forexRate": {
- "value": 0,
- "scale": -128
}, - "transactionAmount": {
- "currency": "str",
- "amount": 0
}, - "availableBalanceAdjustment": {
- "currency": "str",
- "amount": 0
}, - "actualBalanceAdjustment": {
- "currency": "str",
- "amount": 0
}, - "balanceAfter": {
- "currency": "str",
- "amount": 0
}, - "availableBalanceAfter": {
- "currency": "str",
- "amount": 0
}, - "actualBalanceAfter": {
- "currency": "str",
- "amount": 0
}, - "transactionFee": {
- "currency": "str",
- "amount": 0
}, - "cardholderFee": {
- "currency": "str",
- "amount": 0
}, - "processedTimestamp": 0,
- "sourceAmount": {
- "currency": "str",
- "amount": 0
}, - "additionalFields": {
- "property1": "string",
- "property2": "string"
}
}
], - "count": 0,
- "responseCount": 0,
- "startBalance": {
- "currency": "str",
- "amount": 0
}, - "endBalance": {
- "currency": "str",
- "amount": 0
}, - "footer": "string"
}
If your application requires anonymous cards, Weavr will create a pool of cards that are initially not assigned to any identity. This operation assigns one such previously created managed card from the card pool to the logged-in consumer or corporate identity.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "externalReference": "string",
- "activationCode": "string",
- "friendlyName": "string",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "cardholderMobileNumber": "string",
- "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "userId": "string"
}
{- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "string",
- "balances": {
- "availableBalance": 0,
- "actualBalance": 0
}
}
Fetch the list of spend rules associated with the managed card identified by the id
path parameter.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "allowedMerchantCategories": [
- "string"
], - "blockedMerchantCategories": [
- "string"
], - "allowedMerchantIds": [
- "string"
], - "blockedMerchantIds": [
- "string"
], - "allowedMerchantCountries": [
- "st"
], - "blockedMerchantCountries": [
- "st"
], - "allowContactless": true,
- "allowAtm": true,
- "allowECommerce": true,
- "allowCashback": true,
- "allowCreditAuthorisations": true,
- "minTransactionAmount": 0,
- "maxTransactionAmount": 0,
- "spendLimit": [
- {
- "value": {
- "currency": "str",
- "amount": 0
}, - "interval": "DAILY"
}
], - "cardLevelSpendRules": {
- "allowedMerchantCategories": [
- "string"
], - "blockedMerchantCategories": [
- "string"
], - "allowedMerchantIds": [
- "string"
], - "blockedMerchantIds": [
- "string"
], - "allowedMerchantCountries": [
- "st"
], - "blockedMerchantCountries": [
- "st"
], - "allowContactless": true,
- "allowAtm": true,
- "allowECommerce": true,
- "allowCashback": true,
- "allowCreditAuthorisations": true,
- "spendLimit": [
- {
- "value": {
- "currency": "str",
- "amount": 0
}, - "interval": "DAILY"
}
], - "minTransactionAmount": 0,
- "maxTransactionAmount": 0
}, - "profileLevelSpendRules": {
- "allowedMerchantCategories": [
- "string"
], - "blockedMerchantCategories": [
- "string"
], - "allowedMerchantIds": [
- "string"
], - "blockedMerchantIds": [
- "string"
], - "allowedMerchantCountries": [
- "st"
], - "blockedMerchantCountries": [
- "st"
], - "allowContactless": true,
- "allowAtm": true,
- "allowECommerce": true,
- "allowCashback": true,
- "allowCreditAuthorisations": true,
- "authForwardingEnabled": true
}, - "identityLevelSpendRules": {
- "allowedMerchantCategories": [
- "string"
], - "blockedMerchantCategories": [
- "string"
], - "allowedMerchantIds": [
- "string"
], - "blockedMerchantIds": [
- "string"
], - "allowedMerchantCountries": [
- "st"
], - "blockedMerchantCountries": [
- "st"
], - "allowContactless": true,
- "allowAtm": true,
- "allowECommerce": true,
- "allowCashback": true,
- "allowCreditAuthorisations": true,
- "minTransactionAmount": 0,
- "maxTransactionAmount": 0
}
}
Create the spend rules associated with the managed card identified by the id
path parameter.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "allowedMerchantCategories": [
- "string"
], - "blockedMerchantCategories": [
- "string"
], - "allowedMerchantIds": [
- "string"
], - "blockedMerchantIds": [
- "string"
], - "allowedMerchantCountries": [
- "st"
], - "blockedMerchantCountries": [
- "st"
], - "allowContactless": true,
- "allowAtm": true,
- "allowECommerce": true,
- "allowCashback": true,
- "allowCreditAuthorisations": true,
- "spendLimit": [
- {
- "value": {
- "currency": "str",
- "amount": 0
}, - "interval": "DAILY"
}
], - "minTransactionAmount": 0,
- "maxTransactionAmount": 0
}
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Must be user after a POST, to update individual spend rules associated with the managed card identified by the id
path parameter.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "allowedMerchantCategories": [
- "string"
], - "blockedMerchantCategories": [
- "string"
], - "allowedMerchantIds": [
- "string"
], - "blockedMerchantIds": [
- "string"
], - "allowedMerchantCountries": [
- "st"
], - "blockedMerchantCountries": [
- "st"
], - "allowContactless": true,
- "allowAtm": true,
- "allowECommerce": true,
- "allowCashback": true,
- "allowCreditAuthorisations": true,
- "spendLimit": [
- {
- "value": {
- "currency": "str",
- "amount": 0
}, - "interval": "DAILY"
}
], - "minTransactionAmount": 0,
- "maxTransactionAmount": 0,
- "updateSpendLimitMethod": "OVERWRITE"
}
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Remove all spend rules associated with the managed card identified by the id
path parameter.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Upgrades the virtual card identified by the id
path parameter to physical.
Before cards can be upgraded, a physical card programme must be set up and the card profile configuration updated accordingly.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "productReference": "string",
- "carrierType": "string",
- "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "activationCode": "string",
- "pin": {
- "value": "string"
}, - "nameOnCardLine2": "string",
- "bulkDelivery": true
}
{- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "string",
- "balances": {
- "availableBalance": 0,
- "actualBalance": 0
}
}
Activates the physical card identified by the id
path paramter.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "activationCode": "string"
}
{- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "string",
- "balances": {
- "availableBalance": 0,
- "actualBalance": 0
}
}
Retrieves the PIN of the physical card identified by the id
path parameter.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "pin": {
- "value": "string"
}
}
Physical cards can be marked as pinBlocked
if there are too many failed PIN attempts.
Use this operation to unblock a PIN so that the card can be used again.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Report as damaged, and replace the physical card identified by the id
path parameter.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "activationCode": "string"
}
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Report the physical card identified by the id
path parameter as lost. This will deactivate the instrument and a new card will need to be requested.
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Report the physical card identified by the id
path parameter as stolen. This will destroy the instrument and a new replacement card will need to be requested.
Once a replacement is requested, any funds remaining on this destroyed card will be transferred to the replacement card."
Success - No Content.
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "message": "string",
- "syntaxErrors": {
- "invalidFields": [
- {
- "params": [
- "string"
], - "fieldName": "string",
- "error": "REQUIRED"
}
]
}
}
Issue a replacement for the physical card, identified by the id
path parameter, that has already been reported as lost or stolen.
Any funds (that are not blocked pending a purchase for a previous authorisation) remaining on the card will be automatically transferred to the new replacement card.
Success
Bad Request Error - Your request is invalid.
Unauthorized - Your credentials or access token are invalid.
Forbidden - Access to the requested resource or action is forbidden.
Not found - The requested resource couldn't be found.
Conflict
Too many requests.
Internal Server Error - There is a problem with the server. Please try again later.
Service Unavailable - We're temporarily offline for maintenance. Please try again later.
Error
{- "activationCode": "string"
}
{- "id": "string",
- "profileId": "string",
- "externalHandle": "string",
- "tag": "string",
- "friendlyName": "string",
- "currency": "str",
- "state": {
- "state": "ACTIVE",
- "blockedReason": "USER",
- "destroyedReason": "SYSTEM"
}, - "type": "VIRTUAL",
- "cardBrand": "MASTERCARD",
- "cardNumber": {
- "value": "string"
}, - "cvv": {
- "value": "str"
}, - "cardNumberFirstSix": "string",
- "cardNumberLastFour": "stri",
- "nameOnCard": "string",
- "nameOnCardLine2": "string",
- "startMmyy": "stri",
- "expiryMmyy": "stri",
- "cardLevelClassification": "CONSUMER",
- "expiryPeriodMonths": 1,
- "renewalType": "RENEW",
- "renewalTimestamp": 0,
- "creationTimestamp": 0,
- "cardholderMobileNumber": "string",
- "billingAddress": {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st"
}, - "physicalCardDetails": {
- "bulkDelivery": true,
- "productReference": "string",
- "carrierType": "string",
- "pendingActivation": true,
- "pinBlocked": true,
- "manufacturingState": "REQUESTED",
- "replacement": {
- "replacementReason": "DAMAGED",
- "replacementId": "string"
}, - "deliveryAddress": {
- "name": "string",
- "surname": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "postCode": "string",
- "state": "string",
- "country": "st",
- "contactNumber": "string"
}, - "deliveryMethod": "STANDARD_DELIVERY",
- "deliveryTrackingCode": "string",
- "deliveryTrackingMethod": "string",
- "nameOnCardLine2": "string"
}, - "digitalWallets": {
- "pushProvisioningEnabled": true,
- "walletsEnabled": true,
- "artworkReference": "string"
}, - "authForwardingDefaultTimeoutDecision": "APPROVE",
- "threeDSecureAuthConfig": {
- "linkedUserId": "string",
- "primaryChannel": "OTP_SMS",
- "fallbackChannel": "OTP_SMS"
}, - "mode": "PREPAID_MODE",
- "externalData": [
- {
- "name": "string",
- "value": "string"
}
], - "userId": "strin