- Claiming the card number and receiving a reveal grant
- Fetching the card number from the reveal URL
- Why the request must go to the reveal URL and not the API origin
Prerequisites
- A card created through the API (see Create Card)
- API key permissions:
cards:write - The card must be virtual, active, and not expired
Card number retrieval is enabled per account. Contact support to turn it on. Until it is enabled, both endpoints below return
403.How it works
The card number is never returned by the endpoint you call. Instead:- You claim the card number and receive a
reveal_urlplus a short-livedreveal_token. - You call that URL with the token to receive the card number, CVC, and expiration.
vault.meow.com, so the card number is never written to our databases, logs, or backups.
Claim the card number
Call the PAN endpoint with thecardId returned by Create Card:
Fetch the card number
Call thereveal_url exactly as returned, passing the reveal_token as a bearer token alongside your API key:
Use the reveal URL, not the API origin
Sending the same request toapi.meow.com instead of vault.meow.com returns 200 OK with the same field names, but the values are tokenized placeholders:
vault.meow.com. Nothing about the request changes what we send.
Both responses are 200 OK, so a failed integration looks like a working one. If your code receives a value beginning with tok_, it called the wrong host.
Eligibility
A card can return its number only if all of the following are true:- It was created through the API. Cards created in the dashboard cannot return a number.
- It is virtual, not physical.
- It is not closed, suspended, or expired.
Handling errors
Card PAN has already been retrieved
Card PAN has already been retrieved
The card number was already claimed. Revoke the card and create a new one.
Only cards created via this API can retrieve a PAN
Only cards created via this API can retrieve a PAN
The card was created in the dashboard. Create the card through Create Card instead.
Invalid or expired reveal token
Invalid or expired reveal token
The token is older than 300 seconds, belongs to a different card, or was altered. Claim a new card and retry, requesting the number closer to the point of use.
The response contains values beginning with tok_
The response contains values beginning with tok_
The request went to the API origin instead of the reveal URL. Use the
reveal_url value from the claim response verbatim.Next steps
Create Card
Create the virtual card you will retrieve a number for.
Revoke Card
Revoke a card whose number was claimed and is no longer needed.
Card Transactions
List authorizations and settled transactions for a card.
Authentication
API key types, scopes, and the
x-entity-id header.