Skip to main content
An example covering a physical debit card from creation to cancellation, activated by barcode.

Requesting Card Issuance

  1. You offer a card product to a customer. Call List Card Products and note the id of the product you want to offer.
  2. The customer signs up and accepts the card disclosure. Disclosure is generally handled as part of account onboarding, but can be a separate process. See Record Disclosure Acceptance.
  3. You call Issue a Card with the customer, account, card product, embossed name, and optional shipping information. The response contains the card object and its ID.
  4. You receive CARD.UPDATED webhooks as the card is ordered, manufactured, and shipped, so you can keep the customer informed and react if the card is rejected.

Activating a Card

  1. Your customer receives the card, logs into your app, and scans the barcode with their phone camera.
  2. Your app translates the barcode into its value.
  3. You call Activate Card with that value and the customer ID.
  4. The Cards API requests activation through the card vendor.
  5. You prompt the customer to set a PIN using the Set PIN widget.
  6. The widget sends the PIN directly to the card vendor.
  7. The card vendor activates the card and notifies the Synctera platform.
  8. The card’s status becomes ACTIVE, and you receive a CARD.UPDATED webhook.

Reissuing a Card

  1. Your customer reports that they lost the card.
  2. You call Issue a Card with the same details as the original, plus reissue_reason of LOST and reissued_from_id of the lost card. You can also do this from the Synctera dashboard.
  3. Synctera immediately terminates the lost card with the card vendor and sets its status to TERMINATED.
  4. The new card is issued and activated just as the lost card was — with a new PAN, but the same PIN.

Cancelling a Card

  1. The customer cancels the card.
  2. You call Update Card to set the status to TERMINATED. You can also do this from the Synctera dashboard.
  3. Synctera notifies the card vendor.
  4. The card vendor terminates the card.

Next Steps

Card Lifecycle

The states behind each step above.

Issue a Card

The full issuance and activation reference.