Get issuance

get https://api-preview.platform.breadpayments.com/api/virtual-card/issuance/{lookupKey}

Retrieve info for the specified issuance.

Responses

Response body

object

issuance

object

required

Issuance data

uuid

required

Issuance id

status

string

required

Provisioning status of the issuance.
REQUESTED represents a requested but not yet issued card.
PROCESSING represents a provisioning issuance.
ISSUED represents a provisioned issuance.
FAILED represents an issuance that failed to provision.
CLOSED represents an issuance that has gone through checkout and can no longer be modified.

REQUESTED PROCESSING ISSUED FAILED CLOSED

scopeType

string

required

Scope type of the issuance.

APPLICATION

scopeID

uuid

required

Scope ID for the issuance. In the case of APPLICATION scopeType, scopeID will be application ID.

buyerID

uuid

Buyer ID for the issuance.

programID

uuid

Program ID for the issuance.

tenantID

uuid

Tenant ID for the issuance.

paymentProductID

uuid

Payment Product ID for the issuance.

applicationSettings

object

Issuance data required for creating a virtual card

card

object

Card information

cardID

uuid

required

Card id.

lastFour

string

Last 4 digits of the card number. Added once card is provisioned.

status

string

required

Provisioning status of a virtual card.
ACTIVE represents a provisioned card.
FAILED represents a card that failed provisioning.
SUSPENDED represents a suspended card. Can be reinstated.
TERMINATED represents a terminated card. Cannot be reinstated.

ACTIVE FAILED SUSPENDED TERMINATED

expiry

date-time

Expiration datetime. Added once card is provisioned.

issuanceDate

date-time

Issuance datetime. Added once card is provisioned.

pan

string

Card PAN. Only available with r:vc.restricted scope.

cvv

string

Card CVV. Only available with r:vc.restricted scope.

capacity

object

Represents a monetary amount in the specified currency

wallets

array of objects

Wallets associated with the virtual card.

wallets

object

uuid

required

Wallet id.

type

string

required

Type of wallet.

APPLEPAY GOOGLEPAY

status

string

required

Provisioning status of a digital wallet token.
PROVISIONING represents a digital wallet token in the process of provisioning.
ACTIVE represents a successfully provisioned digital wallet token.
FAILED represents a digital wallet token that failed provisioning.
SUSPENDED represents a suspended digital wallet token. Can be reinstated.
TERMINATED represents a terminated digital wallet token. Cannot be reinstated.

PROVISIONING ACTIVE FAILED SUSPENDED TERMINATED

dpan

string

Wallet DPAN. Only available with r:vc.restricted scope.

usedAtCheckout

boolean

required

True if this wallet was used for checkout.

applePay

object

ApplePay wallet information

googlePay

object

GooglePay wallet information

summary

object

Total authorized/settled/refunded transactions.

authorized

number

required

Total authorized transaction.

settled

number

required

Total settled transaction.

refunded

number

required

Total refunded transaction.

transactions

array of objects

List of transactions in descending order from when they were received

transactions

object

type

string

required

Transaction type.

AUTHORIZATION AUTHORIZATION_CLEARING REFUND AUTHORIZATION_REVERSAL CHARGEBACK CHARGEBACK_REVERSAL

token

string

required

Transaction token.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-preview.platform.breadpayments.com/api/virtual-card/issuance/lookupKey \
3
     --header 'accept: application/json'

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

application/json

text/plain

200The updated issuance information.

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized

500Response for errors returned by virtual_card service.