Card Kiosk Collection
These APIs are designed to allow you to print and encrypt your card directly from a kiosk machine. The card information will be sent to our card manufacturer to configure and print the card on-site on a kiosk machine.
The card printing process will automatically begin once the request is received by our card manufacturer.
During the printing process, you will be notified via webhook about any card production status change.
Before using these APIs, make sure to read the guide on kiosk collection.
These statuses represent the lifecycle of a card production.
READY- The card is ready for production. The produce card endpoint can be called.IN_PROGRESS- The card is in production at the kiosk machine.PRODUCED- The card is produced and collected. This is a final state.PRODUCTION_ERROR- The card production failed. The produce card endpoint can be called again to retry the card production.
A card with production status PRODUCED will trigger an asynchronous call to update the associated card order to PRODUCED status.
PUT /v3/spend/profiles/{{profileId}}/cards/{{cardToken}}/production
This endpoint sends the card production request to a kiosk machine. To confirm that card information has been successfully created, please listen to card-production-status-change webhook with status READY.
Identifier that specifies on which kiosk the card should be produced.
curl -X PUT 'https://api.sandbox.transferwise.tech/v3/spend/profiles/{{profileId}}/cards/{{cardToken}}/production' \-H 'Authorization: Bearer <your api token>' \-H 'Content-Type: application/json' \-d '{"kioskId": "WIS00001"}'
200 - OK- The card information have been successfully sent to the kiosk machine.422 - Unprocessable Content- The card information can't be processed by the kiosk machine. For more details, check the error code returned.
The value will be IN_PROGRESS if the card information has been successfully sent to the kiosk machine, otherwise it will be REQUEST_ERROR.
Identifier that specifies which kiosk machine is producing the card.
Time when the card production request has been successfully sent to the kiosk machine.
Code returned when sending the card production request is not successful. The possible values are listed in request errors.
Detailed description of the error code.
{"status": "IN_PROGRESS","kioskId": "WIS00001","occurredAt" : "2024-01-01T12:24:56.121Z"}
{"status": "REQUEST_ERROR","kioskId": "WIS00001","occurredAt" : "2024-01-01T12:24:56.121Z","errorCode": "PIN_VERIFICATION_FAILED","description": "The PIN cannot be verified because the server is unreachable",}
GET /v3/spend/profiles/{{profileId}}/cards/{{cardToken}}/production
You should rely on the card production status change webhook to be notified on the production status.
In some situations, you might want to use this endpoint to synchronously retrieve the production status of a card.
curl -X GET 'https://api.sandbox.transferwise.tech/v3/spend/profiles/{{profileId}}/cards/{{cardToken}}/production' \-H 'Authorization: Bearer <your api token>' \-H 'Content-Type: application/json'
Current production status. The possible values can be found in the production status flow diagram.
Identifier that specifies which kiosk machine is producing the card. When the status is READY, this value is null.
Time when the card production request has been sent to the kiosk machine.
Code returned when card production is not successful. The possible values are listed in production errors. Nullable.
Detailed description of the error code. Nullable.
{"status": "READY","kioskId": null,"occurredAt": "2024-01-01T12:24:56.124Z","errorCode": null,"description": "Card ready for production"}
These errors are related to the card production request when using the produce card endpoint
An error occurred on the server.
The request has already been submitted.
The kiosk ID does not exist. Please verify that this kiosk ID is correctly set up.
The card type does not exist. Please ensure this card type is correctly set up.
Some field values are unexpected.
The PIN does not follow ISO0 or ISO2 standard.
Some required fields are empty or null.
Some required fields are empty, null, or have incorrect lengths.
The character set for some fields is not supported.
Some field formats are invalid.
The encoding for some fields is not expected.
The encoding or formatting for XML text field values is incorrect.
The PIN length is incorrect.
The PIN cannot be verified because the server is unreachable.
The server failed to parse the request.
Only part of the expected data has been received.
The kiosk has not been linked to any branch.
The image server is unreachable or failed to process the data.
The PAN already exists.
The printer or satellite is not ready to start the production.
The request has been created, but production is pending until the printer or satellite is ready
The system is currently busy and cannot accept new requests at this time
These errors are related to the final production status of a card.
Main server error: central base not available.
Main server error: database not available.
Main server error: network not available.
Main server error: user authentication verification failed.
Main server error: the accessed service requires a higher security level.
Main server error: timeout occurred on the Central Base side.
Data processing error: the Data preparation module is not available.
Data processing error: Input/Output error when communicating with the DP.
Data processing error: timeout error.
Satellite agent error: the server is not reachable.
Satellite agent error: user authentication failed on satellite.
Satellite agent error: the network is not available.
Printer error: printer is not reachable.
Printer error: printer setup is incorrect.
Printer error: printer timeout.
Printer error: ribbon error.
Printer error: printer physically unlocked.
Printer error: ribbon is missing.
Printer error: ribbon has ended.
Printer error: printer cover is open.
Printer error: printer paused.
Production error: production data is incorrect.
Production error: feeder is empty.
Production error: feeder card jam.
Production error: hopper is full.
Production error: hopper door is open.
Production error: hopper card jam.
Production error: error occurred during magstripe encoding.
Production error: error occurred during chip personalization.
Production error: error occurred during embossing.
Production error: production timeout has been reached.
Production error: reject box is full.
Production error: card is not in reader.
Production error: user has rejected card production.
Production error: inventory not initialized.
Unknown error.